Add LUFA-side channel open/close routines, add signalling handlers for the creation...
[pub/USBasp.git] / Demos / Host / LowLevel / RNDISEthernetHost / Lib / RNDISCommands.c
index bde6250..533766a 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -43,7 +43,7 @@ uint32_t RequestID = 0;
 /** Function to send the given encapsulated RNDIS command to the device.\r
  *\r
  *  \param[in] Buffer  Source command data buffer to send to the device\r
 /** Function to send the given encapsulated RNDIS command to the device.\r
  *\r
  *  \param[in] Buffer  Source command data buffer to send to the device\r
- *  \param[in] Bytes   Number of bytes to send\r
+ *  \param[in] Length   Number of bytes to send\r
  *\r
  *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
  */\r
  *\r
  *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
  */\r
@@ -67,7 +67,7 @@ uint8_t RNDIS_SendEncapsulatedCommand(void* Buffer, uint16_t Length)
 /** Function to receive the given encapsulated RNDIS response from the device.\r
  *\r
  *  \param[out] Buffer  Destination command data buffer to write read data from the device to\r
 /** Function to receive the given encapsulated RNDIS response from the device.\r
  *\r
  *  \param[out] Buffer  Destination command data buffer to write read data from the device to\r
- *  \param[in] Bytes   Number of bytes to read\r
+ *  \param[in] Length   Number of bytes to read\r
  *\r
  *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
  */\r
  *\r
  *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
  */\r
@@ -91,7 +91,8 @@ uint8_t RNDIS_GetEncapsulatedResponse(void* Buffer, uint16_t Length)
 /** Sends a RNDIS KEEPALIVE command to the device, to ensure that it does not enter standby mode after periods\r
  *  of long inactivity.\r
  *\r
 /** Sends a RNDIS KEEPALIVE command to the device, to ensure that it does not enter standby mode after periods\r
  *  of long inactivity.\r
  *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a\r
+ *          logical command failure\r
  */\r
 uint8_t RNDIS_SendKeepAlive(void)\r
 {\r
  */\r
 uint8_t RNDIS_SendKeepAlive(void)\r
 {\r
@@ -124,7 +125,8 @@ uint8_t RNDIS_SendKeepAlive(void)
  *  \param[in] HostMaxPacketSize  Size of the packet buffer on the host\r
  *  \param[out] DeviceMaxPacketSize   Pointer to where the packet buffer size of the device is to be stored\r
  *\r
  *  \param[in] HostMaxPacketSize  Size of the packet buffer on the host\r
  *  \param[out] DeviceMaxPacketSize   Pointer to where the packet buffer size of the device is to be stored\r
  *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a\r
+ *          logical command failure\r
  */\r
 uint8_t RNDIS_InitializeDevice(uint16_t HostMaxPacketSize, uint16_t* DeviceMaxPacketSize)\r
 {\r
  */\r
 uint8_t RNDIS_InitializeDevice(uint16_t HostMaxPacketSize, uint16_t* DeviceMaxPacketSize)\r
 {\r
@@ -167,7 +169,8 @@ uint8_t RNDIS_InitializeDevice(uint16_t HostMaxPacketSize, uint16_t* DeviceMaxPa
  *  \param[in] Buffer  Pointer to where the property data is to be sourced from\r
  *  \param[in] Length  Length in bytes of the property data to sent to the device\r
  *\r
  *  \param[in] Buffer  Pointer to where the property data is to be sourced from\r
  *  \param[in] Length  Length in bytes of the property data to sent to the device\r
  *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a\r
+ *          logical command failure\r
  */\r
 uint8_t RNDIS_SetRNDISProperty(uint32_t Oid, void* Buffer, uint16_t Length)\r
 {\r
  */\r
 uint8_t RNDIS_SetRNDISProperty(uint32_t Oid, void* Buffer, uint16_t Length)\r
 {\r
@@ -216,7 +219,8 @@ uint8_t RNDIS_SetRNDISProperty(uint32_t Oid, void* Buffer, uint16_t Length)
  *  \param[in] Buffer  Pointer to where the property data is to be written to\r
  *  \param[in] MaxLength  Length in bytes of the destination buffer size\r
  *\r
  *  \param[in] Buffer  Pointer to where the property data is to be written to\r
  *  \param[in] MaxLength  Length in bytes of the destination buffer size\r
  *\r
- *  \return A value from the USB_Host_SendControlErrorCodes_t enum\r
+ *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a\r
+ *          logical command failure\r
  */\r
 uint8_t RNDIS_QueryRNDISProperty(uint32_t Oid, void* Buffer, uint16_t MaxLength)\r
 {\r
  */\r
 uint8_t RNDIS_QueryRNDISProperty(uint32_t Oid, void* Buffer, uint16_t MaxLength)\r
 {\r