stm32l4r9i_discovery.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l4r9i_discovery.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains definitions for STM32L4R9I_DISCOVERY's LEDs,
00006   *          push-buttons hardware resources (MB1311).
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
00011   * All rights reserved.</center></h2>
00012   *
00013   * This software component is licensed by ST under BSD 3-Clause license,
00014   * the "License"; You may not use this file except in compliance with the
00015   * License. You may obtain a copy of the License at:
00016   *                        opensource.org/licenses/BSD-3-Clause
00017   *
00018   ******************************************************************************
00019   */
00020 
00021 /* Define to prevent recursive inclusion -------------------------------------*/
00022 #ifndef __STM32L4R9I_DISCOVERY_H
00023 #define __STM32L4R9I_DISCOVERY_H
00024 
00025 #ifdef __cplusplus
00026  extern "C" {
00027 #endif
00028 
00029 /**
00030   * @brief  Define for STM32L4R9I_DISCOVERY board
00031   */
00032 
00033 
00034 
00035 /* Includes ------------------------------------------------------------------*/
00036 #include "stm32l4xx_hal.h"
00037 #if defined(BSP_USE_CMSIS_OS)
00038 #include "cmsis_os.h"
00039 #endif
00040 
00041 /** @addtogroup BSP
00042   * @{
00043   */
00044 
00045 /** @addtogroup STM32L4R9I_DISCOVERY
00046   * @{
00047   */
00048 
00049 /** @addtogroup STM32L4R9I_DISCOVERY_Common
00050   * @{
00051   */
00052 
00053 /** @defgroup STM32L4R9I_DISCOVERY_Exported_Types Exported Types
00054   * @{
00055   */
00056 
00057 /**
00058  * @brief LED Types Definition
00059  */
00060 typedef enum
00061 {
00062   DISCO_LED1 = 0,
00063   DISCO_LED2 = 1,
00064   LED_ORANGE = DISCO_LED1,
00065   LED_GREEN  = DISCO_LED2
00066 }Led_TypeDef;
00067 
00068 
00069 /**
00070  * @brief JOYSTICK Types Definition
00071  */
00072 typedef enum
00073 {
00074   JOY_SEL   = 0,
00075   JOY_LEFT  = 1,
00076   JOY_RIGHT = 2,
00077   JOY_DOWN  = 3,
00078   JOY_UP    = 4,
00079   JOY_NONE  = 5
00080 }JOYState_TypeDef;
00081 
00082 typedef enum
00083 {
00084   JOY_MODE_GPIO = 0,
00085   JOY_MODE_EXTI = 1
00086 }JOYMode_TypeDef;
00087 
00088 /**
00089  * @brief COM Type Definition
00090  */
00091 typedef enum
00092 {
00093   COM1 = 0
00094 }COM_TypeDef;
00095 
00096 /**
00097   * @}
00098   */
00099 
00100 /** @defgroup STM32L4R9I_DISCOVERY_Exported_Constants Exported Constants
00101   * @{
00102   */
00103 
00104 /** @defgroup STM32L4R9I_DISCOVERY_LED LED Constants
00105   * @{
00106   */
00107 /* LED number */
00108 #define LEDn                              2
00109 
00110 /* LED1 is accessed thru the MFX */
00111 #define LED1_PIN                          IO_PIN_0
00112 
00113 #define LED2_PIN                          GPIO_PIN_4
00114 #define LED2_GPIO_PORT                    GPIOH
00115 #define LED2_GPIO_CLK_ENABLE()            __HAL_RCC_GPIOH_CLK_ENABLE()
00116 #define LED2_GPIO_CLK_DISABLE()           __HAL_RCC_GPIOH_CLK_DISABLE()
00117 
00118 /**
00119   * @}
00120   */
00121 
00122 /** @defgroup STM32L4R9I_DISCOVERY_BUTTON  BUTTON Constants
00123   * @{
00124   */
00125 #define JOYn                              5
00126 
00127 /**
00128 * @brief Joystick Right push-button
00129 */
00130 #if defined(USE_STM32L4R9I_DISCO_REVA)
00131 /* Joystick right and up pins inverted */
00132 #define RIGHT_JOY_PIN                     IO_PIN_1
00133 #else
00134 #define RIGHT_JOY_PIN                     IO_PIN_3
00135 #endif
00136 #define RIGHT_JOY_EXTI_IRQn               EXTI1_IRQn
00137 
00138 /**
00139 * @brief Joystick Left push-button
00140 */
00141 #define LEFT_JOY_PIN                      IO_PIN_4
00142 #define LEFT_JOY_EXTI_IRQn                EXTI1_IRQn
00143 
00144 /**
00145 * @brief Joystick Up push-button
00146 */
00147 #if defined(USE_STM32L4R9I_DISCO_REVA)
00148 /* Joystick right and up pins inverted */
00149 #define UP_JOY_PIN                        IO_PIN_3
00150 #else
00151 #define UP_JOY_PIN                        IO_PIN_1
00152 #endif
00153 #define UP_JOY_EXTI_IRQn                  EXTI1_IRQn
00154 
00155 /**
00156  * @brief Joystick Down push-button
00157  */
00158 #define DOWN_JOY_PIN                      IO_PIN_2
00159 #define DOWN_JOY_EXTI_IRQn                EXTI1_IRQn
00160 
00161 /**
00162  * @brief Joystick Sel push-button
00163  */
00164 #define SEL_JOY_PIN                       GPIO_PIN_13   /* PC.13 */
00165 #define SEL_JOY_GPIO_PORT                 GPIOC
00166 #define SEL_JOY_GPIO_CLK_ENABLE()         __HAL_RCC_GPIOC_CLK_ENABLE()
00167 #define SEL_JOY_GPIO_CLK_DISABLE()        __HAL_RCC_GPIOC_CLK_DISABLE()
00168 #define SEL_JOY_EXTI_IRQn                 EXTI15_10_IRQn
00169 
00170 /**
00171   * @}
00172   */
00173 
00174 /** @defgroup STM32L4R9I_DISCOVERY_MFX_PIN  MFX Pins Constants
00175   * @{
00176   */
00177 
00178 /**
00179   * @brief Pins definition connected to MFX
00180   */
00181 #define DSI_RST_PIN                    IO_PIN_10
00182 #define EXT_RST_PIN                    IO_PIN_11
00183 #define OTG_FS_POWER_SWITCH_PIN        IO_PIN_13
00184 #define OTG_FS_OVER_CURRENT_PIN        IO_PIN_14
00185 #define SD_DETECT_PIN                  IO_PIN_5
00186 
00187 /**
00188   * @}
00189   */
00190 
00191 /** @defgroup STM32L4R9I_DISCOVERY_COM COM Constants
00192   * @{
00193   */
00194 #define COMn                                    1
00195 
00196 /**
00197  * @brief Definition for COM port1, connected to USART2 (ST-Link USB Virtual Com Port)
00198  */
00199 #define DISCOVERY_COM1                          USART2
00200 #define DISCOVERY_COM1_CLK_ENABLE()             __HAL_RCC_USART2_CLK_ENABLE()
00201 #define DISCOVERY_COM1_CLK_DISABLE()            __HAL_RCC_USART2_CLK_DISABLE()
00202 
00203 #define DISCOVERY_COM1_TX_PIN                   GPIO_PIN_2
00204 #define DISCOVERY_COM1_TX_GPIO_PORT             GPIOA
00205 #define DISCOVERY_COM1_TX_GPIO_CLK_ENABLE()     __HAL_RCC_GPIOA_CLK_ENABLE()
00206 #define DISCOVERY_COM1_TX_GPIO_CLK_DISABLE()    __HAL_RCC_GPIOA_CLK_DISABLE()
00207 #define DISCOVERY_COM1_TX_AF                    GPIO_AF7_USART2
00208 
00209 #define DISCOVERY_COM1_RX_PIN                   GPIO_PIN_3
00210 #define DISCOVERY_COM1_RX_GPIO_PORT             GPIOA
00211 #define DISCOVERY_COM1_RX_GPIO_CLK_ENABLE()     __HAL_RCC_GPIOA_CLK_ENABLE()
00212 #define DISCOVERY_COM1_RX_GPIO_CLK_DISABLE()    __HAL_RCC_GPIOA_CLK_DISABLE()
00213 #define DISCOVERY_COM1_RX_AF                    GPIO_AF7_USART2
00214 
00215 #define DISCOVERY_COM1_IRQn                     USART2_IRQn
00216 
00217 
00218 #define DISCOVERY_COMx_CLK_ENABLE(__INDEX__)            do { if((__INDEX__) == COM1) {DISCOVERY_COM1_CLK_ENABLE();}} while(0)
00219 #define DISCOVERY_COMx_CLK_DISABLE(__INDEX__)           do { if((__INDEX__) == COM1) {DISCOVERY_COM1_CLK_DISABLE();}} while(0)
00220 
00221 #define DISCOVERY_COMx_TX_GPIO_CLK_ENABLE(__INDEX__)    do { if((__INDEX__) == COM1) {DISCOVERY_COM1_TX_GPIO_CLK_ENABLE();}} while(0)
00222 #define DISCOVERY_COMx_TX_GPIO_CLK_DISABLE(__INDEX__)   do { if((__INDEX__) == COM1) {DISCOVERY_COM1_TX_GPIO_CLK_DISABLE();}} while(0)
00223 
00224 #define DISCOVERY_COMx_RX_GPIO_CLK_ENABLE(__INDEX__)    do { if((__INDEX__) == COM1) {DISCOVERY_COM1_RX_GPIO_CLK_ENABLE();}} while(0)
00225 #define DISCOVERY_COMx_RX_GPIO_CLK_DISABLE(__INDEX__)   do { if((__INDEX__) == COM1) {DISCOVERY_COM1_RX_GPIO_CLK_DISABLE();}} while(0)
00226 
00227 /**
00228   * @}
00229   */
00230 
00231 /** @defgroup STM32L4R9I_DISCOVERY_BUS  BUS Constants
00232   * @{
00233   */
00234 
00235 #if defined(HAL_I2C_MODULE_ENABLED)
00236 /*##################### I2C1 ###################################*/
00237 
00238 /* I2C TIMING Register define when I2C clock source is SYSCLK */
00239 /* I2C TIMING is calculated in case of the I2C Clock source is the SYSCLK = 120 MHz */
00240 /* Set 0xC080242F value to reach 100 KHz speed (Rise time = 640ns, Fall time = 20ns) */
00241 #ifndef DISCOVERY_I2C1_TIMING
00242  #define DISCOVERY_I2C1_TIMING                  0xC080242F
00243 #endif /* DISCOVERY_I2C1_TIMING */
00244 
00245 /* Maximum Timeout values for flags waiting loops. These timeouts are not based
00246    on accurate values, they just guarantee that the application will not remain
00247    stuck if the I2C communication is corrupted.
00248    You may modify these timeout values depending on CPU frequency and application
00249    conditions (interrupts routines ...). */
00250 #define DISCOVERY_I2C1_TIMEOUT_MAX              3000
00251 
00252 #define IDD_I2C_ADDRESS                  ((uint16_t) 0x84)
00253 #define IO_I2C_ADDRESS                   ((uint16_t) 0x84)
00254 #define AUDIO_I2C_ADDRESS                ((uint16_t) 0x94)
00255 #define TS_I2C_ADDRESS                   ((uint16_t) 0x70)
00256 #define CAMERA_I2C_ADDRESS               ((uint16_t) 0x60)
00257 
00258 #endif /* HAL_I2C_MODULE_ENABLED */
00259 
00260 /*##################### Audio Codec ##########################*/
00261 /**
00262   * @brief  Audio codec chip reset definition
00263   */
00264 /* Audio codec power on/off macro definition */
00265 #define CODEC_AUDIO_POWER_OFF()      BSP_IO_WritePin(AUDIO_RESET_PIN, GPIO_PIN_RESET)
00266 #define CODEC_AUDIO_POWER_ON()       BSP_IO_WritePin(AUDIO_RESET_PIN, GPIO_PIN_SET)
00267 
00268 /* Audio Reset Pin definition */
00269 #define AUDIO_RESET_PIN              IO_PIN_15
00270 
00271 /*##################### MFX ##########################*/
00272 /**
00273   * @brief  MFX interface pins
00274   */
00275 #define MFX_INT_GPIO_PORT                 GPIOI
00276 #define MFX_INT_GPIO_CLK_ENABLE()         __HAL_RCC_GPIOI_CLK_ENABLE()
00277 #define MFX_INT_GPIO_CLK_DISABLE()        __HAL_RCC_GPIOI_CLK_DISABLE()
00278 #define MFX_INT_PIN                       GPIO_PIN_1                  /* PI.01 */
00279 #define MFX_INT_EXTI_IRQn                 EXTI1_IRQn
00280 
00281 #define MFX_WAKEUP_GPIO_PORT              GPIOB
00282 #define MFX_WAKEUP_GPIO_CLK_ENABLE()      __HAL_RCC_GPIOB_CLK_ENABLE()
00283 #define MFX_WAKEUP_GPIO_CLK_DISABLE()     __HAL_RCC_GPIOB_CLK_DISABLE()
00284 #define MFX_WAKEUP_PIN                    GPIO_PIN_2                  /* PB.02 */
00285 
00286 /* Legacy  */
00287 #define IDD_INT_GPIO_PORT                 MFX_INT_GPIO_PORT
00288 #define IDD_INT_GPIO_CLK_ENABLE()         MFX_INT_GPIO_CLK_ENABLE()
00289 #define IDD_INT_GPIO_CLK_DISABLE()        MFX_INT_GPIO_CLK_DISABLE()
00290 #define IDD_INT_PIN                       MFX_INT_PIN
00291 #define IDD_INT_EXTI_IRQn                 MFX_INT_EXTI_IRQn
00292 #define IDD_WAKEUP_GPIO_PORT              MFX_WAKEUP_GPIO_PORT
00293 #define IDD_WAKEUP_GPIO_CLK_ENABLE()      MFX_WAKEUP_GPIO_CLK_ENABLE()
00294 #define IDD_WAKEUP_GPIO_CLK_DISABLE()     MFX_WAKEUP_GPIO_CLK_DISABLE()
00295 #define IDD_WAKEUP_PIN                    MFX_WAKEUP_PIN
00296 
00297 /**
00298   * @brief  Idd current measurement interface pins on MFX
00299   */
00300 #define IDD_AMP_CONTROL_PIN               AGPIO_PIN_1
00301 
00302 /**
00303   * @brief LCD pins
00304   */
00305 /* TE pin */
00306 #define LCD_TE_PIN                       GPIO_PIN_11
00307 #define LCD_TE_CTRL_GPIO_PORT            GPIOF
00308 #define LCD_TE_CTRL_GPIO_CLK_ENABLE()    __HAL_RCC_GPIOF_CLK_ENABLE()
00309 #define LCD_TE_CTRL_GPIO_CLK_DISABLE()   __HAL_RCC_GPIOF_CLK_DISABLE()
00310 
00311 /* Backlight control pin */
00312 #define LCD_BL_CTRL_PIN                  GPIO_PIN_1
00313 #define LCD_BL_CTRL_GPIO_PORT            GPIOB
00314 #define LCD_BL_CTRL_GPIO_CLK_ENABLE()    __HAL_RCC_GPIOB_CLK_ENABLE()
00315 #define LCD_BL_CTRL_GPIO_CLK_DISABLE()   __HAL_RCC_GPIOB_CLK_DISABLE()
00316 
00317 /* TS INT pin */
00318 #define TS_INT_PIN                       IO_PIN_9
00319 #define TS_INT_EXTI_IRQn                 EXTI1_IRQn
00320 
00321 /**
00322   * @}
00323   */
00324 
00325 /**
00326   * @}
00327   */
00328 
00329 /** @defgroup STM32L4R9I_DISCOVERY_Exported_Functions Exported Functions
00330   * @{
00331   */
00332 uint32_t                BSP_GetVersion(void);
00333 void                    BSP_LED_Init(Led_TypeDef Led);
00334 void                    BSP_LED_DeInit(Led_TypeDef Led);
00335 void                    BSP_LED_On(Led_TypeDef Led);
00336 void                    BSP_LED_Off(Led_TypeDef Led);
00337 void                    BSP_LED_Toggle(Led_TypeDef Led);
00338 uint8_t                 BSP_JOY_Init(JOYMode_TypeDef Joy_Mode);
00339 void                    BSP_JOY_DeInit(void);
00340 JOYState_TypeDef        BSP_JOY_GetState(void);
00341 #if defined(HAL_UART_MODULE_ENABLED)
00342 void                    BSP_COM_Init(COM_TypeDef COM, UART_HandleTypeDef *husart);
00343 void                    BSP_COM_DeInit(COM_TypeDef COM, UART_HandleTypeDef *huart);
00344 #endif /* HAL_UART_MODULE_ENABLED */
00345 
00346 /* These __weak functions can be surcharged by application code for specific application needs */
00347 void                    BSP_ErrorHandler(void);
00348 
00349 /**
00350   * @}
00351   */
00352 
00353 /**
00354   * @}
00355   */
00356 
00357 /**
00358   * @}
00359   */
00360 
00361 /**
00362   * @}
00363   */
00364 
00365 #ifdef __cplusplus
00366 }
00367 #endif
00368 
00369 #endif /* __STM32L4R9I_DISCOVERY_H */
00370 
00371 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/