mirror of
https://github.com/apache/nuttx.git
synced 2026-05-28 11:56:10 +08:00
Standardization of some function headers.
This commit is contained in:
+22
-22
@@ -250,7 +250,7 @@ static void ftmac100_ipv6multicast(FAR struct ftmac100_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:
|
||||
@@ -343,7 +343,7 @@ static int ftmac100_transmit(FAR struct ftmac100_driver_s *priv)
|
||||
* reset
|
||||
* 3. During normal TX polling
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -410,7 +410,7 @@ static int ftmac100_txpoll(struct net_driver_s *dev)
|
||||
* Description:
|
||||
* Do the HW reset
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* priv - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -439,7 +439,7 @@ static void ftmac100_reset(FAR struct ftmac100_driver_s *priv)
|
||||
* Description:
|
||||
* Perform HW initialization
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* priv - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -547,7 +547,7 @@ static void ftmac100_init(FAR struct ftmac100_driver_s *priv)
|
||||
* Description:
|
||||
* Read MII registers
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* iobase - Pointer to the driver's registers base
|
||||
* reg - MII register number
|
||||
*
|
||||
@@ -588,7 +588,7 @@ static uint32_t ftmac100_mdio_read(FAR struct ftmac100_register_s *iobase, int r
|
||||
* Description:
|
||||
* Set the MAC address
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* priv - Reference to the NuttX driver state structure
|
||||
* mac - Six bytes MAC address
|
||||
*
|
||||
@@ -618,7 +618,7 @@ static void ftmac100_set_mac(FAR struct ftmac100_driver_s *priv,
|
||||
* 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:
|
||||
@@ -792,7 +792,7 @@ static void ftmac100_receive(FAR struct ftmac100_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:
|
||||
@@ -855,7 +855,7 @@ static void ftmac100_txdone(FAR struct ftmac100_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:
|
||||
@@ -959,7 +959,7 @@ out:
|
||||
* Description:
|
||||
* Hardware interrupt handler
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* irq - Number of the IRQ that generated the interrupt
|
||||
* context - Interrupt register state save info (architecture-specific)
|
||||
*
|
||||
@@ -1014,7 +1014,7 @@ static int ftmac100_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:
|
||||
@@ -1048,7 +1048,7 @@ static void ftmac100_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
|
||||
*
|
||||
@@ -1082,7 +1082,7 @@ static void ftmac100_txtimeout_expiry(int argc, uint32_t arg, ...)
|
||||
* Description:
|
||||
* Perform periodic polling from the worker thread
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - The argument passed when work_queue() as called.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -1125,7 +1125,7 @@ static void ftmac100_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
|
||||
*
|
||||
@@ -1153,7 +1153,7 @@ static void ftmac100_poll_expiry(int argc, uint32_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:
|
||||
@@ -1213,7 +1213,7 @@ static int ftmac100_ifup(struct net_driver_s *dev)
|
||||
* Description:
|
||||
* NuttX Callback: Stop the interface.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -1259,7 +1259,7 @@ static int ftmac100_ifdown(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:
|
||||
@@ -1300,7 +1300,7 @@ static void ftmac100_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:
|
||||
@@ -1337,7 +1337,7 @@ static int ftmac100_txavail(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
|
||||
*
|
||||
@@ -1391,7 +1391,7 @@ static int ftmac100_addmac(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
|
||||
*
|
||||
@@ -1435,7 +1435,7 @@ static int ftmac100_rmmac(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:
|
||||
@@ -1512,7 +1512,7 @@ static void ftmac100_ipv6multicast(FAR struct ftmac100_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