tmk_core/protocol/lufa/LUFA-git/Demos/Device/LowLevel/RNDISEthernet/Lib/ARP.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for ARP.c.
  34  */
  35
  36 #ifndef _ARP_H_
  37 #define _ARP_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <string.h>
  42
  43                 #include <LUFA/Drivers/USB/USB.h>
  44
  45                 #include "EthernetProtocols.h"
  46                 #include "Ethernet.h"
  47                 #include "ProtocolDecoders.h"
  48
  49         /* Macros: */
  50                 /** ARP header operation constant, indicating a request from a host for an address translation. */
  51                 #define ARP_OPERATION_REQUEST            1
  52
  53                 /** ARP header operation constant, indicating a reply from a host giving an address translation. */
  54                 #define ARP_OPERATION_REPLY              2
  55
  56         /* Type Defines: */
  57                 /** Type define for an ARP packet inside an Ethernet frame. */
  58                 typedef struct
  59                 {
  60                         uint16_t      HardwareType; /**< Hardware type constant, indicating the hardware used */
  61                         uint16_t      ProtocolType; /**< Protocol being resolved, usually ETHERTYPE_IPV4 */
  62
  63                         uint8_t       HLEN; /**< Length in bytes of the source/destination hardware addresses */
  64                         uint8_t       PLEN; /**< Length in bytes of the source/destination protocol addresses */
  65                         uint16_t      Operation; /**< Type of operation, either ARP_OPERATION_REQUEST or ARP_OPERATION_REPLY */
  66
  67                         MAC_Address_t SHA; /**< Sender's hardware address */
  68                         IP_Address_t  SPA; /**< Sender's protocol address */
  69                         MAC_Address_t THA; /**< Target's hardware address */
  70                         IP_Address_t  TPA; /**< Target's protocol address */
  71                 } ARP_Header_t;
  72
  73         /* Function Prototypes: */
  74                 int16_t ARP_ProcessARPPacket(void* InDataStart,
  75                                              void* OutDataStart);
  76
  77 #endif
  78