From 663f449c10b9a77a429aaa81066ce2b43ca6dc39 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 19 Apr 2009 11:43:21 +0000 Subject: Fixed incorrect HID interface class and subclass values in the Mouse and KeyboardMouse demos (thanks to Brian Dickman). Capitolised the "Descriptor_Search" and "Descriptor_Search_Comp" prefixes of the values in the DSearch_Return_ErrorCodes_t and DSearch_Comp_Return_ErrorCodes_t enums. Minor documentation improvements. --- LUFA/Drivers/Board/Dataflash.h | 2 +- LUFA/Drivers/Board/Temperature.h | 2 +- LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h | 72 ++++++++++++++++++---------- LUFA/Drivers/Peripheral/Serial.h | 2 +- LUFA/Drivers/USB/Class/ConfigDescriptor.c | 6 +-- LUFA/Drivers/USB/Class/ConfigDescriptor.h | 18 +++---- LUFA/Drivers/USB/Class/HIDParser.c | 6 +-- LUFA/Drivers/USB/HighLevel/StreamCallbacks.h | 5 +- LUFA/Drivers/USB/HighLevel/USBTask.h | 2 +- LUFA/Drivers/USB/LowLevel/Device.h | 2 +- LUFA/Drivers/USB/LowLevel/Endpoint.h | 2 +- LUFA/Drivers/USB/LowLevel/Host.h | 2 +- LUFA/Drivers/USB/LowLevel/OTG.h | 2 +- LUFA/Drivers/USB/LowLevel/Pipe.h | 6 +-- 14 files changed, 74 insertions(+), 55 deletions(-) (limited to 'LUFA/Drivers') diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 9f5d0756d..01ee88930 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -75,7 +75,7 @@ #endif /* Public Interface - May be used in end-application: */ - /* Psuedo-Function Macros: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Determines the currently selected dataflash chip. * diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index f21ed400d..56e579076 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -82,7 +82,7 @@ /** Maximum returnable temperature from the Temperature_GetTemperature() function. */ #define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET) - /* Psuedo-Functions: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel. * This must be called before any other temperature sensor routines. diff --git a/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h b/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h index a5bf03734..494c1e478 100644 --- a/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h +++ b/LUFA/Drivers/Peripheral/AT90USBXXX67/ADC.h @@ -62,32 +62,7 @@ #endif /* Public Interface - May be used in end-application: */ - /* Macros: */ - /** Initializes the ADC, ready for conversions. This must be called before any other ADC operations. - * The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and - * prescaler masks. - */ - #define ADC_Init(mode) MACROS{ ADCSRA = ((1 << ADEN) | mode); }MACROE - - /** Turns off the ADC. If this is called, any further ADC operations will require a call to the - * ADC_Init() macro before the ADC can be used again. - */ - #define ADC_Off() MACROS{ ADCSRA = 0; }MACROE - - /** Indicates if the ADC is enabled. This macro will return boolean true if the ADC subsystem is - * currently enabled, or false otherwise. - */ - #define ADC_GetStatus() ((ADCSRA & (1 << ADEN)) ? true : false) - - /** Indicates if the current ADC conversion is completed, or still in progress. This returns boolean - * false if the reading is still taking place, or true if the conversion is complete and ready to be - * read out with ADC_GetResult(). - */ - #define ADC_IsReadingComplete() (!(ADCSRA & (1 << ADSC))) - - /** Returns the result of the last conversion, as a 16-bit wide integer. */ - #define ADC_GetResult() ADC - + /* Macros: */ /** Reference mask, for using the voltage present at the AVR's AREF pin for the ADC reference. */ #define ADC_REFERENCE_AREF 0 @@ -134,6 +109,51 @@ /** Sets the ADC input clock to prescale by a factor of 128 the AVR's system clock. */ #define ADC_PRESCALE_128 ((1 << ADPS2) | (1 << ADPS1) | (1 << ADPS0)) + /* Pseudo-Function Macros: */ + #if defined(__DOXYGEN__) + /** Initializes the ADC, ready for conversions. This must be called before any other ADC operations. + * The "mode" parameter should be a mask comprised of a conversion mode (free running or single) and + * prescaler masks. + * + * \param Mode Mask of ADC settings, including adjustment, prescale, mode and reference + */ + static inline void ADC_Init(uint8_t Mode); + + /** Turns off the ADC. If this is called, any further ADC operations will require a call to + * ADC_Init() before the ADC can be used again. + */ + static inline void ADC_Off(void); + + /** Indicates if the ADC is currently enabled. + * + * \return Boolean true if the ADC subsystem is currently enabled, false otherwise. + */ + static inline bool ADC_GetStatus(void); + + /** Indicates if the current ADC conversion is completed, or still in progress. + * + * \return Boolean false if the reading is still taking place, or true if the conversion is + * complete and ready to be read out with ADC_GetResult() + */ + static inline bool ADC_IsReadingComplete(void); + + /** Retrieves the conversion value of the last completed ADC conversion. + * + * \return The result of the last ADC conversion + */ + static inline uint16_t ADC_GetResult(void); + #else + #define ADC_Init(mode) MACROS{ ADCSRA = ((1 << ADEN) | mode); }MACROE + + #define ADC_Off() MACROS{ ADCSRA = 0; }MACROE + + #define ADC_GetStatus() ((ADCSRA & (1 << ADEN)) ? true : false) + + #define ADC_IsReadingComplete() (!(ADCSRA & (1 << ADSC))) + + #define ADC_GetResult() ADC + #endif + /* Inline Functions: */ /** Configures the given ADC channel, ready for ADC conversions. This function sets the * associated port pin as an input and disables the digital portion of the I/O to reduce diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index 65b40a53f..a50456b37 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -74,7 +74,7 @@ */ #define SERIAL_2X_UBBRVAL(baud) (((F_CPU / 8) / baud) - 1) - /* Psuedo-Functions: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Indicates whether a character has been received through the USART. * diff --git a/LUFA/Drivers/USB/Class/ConfigDescriptor.c b/LUFA/Drivers/USB/Class/ConfigDescriptor.c index 61a5c445c..c9f8c3cbb 100644 --- a/LUFA/Drivers/USB/Class/ConfigDescriptor.c +++ b/LUFA/Drivers/USB/Class/ConfigDescriptor.c @@ -125,9 +125,9 @@ uint8_t USB_GetNextDescriptorComp_P(uint16_t* BytesRem, uint8_t** CurrConfigLoc, USB_GetNextDescriptor(BytesRem, CurrConfigLoc); - if ((ErrorCode = ComparatorRoutine(*CurrConfigLoc)) != Descriptor_Search_NotFound) + if ((ErrorCode = ComparatorRoutine(*CurrConfigLoc)) != DESCRIPTOR_SEARCH_NotFound) { - if (ErrorCode == Descriptor_Search_Fail) + if (ErrorCode == DESCRIPTOR_SEARCH_Fail) { *CurrConfigLoc = PrevDescLoc; *BytesRem = PrevBytesRem; @@ -137,5 +137,5 @@ uint8_t USB_GetNextDescriptorComp_P(uint16_t* BytesRem, uint8_t** CurrConfigLoc, } } - return Descriptor_Search_Comp_EndOfDescriptor; + return DESCRIPTOR_SEARCH_COMP_EndOfDescriptor; } diff --git a/LUFA/Drivers/USB/Class/ConfigDescriptor.h b/LUFA/Drivers/USB/Class/ConfigDescriptor.h index 7a1d53118..362a43e75 100644 --- a/LUFA/Drivers/USB/Class/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/Class/ConfigDescriptor.h @@ -122,7 +122,7 @@ */ #define DESCRIPTOR_COMPARATOR(name) uint8_t DCOMP_##name (void* const CurrentDescriptor) - /* Psuedo-Functions: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Searches for the next descriptor in the given configuration descriptor using a premade comparator * function. The routine updates the position and remaining configuration descriptor bytes values @@ -146,9 +146,9 @@ * DESCRIPTOR_COMPARATOR(EndpointSearcher) * { * if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint) - * return Descriptor_Search_Found; + * return DESCRIPTOR_SEARCH_Found; * else - * return Descriptor_Search_NotFound; + * return DESCRIPTOR_SEARCH_NotFound; * } * * //... @@ -169,18 +169,18 @@ /** Enum for return values of a descriptor comparator made with DESCRIPTOR_COMPARATOR. */ enum DSearch_Return_ErrorCodes_t { - Descriptor_Search_Found = 0, /**< Current descriptor matches comparator criteria. */ - Descriptor_Search_Fail = 1, /**< No further descriptor could possibly match criteria, fail the search. */ - Descriptor_Search_NotFound = 2, /**< Current descriptor does not match comparator criteria. */ + DESCRIPTOR_SEARCH_Found = 0, /**< Current descriptor matches comparator criteria. */ + DESCRIPTOR_SEARCH_Fail = 1, /**< No further descriptor could possibly match criteria, fail the search. */ + DESCRIPTOR_SEARCH_NotFound = 2, /**< Current descriptor does not match comparator criteria. */ }; /** Enum for return values of USB_GetNextDescriptorComp(). */ enum DSearch_Comp_Return_ErrorCodes_t { - Descriptor_Search_Comp_Found = 0, /**< Configuration descriptor now points to descriptor which matches + DESCRIPTOR_SEARCH_COMP_Found = 0, /**< Configuration descriptor now points to descriptor which matches * search criteria of the given comparator function. */ - Descriptor_Search_Comp_Fail = 1, /**< Comparator function returned Descriptor_Search_Fail. */ - Descriptor_Search_Comp_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */ + DESCRIPTOR_SEARCH_COMP_Fail = 1, /**< Comparator function returned Descriptor_Search_Fail. */ + DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */ }; /* Function Prototypes: */ diff --git a/LUFA/Drivers/USB/Class/HIDParser.c b/LUFA/Drivers/USB/Class/HIDParser.c index 35b280b5c..5fb29aa0a 100644 --- a/LUFA/Drivers/USB/Class/HIDParser.c +++ b/LUFA/Drivers/USB/Class/HIDParser.c @@ -30,7 +30,7 @@ #include "HIDParser.h" -uint8_t ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData) +uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData) { HID_StateTable_t StateTable[HID_STATETABLE_STACK_DEPTH]; HID_StateTable_t* CurrStateTable = &StateTable[0]; @@ -275,7 +275,7 @@ uint8_t ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_Rep return HID_PARSE_Successful; } -bool GetReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem) +bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem) { uint16_t DataBitsRem = ReportItem->Attributes.BitSize; uint16_t CurrentBit = ReportItem->BitOffset; @@ -303,7 +303,7 @@ bool GetReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const Report return true; } -void SetReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem) +void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem) { uint16_t DataBitsRem = ReportItem->Attributes.BitSize; uint16_t CurrentBit = ReportItem->BitOffset; diff --git a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h index 26f150350..5f0b73742 100644 --- a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h +++ b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h @@ -31,9 +31,8 @@ /** \ingroup Group_USB * @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks * - * Macros and enums for the stream callback routines in Endpoint.h and Pipe.c. This module contains the - * code required to easily set up stream callback functions which can be used to force early abort of a - * stream read/write process. + * Macros and enums for the stream callback routines. This module contains the code required to easily set up + * stream callback functions which can be used to force early abort of a stream read/write process. * * @{ */ diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h index 637872291..833fd9ec7 100644 --- a/LUFA/Drivers/USB/HighLevel/USBTask.h +++ b/LUFA/Drivers/USB/HighLevel/USBTask.h @@ -86,7 +86,7 @@ /** Indicates if the USB interface is currently suspended by the host when in device mode. When suspended, * the device should consume minimal power, and cannot communicate to the host. If Remote Wakeup is * supported by the device and USB_RemoteWakeupEnabled is true, suspension can be terminated by the device - * by issuing a Remote Wakup request. + * by issuing a Remote Wakeup request. * * \note This global is only present if the user application can be a USB device. * diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h index 3c2bb3697..206a99361 100644 --- a/LUFA/Drivers/USB/LowLevel/Device.h +++ b/LUFA/Drivers/USB/LowLevel/Device.h @@ -67,7 +67,7 @@ */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0) - /* Psuedo-Function Macros: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Sends a Remote Wakeup request to the host. This signals to the host that the device should * be taken out of suspended mode, and communications should resume. diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h index 651c0e8e6..90375b0ef 100644 --- a/LUFA/Drivers/USB/LowLevel/Endpoint.h +++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h @@ -178,7 +178,7 @@ */ #define ENDPOINT_INT_OUT UEIENX, (1 << RXOUTE), UEINTX, (1 << RXOUTI) - /* Psuedo-Function Macros: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Indicates the number of bytes currently stored in the current endpoint's selected bank. * diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h index 82cceb2c0..62921e866 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.h +++ b/LUFA/Drivers/USB/LowLevel/Host.h @@ -85,7 +85,7 @@ #define HOST_DEVICE_SETTLE_DELAY_MS 1500 #endif - /* Psuedo-Function Macros: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host. * USB bus resets leave the default control pipe configured (if already configured). diff --git a/LUFA/Drivers/USB/LowLevel/OTG.h b/LUFA/Drivers/USB/LowLevel/OTG.h index da303c909..1f59e0cfa 100644 --- a/LUFA/Drivers/USB/LowLevel/OTG.h +++ b/LUFA/Drivers/USB/LowLevel/OTG.h @@ -61,7 +61,7 @@ */ #define USB_OTG_STP_DATA 0 - /* Psuedo-Function Macros: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Initiate a Host Negotiation Protocol request. This indicates to the other connected device * that the device wishes to change device/host roles. diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index 15be81e13..4e2ffec5a 100644 --- a/LUFA/Drivers/USB/LowLevel/Pipe.h +++ b/LUFA/Drivers/USB/LowLevel/Pipe.h @@ -242,7 +242,7 @@ */ #define PIPE_INT_STALL UPIENX, (1 << RXSTALLE), UPINTX, (1 << RXSTALLI) - /* Psuedo-Function Macros: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Indicates the number of bytes currently stored in the current pipes's selected bank. * @@ -367,7 +367,7 @@ * * \see Pipe_GetErrorFlags() macro for information on retrieving the exact error flag. * - * \return Boolean true if an error has ocurred on the selected pipe, false otherwise + * \return Boolean true if an error has occurred on the selected pipe, false otherwise */ static inline bool Pipe_IsError(void); @@ -379,7 +379,7 @@ /** Gets a mask of the hardware error flags which have occurred on the currently selected pipe. This * value can then be masked against the PIPE_ERRORFLAG_* masks to determine what error has occurred. * - * \return Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has ocurred on the selected pipe + * \return Mask comprising of PIPE_ERRORFLAG_* bits indicating what error has occurred on the selected pipe */ static inline uint8_t Pipe_GetErrorFlags(void); -- cgit v1.2.3