mirror of
https://github.com/apache/nuttx.git
synced 2026-05-31 23:40:19 +08:00
Standardization of some function headers.
This commit is contained in:
@@ -201,7 +201,7 @@ static void misoc_net_ipv6multicast(FAR struct misoc_net_driver_s *priv);
|
||||
* Start hardware transmission. Called either from the txdone interrupt
|
||||
* handling or from watchdog based polling.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* priv - Reference to the driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -290,7 +290,7 @@ static int misoc_net_transmit(FAR struct misoc_net_driver_s *priv)
|
||||
* 2. When the preceding TX packet send timesout and the interface is reset
|
||||
* 3. During normal TX polling
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -356,7 +356,7 @@ static int misoc_net_txpoll(FAR struct net_driver_s *dev)
|
||||
* Description:
|
||||
* An interrupt was received indicating the availability of a new RX packet
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* priv - Reference to the driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -530,7 +530,7 @@ static void misoc_net_receive(FAR struct misoc_net_driver_s *priv)
|
||||
* Description:
|
||||
* An interrupt was received indicating that the last TX packet(s) is done
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* priv - Reference to the driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -570,7 +570,7 @@ static void misoc_net_txdone(FAR struct misoc_net_driver_s *priv)
|
||||
* Description:
|
||||
* Perform interrupt related work from the worker thread
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - The argument passed when work_queue() was called.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -620,7 +620,7 @@ static void misoc_net_interrupt_work(FAR void *arg)
|
||||
* Description:
|
||||
* Hardware interrupt handler
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* irq - Number of the IRQ that generated the interrupt
|
||||
* context - Interrupt register state save info (architecture-specific)
|
||||
*
|
||||
@@ -664,7 +664,7 @@ static int misoc_net_interrupt(int irq, FAR void *context, FAR void *arg)
|
||||
* Description:
|
||||
* Perform TX timeout related work from the worker thread
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - The argument passed when work_queue() as called.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -699,7 +699,7 @@ static void misoc_net_txtimeout_work(FAR void *arg)
|
||||
* Our TX watchdog timed out. Called from the timer interrupt handler.
|
||||
* The last TX never completed. Reset the hardware and start again.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* argc - The number of available arguments
|
||||
* arg - The first argument
|
||||
*
|
||||
@@ -733,7 +733,7 @@ static void misoc_net_txtimeout_expiry(int argc, wdparm_t arg, ...)
|
||||
* Description:
|
||||
* Perform periodic polling from the worker thread
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - The argument passed when work_queue() as called.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -777,7 +777,7 @@ static void misoc_net_poll_work(FAR void *arg)
|
||||
* Description:
|
||||
* Periodic timer handler. Called from the timer interrupt handler.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* argc - The number of available arguments
|
||||
* arg - The first argument
|
||||
*
|
||||
@@ -805,7 +805,7 @@ static void misoc_net_poll_expiry(int argc, wdparm_t arg, ...)
|
||||
* NuttX Callback: Bring up the Ethernet interface when an IP address is
|
||||
* provided
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -861,7 +861,7 @@ static int misoc_net_ifup(FAR struct net_driver_s *dev)
|
||||
* Description:
|
||||
* NuttX Callback: Stop the interface.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -904,7 +904,7 @@ static int misoc_net_ifdown(FAR struct net_driver_s *dev)
|
||||
* Description:
|
||||
* Perform an out-of-cycle poll on the worker thread.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - Reference to the NuttX driver state structure (cast to void*)
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -945,7 +945,7 @@ static void misoc_net_txavail_work(FAR void *arg)
|
||||
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX
|
||||
* latency.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -982,7 +982,7 @@ static int misoc_net_txavail(FAR struct net_driver_s *dev)
|
||||
* NuttX Callback: Add the specified MAC address to the hardware multicast
|
||||
* address filtering
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
* mac - The MAC address to be added
|
||||
*
|
||||
@@ -1011,7 +1011,7 @@ static int misoc_net_addmac(FAR struct net_driver_s *dev, FAR const uint8_t *mac
|
||||
* NuttX Callback: Remove the specified MAC address from the hardware multicast
|
||||
* address filtering
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
* mac - The MAC address to be removed
|
||||
*
|
||||
@@ -1039,7 +1039,7 @@ static int misoc_net_rmmac(FAR struct net_driver_s *dev, FAR const uint8_t *mac)
|
||||
* Description:
|
||||
* Configure the IPv6 multicast MAC address.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* priv - A reference to the private driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -1116,7 +1116,7 @@ static void misoc_net_ipv6multicast(FAR struct misoc_net_driver_s *priv)
|
||||
* Description:
|
||||
* Initialize the Ethernet controller and driver
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* intf - In the case where there are multiple EMACs, this value
|
||||
* identifies which EMAC is to be initialized.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user