diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-01-04 13:34:02 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-01-04 13:34:02 +0000 |
| commit | 6122ba93cf957bd495fdd1838bac16fb24896a17 (patch) | |
| tree | b8cef2eb41161e5beb7523f30b54ac03dfd7e9b4 /LUFA/Drivers/USB/Class/Host/RNDIS.h | |
| parent | 1e1cf2c499d7ac0cfae536e1264af4645350813b (diff) | |
| download | lufa-6122ba93cf957bd495fdd1838bac16fb24896a17.tar.gz lufa-6122ba93cf957bd495fdd1838bac16fb24896a17.tar.bz2 lufa-6122ba93cf957bd495fdd1838bac16fb24896a17.zip | |
Fix MassStorageKeyboard demo USE_INTERNAL_SERIAL check being performed before the required library headers were included, causing a compilation error.
Added notes to the class driver functions indicating which functions require what Device/Host state machine states to function.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Host/RNDIS.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/RNDIS.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 827cd65a0..fad27b9ad 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -190,6 +190,9 @@ /** Determines if a packet is currently waiting for the host to read in and process.
*
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
*
* \return Boolean true if a packet is waiting to be read in by the host, false otherwise
@@ -200,6 +203,9 @@ /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave
* only the packet contents for processing by the host in the nominated buffer.
*
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
* \param[out] Buffer Pointer to a buffer where the packer data is to be written to
* \param[out] PacketLength Pointer to where the length in bytes of the read packet is to be stored
@@ -211,6 +217,9 @@ /** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header.
*
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
+ * call will fail.
+ *
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
* \param[in] Buffer Pointer to a buffer where the packer data is to be read from
* \param[in] PacketLength Length in bytes of the packet to send
|