diff --git a/Demos/Device/Joystick/Joystick.c b/Demos/Device/Joystick/Joystick.c index a5c3242feb..b2de42fc2f 100644 --- a/Demos/Device/Joystick/Joystick.c +++ b/Demos/Device/Joystick/Joystick.c @@ -58,7 +58,7 @@ int main(void) /* Hardware Initialization */ Joystick_Init(); LEDs_Init(); - HWB_Init(); + Buttons_Init(); /* Indicate USB not ready */ UpdateStatus(Status_USBNotReady); @@ -173,7 +173,7 @@ bool GetNextReport(USB_JoystickReport_Data_t* ReportData) if (JoyStatus_LCL & JOY_PRESS) ReportData->Button = (1 << 1); - if (HWB_GetStatus()) + if (Buttons_GetStatus() & BUTTONS_BUTTON1) ReportData->Button |= (1 << 0); /* Check if the new report is different to the previous report */ diff --git a/Demos/Device/Joystick/Joystick.h b/Demos/Device/Joystick/Joystick.h index 2a5cc25882..c274b5bc57 100644 --- a/Demos/Device/Joystick/Joystick.h +++ b/Demos/Device/Joystick/Joystick.h @@ -48,7 +48,7 @@ #include // USB Functionality #include // Joystick driver #include // LEDs driver - #include // Hardware Button driver + #include // Board Buttons driver #include // Simple scheduler for task management /* Task Definitions: */ diff --git a/Demos/Device/KeyboardMouse/KeyboardMouse.c b/Demos/Device/KeyboardMouse/KeyboardMouse.c index dc039eec0f..5c9332849d 100644 --- a/Demos/Device/KeyboardMouse/KeyboardMouse.c +++ b/Demos/Device/KeyboardMouse/KeyboardMouse.c @@ -240,8 +240,8 @@ TASK(USB_Keyboard) { uint8_t JoyStatus_LCL = Joystick_GetStatus(); - /* Check if HWB is not pressed, if so mouse mode enabled */ - if (!(HWB_GetStatus())) + /* Check if board button is not pressed, if so mouse mode enabled */ + if (!(Buttons_GetStatus() & BUTTONS_BUTTON1)) { if (JoyStatus_LCL & JOY_UP) KeyboardReportData.KeyCode[0] = 0x04; // A @@ -311,8 +311,8 @@ TASK(USB_Mouse) { uint8_t JoyStatus_LCL = Joystick_GetStatus(); - /* Check if HWB is pressed, if so mouse mode enabled */ - if (HWB_GetStatus()) + /* Check if board button is pressed, if so mouse mode enabled */ + if (Buttons_GetStatus() & BUTTONS_BUTTON1) { if (JoyStatus_LCL & JOY_UP) MouseReportData.Y = 1; diff --git a/Demos/Device/KeyboardMouse/KeyboardMouse.h b/Demos/Device/KeyboardMouse/KeyboardMouse.h index a69293c412..9a1fee1f4c 100644 --- a/Demos/Device/KeyboardMouse/KeyboardMouse.h +++ b/Demos/Device/KeyboardMouse/KeyboardMouse.h @@ -45,7 +45,7 @@ #include // USB Functionality #include // Joystick driver #include // LEDs driver - #include // Hardware Button driver + #include // Board Buttons driver #include // Simple scheduler for task management /* Task Definitions: */ diff --git a/Demos/Device/MIDI/MIDI.c b/Demos/Device/MIDI/MIDI.c index 7e1d211561..1323e11634 100644 --- a/Demos/Device/MIDI/MIDI.c +++ b/Demos/Device/MIDI/MIDI.c @@ -58,7 +58,7 @@ int main(void) /* Hardware Initialization */ Joystick_Init(); LEDs_Init(); - HWB_Init(); + Buttons_Init(); /* Indicate USB not ready */ UpdateStatus(Status_USBNotReady); @@ -134,8 +134,8 @@ TASK(USB_MIDI_Task) uint8_t JoystickStatus = Joystick_GetStatus(); uint8_t JoystickChanges = (JoystickStatus ^ PrevJoystickStatus); - /* Get HWB status - if set use channel 10 (percussion), otherwise use channel 1 */ - uint8_t Channel = ((HWB_GetStatus()) ? MIDI_CHANNEL(10) : MIDI_CHANNEL(1)); + /* Get board button status - if pressed use channel 10 (percussion), otherwise use channel 1 */ + uint8_t Channel = ((Buttons_GetStatus() & BUTTONS_BUTTON1) ? MIDI_CHANNEL(10) : MIDI_CHANNEL(1)); if (JoystickChanges & JOY_LEFT) SendMIDINoteChange(0x3C, (JoystickStatus & JOY_LEFT), 0, Channel); diff --git a/Demos/Device/MIDI/MIDI.h b/Demos/Device/MIDI/MIDI.h index 4e81c8c2ad..4d801e82f0 100644 --- a/Demos/Device/MIDI/MIDI.h +++ b/Demos/Device/MIDI/MIDI.h @@ -48,7 +48,7 @@ #include // USB Functionality #include // Joystick driver #include // LEDs driver - #include // Hardware Button driver + #include // Board Buttons driver #include // Simple scheduler for task management /* Macros: */ diff --git a/Demos/Device/Mouse/Mouse.c b/Demos/Device/Mouse/Mouse.c index 669b576a6d..7fff291f42 100644 --- a/Demos/Device/Mouse/Mouse.c +++ b/Demos/Device/Mouse/Mouse.c @@ -81,7 +81,7 @@ int main(void) /* Hardware Initialization */ Joystick_Init(); LEDs_Init(); - HWB_Init(); + Buttons_Init(); /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */ OCR0A = 0x7D; @@ -305,7 +305,7 @@ void CreateMouseReport(USB_MouseReport_Data_t* ReportData) if (JoyStatus_LCL & JOY_PRESS) ReportData->Button = (1 << 0); - if (HWB_GetStatus()) + if (Buttons_GetStatus() & BUTTONS_BUTTON1) ReportData->Button |= (1 << 1); } diff --git a/Demos/Device/Mouse/Mouse.h b/Demos/Device/Mouse/Mouse.h index 714f8d6e83..4eaf457ca6 100644 --- a/Demos/Device/Mouse/Mouse.h +++ b/Demos/Device/Mouse/Mouse.h @@ -50,7 +50,7 @@ #include // USB Functionality #include // Joystick driver #include // LEDs driver - #include // Hardware Button driver + #include // Board Buttons driver #include // Simple scheduler for task management /* Task Definitions: */ diff --git a/Demos/Host/MassStorageHost/MassStorageHost.c b/Demos/Host/MassStorageHost/MassStorageHost.c index 15006d336a..d06e3a63af 100644 --- a/Demos/Host/MassStorageHost/MassStorageHost.c +++ b/Demos/Host/MassStorageHost/MassStorageHost.c @@ -63,7 +63,7 @@ int main(void) /* Hardware Initialization */ SerialStream_Init(9600, false); LEDs_Init(); - HWB_Init(); + Buttons_Init(); /* Indicate USB not ready */ UpdateStatus(Status_USBNotReady); @@ -319,10 +319,10 @@ TASK(USB_MassStore_Host) puts_P(PSTR("\r\n")); } - puts_P(PSTR("\r\n\r\nPress HWB to read entire ASCII contents of disk...\r\n\r\n")); + puts_P(PSTR("\r\n\r\nPress board button to read entire ASCII contents of disk...\r\n\r\n")); - /* Wait for HWB to be pressed */ - while (!(HWB_GetStatus())) + /* Wait for the board button to be pressed */ + while (!(Buttons_GetStatus() & BUTTONS_BUTTON1)) { /* Abort if device removed */ if (!(USB_IsConnected)) diff --git a/Demos/Host/MassStorageHost/MassStorageHost.h b/Demos/Host/MassStorageHost/MassStorageHost.h index d4b9947bb3..2160659702 100644 --- a/Demos/Host/MassStorageHost/MassStorageHost.h +++ b/Demos/Host/MassStorageHost/MassStorageHost.h @@ -52,7 +52,7 @@ #include // USB Functionality #include // Serial stream driver #include // LEDs driver - #include // Hardware Button driver + #include // Board Buttons driver #include // Simple scheduler for task management /* Enums: */ diff --git a/Demos/OTG/TestApp/TestApp.c b/Demos/OTG/TestApp/TestApp.c index 8c8a23ffc2..4dc9b44e30 100644 --- a/Demos/OTG/TestApp/TestApp.c +++ b/Demos/OTG/TestApp/TestApp.c @@ -40,7 +40,7 @@ TASK_LIST { { .Task = TestApp_CheckJoystick, .TaskStatus = TASK_RUN }, - { .Task = TestApp_CheckHWB , .TaskStatus = TASK_RUN }, + { .Task = TestApp_CheckButton , .TaskStatus = TASK_RUN }, { .Task = TestApp_CheckTemp , .TaskStatus = TASK_RUN }, { .Task = USB_USBTask , .TaskStatus = TASK_RUN }, }; @@ -63,7 +63,7 @@ int main(void) Temperature_Init(); Joystick_Init(); LEDs_Init(); - HWB_Init(); + Buttons_Init(); /* Millisecond timer initialization, with output compare interrupt enabled */ OCR0A = 0x7D; @@ -137,17 +137,17 @@ TASK(TestApp_CheckTemp) } } -/** Task responsible for checking the HWB button position, and start-stopping other tasks and the USB +/** Task responsible for checking the board's first button' position, and start-stopping other tasks and the USB * interface in response to user joystick movements. */ -TASK(TestApp_CheckHWB) +TASK(TestApp_CheckButton) { static SchedulerDelayCounter_t DelayCounter = 0; static bool IsPressed; static bool BlockingJoystickTask; - /* Check if HWB pressed (start USB) */ - if (HWB_GetStatus() == true) + /* Check if board button pressed (start USB) */ + if (Buttons_GetStatus() & BUTTONS_BUTTON1) { /* Debounce - check 100 ticks later to see if button is still being pressed */ if ((IsPressed == false) && (Scheduler_HasDelayElapsed(100, &DelayCounter))) @@ -185,7 +185,7 @@ TASK(TestApp_CheckHWB) } else { - /* HWB not pressed - reset debounce interval counter and press handled flag */ + /* Board button not pressed - reset debounce interval counter and press handled flag */ Scheduler_ResetDelay(&DelayCounter); IsPressed = false; } diff --git a/Demos/OTG/TestApp/TestApp.h b/Demos/OTG/TestApp/TestApp.h index d5ce8dd3aa..de4d52612e 100644 --- a/Demos/OTG/TestApp/TestApp.h +++ b/Demos/OTG/TestApp/TestApp.h @@ -51,12 +51,12 @@ #include // USART Stream driver #include // Joystick driver #include // LED driver - #include // Hardware Button driver + #include // Board Buttons driver #include // Temperature sensor driver /* Task Definitions: */ TASK(TestApp_CheckJoystick); - TASK(TestApp_CheckHWB); + TASK(TestApp_CheckButton); TASK(TestApp_CheckTemp); #endif diff --git a/LUFA.pnproj b/LUFA.pnproj index 55457f5185..dae734b10b 100644 --- a/LUFA.pnproj +++ b/LUFA.pnproj @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/LUFA/ChangeLog.txt b/LUFA/ChangeLog.txt index d538e35fd6..98b82d35a4 100644 --- a/LUFA/ChangeLog.txt +++ b/LUFA/ChangeLog.txt @@ -77,6 +77,7 @@ * - Fixed missing semicolon in the ATAVRUSBRF01 LED board driver code (thanks to Morten Lund) * - Changed LED board driver code to define dummy LED masks for the first four board LEDs, so that user code can be compiled for boards * with less than four LEDs without code modifications (thanks to Morten Lund) + * - Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button * * * \section Sec_ChangeLog090401 Version 090401 diff --git a/LUFA/DriverStubs/HWB.h b/LUFA/DriverStubs/Buttons.h similarity index 74% rename from LUFA/DriverStubs/HWB.h rename to LUFA/DriverStubs/Buttons.h index 4b7f205424..0d02e5c71c 100644 --- a/LUFA/DriverStubs/HWB.h +++ b/LUFA/DriverStubs/Buttons.h @@ -35,13 +35,12 @@ driver file should be completed and copied into the "/Board/" folder inside the application's folder. - This stub is for the board-specific component of the LUFA HWB (Hardware - Button, a physical button on most Atmel USB boards) driver. This could - alternately be driven from any button connected to the USB AVR. + This stub is for the board-specific component of the LUFA Buttons driver, + for the control of physical board-mounted GPIO pushbuttons. */ -#ifndef __HWB_USER_H__ -#define __HWB_USER_H__ +#ifndef __BUTTONS_USER_H__ +#define __BUTTONS_USER_H__ /* Includes: */ #include @@ -57,20 +56,24 @@ #endif /* Preprocessor Checks: */ - #if !defined(INCLUDE_FROM_HWB_H) - #error Do not include this file directly. Include LUFA/Drivers/Board/HWB.h instead. + #if !defined(INCLUDE_FROM_BUTTONS_H) + #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. #endif /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Button mask for the first button on the board. */ + #define BUTTONS_BUTTON1 // TODO: Add mask for first board buton here + /* Inline Functions: */ #if !defined(__DOXYGEN__) - static inline void HWB_Init(void) + static inline void Buttons_Init(void) { - // TODO: Initialize the appropriate port pin as an input here, with pull-up + // TODO: Initialize the appropriate port pins as an inputs here, with pull-ups } - static inline bool HWB_GetStatus(void) ATTR_WARN_UNUSED_RESULT; - static inline bool HWB_GetStatus(void) + static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; + static inline uint8_t Buttons_GetStatus(void) { // TODO: Return current button status here, debounced if required } diff --git a/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h similarity index 69% rename from LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h rename to LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h index 87426de160..29cc4e3625 100644 --- a/LUFA/Drivers/Board/ATAVRUSBRF01/HWB.h +++ b/LUFA/Drivers/Board/ATAVRUSBRF01/Buttons.h @@ -30,14 +30,14 @@ /** \file * - * Board specific HWB driver header for the ATAVRUSBRF01. + * Board specific Buttons driver header for the ATAVRUSBRF01. * - * \note This file should not be included directly. It is automatically included as needed by the HWB driver - * dispatch header located in LUFA/Drivers/Board/HWB.h. + * \note This file should not be included directly. It is automatically included as needed by the Buttons driver + * dispatch header located in LUFA/Drivers/Board/Buttons.h. */ -#ifndef __HWB_ATAVRUSBRF01_H__ -#define __HWB_ATAVRUSBRF01_H__ +#ifndef __BUTTONS_ATAVRUSBRF01_H__ +#define __BUTTONS_ATAVRUSBRF01_H__ /* Includes: */ #include @@ -51,23 +51,27 @@ #endif /* Preprocessor Checks: */ - #if !defined(INCLUDE_FROM_HWB_H) - #error Do not include this file directly. Include LUFA/Drivers/Board/HWB.h instead. + #if !defined(INCLUDE_FROM_BUTTONS_H) + #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. #endif /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Button mask for the first button on the board. */ + #define BUTTONS_BUTTON1 (1 << 7) + /* Inline Functions: */ #if !defined(__DOXYGEN__) - static inline void HWB_Init(void) + static inline void Buttons_Init(void) { - DDRD &= ~(1 << 7); - PORTD |= (1 << 7); + DDRD &= ~BUTTONS_BUTTON1; + PORTD |= BUTTONS_BUTTON1; } - static inline bool HWB_GetStatus(void) ATTR_WARN_UNUSED_RESULT; - static inline bool HWB_GetStatus(void) + static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; + static inline uint8_t Buttons_GetStatus(void) { - return (!(PIND & (1 << 7))); + return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); } #endif diff --git a/LUFA/Drivers/Board/HWB.h b/LUFA/Drivers/Board/Buttons.h similarity index 67% rename from LUFA/Drivers/Board/HWB.h rename to LUFA/Drivers/Board/Buttons.h index f6221afd3b..46d147345c 100644 --- a/LUFA/Drivers/Board/HWB.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -30,25 +30,25 @@ /** \file * - * This file is the master dispatch header file for the board-specific HWB driver, for boards containing a - * physical pushbutton connected to the AVR's HWB IO pin. + * This file is the master dispatch header file for the board-specific Buttons driver, for boards containing + * physical pushbuttons connected to the AVR's GPIO pins. * - * User code should include this file, which will in turn include the correct HWB driver header file for the + * User code should include this file, which will in turn include the correct Button driver header file for the * currently selected board. * - * If the BOARD value is set to BOARD_USER, this will include the /Board/HWB.h file in the user project + * If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project * directory. */ /** \ingroup Group_BoardDrivers - * @defgroup Group_HWB HWB Driver - LUFA/Drivers/Board/HWB.h + * @defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * * \section Module Description - * Functions, macros, variables, enums and types related to the control of board HWB. + * Functions, macros, variables, enums and types related to the control of physical board GPIO buttons. * * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project * directory. Otherwise, it will include the appropriate built in board driver header file. @@ -56,12 +56,12 @@ * @{ */ -#ifndef __HWB_H__ -#define __HWB_H__ +#ifndef __BUTTONS_H__ +#define __BUTTONS_H__ /* Macros: */ #if !defined(__DOXYGEN__) - #define INCLUDE_FROM_HWB_H + #define INCLUDE_FROM_BUTTONS_H #define INCLUDE_FROM_BOARD_DRIVER #endif @@ -71,33 +71,33 @@ #if !defined(BOARD) #error BOARD must be set in makefile to a value specified in BoardTypes.h. #elif (BOARD == BOARD_USBKEY) - #include "USBKEY/HWB.h" + #include "USBKEY/BUTTONS.h" #elif (BOARD == BOARD_STK525) - #include "STK525/HWB.h" + #include "STK525/BUTTONS.h" #elif (BOARD == BOARD_STK526) - #include "STK526/HWB.h" + #include "STK526/BUTTONS.h" #elif (BOARD == BOARD_ATAVRUSBRF01) - #include "ATAVRUSBRF01/HWB.h" + #include "ATAVRUSBRF01/BUTTONS.h" #elif (BOARD == BOARD_USER) - #include "Board/HWB.h" + #include "Board/BUTTONS.h" #else - #error The selected board does not contain a HWB. + #error The selected board does not contain any GPIO buttons. #endif /* Pseudo-Functions for Doxygen: */ #if defined(__DOXYGEN__) - /** Initializes the HWB driver, so that the current button position can be read. This sets the appropriate - * I/O pin to an input with pull-up enabled. + /** Initializes the BUTTONS driver, so that the current button position can be read. This sets the appropriate + * I/O pins to an inputs with pull-ups enabled. * - * This must be called before any HWB functions are used. + * This must be called before any Button driver functions are used. */ - static inline void HWB_Init(void); + static inline void Buttons_Init(void); - /** Returns the current position of the HWB button on the board. + /** Returns a mask indicating which board buttons are currently pressed. * - * \return Boolean true if the button is currently pressed, false otherwise + * \return Mask indicating which board buttons are currently pressed */ - static inline bool HWB_GetStatus(void) ATTR_WARN_UNUSED_RESULT; + static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; #endif #endif diff --git a/LUFA/Drivers/Board/STK526/HWB.h b/LUFA/Drivers/Board/STK525/Buttons.h similarity index 67% rename from LUFA/Drivers/Board/STK526/HWB.h rename to LUFA/Drivers/Board/STK525/Buttons.h index 6f1861bc15..dc7aca7335 100644 --- a/LUFA/Drivers/Board/STK526/HWB.h +++ b/LUFA/Drivers/Board/STK525/Buttons.h @@ -30,14 +30,20 @@ /** \file * - * Board specific HWB driver header for the STK526. + * Board specific Buttons driver header for the STK525. * - * \note This file should not be included directly. It is automatically included as needed by the HWB driver - * dispatch header located in LUFA/Drivers/Board/HWB.h. + * \note This file should not be included directly. It is automatically included as needed by the Buttons driver + * dispatch header located in LUFA/Drivers/Board/Buttons.h. */ -#ifndef __HWB_STK526_H__ -#define __HWB_STK526_H__ +#ifndef __BUTTONS_STK525_H__ +#define __BUTTONS_STK525_H__ + + /* Includes: */ + #include + #include + + #include "../../../Common/Common.h" /* Includes: */ #include @@ -51,29 +57,33 @@ #endif /* Preprocessor Checks: */ - #if !defined(INCLUDE_FROM_HWB_H) - #error Do not include this file directly. Include LUFA/Drivers/Board/HWB.h instead. + #if !defined(INCLUDE_FROM_BUTTONS_H) + #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. #endif /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Button mask for the first button on the board. */ + #define BUTTONS_BUTTON1 (1 << 2) + /* Inline Functions: */ #if !defined(__DOXYGEN__) - static inline void HWB_Init(void) + static inline void Buttons_Init(void) { - DDRD &= ~(1 << 7); - PORTD |= (1 << 7); + DDRE &= ~BUTTONS_BUTTON1; + PORTE |= BUTTONS_BUTTON1; } - static inline bool HWB_GetStatus(void) ATTR_WARN_UNUSED_RESULT; - static inline bool HWB_GetStatus(void) + static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; + static inline uint8_t Buttons_GetStatus(void) { - return (!(PIND & (1 << 7))); + return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); } #endif - + /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif - + #endif diff --git a/LUFA/Drivers/Board/STK525/Dataflash.h b/LUFA/Drivers/Board/STK525/Dataflash.h index b2ea1b8e9e..bc9ab9fbd6 100644 --- a/LUFA/Drivers/Board/STK525/Dataflash.h +++ b/LUFA/Drivers/Board/STK525/Dataflash.h @@ -30,7 +30,7 @@ /** \file * - * Board specific HWB driver header for the STK525. + * Board specific Dataflash driver header for the STK525. * * \note This file should not be included directly. It is automatically included as needed by the dataflash driver * dispatch header located in LUFA/Drivers/Board/Dataflash.h. diff --git a/LUFA/Drivers/Board/STK525/HWB.h b/LUFA/Drivers/Board/STK526/Buttons.h similarity index 67% rename from LUFA/Drivers/Board/STK525/HWB.h rename to LUFA/Drivers/Board/STK526/Buttons.h index 2200453ee8..fba578cb20 100644 --- a/LUFA/Drivers/Board/STK525/HWB.h +++ b/LUFA/Drivers/Board/STK526/Buttons.h @@ -30,14 +30,20 @@ /** \file * - * Board specific HWB driver header for the STK525. + * Board specific Buttons driver header for the STK526. * - * \note This file should not be included directly. It is automatically included as needed by the HWB driver - * dispatch header located in LUFA/Drivers/Board/HWB.h. + * \note This file should not be included directly. It is automatically included as needed by the Buttons driver + * dispatch header located in LUFA/Drivers/Board/Buttons.h. */ -#ifndef __HWB_STK525_H__ -#define __HWB_STK525_H__ +#ifndef __BUTTONS_STK526_H__ +#define __BUTTONS_STK526_H__ + + /* Includes: */ + #include + #include + + #include "../../../Common/Common.h" /* Includes: */ #include @@ -51,23 +57,27 @@ #endif /* Preprocessor Checks: */ - #if !defined(INCLUDE_FROM_HWB_H) - #error Do not include this file directly. Include LUFA/Drivers/Board/HWB.h instead. + #if !defined(INCLUDE_FROM_BUTTONS_H) + #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. #endif /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Button mask for the first button on the board. */ + #define BUTTONS_BUTTON1 (1 << 2) + /* Inline Functions: */ #if !defined(__DOXYGEN__) - static inline void HWB_Init(void) + static inline void Buttons_Init(void) { - DDRE &= ~(1 << 2); - PORTE |= (1 << 2); + DDRD &= ~BUTTONS_BUTTON1; + PORTD |= BUTTONS_BUTTON1; } - static inline bool HWB_GetStatus(void) ATTR_WARN_UNUSED_RESULT; - static inline bool HWB_GetStatus(void) + static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; + static inline uint8_t Buttons_GetStatus(void) { - return (!(PINE & (1 << 2))); + return ((PIND & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); } #endif @@ -75,6 +85,5 @@ #if defined(__cplusplus) } #endif - + #endif - diff --git a/LUFA/Drivers/Board/STK526/Dataflash.h b/LUFA/Drivers/Board/STK526/Dataflash.h index 65c5e202cd..cb8193e56a 100644 --- a/LUFA/Drivers/Board/STK526/Dataflash.h +++ b/LUFA/Drivers/Board/STK526/Dataflash.h @@ -30,7 +30,7 @@ /** \file * - * Board specific HWB driver header for the STK525. + * Board specific Dataflash driver header for the STK525. * * \note This file should not be included directly. It is automatically included as needed by the dataflash driver * dispatch header located in LUFA/Drivers/Board/Dataflash.h. diff --git a/LUFA/Drivers/Board/USBKEY/HWB.h b/LUFA/Drivers/Board/USBKEY/Buttons.h similarity index 69% rename from LUFA/Drivers/Board/USBKEY/HWB.h rename to LUFA/Drivers/Board/USBKEY/Buttons.h index 13af186a07..78c5b56627 100644 --- a/LUFA/Drivers/Board/USBKEY/HWB.h +++ b/LUFA/Drivers/Board/USBKEY/Buttons.h @@ -30,14 +30,14 @@ /** \file * - * Board specific HWB driver header for the USBKEY. + * Board specific Buttons driver header for the USBKEY. * - * \note This file should not be included directly. It is automatically included as needed by the HWB driver - * dispatch header located in LUFA/Drivers/Board/HWB.h. + * \note This file should not be included directly. It is automatically included as needed by the Buttons driver + * dispatch header located in LUFA/Drivers/Board/Buttons.h. */ -#ifndef __HWB_USBKEY_H__ -#define __HWB_USBKEY_H__ +#ifndef __BUTTONS_USBKEY_H__ +#define __BUTTONS_USBKEY_H__ /* Includes: */ #include @@ -51,23 +51,27 @@ #endif /* Preprocessor Checks: */ - #if !defined(INCLUDE_FROM_HWB_H) - #error Do not include this file directly. Include LUFA/Drivers/Board/HWB.h instead. + #if !defined(INCLUDE_FROM_BUTTONS_H) + #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead. #endif /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Button mask for the first button on the board. */ + #define BUTTONS_BUTTON1 (1 << 2) + /* Inline Functions: */ #if !defined(__DOXYGEN__) - static inline void HWB_Init(void) + static inline void Buttons_Init(void) { - DDRE &= ~(1 << 2); - PORTE |= (1 << 2); + DDRE &= ~BUTTONS_BUTTON1; + PORTE |= BUTTONS_BUTTON1; } - static inline bool HWB_GetStatus(void) ATTR_WARN_UNUSED_RESULT; - static inline bool HWB_GetStatus(void) + static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; + static inline uint8_t Buttons_GetStatus(void) { - return (!(PINE & (1 << 2))); + return ((PINE & BUTTONS_BUTTON1) ^ BUTTONS_BUTTON1); } #endif diff --git a/LUFA/Drivers/Board/USBKEY/Dataflash.h b/LUFA/Drivers/Board/USBKEY/Dataflash.h index cae62fd490..d4bfdc9438 100644 --- a/LUFA/Drivers/Board/USBKEY/Dataflash.h +++ b/LUFA/Drivers/Board/USBKEY/Dataflash.h @@ -30,7 +30,7 @@ /** \file * - * Board specific HWB driver header for the STK525. + * Board specific Dataflash driver header for the STK525. * * \note This file should not be included directly. It is automatically included as needed by the dataflash driver * dispatch header located in LUFA/Drivers/Board/Dataflash.h. diff --git a/LUFA/MainPage.txt b/LUFA/MainPage.txt index 1f18d0f416..9dc8a18d43 100644 --- a/LUFA/MainPage.txt +++ b/LUFA/MainPage.txt @@ -15,15 +15,15 @@ * microcontrollers, released under the MIT license. * * Currently supported AVR models: - * - AT90USB1286 - * - AT90USB1287 - * - AT90USB646 - * - AT90USB647 - * - AT90USB162 - * - AT90USB82 - * - ATMEGA16U4 - * - ATMEGA32U6 - * - ATMEGA32U4 + * - AT90USB1286 (USB Host and Device) + * - AT90USB1287 (USB Host and Device) + * - AT90USB646 (USB Device Only) + * - AT90USB647 (USB Device Only) + * - AT90USB162 (USB Device Only) + * - AT90USB82 (USB Device Only) + * - ATMEGA16U4 (USB Device Only) + * - ATMEGA32U6 (USB Device Only) + * - ATMEGA32U4 (USB Device Only) * * Currently supported Atmel boards: * - AT90USBKEY diff --git a/LUFA/MigrationInformation.txt b/LUFA/MigrationInformation.txt index 0e384f9303..6439419f3f 100644 --- a/LUFA/MigrationInformation.txt +++ b/LUFA/MigrationInformation.txt @@ -17,6 +17,7 @@ * BUTTLOADTAG elements, or download and extract ButtLoadTag.h header from the ButtLoad project. * - The Drivers/AT90USBXXX directory has been renamed to Drivers/Peripheral. * - The Serial_Stream driver has been renamed to SerialStream to remain consistent with the rest of the library naming scheme. + * - The HWB driver has changed to the Buttons driver. See the board Buttons driver documentation for the new API. * * Dual Role Mode * - The USB_PowerOnFail even has been renamed to USB_InitFailure.