Commit a14ece5f authored by Dean Camera's avatar Dean Camera
Browse files

Change over Doxygen \note documentation to \pre where applicable.

parent 27fb4426
...@@ -102,6 +102,7 @@ ...@@ -102,6 +102,7 @@
* \return Boolean true if the buffer has been captured by the application for device-to-host transmissions, false otherwise * \return Boolean true if the buffer has been captured by the application for device-to-host transmissions, false otherwise
*/ */
#define TCP_APP_HAVE_CAPTURED_BUFFER(Buffer) (!(Buffer->Ready) && Buffer->InUse && \ #define TCP_APP_HAVE_CAPTURED_BUFFER(Buffer) (!(Buffer->Ready) && Buffer->InUse && \
(Buffer->Direction == TCP_PACKETDIR_OUT)) (Buffer->Direction == TCP_PACKETDIR_OUT))
/** Application macro: Indicates if the application can lock the buffer for multiple continued device-to-host transmissions. /** Application macro: Indicates if the application can lock the buffer for multiple continued device-to-host transmissions.
...@@ -115,7 +116,7 @@ ...@@ -115,7 +116,7 @@
/** Application macro: Captures the application buffer, locking it for device-to-host transmissions only. This should be /** Application macro: Captures the application buffer, locking it for device-to-host transmissions only. This should be
* performed when the application needs to transmit several packets worth of data in succession with no interruptions from the host. * performed when the application needs to transmit several packets worth of data in succession with no interruptions from the host.
* *
* \note The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER(). * \pre The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER().
* *
* \param[in] Buffer Application buffer to lock * \param[in] Buffer Application buffer to lock
*/ */
......
...@@ -115,7 +115,7 @@ ...@@ -115,7 +115,7 @@
/** Application macro: Captures the application buffer, locking it for device-to-host transmissions only. This should be /** Application macro: Captures the application buffer, locking it for device-to-host transmissions only. This should be
* performed when the application needs to transmit several packets worth of data in succession with no interruptions from the host. * performed when the application needs to transmit several packets worth of data in succession with no interruptions from the host.
* *
* \note The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER(). * \pre The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER().
* *
* \param[in] Buffer Application buffer to lock * \param[in] Buffer Application buffer to lock
*/ */
......
...@@ -91,7 +91,7 @@ ...@@ -91,7 +91,7 @@
/** Initializes the temperature sensor driver, including setting up the appropriate ADC channel. /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.
* This must be called before any other temperature sensor routines. * This must be called before any other temperature sensor routines.
* *
* \note The ADC itself (not the ADC channel) must be configured separately before calling the * \pre The ADC itself (not the ADC channel) must be configured separately before calling the
* temperature sensor functions. * temperature sensor functions.
*/ */
static inline void Temperature_Init(void); static inline void Temperature_Init(void);
......
...@@ -145,7 +145,7 @@ ...@@ -145,7 +145,7 @@
/** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming /** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming
* OUT endpoint ready for reading. * OUT endpoint ready for reading.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
...@@ -166,7 +166,7 @@ ...@@ -166,7 +166,7 @@
/** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects /** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects
* the streaming IN endpoint ready for writing. * the streaming IN endpoint ready for writing.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
...@@ -186,7 +186,7 @@ ...@@ -186,7 +186,7 @@
/** Reads the next 8-bit audio sample from the current audio interface. /** Reads the next 8-bit audio sample from the current audio interface.
* *
* \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
* ensure the correct endpoint is selected and ready for data. * ensure the correct endpoint is selected and ready for data.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
...@@ -211,7 +211,7 @@ ...@@ -211,7 +211,7 @@
/** Reads the next 16-bit audio sample from the current audio interface. /** Reads the next 16-bit audio sample from the current audio interface.
* *
* \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
* that the correct endpoint is selected and ready for data. * that the correct endpoint is selected and ready for data.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
...@@ -236,7 +236,7 @@ ...@@ -236,7 +236,7 @@
/** Reads the next 24-bit audio sample from the current audio interface. /** Reads the next 24-bit audio sample from the current audio interface.
* *
* \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
* that the correct endpoint is selected and ready for data. * that the correct endpoint is selected and ready for data.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
...@@ -261,7 +261,7 @@ ...@@ -261,7 +261,7 @@
/** Writes the next 8-bit audio sample to the current audio interface. /** Writes the next 8-bit audio sample to the current audio interface.
* *
* \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
* ensure that the correct endpoint is selected and ready for data. * ensure that the correct endpoint is selected and ready for data.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
...@@ -280,7 +280,7 @@ ...@@ -280,7 +280,7 @@
/** Writes the next 16-bit audio sample to the current audio interface. /** Writes the next 16-bit audio sample to the current audio interface.
* *
* \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
* ensure that the correct endpoint is selected and ready for data. * ensure that the correct endpoint is selected and ready for data.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
...@@ -299,7 +299,7 @@ ...@@ -299,7 +299,7 @@
/** Writes the next 24-bit audio sample to the current audio interface. /** Writes the next 24-bit audio sample to the current audio interface.
* *
* \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to
* ensure that the correct endpoint is selected and ready for data. * ensure that the correct endpoint is selected and ready for data.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state
......
...@@ -203,7 +203,7 @@ ...@@ -203,7 +203,7 @@
* \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
* packed into a single endpoint packet, increasing data throughput. * packed into a single endpoint packet, increasing data throughput.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
...@@ -220,7 +220,7 @@ ...@@ -220,7 +220,7 @@
* \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
* packed into a single endpoint packet, increasing data throughput. * packed into a single endpoint packet, increasing data throughput.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
...@@ -232,7 +232,7 @@ ...@@ -232,7 +232,7 @@
/** Determines the number of bytes received by the CDC interface from the host, waiting to be read. /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
...@@ -245,7 +245,7 @@ ...@@ -245,7 +245,7 @@
* returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data * returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data
* underflow occurs. * underflow occurs.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
...@@ -256,7 +256,7 @@ ...@@ -256,7 +256,7 @@
/** Flushes any data waiting to be sent, ensuring that the send buffer is cleared. /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
...@@ -270,7 +270,7 @@ ...@@ -270,7 +270,7 @@
* until they are cleared via a second notification. This should be called each time the CDC class driver's * until they are cleared via a second notification. This should be called each time the CDC class driver's
* ControlLineStates.DeviceToHost value is updated to push the new states to the USB host. * ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
* the call will fail. * the call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state
......
...@@ -116,8 +116,8 @@ ...@@ -116,8 +116,8 @@
* endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple * endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple
* MIDI events to be packed into a single endpoint packet, increasing data throughput. * MIDI events to be packed into a single endpoint packet, increasing data throughput.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* the call will fail. * call will fail.
* *
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
...@@ -140,8 +140,8 @@ ...@@ -140,8 +140,8 @@
/** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains /** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains
* multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event. * multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.
* *
* \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* the call will fail. * call will fail.
* *
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
* \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
......
...@@ -205,7 +205,7 @@ ...@@ -205,7 +205,7 @@
* \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
* packed into a single pipe packet, increasing data throughput. * packed into a single pipe packet, increasing data throughput.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
...@@ -222,7 +222,7 @@ ...@@ -222,7 +222,7 @@
* \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be
* packed into a single pipe packet, increasing data throughput. * packed into a single pipe packet, increasing data throughput.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
...@@ -234,7 +234,7 @@ ...@@ -234,7 +234,7 @@
/** Determines the number of bytes received by the CDC interface from the device, waiting to be read. /** Determines the number of bytes received by the CDC interface from the device, waiting to be read.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
...@@ -247,7 +247,7 @@ ...@@ -247,7 +247,7 @@
* returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data * returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data
* underflow occurs. * underflow occurs.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
...@@ -258,7 +258,7 @@ ...@@ -258,7 +258,7 @@
/** Flushes any data waiting to be sent, ensuring that the send buffer is cleared. /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state
......
...@@ -167,9 +167,8 @@ ...@@ -167,9 +167,8 @@
/** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe. /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* \n\n
* *
* \note The destination buffer should be large enough to accommodate the largest report that the attached device * \note The destination buffer should be large enough to accommodate the largest report that the attached device
* can generate. * can generate.
...@@ -185,9 +184,8 @@ ...@@ -185,9 +184,8 @@
#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY) #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
/** Receives a HID IN report from the attached device, by the report ID. /** Receives a HID IN report from the attached device, by the report ID.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* \n\n
* *
* \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
* *
...@@ -204,9 +202,8 @@ ...@@ -204,9 +202,8 @@
/** Sends an OUT or FEATURE report to the currently attached HID device, using the device's OUT pipe if available, /** Sends an OUT or FEATURE report to the currently attached HID device, using the device's OUT pipe if available,
* or the device's Control pipe if not. * or the device's Control pipe if not.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* \n\n
* *
* \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed
* from the parameter list of this function. * from the parameter list of this function.
...@@ -233,7 +230,7 @@ ...@@ -233,7 +230,7 @@
/** Determines if a HID IN report has been received from the attached device on the data IN pipe. /** Determines if a HID IN report has been received from the attached device on the data IN pipe.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state
......
...@@ -130,7 +130,7 @@ ...@@ -130,7 +130,7 @@
/** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded. /** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
...@@ -154,7 +154,7 @@ ...@@ -154,7 +154,7 @@
/** Receives a MIDI event packet from the device. /** Receives a MIDI event packet from the device.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
......
...@@ -174,7 +174,7 @@ ...@@ -174,7 +174,7 @@
/** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
* properties. * properties.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
...@@ -199,7 +199,7 @@ ...@@ -199,7 +199,7 @@
/** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size. /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
...@@ -215,7 +215,7 @@ ...@@ -215,7 +215,7 @@
/** Retrieves the device sense data, indicating the current device state and error codes for the previously /** Retrieves the device sense data, indicating the current device state and error codes for the previously
* issued command. * issued command.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
...@@ -231,7 +231,7 @@ ...@@ -231,7 +231,7 @@
/** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
* the device from removal so that blocks of data on the medium can be read or altered. * the device from removal so that blocks of data on the medium can be read or altered.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
...@@ -245,7 +245,7 @@ ...@@ -245,7 +245,7 @@
/** Reads blocks of data from the attached Mass Storage device's medium. /** Reads blocks of data from the attached Mass Storage device's medium.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
...@@ -263,7 +263,7 @@ ...@@ -263,7 +263,7 @@
/** Writes blocks of data to the attached Mass Storage device's medium. /** Writes blocks of data to the attached Mass Storage device's medium.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state
......
...@@ -161,7 +161,7 @@ ...@@ -161,7 +161,7 @@
* printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see * printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see
* \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer. * \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] PRNTInterfaceInfo Pointer to a structure containing a Printer Class host configuration and state * \param[in,out] PRNTInterfaceInfo Pointer to a structure containing a Printer Class host configuration and state
......
...@@ -195,7 +195,7 @@ ...@@ -195,7 +195,7 @@
/** Determines if a packet is currently waiting for the host to read in and process. /** 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 * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
...@@ -207,7 +207,7 @@ ...@@ -207,7 +207,7 @@
/** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave /** 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. * 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 * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
...@@ -221,7 +221,7 @@ ...@@ -221,7 +221,7 @@
/** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header. /** 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 * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state
......
...@@ -146,7 +146,7 @@ ...@@ -146,7 +146,7 @@
/** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
* are issued to the device. Only one session can be open at the one time. * are issued to the device. Only one session can be open at the one time.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
...@@ -159,7 +159,7 @@ ...@@ -159,7 +159,7 @@
/** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
* PIMA commands have been issued to the device. * PIMA commands have been issued to the device.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
...@@ -172,7 +172,7 @@ ...@@ -172,7 +172,7 @@
/** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send
* arbitrary PIMA blocks to the device with or without parameters. * arbitrary PIMA blocks to the device with or without parameters.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
...@@ -187,7 +187,7 @@ ...@@ -187,7 +187,7 @@
/** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with
* or without parameters. * or without parameters.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
* call will fail. * call will fail.
* *
* \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
...@@ -201,7 +201,7 @@ ...@@ -201,7 +201,7 @@
/** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically. /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
* *
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the