FreeBSD/Linux Kernel Cross Reference
sys/netinet/if_ether.h

     /*
      * Copyright (c) 1982, 1986, 1993
      *      The Regents of the University of California.  All rights reserved.
      *
      * Redistribution and use in source and binary forms, with or without
      * modification, are permitted provided that the following conditions
      * are met:
      * 1. Redistributions of source code must retain the above copyright
      *    notice, this list of conditions and the following disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     * 3. All advertising materials mentioning features or use of this software
     *    must display the following acknowledgement:
     *      This product includes software developed by the University of
     *      California, Berkeley and its contributors.
     * 4. Neither the name of the University nor the names of its contributors
     *    may be used to endorse or promote products derived from this software
     *    without specific prior written permission.
     *
     * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     * SUCH DAMAGE.
     *
     *      @(#)if_ether.h  8.3 (Berkeley) 5/2/95
     * $FreeBSD: src/sys/netinet/if_ether.h,v 1.15.2.1 1999/09/05 08:18:13 peter Exp $
     */
    
    #ifndef _NETINET_IF_ETHER_H_
    #define _NETINET_IF_ETHER_H_
    
    #include <net/ethernet.h>
    
    #define ETHERTYPE_PUP           0x0200  /* PUP protocol */
    #define ETHERTYPE_IP            0x0800  /* IP protocol */
    #define ETHERTYPE_ARP           0x0806  /* Addr. resolution protocol */
    #define ETHERTYPE_REVARP        0x8035  /* reverse Addr. resolution protocol */
    
    /*
     * The ETHERTYPE_NTRAILER packet types starting at ETHERTYPE_TRAIL have
     * (type-ETHERTYPE_TRAIL)*512 bytes of data followed
     * by an ETHER type (as given above) and then the (variable-length) header.
     */
    #define ETHERTYPE_TRAIL         0x1000          /* Trailer packet */
    #define ETHERTYPE_NTRAILER      16
    
    #define ETHERMTU        (ETHER_MAX_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
    #define ETHERMIN        (ETHER_MIN_LEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
    
    #ifdef KERNEL
    /*
     * Macro to map an IP multicast address to an Ethernet multicast address.
     * The high-order 25 bits of the Ethernet address are statically assigned,
     * and the low-order 23 bits are taken from the low end of the IP address.
     */
    #define ETHER_MAP_IP_MULTICAST(ipaddr, enaddr) \
            /* struct in_addr *ipaddr; */ \
            /* u_char enaddr[ETHER_ADDR_LEN];          */ \
    { \
            (enaddr)[0] = 0x01; \
            (enaddr)[1] = 0x00; \
            (enaddr)[2] = 0x5e; \
            (enaddr)[3] = ((u_char *)ipaddr)[1] & 0x7f; \
            (enaddr)[4] = ((u_char *)ipaddr)[2]; \
            (enaddr)[5] = ((u_char *)ipaddr)[3]; \
    }
    #endif
    
    /*
     * Ethernet Address Resolution Protocol.
     *
     * See RFC 826 for protocol description.  Structure below is adapted
     * to resolving internet addresses.  Field names used correspond to
     * RFC 826.
     */
    struct  ether_arp {
            struct  arphdr ea_hdr;  /* fixed-size header */
            u_char  arp_sha[ETHER_ADDR_LEN];        /* sender hardware address */
            u_char  arp_spa[4];     /* sender protocol address */
            u_char  arp_tha[ETHER_ADDR_LEN];        /* target hardware address */
            u_char  arp_tpa[4];     /* target protocol address */
    };
    #define arp_hrd ea_hdr.ar_hrd
    #define arp_pro ea_hdr.ar_pro
    #define arp_hln ea_hdr.ar_hln
    #define arp_pln ea_hdr.ar_pln
    #define arp_op  ea_hdr.ar_op
    
    
    /*
     * Structure shared between the ethernet driver modules and
    * the address resolution code.  For example, each ec_softc or il_softc
    * begins with this structure.
    */
   struct  arpcom {
           /*
            * The ifnet struct _must_ be at the head of this structure.
            */
           struct  ifnet ac_if;            /* network-visible interface */
           u_char  ac_enaddr[ETHER_ADDR_LEN];              /* ethernet hardware address */
           struct  ether_multi *ac_multiaddrs; /* list of ether multicast addrs */
           int     ac_multicnt;            /* length of ac_multiaddrs list */
   };
   
   struct sockaddr_inarp {
           u_char  sin_len;
           u_char  sin_family;
           u_short sin_port;
           struct  in_addr sin_addr;
           struct  in_addr sin_srcaddr;
           u_short sin_tos;
           u_short sin_other;
   #define SIN_PROXY 1
   };
   /*
    * IP and ethernet specific routing flags
    */
   #define RTF_USETRAILERS RTF_PROTO1      /* use trailers */
   #define RTF_ANNOUNCE    RTF_PROTO2      /* announce new arp entry */
   
   #ifdef  KERNEL
   extern u_char   etherbroadcastaddr[ETHER_ADDR_LEN];
   extern u_char   ether_ipmulticast_min[ETHER_ADDR_LEN];
   extern u_char   ether_ipmulticast_max[ETHER_ADDR_LEN];
   extern struct   ifqueue arpintrq;
   
   int     arpresolve __P((struct arpcom *, struct rtentry *, struct mbuf *,
                           struct sockaddr *, u_char *, struct rtentry *));
   void    arp_ifinit __P((struct arpcom *, struct ifaddr *));
   int     ether_addmulti __P((struct ifreq *, struct arpcom *));
   int     ether_delmulti __P((struct ifreq *, struct arpcom *));
   
   /*
    * Ethernet multicast address structure.  There is one of these for each
    * multicast address or range of multicast addresses that we are supposed
    * to listen to on a particular interface.  They are kept in a linked list,
    * rooted in the interface's arpcom structure.  (This really has nothing to
    * do with ARP, or with the Internet address family, but this appears to be
    * the minimally-disrupting place to put it.)
    */
   struct ether_multi {
           u_char  enm_addrlo[ETHER_ADDR_LEN];             /* low  or only address of range */
           u_char  enm_addrhi[ETHER_ADDR_LEN];             /* high or only address of range */
           struct  arpcom *enm_ac;         /* back pointer to arpcom */
           u_int   enm_refcount;           /* no. claims to this addr/range */
           struct  ether_multi *enm_next;  /* ptr to next ether_multi */
   };
   
   /*
    * Structure used by macros below to remember position when stepping through
    * all of the ether_multi records.
    */
   struct ether_multistep {
           struct ether_multi  *e_enm;
   };
   
   /*
    * Macro for looking up the ether_multi record for a given range of Ethernet
    * multicast addresses connected to a given arpcom structure.  If no matching
    * record is found, "enm" returns NULL.
    */
   #define ETHER_LOOKUP_MULTI(addrlo, addrhi, ac, enm) \
           /* u_char addrlo[ETHER_ADDR_LEN]; */ \
           /* u_char addrhi[ETHER_ADDR_LEN]; */ \
           /* struct arpcom *ac; */ \
           /* struct ether_multi *enm; */ \
   { \
           for ((enm) = (ac)->ac_multiaddrs; \
               (enm) != NULL && \
               (bcmp((enm)->enm_addrlo, (addrlo), ETHER_ADDR_LEN) != 0 || \
                bcmp((enm)->enm_addrhi, (addrhi), ETHER_ADDR_LEN) != 0); \
                   (enm) = (enm)->enm_next); \
   }
   
   /*
    * Macro to step through all of the ether_multi records, one at a time.
    * The current position is remembered in "step", which the caller must
    * provide.  ETHER_FIRST_MULTI(), below, must be called to initialize "step"
    * and get the first record.  Both macros return a NULL "enm" when there
    * are no remaining records.
    */
   #define ETHER_NEXT_MULTI(step, enm) \
           /* struct ether_multistep step; */  \
           /* struct ether_multi *enm; */  \
   { \
           if (((enm) = (step).e_enm) != NULL) \
                   (step).e_enm = (enm)->enm_next; \
   }
   
   #define ETHER_FIRST_MULTI(step, ac, enm) \
           /* struct ether_multistep step; */ \
           /* struct arpcom *ac; */ \
           /* struct ether_multi *enm; */ \
   { \
           (step).e_enm = (ac)->ac_multiaddrs; \
           ETHER_NEXT_MULTI((step), (enm)); \
   }
   
   #endif
   
   #endif

Cache object: 76809b1cf673fe819a4656eeff09da8f