forked from mfulz_github/qmk_firmware
		
	Added parameter directions to function parameter documentation. Added new experimental FAST_STREAM_FUNCTIONS compile time option to speed up stream transfers at the expense of a higher FLASH consumption (needs testing to verify improved throughput).
		
			
				
	
	
		
			105 lines
		
	
	
		
			3.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			105 lines
		
	
	
		
			3.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
             LUFA Library
 | 
						|
     Copyright (C) Dean Camera, 2009.
 | 
						|
              
 | 
						|
  dean [at] fourwalledcubicle [dot] com
 | 
						|
      www.fourwalledcubicle.com
 | 
						|
*/
 | 
						|
 | 
						|
/*
 | 
						|
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 | 
						|
 | 
						|
  Permission to use, copy, modify, and distribute this software
 | 
						|
  and its documentation for any purpose and without fee is hereby
 | 
						|
  granted, provided that the above copyright notice appear in all
 | 
						|
  copies and that both that the copyright notice and this
 | 
						|
  permission notice and warranty disclaimer appear in supporting
 | 
						|
  documentation, and that the name of the author not be used in
 | 
						|
  advertising or publicity pertaining to distribution of the
 | 
						|
  software without specific, written prior permission.
 | 
						|
 | 
						|
  The author disclaim all warranties with regard to this
 | 
						|
  software, including all implied warranties of merchantability
 | 
						|
  and fitness.  In no event shall the author be liable for any
 | 
						|
  special, indirect or consequential damages or any damages
 | 
						|
  whatsoever resulting from loss of use, data or profits, whether
 | 
						|
  in an action of contract, negligence or other tortious action,
 | 
						|
  arising out of or in connection with the use or performance of
 | 
						|
  this software.
 | 
						|
*/
 | 
						|
 | 
						|
/** \file
 | 
						|
 *
 | 
						|
 *  Header file for Ethernet.c.
 | 
						|
 */
 | 
						|
 
 | 
						|
#ifndef _ETHERNET_H_
 | 
						|
#define _ETHERNET_H_
 | 
						|
 | 
						|
	/* Includes: */
 | 
						|
		#include <avr/io.h>
 | 
						|
		#include <string.h>
 | 
						|
		
 | 
						|
		#include <LUFA/Drivers/USB/Class/RNDIS.h>
 | 
						|
 | 
						|
		#include "EthernetProtocols.h"
 | 
						|
		#include "ProtocolDecoders.h"
 | 
						|
		#include "ICMP.h"
 | 
						|
		#include "TCP.h"
 | 
						|
		#include "UDP.h"
 | 
						|
		#include "DHCP.h"
 | 
						|
		#include "ARP.h"
 | 
						|
		#include "IP.h"
 | 
						|
		
 | 
						|
	/* Macros: */
 | 
						|
		/** Physical MAC address of the USB RNDIS network adapter */
 | 
						|
		#define ADAPTER_MAC_ADDRESS              {0x00, 0x02, 0x00, 0x02, 0x00, 0x02}		
 | 
						|
 | 
						|
		/** Physical MAC address of the virtual server on the network */
 | 
						|
		#define SERVER_MAC_ADDRESS               {0x00, 0x01, 0x00, 0x01, 0x00, 0x01}		
 | 
						|
 | 
						|
		/** Physical MAC address of the network broadcast address */
 | 
						|
		#define BROADCAST_MAC_ADDRESS            {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}
 | 
						|
	
 | 
						|
		/** Performs a comparison between two MAC addresses, indicating if they are identical.
 | 
						|
		 *  
 | 
						|
		 *  \param[in] MAC1  First MAC address
 | 
						|
		 *  \param[in] MAC2  Second MAC address
 | 
						|
		 *
 | 
						|
		 *  \return True if the addresses match, false otherwise
 | 
						|
		 */
 | 
						|
		#define MAC_COMPARE(MAC1, MAC2)          (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0)
 | 
						|
		
 | 
						|
		/** Return value for all sub protocol handling routines, indicating that no response packet has been generated */
 | 
						|
		#define NO_RESPONSE                      0		
 | 
						|
 | 
						|
		/** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled */
 | 
						|
		#define NO_PROCESS                       -1
 | 
						|
 | 
						|
	/* Type Defines: */
 | 
						|
		/** Type define for an Ethernet frame header */
 | 
						|
		typedef struct
 | 
						|
		{
 | 
						|
			MAC_Address_t Destination; /**< Physical MAC address of the packet recipient */
 | 
						|
			MAC_Address_t Source; /**< Physics MAC address of the packet source */
 | 
						|
			
 | 
						|
			union
 | 
						|
			{
 | 
						|
				uint16_t  EtherType; /**< Ethernet packet subprotocol type, for Ethernet V2 packets */
 | 
						|
				uint16_t  Length; /**< Ethernet frame length, for Ethernet V1 packets */
 | 
						|
			};
 | 
						|
		} Ethernet_Frame_Header_t;
 | 
						|
		
 | 
						|
	/* External Variables: */
 | 
						|
		extern const MAC_Address_t ServerMACAddress;
 | 
						|
		extern const IP_Address_t  ServerIPAddress;
 | 
						|
		extern const MAC_Address_t BroadcastMACAddress;
 | 
						|
		extern const IP_Address_t  BroadcastIPAddress;
 | 
						|
		extern const IP_Address_t  ClientIPAddress;
 | 
						|
		
 | 
						|
	/* Function Prototypes: */
 | 
						|
		void     Ethernet_ProcessPacket(Ethernet_Frame_Info_t* FrameIN, Ethernet_Frame_Info_t* FrameOUT);
 | 
						|
		uint16_t Ethernet_Checksum16(void* Data, uint16_t Bytes);
 | 
						|
		
 | 
						|
#endif
 |