ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation cleanups.

Browse source
This commit is contained in:
Dean Camera 2010-06-03 15:32:45 +00:00
parent 9293de2491
commit fc92f9969c
109 changed files with 473 additions and 434 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h
View file

@ -42,7 +42,7 @@
#include "GenericHIDHost.h"
/* Macros: */
/** Interface Class value for the Human Interface Device class */
/** Interface Class value for the Human Interface Device class. */
#define HID_CLASS 0x03
/* Enums: */

4
Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.h
View file

@ -53,10 +53,10 @@
#include "ConfigDescriptor.h"
/* Macros: */
/** Pipe number for the HID data IN pipe */
/** Pipe number for the HID data IN pipe. */
#define HID_DATA_IN_PIPE 1
/** Pipe number for the HID data OUT pipe */
/** Pipe number for the HID data OUT pipe. */
#define HID_DATA_OUT_PIPE 2
/** HID Class specific request to send a HID report to the device. */

8
Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h
View file

@ -42,16 +42,16 @@
#include "HIDReport.h"
/* Macros: */
/** Interface Class value for the Human Interface Device class */
/** Interface Class value for the Human Interface Device class. */
#define JOYSTICK_CLASS 0x03
/** Interface Protocol value for a Boot Protocol Mouse compliant device */
/** Interface Protocol value for a Boot Protocol Mouse compliant device. */
#define JOYSTICK_PROTOCOL 0x02
/** Descriptor header type constant for a HID descriptor */
/** Descriptor header type constant for a HID descriptor. */
#define DTYPE_HID 0x21
/** Descriptor header type constant for a HID report descriptor */
/** Descriptor header type constant for a HID report descriptor. */
#define DTYPE_Report 0x22
/* Enums: */

10
Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h
View file

@ -43,19 +43,19 @@
#include "JoystickHostWithParser.h"
/* Macros: */
/** HID Report Descriptor Usage for a Joystick */
/** HID Report Descriptor Usage for a Joystick. */
#define USAGE_JOYSTICK 0x04
/** HID Report Descriptor Usage Page value for a toggle button */
/** HID Report Descriptor Usage Page value for a toggle button. */
#define USAGE_PAGE_BUTTON 0x09
/** HID Report Descriptor Usage Page value for a Generic Desktop Control */
/** HID Report Descriptor Usage Page value for a Generic Desktop Control. */
#define USAGE_PAGE_GENERIC_DCTRL 0x01
/** HID Report Descriptor Usage value for a X axis movement */
/** HID Report Descriptor Usage value for a X axis movement. */
#define USAGE_X 0x30
/** HID Report Descriptor Usage value for a Y axis movement */
/** HID Report Descriptor Usage value for a Y axis movement. */
#define USAGE_Y 0x31
/* Enums: */

2
Demos/Host/LowLevel/JoystickHostWithParser/JoystickHostWithParser.h
View file

@ -54,7 +54,7 @@
#include "HIDReport.h"
/* Macros: */
/** Pipe number for the joystick report data pipe */
/** Pipe number for the joystick report data pipe. */
#define JOYSTICK_DATAPIPE 1
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */

4
Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h
View file

@ -42,10 +42,10 @@
#include "KeyboardHost.h"
/* Macros: */
/** Interface Class value for the Human Interface Device class */
/** Interface Class value for the Human Interface Device class. */
#define KEYBOARD_CLASS 0x03
/** Interface Protocol value for a Boot Protocol Keyboard compliant device */
/** Interface Protocol value for a Boot Protocol Keyboard compliant device. */
#define KEYBOARD_PROTOCOL 0x01
/* Enums: */

6
Demos/Host/LowLevel/KeyboardHost/KeyboardHost.h
View file

