include/sys/ethernet.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2014 Garrett D'Amore <garrett@damore.org>
  23  *
  24  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  25  * Use is subject to license terms.
  26  */
  27
  28 /*
  29  * ethernet.h header for common Ethernet declarations.
  30  */
  31
  32 #ifndef _SYS_ETHERNET_H
  33 #define _SYS_ETHERNET_H
  34
  35 #ifdef  __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 #define ETHERADDRL      (6)             /* ethernet address length in octets */
  40 #define ETHERFCSL       (4)             /* ethernet FCS length in octets */
  41 #define ETHERADDRSTRL   (18)            /* char size of ETHERADDRL with null */
  42
  43 /*
  44  * Ethernet address - 6 octets
  45  */
  46 typedef uchar_t ether_addr_t[ETHERADDRL];
  47
  48 /*
  49  * Ethernet address - 6 octets
  50  */
  51 struct  ether_addr {
  52         ether_addr_t    ether_addr_octet;
  53 };
  54
  55 /*
  56  * Structure of a 10Mb/s Ethernet header.
  57  */
  58 struct  ether_header {
  59         struct  ether_addr      ether_dhost;
  60         struct  ether_addr      ether_shost;
  61         ushort_t                ether_type;
  62 };
  63
  64 #define ETHER_CFI       0
  65
  66 struct  ether_vlan_header {
  67         struct  ether_addr      ether_dhost;
  68         struct  ether_addr      ether_shost;
  69         ushort_t                ether_tpid;
  70         ushort_t                ether_tci;
  71         ushort_t                ether_type;
  72 };
  73
  74 /*
  75  * The VLAN tag.  Available for applications that cannot make use of struct
  76  * ether_vlan_header because they assume Ethernet encapsulation.
  77  */
  78 struct ether_vlan_extinfo {
  79         ushort_t                ether_tci;
  80         ushort_t                ether_type;
  81 };
  82
  83 #define ETHERTYPE_PUP           (0x0200)        /* PUP protocol */
  84 #define ETHERTYPE_802_MIN       (0x0600)        /* Min valid ethernet type */
  85                                                 /* under IEEE 802.3 rules */
  86 #define ETHERTYPE_IP            (0x0800)        /* IP protocol */
  87 #define ETHERTYPE_ARP           (0x0806)        /* Addr. resolution protocol */
  88 #define ETHERTYPE_REVARP        (0x8035)        /* Reverse ARP */
  89 #define ETHERTYPE_AT            (0x809b)        /* AppleTalk protocol */
  90 #define ETHERTYPE_AARP          (0x80f3)        /* AppleTalk ARP */
  91 #define ETHERTYPE_VLAN          (0x8100)        /* 802.1Q VLAN */
  92 #define ETHERTYPE_IPV6          (0x86dd)        /* IPv6 */
  93 #define ETHERTYPE_SLOW          (0x8809)        /* Slow Protocol */
  94 #define ETHERTYPE_PPPOED        (0x8863)        /* PPPoE Discovery Stage */
  95 #define ETHERTYPE_PPPOES        (0x8864)        /* PPPoE Session Stage */
  96 #define ETHERTYPE_EAPOL         (0x888e)        /* EAPOL protocol */
  97 #define ETHERTYPE_RSN_PREAUTH   (0x88c7)        /* RSN PRE-Authentication */
  98 #define ETHERTYPE_TRILL         (0x88c8)        /* TBD. TRILL frame */
  99 #define ETHERTYPE_FCOE          (0x8906)        /* FCoE */
 100 #define ETHERTYPE_MAX           (0xffff)        /* Max valid ethernet type */
 101
 102 /*
 103  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
 104  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
 105  * by an ETHER type (as given above) and then the (variable-length) header.
 106  */
 107 #define ETHERTYPE_TRAIL         (0x1000)        /* Trailer packet */
 108 #define ETHERTYPE_NTRAILER      (16)
 109
 110 #define ETHERMTU                (1500)  /* max frame w/o header or fcs */
 111 #define ETHERMIN                (60)    /* min frame w/header w/o fcs */
 112 #define ETHERMAX                (1514)  /* max frame w/header w/o fcs */
 113
 114 /*
 115  * Compare two Ethernet addresses - assumes that the two given
 116  * pointers can be referenced as shorts.  On architectures
 117  * where this is not the case, use bcmp instead.  Note that like
 118  * bcmp, we return zero if they are the SAME.
 119  */
 120
 121 #if defined(__sparc) || defined(__i386) || defined(__amd64)
 122 #define ether_cmp(a, b) (((short *)b)[2] != ((short *)a)[2] || \
 123         ((short *)b)[1] != ((short *)a)[1] || \
 124         ((short *)b)[0] != ((short *)a)[0])
 125 #else
 126 #define ether_cmp(a, b) (bcmp((caddr_t)a, (caddr_t)b, 6))
 127 #endif
 128
 129 /*
 130  * Copy Ethernet addresses from a to b - assumes that the two given
 131  * pointers can be referenced as shorts.  On architectures
 132  * where this is not the case, use bcopy instead.
 133  */
 134
 135 #if defined(__sparc) || defined(__i386) || defined(__amd64)
 136 #define ether_copy(a, b) { ((short *)b)[0] = ((short *)a)[0]; \
 137         ((short *)b)[1] = ((short *)a)[1]; ((short *)b)[2] = ((short *)a)[2]; }
 138 #else
 139 #define ether_copy(a, b) (bcopy((caddr_t)a, (caddr_t)b, 6))
 140 #endif
 141
 142 #ifdef  _KERNEL
 143 extern int localetheraddr(struct ether_addr *, struct ether_addr *);
 144 extern char *ether_sprintf(struct ether_addr *);
 145 extern int ether_aton(char *, uchar_t *);
 146 #else   /* _KERNEL */
 147 extern char *ether_ntoa(const struct ether_addr *);
 148 extern char *ether_ntoa_r(const struct ether_addr *, char *);
 149 extern struct ether_addr *ether_aton(const char *);
 150 extern struct ether_addr *ether_aton_r(const char *, struct ether_addr *);
 151 extern int ether_ntohost(char *, const struct ether_addr *);
 152 extern int ether_hostton(const char *, struct ether_addr *);
 153 extern int ether_line(const char *, struct ether_addr *, char *);
 154 #endif  /* _KERNEL */
 155
 156 #ifdef  __cplusplus
 157 }
 158 #endif
 159
 160 #endif  /* _SYS_ETHERNET_H */