X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/6a10d6b465be27db090d760dc0fbe722c94e4344..a96d77eca77c84777de7ff289a5144fb0db94517:/LUFA/Drivers/USB/LowLevel/DevChapter9.h diff --git a/LUFA/Drivers/USB/LowLevel/DevChapter9.h b/LUFA/Drivers/USB/LowLevel/DevChapter9.h index 5e1772a53..3d49062ba 100644 --- a/LUFA/Drivers/USB/LowLevel/DevChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/DevChapter9.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, provided that the above copyright notice appear in all - copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that the copyright notice and this + permission notice and warranty disclaimer appear in supporting + documentation, and that the name of the author not be used in + advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -28,14 +28,6 @@ this software. */ -/** \file - * - * Module for device mode request processing. This module allows for the processing of standard control - * requests to the default control endpoint while in device mode. - * - * \see Chapter 9 of the USB 2.0 specification. - */ - #ifndef __DEVCHAPTER9_H__ #define __DEVCHAPTER9_H__ @@ -43,11 +35,13 @@ #include #include #include + #include #include "../HighLevel/StdDescriptors.h" #include "../HighLevel/Events.h" + #include "../HighLevel/StdRequestType.h" + #include "../HighLevel/USBTask.h" #include "LowLevel.h" - #include "StdRequestType.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) @@ -55,75 +49,93 @@ #endif /* Public Interface - May be used in end-application: */ + /* Macros: */ + #if defined(USE_SINGLE_DEVICE_CONFIGURATION) + #define FIXED_NUM_CONFIGURATIONS 1 + #endif + + /* Enums: */ + #if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS) + /** Enum for the possible descriptor memory spaces, for the MemoryAddressSpace of the + * \ref CALLBACK_USB_GetDescriptor() function. This can be used when none of the USE_*_DESCRIPTORS + * compile time options are used, to indicate in which memory space the descriptor is stored. + * + * \ingroup Group_Device + */ + enum USB_DescriptorMemorySpaces_t + { + MEMSPACE_FLASH = 0, /**< Indicates the requested descriptor is located in FLASH memory */ + MEMSPACE_EEPROM = 1, /**< Indicates the requested descriptor is located in EEPROM memory */ + MEMSPACE_RAM = 2, /**< Indicates the requested descriptor is located in RAM memory */ + }; + #endif + /* Global Variables: */ /** Indicates the currently set configuration number of the device. USB devices may have several * different configurations which the host can select between; this indicates the currently selected * value, or 0 if no configuration has been selected. * - * If a device has only one single configuration, the token USE_SINGLE_DEVICE_CONFIGURATION may be - * defined in the project makefile and passed to the compiler using the -D switch. This optimize for - * a single configuration, saving a small amount of space in the resulting compiled binary. - * * \note This variable should be treated as read-only in the user application, and never manually * changed in value. + * + * \ingroup Group_Device */ extern uint8_t USB_ConfigurationNumber; - /** 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. - */ - extern bool USB_RemoteWakeupEnabled; + #if !defined(NO_DEVICE_REMOTE_WAKEUP) + /** 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 To reduce FLASH usage of the compiled applications where Remote Wakeup is not supported, + * 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 - * 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. - */ - extern bool USB_CurrentlySelfPowered; - - /* Throwable Events: */ - /** This module raises the 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. - */ - RAISES_EVENT(USB_UnhandledControlPacket); - - /** This module raises the USB_ConfigurationChanged event when the host issues a REQ_SetConfiguration - * device request, to change the currently selected configuration number. - * - * \see Events.h for more information on this event. - */ - RAISES_EVENT(USB_ConfigurationChanged); - - /** This module raises the USB_DeviceEnumerationComplete event when the host has completed its - * enumeration of the device (i.e. when a REQ_SetConfiguration request changes the current configuration - * number from 0 to a non-zero value). - * - * \see Events.h for more information on this event. - */ - RAISES_EVENT(USB_DeviceEnumerationComplete); + #if !defined(NO_DEVICE_SELF_POWER) + /** Indicates if the device is currently being powered by its own power supply, rather than being + * 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 + */ + extern bool USB_CurrentlySelfPowered; + #endif /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) #if defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS) #error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive. + #elif defined(USE_RAM_DESCRIPTORS) && defined(USE_FLASH_DESCRIPTORS) + #error USE_RAM_DESCRIPTORS and USE_FLASH_DESCRIPTORS are mutually exclusive. + #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS) + #error USE_FLASH_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive. + #elif defined(USE_FLASH_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS) && defined(USE_RAM_DESCRIPTORS) + #error Only one of the USE_*_DESCRIPTORS modes should be selected. #endif /* Function Prototypes: */ - void USB_Device_ProcessControlPacket(void); + void USB_Device_ProcessControlRequest(void); #if defined(INCLUDE_FROM_DEVCHAPTER9_C) static void USB_Device_SetAddress(void); static void USB_Device_SetConfiguration(void); static void USB_Device_GetConfiguration(void); static void USB_Device_GetDescriptor(void); - static void USB_Device_GetStatus(const uint8_t bmRequestType); - #if !defined(NO_CLEARSET_FEATURE_REQUEST) - static void USB_Device_ClearSetFeature(const uint8_t bRequest, const uint8_t bmRequestType); - #endif + static void USB_Device_GetStatus(void); + static void USB_Device_ClearSetFeature(void); + + #if !defined(NO_INTERNAL_SERIAL) && (defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)) + static char USB_Device_NibbleToASCII(uint8_t Nibble) ATTR_ALWAYS_INLINE; + static void USB_Device_GetInternalSerialDescriptor(void); + #endif #endif #endif