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