sys/net/if_vlan_var.h

   1 /*-
   2  * Copyright 1998 Massachusetts Institute of Technology
   3  *
   4  * Permission to use, copy, modify, and distribute this software and
   5  * its documentation for any purpose and without fee is hereby
   6  * granted, provided that both the above copyright notice and this
   7  * permission notice appear in all copies, that both the above
   8  * copyright notice and this permission notice appear in all
   9  * supporting documentation, and that the name of M.I.T. not be used
  10  * in advertising or publicity pertaining to distribution of the
  11  * software without specific, written prior permission.  M.I.T. makes
  12  * no representations about the suitability of this software for any
  13  * purpose.  It is provided "as is" without express or implied
  14  * warranty.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _NET_IF_VLAN_VAR_H_
  33 #define _NET_IF_VLAN_VAR_H_     1
  34
  35 /* Set the VLAN ID in an mbuf packet header non-destructively. */
  36 #define EVL_APPLY_VLID(m, vlid)                                         \
  37         do {                                                            \
  38                 if ((m)->m_flags & M_VLANTAG) {                         \
  39                         (m)->m_pkthdr.ether_vtag &= EVL_VLID_MASK;      \
  40                         (m)->m_pkthdr.ether_vtag |= (vlid);             \
  41                 } else {                                                \
  42                         (m)->m_pkthdr.ether_vtag = (vlid);              \
  43                         (m)->m_flags |= M_VLANTAG;                      \
  44                 }                                                       \
  45         } while (0)
  46
  47 /* Set the priority ID in an mbuf packet header non-destructively. */
  48 #define EVL_APPLY_PRI(m, pri)                                           \
  49         do {                                                            \
  50                 if ((m)->m_flags & M_VLANTAG) {                         \
  51                         uint16_t __vlantag = (m)->m_pkthdr.ether_vtag;  \
  52                         (m)->m_pkthdr.ether_vtag |= EVL_MAKETAG(        \
  53                             EVL_VLANOFTAG(__vlantag), (pri),            \
  54                             EVL_CFIOFTAG(__vlantag));                   \
  55                 } else {                                                \
  56                         (m)->m_pkthdr.ether_vtag =                      \
  57                             EVL_MAKETAG(0, (pri), 0);                   \
  58                         (m)->m_flags |= M_VLANTAG;                      \
  59                 }                                                       \
  60         } while (0)
  61
  62 /* sysctl(3) tags, for compatibility purposes */
  63 #define VLANCTL_PROTO   1
  64 #define VLANCTL_MAX     2
  65
  66 /*
  67  * Configuration structure for SIOCSETVLAN and SIOCGETVLAN ioctls.
  68  */
  69 struct  vlanreq {
  70         char    vlr_parent[IFNAMSIZ];
  71         u_short vlr_tag;
  72 };
  73 #define SIOCSETVLAN     SIOCSIFGENERIC
  74 #define SIOCGETVLAN     SIOCGIFGENERIC
  75
  76 #ifdef _KERNEL
  77 /*
  78  * Drivers that are capable of adding and removing the VLAN header
  79  * in hardware indicate they support this by marking IFCAP_VLAN_HWTAGGING
  80  * in if_capabilities.  Drivers for hardware that is capable
  81  * of handling larger MTU's that may include a software-appended
  82  * VLAN header w/o lowering the normal MTU should mark IFCAP_VLAN_MTU
  83  * in if_capabilities; this notifies the VLAN code it can leave the
  84  * MTU on the vlan interface at the normal setting.
  85  */
  86
  87 /*
  88  * VLAN tags are stored in host byte order.  Byte swapping may be
  89  * necessary.
  90  *
  91  * Drivers that support hardware VLAN tag stripping fill in the
  92  * received VLAN tag (containing both vlan and priority information)
  93  * into the ether_vtag mbuf packet header field:
  94  *
  95  *      m->m_pkthdr.ether_vtag = vtag;          // ntohs()?
  96  *      m->m_flags |= M_VLANTAG;
  97  *
  98  * to mark the packet m with the specified VLAN tag.
  99  *
 100  * On output the driver should check the mbuf for the M_VLANTAG
 101  * flag to see if a VLAN tag is present and valid:
 102  *
 103  *      if (m->m_flags & M_VLANTAG) {
 104  *              ... = m->m_pkthdr.ether_vtag;   // htons()?
 105  *              ... pass tag to hardware ...
 106  *      }
 107  *
 108  * Note that a driver must indicate it supports hardware VLAN
 109  * stripping/insertion by marking IFCAP_VLAN_HWTAGGING in
 110  * if_capabilities.
 111  */
 112
 113 #define VLAN_CAPABILITIES(_ifp) do {                            \
 114         if ((_ifp)->if_vlantrunk != NULL)                       \
 115                 (*vlan_trunk_cap_p)(_ifp);                      \
 116 } while (0)
 117
 118 #define VLAN_TRUNKDEV(_ifp)                                     \
 119         (_ifp)->if_type == IFT_L2VLAN ? (*vlan_trunkdev_p)((_ifp)) : NULL
 120 #define VLAN_TAG(_ifp, _vid)                                    \
 121         (_ifp)->if_type == IFT_L2VLAN ? (*vlan_tag_p)((_ifp), (_vid)) : EINVAL
 122 #define VLAN_COOKIE(_ifp)                                       \
 123         (_ifp)->if_type == IFT_L2VLAN ? (*vlan_cookie_p)((_ifp)) : NULL
 124 #define VLAN_SETCOOKIE(_ifp, _cookie)                           \
 125         (_ifp)->if_type == IFT_L2VLAN ?                         \
 126             (*vlan_setcookie_p)((_ifp), (_cookie)) : EINVAL
 127 #define VLAN_DEVAT(_ifp, _vid)                                  \
 128         (_ifp)->if_vlantrunk != NULL ? (*vlan_devat_p)((_ifp), (_vid)) : NULL
 129
 130 extern  void (*vlan_trunk_cap_p)(struct ifnet *);
 131 extern  struct ifnet *(*vlan_trunkdev_p)(struct ifnet *);
 132 extern  struct ifnet *(*vlan_devat_p)(struct ifnet *, uint16_t);
 133 extern  int (*vlan_tag_p)(struct ifnet *, uint16_t *);
 134 extern  int (*vlan_setcookie_p)(struct ifnet *, void *);
 135 extern  void *(*vlan_cookie_p)(struct ifnet *);
 136
 137 #ifdef _SYS_EVENTHANDLER_H_
 138 /* VLAN state change events */
 139 typedef void (*vlan_config_fn)(void *, struct ifnet *, uint16_t);
 140 typedef void (*vlan_unconfig_fn)(void *, struct ifnet *, uint16_t);
 141 EVENTHANDLER_DECLARE(vlan_config, vlan_config_fn);
 142 EVENTHANDLER_DECLARE(vlan_unconfig, vlan_unconfig_fn);
 143 #endif /* _SYS_EVENTHANDLER_H_ */
 144
 145 #endif /* _KERNEL */
 146
 147 #endif /* _NET_IF_VLAN_VAR_H_ */