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

Changed PIPE_CONTROLPIPE_DEFAULT_SIZE from 8 to 64 to try to prevent problems with faulty devices which do not respect the given wLength value when reading in the device descriptor.

Browse source 
Further documentation improvements - removed file view from the main library documentation, replaced file references in the documentation with group references.
This commit is contained in:
Dean Camera 2009-05-04 12:55:00 +00:00
parent edcfaf7716
commit 253deb996f
60 changed files with 127 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

2
LUFA/Drivers/USB/Class/ConfigDescriptor.h
View file

@ -96,7 +96,7 @@
/** Returns the descriptor's type, expressed as the 8-bit type value in the header of the descriptor.
* This value's meaning depends on the descriptor's placement in the descriptor, but standard type
* values can be accessed in the DescriptorTypes_t enum located in USB/HighLevel/StdDescriptors.h.
* values can be accessed in the \ref USB_DescriptorTypes_t enum.
*/
#if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)
#define DESCRIPTOR_TYPE(DescriptorPtr) DESCRIPTOR_CAST(DescriptorPtr, USB_Descriptor_Header_t).Type

26
LUFA/Drivers/USB/HighLevel/Events.h
View file

@ -219,7 +219,7 @@
* \note This event only exists on USB AVR models which support dual role modes.
*
* \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied
* to the compiler (see LowLevel.h documentation).
* to the compiler (see \ref Group_USBManagement documentation).
*/
void USB_UIDChange(void);
@ -232,7 +232,7 @@
* \note This event only exists on USB AVR models which supports host mode.
*
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*/
void USB_HostError(const uint8_t ErrorCode);
@ -244,9 +244,9 @@
* \note This event only exists on USB AVR models which supports host mode.
*
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*
* \see USBTask.h for more information on the USB management task and reducing CPU usage.
* \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.
*/
void USB_DeviceAttached(void);
@ -257,9 +257,9 @@
* \note This event only exists on USB AVR models which supports host mode.
*
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*
* \see USBTask.h for more information on the USB management task and reducing CPU usage.
* \see \ref TASK(USB_USBTask) for more information on the USB management task and reducing CPU usage.
*/
void USB_DeviceUnattached(void);
@ -276,7 +276,7 @@
* \note This event only exists on USB AVR models which supports host mode.
*
* \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*/
void USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
@ -294,7 +294,7 @@
* on control transfers, interrupts are disabled during control request processing.
*
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*
* \note Requests should be handled in the same manner as described in the USB 2.0 Specification,
* or appropriate class specification. In all instances, the library has already read the
@ -310,7 +310,7 @@
* This event fires after the value of \ref USB_ConfigurationNumber has been changed.
*
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*/
void USB_ConfigurationChanged(void);
@ -319,7 +319,7 @@
* the device over to a low power state until the host wakes up the device.
*
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*
* \see \ref USB_WakeUp() event for accompanying Wake Up event.
*/
@ -331,7 +331,7 @@
* mode.
*
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*
* \see \ref USB_Suspend() event for accompanying Suspend event.
*/
@ -344,7 +344,7 @@
* disabled.
*
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*/
void USB_Reset(void);
@ -355,7 +355,7 @@
* \ref USB_Device_ErrorCodes_t enum located in Device.h.
*
* \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
* LowLevel.h documentation).
* \ref Group_USBManagement documentation).
*/
void USB_DeviceError(const uint8_t ErrorCode);
#endif

55
LUFA/Drivers/USB/HighLevel/StdDescriptors.h
View file

