Home | History | Annotate | Line # | Download | only in net
if_ether.h revision 1.8
      1 /*	$NetBSD: if_ether.h,v 1.8 1999/04/09 09:32:51 drochner Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1982, 1986, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by the University of
     18  *	California, Berkeley and its contributors.
     19  * 4. Neither the name of the University nor the names of its contributors
     20  *    may be used to endorse or promote products derived from this software
     21  *    without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  *	@(#)if_ether.h	8.1 (Berkeley) 6/10/93
     36  */
     37 
     38 #ifndef _NET_IF_ETHER_H_
     39 #define _NET_IF_ETHER_H_
     40 
     41 /*
     42  * Some basic Ethernet constants.
     43  */
     44 #define	ETHER_ADDR_LEN	6	/* length of an Ethernet address */
     45 #define	ETHER_TYPE_LEN	2	/* length of the Ethernet type field */
     46 #define	ETHER_CRC_LEN	4	/* length of the Ethernet CRC */
     47 #define	ETHER_HDR_LEN	((ETHER_ADDR_LEN * 2) + ETHER_TYPE_LEN)
     48 #define	ETHER_MIN_LEN	64	/* minimum frame length, including CRC */
     49 #define	ETHER_MAX_LEN	1518	/* maximum frame length, including CRC */
     50 
     51 /*
     52  * Ethernet address - 6 octets
     53  * this is only used by the ethers(3) functions.
     54  */
     55 struct ether_addr {
     56 	u_int8_t ether_addr_octet[ETHER_ADDR_LEN];
     57 };
     58 
     59 /*
     60  * Structure of a 10Mb/s Ethernet header.
     61  */
     62 struct	ether_header {
     63 	u_int8_t  ether_dhost[ETHER_ADDR_LEN];
     64 	u_int8_t  ether_shost[ETHER_ADDR_LEN];
     65 	u_int16_t ether_type;
     66 };
     67 
     68 #include <net/ethertypes.h>
     69 
     70 #define	ETHER_IS_MULTICAST(addr) (*(addr) & 0x01) /* is address mcast/bcast? */
     71 
     72 #define	ETHERMTU	(ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
     73 #define	ETHERMIN	(ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
     74 
     75 #ifndef _STANDALONE
     76 
     77 #ifdef _KERNEL
     78 /*
     79  * Macro to map an IP multicast address to an Ethernet multicast address.
     80  * The high-order 25 bits of the Ethernet address are statically assigned,
     81  * and the low-order 23 bits are taken from the low end of the IP address.
     82  */
     83 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr)				\
     84 	/* struct in_addr *ipaddr; */					\
     85 	/* u_int8_t enaddr[ETHER_ADDR_LEN]; */				\
     86 {									\
     87 	(enaddr)[0] = 0x01;						\
     88 	(enaddr)[1] = 0x00;						\
     89 	(enaddr)[2] = 0x5e;						\
     90 	(enaddr)[3] = ((u_int8_t *)ipaddr)[1] & 0x7f;			\
     91 	(enaddr)[4] = ((u_int8_t *)ipaddr)[2];				\
     92 	(enaddr)[5] = ((u_int8_t *)ipaddr)[3];				\
     93 }
     94 #endif
     95 
     96 /*
     97  * Structure shared between the ethernet driver modules and
     98  * the multicast list code.  For example, each ec_softc or il_softc
     99  * begins with this structure.
    100  */
    101 struct	ethercom {
    102 	struct	 ifnet ec_if;			/* network-visible interface */
    103 	LIST_HEAD(, ether_multi) ec_multiaddrs;	/* list of ether multicast addrs */
    104 	int	 ec_multicnt;			/* length of ac_multiaddrs list */
    105 };
    106 
    107 #ifdef	_KERNEL
    108 u_int8_t etherbroadcastaddr[ETHER_ADDR_LEN];
    109 u_int8_t ether_ipmulticast_min[ETHER_ADDR_LEN];
    110 u_int8_t ether_ipmulticast_max[ETHER_ADDR_LEN];
    111 
    112 int	ether_addmulti __P((struct ifreq *, struct ethercom *));
    113 int	ether_delmulti __P((struct ifreq *, struct ethercom *));
    114 #endif /* _KERNEL */
    115 
    116 /*
    117  * Ethernet multicast address structure.  There is one of these for each
    118  * multicast address or range of multicast addresses that we are supposed
    119  * to listen to on a particular interface.  They are kept in a linked list,
    120  * rooted in the interface's ethercom structure.
    121  */
    122 struct ether_multi {
    123 	u_int8_t enm_addrlo[ETHER_ADDR_LEN]; /* low  or only address of range */
    124 	u_int8_t enm_addrhi[ETHER_ADDR_LEN]; /* high or only address of range */
    125 	struct	 ethercom *enm_ec;	/* back pointer to ethercom */
    126 	u_int	 enm_refcount;		/* no. claims to this addr/range */
    127 	LIST_ENTRY(ether_multi) enm_list;
    128 };
    129 
    130 /*
    131  * Structure used by macros below to remember position when stepping through
    132  * all of the ether_multi records.
    133  */
    134 struct ether_multistep {
    135 	struct ether_multi  *e_enm;
    136 };
    137 
    138 /*
    139  * Macro for looking up the ether_multi record for a given range of Ethernet
    140  * multicast addresses connected to a given ethercom structure.  If no matching
    141  * record is found, "enm" returns NULL.
    142  */
    143 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ec, enm)			\
    144 	/* u_int8_t addrlo[ETHER_ADDR_LEN]; */				\
    145 	/* u_int8_t addrhi[ETHER_ADDR_LEN]; */				\
    146 	/* struct ethercom *ec; */					\
    147 	/* struct ether_multi *enm; */					\
    148 {									\
    149 	for ((enm) = (ec)->ec_multiaddrs.lh_first;			\
    150 	    (enm) != NULL &&						\
    151 	    (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 ||	\
    152 	     bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0);	\
    153 		(enm) = (enm)->enm_list.le_next);			\
    154 }
    155 
    156 /*
    157  * Macro to step through all of the ether_multi records, one at a time.
    158  * The current position is remembered in "step", which the caller must
    159  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
    160  * and get the first record.  Both macros return a NULL "enm" when there
    161  * are no remaining records.
    162  */
    163 #define ETHER_NEXT_MULTI(step, enm) \
    164 	/* struct ether_multistep step; */  \
    165 	/* struct ether_multi *enm; */  \
    166 { \
    167 	if (((enm) = (step).e_enm) != NULL) \
    168 		(step).e_enm = (enm)->enm_list.le_next; \
    169 }
    170 
    171 #define ETHER_FIRST_MULTI(step, ec, enm) \
    172 	/* struct ether_multistep step; */ \
    173 	/* struct ethercom *ec; */ \
    174 	/* struct ether_multi *enm; */ \
    175 { \
    176 	(step).e_enm = (ec)->ec_multiaddrs.lh_first; \
    177 	ETHER_NEXT_MULTI((step), (enm)); \
    178 }
    179 
    180 /*
    181  * Prototype ethers(3) functions.
    182  */
    183 #ifndef _KERNEL
    184 #include <sys/cdefs.h>
    185 __BEGIN_DECLS
    186 char *	ether_ntoa __P((struct ether_addr *));
    187 struct ether_addr *
    188 	ether_aton __P((const char *));
    189 int	ether_ntohost __P((char *, struct ether_addr *));
    190 int	ether_hostton __P((const char *, struct ether_addr *));
    191 int	ether_line __P((const char *, struct ether_addr *, char *));
    192 __END_DECLS
    193 #endif
    194 
    195 #endif /* _STANDALONE */
    196 
    197 #endif /* _NET_IF_ETHER_H_ */
    198