Moved out each demos' functionality library files (e.g. Ring Buffer library) to ...
[pub/lufa.git] / Demos / Device / RNDISEthernet / Lib / DHCP.h
diff --git a/Demos/Device/RNDISEthernet/Lib/DHCP.h b/Demos/Device/RNDISEthernet/Lib/DHCP.h
new file mode 100644 (file)
index 0000000..f0e68b9
--- /dev/null
@@ -0,0 +1,125 @@
+/*\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 DHCP.c.\r
+ */\r
\r
+#ifndef _DHCP_H_\r
+#define _DHCP_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
+               /** DHCP operation constant, indicating a request from a host to a DHCP server */\r
+               #define DHCP_OP_BOOTREQUEST       0x01\r
+\r
+               /** DHCP operation constant, indicating a reply from a DHCP server to a host */\r
+               #define DHCP_OP_BOOTREPLY         0x02\r
+               \r
+               /** Hardware type constant, indicating Ethernet as a carrier */\r
+               #define DHCP_HTYPE_ETHERNET       0x01\r
+               \r
+               /** Magic boot protocol "cookie", inserted into all BOOTP packets (BOOTP is the carrier of DHCP) */\r
+               #define DHCP_MAGIC_COOKIE         0x63825363\r
+               \r
+               /** DHCP option list entry header, indicating that a subnet mask will follow */\r
+               #define DHCP_OPTION_SUBNETMASK    1\r
+\r
+               /** DHCP option list entry header, indicating that the DHCP message type constant will follow */\r
+               #define DHCP_OPTION_MESSAGETYPE   53\r
+\r
+               /** DHCP option list entry header, indicating that the IP address of the DHCP server will follow */\r
+               #define DHCP_OPTION_DHCPSERVER    54\r
+\r
+               /** DHCP option list entry header, used to pad out option data */\r
+               #define DHCP_OPTION_PAD           0\r
+\r
+               /** DHCP option list entry header, indicating the end of option data */\r
+               #define DHCP_OPTION_END           255\r
+                       \r
+               /** Message type constant, used in the DHCP option data field, requesting that a DHCP server offer an IP address */\r
+               #define DHCP_MESSAGETYPE_DISCOVER 1\r
+\r
+               /** Message type constant, used in the DHCP option data field, indicating that a DHCP server is offering an IP address */\r
+               #define DHCP_MESSAGETYPE_OFFER    2\r
+\r
+               /** Message type constant, used in the DHCP option data field, requesting that a DHCP server lease a given IP address */\r
+               #define DHCP_MESSAGETYPE_REQUEST  3\r
+\r
+               /** Message type constant, used in the DHCP option data field, declining an offered DHCP server IP address lease */\r
+               #define DHCP_MESSAGETYPE_DECLINE  4\r
+\r
+               /** Message type constant, used in the DHCP option data field, ACKing a host IP lease request */\r
+               #define DHCP_MESSAGETYPE_ACK      5\r
+\r
+               /** Message type constant, used in the DHCP option data field, NACKing a host IP lease request */\r
+               #define DHCP_MESSAGETYPE_NACK     6\r
+\r
+               /** Message type constant, used in the DHCP option data field, indicating that a host is releasing a leased IP address */\r
+               #define DHCP_MESSAGETYPE_RELEASE  7\r
+\r
+       /* Type Defines: */\r
+               /** Type define for a DHCP packet inside an Ethernet frame. */\r
+               typedef struct\r
+               {\r
+                       uint8_t  Operation; /**< DHCP operation, either DHCP_OP_BOOTREQUEST or DHCP_OP_BOOTREPLY */\r
+                       uint8_t  HardwareType; /**< Hardware carrier type constant */\r
+                       uint8_t  HardwareAddressLength;  /**< Length in bytes of a hardware (MAC) address on the network */\r
+                       uint8_t  Hops; /**< Number of hops required to reach the server, unused */\r
+\r
+                       uint32_t TransactionID; /**< Unique ID of the DHCP packet, for positive matching between sent and received packets */\r
+\r
+                       uint16_t ElapsedSeconds; /**< Elapsed seconds since the request was made */\r
+                       uint16_t Flags; /**< BOOTP packet flags */\r
+                       \r
+                       IP_Address_t ClientIP; /**< Client IP address, if already leased an IP */\r
+                       IP_Address_t YourIP; /**< Client IP address */\r
+                       IP_Address_t NextServerIP; /**< Legacy BOOTP protocol field, unused for DHCP */\r
+                       IP_Address_t RelayAgentIP; /**< Legacy BOOTP protocol field, unused for DHCP */\r
+                       \r
+                       uint8_t ClientHardwareAddress[16]; /**< Hardware (MAC) address of the client making a request to the DHCP server */\r
+                       uint8_t ServerHostnameString[64]; /**< Legacy BOOTP protocol field, unused for DHCP */\r
+                       uint8_t BootFileName[128]; /**< Legacy BOOTP protocol field, unused for DHCP */\r
+                       \r
+                       uint32_t Cookie; /**< Magic BOOTP protocol cookie to indicate a valid packet */\r
+               } DHCP_Header_t;\r
+\r
+       /* Function Prototypes: */\r
+               int16_t DHCP_ProcessDHCPPacket(void* IPHeaderInStart, void* DHCPHeaderInStart, void* DHCPHeaderOutStart);\r
+\r
+#endif\r