diff options
Diffstat (limited to 'Demos/Host')
10 files changed, 48 insertions, 48 deletions
diff --git a/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.c b/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.c index 5bb89af47..9f7da5998 100644 --- a/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.c +++ b/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.c @@ -164,10 +164,10 @@ void ReadNextReport(void) /** Writes a report to the attached device.
*
- * \param ReportOUTData Buffer containing the report to send to the device
- * \param ReportIndex Index of the report in the device (zero if the device does not use multiple reports)
- * \param ReportType Type of report to send, either HID_REPORTTYPE_OUTPUT or HID_REPORTTYPE_FEATURE
- * \param ReportLength Length of the report to send
+ * \param[in] ReportOUTData Buffer containing the report to send to the device
+ * \param[in] ReportIndex Index of the report in the device (zero if the device does not use multiple reports)
+ * \param[in] ReportType Type of report to send, either HID_REPORTTYPE_OUTPUT or HID_REPORTTYPE_FEATURE
+ * \param[in] ReportLength Length of the report to send
*/
void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength)
{
diff --git a/Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.c b/Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.c index 54e400ded..4e78b0de9 100644 --- a/Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.c +++ b/Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.c @@ -224,7 +224,7 @@ void Keyboard_HID_Task(void) /** Processes a read HID report from an attached keyboard, extracting out elements via the HID parser results
* as required and prints pressed characters to the serial port. Each time a key is typed, a board LED is toggled.
*
- * \param KeyboardReport Pointer to a HID report from an attached keyboard device
+ * \param[in] KeyboardReport Pointer to a HID report from an attached keyboard device
*/
void ProcessKeyboardReport(uint8_t* KeyboardReport)
{
diff --git a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.c b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.c index e2a64da90..7ee7de138 100644 --- a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.c +++ b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.c @@ -170,7 +170,7 @@ static uint8_t MassStore_WaitForDataReceived(void) /** Sends or receives the transaction's data stage to or from the attached device, reading or
* writing to the nominated buffer.
*
- * \param BufferPtr Pointer to the data buffer to read from or write to
+ * \param[in,out] BufferPtr Pointer to the data buffer to read from or write to
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -269,7 +269,7 @@ uint8_t MassStore_MassStorageReset(void) /** Issues a Mass Storage class specific request to determine the index of the highest numbered Logical
* Unit in the attached device.
*
- * \param MaxLUNIndex Pointer to the location that the maximum LUN index value should be stored
+ * \param[out] MaxLUNIndex Pointer to the location that the maximum LUN index value should be stored
*
* \return A value from the USB_Host_SendControlErrorCodes_t enum
*/
@@ -304,8 +304,8 @@ uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex) /** Issues a SCSI Inquiry command to the attached device, to determine the device's information. This
* gives information on the device's capabilities.
*
- * \param LUNIndex Index of the LUN inside the device the command is being addressed to
- * \param InquiryPtr Pointer to the inquiry data structure where the inquiry data from the device is to be stored
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[out] InquiryPtr Pointer to the inquiry data structure where the inquiry data from the device is to be stored
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -367,8 +367,8 @@ uint8_t MassStore_Inquiry(const uint8_t LUNIndex, const SCSI_Inquiry_Response_t* /** Issues a SCSI Request Sense command to the attached device, to determine the current SCSI sense information. This
* gives error codes for the last issued SCSI command to the device.
*
- * \param LUNIndex Index of the LUN inside the device the command is being addressed to
- * \param SensePtr Pointer to the sense data structure where the sense data from the device is to be stored
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[out] SensePtr Pointer to the sense data structure where the sense data from the device is to be stored
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -430,11 +430,11 @@ uint8_t MassStore_RequestSense(const uint8_t LUNIndex, const SCSI_Request_Sense_ /** Issues a SCSI Device Block Read command to the attached device, to read in one or more data blocks from the
* storage medium into a buffer.
*
- * \param LUNIndex Index of the LUN inside the device the command is being addressed to
- * \param BlockAddress Start block address to read from
- * \param Blocks Number of blocks to read from the device
- * \param BlockSize Size in bytes of each block to read
- * \param BufferPtr Pointer to the buffer where the read data is to be written to
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[in] BlockAddress Start block address to read from
+ * \param[in] Blocks Number of blocks to read from the device
+ * \param[in] BlockSize Size in bytes of each block to read
+ * \param[out] BufferPtr Pointer to the buffer where the read data is to be written to
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -501,11 +501,11 @@ uint8_t MassStore_ReadDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAd /** Issues a SCSI Device Block Write command to the attached device, to write one or more data blocks to the
* storage medium from a buffer.
*
- * \param LUNIndex Index of the LUN inside the device the command is being addressed to
- * \param BlockAddress Start block address to write to
- * \param Blocks Number of blocks to write to in the device
- * \param BlockSize Size in bytes of each block to write
- * \param BufferPtr Pointer to the buffer where the write data is to be sourced from
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[in] BlockAddress Start block address to write to
+ * \param[in] Blocks Number of blocks to write to in the device
+ * \param[in] BlockSize Size in bytes of each block to write
+ * \param[in] BufferPtr Pointer to the buffer where the write data is to be sourced from
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -565,7 +565,7 @@ uint8_t MassStore_WriteDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockA /** Issues a SCSI Device Test Unit Ready command to the attached device, to determine if the device is ready to accept
* other commands.
*
- * \param LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -613,8 +613,8 @@ uint8_t MassStore_TestUnitReady(const uint8_t LUNIndex) /** Issues a SCSI Device Read Capacity command to the attached device, to determine the capacity of the
* given Logical Unit within the device.
*
- * \param LUNIndex Index of the LUN inside the device the command is being addressed to
- * \param CapacityPtr Device capacity structure where the capacity data is to be stored
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[out] CapacityPtr Device capacity structure where the capacity data is to be stored
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -685,8 +685,8 @@ uint8_t MassStore_ReadCapacity(const uint8_t LUNIndex, SCSI_Capacity_t* const Ca * being removed. This is a legacy command for SCSI disks with removable storage (such as ZIP disks), but should still
* be issued before the first read or write command is sent.
*
- * \param LUNIndex Index of the LUN inside the device the command is being addressed to
- * \param PreventRemoval Whether or not the LUN media should be locked to prevent removal or not
+ * \param[in] LUNIndex Index of the LUN inside the device the command is being addressed to
+ * \param[in] PreventRemoval Whether or not the LUN media should be locked to prevent removal or not
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
diff --git a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h index 8f3e8a12e..f13b4b15a 100644 --- a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h +++ b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h @@ -42,7 +42,7 @@ #include "MassStorageHost.h"
#include "SCSI_Codes.h"
- #include <LUFA/Drivers/USB/USB.h> // USB Functionality
+ #include <LUFA/Drivers/USB/USB.h>
/* Macros: */
/** Class specific request to reset the Mass Storage interface of the attached device */
diff --git a/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.c b/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.c index 200c81ad4..2f84d0fb8 100644 --- a/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.c +++ b/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.c @@ -349,9 +349,9 @@ void MassStorage_Task(void) * printing error codes to the serial port and waiting until the device is removed before
* continuing.
*
- * \param CommandString ASCII string located in PROGMEM space indicating what operation failed
- * \param FailedAtSCSILayer Indicates if the command failed at the (logical) SCSI layer or at the physical USB layer
- * \param ErrorCode Error code of the function which failed to complete successfully
+ * \param[in] CommandString ASCII string located in PROGMEM space indicating what operation failed
+ * \param[in] FailedAtSCSILayer Indicates if the command failed at the (logical) SCSI layer or at the physical USB layer
+ * \param[in] ErrorCode Error code of the function which failed to complete successfully
*/
void ShowDiskReadError(char* CommandString, bool FailedAtSCSILayer, uint8_t ErrorCode)
{
diff --git a/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.h b/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.h index a5b84c2eb..1307a1af2 100644 --- a/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.h +++ b/Demos/Host/LowLevel/MassStorageHost/MassStorageHost.h @@ -49,12 +49,12 @@ #include "Lib/MassStoreCommands.h"
- #include <LUFA/Version.h> // Library Version Information
- #include <LUFA/Drivers/Misc/TerminalCodes.h> // ANSI Terminal Escape Codes
- #include <LUFA/Drivers/USB/USB.h> // USB Functionality
- #include <LUFA/Drivers/Peripheral/SerialStream.h> // Serial stream driver
- #include <LUFA/Drivers/Board/LEDs.h> // LEDs driver
- #include <LUFA/Drivers/Board/Buttons.h> // Board Buttons driver
+ #include <LUFA/Version.h>
+ #include <LUFA/Drivers/Misc/TerminalCodes.h>
+ #include <LUFA/Drivers/USB/USB.h>
+ #include <LUFA/Drivers/Peripheral/SerialStream.h>
+ #include <LUFA/Drivers/Board/LEDs.h>
+ #include <LUFA/Drivers/Board/Buttons.h>
/* Macros: */
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
diff --git a/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.c b/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.c index 5f0d35866..d7a947105 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.c +++ b/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.c @@ -224,7 +224,7 @@ void Mouse_HID_Task(void) /** Processes a read HID report from an attached mouse, extracting out elements via the HID parser results
* as required and displays movement and button presses on the board LEDs.
*
- * \param MouseReport Pointer to a HID report from an attached mouse device
+ * \param[in] MouseReport Pointer to a HID report from an attached mouse device
*/
void ProcessMouseReport(uint8_t* MouseReport)
{
diff --git a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c index 8f05e48f4..bf8575084 100644 --- a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c +++ b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c @@ -190,8 +190,8 @@ uint8_t SImage_RecieveBlockHeader(void) /** Function to send the given data to the device, after a command block has been issued.
*
- * \param Buffer Source data buffer to send to the device
- * \param Bytes Number of bytes to send
+ * \param[in] Buffer Source data buffer to send to the device
+ * \param[in] Bytes Number of bytes to send
*/
void SImage_SendData(void* Buffer, uint16_t Bytes)
{
@@ -211,8 +211,8 @@ void SImage_SendData(void* Buffer, uint16_t Bytes) /** Function to receive the given data to the device, after a response block has been received.
*
- * \param Buffer Destination data buffer to put read bytes from the device
- * \param Bytes Number of bytes to receive
+ * \param[out] Buffer Destination data buffer to put read bytes from the device
+ * \param[in] Bytes Number of bytes to receive
*
* \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
*/
@@ -257,7 +257,7 @@ bool SImage_IsEventReceived(void) /** Clears the stall condition in the attached device on the nominated endpoint number.
*
- * \param EndpointNum Endpoint number in the attached device whose stall condition is to be cleared
+ * \param[in] EndpointNum Endpoint number in the attached device whose stall condition is to be cleared
*
* \return A value from the USB_Host_SendControlErrorCodes_t enum
*/
diff --git a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h index ad0ba55a2..2674b6aa5 100644 --- a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h +++ b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h @@ -57,7 +57,7 @@ /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
* a command container.
*
- * \param params Number of parameters which are to be sent in the Param field of the container
+ * \param[in] params Number of parameters which are to be sent in the Param field of the container
*/
#define PIMA_COMMAND_SIZE(params) ((sizeof(PIMA_SendBlock) - sizeof(PIMA_SendBlock.Params)) + \
(params * sizeof(PIMA_SendBlock.Params[0])))
@@ -65,7 +65,7 @@ /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
* a data container.
*
- * \param datalen Length in bytes of the data in the container
+ * \param[in] datalen Length in bytes of the data in the container
*/
#define PIMA_DATA_SIZE(datalen) ((sizeof(PIMA_SendBlock) - sizeof(PIMA_SendBlock.Params)) + datalen)
diff --git a/Demos/Host/LowLevel/StillImageHost/StillImageHost.c b/Demos/Host/LowLevel/StillImageHost/StillImageHost.c index a337ab045..524387123 100644 --- a/Demos/Host/LowLevel/StillImageHost/StillImageHost.c +++ b/Demos/Host/LowLevel/StillImageHost/StillImageHost.c @@ -327,8 +327,8 @@ void StillImage_Task(void) /** Function to convert a given Unicode encoded string to ASCII. This function will only work correctly on Unicode
* strings which contain ASCII printable characters only.
*
- * \param UnicodeString Pointer to a Unicode encoded input string
- * \param Buffer Pointer to a buffer where the converted ASCII string should be stored
+ * \param[in] UnicodeString Pointer to a Unicode encoded input string
+ * \param[out] Buffer Pointer to a buffer where the converted ASCII string should be stored
*/
void UnicodeToASCII(uint8_t* UnicodeString, char* Buffer)
{
@@ -351,8 +351,8 @@ void UnicodeToASCII(uint8_t* UnicodeString, char* Buffer) /** Displays a PIMA command error via the device's serial port.
*
- * \param ErrorCode Error code of the function which failed to complete successfully
- * \param ResponseCodeError Indicates if the error is due to a command failed indication from the device, or a communication failure
+ * \param[in] ErrorCode Error code of the function which failed to complete successfully
+ * \param[in] ResponseCodeError Indicates if the error is due to a command failed indication from the device, or a communication failure
*/
void ShowCommandError(uint8_t ErrorCode, bool ResponseCodeError)
{
|