Rob Greenhill / EthernetNetIf

LPC1768/lwip/include/netif/etharp.h@0:f993b6d8b1d8, 2012-05-29 (annotated)

Committer:
zoot661
Date:
Tue May 29 09:49:18 2012 +0000
Revision:
0:f993b6d8b1d8

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


zoot661

0:f993b6d8b1d8


     1

/*





zoot661

0:f993b6d8b1d8


     2

 * Copyright (c) 2001-2003 Swedish Institute of Computer Science.





zoot661

0:f993b6d8b1d8


     3

 * Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv>





zoot661

0:f993b6d8b1d8


     4

 * Copyright (c) 2003-2004 Axon Digital Design B.V., The Netherlands.





zoot661

0:f993b6d8b1d8


     5

 * All rights reserved. 





zoot661

0:f993b6d8b1d8


     6

 * 





zoot661

0:f993b6d8b1d8


     7

 * Redistribution and use in source and binary forms, with or without modification, 





zoot661

0:f993b6d8b1d8


     8

 * are permitted provided that the following conditions are met:





zoot661

0:f993b6d8b1d8


     9

 *





zoot661

0:f993b6d8b1d8


    10

 * 1. Redistributions of source code must retain the above copyright notice,





zoot661

0:f993b6d8b1d8


    11

 *    this list of conditions and the following disclaimer.





zoot661

0:f993b6d8b1d8


    12

 * 2. Redistributions in binary form must reproduce the above copyright notice,





zoot661

0:f993b6d8b1d8


    13

 *    this list of conditions and the following disclaimer in the documentation





zoot661

0:f993b6d8b1d8


    14

 *    and/or other materials provided with the distribution.





zoot661

0:f993b6d8b1d8


    15

 * 3. The name of the author may not be used to endorse or promote products





zoot661

0:f993b6d8b1d8


    16

 *    derived from this software without specific prior written permission. 





zoot661

0:f993b6d8b1d8


    17

 *





zoot661

0:f993b6d8b1d8


    18

 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 





zoot661

0:f993b6d8b1d8


    19

 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 





zoot661

0:f993b6d8b1d8


    20

 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 





zoot661

0:f993b6d8b1d8


    21

 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 





zoot661

0:f993b6d8b1d8


    22

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 





zoot661

0:f993b6d8b1d8


    23

 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 





zoot661

0:f993b6d8b1d8


    24

 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 





zoot661

0:f993b6d8b1d8


    25

 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 





zoot661

0:f993b6d8b1d8


    26

 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 





zoot661

0:f993b6d8b1d8


    27

 * OF SUCH DAMAGE.





zoot661

0:f993b6d8b1d8


    28

 *





zoot661

0:f993b6d8b1d8


    29

 * This file is part of the lwIP TCP/IP stack.





zoot661

0:f993b6d8b1d8


    30

 * 





zoot661

0:f993b6d8b1d8


    31

 * Author: Adam Dunkels <adam@sics.se>





zoot661

0:f993b6d8b1d8


    32

 *





zoot661

0:f993b6d8b1d8


    33

 */





zoot661

0:f993b6d8b1d8


    34







zoot661

0:f993b6d8b1d8


    35

#ifndef __NETIF_ETHARP_H__





zoot661

0:f993b6d8b1d8


    36

#define __NETIF_ETHARP_H__





zoot661

0:f993b6d8b1d8


    37







zoot661

0:f993b6d8b1d8


    38

#include "lwip/opt.h"





zoot661

0:f993b6d8b1d8


    39







zoot661

0:f993b6d8b1d8


    40

#if LWIP_ARP || LWIP_ETHERNET /* don't build if not configured for use in lwipopts.h */





zoot661

0:f993b6d8b1d8


    41







zoot661

0:f993b6d8b1d8


    42

#include "lwip/pbuf.h"





zoot661

0:f993b6d8b1d8


    43

#include "lwip/ip_addr.h"





zoot661

0:f993b6d8b1d8


    44

#include "lwip/netif.h"





zoot661

0:f993b6d8b1d8


    45

#include "lwip/ip.h"





zoot661

