CFM: Revert default MA and MD name.
[openvswitch] / lib / netdev-provider.h
index be51c48a541f8d94d3847edc7dbf79c8a159efa3..23de420f43559ef55c86df4c81187f9e428b77f5 100644 (file)
@@ -166,7 +166,7 @@ struct netdev_class {
      *
      * If this netdev class does not support enumeration, this may be a null
      * pointer. */
-    int (*enumerate)(struct svec *all_names);
+    int (*enumerate)(struct sset *all_names);
 
     /* Attempts to receive a packet from 'netdev' into the 'size' bytes in
      * 'buffer'.  If successful, returns the number of bytes in the received
@@ -175,10 +175,9 @@ struct netdev_class {
      *
      * May return -EOPNOTSUPP if a network device does not implement packet
      * reception through this interface.  This function may be set to null if
-     * it would always return -EOPNOTSUPP anyhow.  (This will disable the OVS
-     * integrated DHCP client and OpenFlow controller discovery, and prevent
-     * the network device from being usefully used by the netdev-based
-     * "userspace datapath".) */
+     * it would always return -EOPNOTSUPP anyhow.  (This will prevent the
+     * network device from being usefully used by the netdev-based "userspace
+     * datapath".) */
     int (*recv)(struct netdev *netdev, void *buffer, size_t size);
 
     /* Registers with the poll loop to wake up from the next call to
@@ -209,10 +208,10 @@ struct netdev_class {
      *
      * May return EOPNOTSUPP if a network device does not implement packet
      * transmission through this interface.  This function may be set to null
-     * if it would always return EOPNOTSUPP anyhow.  (This will disable the OVS
-     * integrated DHCP client and OpenFlow controller discovery, and prevent
-     * the network device from being usefully used by the netdev-based
-     * "userspace datapath".) */
+     * if it would always return EOPNOTSUPP anyhow.  (This will prevent the
+     * network device from being usefully used by the netdev-based "userspace
+     * datapath".  It will also prevent the OVS implementation of bonding from
+     * working properly over 'netdev'.) */
     int (*send)(struct netdev *netdev, const void *buffer, size_t size);
 
     /* Registers with the poll loop to wake up from the next call to
@@ -264,13 +263,17 @@ struct netdev_class {
      */
     int (*get_carrier)(const struct netdev *netdev, bool *carrier);
 
-    /* Sets 'miimon' to true if 'netdev' is up according to its MII.  If
-     * 'netdev' does not support MII, may fall back to another method or return
-     * EOPNOTSUPP.
+    /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
+     * instead of checking 'netdev''s carrier.  'netdev''s MII registers will
+     * be polled once ever 'interval' milliseconds.  If 'netdev' does not
+     * support MII, another method may be used as a fallback.  If 'interval' is
+     * less than or equal to zero, reverts ->get_carrier() to its normal
+     * behavior.
      *
-     * This function may be set to null if it would always return EOPNOTSUPP.
+     * Most network devices won't support this feature and will set this
+     * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
      */
-    int (*get_miimon)(const struct netdev *netdev, bool *miimon);
+    int (*set_miimon_interval)(struct netdev *netdev, long long int interval);
 
     /* Retrieves current device stats for 'netdev' into 'stats'.
      *
@@ -332,11 +335,11 @@ struct netdev_class {
      * this function must not add "" to 'types'.
      *
      * The caller is responsible for initializing 'types' (e.g. with
-     * svec_init()) before calling this function.  The caller takes ownership
-     * of the strings added to 'types'.
+     * sset_init()) before calling this function.  The caller retains ownership
+     * of 'types'.
      *
      * May be NULL if 'netdev' does not support QoS at all. */
-    int (*get_qos_types)(const struct netdev *netdev, struct svec *types);
+    int (*get_qos_types)(const struct netdev *netdev, struct sset *types);
 
     /* Queries 'netdev' for its capabilities regarding the specified 'type' of
      * QoS.  On success, initializes 'caps' with the QoS capabilities.
@@ -545,7 +548,8 @@ struct netdev_class {
      *
      * This function may be set to null if it would always return EOPNOTSUPP
      * anyhow. */
-    int (*arp_lookup)(const struct netdev *netdev, uint32_t ip, uint8_t mac[6]);
+    int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip,
+                      uint8_t mac[6]);
 
     /* Retrieves the current set of flags on 'netdev' into '*old_flags'.
      * Then, turns off the flags that are set to 1 in 'off' and turns on the