@ -76,12 +76,12 @@
#define NO_DESCRIPTOR 0
/** Macro to calculate the power value for the device descriptor, from a given number of milliamps. */
#define USB_CONFIG_POWER_MA(x) (x >> 1)
#define USB_CONFIG_POWER_MA(mA) (mA >> 1)
/** Macro to calculate the Unicode length of a string with a given number of Unicode characters.
* Should be used in string descriptor's headers for giving the string descriptor's byte length.
*/
#define USB_STRING_LEN(x) (sizeof(USB_Descriptor_Header_t) + (x << 1))
#define USB_STRING_LEN(str) (sizeof(USB_Descriptor_Header_t) + (str << 1))
/** Macro to encode a given four digit floating point version number (e.g. 01.23) into Binary Coded
* Decimal format for descriptor fields requiring BCD encoding, such as the USB version number in the
@ -183,7 +183,7 @@
/** This module raises the Device Error event while in device mode, if the \ref USB_GetDescriptor()
* routine is not hooked in the user application to properly return descriptors to the library.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_DeviceError);
#endif
@ -206,10 +206,9 @@
/* Type Defines: */
/** Type define for all descriptor's header, indicating the descriptor's length and type.
*
* \note The non-standard structure element names are documented here - see the StdDescriptors.h file
* documentation for more information on the two descriptor naming schemes. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names
* identical to those listed in the USB standard.
* \note The non-standard structure element names are documented here. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements
* with names identical to those listed in the USB standard.
*/
typedef struct
{
@ -226,10 +225,9 @@
/** Type define for a standard device descriptor.
*
* \note The non-standard structure element names are documented here - see the StdDescriptors.h file
* documentation for more information on the two descriptor naming schemes. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names
* identical to those listed in the USB standard.
* \note The non-standard structure element names are documented here. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements
* with names identical to those listed in the USB standard.
*/
typedef struct
{
@ -286,10 +284,9 @@
/** Type define for a standard configuration descriptor.
*
* \note The non-standard structure element names are documented here - see the StdDescriptors.h file
* documentation for more information on the two descriptor naming schemes. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names
* identical to those listed in the USB standard.
* \note The non-standard structure element names are documented here. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements
* with names identical to those listed in the USB standard.
*/
typedef struct
{
@ -326,10 +323,9 @@
/** Type define for a standard interface descriptor.
*
* \note The non-standard structure element names are documented here - see the StdDescriptors.h file
* documentation for more information on the two descriptor naming schemes. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names
* identical to those listed in the USB standard.
* \note The non-standard structure element names are documented here. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements
* with names identical to those listed in the USB standard.
*/
typedef struct
{
@ -372,10 +368,9 @@
* together at the point of enumeration, loading one generic driver for all the interfaces in the single
* function. Read the ECN for more information.
*
* \note The non-standard structure element names are documented here - see the StdDescriptors.h file
* documentation for more information on the two descriptor naming schemes. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names
* identical to those listed in the USB standard.
* \note The non-standard structure element names are documented here. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements
* with names identical to those listed in the USB standard.
*/
typedef struct
{
@ -406,10 +401,9 @@
/** Type define for a standard endpoint descriptor.
*
* \note The non-standard structure element names are documented here - see the StdDescriptors.h file
* documentation for more information on the two descriptor naming schemes. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names
* identical to those listed in the USB standard.
* \note The non-standard structure element names are documented here. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements
* with names identical to those listed in the USB standard.
*/
typedef struct
{
@ -448,10 +442,9 @@
* This structure should also be used for string index 0, which contains the supported language IDs for
* the device as an array.
*
* \note The non-standard structure element names are documented here - see the StdDescriptors.h file
* documentation for more information on the two descriptor naming schemes. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements with names
* identical to those listed in the USB standard.
* \note The non-standard structure element names are documented here. If the
* USE_NONSTANDARD_DESCRIPTOR_NAMES token is not set, this structure contains elements
* with names identical to those listed in the USB standard.
*/
typedef struct
{

18
LUFA/Drivers/USB/HighLevel/USBInterrupt.h
View file

@ -118,7 +118,7 @@
*
* \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_VBUSChange);
@ -126,7 +126,7 @@
*
* \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_VBUSConnect);
@ -134,7 +134,7 @@
*
* \note Not all USB AVR models support VBUS interrupts; this event only exists on supported AVRs.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_VBUSDisconnect);
#endif
@ -143,21 +143,21 @@
/** This module raises the Suspended event when the host suspends the USB interface of the AVR
* whilst running in device mode.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_Suspend);
/** This module raises the Wake Up event when the host resumes the USB interface of the AVR
* whilst running in device mode.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_WakeUp);
/** This module raises the USB Reset event when the host resets the USB interface of the AVR
* whilst running in device mode.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_Reset);
#endif
@ -168,7 +168,7 @@
*
* \note Not all USB AVR models support host mode; this event only exists on supported AVRs.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_HostError);
@ -177,7 +177,7 @@
*
* \note Not all USB AVR models support host mode; this event only exists on supported AVRs.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_DeviceUnattached);
#endif
@ -188,7 +188,7 @@
* \note Not all USB AVR models support host mode and thus the UID pin; this event only exists on
* supported AVRs.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_UIDChange);
#endif

4
LUFA/Drivers/USB/HighLevel/USBTask.c
View file

@ -157,7 +157,7 @@ static void USB_HostTask(void)
break;
case HOST_STATE_Powered:
Pipe_ConfigurePipe(PIPE_CONTROLPIPE, EP_TYPE_CONTROL,
PIPE_TOKEN_SETUP, PIPE_CONTROLPIPE,
PIPE_TOKEN_SETUP, ENDPOINT_CONTROLEP,
PIPE_CONTROLPIPE_DEFAULT_SIZE, PIPE_BANK_SINGLE);
if (!(Pipe_IsConfigured()))
@ -203,7 +203,7 @@ static void USB_HostTask(void)
Pipe_ResetPipe(PIPE_CONTROLPIPE);
Pipe_ConfigurePipe(PIPE_CONTROLPIPE, EP_TYPE_CONTROL,
PIPE_TOKEN_SETUP, PIPE_CONTROLPIPE,
PIPE_TOKEN_SETUP, ENDPOINT_CONTROLEP,
USB_ControlPipeSize, PIPE_BANK_SINGLE);
if (!(Pipe_IsConfigured()))

14
LUFA/Drivers/USB/HighLevel/USBTask.h
View file

@ -127,28 +127,28 @@
/** This module raises the \ref USB_Connect event when a USB device has been connected whilst in host
* mode, but not yet enumerated.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_Connect);
/** This module raises the \ref USB_DeviceAttached event when in host mode, and a device is attached
* to the AVR's USB interface.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_DeviceAttached);
/** This module raises the \ref USB_DeviceUnattached event when in host mode, and a device is removed
* from the AVR's USB interface.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_DeviceUnattached);
/** This module raises the \ref USB_DeviceEnumerationFailed event when in host mode, and an
* attached USB device has failed to successfully enumerated.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_DeviceEnumerationFailed);
@ -156,14 +156,14 @@
* attached USB device has been successfully enumerated and ready to be used by the user
* application.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_DeviceEnumerationComplete);
/** This module raises the \ref USB_Disconnect event when an attached USB device is removed from the USB
* bus.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_Disconnect);
#endif
@ -183,7 +183,7 @@
* - In host mode, it may be disabled at start-up, enabled on the firing of the \ref USB_DeviceAttached
* event and disabled again on the firing of the \ref USB_DeviceUnattached event.
*
* \see Events.h for more information on the USB events.
* \see \ref Group_Events for more information on the USB events.
*
* \ingroup Group_USBManagement
*/

6
LUFA/Drivers/USB/LowLevel/DevChapter9.h
View file

@ -86,14 +86,14 @@
/** This module raises the \ref USB_UnhandledControlPacket event when a request to the default control
* endpoint has been received, but the library does not implement an internal handler for it.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_UnhandledControlPacket);
/** This module raises the \ref USB_ConfigurationChanged event when the host issues a \ref REQ_SetConfiguration
* device request, to change the currently selected configuration number.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_ConfigurationChanged);
@ -101,7 +101,7 @@
* enumeration of the device (i.e. when a \ref REQ_SetConfiguration request changes the current configuration
* number from 0 to a non-zero value).
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
RAISES_EVENT(USB_DeviceEnumerationComplete);

6
LUFA/Drivers/USB/LowLevel/Device.h
View file

@ -80,7 +80,7 @@
* issued if the host is currently allowing remote wakeup events from the device (i.e.,
* the \ref USB_RemoteWakeupEnabled flag is set).
*
* \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
*/
static inline void USB_Device_SendRemoteWakeup(void);
@ -93,7 +93,7 @@
* \note This macro should only be used if the device has indicated to the host that it
* supports the Remote Wakeup feature in the device descriptors.
*
* \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
*
* \return Boolean true if no Remote Wakeup request is currently being sent, false otherwise
*/
@ -124,7 +124,7 @@
DEVICE_ERROR_GetDescriptorNotHooked = 0, /**< Indicates that the \ref USB_GetDescriptor() method
* has not been hooked by the user application.
*
* \see StdDescriptors.h for more information on
* \see \ref Group_Descriptors for more information on
* the \ref USB_GetDescriptor() method.
*/
};

7
LUFA/Drivers/USB/LowLevel/Host.h
View file

@ -179,8 +179,7 @@
*
* For information on each state, refer to the USB 2.0 specification. Some states have
*
* \see USBTask.h for information on the global variable USB_HostState, which stores the
* current host state machine state.
* \see \ref USB_HostState, which stores the current host state machine state.
*/
enum USB_Host_States_t
{
@ -202,7 +201,7 @@
/** Enum for the error codes for the \ref USB_HostError event.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
enum USB_Host_ErrorCodes_t
{
@ -216,7 +215,7 @@
/** Enum for the error codes for the \ref USB_DeviceEnumerationFailed event.
*
* \see Events.h for more information on this event.
* \see \ref Group_Events for more information on this event.
*/
enum USB_Host_EnumerationErrorCodes_t
{

12
LUFA/Drivers/USB/LowLevel/LowLevel.h
View file

@ -118,7 +118,7 @@
*
* \note This token is not available on AVR models which do not support host mode.
*/
#define USB_MODE_HOST 2
#define USB_MODE_HOST 2
#endif
#if defined(USB_CAN_BE_BOTH) || defined(__DOXYGEN__)
@ -159,25 +159,25 @@
/** Mask for a CONTROL type endpoint or pipe.
*
* \note See Endpoint.h and Pipe.h headers for endpoint/pipe functions.
* \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
*/
#define EP_TYPE_CONTROL 0x00
/** Mask for an ISOCHRONOUS type endpoint or pipe.
*
* \note See Endpoint.h and Pipe.h headers for endpoint/pipe functions.
* \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
*/
#define EP_TYPE_ISOCHRONOUS 0x01
/** Mask for a BULK type endpoint or pipe.
*
* \note See Endpoint.h and Pipe.h headers for endpoint/pipe functions.
* \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
*/
#define EP_TYPE_BULK 0x02
/** Mask for an INTERRUPT type endpoint or pipe.
*
* \note See Endpoint.h and Pipe.h headers for endpoint/pipe functions.
* \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
*/
#define EP_TYPE_INTERRUPT 0x03
@ -304,13 +304,13 @@
#endif
#if !defined(USE_STATIC_OPTIONS) || defined(__DOXYGEN__)
extern volatile uint8_t USB_Options;
/** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
* was called. This value will be one of the USB_MODE_* masks defined elsewhere in this module.
*
* \note This variable should be treated as read-only in the user application, and never manually
* changed in value.
*/
extern volatile uint8_t USB_Options;
#endif
/* Throwable Events: */

6
LUFA/Drivers/USB/LowLevel/Pipe.h
View file

@ -128,7 +128,7 @@
/** Default size of the default control pipe's bank, until altered by the Endpoint0Size value
* in the device descriptor of the attached device.
*/
#define PIPE_CONTROLPIPE_DEFAULT_SIZE 8
#define PIPE_CONTROLPIPE_DEFAULT_SIZE 64
/** Pipe number mask, for masking against pipe addresses to retrieve the pipe's numerical address
* in the device.
@ -955,6 +955,10 @@
/* Macros: */
#define PIPE_TOKEN_MASK (0x03 << PTOKEN0)
#if !defined(ENDPOINT_CONTROLEP)
#define ENDPOINT_CONTROLEP 0
#endif
#define Pipe_AllocateMemory() MACROS{ UPCFG1X |= (1 << ALLOC); }MACROE
#define Pipe_DeallocateMemory() MACROS{ UPCFG1X &= ~(1 << ALLOC); }MACROE