@ -53,10 +53,10 @@
#include "ConfigDescriptor.h"
/* Macros: */
/** Pipe number for the keyboard data IN pipe */
/** Pipe number for the keyboard data IN pipe. */
#define KEYBOARD_DATAPIPE 1
/** HID Class Specific request to set the report protocol mode */
/** HID Class Specific request to set the report protocol mode. */
#define REQ_SetProtocol 0x0B
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
@ -72,7 +72,7 @@
#define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3)
/* Type Defines: */
/** Type define for a standard Boot Protocol Keyboard report */
/** Type define for a standard Boot Protocol Keyboard report. */
typedef struct
{
uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (such as Shift, Control, etc.) */

8
Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h
View file

@ -42,16 +42,16 @@
#include "HIDReport.h"
/* Macros: */
/** Interface Class value for the Human Interface Device class */
/** Interface Class value for the Human Interface Device class. */
#define KEYBOARD_CLASS 0x03
/** Interface Protocol value for a Boot Protocol Keyboard compliant device */
/** Interface Protocol value for a Boot Protocol Keyboard compliant device. */
#define KEYBOARD_PROTOCOL 0x01
/** Descriptor header type constant for a HID descriptor */
/** Descriptor header type constant for a HID descriptor. */
#define DTYPE_HID 0x21
/** Descriptor header type constant for a HID report descriptor */
/** Descriptor header type constant for a HID report descriptor. */
#define DTYPE_Report 0x22
/* Enums: */

2
Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h
View file

@ -43,7 +43,7 @@
#include "KeyboardHostWithParser.h"
/* Macros: */
/** HID Report Descriptor Usage Page value for a desktop keyboard */
/** HID Report Descriptor Usage Page value for a desktop keyboard. */
#define USAGE_PAGE_KEYBOARD 0x07
/* Enums: */

2
Demos/Host/LowLevel/KeyboardHostWithParser/KeyboardHostWithParser.h
View file

@ -49,7 +49,7 @@
#include "HIDReport.h"
/* Macros: */
/** Pipe number for the keyboard report data pipe */
/** Pipe number for the keyboard report data pipe. */
#define KEYBOARD_DATAPIPE 1
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */

6
Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h
View file

@ -42,13 +42,13 @@
#include "MIDIHost.h"
/* Macros: */
/** Interface Class value for the MIDI Audio class */
/** Interface Class value for the MIDI Audio class. */
#define MIDI_STREAMING_CLASS 0x01
/** Interface Class value for the MIDI Audio Streaming subclass */
/** Interface Class value for the MIDI Audio Streaming subclass. */
#define MIDI_STREAMING_SUBCLASS 0x03
/** Interface Class value for the MIDI Audio Streaming protocol */
/** Interface Class value for the MIDI Audio Streaming protocol. */
#define MIDI_STREAMING_PROTOCOL 0x00
/* Enums: */

10
Demos/Host/LowLevel/MIDIHost/MIDIHost.h
View file

@ -55,13 +55,13 @@
#include "ConfigDescriptor.h"
/* Macros: */
/** MIDI command for a note on (activation) event */
/** MIDI command for a note on (activation) event. */
#define MIDI_COMMAND_NOTE_ON 0x90
/** MIDI command for a note off (deactivation) event */
/** MIDI command for a note off (deactivation) event. */
#define MIDI_COMMAND_NOTE_OFF 0x80
/** Standard key press velocity value used for all note events, as no pressure sensor is mounted */
/** Standard key press velocity value used for all note events, as no pressure sensor is mounted. */
#define MIDI_STANDARD_VELOCITY 64
/** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
@ -71,10 +71,10 @@
*/
#define MIDI_CHANNEL(channel) (channel - 1)
/** Pipe number for the MIDI data IN pipe */
/** Pipe number for the MIDI data IN pipe. */
#define MIDI_DATAPIPE_IN 1
/** Pipe number for the MIDI data OUT pipe */
/** Pipe number for the MIDI data OUT pipe. */
#define MIDI_DATAPIPE_OUT 2
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */

6
Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h
View file

@ -42,13 +42,13 @@
#include "MassStorageHost.h"
/* Macros: */
/** Interface Class value for the Mass Storage Device class */
/** Interface Class value for the Mass Storage Device class. */
#define MASS_STORE_CLASS 0x08
/** Interface Class value for the Mass Storage Device subclass */
/** Interface Class value for the Mass Storage Device subclass. */
#define MASS_STORE_SUBCLASS 0x06
/** Interface Protocol value for the Bulk Only transport protocol */
/** Interface Protocol value for the Bulk Only transport protocol. */
#define MASS_STORE_PROTOCOL 0x50
/* Enums: */

22
Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h
View file

@ -45,34 +45,34 @@
#include <LUFA/Drivers/USB/USB.h>
/* Macros: */
/** Class specific request to reset the Mass Storage interface of the attached device */
/** Class specific request to reset the Mass Storage interface of the attached device. */
#define REQ_MassStorageReset 0xFF
/** Class specific request to retrieve the maximum Logical Unit Number (LUN) index of the attached device */
/** Class specific request to retrieve the maximum Logical Unit Number (LUN) index of the attached device. */
#define REQ_GetMaxLUN 0xFE
/** Command Block Wrapper signature byte, for verification of valid CBW blocks */
/** Command Block Wrapper signature byte, for verification of valid CBW blocks. */
#define CBW_SIGNATURE 0x43425355UL
/** Command Static Wrapper signature byte, for verification of valid CSW blocks */
/** Command Static Wrapper signature byte, for verification of valid CSW blocks. */
#define CSW_SIGNATURE 0x53425355UL
/** Data direction mask for the Flags field of a CBW, indicating Host-to-Device transfer direction */
/** Data direction mask for the Flags field of a CBW, indicating Host-to-Device transfer direction. */
#define COMMAND_DIRECTION_DATA_OUT (0 << 7)
/** Data direction mask for the Flags field of a CBW, indicating Device-to-Host transfer direction */
/** Data direction mask for the Flags field of a CBW, indicating Device-to-Host transfer direction. */
#define COMMAND_DIRECTION_DATA_IN (1 << 7)
/** Timeout period between the issuing of a CBW to a device, and the reception of the first packet */
/** Timeout period between the issuing of a CBW to a device, and the reception of the first packet. */
#define COMMAND_DATA_TIMEOUT_MS 10000
/** Pipe number of the Mass Storage data IN pipe */
/** Pipe number of the Mass Storage data IN pipe. */
#define MASS_STORE_DATA_IN_PIPE 1
/** Pipe number of the Mass Storage data OUT pipe */
/** Pipe number of the Mass Storage data OUT pipe. */
#define MASS_STORE_DATA_OUT_PIPE 2
/** Additional error code for Mass Storage functions when a device returns a logical command failure */
/** Additional error code for Mass Storage functions when a device returns a logical command failure. */
#define MASS_STORE_SCSI_COMMAND_FAILED 0xC0
/* Type defines: */
@ -175,7 +175,7 @@
} SCSI_Capacity_t;
/* Enums: */
/** CSW status return codes, indicating the overall status of the issued CBW */
/** CSW status return codes, indicating the overall status of the issued CBW. */
enum MassStorageHost_CommandStatusCodes_t
{
Command_Pass = 0, /**< Command completed successfully */

4
Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h
View file

@ -42,10 +42,10 @@
#include "MouseHost.h"
/* Macros: */
/** Interface Class value for the Human Interface Device class */
/** Interface Class value for the Human Interface Device class. */
#define MOUSE_CLASS 0x03
/** Interface Protocol value for a Boot Protocol Mouse compliant device */
/** Interface Protocol value for a Boot Protocol Mouse compliant device. */
#define MOUSE_PROTOCOL 0x02
/* Enums: */

6
Demos/Host/LowLevel/MouseHost/MouseHost.h
View file

@ -53,10 +53,10 @@
#include "ConfigDescriptor.h"
/* Macros: */
/** Pipe number for the mouse data IN pipe */
/** Pipe number for the mouse data IN pipe. */
#define MOUSE_DATAPIPE 1
/** HID Class Specific request to set the report protocol mode */
/** HID Class Specific request to set the report protocol mode. */
#define REQ_SetProtocol 0x0B
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
@ -72,7 +72,7 @@
#define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3)
/* Type Defines: */
/** Type define for a standard Boot Protocol Mouse report */
/** Type define for a standard Boot Protocol Mouse report. */
typedef struct
{
uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */

8
Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h
View file

@ -42,16 +42,16 @@
#include "HIDReport.h"
/* Macros: */
/** Interface Class value for the Human Interface Device class */
/** Interface Class value for the Human Interface Device class. */
#define MOUSE_CLASS 0x03
/** Interface Protocol value for a Boot Protocol Mouse compliant device */
/** Interface Protocol value for a Boot Protocol Mouse compliant device. */
#define MOUSE_PROTOCOL 0x02
/** Descriptor header type constant for a HID descriptor */
/** Descriptor header type constant for a HID descriptor. */
#define DTYPE_HID 0x21
/** Descriptor header type constant for a HID report descriptor */
/** Descriptor header type constant for a HID report descriptor. */
#define DTYPE_Report 0x22
/* Enums: */

12
Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h
View file

@ -43,22 +43,22 @@
#include "MouseHostWithParser.h"
/* Macros: */
/** HID Report Descriptor Usage for a Mouse */
/** HID Report Descriptor Usage for a Mouse. */
#define USAGE_MOUSE 0x02
/** HID Report Descriptor Usage Page value for a toggle button */
/** HID Report Descriptor Usage Page value for a toggle button. */
#define USAGE_PAGE_BUTTON 0x09
/** HID Report Descriptor Usage Page value for a Generic Desktop Control */
/** HID Report Descriptor Usage Page value for a Generic Desktop Control. */
#define USAGE_PAGE_GENERIC_DCTRL 0x01
/** HID Report Descriptor Usage value for a X axis movement */
/** HID Report Descriptor Usage value for a X axis movement. */
#define USAGE_X 0x30
/** HID Report Descriptor Usage value for a Y axis movement */
/** HID Report Descriptor Usage value for a Y axis movement. */
#define USAGE_Y 0x31
/** HID Report Descriptor Usage value for a Scroll Wheel movement */
/** HID Report Descriptor Usage value for a Scroll Wheel movement. */
#define USAGE_SCROLL_WHEEL 0x38
/* Enums: */

2
Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.h
View file

@ -54,7 +54,7 @@
#include "HIDReport.h"
/* Macros: */
/** Pipe number for the mouse report data pipe */
/** Pipe number for the mouse report data pipe. */
#define MOUSE_DATAPIPE 1
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */

6
Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h
View file

@ -38,13 +38,13 @@
#include "Lib/PrinterCommands.h"
/* Macros: */
/** Interface Class value for the Printer Device class */
/** Interface Class value for the Printer Device class. */
#define PRINTER_CLASS 0x07
/** Interface Subclass value for the Printer Device class */
/** Interface Subclass value for the Printer Device class. */
#define PRINTER_SUBCLASS 0x01
/** Interface Protocol value for a Bidirectional communication encapsulation */
/** Interface Protocol value for a Bidirectional communication encapsulation. */
#define PRINTER_PROTOCOL 0x02
/* Enums: */

10
Demos/Host/LowLevel/PrinterHost/Lib/PrinterCommands.h
View file

@ -43,19 +43,19 @@
#include <LUFA/Drivers/USB/USB.h>
/* Macros: */
/** Printer class-specific request to retrieve the printer's ID string */
/** Printer class-specific request to retrieve the printer's ID string. */
#define REQ_GetDeviceID 0
/** Printer class-specific request to retrieve the printer's virtual port status flags */
/** Printer class-specific request to retrieve the printer's virtual port status flags. */
#define REQ_GetPortStatus 1
/** Printer class-specific request to soft-reset the device */
/** Printer class-specific request to soft-reset the device. */
#define REQ_SoftReset 2
/** Pipe number of the Printer data IN pipe */
/** Pipe number of the Printer data IN pipe. */
#define PRINTER_DATA_IN_PIPE 1
/** Pipe number of the Printer data OUT pipe */
/** Pipe number of the Printer data OUT pipe. */
#define PRINTER_DATA_OUT_PIPE 2
/* Function Prototypes: */

12
Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h
View file

@ -42,22 +42,22 @@
#include "RNDISEthernetHost.h"
/* Macros: */
/** Interface Class value for the CDC class */
/** Interface Class value for the CDC class. */
#define CDC_CONTROL_CLASS 0x02
/** Interface Class value for the CDC Communication Interface subclass */
/** Interface Class value for the CDC Communication Interface subclass. */
#define CDC_CONTROL_SUBCLASS 0x02
/** Interface Class value for the CDC RNDIS vendor specific protocol */
/** Interface Class value for the CDC RNDIS vendor specific protocol. */
#define CDC_CONTROL_PROTOCOL 0xFF
/** Interface Class value for the CDC data class */
/** Interface Class value for the CDC data class. */
#define CDC_DATA_CLASS 0x0A
/** Interface Class value for the CDC data subclass */
/** Interface Class value for the CDC data subclass. */
#define CDC_DATA_SUBCLASS 0x00
/** Interface Class value for the CDC data protocol */
/** Interface Class value for the CDC data protocol. */
#define CDC_DATA_PROTOCOL 0x00
/* Enums: */

38
Demos/Host/LowLevel/RNDISEthernetHost/Lib/RNDISCommands.h
View file

@ -46,14 +46,14 @@
#include "RNDISConstants.h"
/* Type Defines: */
/** Type define for a RNDIS message header, sent before RNDIS messages */
/** Type define for a RNDIS message header, sent before RNDIS messages. */
typedef struct
{
uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */
uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
} RNDIS_Message_Header_t;
/** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */
/** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter. */
typedef struct
{
uint32_t MessageType;
@ -69,7 +69,7 @@
uint32_t Reserved;
} RNDIS_Packet_Message_t;
/** Type define for a RNDIS Initialize command message */
/** Type define for a RNDIS Initialize command message. */
typedef struct
{
uint32_t MessageType;
@ -81,7 +81,7 @@
uint32_t MaxTransferSize;
} RNDIS_Initialize_Message_t;
/** Type define for a RNDIS Initialize complete response message */
/** Type define for a RNDIS Initialize complete response message. */
typedef struct
{
uint32_t MessageType;
@ -100,7 +100,7 @@
uint32_t AFListSize;
} RNDIS_Initialize_Complete_t;
/** Type define for a RNDIS Keepalive command message */
/** Type define for a RNDIS Keepalive command message. */
typedef struct
{
uint32_t MessageType;
@ -108,7 +108,7 @@
uint32_t RequestId;
} RNDIS_KeepAlive_Message_t;
/** Type define for a RNDIS Keepalive complete message */
/** Type define for a RNDIS Keepalive complete message. */
typedef struct
{
uint32_t MessageType;
@ -117,7 +117,7 @@
uint32_t Status;
} RNDIS_KeepAlive_Complete_t;
/** Type define for a RNDIS Reset complete message */
/** Type define for a RNDIS Reset complete message. */
typedef struct
{
uint32_t MessageType;
@ -127,7 +127,7 @@
uint32_t AddressingReset;
} RNDIS_Reset_Complete_t;
/** Type define for a RNDIS Set command message */
/** Type define for a RNDIS Set command message. */
typedef struct
{
uint32_t MessageType;
@ -140,7 +140,7 @@
uint32_t DeviceVcHandle;
} RNDIS_Set_Message_t;
/** Type define for a RNDIS Set complete response message */
/** Type define for a RNDIS Set complete response message. */
typedef struct
{
uint32_t MessageType;
@ -149,7 +149,7 @@
uint32_t Status;
} RNDIS_Set_Complete_t;
/** Type define for a RNDIS Query command message */
/** Type define for a RNDIS Query command message. */
typedef struct
{
uint32_t MessageType;
@ -162,7 +162,7 @@
uint32_t DeviceVcHandle;
} RNDIS_Query_Message_t;
/** Type define for a RNDIS Query complete response message */
/** Type define for a RNDIS Query complete response message. */
typedef struct
{
uint32_t MessageType;
@ -175,28 +175,28 @@
} RNDIS_Query_Complete_t;
/* Macros: */
/** RNDIS request to issue a host-to-device NDIS command */
/** RNDIS request to issue a host-to-device NDIS command. */
#define REQ_SendEncapsulatedCommand 0x00
/** RNDIS request to issue a device-to-host NDIS response */
/** RNDIS request to issue a device-to-host NDIS response. */
#define REQ_GetEncapsulatedResponse 0x01
/** Implemented RNDIS Version Major */
/** Implemented RNDIS Version Major. */
#define REMOTE_NDIS_VERSION_MAJOR 0x01
/** Implemented RNDIS Version Minor */
/** Implemented RNDIS Version Minor. */
#define REMOTE_NDIS_VERSION_MINOR 0x00
/** Pipe number for the RNDIS data IN pipe */
/** Pipe number for the RNDIS data IN pipe. */
#define RNDIS_DATAPIPE_IN 1
/** Pipe number for the RNDIS data OUT pipe */
/** Pipe number for the RNDIS data OUT pipe. */
#define RNDIS_DATAPIPE_OUT 2
/** Pipe number for the RNDIS notification pipe */
/** Pipe number for the RNDIS notification pipe. */
#define RNDIS_NOTIFICATIONPIPE 3
/** Additional error code for RNDIS functions when a device returns a logical command failure */
/** Additional error code for RNDIS functions when a device returns a logical command failure. */
#define RNDIS_COMMAND_FAILED 0xC0
/* Function Prototypes: */

6
Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h
View file

@ -42,13 +42,13 @@
#include "StillImageHost.h"
/* Macros: */
/** Interface Class value for the Still Image Device class */
/** Interface Class value for the Still Image Device class. */
#define SIMAGE_CLASS 0x06
/** Interface Class value for the Still Image Device subclass */
/** Interface Class value for the Still Image Device subclass. */
#define SIMAGE_SUBCLASS 0x01
/** Interface Class value for the Still Image Device protocol */
/** Interface Class value for the Still Image Device protocol. */
#define SIMAGE_PROTOCOL 0x01
/* Enums: */

10
Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h
View file

@ -42,22 +42,22 @@
#include "PIMACodes.h"
/* Macros: */
/** Pipe number of the Still Image data IN pipe */
/** Pipe number of the Still Image data IN pipe. */
#define SIMAGE_DATA_IN_PIPE 0x01
/** Pipe number of the Still Image data OUT pipe */
/** Pipe number of the Still Image data OUT pipe. */
#define SIMAGE_DATA_OUT_PIPE 0x02
/** Pipe number of the Still Image events pipe */
/** Pipe number of the Still Image events pipe. */
#define SIMAGE_EVENTS_PIPE 0x03
/** Length in bytes of a given Unicode string's character length
/** Length in bytes of a given Unicode string's character length.
*
* \param[in] chars Total number of Unicode characters in the string
*/
#define UNICODE_STRING_LENGTH(chars) ((chars) << 1)
/** Timeout period between the issuing of a command to a device, and the reception of the first packet */
/** Timeout period between the issuing of a command to a device, and the reception of the first packet. */
#define COMMAND_DATA_TIMEOUT_MS 10000
/** Used in the DataLength field of a PIMA container, to give the total container size in bytes for

12
Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h
View file

@ -42,22 +42,22 @@
#include "VirtualSerialHost.h"
/* Macros: */
/** Interface Class value for the CDC class */
/** Interface Class value for the CDC class. */
#define CDC_CONTROL_CLASS 0x02
/** Interface Class value for the CDC Communication Interface subclass */
/** Interface Class value for the CDC Communication Interface subclass. */
#define CDC_CONTROL_SUBCLASS 0x02
/** Interface Class value for the CDC protocol */
/** Interface Class value for the CDC protocol. */
#define CDC_CONTROL_PROTOCOL 0x01
/** Interface Class value for the CDC data class */
/** Interface Class value for the CDC data class. */
#define CDC_DATA_CLASS 0x0A
/** Interface Class value for the CDC data subclass */
/** Interface Class value for the CDC data subclass. */
#define CDC_DATA_SUBCLASS 0x00
/** Interface Class value for the CDC data protocol */
/** Interface Class value for the CDC data protocol. */
#define CDC_DATA_PROTOCOL 0x00
/* Enums: */

6
Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.h
View file

@ -53,13 +53,13 @@
#include "ConfigDescriptor.h"
/* Macros: */
/** Pipe number for the CDC data IN pipe */
/** Pipe number for the CDC data IN pipe. */
#define CDC_DATAPIPE_IN 1
/** Pipe number for the CDC data OUT pipe */
/** Pipe number for the CDC data OUT pipe. */
#define CDC_DATAPIPE_OUT 2
/** Pipe number for the CDC notification pipe */
/** Pipe number for the CDC notification pipe. */
#define CDC_NOTIFICATIONPIPE 3
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */