From 33f1ff8464641c392fb713fe4e45be0c18a6b047 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Mon, 30 Apr 2012 11:23:38 -0700 Subject: [PATCH] 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 --- lib/netdev-provider.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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'. -- 2.43.0