board_keys.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. /***********************************************************************************************************************
  2. * File Name : board_keys.h
  3. * Description : This module has information about the keys on this board.
  4. **********************************************************************************************************************/
  5. /*******************************************************************************************************************//**
  6. * @ingroup BOARD_RA6M4
  7. * @defgroup BSP_RA6M4_IOT_KEYS Board keys
  8. * @brief key information for this board.
  9. *
  10. * This is code specific to the BSP_RA6M4_IOT board.
  11. *
  12. * @{
  13. **********************************************************************************************************************/
  14. #ifndef BOARD_KEYS_H
  15. #define BOARD_KEYS_H
  16. /** Common macro for FSP header files. There is also a corresponding FSP_FOOTER macro at the end of this file. */
  17. FSP_HEADER
  18. /***********************************************************************************************************************
  19. * Macro definitions
  20. **********************************************************************************************************************/
  21. /***********************************************************************************************************************
  22. * Typedef definitions
  23. **********************************************************************************************************************/
  24. /** Information on how many keys and what pins they are on. */
  25. typedef struct st_bsp_keys
  26. {
  27. uint16_t key_count; ///< The number of keys on this board
  28. uint16_t const * p_keys; ///< Pointer to an array of IOPORT pins for controlling keys
  29. } bsp_keys_t;
  30. /** Available user-controllable keys on this board. These enums can be can be used to index into the array of key pins
  31. * found in the bsp_keys_t structure. */
  32. typedef enum e_bsp_key
  33. {
  34. BSP_KEY_KEY1=0, ///< TB KEY1
  35. BSP_KEY_KEY2=0, ///< TB KEY2
  36. } bsp_key_t;
  37. /***********************************************************************************************************************
  38. * Exported global variables
  39. **********************************************************************************************************************/
  40. /***********************************************************************************************************************
  41. * Public Functions
  42. **********************************************************************************************************************/
  43. void key_sample (void);
  44. /** Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
  45. FSP_FOOTER
  46. #endif /* BOARD_KEYS_H */
  47. /** @} (end defgroup BSP_RA6M4_IOT_KEYS) */