vswitchd: Add miimon support.
[sliver-openvswitch.git] / lib / netdev-provider.h
index 52f440f..9c75ccb 100644 (file)
@@ -40,7 +40,7 @@ struct arg {
  * implementations. */
 struct netdev_dev {
     char *name;                         /* Name of network device. */
-    const struct netdev_class *netdev_class; /* Functions to control 
+    const struct netdev_class *netdev_class; /* Functions to control
                                                 this device. */
     int ref_cnt;                        /* Times this devices was opened. */
     struct shash_node *node;            /* Pointer to element in global map. */
@@ -129,11 +129,11 @@ struct netdev_class {
      * to be called.  May be null if nothing is needed here. */
     void (*wait)(void);
 
-    /* Attempts to create a network device of 'type' with 'name'.
-     * 'type' corresponds to the 'type' field used in the netdev_class
-     * structure. On success sets 'netdev_devp' to the newly created device. */
-    int (*create)(const char *name, const char *type, const struct shash *args,
-                  struct netdev_dev **netdev_devp);
+    /* Attempts to create a network device named 'name' with initial 'args' in
+     * 'netdev_class'.  On success sets 'netdev_devp' to the newly created
+     * device. */
+    int (*create)(const struct netdev_class *netdev_class, const char *name,
+                  const struct shash *args, struct netdev_dev **netdev_devp);
 
     /* Destroys 'netdev_dev'.
      *
@@ -259,9 +259,21 @@ struct netdev_class {
     int (*get_ifindex)(const struct netdev *netdev);
 
     /* Sets 'carrier' to true if carrier is active (link light is on) on
-     * 'netdev'. */
+     * 'netdev'.
+     *
+     * May be null if device does not provide carrier status (will be always
+     * up as long as device is up).
+     */
     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.
+     *
+     * This function may be set to null if it would always return EOPNOTSUPP.
+     */
+    int (*get_miimon)(const struct netdev *netdev, bool *miimon);
+
     /* Retrieves current device stats for 'netdev' into 'stats'.
      *
      * A network device that supports some statistics but not others, it should
@@ -514,6 +526,20 @@ struct netdev_class {
     int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
                         char **netdev_name);
 
+    /* Retrieves the status of the device.
+     *
+     * Populates 'sh' with key-value pairs representing the status of the
+     * device.  A device's status is a set of key-value string pairs
+     * representing netdev type specific information.  For more information see
+     * ovs-vswitchd.conf.db(5).
+     *
+     * The data of 'sh' are heap allocated strings which the caller is
+     * responsible for deallocating.
+     *
+     * This function may be set to null if it would always return EOPNOTSUPP
+     * anyhow. */
+    int (*get_status)(const struct netdev *netdev, struct shash *sh);
+
     /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
      * corresponding MAC address in 'mac'.  A return value of ENXIO, in
      * particular, indicates that there is no ARP table entry for 'ip' on
@@ -546,10 +572,13 @@ struct netdev_class {
     void (*poll_remove)(struct netdev_notifier *notifier);
 };
 
+int netdev_register_provider(const struct netdev_class *);
+int netdev_unregister_provider(const char *type);
+const struct netdev_class *netdev_lookup_provider(const char *type);
+
 extern const struct netdev_class netdev_linux_class;
+extern const struct netdev_class netdev_internal_class;
 extern const struct netdev_class netdev_tap_class;
-extern const struct netdev_class netdev_patch_class;
-extern const struct netdev_class netdev_gre_class;
 
 #ifdef  __cplusplus
 }