Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 disclaim 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 "EthernetProtocols.h"
  44                 #include "ProtocolDecoders.h"
  45                 #include "ICMP.h"
  46                 #include "TCP.h"
  47                 #include "UDP.h"
  48                 #include "DHCP.h"
  49                 #include "ARP.h"
  50                 #include "IP.h"
  51
  52         /* Macros: */
  53                 /** Physical MAC address of the virtual server on the network */
  54                 #define SERVER_MAC_ADDRESS               {0x00, 0x01, 0x00, 0x01, 0x00, 0x01}
  55
  56                 /** Physical MAC address of the network broadcast address */
  57                 #define BROADCAST_MAC_ADDRESS            {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}
  58
  59                 /** Performs a comparison between two MAC addresses, indicating if they are identical.
  60                  *
  61                  *  \param MAC1  First MAC address
  62                  *  \param MAC2  Second MAC address
  63                  *
  64                  *  \return True if the addresses match, false otherwise
  65                  */
  66                 #define MAC_COMPARE(MAC1, MAC2)          (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0)
  67
  68                 /** Maximum size of an incoming or outgoing Ethernet frame in bytes */
  69                 #define ETHERNET_FRAME_SIZE_MAX          1500
  70
  71                 /** Minimum size of an Ethernet packet in bytes, to conform to the Ethernet V2 packet standard */
  72                 #define ETHERNET_VER2_MINSIZE            0x0600
  73
  74                 /** Return value for all sub protocol handling routines, indicating that no response packet has been generated */
  75                 #define NO_RESPONSE                      0
  76
  77                 /** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled */
  78                 #define NO_PROCESS                       -1
  79
  80         /* Type Defines: */
  81                 /** Type define for an Ethernet frame buffer. */
  82                 typedef struct
  83                 {
  84                         uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */
  85                         uint16_t      FrameLength; /**< Length in bytes of the Ethernet frame stored in the buffer */
  86                         bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */
  87                 } Ethernet_Frame_Info_t;
  88
  89                 /** Type define for an Ethernet frame header */
  90                 typedef struct
  91                 {
  92                         MAC_Address_t Destination; /**< Physical MAC address of the packet recipient */
  93                         MAC_Address_t Source; /**< Physics MAC address of the packet source */
  94
  95                         union
  96                         {
  97                                 uint16_t  EtherType; /**< Ethernet packet subprotocol type, for Ethernet V2 packets */
  98                                 uint16_t  Length; /**< Ethernet frame length, for Ethernet V1 packets */
  99                         };
 100                 } Ethernet_Frame_Header_t;
 101
 102         /* External Variables: */
 103                 extern Ethernet_Frame_Info_t FrameIN;
 104                 extern Ethernet_Frame_Info_t FrameOUT;
 105
 106                 extern const MAC_Address_t ServerMACAddress;
 107                 extern const IP_Address_t  ServerIPAddress;
 108                 extern const MAC_Address_t BroadcastMACAddress;
 109                 extern const IP_Address_t  BroadcastIPAddress;
 110                 extern const IP_Address_t  ClientIPAddress;
 111
 112         /* Function Prototypes: */
 113                 void     Ethernet_ProcessPacket(void);
 114                 uint16_t Ethernet_Checksum16(void* Data, uint16_t Bytes);
 115
 116 #endif