protocol/lufa/LUFA-git/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.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 Ethernet.c.
  34  */
  35
  36 #ifndef _ETHERNET_H_
  37 #define _ETHERNET_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <string.h>
  42
  43                 #include "Config/AppConfig.h"
  44
  45                 #include "EthernetProtocols.h"
  46                 #include "ProtocolDecoders.h"
  47                 #include "ICMP.h"
  48                 #include "TCP.h"
  49                 #include "UDP.h"
  50                 #include "DHCP.h"
  51                 #include "ARP.h"
  52                 #include "IP.h"
  53
  54         /* Macros: */
  55                 /** Physical MAC address of the network broadcast address. */
  56                 #define BROADCAST_MAC_ADDRESS            {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}
  57
  58                 /** Performs a comparison between two MAC addresses, indicating if they are identical.
  59                  *
  60                  *  \param[in] MAC1  First MAC address
  61                  *  \param[in] MAC2  Second MAC address
  62                  *
  63                  *  \return True if the addresses match, \c false otherwise
  64                  */
  65                 #define MAC_COMPARE(MAC1, MAC2)          (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0)
  66
  67                 /** Maximum size of an incoming or outgoing Ethernet frame in bytes. */
  68                 #define ETHERNET_FRAME_SIZE_MAX          1500
  69
  70                 /** Minimum size of an Ethernet packet in bytes, to conform to the Ethernet V2 packet standard. */
  71                 #define ETHERNET_VER2_MINSIZE            0x0600
  72
  73                 /** Return value for all sub protocol handling routines, indicating that no response packet has been generated. */
  74                 #define NO_RESPONSE                      0
  75
  76                 /** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled. */
  77                 #define NO_PROCESS                       -1
  78
  79         /* Type Defines: */
  80                 /** Type define for an Ethernet frame buffer data and information structure. */
  81                 typedef struct
  82                 {
  83                         uint8_t  FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents. */
  84                         uint16_t FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer. */
  85                 } Ethernet_Frame_Info_t;
  86
  87                 /** Type define for an Ethernet frame header. */
  88                 typedef struct
  89                 {
  90                         MAC_Address_t Destination; /**< Physical MAC address of the packet recipient */
  91                         MAC_Address_t Source; /**< Physics MAC address of the packet source */
  92                         uint16_t      EtherType; /**< Ethernet packet sub-protocol type, for Ethernet V2 packets */
  93                 } Ethernet_Frame_Header_t;
  94
  95         /* External Variables: */
  96                 extern Ethernet_Frame_Info_t FrameIN;
  97                 extern Ethernet_Frame_Info_t FrameOUT;
  98
  99                 extern const MAC_Address_t ServerMACAddress;
 100                 extern const IP_Address_t  ServerIPAddress;
 101                 extern const MAC_Address_t BroadcastMACAddress;
 102                 extern const IP_Address_t  BroadcastIPAddress;
 103                 extern const IP_Address_t  ClientIPAddress;
 104
 105         /* Function Prototypes: */
 106                 void     Ethernet_ProcessPacket(void);
 107                 uint16_t Ethernet_Checksum16(void* Data,
 108                                              uint16_t Bytes);
 109
 110 #endif
 111