mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_SAKURAIO_EVB_01/TARGET_STM/TARGET_STM32F4/pin_device.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
160:5571c4ff569f 
mbed library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 160:5571c4ff569f 1 /* mbed Microcontroller Library
Anna Bridge 160:5571c4ff569f 2 *******************************************************************************
Anna Bridge 160:5571c4ff569f 3 * Copyright (c) 2016, STMicroelectronics
Anna Bridge 160:5571c4ff569f 4 * All rights reserved.
Anna Bridge 160:5571c4ff569f 5 *
Anna Bridge 160:5571c4ff569f 6 * Redistribution and use in source and binary forms, with or without
Anna Bridge 160:5571c4ff569f 7 * modification, are permitted provided that the following conditions are met:
Anna Bridge 160:5571c4ff569f 8 *
Anna Bridge 160:5571c4ff569f 9 * 1. Redistributions of source code must retain the above copyright notice,
Anna Bridge 160:5571c4ff569f 10 * this list of conditions and the following disclaimer.
Anna Bridge 160:5571c4ff569f 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
Anna Bridge 160:5571c4ff569f 12 * this list of conditions and the following disclaimer in the documentation
Anna Bridge 160:5571c4ff569f 13 * and/or other materials provided with the distribution.
Anna Bridge 160:5571c4ff569f 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Anna Bridge 160:5571c4ff569f 15 * may be used to endorse or promote products derived from this software
Anna Bridge 160:5571c4ff569f 16 * without specific prior written permission.
Anna Bridge 160:5571c4ff569f 17 *
Anna Bridge 160:5571c4ff569f 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Anna Bridge 160:5571c4ff569f 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Anna Bridge 160:5571c4ff569f 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Anna Bridge 160:5571c4ff569f 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Anna Bridge 160:5571c4ff569f 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Anna Bridge 160:5571c4ff569f 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Anna Bridge 160:5571c4ff569f 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Anna Bridge 160:5571c4ff569f 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Anna Bridge 160:5571c4ff569f 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Anna Bridge 160:5571c4ff569f 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Anna Bridge 160:5571c4ff569f 28 *******************************************************************************
Anna Bridge 160:5571c4ff569f 29 */
Anna Bridge 160:5571c4ff569f 30 #ifndef MBED_PIN_DEVICE_H
Anna Bridge 160:5571c4ff569f 31 #define MBED_PIN_DEVICE_H
Anna Bridge 160:5571c4ff569f 32
Anna Bridge 160:5571c4ff569f 33 #include "cmsis.h"
Anna Bridge 160:5571c4ff569f 34
Anna Bridge 160:5571c4ff569f 35 // when LL is available, below include can be used
Anna Bridge 160:5571c4ff569f 36 // #include "stm32f4xx_ll_gpio.h"
Anna Bridge 160:5571c4ff569f 37 // until then let's define locally the required functions
Anna Bridge 160:5571c4ff569f 38 #define LL_GPIO_PIN_0 GPIO_BSRR_BS_0 /*!< Select pin 0 */
Anna Bridge 160:5571c4ff569f 39 #define LL_GPIO_PIN_1 GPIO_BSRR_BS_1 /*!< Select pin 1 */
Anna Bridge 160:5571c4ff569f 40 #define LL_GPIO_PIN_2 GPIO_BSRR_BS_2 /*!< Select pin 2 */
Anna Bridge 160:5571c4ff569f 41 #define LL_GPIO_PIN_3 GPIO_BSRR_BS_3 /*!< Select pin 3 */
Anna Bridge 160:5571c4ff569f 42 #define LL_GPIO_PIN_4 GPIO_BSRR_BS_4 /*!< Select pin 4 */
Anna Bridge 160:5571c4ff569f 43 #define LL_GPIO_PIN_5 GPIO_BSRR_BS_5 /*!< Select pin 5 */
Anna Bridge 160:5571c4ff569f 44 #define LL_GPIO_PIN_6 GPIO_BSRR_BS_6 /*!< Select pin 6 */
Anna Bridge 160:5571c4ff569f 45 #define LL_GPIO_PIN_7 GPIO_BSRR_BS_7 /*!< Select pin 7 */
Anna Bridge 160:5571c4ff569f 46 #define LL_GPIO_PIN_8 GPIO_BSRR_BS_8 /*!< Select pin 8 */
Anna Bridge 160:5571c4ff569f 47 #define LL_GPIO_PIN_9 GPIO_BSRR_BS_9 /*!< Select pin 9 */
Anna Bridge 160:5571c4ff569f 48 #define LL_GPIO_PIN_10 GPIO_BSRR_BS_10 /*!< Select pin 10 */
Anna Bridge 160:5571c4ff569f 49 #define LL_GPIO_PIN_11 GPIO_BSRR_BS_11 /*!< Select pin 11 */
Anna Bridge 160:5571c4ff569f 50 #define LL_GPIO_PIN_12 GPIO_BSRR_BS_12 /*!< Select pin 12 */
Anna Bridge 160:5571c4ff569f 51 #define LL_GPIO_PIN_13 GPIO_BSRR_BS_13 /*!< Select pin 13 */
Anna Bridge 160:5571c4ff569f 52 #define LL_GPIO_PIN_14 GPIO_BSRR_BS_14 /*!< Select pin 14 */
Anna Bridge 160:5571c4ff569f 53 #define LL_GPIO_PIN_15 GPIO_BSRR_BS_15 /*!< Select pin 15 */
Anna Bridge 160:5571c4ff569f 54
Anna Bridge 160:5571c4ff569f 55 #define LL_GPIO_MODE_INPUT ((uint32_t)0x00000000U) /*!< Select input mode */
Anna Bridge 160:5571c4ff569f 56 #define LL_GPIO_MODE_OUTPUT GPIO_MODER_MODER0_0 /*!< Select output mode */
Anna Bridge 160:5571c4ff569f 57 #define LL_GPIO_MODE_ALTERNATE GPIO_MODER_MODER0_1 /*!< Select alternate function mode */
Anna Bridge 160:5571c4ff569f 58 #define LL_GPIO_MODE_ANALOG GPIO_MODER_MODER0 /*!< Select analog mode */
Anna Bridge 160:5571c4ff569f 59
Anna Bridge 160:5571c4ff569f 60 #define LL_GPIO_OUTPUT_PUSHPULL ((uint32_t)0x00000000U) /*!< Select push-pull as output type */
Anna Bridge 160:5571c4ff569f 61 #define LL_GPIO_OUTPUT_OPENDRAIN GPIO_OTYPER_OT_0 /*!< Select open-drain as output type */
Anna Bridge 160:5571c4ff569f 62
Anna Bridge 160:5571c4ff569f 63 #define LL_GPIO_PULL_NO ((uint32_t)0x00000000U) /*!< Select I/O no pull */
Anna Bridge 160:5571c4ff569f 64 #define LL_GPIO_PULL_UP GPIO_PUPDR_PUPDR0_0 /*!< Select I/O pull up */
Anna Bridge 160:5571c4ff569f 65 #define LL_GPIO_PULL_DOWN GPIO_PUPDR_PUPDR0_1 /*!< Select I/O pull down */
Anna Bridge 160:5571c4ff569f 66
Anna Bridge 160:5571c4ff569f 67 #define LL_GPIO_SPEED_FREQ_LOW ((uint32_t)0x00000000U) /*!< Select I/O low output speed */
Anna Bridge 160:5571c4ff569f 68 #define LL_GPIO_SPEED_FREQ_MEDIUM GPIO_OSPEEDER_OSPEEDR0_0 /*!< Select I/O medium output speed */
Anna Bridge 160:5571c4ff569f 69 #define LL_GPIO_SPEED_FREQ_HIGH GPIO_OSPEEDER_OSPEEDR0_1 /*!< Select I/O fast output speed */
Anna Bridge 160:5571c4ff569f 70 #define LL_GPIO_SPEED_FREQ_VERY_HIGH GPIO_OSPEEDER_OSPEEDR0 /*!< Select I/O high output speed */
Anna Bridge 160:5571c4ff569f 71
Anna Bridge 160:5571c4ff569f 72 __STATIC_INLINE void LL_GPIO_SetAFPin_0_7(GPIO_TypeDef *GPIOx, uint32_t Pin, uint32_t Alternate)
Anna Bridge 160:5571c4ff569f 73 {
AnnaBridge 170:e95d10626187 74 MODIFY_REG(GPIOx->AFR[0], (0xFU << (POSITION_VAL(Pin) * 4U)),
AnnaBridge 170:e95d10626187 75 (Alternate << (POSITION_VAL(Pin) * 4U)));
Anna Bridge 160:5571c4ff569f 76 }
Anna Bridge 160:5571c4ff569f 77 __STATIC_INLINE void LL_GPIO_SetAFPin_8_15(GPIO_TypeDef *GPIOx, uint32_t Pin, uint32_t Alternate)
Anna Bridge 160:5571c4ff569f 78 {
AnnaBridge 170:e95d10626187 79 MODIFY_REG(GPIOx->AFR[1], (0xFU << (POSITION_VAL(Pin >> 8U) * 4U)),
AnnaBridge 170:e95d10626187 80 (Alternate << (POSITION_VAL(Pin >> 8U) * 4U)));
Anna Bridge 160:5571c4ff569f 81 }
Anna Bridge 160:5571c4ff569f 82 __STATIC_INLINE void LL_GPIO_SetPinMode(GPIO_TypeDef *GPIOx, uint32_t Pin, uint32_t Mode)
Anna Bridge 160:5571c4ff569f 83 {
AnnaBridge 170:e95d10626187 84 MODIFY_REG(GPIOx->MODER, (GPIO_MODER_MODER0 << (POSITION_VAL(Pin) * 2U)), (Mode << (POSITION_VAL(Pin) * 2U)));
Anna Bridge 160:5571c4ff569f 85 }
Anna Bridge 160:5571c4ff569f 86 __STATIC_INLINE uint32_t LL_GPIO_GetPinMode(GPIO_TypeDef *GPIOx, uint32_t Pin)
Anna Bridge 160:5571c4ff569f 87 {
AnnaBridge 170:e95d10626187 88 return (uint32_t)(READ_BIT(GPIOx->MODER, ((Pin * Pin) * GPIO_MODER_MODER0)) / (Pin * Pin));
Anna Bridge 160:5571c4ff569f 89 }
Anna Bridge 160:5571c4ff569f 90 __STATIC_INLINE void LL_GPIO_SetPinPull(GPIO_TypeDef *GPIOx, uint32_t Pin, uint32_t Pull)
Anna Bridge 160:5571c4ff569f 91 {
AnnaBridge 170:e95d10626187 92 MODIFY_REG(GPIOx->PUPDR, (GPIO_PUPDR_PUPDR0 << (POSITION_VAL(Pin) * 2U)), (Pull << (POSITION_VAL(Pin) * 2U)));
Anna Bridge 160:5571c4ff569f 93 }
Anna Bridge 160:5571c4ff569f 94 __STATIC_INLINE void LL_GPIO_SetPinOutputType(GPIO_TypeDef *GPIOx, uint32_t PinMask, uint32_t OutputType)
Anna Bridge 160:5571c4ff569f 95 {
AnnaBridge 170:e95d10626187 96 MODIFY_REG(GPIOx->OTYPER, PinMask, (PinMask * OutputType));
Anna Bridge 160:5571c4ff569f 97 }
Anna Bridge 160:5571c4ff569f 98 __STATIC_INLINE void LL_GPIO_SetPinSpeed(GPIO_TypeDef *GPIOx, uint32_t Pin, uint32_t Speed)
Anna Bridge 160:5571c4ff569f 99 {
AnnaBridge 170:e95d10626187 100 MODIFY_REG(GPIOx->OSPEEDR, (GPIO_OSPEEDER_OSPEEDR0 << (POSITION_VAL(Pin) * 2U)),
AnnaBridge 170:e95d10626187 101 (Speed << (POSITION_VAL(Pin) * 2U)));
Anna Bridge 160:5571c4ff569f 102 }
Anna Bridge 160:5571c4ff569f 103 // Above lines shall be defined in LL when available
Anna Bridge 160:5571c4ff569f 104
Anna Bridge 160:5571c4ff569f 105 extern const uint32_t ll_pin_defines[16];
Anna Bridge 160:5571c4ff569f 106
Anna Bridge 160:5571c4ff569f 107 /* Family specific implementations */
Anna Bridge 160:5571c4ff569f 108 static inline void stm_pin_DisconnectDebug(PinName pin)
Anna Bridge 160:5571c4ff569f 109 {
Anna Bridge 160:5571c4ff569f 110 /* empty for now */
Anna Bridge 160:5571c4ff569f 111 }
Anna Bridge 160:5571c4ff569f 112
Anna Bridge 160:5571c4ff569f 113 static inline void stm_pin_PullConfig(GPIO_TypeDef *gpio, uint32_t ll_pin, uint32_t pull_config)
Anna Bridge 160:5571c4ff569f 114 {
Anna Bridge 160:5571c4ff569f 115 switch (pull_config) {
Anna Bridge 160:5571c4ff569f 116 case GPIO_PULLUP:
Anna Bridge 160:5571c4ff569f 117 LL_GPIO_SetPinPull(gpio, ll_pin, LL_GPIO_PULL_UP);
Anna Bridge 160:5571c4ff569f 118 break;
Anna Bridge 160:5571c4ff569f 119 case GPIO_PULLDOWN:
Anna Bridge 160:5571c4ff569f 120 LL_GPIO_SetPinPull(gpio, ll_pin, LL_GPIO_PULL_DOWN);
Anna Bridge 160:5571c4ff569f 121 break;
Anna Bridge 160:5571c4ff569f 122 default:
Anna Bridge 160:5571c4ff569f 123 LL_GPIO_SetPinPull(gpio, ll_pin, LL_GPIO_PULL_NO);
Anna Bridge 160:5571c4ff569f 124 break;
Anna Bridge 160:5571c4ff569f 125 }
Anna Bridge 160:5571c4ff569f 126 }
Anna Bridge 160:5571c4ff569f 127
AnnaBridge 170:e95d10626187 128 static inline void stm_pin_SetAFPin(GPIO_TypeDef *gpio, PinName pin, uint32_t afnum)
Anna Bridge 160:5571c4ff569f 129 {
Anna Bridge 160:5571c4ff569f 130 uint32_t ll_pin = ll_pin_defines[STM_PIN(pin)];
Anna Bridge 160:5571c4ff569f 131
AnnaBridge 170:e95d10626187 132 if (STM_PIN(pin) > 7) {
Anna Bridge 160:5571c4ff569f 133 LL_GPIO_SetAFPin_8_15(gpio, ll_pin, afnum);
AnnaBridge 170:e95d10626187 134 } else {
Anna Bridge 160:5571c4ff569f 135 LL_GPIO_SetAFPin_0_7(gpio, ll_pin, afnum);
AnnaBridge 170:e95d10626187 136 }
Anna Bridge 160:5571c4ff569f 137 }
Anna Bridge 160:5571c4ff569f 138
Anna Bridge 160:5571c4ff569f 139 #endif