Changeset 33fefc2 in rtems

Timestamp:

03/23/99 23:17:52 (24 years ago)

Author:

Joel Sherrill <joel.sherrill@…>

Branches:

4.10, 4.11, 4.8, 4.9, 5, master

Children:

33508cb

Parents:

e828c2dd

Message:

Patch from Eric Norum to account for new routine that improved
parsing of interface names.

File:

• doc/networking/driver.t (modified) (3 diffs)

doc/networking/driver.t

@@ -135 +135 @@
 @item ifp->if_name
 The name of the device.  The network stack uses this string
-and the device number for device name lookups.  The name should not
-contain digits as these will be assumed to be part of the unit number
-and not part of the device name.
-
+and the device number for device name lookups.  The device name should
+be obtained from the @code{name} entry in the configuration structure.
 
 @item ifp->if_unit
 The device number.  The network stack uses this number and the
 device name for device name lookups.  For example, if
-@code{ifp->if_name} is @samp{scc}, and @code{ifp->if_unit} is @samp{1},
-the full device name would be @samp{scc1}.
+@code{ifp->if_name} is @samp{scc} and @code{ifp->if_unit} is @samp{1},
+the full device name would be @samp{scc1}.  The unit number should be
+obtained from the `name' entry in the configuration structure.
 
 @item ifp->if_mtu
@@ -174 +173 @@
 @end table
 
+RTEMS provides a function to parse the driver name in the
+configuration structure into a device name and unit number.
+
+@example
+int rtems_bsdnet_parse_driver_name (
+  const struct rtems_bsdnet_ifconfig *config,
+  char **namep
+);
+@end example
+
+The function takes two arguments; a pointer to the configuration
+structure and a pointer to a pointer to a character.  The function
+parses the configuration name entry, allocates memory for the driver
+name, places the driver name in this memory, sets the second argument
+to point to the name and returns the unit number. 
+On error, a message is printed and -1 is returned.
+
 Once the attach function  has set up the above entries it must link the
 driver data structure onto the list of devices by
@@ -182 +198 @@
 The attach function should return a non-zero value to indicate that
 the driver has been successfully configured and attached.
-
-
-
 
 @section Write the Driver Start Function.