/**
|
* @file
|
* Ethernet protocol definitions
|
*/
|
|
/*
|
* Copyright (c) 2001-2004 Swedish Institute of Computer Science.
|
* 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. The name of the author may not be used to endorse or promote products
|
* derived from this software without specific prior written permission.
|
*
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
*
|
* This file is part of the lwIP TCP/IP stack.
|
*
|
* Author: Adam Dunkels <adam@sics.se>
|
*
|
*/
|
#ifndef LWIP_HDR_PROT_ETHERNET_H
|
#define LWIP_HDR_PROT_ETHERNET_H
|
|
#include "lwip/arch.h"
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif
|
|
#ifndef ETH_HWADDR_LEN
|
#ifdef ETHARP_HWADDR_LEN
|
#define ETH_HWADDR_LEN ETHARP_HWADDR_LEN /* compatibility mode */
|
#else
|
#define ETH_HWADDR_LEN 6
|
#endif
|
#endif
|
|
#ifdef PACK_STRUCT_USE_INCLUDES
|
# include "arch/bpstruct.h"
|
#endif
|
PACK_STRUCT_BEGIN
|
struct eth_addr {
|
PACK_STRUCT_FLD_8(u8_t addr[ETH_HWADDR_LEN]);
|
} PACK_STRUCT_STRUCT;
|
PACK_STRUCT_END
|
#ifdef PACK_STRUCT_USE_INCLUDES
|
# include "arch/epstruct.h"
|
#endif
|
|
#ifdef PACK_STRUCT_USE_INCLUDES
|
# include "arch/bpstruct.h"
|
#endif
|
PACK_STRUCT_BEGIN
|
/** Ethernet header */
|
struct eth_hdr {
|
#if ETH_PAD_SIZE
|
PACK_STRUCT_FLD_8(u8_t padding[ETH_PAD_SIZE]);
|
#endif
|
PACK_STRUCT_FLD_S(struct eth_addr dest);
|
PACK_STRUCT_FLD_S(struct eth_addr src);
|
PACK_STRUCT_FIELD(u16_t type);
|
} PACK_STRUCT_STRUCT;
|
PACK_STRUCT_END
|
#ifdef PACK_STRUCT_USE_INCLUDES
|
# include "arch/epstruct.h"
|
#endif
|
|
#define SIZEOF_ETH_HDR (14 + ETH_PAD_SIZE)
|
|
#ifdef PACK_STRUCT_USE_INCLUDES
|
# include "arch/bpstruct.h"
|
#endif
|
PACK_STRUCT_BEGIN
|
/** VLAN header inserted between ethernet header and payload
|
* if 'type' in ethernet header is ETHTYPE_VLAN.
|
* See IEEE802.Q */
|
struct eth_vlan_hdr {
|
PACK_STRUCT_FIELD(u16_t prio_vid);
|
PACK_STRUCT_FIELD(u16_t tpid);
|
} PACK_STRUCT_STRUCT;
|
PACK_STRUCT_END
|
#ifdef PACK_STRUCT_USE_INCLUDES
|
# include "arch/epstruct.h"
|
#endif
|
|
#define SIZEOF_VLAN_HDR 4
|
#define VLAN_ID(vlan_hdr) (lwip_htons((vlan_hdr)->prio_vid) & 0xFFF)
|
|
/**
|
* @ingroup ethernet
|
* A list of often ethtypes (although lwIP does not use all of them): */
|
enum eth_type {
|
/** Internet protocol v4 */
|
ETHTYPE_IP = 0x0800U,
|
/** Address resolution protocol */
|
ETHTYPE_ARP = 0x0806U,
|
/** Wake on lan */
|
ETHTYPE_WOL = 0x0842U,
|
/** RARP */
|
ETHTYPE_RARP = 0x8035U,
|
/** Virtual local area network */
|
ETHTYPE_VLAN = 0x8100U,
|
/** Internet protocol v6 */
|
ETHTYPE_IPV6 = 0x86DDU,
|
/** PPP Over Ethernet Discovery Stage */
|
ETHTYPE_PPPOEDISC = 0x8863U,
|
/** PPP Over Ethernet Session Stage */
|
ETHTYPE_PPPOE = 0x8864U,
|
/** Jumbo Frames */
|
ETHTYPE_JUMBO = 0x8870U,
|
/** Process field network */
|
ETHTYPE_PROFINET = 0x8892U,
|
/** Ethernet for control automation technology */
|
ETHTYPE_ETHERCAT = 0x88A4U,
|
/** Link layer discovery protocol */
|
ETHTYPE_LLDP = 0x88CCU,
|
/** Serial real-time communication system */
|
ETHTYPE_SERCOS = 0x88CDU,
|
/** Media redundancy protocol */
|
ETHTYPE_MRP = 0x88E3U,
|
/** Precision time protocol */
|
ETHTYPE_PTP = 0x88F7U,
|
/** Q-in-Q, 802.1ad */
|
ETHTYPE_QINQ = 0x9100U
|
};
|
|
/** The 24-bit IANA IPv4-multicast OUI is 01-00-5e: */
|
#define LL_IP4_MULTICAST_ADDR_0 0x01
|
#define LL_IP4_MULTICAST_ADDR_1 0x00
|
#define LL_IP4_MULTICAST_ADDR_2 0x5e
|
|
/** IPv6 multicast uses this prefix */
|
#define LL_IP6_MULTICAST_ADDR_0 0x33
|
#define LL_IP6_MULTICAST_ADDR_1 0x33
|
|
/** MEMCPY-like macro to copy to/from struct eth_addr's that are local variables
|
* or known to be 32-bit aligned within the protocol header. */
|
#ifndef ETHADDR32_COPY
|
#define ETHADDR32_COPY(dst, src) SMEMCPY(dst, src, ETH_HWADDR_LEN)
|
#endif
|
|
/** MEMCPY-like macro to copy to/from struct eth_addr's that are no local
|
* variables and known to be 16-bit aligned within the protocol header. */
|
#ifndef ETHADDR16_COPY
|
#define ETHADDR16_COPY(dst, src) SMEMCPY(dst, src, ETH_HWADDR_LEN)
|
#endif
|
|
#define eth_addr_cmp(addr1, addr2) (memcmp((addr1)->addr, (addr2)->addr, ETH_HWADDR_LEN) == 0)
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif /* LWIP_HDR_PROT_ETHERNET_H */
|
