mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-16 12:51:47 +00:00
Added new NO_DEVICE_SELF_POWER and NO_DEVICE_REMOTE_WAKEUP compile time options.
This commit is contained in:
parent
77cd3a42a7
commit
8b75659563
@ -81,7 +81,7 @@ USB_Descriptor_Configuration_t ConfigurationDescriptor =
|
|||||||
.ConfigurationNumber = 1,
|
.ConfigurationNumber = 1,
|
||||||
.ConfigurationStrIndex = NO_DESCRIPTOR,
|
.ConfigurationStrIndex = NO_DESCRIPTOR,
|
||||||
|
|
||||||
.ConfigAttributes = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
|
.ConfigAttributes = USB_CONFIG_ATTR_BUSPOWERED,
|
||||||
|
|
||||||
.MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
|
.MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
|
||||||
},
|
},
|
||||||
|
@ -127,6 +127,8 @@ LUFA_OPTS += -D FIXED_NUM_CONFIGURATIONS=1
|
|||||||
LUFA_OPTS += -D USE_RAM_DESCRIPTORS
|
LUFA_OPTS += -D USE_RAM_DESCRIPTORS
|
||||||
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
|
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
|
||||||
LUFA_OPTS += -D NO_INTERNAL_SERIAL
|
LUFA_OPTS += -D NO_INTERNAL_SERIAL
|
||||||
|
LUFA_OPTS += -D NO_DEVICE_SELF_POWER
|
||||||
|
LUFA_OPTS += -D NO_DEVICE_REMOTE_WAKEUP
|
||||||
|
|
||||||
|
|
||||||
# List C source files here. (C dependencies are automatically generated.)
|
# List C source files here. (C dependencies are automatically generated.)
|
||||||
|
@ -81,7 +81,7 @@ USB_Descriptor_Configuration_t ConfigurationDescriptor =
|
|||||||
.ConfigurationNumber = 1,
|
.ConfigurationNumber = 1,
|
||||||
.ConfigurationStrIndex = NO_DESCRIPTOR,
|
.ConfigurationStrIndex = NO_DESCRIPTOR,
|
||||||
|
|
||||||
.ConfigAttributes = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
|
.ConfigAttributes = USB_CONFIG_ATTR_BUSPOWERED,
|
||||||
|
|
||||||
.MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
|
.MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
|
||||||
},
|
},
|
||||||
|
@ -128,6 +128,8 @@ LUFA_OPTS += -D FIXED_NUM_CONFIGURATIONS=1
|
|||||||
LUFA_OPTS += -D USE_RAM_DESCRIPTORS
|
LUFA_OPTS += -D USE_RAM_DESCRIPTORS
|
||||||
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
|
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
|
||||||
LUFA_OPTS += -D NO_INTERNAL_SERIAL
|
LUFA_OPTS += -D NO_INTERNAL_SERIAL
|
||||||
|
LUFA_OPTS += -D NO_DEVICE_SELF_POWER
|
||||||
|
LUFA_OPTS += -D NO_DEVICE_REMOTE_WAKEUP
|
||||||
|
|
||||||
|
|
||||||
# List C source files here. (C dependencies are automatically generated.)
|
# List C source files here. (C dependencies are automatically generated.)
|
||||||
|
@ -101,7 +101,7 @@ USB_Descriptor_Configuration_t ConfigurationDescriptor =
|
|||||||
.ConfigurationNumber = 1,
|
.ConfigurationNumber = 1,
|
||||||
.ConfigurationStrIndex = NO_DESCRIPTOR,
|
.ConfigurationStrIndex = NO_DESCRIPTOR,
|
||||||
|
|
||||||
.ConfigAttributes = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
|
.ConfigAttributes = USB_CONFIG_ATTR_BUSPOWERED,
|
||||||
|
|
||||||
.MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
|
.MaxPowerConsumption = USB_CONFIG_POWER_MA(100)
|
||||||
},
|
},
|
||||||
|
@ -127,6 +127,8 @@ LUFA_OPTS += -D FIXED_NUM_CONFIGURATIONS=1
|
|||||||
LUFA_OPTS += -D USE_RAM_DESCRIPTORS
|
LUFA_OPTS += -D USE_RAM_DESCRIPTORS
|
||||||
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
|
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
|
||||||
LUFA_OPTS += -D NO_INTERNAL_SERIAL
|
LUFA_OPTS += -D NO_INTERNAL_SERIAL
|
||||||
|
LUFA_OPTS += -D NO_DEVICE_SELF_POWER
|
||||||
|
LUFA_OPTS += -D NO_DEVICE_REMOTE_WAKEUP
|
||||||
|
|
||||||
|
|
||||||
# List C source files here. (C dependencies are automatically generated.)
|
# List C source files here. (C dependencies are automatically generated.)
|
||||||
|
@ -119,6 +119,7 @@
|
|||||||
*/
|
*/
|
||||||
#define USB_CONFIG_ATTR_BUSPOWERED 0x80
|
#define USB_CONFIG_ATTR_BUSPOWERED 0x80
|
||||||
|
|
||||||
|
|
||||||
/** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t
|
/** Can be masked with other configuration descriptor attributes for a \ref USB_Descriptor_Configuration_Header_t
|
||||||
* descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power
|
* descriptor's ConfigAttributes value to indicate that the specified configuration can draw its power
|
||||||
* from the device's own power source.
|
* from the device's own power source.
|
||||||
|
@ -36,8 +36,14 @@
|
|||||||
#include "DevChapter9.h"
|
#include "DevChapter9.h"
|
||||||
|
|
||||||
uint8_t USB_ConfigurationNumber;
|
uint8_t USB_ConfigurationNumber;
|
||||||
bool USB_RemoteWakeupEnabled;
|
|
||||||
|
#if !defined(NO_DEVICE_SELF_POWER)
|
||||||
bool USB_CurrentlySelfPowered;
|
bool USB_CurrentlySelfPowered;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if !defined(NO_DEVICE_REMOTE_WAKEUP)
|
||||||
|
bool USB_RemoteWakeupEnabled;
|
||||||
|
#endif
|
||||||
|
|
||||||
void USB_Device_ProcessControlRequest(void)
|
void USB_Device_ProcessControlRequest(void)
|
||||||
{
|
{
|
||||||
@ -302,12 +308,16 @@ static void USB_Device_GetStatus(void)
|
|||||||
switch (USB_ControlRequest.bmRequestType)
|
switch (USB_ControlRequest.bmRequestType)
|
||||||
{
|
{
|
||||||
case (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_DEVICE):
|
case (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_DEVICE):
|
||||||
|
#if !defined(NO_DEVICE_SELF_POWER)
|
||||||
if (USB_CurrentlySelfPowered)
|
if (USB_CurrentlySelfPowered)
|
||||||
CurrentStatus |= FEATURE_SELFPOWERED_ENABLED;
|
CurrentStatus |= FEATURE_SELFPOWERED_ENABLED;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if !defined(NO_DEVICE_REMOTE_WAKEUP)
|
||||||
if (USB_RemoteWakeupEnabled)
|
if (USB_RemoteWakeupEnabled)
|
||||||
CurrentStatus |= FEATURE_REMOTE_WAKEUP_ENABLED;
|
CurrentStatus |= FEATURE_REMOTE_WAKEUP_ENABLED;
|
||||||
|
#endif
|
||||||
|
|
||||||
break;
|
break;
|
||||||
#if !defined(CONTROL_ONLY_DEVICE)
|
#if !defined(CONTROL_ONLY_DEVICE)
|
||||||
case (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_ENDPOINT):
|
case (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_ENDPOINT):
|
||||||
@ -336,10 +346,12 @@ static void USB_Device_ClearSetFeature(void)
|
|||||||
switch (USB_ControlRequest.bmRequestType & CONTROL_REQTYPE_RECIPIENT)
|
switch (USB_ControlRequest.bmRequestType & CONTROL_REQTYPE_RECIPIENT)
|
||||||
{
|
{
|
||||||
case REQREC_DEVICE:
|
case REQREC_DEVICE:
|
||||||
|
#if !defined(NO_DEVICE_REMOTE_WAKEUP)
|
||||||
if ((uint8_t)USB_ControlRequest.wValue == FEATURE_REMOTE_WAKEUP)
|
if ((uint8_t)USB_ControlRequest.wValue == FEATURE_REMOTE_WAKEUP)
|
||||||
USB_RemoteWakeupEnabled = (USB_ControlRequest.bRequest == REQ_SetFeature);
|
USB_RemoteWakeupEnabled = (USB_ControlRequest.bRequest == REQ_SetFeature);
|
||||||
else
|
else
|
||||||
return;
|
return;
|
||||||
|
#endif
|
||||||
|
|
||||||
break;
|
break;
|
||||||
#if !defined(CONTROL_ONLY_DEVICE)
|
#if !defined(CONTROL_ONLY_DEVICE)
|
||||||
|
@ -82,23 +82,32 @@
|
|||||||
*/
|
*/
|
||||||
extern uint8_t USB_ConfigurationNumber;
|
extern uint8_t USB_ConfigurationNumber;
|
||||||
|
|
||||||
/** Indicates if the host is currently allowing the device to issue remote wakeup events. If this
|
#if !defined(NO_DEVICE_REMOTE_WAKEUP)
|
||||||
* flag is cleared, the device should not issue remote wakeup events to the host.
|
/** Indicates if the host is currently allowing the device to issue remote wakeup events. If this
|
||||||
*
|
* flag is cleared, the device should not issue remote wakeup events to the host.
|
||||||
* \note This variable should be treated as read-only in the user application, and never manually
|
*
|
||||||
* changed in value.
|
* \note This variable should be treated as read-only in the user application, and never manually
|
||||||
*
|
* changed in value.
|
||||||
* \ingroup Group_Device
|
*
|
||||||
*/
|
* \note To reduce FLASH usage of the compiled applications where Remote Wakeup is not supported,
|
||||||
extern bool USB_RemoteWakeupEnabled;
|
* this global and the underlying management code can be disabled by defining the
|
||||||
|
* NO_DEVICE_REMOTE_WAKEUP token in the project makefile and passing it to the compiler via
|
||||||
|
* the -D switch.
|
||||||
|
*
|
||||||
|
* \ingroup Group_Device
|
||||||
|
*/
|
||||||
|
extern bool USB_RemoteWakeupEnabled;
|
||||||
|
#endif
|
||||||
|
|
||||||
/** Indicates if the device is currently being powered by its own power supply, rather than being
|
#if !defined(NO_DEVICE_SELF_POWER)
|
||||||
* powered by the host's USB supply. This flag should remain cleared if the device does not
|
/** Indicates if the device is currently being powered by its own power supply, rather than being
|
||||||
* support self powered mode, as indicated in the device descriptors.
|
* powered by the host's USB supply. This flag should remain cleared if the device does not
|
||||||
*
|
* support self powered mode, as indicated in the device descriptors.
|
||||||
* \ingroup Group_Device
|
*
|
||||||
*/
|
* \ingroup Group_Device
|
||||||
extern bool USB_CurrentlySelfPowered;
|
*/
|
||||||
|
extern bool USB_CurrentlySelfPowered;
|
||||||
|
#endif
|
||||||
|
|
||||||
/* Private Interface - For use in library only: */
|
/* Private Interface - For use in library only: */
|
||||||
#if !defined(__DOXYGEN__)
|
#if !defined(__DOXYGEN__)
|
||||||
|
@ -83,7 +83,8 @@
|
|||||||
* \note This macro should only be used if the device has indicated to the host that it
|
* \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, and should only be
|
* supports the Remote Wakeup feature in the device descriptors, and should only be
|
||||||
* issued if the host is currently allowing remote wakeup events from the device (i.e.,
|
* issued if the host is currently allowing remote wakeup events from the device (i.e.,
|
||||||
* the \ref USB_RemoteWakeupEnabled flag is set).
|
* the \ref USB_RemoteWakeupEnabled flag is set). When the NO_DEVICE_REMOTE_WAKEUP compile
|
||||||
|
* time option is used, this macro is unavailable.
|
||||||
*
|
*
|
||||||
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
|
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
|
||||||
*/
|
*/
|
||||||
@ -96,7 +97,8 @@
|
|||||||
* a sent RMWAKEUP request was accepted or rejected by the host.
|
* a sent RMWAKEUP request was accepted or rejected by the host.
|
||||||
*
|
*
|
||||||
* \note This macro should only be used if the device has indicated to the host that it
|
* \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.
|
* supports the Remote Wakeup feature in the device descriptors. When the NO_DEVICE_REMOTE_WAKEUP
|
||||||
|
* compile time option is used, this macro is unavailable.
|
||||||
*
|
*
|
||||||
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
|
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
|
||||||
*
|
*
|
||||||
@ -123,10 +125,12 @@
|
|||||||
*/
|
*/
|
||||||
static inline bool USB_Device_DisableSOFEvents(void);
|
static inline bool USB_Device_DisableSOFEvents(void);
|
||||||
#else
|
#else
|
||||||
#define USB_Device_SendRemoteWakeup() MACROS{ UDCON |= (1 << RMWKUP); }MACROE
|
#if !defined(NO_DEVICE_REMOTE_WAKEUP)
|
||||||
|
#define USB_Device_SendRemoteWakeup() MACROS{ UDCON |= (1 << RMWKUP); }MACROE
|
||||||
#define USB_Device_IsRemoteWakeupSent() ((UDCON & (1 << RMWKUP)) ? false : true)
|
|
||||||
|
|
||||||
|
#define USB_Device_IsRemoteWakeupSent() ((UDCON & (1 << RMWKUP)) ? false : true)
|
||||||
|
#endif
|
||||||
|
|
||||||
#define USB_Device_IsUSBSuspended() ((UDINT & (1 << SUSPI)) ? true : false)
|
#define USB_Device_IsUSBSuspended() ((UDINT & (1 << SUSPI)) ? true : false)
|
||||||
|
|
||||||
#define USB_Device_EnableSOFEvents() MACROS{ USB_INT_Enable(USB_INT_SOFI); }MACROE
|
#define USB_Device_EnableSOFEvents() MACROS{ USB_INT_Enable(USB_INT_SOFI); }MACROE
|
||||||
|
@ -142,8 +142,14 @@ void USB_ResetInterface(void)
|
|||||||
#if defined(USB_CAN_BE_DEVICE)
|
#if defined(USB_CAN_BE_DEVICE)
|
||||||
USB_DeviceState = DEVICE_STATE_Unattached;
|
USB_DeviceState = DEVICE_STATE_Unattached;
|
||||||
USB_ConfigurationNumber = 0;
|
USB_ConfigurationNumber = 0;
|
||||||
USB_RemoteWakeupEnabled = false;
|
|
||||||
USB_CurrentlySelfPowered = false;
|
#if !defined(NO_DEVICE_REMOTE_WAKEUP)
|
||||||
|
USB_RemoteWakeupEnabled = false;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if !defined(NO_DEVICE_SELF_POWER)
|
||||||
|
USB_CurrentlySelfPowered = false;
|
||||||
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
if (!(USB_Options & USB_OPT_MANUAL_PLL))
|
if (!(USB_Options & USB_OPT_MANUAL_PLL))
|
||||||
|
@ -21,13 +21,16 @@ uint8_t TEMPLATE_FUNC_NAME (const void* Buffer, uint16_t Length)
|
|||||||
|
|
||||||
if (Endpoint_IsINReady())
|
if (Endpoint_IsINReady())
|
||||||
{
|
{
|
||||||
while (Length && (Endpoint_BytesInEndpoint() < USB_ControlEndpointSize))
|
uint16_t BytesInEndpoint = Endpoint_BytesInEndpoint();
|
||||||
|
|
||||||
|
while (Length && (BytesInEndpoint < USB_ControlEndpointSize))
|
||||||
{
|
{
|
||||||
TEMPLATE_TRANSFER_BYTE(DataStream);
|
TEMPLATE_TRANSFER_BYTE(DataStream);
|
||||||
Length--;
|
Length--;
|
||||||
|
BytesInEndpoint++;
|
||||||
}
|
}
|
||||||
|
|
||||||
LastPacketFull = (Endpoint_BytesInEndpoint() == USB_ControlEndpointSize);
|
LastPacketFull = (BytesInEndpoint == USB_ControlEndpointSize);
|
||||||
Endpoint_ClearIN();
|
Endpoint_ClearIN();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -25,6 +25,7 @@
|
|||||||
* - Added new EVK527 board target
|
* - Added new EVK527 board target
|
||||||
* - Added new USB_Host_GetDeviceStringDescriptor() convenience function
|
* - Added new USB_Host_GetDeviceStringDescriptor() convenience function
|
||||||
* - Added new LEDNotification project to the library, to give a visual LED notification on new events from the host
|
* - Added new LEDNotification project to the library, to give a visual LED notification on new events from the host
|
||||||
|
* - Added new NO_DEVICE_REMOTE_WAKEUP and NO_DEVICE_SELF_POWER compile time options
|
||||||
*
|
*
|
||||||
* <b>Changed:</b>
|
* <b>Changed:</b>
|
||||||
* - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of keycodes
|
* - Removed code in the Keyboard demos to send zeroed reports between two reports with differing numbers of keycodes
|
||||||
|
@ -68,9 +68,57 @@
|
|||||||
* the HID.h file documentation.
|
* the HID.h file documentation.
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
* \section Sec_SummaryUSBTokens USB Driver Related Tokens
|
* \section Sec_SummaryUSBTokens General USB Driver Related Tokens
|
||||||
* This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.
|
* This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.
|
||||||
*
|
*
|
||||||
|
* <b>NO_STREAM_CALLBACKS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n
|
||||||
|
* Both the endpoint and the pipe driver code contains stream functions, allowing for arrays of data to be sent to or from the
|
||||||
|
* host easily via a single function call (rather than complex routines worrying about sending full packets, waiting for the endpoint/
|
||||||
|
* pipe to become ready, etc.). By default, these stream functions require a callback function which is executed after each byte processed,
|
||||||
|
* allowing for early-aborts of stream transfers by the application. If callbacks are not required in an application, they can be removed
|
||||||
|
* by defining this token, reducing the compiled binary size. When removed, the stream functions no longer accept a callback function as
|
||||||
|
* a parameter.
|
||||||
|
*
|
||||||
|
* <b>FAST_STREAM_TRANSFERS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n
|
||||||
|
* By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full
|
||||||
|
* or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However,
|
||||||
|
* this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is
|
||||||
|
* used, bytes are sent or recevied in groups of 8 bytes at a time increasing performance at the expense of a larger flash memory consumption
|
||||||
|
* due to the extra code required to deal with byte alignment.
|
||||||
|
*
|
||||||
|
* <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
|
||||||
|
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
|
||||||
|
* voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options
|
||||||
|
* mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing
|
||||||
|
* the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an
|
||||||
|
* Options parameter.
|
||||||
|
*
|
||||||
|
* <b>USB_DEVICE_ONLY</b> - ( \ref Group_USBManagement ) \n
|
||||||
|
* For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the
|
||||||
|
* mode the library should be initialized to. If only device mode is required, the code for USB host mode can be removed from the binary to
|
||||||
|
* save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevant on smaller USB AVRs which
|
||||||
|
* do not support host mode.
|
||||||
|
*
|
||||||
|
* <b>USB_HOST_ONLY</b> - ( \ref Group_USBManagement ) \n
|
||||||
|
* Same as USB_DEVICE_ONLY, except the library is fixed to USB host mode rather than USB device mode. Not available on some USB AVR models.
|
||||||
|
*
|
||||||
|
* <b>USB_STREAM_TIMEOUT_MS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
|
||||||
|
* When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host
|
||||||
|
* must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero 16-bit value to set the timeout
|
||||||
|
* period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead.
|
||||||
|
*
|
||||||
|
* <b>NO_LIMITED_CONTROLLER_CONNECT</b> - ( \ref Group_Events ) \n
|
||||||
|
* On the smaller USB AVRs, the USB controller lacks VBUS events to determine the physical connection state of the USB bus to a host. In lieu of
|
||||||
|
* VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be
|
||||||
|
* slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is
|
||||||
|
* required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_DeviceState global
|
||||||
|
* can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro.
|
||||||
|
* When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens
|
||||||
|
* This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode.
|
||||||
|
*
|
||||||
* <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
|
* <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
|
||||||
* Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one
|
* Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one
|
||||||
* of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime.
|
* of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime.
|
||||||
@ -101,13 +149,6 @@
|
|||||||
* reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
|
* reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
|
||||||
* implicitly via the library APIs.
|
* implicitly via the library APIs.
|
||||||
*
|
*
|
||||||
* <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n
|
|
||||||
* One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of
|
|
||||||
* the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
|
|
||||||
* may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR
|
|
||||||
* reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
|
|
||||||
* implicitly via the library APIs.
|
|
||||||
*
|
|
||||||
* <b>FIXED_NUM_CONFIGURATIONS</b>=<i>x</i> - ( \ref Group_Device ) \n
|
* <b>FIXED_NUM_CONFIGURATIONS</b>=<i>x</i> - ( \ref Group_Device ) \n
|
||||||
* By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces
|
* By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces
|
||||||
* the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in
|
* the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in
|
||||||
@ -119,20 +160,31 @@
|
|||||||
* is through control endpoint requests. Defining this token will remove several features related to the selection and control of device
|
* is through control endpoint requests. Defining this token will remove several features related to the selection and control of device
|
||||||
* endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.
|
* endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.
|
||||||
*
|
*
|
||||||
* <b>NO_STREAM_CALLBACKS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n
|
* <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n
|
||||||
* Both the endpoint and the pipe driver code contains stream functions, allowing for arrays of data to be sent to or from the
|
* Some applications prefer to not call the USB_USBTask() management task reguarly while in device mode, as it can complicate code significantly.
|
||||||
* host easily via a single function call (rather than complex routines worrying about sending full packets, waiting for the endpoint/
|
* Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control
|
||||||
* pipe to become ready, etc.). By default, these stream functions require a callback function which is executed after each byte processed,
|
* endpoint entirely via USB controller interrupts asynchronously to the user application.
|
||||||
* allowing for early-aborts of stream transfers by the application. If callbacks are not required in an application, they can be removed
|
|
||||||
* by defining this token, reducing the compiled binary size. When removed, the stream functions no longer accept a callback function as
|
|
||||||
* a parameter.
|
|
||||||
*
|
*
|
||||||
* <b>FAST_STREAM_TRANSFERS</b> - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n
|
* <b>NO_DEVICE_REMOTE_WAKEUP</b> - (\ref Group_Device ) \n
|
||||||
* By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full
|
* Many devices do not require the use of the Remote Wakeup features of USB, used to wake up the USB host when suspended. On these devices,
|
||||||
* or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However,
|
* the code required to manage device Remote Wakeup can be disabled by defining this token and passing it to the library via the -D switch.
|
||||||
* this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is
|
*
|
||||||
* used, bytes are sent or recevied in groups of 8 bytes at a time increasing performance at the expense of a larger flash memory consumption
|
* <b>NO_DEVICE_SELF_POWER</b> - (\ref Group_Device ) \n
|
||||||
* due to the extra code required to deal with byte alignment.
|
* USB devices may be bus powered, self powered, or a combination of both. When a device can be both bus powered and self powered, the host may
|
||||||
|
* query the device to determine the current power source, via \ref USB_CurrentlySelfPowered. For solely bus powered devices, this global and the
|
||||||
|
* code required to manage it may be disabled by passing this token to the library via the -D switch.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* \section Sec_SummaryUSBHostTokens USB Host Mode Driver Related Tokens
|
||||||
|
*
|
||||||
|
* This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode.
|
||||||
|
*
|
||||||
|
* <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n
|
||||||
|
* One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of
|
||||||
|
* the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
|
||||||
|
* may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR
|
||||||
|
* reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
|
||||||
|
* implicitly via the library APIs.
|
||||||
*
|
*
|
||||||
* <b>USB_HOST_TIMEOUT_MS</b>=<i>x</i> - ( \ref Group_Host ) \n
|
* <b>USB_HOST_TIMEOUT_MS</b>=<i>x</i> - ( \ref Group_Host ) \n
|
||||||
* When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached
|
* When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached
|
||||||
@ -144,38 +196,4 @@
|
|||||||
* they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled
|
* they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled
|
||||||
* back to a known idle state before communications occur with the device. This token may be defined to a 16-bit value to set the device
|
* back to a known idle state before communications occur with the device. This token may be defined to a 16-bit value to set the device
|
||||||
* settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
|
* settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead.
|
||||||
*
|
|
||||||
* <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
|
|
||||||
* By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad
|
|
||||||
* voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options
|
|
||||||
* mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing
|
|
||||||
* the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an
|
|
||||||
* Options parameter.
|
|
||||||
*
|
|
||||||
* <b>USB_DEVICE_ONLY</b> - ( \ref Group_USBManagement ) \n
|
|
||||||
* For the USB AVR models supporting both device and host USB modes, the USB_Init() function contains a Mode parameter which specifies the
|
|
||||||
* mode the library should be initialized to. If only device mode is required, the code for USB host mode can be removed from the binary to
|
|
||||||
* save space. When defined, the USB_Init() function no longer accepts a Mode parameter. This define is irrelevant on smaller USB AVRs which
|
|
||||||
* do not support host mode.
|
|
||||||
*
|
|
||||||
* <b>USB_HOST_ONLY</b> - ( \ref Group_USBManagement ) \n
|
|
||||||
* Same as USB_DEVICE_ONLY, except the library is fixed to USB host mode rather than USB device mode. Not available on some USB AVR models.
|
|
||||||
*
|
|
||||||
* <b>USB_STREAM_TIMEOUT_MS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
|
|
||||||
* When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host
|
|
||||||
* must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero 16-bit value to set the timeout
|
|
||||||
* period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead.
|
|
||||||
*
|
|
||||||
* <b>NO_LIMITED_CONTROLLER_CONNECT</b> - ( \ref Group_Events ) \n
|
|
||||||
* On the smaller USB AVRs, the USB controller lacks VBUS events to determine the physical connection state of the USB bus to a host. In lieu of
|
|
||||||
* VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be
|
|
||||||
* slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is
|
|
||||||
* required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_DeviceState global
|
|
||||||
* can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro.
|
|
||||||
* When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
|
|
||||||
*
|
|
||||||
* <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n
|
|
||||||
* Some applications prefer to not call the USB_USBTask() management task reguarly while in device mode, as it can complicate code significantly.
|
|
||||||
* Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control
|
|
||||||
* endpoint entirely via USB controller interrupts asynchronously to the user application.
|
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user