Add beginnings of a RNDIS Ethernet Host demo.
[pub/lufa.git] / Demos / Host / Incomplete / RNDISEthernetHost / Lib / RNDISCommands.h
diff --git a/Demos/Host/Incomplete/RNDISEthernetHost/Lib/RNDISCommands.h b/Demos/Host/Incomplete/RNDISEthernetHost/Lib/RNDISCommands.h
new file mode 100644 (file)
index 0000000..dfb43e2
--- /dev/null
@@ -0,0 +1,205 @@
+/*\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 RNDISCommands.c.\r
+ */\r
+\r
+#ifndef _RNDIS_COMMANDS_H_\r
+#define _RNDIS_COMMANDS_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <stdio.h>\r
+               \r
+               #include <LUFA/Drivers/USB/USB.h>\r
+               \r
+               #include "RNDISConstants.h"\r
+\r
+       /* Type Defines: */\r
+               /** Type define for a RNDIS message header, sent before RNDIS messages */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */\r
+                       uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */\r
+               } RNDIS_Message_Header_t;\r
+\r
+               /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t DataOffset;\r
+                       uint32_t DataLength;\r
+                       uint32_t OOBDataOffset;\r
+                       uint32_t OOBDataLength;\r
+                       uint32_t NumOOBDataElements;\r
+                       uint32_t PerPacketInfoOffset;\r
+                       uint32_t PerPacketInfoLength;\r
+                       uint32_t VcHandle;\r
+                       uint32_t Reserved;\r
+               } RNDIS_Packet_Message_t;\r
+       \r
+               /** Type define for a RNDIS Initialize command message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+                       \r
+                       uint32_t MajorVersion;\r
+                       uint32_t MinorVersion;\r
+                       uint32_t MaxTransferSize;\r
+               } RNDIS_Initialize_Message_t;\r
+               \r
+               /** Type define for a RNDIS Initialize complete response message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+                       uint32_t Status;\r
+                       \r
+                       uint32_t MajorVersion;\r
+                       uint32_t MinorVersion;\r
+                       uint32_t DeviceFlags;\r
+                       uint32_t Medium;\r
+                       uint32_t MaxPacketsPerTransfer;\r
+                       uint32_t MaxTransferSize;\r
+                       uint32_t PacketAlignmentFactor;\r
+                       uint32_t AFListOffset;\r
+                       uint32_t AFListSize;\r
+               } RNDIS_Initialize_Complete_t;\r
+               \r
+               /** Type define for a RNDIS Keepalive command message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+               } RNDIS_KeepAlive_Message_t;\r
+\r
+               /** Type define for a RNDIS Keepalive complete message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+                       uint32_t Status;\r
+               } RNDIS_KeepAlive_Complete_t;\r
+\r
+               /** Type define for a RNDIS Reset complete message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t Status;\r
+\r
+                       uint32_t AddressingReset;\r
+               } RNDIS_Reset_Complete_t;\r
+               \r
+               /** Type define for a RNDIS Set command message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+                       \r
+                       uint32_t Oid;\r
+                       uint32_t InformationBufferLength;\r
+                       uint32_t InformationBufferOffset;\r
+                       uint32_t DeviceVcHandle;\r
+               } RNDIS_Set_Message_t;\r
+\r
+               /** Type define for a RNDIS Set complete response message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+                       uint32_t Status;\r
+               } RNDIS_Set_Complete_t;\r
+               \r
+               /** Type define for a RNDIS Query command message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+                       \r
+                       uint32_t Oid;\r
+                       uint32_t InformationBufferLength;\r
+                       uint32_t InformationBufferOffset;\r
+                       uint32_t DeviceVcHandle;\r
+               } RNDIS_Query_Message_t;\r
+               \r
+               /** Type define for a RNDIS Query complete response message */\r
+               typedef struct\r
+               {\r
+                       uint32_t MessageType;\r
+                       uint32_t MessageLength;\r
+                       uint32_t RequestId;\r
+                       uint32_t Status;\r
+                       \r
+                       uint32_t InformationBufferLength;\r
+                       uint32_t InformationBufferOffset;\r
+               } RNDIS_Query_Complete_t;\r
+\r
+       /* Macros: */\r
+               /** RNDIS request to issue a host-to-device NDIS command */\r
+               #define REQ_SendEncapsulatedCommand           0x00\r
+\r
+               /** RNDIS request to issue a device-to-host NDIS response */\r
+               #define REQ_GetEncapsulatedResponse           0x01\r
+\r
+               /** Implemented RNDIS Version Major */\r
+               #define REMOTE_NDIS_VERSION_MAJOR             0x01\r
+\r
+               /** Implemented RNDIS Version Minor */\r
+               #define REMOTE_NDIS_VERSION_MINOR             0x00\r
+\r
+               /** Pipe number for the RNDIS data IN pipe */\r
+               #define RNDIS_DATAPIPE_IN         1\r
+\r
+               /** Pipe number for the RNDIS data OUT pipe */\r
+               #define RNDIS_DATAPIPE_OUT        2\r
+\r
+               /** Pipe number for the RNDIS notification pipe */\r
+               #define RNDIS_NOTIFICATIONPIPE    3\r
+               \r
+       /* Function Prototypes: */\r
+               uint8_t RNDIS_SendEncapsulatedCommand(void* Buffer, uint16_t Length);\r
+               uint8_t RNDIS_GetEncapsulatedResponse(void* Buffer, uint16_t Length);\r
+\r
+               uint8_t RNDIS_InitializeDevice(uint16_t MaxPacketSize, RNDIS_Initialize_Complete_t* InitMessageResponse);\r
+               uint8_t RNDIS_SetRNDISProperty(uint32_t Oid, void* Buffer, uint16_t Length);\r
+\r
+#endif\r