4G_module/include/platform/lwip/netif/etharp.h

278 lines
11 KiB
C

/*
* Copyright (c) 2001-2003 Swedish Institute of Computer Science.
* Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv>
* Copyright (c) 2003-2004 Axon Digital Design B.V., The Netherlands.
* 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 __NETIF_ETHARP_H__
#define __NETIF_ETHARP_H__
#include "opt.h"
#if LWIP_ARP || LWIP_ETHERNET /* don't build if not configured for use in lwipopts.h */
#include "pbuf.h"
#include "ip_addr.h"
#include "netif.h"
#include "ip.h"
#ifdef __cplusplus
extern "C" {
#endif
#ifndef ETHARP_HWADDR_LEN
#define ETHARP_HWADDR_LEN 6
#endif
#ifdef PACK_STRUCT_USE_INCLUDES
# include "bpstruct.h"
#endif
PACK_STRUCT_BEGIN
struct eth_addr {
PACK_STRUCT_FIELD(u8_t addr[ETHARP_HWADDR_LEN]);
} PACK_STRUCT_STRUCT;
PACK_STRUCT_END
#ifdef PACK_STRUCT_USE_INCLUDES
# include "epstruct.h"
#endif
#ifdef PACK_STRUCT_USE_INCLUDES
# include "bpstruct.h"
#endif
PACK_STRUCT_BEGIN
/** Ethernet header */
struct eth_hdr {
#if ETH_PAD_SIZE
PACK_STRUCT_FIELD(u8_t padding[ETH_PAD_SIZE]);
#endif
PACK_STRUCT_FIELD(struct eth_addr dest);
PACK_STRUCT_FIELD(struct eth_addr src);
PACK_STRUCT_FIELD(u16_t type);
} PACK_STRUCT_STRUCT;
PACK_STRUCT_END
#ifdef PACK_STRUCT_USE_INCLUDES
# include "epstruct.h"
#endif
#if ETHARP_SUPPORT_VLAN
#ifdef PACK_STRUCT_USE_INCLUDES
# include "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 "epstruct.h"
#endif
#define SIZEOF_VLAN_HDR 4
#define VLAN_ID(vlan_hdr) (htons((vlan_hdr)->prio_vid) & 0xFFF)
#define VLAN_ID_SET(vlan_hdr, vlanid) (((vlan_hdr)->prio_vid) = ntohs(vlanid))
#endif /* ETHARP_SUPPORT_VLAN */
#ifdef PACK_STRUCT_USE_INCLUDES
# include "bpstruct.h"
#endif
PACK_STRUCT_BEGIN
/** the ARP message, see RFC 826 ("Packet format") */
struct etharp_hdr {
PACK_STRUCT_FIELD(u16_t hwtype);
PACK_STRUCT_FIELD(u16_t proto);
PACK_STRUCT_FIELD(u8_t hwlen);
PACK_STRUCT_FIELD(u8_t protolen);
PACK_STRUCT_FIELD(u16_t opcode);
PACK_STRUCT_FIELD(struct eth_addr shwaddr);
PACK_STRUCT_FIELD(struct ip_addr2 sipaddr);
PACK_STRUCT_FIELD(struct eth_addr dhwaddr);
PACK_STRUCT_FIELD(struct ip_addr2 dipaddr);
} PACK_STRUCT_STRUCT;
PACK_STRUCT_END
#ifdef PACK_STRUCT_USE_INCLUDES
# include "epstruct.h"
#endif
#define SIZEOF_ETHARP_HDR 28
#define SIZEOF_ETHARP_PACKET (SIZEOF_ETH_HDR + SIZEOF_ETHARP_HDR)
/** 5 seconds period */
#define ARP_TMR_INTERVAL 5000
#define ETHTYPE_WAPI 0x88B4U
#define ETHTYPE_ARP 0x0806U
#define ETHTYPE_IP 0x0800U
#define ETHTYPE_VLAN 0x8100U
#define ETHTYPE_IPV6 0x86DDU
#define ETHTYPE_PPPOEDISC 0x8863U /* PPP Over Ethernet Discovery Stage */
#define ETHTYPE_PPPOE 0x8864U /* PPP Over Ethernet Session Stage */
#define ETHTYPE_EAPOL 0x888EU
/** 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(src, dst) SMEMCPY(src, dst, ETHARP_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(src, dst) SMEMCPY(src, dst, ETHARP_HWADDR_LEN)
#endif
#if LWIP_ARP /* don't build if not configured for use in lwipopts.h */
/** ARP message types (opcodes) */
#define ARP_REQUEST 1
#define ARP_REPLY 2
/** Define this to 1 and define LWIP_ARP_FILTER_NETIF_FN(pbuf, netif, type)
* to a filter function that returns the correct netif when using multiple
* netifs on one hardware interface where the netif's low-level receive
* routine cannot decide for the correct netif (e.g. when mapping multiple
* IP addresses to one hardware interface).
*/
#ifndef LWIP_ARP_FILTER_NETIF
#define LWIP_ARP_FILTER_NETIF 0
#endif
#if ARP_QUEUEING
/** struct for queueing outgoing packets for unknown address
* defined here to be accessed by memp.h
*/
struct etharp_q_entry {
struct etharp_q_entry *next;
struct pbuf *p;
};
#endif /* ARP_QUEUEING */
#define etharp_init() /* Compatibility define, not init needed. */
void etharp_tmr(void);
s8_t etharp_find_addr(struct netif *netif, ip_addr_t *ipaddr,
struct eth_addr **eth_ret, ip_addr_t **ip_ret);
err_t etharp_output(struct netif *netif, struct pbuf *q, ip_addr_t *dest);
err_t etharp_query(struct netif *netif, ip_addr_t *ipaddr, struct pbuf *q);
err_t etharp_request(struct netif *netif, ip_addr_t *ipaddr);
/** For Ethernet network interfaces, we might want to send "gratuitous ARP";
* this is an ARP packet sent by a node in order to spontaneously cause other
* nodes to update an entry in their ARP cache.
* From RFC 3220 "IP Mobility Support for IPv4" section 4.6. */
#define etharp_gratuitous(netif) etharp_request((netif), &(netif)->ip_addr)
void etharp_cleanup_netif(struct netif *netif);
char * lwip_ethaddr_ntoa(struct eth_addr *mac);
char * lwip_macaddr_ntoa(u8_t *macaddr);
#if ETHARP_SUPPORT_STATIC_ENTRIES
err_t etharp_add_static_entry(ip_addr_t *ipaddr, struct eth_addr *ethaddr);
err_t etharp_remove_static_entry(ip_addr_t *ipaddr);
#endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
#if LWIP_AUTOIP
err_t etharp_raw(struct netif *netif, const struct eth_addr *ethsrc_addr,
const struct eth_addr *ethdst_addr,
const struct eth_addr *hwsrc_addr, const ip_addr_t *ipsrc_addr,
const struct eth_addr *hwdst_addr, const ip_addr_t *ipdst_addr,
const u16_t opcode);
#endif /* LWIP_AUTOIP */
#endif /* LWIP_ARP */
err_t ethernet_input(struct pbuf *p, struct netif *netif);
err_t ethernet_netif_input(struct pbuf *p, struct netif *netif);
struct pbuf *ethernet_dl_pbuf_reshape(struct netif *netif, struct pbuf *p);
struct pbuf *ethernet_copy_data_ref(u8_t *data, u32_t len, pmsg *msg, int * free_flag);
struct pbuf *ethernet_copy_data_ref2(u8_t *data, u32_t len, pmsg *msg, int * free_flag);
struct pbuf *ethernet_copy_data_all(u8_t *data, u32_t len);
struct pbuf *ethernet_ifinput_pbuf(u8_t *data, u32_t len, pmsg *msg);
#define eth_addr_to_cmac_vlan(eth, cmac, vlanid) do { \
MEMCPY((cmac), (eth)->addr, ETHARP_HWADDR_LEN); \
(cmac)[ETHARP_HWADDR_LEN] = (vlanid) & 0xFF; \
(cmac)[ETHARP_HWADDR_LEN + 1] = (vlanid) >> 8; \
} while(0)
#define cmac_addr_to_eth_vlan(cmac, eth, vlanid) do { \
MEMCPY((eth)->addr, (cmac), ETHARP_HWADDR_LEN); \
(vlanid) = ((cmac)[ETHARP_HWADDR_LEN + 1] << 8) | (cmac)[ETHARP_HWADDR_LEN]; \
}while(0)
#define cmac_addr_to_cmac_vlan(cmac, cmacvlan, vlanid) do { \
MEMCPY((cmacvlan), (cmac), ETHARP_HWADDR_LEN); \
(cmacvlan)[ETHARP_HWADDR_LEN] = (vlanid) & 0xFF; \
(cmacvlan)[ETHARP_HWADDR_LEN + 1] = (vlanid) >> 8; \
} while(0)
#define cmac_addr_add_vlanid(cmac, vlanid) do { \
(cmac)[ETHARP_HWADDR_LEN] = (vlanid) & 0xFF; \
(cmac)[ETHARP_HWADDR_LEN + 1] = (vlanid) >> 8; \
} while(0)
#define cmac_addr_fetch_vlanid(cmac, vlanid) do { \
(vlanid) = ((cmac)[ETHARP_HWADDR_LEN + 1] << 8) | (cmac)[ETHARP_HWADDR_LEN]; \
} while(0)
#define eth_addr_to_cmac(eth, cmac) (MEMCPY((cmac), (eth)->addr, ETHARP_HWADDR_LEN))
#define cmac_addr_to_eth(cmac, eth) (MEMCPY((eth)->addr, (cmac), ETHARP_HWADDR_LEN))
#define eth_addr_cmp(addr1, addr2) (memcmp((addr1)->addr, (addr2)->addr, ETHARP_HWADDR_LEN) == 0) //for eth_addr *
#define cmac_addr_cmp(addr1, addr2) (memcmp((addr1), (addr2), ETHARP_HWADDR_LEN) == 0) //for char* type
#define cmac_vlan_addr_cmp(addr1, addr2) (memcmp((addr1), (addr2), (ETHARP_HWADDR_LEN + ETH_VLANID_SIZE)) == 0) //for char* type
#define cmac_vlan_addr_cpy(dst, src) (MEMCPY((dst), (src), (ETHARP_HWADDR_LEN + ETH_VLANID_SIZE))) //for char* type
#define eth_addr_isbroadcast(addr1) (0xFF == (addr1)->addr[0] && \
0xFF == (addr1)->addr[1] && \
0xFF == (addr1)->addr[2] && \
0xFF == (addr1)->addr[3] && \
0xFF == (addr1)->addr[4] && \
0xFF == (addr1)->addr[5])
// 0x01 0x00 0x5e is for ipv4 case
// 0x33 0x33 is for ipv6 case
#define eth_addr_ismulticast(addr1) ((0x01 == (addr1)->addr[0] && 0x00 == (addr1)->addr[1] && 0x5e == (addr1)->addr[2]) || \
(0x33 == (addr1)->addr[0] && 0x33 == (addr1)->addr[1]))
extern const struct eth_addr ethbroadcast, ethzero;
#endif /* LWIP_ARP || LWIP_ETHERNET */
#ifdef __cplusplus
}
#endif
#endif /* __NETIF_ARP_H__ */