Document the PDI programming routines implemented so far in the AVRISP project. Add...

[pub/USBasp.git] / Demos / Host / LowLevel / RNDISEthernetHost / Lib / RNDISCommands.c

diff --git a/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.c b/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.c
index bde6250..ca9ee5f 100644 (file)
--- a/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.c
+++ b/Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.c
@@ -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
- *  \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
@@ -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
- *  \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
@@ -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
- *  \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
@@ -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
- *  \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
@@ -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
- *  \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
@@ -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
- *  \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