mirror of
https://github.com/zsa/qmk_firmware.git
synced 2026-05-04 14:55:29 +00:00
Changed HWB board driver to Buttons driver, to allow for the support of future boards with more than one mounted GPIO button.
This commit is contained in:
Dean Camera
@@ -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
|
||||
|
||||
@@ -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 <avr/io.h>
|
||||
@@ -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
|
||||
}
|
||||
@@ -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 <avr/io.h>
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
@@ -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 <avr/io.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include "../../../Common/Common.h"
|
||||
|
||||
/* Includes: */
|
||||
#include <avr/io.h>
|
||||
@@ -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
|
||||
@@ -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.
|
||||
|
||||
@@ -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 <avr/io.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include "../../../Common/Common.h"
|
||||
|
||||
/* Includes: */
|
||||
#include <avr/io.h>
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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 <avr/io.h>
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
*
|
||||
* <b>Dual Role Mode</b>
|
||||
* - The USB_PowerOnFail even has been renamed to USB_InitFailure.
|
||||
|
||||
Reference in New Issue
Block a user