etharp.h

00001 /**
00002  * @file
00003  * ARP protocol definitions
00004  */
00005 
00006 /*
00007  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
00008  * All rights reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without modification,
00011  * are permitted provided that the following conditions are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright notice,
00014  *    this list of conditions and the following disclaimer.
00015  * 2. Redistributions in binary form must reproduce the above copyright notice,
00016  *    this list of conditions and the following disclaimer in the documentation
00017  *    and/or other materials provided with the distribution.
00018  * 3. The name of the author may not be used to endorse or promote products
00019  *    derived from this software without specific prior written permission.
00020  *
00021  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
00022  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00023  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
00024  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
00026  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
00029  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
00030  * OF SUCH DAMAGE.
00031  *
00032  * This file is part of the lwIP TCP/IP stack.
00033  *
00034  * Author: Adam Dunkels <adam@sics.se>
00035  *
00036  */
00037 #ifndef LWIP_HDR_PROT_ETHARP_H
00038 #define LWIP_HDR_PROT_ETHARP_H
00039 
00040 #include "lwip/arch.h"
00041 #include "lwip/prot/lwip_ethernet.h"
00042 #include "lwip/ip4_addr.h"
00043 
00044 #ifdef __cplusplus
00045 extern "C" {
00046 #endif
00047 
00048 #ifndef ETHARP_HWADDR_LEN
00049 #define ETHARP_HWADDR_LEN     ETH_HWADDR_LEN
00050 #endif
00051 
00052 #ifdef PACK_STRUCT_USE_INCLUDES
00053 #  include "arch/bpstruct.h"
00054 #endif
00055 PACK_STRUCT_BEGIN
00056 /** the ARP message, see RFC 826 ("Packet format") */
00057 struct etharp_hdr {
00058   PACK_STRUCT_FIELD(u16_t hwtype);
00059   PACK_STRUCT_FIELD(u16_t proto);
00060   PACK_STRUCT_FLD_8(u8_t  hwlen);
00061   PACK_STRUCT_FLD_8(u8_t  protolen);
00062   PACK_STRUCT_FIELD(u16_t opcode);
00063   PACK_STRUCT_FLD_S(struct eth_addr shwaddr);
00064   PACK_STRUCT_FLD_S(struct ip4_addr2 sipaddr);
00065   PACK_STRUCT_FLD_S(struct eth_addr dhwaddr);
00066   PACK_STRUCT_FLD_S(struct ip4_addr2 dipaddr);
00067 } PACK_STRUCT_STRUCT;
00068 PACK_STRUCT_END
00069 #ifdef PACK_STRUCT_USE_INCLUDES
00070 #  include "arch/epstruct.h"
00071 #endif
00072 
00073 #define SIZEOF_ETHARP_HDR 28
00074 
00075 /* ARP hwtype values */
00076 enum etharp_hwtype {
00077   HWTYPE_ETHERNET = 1
00078   /* others not used */
00079 };
00080 
00081 /* ARP message types (opcodes) */
00082 enum etharp_opcode {
00083   ARP_REQUEST = 1,
00084   ARP_REPLY   = 2
00085 };
00086 
00087 #ifdef __cplusplus
00088 }
00089 #endif
00090 
00091 #endif /* LWIP_HDR_PROT_ETHARP_H */