mirror of
https://github.com/apache/nuttx.git
synced 2026-06-05 15:58:59 +08:00
Standardization of some function headers.
This commit is contained in:
@@ -94,7 +94,7 @@ struct iob_s; /* Forward reference */
|
||||
* Description:
|
||||
* Bind the MAC callback table to the MAC state.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* mac - Reference to the MAC driver state structure
|
||||
* cb - MAC callback operations
|
||||
*
|
||||
@@ -111,7 +111,7 @@ int mac802154_bind(MACHANDLE mac, FAR struct mac802154_maccb_s *cb);
|
||||
* Description:
|
||||
* Handle MAC and radio IOCTL commands directed to the MAC.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* mac - Reference to the MAC driver state structure
|
||||
* cmd - The IOCTL command
|
||||
* arg - The argument for the IOCTL command
|
||||
|
||||
@@ -60,7 +60,7 @@
|
||||
* Description:
|
||||
* Bind the MAC callback table to the MAC state.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* mac - Reference to the MAC driver state structure
|
||||
* cb - MAC callback operations
|
||||
*
|
||||
|
||||
@@ -62,7 +62,7 @@
|
||||
* Description:
|
||||
* Handle MAC and radio IOCTL commands directed to the MAC.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* mac - Reference to the MAC driver state structure
|
||||
* cmd - The IOCTL command
|
||||
* arg - The argument for the IOCTL command
|
||||
|
||||
@@ -296,7 +296,7 @@ static inline void lo_netmask(FAR struct net_driver_s *dev)
|
||||
* a callback from devif_poll() or devif_timer(). devif_poll() will be
|
||||
* called only during normal TX polling.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -416,7 +416,7 @@ static int lo_loopback(FAR struct net_driver_s *dev)
|
||||
* Description:
|
||||
* Perform loopback of received framelist.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - The argument passed when work_queue() as called.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -444,7 +444,7 @@ static void lo_loopback_work(FAR void *arg)
|
||||
* Description:
|
||||
* Perform periodic polling from the worker thread
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - The argument passed when work_queue() as called.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -485,7 +485,7 @@ static void lo_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
|
||||
*
|
||||
@@ -522,7 +522,7 @@ static void lo_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:
|
||||
@@ -590,7 +590,7 @@ static int lo_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:
|
||||
@@ -622,7 +622,7 @@ static int lo_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:
|
||||
@@ -666,7 +666,7 @@ static void lo_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:
|
||||
@@ -711,7 +711,7 @@ static int lo_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
|
||||
*
|
||||
@@ -746,7 +746,7 @@ static int lo_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
|
||||
*
|
||||
@@ -780,7 +780,7 @@ static int lo_rmmac(FAR struct net_driver_s *dev, FAR const uint8_t *mac)
|
||||
* Description:
|
||||
* Handle network IOCTL commands directed to this device.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
* cmd - The IOCTL command
|
||||
* arg - The argument for the IOCTL command
|
||||
@@ -1044,7 +1044,7 @@ static int lo_properties(FAR struct radio_driver_s *netdev,
|
||||
* Description:
|
||||
* Initialize and register the Ieee802.15.4 MAC loopback network driver.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* None
|
||||
*
|
||||
* Returned Value:
|
||||
|
||||
@@ -565,7 +565,7 @@ static int macnet_rxframe(FAR struct macnet_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:
|
||||
@@ -591,7 +591,7 @@ static int macnet_txpoll_callback(FAR struct net_driver_s *dev)
|
||||
* Description:
|
||||
* Perform periodic polling from the worker thread
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* arg - The argument passed when work_queue() as called.
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -637,7 +637,7 @@ static void macnet_txpoll_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
|
||||
*
|
||||
@@ -739,7 +739,7 @@ static int macnet_coord_saddr(FAR struct radio_driver_s *radio,
|
||||
* NuttX Callback: Bring up the IEEE 802.15.4 interface when an IP address
|
||||
* is provided
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
*
|
||||
* Returned Value:
|
||||
@@ -818,7 +818,7 @@ static int macnet_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:
|
||||
@@ -859,7 +859,7 @@ static int macnet_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:
|
||||
@@ -910,7 +910,7 @@ static void macnet_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:
|
||||
@@ -949,7 +949,7 @@ static int macnet_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
|
||||
*
|
||||
@@ -980,7 +980,7 @@ static int macnet_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
|
||||
*
|
||||
@@ -1010,7 +1010,7 @@ static int macnet_rmmac(FAR struct net_driver_s *dev, FAR const uint8_t *mac)
|
||||
* Description:
|
||||
* Handle network IOCTL commands directed to this device.
|
||||
*
|
||||
* Parameters:
|
||||
* Input Parameters:
|
||||
* dev - Reference to the NuttX driver state structure
|
||||
* cmd - The IOCTL command
|
||||
* arg - The argument for the IOCTL command
|
||||
|
||||
Reference in New Issue
Block a user