lib/netdev.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 /* Generic interface to network devices.
  35  *
  36  * Currently, there is a single implementation of this interface that supports
  37  * Linux.  The interface should be generic enough to be implementable on other
  38  * operating systems as well. */
  39
  40 #ifndef NETDEV_H
  41 #define NETDEV_H 1
  42
  43 #include <stdbool.h>
  44 #include <stdint.h>
  45
  46 struct ofpbuf;
  47 struct in_addr;
  48 struct in6_addr;
  49
  50 enum netdev_feature_type {
  51     NETDEV_FEAT_CURRENT,
  52     NETDEV_FEAT_ADVERTISED,
  53     NETDEV_FEAT_SUPPORTED,
  54     NETDEV_FEAT_PEER
  55 };
  56
  57 enum netdev_flags {
  58     NETDEV_UP = 0x0001,         /* Device enabled? */
  59     NETDEV_PROMISC = 0x0002     /* Promiscuous mode? */
  60 };
  61
  62 enum netdev_pseudo_ethertype {
  63     NETDEV_ETH_TYPE_NONE = -128, /* Receive no frames. */
  64     NETDEV_ETH_TYPE_ANY,         /* Receive all frames. */
  65     NETDEV_ETH_TYPE_802_2        /* Receive all IEEE 802.2 frames. */
  66 };
  67
  68 struct netdev;
  69
  70 int netdev_open(const char *name, int ethertype, struct netdev **);
  71 int netdev_open_tap(const char *name, struct netdev **);
  72 void netdev_close(struct netdev *);
  73
  74 int netdev_recv(struct netdev *, struct ofpbuf *);
  75 void netdev_recv_wait(struct netdev *);
  76 int netdev_drain(struct netdev *);
  77 int netdev_send(struct netdev *, const struct ofpbuf *);
  78 int netdev_set_etheraddr(struct netdev *, const uint8_t mac[6]);
  79 const uint8_t *netdev_get_etheraddr(const struct netdev *);
  80 const char *netdev_get_name(const struct netdev *);
  81 int netdev_get_mtu(const struct netdev *);
  82 int netdev_get_link_status(const struct netdev *);
  83 uint32_t netdev_get_features(struct netdev *, int);
  84 bool netdev_get_in4(const struct netdev *, struct in_addr *);
  85 int netdev_set_in4(struct netdev *, struct in_addr addr, struct in_addr mask);
  86 int netdev_add_router(struct netdev *, struct in_addr router);
  87 bool netdev_get_in6(const struct netdev *, struct in6_addr *);
  88 int netdev_get_flags(const struct netdev *, enum netdev_flags *);
  89 int netdev_set_flags(struct netdev *, enum netdev_flags, bool permanent);
  90 int netdev_turn_flags_on(struct netdev *, enum netdev_flags, bool permanent);
  91 int netdev_turn_flags_off(struct netdev *, enum netdev_flags, bool permanent);
  92 int netdev_arp_lookup(const struct netdev *, uint32_t ip, uint8_t mac[6]);
  93
  94 #endif /* netdev.h */