0:f993b6d8b1d8


    46







zoot661

0:f993b6d8b1d8


    47

#ifdef __cplusplus





zoot661

0:f993b6d8b1d8


    48

extern "C" {





zoot661

0:f993b6d8b1d8


    49

#endif





zoot661

0:f993b6d8b1d8


    50







zoot661

0:f993b6d8b1d8


    51

#ifndef ETHARP_HWADDR_LEN





zoot661

0:f993b6d8b1d8


    52

#define ETHARP_HWADDR_LEN     6





zoot661

0:f993b6d8b1d8


    53

#endif





zoot661

0:f993b6d8b1d8


    54







zoot661

0:f993b6d8b1d8


    55

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


    56

#  include "arch/bpstruct.h"





zoot661

0:f993b6d8b1d8


    57

#endif





zoot661

0:f993b6d8b1d8


    58

PACK_STRUCT_BEGIN





zoot661

0:f993b6d8b1d8


    59

struct eth_addr {





zoot661

0:f993b6d8b1d8


    60

  PACK_STRUCT_FIELD(u8_t addr[ETHARP_HWADDR_LEN]);





zoot661

0:f993b6d8b1d8


    61

} PACK_STRUCT_STRUCT;





zoot661

0:f993b6d8b1d8


    62

PACK_STRUCT_END





zoot661

0:f993b6d8b1d8


    63

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


    64

#  include "arch/epstruct.h"





zoot661

0:f993b6d8b1d8


    65

#endif





zoot661

0:f993b6d8b1d8


    66







zoot661

0:f993b6d8b1d8


    67

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


    68

#  include "arch/bpstruct.h"





zoot661

0:f993b6d8b1d8


    69

#endif





zoot661

0:f993b6d8b1d8


    70

PACK_STRUCT_BEGIN





zoot661

0:f993b6d8b1d8


    71

/* Ethernet header */





zoot661

0:f993b6d8b1d8


    72

struct eth_hdr {





zoot661

0:f993b6d8b1d8


    73

#if ETH_PAD_SIZE





zoot661

0:f993b6d8b1d8


    74

  PACK_STRUCT_FIELD(u8_t padding[ETH_PAD_SIZE]);





zoot661

0:f993b6d8b1d8


    75

#endif





zoot661

0:f993b6d8b1d8


    76

  PACK_STRUCT_FIELD(struct eth_addr dest);





zoot661

0:f993b6d8b1d8


    77

  PACK_STRUCT_FIELD(struct eth_addr src);





zoot661

0:f993b6d8b1d8


    78

  PACK_STRUCT_FIELD(u16_t type);





zoot661

0:f993b6d8b1d8


    79

} PACK_STRUCT_STRUCT;





zoot661

0:f993b6d8b1d8


    80

PACK_STRUCT_END





zoot661

0:f993b6d8b1d8


    81

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


    82

#  include "arch/epstruct.h"





zoot661

0:f993b6d8b1d8


    83

#endif





zoot661

0:f993b6d8b1d8


    84







zoot661

0:f993b6d8b1d8


    85

#define SIZEOF_ETH_HDR (14 + ETH_PAD_SIZE)





zoot661

0:f993b6d8b1d8


    86







zoot661

0:f993b6d8b1d8


    87

#if ETHARP_SUPPORT_VLAN





zoot661

0:f993b6d8b1d8


    88







zoot661

0:f993b6d8b1d8


    89

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


    90

#  include "arch/bpstruct.h"





zoot661

0:f993b6d8b1d8


    91

#endif





zoot661

0:f993b6d8b1d8


    92

PACK_STRUCT_BEGIN





zoot661

0:f993b6d8b1d8


    93

/* VLAN header inserted between ethernet header and payload





zoot661

0:f993b6d8b1d8


    94

 * if 'type' in ethernet header is ETHTYPE_VLAN.





zoot661

0:f993b6d8b1d8


    95

 * See IEEE802.Q */





zoot661

0:f993b6d8b1d8


    96

struct eth_vlan_hdr {





zoot661

0:f993b6d8b1d8


    97

  PACK_STRUCT_FIELD(u16_t tpid);





zoot661

0:f993b6d8b1d8


    98

  PACK_STRUCT_FIELD(u16_t prio_vid);





zoot661

0:f993b6d8b1d8


    99

} PACK_STRUCT_STRUCT;





zoot661

0:f993b6d8b1d8


   100

PACK_STRUCT_END





zoot661

0:f993b6d8b1d8


   101

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


   102

#  include "arch/epstruct.h"





zoot661

0:f993b6d8b1d8


   103

#endif





zoot661

0:f993b6d8b1d8


   104







zoot661

0:f993b6d8b1d8


   105

#define SIZEOF_VLAN_HDR 4





zoot661

0:f993b6d8b1d8


   106

#define VLAN_ID(vlan_hdr) (htons((vlan_hdr)->prio_vid) & 0xFFF)





zoot661

0:f993b6d8b1d8


   107







zoot661

0:f993b6d8b1d8


   108

#endif /* ETHARP_SUPPORT_VLAN */





zoot661

0:f993b6d8b1d8


   109







zoot661

0:f993b6d8b1d8


   110

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


   111

#  include "arch/bpstruct.h"





zoot661

0:f993b6d8b1d8


   112

#endif





zoot661

0:f993b6d8b1d8


   113

PACK_STRUCT_BEGIN





zoot661

0:f993b6d8b1d8


   114

/* the ARP message, see RFC 826 ("Packet format") */





zoot661

0:f993b6d8b1d8


   115

struct etharp_hdr {





zoot661

0:f993b6d8b1d8


   116

  PACK_STRUCT_FIELD(u16_t hwtype);





zoot661

0:f993b6d8b1d8


   117

  PACK_STRUCT_FIELD(u16_t proto);





zoot661

0:f993b6d8b1d8


   118

  PACK_STRUCT_FIELD(u8_t  hwlen);





zoot661

0:f993b6d8b1d8


   119

  PACK_STRUCT_FIELD(u8_t  protolen);





zoot661

0:f993b6d8b1d8


   120

  PACK_STRUCT_FIELD(u16_t opcode);





zoot661

0:f993b6d8b1d8


   121

  PACK_STRUCT_FIELD(struct eth_addr shwaddr);





zoot661

0:f993b6d8b1d8


   122

  PACK_STRUCT_FIELD(struct ip_addr2 sipaddr);





zoot661

0:f993b6d8b1d8


   123

  PACK_STRUCT_FIELD(struct eth_addr dhwaddr);





zoot661

0:f993b6d8b1d8


   124

  PACK_STRUCT_FIELD(struct ip_addr2 dipaddr);





zoot661

0:f993b6d8b1d8


   125

} PACK_STRUCT_STRUCT;





zoot661

0:f993b6d8b1d8


   126

PACK_STRUCT_END





zoot661

0:f993b6d8b1d8


   127

#ifdef PACK_STRUCT_USE_INCLUDES





zoot661

0:f993b6d8b1d8


   128

#  include "arch/epstruct.h"





zoot661

0:f993b6d8b1d8


   129

#endif





zoot661

0:f993b6d8b1d8


   130







zoot661

0:f993b6d8b1d8


   131

#define SIZEOF_ETHARP_HDR 28





zoot661

0:f993b6d8b1d8


   132

#define SIZEOF_ETHARP_PACKET (SIZEOF_ETH_HDR + SIZEOF_ETHARP_HDR)





zoot661

0:f993b6d8b1d8


   133







zoot661

0:f993b6d8b1d8


   134

/* 5 seconds period */





zoot661

0:f993b6d8b1d8


   135

#define ARP_TMR_INTERVAL 5000





zoot661

0:f993b6d8b1d8


   136







zoot661

0:f993b6d8b1d8


   137

#define ETHTYPE_ARP       0x0806





zoot661

0:f993b6d8b1d8


   138

#define ETHTYPE_IP        0x0800





zoot661

0:f993b6d8b1d8


   139

#define ETHTYPE_VLAN      0x8100





zoot661

0:f993b6d8b1d8


   140

#define ETHTYPE_PPPOEDISC 0x8863  /* PPP Over Ethernet Discovery Stage */





zoot661

0:f993b6d8b1d8


   141

#define ETHTYPE_PPPOE     0x8864  /* PPP Over Ethernet Session Stage */





zoot661

0:f993b6d8b1d8


   142







zoot661

0:f993b6d8b1d8


   143

/* MEMCPY-like macro to copy to/from struct eth_addr's that are local variables





zoot661

0:f993b6d8b1d8


   144

 * or known to be 32-bit aligned within the protocol header. */





zoot661

0:f993b6d8b1d8


   145

#ifndef ETHADDR32_COPY





zoot661

0:f993b6d8b1d8


   146

#define ETHADDR32_COPY(src, dst)  SMEMCPY(src, dst, ETHARP_HWADDR_LEN)





zoot661

0:f993b6d8b1d8


   147

#endif





zoot661

0:f993b6d8b1d8


   148







zoot661

0:f993b6d8b1d8


   149

/* MEMCPY-like macro to copy to/from struct eth_addr's that are no local





zoot661

0:f993b6d8b1d8


   150

 * variables and known to be 16-bit aligned within the protocol header. */





zoot661

0:f993b6d8b1d8


   151

#ifndef ETHADDR16_COPY





zoot661

0:f993b6d8b1d8


   152

#define ETHADDR16_COPY(src, dst)  SMEMCPY(src, dst, ETHARP_HWADDR_LEN)





zoot661

0:f993b6d8b1d8


   153

#endif





zoot661

0:f993b6d8b1d8


   154







zoot661

0:f993b6d8b1d8


   155

#if LWIP_ARP /* don't build if not configured for use in lwipopts.h */





zoot661

0:f993b6d8b1d8


   156







zoot661

0:f993b6d8b1d8


   157

/* ARP message types (opcodes) */





zoot661

0:f993b6d8b1d8


   158

#define ARP_REQUEST 1





zoot661

0:f993b6d8b1d8


   159

#define ARP_REPLY   2





zoot661

0:f993b6d8b1d8


   160







zoot661

0:f993b6d8b1d8


   161

/* Define this to 1 and define LWIP_ARP_FILTER_NETIF_FN(pbuf, netif, type)





zoot661

0:f993b6d8b1d8


   162

 * to a filter function that returns the correct netif when using multiple





zoot661

0:f993b6d8b1d8


   163

 * netifs on one hardware interface where the netif's low-level receive





zoot661

0:f993b6d8b1d8


   164

 * routine cannot decide for the correct netif (e.g. when mapping multiple





zoot661

0:f993b6d8b1d8


   165

 * IP addresses to one hardware interface).





zoot661

0:f993b6d8b1d8


   166

 */





zoot661

0:f993b6d8b1d8


   167

#ifndef LWIP_ARP_FILTER_NETIF





zoot661

0:f993b6d8b1d8


   168

#define LWIP_ARP_FILTER_NETIF 0





zoot661

0:f993b6d8b1d8


   169

#endif





zoot661

0:f993b6d8b1d8


   170







zoot661

0:f993b6d8b1d8


   171

#if ARP_QUEUEING





zoot661

0:f993b6d8b1d8


   172

/* struct for queueing outgoing packets for unknown address





zoot661

0:f993b6d8b1d8


   173

  * defined here to be accessed by memp.h





zoot661

0:f993b6d8b1d8


   174

  */





zoot661

0:f993b6d8b1d8


   175

struct etharp_q_entry {





zoot661

0:f993b6d8b1d8


   176

  struct etharp_q_entry *next;





zoot661

0:f993b6d8b1d8


   177

  struct pbuf *p;





zoot661

0:f993b6d8b1d8


   178

};





zoot661

0:f993b6d8b1d8


   179

#endif /* ARP_QUEUEING */





zoot661

0:f993b6d8b1d8


   180







zoot661

0:f993b6d8b1d8


   181

#define etharp_init() /* Compatibility define, not init needed. */





zoot661

0:f993b6d8b1d8


   182

void etharp_tmr(void);





zoot661

0:f993b6d8b1d8


   183

s8_t etharp_find_addr(struct netif *netif, ip_addr_t *ipaddr,





zoot661

0:f993b6d8b1d8


   184

         struct eth_addr **eth_ret, ip_addr_t **ip_ret);





zoot661

0:f993b6d8b1d8


   185

err_t etharp_output(struct netif *netif, struct pbuf *q, ip_addr_t *ipaddr);





zoot661

0:f993b6d8b1d8


   186

err_t etharp_query(struct netif *netif, ip_addr_t *ipaddr, struct pbuf *q);





zoot661

0:f993b6d8b1d8


   187

err_t etharp_request(struct netif *netif, ip_addr_t *ipaddr);





zoot661

0:f993b6d8b1d8


   188

/* For Ethernet network interfaces, we might want to send "gratuitous ARP";





zoot661

0:f993b6d8b1d8


   189

 *  this is an ARP packet sent by a node in order to spontaneously cause other





zoot661

0:f993b6d8b1d8


   190

 *  nodes to update an entry in their ARP cache.





zoot661

0:f993b6d8b1d8


   191

 *  From RFC 3220 "IP Mobility Support for IPv4" section 4.6. */





zoot661

0:f993b6d8b1d8


   192

#define etharp_gratuitous(netif) etharp_request((netif), &(netif)->ip_addr)





zoot661

0:f993b6d8b1d8


   193







zoot661

0:f993b6d8b1d8


   194

#if ETHARP_SUPPORT_STATIC_ENTRIES





zoot661

0:f993b6d8b1d8


   195

err_t etharp_add_static_entry(ip_addr_t *ipaddr, struct eth_addr *ethaddr);





zoot661

0:f993b6d8b1d8


   196

err_t etharp_remove_static_entry(ip_addr_t *ipaddr);





zoot661

0:f993b6d8b1d8


   197

#endif /* ETHARP_SUPPORT_STATIC_ENTRIES */





zoot661

0:f993b6d8b1d8


   198







zoot661

0:f993b6d8b1d8


   199

#if LWIP_AUTOIP





zoot661

0:f993b6d8b1d8


   200

err_t etharp_raw(struct netif *netif, const struct eth_addr *ethsrc_addr,





zoot661

0:f993b6d8b1d8


   201

                 const struct eth_addr *ethdst_addr,





zoot661

0:f993b6d8b1d8


   202

                 const struct eth_addr *hwsrc_addr, const ip_addr_t *ipsrc_addr,





zoot661

0:f993b6d8b1d8


   203

                 const struct eth_addr *hwdst_addr, const ip_addr_t *ipdst_addr,





zoot661

0:f993b6d8b1d8


   204

                 const u16_t opcode);





zoot661

0:f993b6d8b1d8


   205

#endif /* LWIP_AUTOIP */





zoot661

0:f993b6d8b1d8


   206







zoot661

0:f993b6d8b1d8


   207

#endif /* LWIP_ARP */





zoot661

0:f993b6d8b1d8


   208







zoot661

0:f993b6d8b1d8


   209

err_t ethernet_input(struct pbuf *p, struct netif *netif);





zoot661

0:f993b6d8b1d8


   210







zoot661

0:f993b6d8b1d8


   211

#define eth_addr_cmp(addr1, addr2) (memcmp((addr1)->addr, (addr2)->addr, ETHARP_HWADDR_LEN) == 0)





zoot661

0:f993b6d8b1d8


   212







zoot661

0:f993b6d8b1d8


   213

extern const struct eth_addr ethbroadcast, ethzero;





zoot661

0:f993b6d8b1d8


   214







zoot661

0:f993b6d8b1d8


   215

#ifdef __cplusplus





zoot661

0:f993b6d8b1d8


   216

}





zoot661

0:f993b6d8b1d8


   217

#endif





zoot661

0:f993b6d8b1d8


   218







zoot661

0:f993b6d8b1d8


   219

#endif /* LWIP_ARP || LWIP_ETHERNET */





zoot661

0:f993b6d8b1d8


   220







zoot661

0:f993b6d8b1d8


   221

#endif /* __NETIF_ARP_H__ */