Home | History | Annotate | Line # | Download | only in netinet
if_ether.h revision 1.5
      1 /*
      2  * Copyright (c) 1982, 1986 Regents of the University of California.
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  * 1. Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  * 2. Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in the
     12  *    documentation and/or other materials provided with the distribution.
     13  * 3. All advertising materials mentioning features or use of this software
     14  *    must display the following acknowledgement:
     15  *	This product includes software developed by the University of
     16  *	California, Berkeley and its contributors.
     17  * 4. Neither the name of the University nor the names of its contributors
     18  *    may be used to endorse or promote products derived from this software
     19  *    without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     31  * SUCH DAMAGE.
     32  *
     33  *	from: @(#)if_ether.h	7.5 (Berkeley) 6/28/90
     34  *	$Id: if_ether.h,v 1.5 1993/12/13 15:10:40 hpeyerl Exp $
     35  */
     36 
     37 #ifndef _NETINET_IF_ETHER_H_
     38 #define _NETINET_IF_ETHER_H_
     39 
     40 /*
     41  * Structure of a 10Mb/s Ethernet header.
     42  */
     43 struct	ether_header {
     44 	u_char	ether_dhost[6];
     45 	u_char	ether_shost[6];
     46 	u_short	ether_type;
     47 };
     48 
     49 #define	ETHERTYPE_PUP		0x0200	/* PUP protocol */
     50 #define	ETHERTYPE_IP		0x0800	/* IP protocol */
     51 #define ETHERTYPE_ARP		0x0806	/* address resolution protocol */
     52 #define ETHERTYPE_REVARP	0x8035	/* reverse addr resolution protocol */
     53 
     54 /*
     55  * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
     56  * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
     57  * by an ETHER type (as given above) and then the (variable-length) header.
     58  */
     59 #define	ETHERTYPE_TRAIL		0x1000		/* Trailer packet */
     60 #define	ETHERTYPE_NTRAILER	16
     61 
     62 #define	ETHERMTU	1500
     63 #define	ETHERMIN	(60-14)
     64 
     65 #ifdef KERNEL
     66 /*
     67  * Macro to map an IP multicast address to an Ethernet multicast address.
     68  * The high-order 25 bits of the Ethernet address are statically assigned,
     69  * and the low-order 23 bits are taken from the low end of the IP address.
     70  */
     71 #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
     72 	/* struct in_addr *ipaddr; */ \
     73 	/* u_char enaddr[6];       */ \
     74 { \
     75 	(enaddr)[0] = 0x01; \
     76 	(enaddr)[1] = 0x00; \
     77 	(enaddr)[2] = 0x5e; \
     78 	(enaddr)[3] = ((u_char *)ipaddr)[1] & 0x7f; \
     79 	(enaddr)[4] = ((u_char *)ipaddr)[2]; \
     80 	(enaddr)[5] = ((u_char *)ipaddr)[3]; \
     81 }
     82 #endif
     83 
     84 
     85 /*
     86  * Ethernet Address Resolution Protocol.
     87  *
     88  * See RFC 826 for protocol description.  Structure below is adapted
     89  * to resolving internet addresses.  Field names used correspond to
     90  * RFC 826.
     91  */
     92 struct	ether_arp {
     93 	struct	arphdr ea_hdr;	/* fixed-size header */
     94 	u_char	arp_sha[6];	/* sender hardware address */
     95 	u_char	arp_spa[4];	/* sender protocol address */
     96 	u_char	arp_tha[6];	/* target hardware address */
     97 	u_char	arp_tpa[4];	/* target protocol address */
     98 };
     99 #define	arp_hrd	ea_hdr.ar_hrd
    100 #define	arp_pro	ea_hdr.ar_pro
    101 #define	arp_hln	ea_hdr.ar_hln
    102 #define	arp_pln	ea_hdr.ar_pln
    103 #define	arp_op	ea_hdr.ar_op
    104 
    105 
    106 /*
    107  * Structure shared between the ethernet driver modules and
    108  * the address resolution code.  For example, each ec_softc or il_softc
    109  * begins with this structure.
    110  */
    111 struct	arpcom {
    112 	struct 	ifnet ac_if;		/* network-visible interface */
    113 	u_char	ac_enaddr[6];		/* ethernet hardware address */
    114 	struct in_addr ac_ipaddr;	/* copy of ip address- XXX */
    115 #ifdef MULTICAST
    116 	struct ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
    117 	int ac_multicnt;		/* length of ac_multiaddrs list */
    118 #endif
    119 };
    120 
    121 /*
    122  * Internet to ethernet address resolution table.
    123  */
    124 struct	arptab {
    125 	struct	in_addr at_iaddr;	/* internet address */
    126 	u_char	at_enaddr[6];		/* ethernet address */
    127 	u_char	at_timer;		/* minutes since last reference */
    128 	u_char	at_flags;		/* flags */
    129 	struct	mbuf *at_hold;		/* last packet until resolved/timeout */
    130 };
    131 
    132 #ifdef	KERNEL
    133 u_char	etherbroadcastaddr[6];
    134 #if defined(ISO) && !defined(MULTICAST)
    135 #define MULTICAST 1
    136 #endif
    137 #ifdef MULTICAST
    138 u_char	ether_ipmulticast_min[6];
    139 u_char	ether_ipmulticast_max[6];
    140 #endif
    141 struct	arptab *arptnew();
    142 int	ether_output(), ether_input();
    143 char	*ether_sprintf();
    144 
    145 #ifdef MULTICAST
    146 /*
    147  * Ethernet multicast address structure.  There is one of these for each
    148  * multicast address or range of multicast addresses that we are supposed
    149  * to listen to on a particular interface.  They are kept in a linked list,
    150  * rooted in the interface's arpcom structure.  (This really has nothing to
    151  * do with ARP, or with the Internet address family, but this appears to be
    152  * the minimally-disrupting place to put it.)
    153  */
    154 struct ether_multi {
    155 	u_char	enm_addrlo[6];		/* low  or only address of range */
    156 	u_char	enm_addrhi[6];		/* high or only address of range */
    157 	struct	arpcom *enm_ac;		/* back pointer to arpcom */
    158 	u_int	enm_refcount;		/* no. claims to this addr/range */
    159 	struct	ether_multi *enm_next;	/* ptr to next ether_multi */
    160 };
    161 
    162 /*
    163  * Structure used by macros below to remember position when stepping through
    164  * all of the ether_multi records.
    165  */
    166 struct ether_multistep {
    167 	struct ether_multi  *e_enm;
    168 };
    169 
    170 /*
    171  * Macro for looking up the ether_multi record for a given range of Ethernet
    172  * multicast addresses connected to a given arpcom structure.  If no matching
    173  * record is found, "enm" returns NULL.
    174  */
    175 #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \
    176 	/* u_char addrlo[6]; */ \
    177 	/* u_char addrhi[6]; */ \
    178 	/* struct arpcom *ac; */ \
    179 	/* struct ether_multi *enm; */ \
    180 { \
    181 	for ((enm) = (ac)->ac_multiaddrs; \
    182 	    (enm) != NULL && \
    183 	    (bcmp((enm)->enm_addrlo, (addrlo), 6) != 0 || \
    184 	     bcmp((enm)->enm_addrhi, (addrhi), 6) != 0); \
    185 		(enm) = (enm)->enm_next); \
    186 }
    187 
    188 /*
    189  * Macro to step through all of the ether_multi records, one at a time.
    190  * The current position is remembered in "step", which the caller must
    191  * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
    192  * and get the first record.  Both macros return a NULL "enm" when there
    193  * are no remaining records.
    194  */
    195 #define ETHER_NEXT_MULTI(step, enm) \
    196 	/* struct ether_multistep step; */  \
    197 	/* struct ether_multi *enm; */  \
    198 { \
    199 	if (((enm) = (step).e_enm) != NULL) \
    200 		(step).e_enm = (enm)->enm_next; \
    201 }
    202 
    203 #define ETHER_FIRST_MULTI(step, ac, enm) \
    204 	/* struct ether_multistep step; */ \
    205 	/* struct arpcom *ac; */ \
    206 	/* struct ether_multi *enm; */ \
    207 { \
    208 	(step).e_enm = (ac)->ac_multiaddrs; \
    209 	ETHER_NEXT_MULTI((step), (enm)); \
    210 }
    211 #endif
    212 #endif
    213 
    214 #endif /* !_NETINET_IF_ETHER_H_ */
    215