summaryrefslogtreecommitdiff
path: root/lib/netdev-provider.h
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2012-04-30 11:23:38 -0700
committerBen Pfaff <blp@nicira.com>2012-05-01 14:29:35 -0700
commit33f1ff8464641c392fb713fe4e45be0c18a6b047 (patch)
tree779b671e9fa76ddb675d139cbca3709a07e3a3cf /lib/netdev-provider.h
parent1ea9e6097969ecca167827b68a6492127992c82b (diff)
downloadopenvswitch-33f1ff8464641c392fb713fe4e45be0c18a6b047.tar.gz
netdev: Document use for get_etheraddr member of struct netdev_class.
This has confused developers adding hardware support, e.g.: http://openvswitch.org/pipermail/dev/2012-April/016350.html Signed-off-by: Ben Pfaff <blp@nicira.com>
Diffstat (limited to 'lib/netdev-provider.h')
-rw-r--r--lib/netdev-provider.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/netdev-provider.h b/lib/netdev-provider.h
index daf46adee..6daae5e6c 100644
--- a/lib/netdev-provider.h
+++ b/lib/netdev-provider.h
@@ -231,7 +231,10 @@ struct netdev_class {
/* Sets 'netdev''s Ethernet address to 'mac' */
int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
- /* Retrieves 'netdev''s Ethernet address into 'mac'. */
+ /* Retrieves 'netdev''s Ethernet address into 'mac'.
+ *
+ * This address will be advertised as 'netdev''s MAC address through the
+ * OpenFlow protocol, among other uses. */
int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
/* Retrieves 'netdev''s MTU into '*mtup'.