Standardization of some function headers.

net/netdev/netdev.h

@@ -114,7 +114,7 @@ bool netdev_verify(FAR struct net_driver_s *dev);
  *   Find a previously registered network device using its assigned
  *   network interface name
  *
- * Parameters:
+ * Input Parameters:
  *   ifname The interface name of the device of interest
  *
  * Returned Value:
@@ -137,7 +137,7 @@ FAR struct net_driver_s *netdev_findbyname(FAR const char *ifname);
  *
  *   NOTE: netdev semaphore held throughout enumeration.
  *
- * Parameters:
+ * Input Parameters:
  *   callback - Will be called for each registered device
  *   arg      - User argument passed to callback()
  *
@@ -158,7 +158,7 @@ int netdev_foreach(netdev_callback_t callback, FAR void *arg);
  *   Find a previously registered network device by matching an arbitrary
  *   IPv4 address.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - Local, bound address of a connection.
  *   ripaddr - Remote address of a connection to use in the lookup
  *
@@ -183,7 +183,7 @@ FAR struct net_driver_s *netdev_findby_ipv4addr(in_addr_t lipaddr,
  *   Find a previously registered network device by matching an arbitrary
  *   IPv6 address.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - Local, bound address of a connection.
  *   ripaddr - Remote address of a connection to use in the lookup
  *
@@ -211,7 +211,7 @@ FAR struct net_driver_s *netdev_findby_ipv6addr(const net_ipv6addr_t lipaddr,
  *   registered device causing a given index to be meaningless (unless, of
  *   course, the caller keeps the network locked).
  *
- * Parameters:
+ * Input Parameters:
  *   index - the index of the interface to file
  *
  * Returned Value:
@@ -238,7 +238,7 @@ FAR struct net_driver_s *netdev_findbyindex(int index);
  *   if a socket is connected with INADDY_ANY.  In this case, I suppose we
  *   should use the IP address associated with some default device???
  *
- * Parameters:
+ * Input Parameters:
  *   NULL
  *
  * Returned Value:
@@ -260,7 +260,7 @@ FAR struct net_driver_s *netdev_default(void);
  *   Notify the device driver that forwards the IPv4 address that new TX
  *   data is available.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - The local address bound to the socket
  *   ripaddr - The remote address to send the data
  *
@@ -284,7 +284,7 @@ void netdev_ipv4_txnotify(in_addr_t lipaddr, in_addr_t ripaddr);
  *   Notify the device driver that forwards the IPv4 address that new TX
  *   data is available.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - The local address bound to the socket
  *   ripaddr - The remote address to send the data
  *
@@ -310,7 +310,7 @@ void netdev_ipv6_txnotify(FAR const net_ipv6addr_t lipaddr,
  *   would be called when the upper level logic already understands how the
  *   packet will be routed.
  *
- * Parameters:
+ * Input Parameters:
  *   dev - The network device driver state structure.
  *
  * Returned Value:
@@ -329,7 +329,7 @@ void netdev_txnotify_dev(FAR struct net_driver_s *dev);
  * Description:
  *   Return the number of network devices
  *
- * Parameters:
+ * Input Parameters:
  *   None
  *
  * Returned Value:
@@ -350,7 +350,7 @@ int netdev_count(void);
  * Description:
  *   Return the IPv4 configuration of each network adaptor
  *
- * Parameters:
+ * Input Parameters:
  *   ifc - A reference to the instance of struct ifconf in which to return
  *         the information.
  *
@@ -374,7 +374,7 @@ int netdev_ipv4_ifconf(FAR struct ifconf *ifc);
  * Description:
  *   Return the IPv6 configuration of each network adaptor
  *
- * Parameters:
+ * Input Parameters:
  *   lifc - A reference to the instance of struct lifconf in which to return
  *          the information.
  *
@@ -398,7 +398,7 @@ int netdev_ipv6_ifconf(FAR struct lifconf *lifc);
  * Description:
  *   Returns the size of the MAC address associated with a network device.
  *
- * Parameters:
+ * Input Parameters:
  *   dev - A reference to the device of interest
  *
  * Returned Value:

net/netdev/netdev_carrier.c

@@ -65,7 +65,7 @@
  *   Notifies the networking layer about an available carrier.
  *   (e.g. a cable was plugged in)
  *
- * Parameters:
+ * Input Parameters:
  *   dev - The device driver structure
  *
  * Returned Value:
@@ -91,7 +91,7 @@ int netdev_carrier_on(FAR struct net_driver_s *dev)
  *   Notifies the networking layer about an disappeared carrier.
  *   (e.g. a cable was unplugged)
  *
- * Parameters:
+ * Input Parameters:
  *   dev - The device driver structure
  *
  * Returned Value:

net/netdev/netdev_count.c

@@ -58,7 +58,7 @@
  * Description:
  *   Return the number of network devices
  *
- * Parameters:
+ * Input Parameters:
  *   None
  *
  * Returned Value:

net/netdev/netdev_default.c

@@ -62,7 +62,7 @@
  *   if a socket is connected with INADDY_ANY.  In this case, I suppose we
  *   should use the IP address associated with some default device???
  *
- * Parameters:
+ * Input Parameters:
  *   NULL
  *
  * Returned Value:

net/netdev/netdev_findbyaddr.c

@@ -68,7 +68,7 @@
  *   with the subnet served by the device.  Only "up" devices are considered
  *   (since a "down" device has no meaningful address).
  *
- * Parameters:
+ * Input Parameters:
  *   ripaddr - Remote address of a connection to use in the lookup
  *
  * Returned Value:
@@ -121,7 +121,7 @@ static FAR struct net_driver_s *netdev_finddevice_ipv4addr(in_addr_t ripaddr)
  *   with the subnet served by the device.  Only "up" devices are considered
  *   (since a "down" device has no meaningful address).
  *
- * Parameters:
+ * Input Parameters:
  *   ripaddr - Remote address of a connection to use in the lookup
  *
  * Returned Value:
@@ -178,7 +178,7 @@ netdev_finddevice_ipv6addr(const net_ipv6addr_t ripaddr)
  *   Find a previously registered network device by matching an arbitrary
  *   IPv4 address.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - Local, bound address of a connection.
  *   ripaddr - Remote address of a connection to use in the lookup
  *
@@ -278,7 +278,7 @@ FAR struct net_driver_s *netdev_findby_ipv4addr(in_addr_t lipaddr,
  *   Find a previously registered network device by matching an arbitrary
  *   IPv6 address.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - Local, bound address of a connection.
  *   ripaddr - Remote address of a connection to use in the lookup
  *

net/netdev/netdev_findbyindex.c

@@ -62,7 +62,7 @@
  *   registered device causing a given index to be meaningless (unless, of
  *   course, the caller keeps the network locked).
  *
- * Parameters:
+ * Input Parameters:
  *   index - the index of the interface to file
  *
  * Returned Value:

net/netdev/netdev_findbyname.c

@@ -59,7 +59,7 @@
  *   Find a previously registered network device using its assigned
  *   network interface name
  *
- * Parameters:
+ * Input Parameters:
  *   ifname The interface name of the device of interest
  *
  * Returned Value:

net/netdev/netdev_foreach.c

@@ -58,7 +58,7 @@
  *
  *   NOTE: netdev semaphore held throughout enumeration.
  *
- * Parameters:
+ * Input Parameters:
  *   callback - Will be called for each registered device
  *   arg      - User argument passed to callback()
  *

net/netdev/netdev_ifconf.c

@@ -83,7 +83,7 @@ struct ifconf_ipv6_info_s
  *   Callback from netdev_foreach() that does the real implementation of
  *   netdev_ipv4_ifconf().
  *
- * Parameters:
+ * Input Parameters:
  *   dev - The network device for this callback.
  *   arg - User callback argument
  *
@@ -160,7 +160,7 @@ static int ifconf_ipv4_callback(FAR struct net_driver_s *dev, FAR void *arg)
  *   Callback from netdev_foreach() that does the real implementation of
  *   netdev_ipv6_ifconf().
  *
- * Parameters:
+ * Input Parameters:
  *   dev - The network device for this callback.
  *   arg - User callback argument
  *
@@ -241,7 +241,7 @@ static int ifconf_ipv6_callback(FAR struct net_driver_s *dev, FAR void *arg)
  *   Return the IPv4 configuration of each network adaptor that (1) has
  *   and IPv4 address assigned and (2) is in the UP state
  *
- * Parameters:
+ * Input Parameters:
  *   ifc - A reference to the instance of struct ifconf in which to return
  *         the information.
  *
@@ -274,7 +274,7 @@ int netdev_ipv4_ifconf(FAR struct ifconf *ifc)
  *   Return the IPv6 configuration of each network adaptor that (1) has
  *   and IPv6 address assigned and (2) is in the UP state.
  *
- * Parameters:
+ * Input Parameters:
  *   lifc - A reference to the instance of struct lifconf in which to return
  *          the information.
  *

net/netdev/netdev_ioctl.c

@@ -376,7 +376,7 @@ static void ioctl_set_ipv6addr(FAR net_ipv6addr_t outaddr,
  * Description:
  *   Perform IEEE802.15.4 network device specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock    Socket structure
  *   dev      Ethernet driver device structure
  *   cmd      The ioctl command
@@ -438,7 +438,7 @@ static int netdev_iee802154_ioctl(FAR struct socket *psock, int cmd,
  * Description:
  *   Perform non-IEEE802.15.4 packet radio network device specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock    Socket structure
  *   dev      Ethernet driver device structure
  *   cmd      The ioctl command
@@ -501,7 +501,7 @@ static int netdev_pktradio_ioctl(FAR struct socket *psock, int cmd,
  * Description:
  *   Perform wireless network device specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock    Socket structure
  *   dev      Ethernet driver device structure
  *   cmd      The ioctl command
@@ -545,7 +545,7 @@ static int netdev_wifr_ioctl(FAR struct socket *psock, int cmd,
  * Description:
  *   Verify the struct ifreq and get the Ethernet device.
  *
- * Parameters:
+ * Input Parameters:
  *   req - The argument of the ioctl cmd
  *
  * Returned Value:
@@ -573,7 +573,7 @@ static FAR struct net_driver_s *netdev_ifr_dev(FAR struct ifreq *req)
  * Description:
  *   Perform network device specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock    Socket structure
  *   cmd      The ioctl command
  *   req      The argument of the ioctl cmd
@@ -1027,7 +1027,7 @@ static int netdev_ifr_ioctl(FAR struct socket *psock, int cmd,
  * Description:
  *   Verify the struct ip_msfilter and get the Ethernet device.
  *
- * Parameters:
+ * Input Parameters:
  *   req - The argument of the ioctl cmd
  *
  * Returned Value:
@@ -1057,7 +1057,7 @@ static FAR struct net_driver_s *netdev_imsfdev(FAR struct ip_msfilter *imsf)
  * Description:
  *   Perform network device specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock    Socket structure
  *   dev      Ethernet driver device structure
  *   cmd      The ioctl command
@@ -1116,7 +1116,7 @@ static int netdev_imsf_ioctl(FAR struct socket *psock, int cmd,
  * Description:
  *   Perform ARP table specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock  Socket structure
  *   dev    Ethernet driver device structure
  *   cmd    The ioctl command
@@ -1239,7 +1239,7 @@ static int netdev_arp_ioctl(FAR struct socket *psock, int cmd,
  * Description:
  *   Perform routing table specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock    Socket structure
  *   dev      Ethernet driver device structure
  *   cmd      The ioctl command
@@ -1354,7 +1354,7 @@ static int netdev_rt_ioctl(FAR struct socket *psock, int cmd,
  * Description:
  *   Perform network device specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   psock    A pointer to a NuttX-specific, internal socket structure
  *   cmd      The ioctl command
  *   arg      The argument of the ioctl cmd
@@ -1464,7 +1464,7 @@ int psock_ioctl(FAR struct socket *psock, int cmd, unsigned long arg)
  * Description:
  *   Perform network device specific operations.
  *
- * Parameters:
+ * Input Parameters:
  *   sockfd   Socket descriptor of device
  *   cmd      The ioctl command
  *   arg      The argument of the ioctl cmd

net/netdev/netdev_lladdrsize.c

@@ -65,7 +65,7 @@
  *   case that there ar mutiple packet radios.  In that case, we have to
  *   query the radio for its address length.
  *
- * Parameters:
+ * Input Parameters:
  *   dev - A reference to the device of interest
  *
  * Returned Value:
@@ -101,7 +101,7 @@ static inline int netdev_pktradio_addrlen(FAR struct net_driver_s *dev)
  * Description:
  *   Returns the size of the MAC address associated with a network device.
  *
- * Parameters:
+ * Input Parameters:
  *   dev - A reference to the device of interest
  *
  * Returned Value:

net/netdev/netdev_register.c

@@ -102,7 +102,7 @@ struct net_driver_s *g_netdevices = NULL;
  *   Given a device name format string, find the next device number for the
  *   class of device represented by that format string.
  *
- * Parameters:
+ * Input Parameters:
  *   devfmt - The device format string
  *
  * Returned Value:
@@ -153,7 +153,7 @@ static int find_devnum(FAR const char *devfmt)
  *   Register a network device driver and assign a name to it so that it can
  *   be found in subsequent network ioctl operations on the device.
  *
- * Parameters:
+ * Input Parameters:
  *   dev    - The device driver structure to be registered.
  *   lltype - Link level protocol used by the driver (Ethernet, SLIP, TUN, ...
  *              ...

net/netdev/netdev_txnotify.c

@@ -61,7 +61,7 @@
  *   Notify the device driver that forwards the IPv4 address that new TX
  *   data is available.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - The local address bound to the socket
  *   ripaddr - The remote address to send the data
  *
@@ -98,7 +98,7 @@ void netdev_ipv4_txnotify(in_addr_t lipaddr, in_addr_t ripaddr)
  *   Notify the device driver that forwards the IPv4 address that new TX
  *   data is available.
  *
- * Parameters:
+ * Input Parameters:
  *   lipaddr - The local address bound to the socket
  *   ripaddr - The remote address to send the data
  *
@@ -136,7 +136,7 @@ void netdev_ipv6_txnotify(FAR const net_ipv6addr_t lipaddr,
  *   would be called when the upper level logic already understands how the
  *   packet will be routed.
  *
- * Parameters:
+ * Input Parameters:
  *   dev - The network device driver state structure.
  *
  * Returned Value:

net/netdev/netdev_unregister.c

@@ -75,7 +75,7 @@
  * Description:
  *   Unregister a network device driver.
  *
- * Parameters:
+ * Input Parameters:
  *   dev - The device driver structure to un-register
  *
  * Returned Value: