Moved out each demos' functionality library files (e.g. Ring Buffer library) to ...

[pub/lufa.git] / Demos / Device / RNDISEthernet / Lib / IP.h

diff --git a/Demos/Device/RNDISEthernet/Lib/IP.h b/Demos/Device/RNDISEthernet/Lib/IP.h
new file mode 100644 (file)
index 0000000..fc1a46a
--- /dev/null
+++ b/Demos/Device/RNDISEthernet/Lib/IP.h
@@ -0,0 +1,93 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Header file for IP.c.\r
+ */\r
+ \r
+#ifndef _IP_H_\r
+#define _IP_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <string.h>\r
+               \r
+               #include "EthernetProtocols.h"\r
+               #include "Ethernet.h"\r
+               #include "ProtocolDecoders.h"\r
+       \r
+       /* Macros: */\r
+               /** Protocol IP address of the host (client) machine, once assigned by DHCP */\r
+               #define CLIENT_IP_ADDRESS                { 10,     0,    0,    1}\r
+\r
+               /** Protocol IP address of the virtual server machine */\r
+               #define SERVER_IP_ADDRESS                { 10,     0,    0,    2}\r
+\r
+               /** Protocol IP address of the broadcast address */\r
+               #define BROADCAST_IP_ADDRESS             {0xFF, 0xFF, 0xFF, 0xFF}\r
+\r
+               /** Default Time To Live (TTL) value for sent packets, indicating the maximum allowable hops until their destination is reached */\r
+               #define DEFAULT_TTL                      128\r
+               \r
+               /** Performs a comparison between two IP addresses, indicating if they are identical.\r
+                *  \r
+                *  \param IP1  First IP address\r
+                *  \param IP2  Second IP address\r
+                *\r
+                *  \return True if the addresses match, false otherwise\r
+                */\r
+               #define IP_COMPARE(IP1, IP2)             (memcmp(IP1, IP2, sizeof(IP_Address_t)) == 0)\r
+               \r
+       /* Type Defines: */\r
+               /** Type define of an IP packet header. */\r
+               typedef struct\r
+               {\r
+                       unsigned char  HeaderLength   : 4; /**< Total length of the packet header, in 4-byte blocks */\r
+                       unsigned char  Version        : 4; /**< IP protocol version */\r
+                       uint8_t        TypeOfService; /**< Special service type identifier, indicating delay/throughput/reliability levels */\r
+                       uint16_t       TotalLength; /**< Total length of the IP packet, in bytes */\r
+\r
+                       uint16_t       Identification; /**< Identification value for identifying fragmented packets */\r
+                       unsigned int   FragmentOffset : 13; /**< Offset of this IP fragment */\r
+                       unsigned int   Flags          : 3; /**< Fragment flags, to indicate if a packet is fragmented */\r
+\r
+                       uint8_t        TTL; /**< Maximum allowable number of hops to reach the packet destination */\r
+                       uint8_t        Protocol; /**< Encapsulated protocol type */\r
+                       uint16_t       HeaderChecksum; /**< Ethernet checksum of the IP header */\r
+                       \r
+                       IP_Address_t  SourceAddress; /**< Source protocol IP address of the packet */\r
+                       IP_Address_t  DestinationAddress; /**< Destination protocol IP address of the packet */\r
+               } IP_Header_t;\r
+               \r
+       /* Function Prototypes: */\r
+               int16_t IP_ProcessIPPacket(void* InDataStart, void* OutDataStart);\r
+\r
+#endif\r