stm32f4xx_nucleo.h

00001 /** 
00002   ******************************************************************************
00003   * @file    stm32f4xx_nucleo.h
00004   * @author  MCD Application Team
00005   * @version V1.1.0
00006   * @date    19-June-2014
00007   * @brief   This file contains definitions for:
00008   *          - LEDs and push-button available on STM32F4XX-Nucleo Kit 
00009   *            from STMicroelectronics
00010   *          - LCD, joystick and microSD available on Adafruit 1.8" TFT LCD 
00011   *            shield (reference ID 802)
00012   ******************************************************************************
00013   * @attention
00014   *
00015   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
00016   *
00017   * Redistribution and use in source and binary forms, with or without modification,
00018   * are permitted provided that the following conditions are met:
00019   *   1. Redistributions of source code must retain the above copyright notice,
00020   *      this list of conditions and the following disclaimer.
00021   *   2. Redistributions in binary form must reproduce the above copyright notice,
00022   *      this list of conditions and the following disclaimer in the documentation
00023   *      and/or other materials provided with the distribution.
00024   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00025   *      may be used to endorse or promote products derived from this software
00026   *      without specific prior written permission.
00027   *
00028   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00029   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00031   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00032   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038   *
00039   ******************************************************************************  
00040   */ 
00041   
00042 /* Define to prevent recursive inclusion -------------------------------------*/
00043 #ifndef __STM32F4XX_NUCLEO_H
00044 #define __STM32F4XX_NUCLEO_H
00045 
00046 #ifdef __cplusplus
00047  extern "C" {
00048 #endif
00049 
00050 /* Includes ------------------------------------------------------------------*/
00051 #include "stm32f4xx_hal.h"
00052    
00053 /** @addtogroup BSP
00054   * @{
00055   */
00056 
00057 /** @addtogroup STM32F4XX_NUCLEO
00058   * @{
00059   */
00060 
00061 /** @addtogroup STM32F4XX_NUCLEO_LOW_LEVEL
00062   * @{
00063   */ 
00064 
00065 /** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Types
00066   * @{
00067   */
00068 typedef enum 
00069 {
00070   LED
00071 }Led_TypeDef;
00072 
00073 typedef enum 
00074 {  
00075   BUTTON_KEY = 0
00076 }Button_TypeDef;
00077 
00078 typedef enum 
00079 {  
00080   BUTTON_MODE_GPIO = 0,
00081   BUTTON_MODE_EXTI = 1
00082 }ButtonMode_TypeDef;
00083 
00084 typedef enum 
00085 { 
00086   JOY_NONE  = 0,
00087   JOY_SEL   = 1,
00088   JOY_DOWN  = 2,
00089   JOY_LEFT  = 3,
00090   JOY_RIGHT = 4,
00091   JOY_UP    = 5
00092 }JOYState_TypeDef;
00093 
00094 /**
00095   * @}
00096   */ 
00097 
00098 /** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Constants
00099   * @{
00100   */ 
00101 
00102 /** 
00103   * @brief Define for STM32F4XX_NUCLEO board  
00104   */ 
00105 #if !defined (USE_STM32F4XX_NUCLEO)
00106  #define USE_STM32F4XX_NUCLEO
00107 #endif
00108 
00109 /** @addtogroup STM32F4XX_NUCLEO_LOW_LEVEL_LED
00110   * @{
00111   */
00112 #define LEDn                                    1
00113 
00114 #define LED2_PIN                                GPIO_PIN_5
00115 #define LED2_GPIO_PORT                          GPIOA
00116 #define LED2_GPIO_CLK_ENABLE()                  __GPIOA_CLK_ENABLE()
00117 #define LED2_GPIO_CLK_DISABLE()                 __GPIOA_CLK_DISABLE()  
00118 
00119 #define LEDx_GPIO_CLK_ENABLE(__INDEX__)   (((__INDEX__) == 0) ? LED2_GPIO_CLK_ENABLE() : 0)
00120 #define LEDx_GPIO_CLK_DISABLE(__INDEX__)  (((__INDEX__) == 0) ? LED2_GPIO_CLK_DISABLE() : 0)
00121 /**
00122   * @}
00123   */ 
00124   
00125 /** @addtogroup STM32F4XX_NUCLEO_LOW_LEVEL_BUTTON
00126   * @{
00127   */  
00128 #define BUTTONn                                 1  
00129 
00130 /**
00131  * @brief Key push-button
00132  */
00133 #define KEY_BUTTON_PIN                          GPIO_PIN_13
00134 #define KEY_BUTTON_GPIO_PORT                    GPIOC
00135 #define KEY_BUTTON_GPIO_CLK_ENABLE()            __GPIOC_CLK_ENABLE()
00136 #define KEY_BUTTON_GPIO_CLK_DISABLE()           __GPIOC_CLK_DISABLE()
00137 #define KEY_BUTTON_EXTI_IRQn                    EXTI15_10_IRQn
00138 
00139 #define BUTTONx_GPIO_CLK_ENABLE(__INDEX__)   (((__INDEX__) == 0) ? KEY_BUTTON_GPIO_CLK_ENABLE() : 0)
00140 #define BUTTONx_GPIO_CLK_DISABLE(__INDEX__)  (((__INDEX__) == 0) ? KEY_BUTTON_GPIO_CLK_DISABLE() : 0)
00141 /**
00142   * @}
00143   */ 
00144 
00145 /** @addtogroup STM32F4XX_NUCLEO_LOW_LEVEL_BUS
00146   * @{
00147   */
00148 /*############################### SPI1 #######################################*/
00149 #define NUCLEO_SPIx                                     SPI1
00150 #define NUCLEO_SPIx_CLK_ENABLE()                        __SPI1_CLK_ENABLE()
00151 
00152 #define NUCLEO_SPIx_SCK_AF                              GPIO_AF5_SPI1
00153 #define NUCLEO_SPIx_SCK_GPIO_PORT                       GPIOA
00154 #define NUCLEO_SPIx_SCK_PIN                             GPIO_PIN_5
00155 #define NUCLEO_SPIx_SCK_GPIO_CLK_ENABLE()               __GPIOA_CLK_ENABLE()
00156 #define NUCLEO_SPIx_SCK_GPIO_CLK_DISABLE()              __GPIOA_CLK_DISABLE()
00157 
00158 #define NUCLEO_SPIx_MISO_MOSI_AF                        GPIO_AF5_SPI1
00159 #define NUCLEO_SPIx_MISO_MOSI_GPIO_PORT                 GPIOA
00160 #define NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_ENABLE()         __GPIOA_CLK_ENABLE()
00161 #define NUCLEO_SPIx_MISO_MOSI_GPIO_CLK_DISABLE()        __GPIOA_CLK_DISABLE()
00162 #define NUCLEO_SPIx_MISO_PIN                            GPIO_PIN_6
00163 #define NUCLEO_SPIx_MOSI_PIN                            GPIO_PIN_7
00164 /* Maximum Timeout values for flags waiting loops. These timeouts are not based
00165    on accurate values, they just guarantee that the application will not remain
00166    stuck if the SPI communication is corrupted.
00167    You may modify these timeout values depending on CPU frequency and application
00168    conditions (interrupts routines ...). */   
00169 #define NUCLEO_SPIx_TIMEOUT_MAX                   1000
00170 
00171 /**
00172   * @brief  SD Control Lines management
00173   */
00174 #define SD_CS_LOW()       HAL_GPIO_WritePin(SD_CS_GPIO_PORT, SD_CS_PIN, GPIO_PIN_RESET)
00175 #define SD_CS_HIGH()      HAL_GPIO_WritePin(SD_CS_GPIO_PORT, SD_CS_PIN, GPIO_PIN_SET)
00176 
00177 /**
00178   * @brief  LCD Control Lines management
00179   */
00180 #define LCD_CS_LOW()      HAL_GPIO_WritePin(LCD_CS_GPIO_PORT, LCD_CS_PIN, GPIO_PIN_RESET)
00181 #define LCD_CS_HIGH()     HAL_GPIO_WritePin(LCD_CS_GPIO_PORT, LCD_CS_PIN, GPIO_PIN_SET)
00182 #define LCD_DC_LOW()      HAL_GPIO_WritePin(LCD_DC_GPIO_PORT, LCD_DC_PIN, GPIO_PIN_RESET)
00183 #define LCD_DC_HIGH()     HAL_GPIO_WritePin(LCD_DC_GPIO_PORT, LCD_DC_PIN, GPIO_PIN_SET)
00184      
00185 /**
00186   * @brief  SD Control Interface pins
00187   */
00188 #define SD_CS_PIN                                 GPIO_PIN_5
00189 #define SD_CS_GPIO_PORT                           GPIOB
00190 #define SD_CS_GPIO_CLK_ENABLE()                 __GPIOB_CLK_ENABLE()
00191 #define SD_CS_GPIO_CLK_DISABLE()                __GPIOB_CLK_DISABLE()
00192 
00193 /**
00194   * @brief  LCD Control Interface pins
00195   */
00196 #define LCD_CS_PIN                                 GPIO_PIN_6
00197 #define LCD_CS_GPIO_PORT                           GPIOB
00198 #define LCD_CS_GPIO_CLK_ENABLE()                 __GPIOB_CLK_ENABLE()
00199 #define LCD_CS_GPIO_CLK_DISABLE()                __GPIOB_CLK_DISABLE()
00200     
00201 /**
00202   * @brief  LCD Data/Command Interface pins
00203   */
00204 #define LCD_DC_PIN                                 GPIO_PIN_9
00205 #define LCD_DC_GPIO_PORT                           GPIOA
00206 #define LCD_DC_GPIO_CLK_ENABLE()                 __GPIOA_CLK_ENABLE()
00207 #define LCD_DC_GPIO_CLK_DISABLE()                __GPIOA_CLK_DISABLE()
00208 
00209 /*################################ ADC1 ######################################*/
00210 /**
00211   * @brief  ADC Interface pins
00212   *         used to detect motion of Joystick available on Adafruit 1.8" TFT shield
00213   */
00214 #define NUCLEO_ADCx                                 ADC1
00215 #define NUCLEO_ADCx_CLK_ENABLE()                  __ADC1_CLK_ENABLE()
00216 
00217 #define NUCLEO_ADCx_CHANNEL                       ADC_CHANNEL_8
00218    
00219 #define NUCLEO_ADCx_GPIO_PORT                       GPIOB
00220 #define NUCLEO_ADCx_GPIO_PIN                        GPIO_PIN_0
00221 #define NUCLEO_ADCx_GPIO_CLK_ENABLE()             __GPIOB_CLK_ENABLE()
00222 #define NUCLEO_ADCx_GPIO_CLK_DISABLE()            __GPIOB_CLK_DISABLE()
00223 /**
00224   * @}
00225   */
00226 
00227 /**
00228   * @}
00229   */
00230 
00231 /** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Macros
00232   * @{
00233   */  
00234 /**
00235   * @}
00236   */ 
00237 
00238 /** @defgroup STM32F4XX_NUCLEO_LOW_LEVEL_Exported_Functions
00239   * @{
00240   */
00241 uint32_t         BSP_GetVersion(void);  
00242 void             BSP_LED_Init(Led_TypeDef Led);
00243 void             BSP_LED_On(Led_TypeDef Led);
00244 void             BSP_LED_Off(Led_TypeDef Led);
00245 void             BSP_LED_Toggle(Led_TypeDef Led);
00246 void             BSP_PB_Init(Button_TypeDef Button, ButtonMode_TypeDef ButtonMode);
00247 uint32_t         BSP_PB_GetState(Button_TypeDef Button);
00248 uint8_t          BSP_JOY_Init(void);
00249 JOYState_TypeDef BSP_JOY_GetState(void);
00250   
00251 /**
00252   * @}
00253   */ 
00254 
00255 /**
00256   * @}
00257   */ 
00258 
00259 /**
00260   * @}
00261   */
00262 
00263 /**
00264   * @}
00265   */
00266 
00267 #ifdef __cplusplus
00268 }
00269 #endif
00270 
00271 #endif /* __STM32F4XX_NUCLEO_H */
00272 
00273 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/