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_NUCLEO_F401RE/TARGET_STM/PinNamesTypes.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
170:e95d10626187
mbed library. Release version 158

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 *******************************************************************************
AnnaBridge 156:ff21514d8981 3 * Copyright (c) 2016, STMicroelectronics
AnnaBridge 156:ff21514d8981 4 * All rights reserved.
AnnaBridge 156:ff21514d8981 5 *
AnnaBridge 156:ff21514d8981 6 * Redistribution and use in source and binary forms, with or without
AnnaBridge 156:ff21514d8981 7 * modification, are permitted provided that the following conditions are met:
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 156:ff21514d8981 10 * this list of conditions and the following disclaimer.
AnnaBridge 156:ff21514d8981 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 156:ff21514d8981 12 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 156:ff21514d8981 13 * and/or other materials provided with the distribution.
AnnaBridge 156:ff21514d8981 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 156:ff21514d8981 15 * may be used to endorse or promote products derived from this software
AnnaBridge 156:ff21514d8981 16 * without specific prior written permission.
AnnaBridge 156:ff21514d8981 17 *
AnnaBridge 156:ff21514d8981 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 156:ff21514d8981 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 156:ff21514d8981 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 156:ff21514d8981 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 156:ff21514d8981 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 156:ff21514d8981 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 156:ff21514d8981 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 156:ff21514d8981 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 156:ff21514d8981 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 156:ff21514d8981 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 156:ff21514d8981 28 *******************************************************************************
AnnaBridge 156:ff21514d8981 29 */
AnnaBridge 156:ff21514d8981 30 #ifndef MBED_PINNAMESTYPES_H
AnnaBridge 156:ff21514d8981 31 #define MBED_PINNAMESTYPES_H
AnnaBridge 156:ff21514d8981 32
AnnaBridge 156:ff21514d8981 33 #include "cmsis.h"
AnnaBridge 156:ff21514d8981 34
AnnaBridge 156:ff21514d8981 35 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 36 extern "C" {
AnnaBridge 156:ff21514d8981 37 #endif
AnnaBridge 156:ff21514d8981 38
AnnaBridge 156:ff21514d8981 39 /* STM PIN data as used in pin_function is coded on 32 bits as below
AnnaBridge 156:ff21514d8981 40 * [2:0] Function (like in MODER reg) : Input / Output / Alt / Analog
AnnaBridge 156:ff21514d8981 41 * [3] Output Push-Pull / Open Drain (as in OTYPER reg)
AnnaBridge 156:ff21514d8981 42 * [5:4] as in PUPDR reg: No Pull, Pull-up, Pull-Donc
AnnaBridge 156:ff21514d8981 43 * [7:6] Reserved for speed config (as in OSPEEDR), but not used yet
AnnaBridge 156:ff21514d8981 44 * [11:8] Alternate Num (as in AFRL/AFRG reg)
AnnaBridge 156:ff21514d8981 45 * [16:12] Channel (Analog/Timer specific)
AnnaBridge 156:ff21514d8981 46 * [17] Inverted (Analog/Timer specific)
AnnaBridge 156:ff21514d8981 47 * [18] Analog ADC control - Only valid for specific families
AnnaBridge 156:ff21514d8981 48 * [32:19] Reserved
AnnaBridge 156:ff21514d8981 49 */
AnnaBridge 156:ff21514d8981 50
AnnaBridge 156:ff21514d8981 51 #define STM_PIN_FUNCTION_MASK 0x07
AnnaBridge 156:ff21514d8981 52 #define STM_PIN_FUNCTION_SHIFT 0
AnnaBridge 156:ff21514d8981 53 #define STM_PIN_FUNCTION_BITS (STM_PIN_FUNCTION_MASK << STM_PIN_FUNCTION_SHIFT)
AnnaBridge 156:ff21514d8981 54
AnnaBridge 156:ff21514d8981 55 #define STM_PIN_OD_MASK 0x01
AnnaBridge 156:ff21514d8981 56 #define STM_PIN_OD_SHIFT 3
AnnaBridge 156:ff21514d8981 57 #define STM_PIN_OD_BITS (STM_PIN_OD_MASK << STM_PIN_OD_SHIFT)
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 #define STM_PIN_PUPD_MASK 0x03
AnnaBridge 156:ff21514d8981 60 #define STM_PIN_PUPD_SHIFT 4
AnnaBridge 156:ff21514d8981 61 #define STM_PIN_PUPD_BITS (STM_PIN_PUPD_MASK << STM_PIN_PUPD_SHIFT)
AnnaBridge 156:ff21514d8981 62
AnnaBridge 156:ff21514d8981 63 #define STM_PIN_SPEED_MASK 0x03
AnnaBridge 156:ff21514d8981 64 #define STM_PIN_SPEED_SHIFT 6
AnnaBridge 156:ff21514d8981 65 #define STM_PIN_SPEED_BITS (STM_PIN_SPEED_MASK << STM_PIN_SPEED_SHIFT)
AnnaBridge 156:ff21514d8981 66
AnnaBridge 156:ff21514d8981 67 #define STM_PIN_AFNUM_MASK 0x0F
AnnaBridge 156:ff21514d8981 68 #define STM_PIN_AFNUM_SHIFT 8
AnnaBridge 156:ff21514d8981 69 #define STM_PIN_AFNUM_BITS (STM_PIN_AFNUM_MASK << STM_PIN_AFNUM_SHIFT)
AnnaBridge 156:ff21514d8981 70
AnnaBridge 156:ff21514d8981 71 #define STM_PIN_CHAN_MASK 0x1F
AnnaBridge 156:ff21514d8981 72 #define STM_PIN_CHAN_SHIFT 12
AnnaBridge 156:ff21514d8981 73 #define STM_PIN_CHANNEL_BIT (STM_PIN_CHAN_MASK << STM_PIN_CHAN_SHIFT)
AnnaBridge 156:ff21514d8981 74
AnnaBridge 156:ff21514d8981 75 #define STM_PIN_INV_MASK 0x01
AnnaBridge 156:ff21514d8981 76 #define STM_PIN_INV_SHIFT 17
AnnaBridge 156:ff21514d8981 77 #define STM_PIN_INV_BIT (STM_PIN_INV_MASK << STM_PIN_INV_SHIFT)
AnnaBridge 156:ff21514d8981 78
AnnaBridge 156:ff21514d8981 79 #define STM_PIN_AN_CTRL_MASK 0x01
AnnaBridge 156:ff21514d8981 80 #define STM_PIN_AN_CTRL_SHIFT 18
AnnaBridge 156:ff21514d8981 81 #define STM_PIN_ANALOG_CONTROL_BIT (STM_PIN_AN_CTRL_MASK << STM_PIN_AN_CTRL_SHIFT)
AnnaBridge 156:ff21514d8981 82
AnnaBridge 156:ff21514d8981 83 #define STM_PIN_FUNCTION(X) (((X) >> STM_PIN_FUNCTION_SHIFT) & STM_PIN_FUNCTION_MASK)
AnnaBridge 156:ff21514d8981 84 #define STM_PIN_OD(X) (((X) >> STM_PIN_OD_SHIFT) & STM_PIN_OD_MASK)
AnnaBridge 156:ff21514d8981 85 #define STM_PIN_PUPD(X) (((X) >> STM_PIN_PUPD_SHIFT) & STM_PIN_PUPD_MASK)
AnnaBridge 156:ff21514d8981 86 #define STM_PIN_SPEED(X) (((X) >> STM_PIN_SPEED_SHIFT) & STM_PIN_SPEED_MASK)
AnnaBridge 156:ff21514d8981 87 #define STM_PIN_AFNUM(X) (((X) >> STM_PIN_AFNUM_SHIFT) & STM_PIN_AFNUM_MASK)
AnnaBridge 156:ff21514d8981 88 #define STM_PIN_CHANNEL(X) (((X) >> STM_PIN_CHAN_SHIFT) & STM_PIN_CHAN_MASK)
AnnaBridge 156:ff21514d8981 89 #define STM_PIN_INVERTED(X) (((X) >> STM_PIN_INV_SHIFT) & STM_PIN_INV_MASK)
AnnaBridge 156:ff21514d8981 90 #define STM_PIN_ANALOG_CONTROL(X) (((X) >> STM_PIN_AN_CTRL_SHIFT) & STM_PIN_AN_CTRL_MASK)
AnnaBridge 156:ff21514d8981 91
AnnaBridge 156:ff21514d8981 92 #define STM_PIN_DEFINE(FUNC_OD, PUPD, AFNUM) ((int)(FUNC_OD) |\
AnnaBridge 156:ff21514d8981 93 ((PUPD & STM_PIN_PUPD_MASK) << STM_PIN_PUPD_SHIFT) |\
AnnaBridge 156:ff21514d8981 94 ((AFNUM & STM_PIN_AFNUM_MASK) << STM_PIN_AFNUM_SHIFT))
AnnaBridge 156:ff21514d8981 95
AnnaBridge 156:ff21514d8981 96 #define STM_PIN_DEFINE_EXT(FUNC_OD, PUPD, AFNUM, CHAN, INV) \
AnnaBridge 156:ff21514d8981 97 ((int)(FUNC_OD) |\
AnnaBridge 156:ff21514d8981 98 ((PUPD & STM_PIN_PUPD_MASK) << STM_PIN_PUPD_SHIFT) |\
AnnaBridge 156:ff21514d8981 99 ((AFNUM & STM_PIN_AFNUM_MASK) << STM_PIN_AFNUM_SHIFT) |\
AnnaBridge 156:ff21514d8981 100 ((CHAN & STM_PIN_CHAN_MASK) << STM_PIN_CHAN_SHIFT) |\
AnnaBridge 156:ff21514d8981 101 ((INV & STM_PIN_INV_MASK) << STM_PIN_INV_SHIFT))
AnnaBridge 156:ff21514d8981 102
AnnaBridge 156:ff21514d8981 103 /*
AnnaBridge 156:ff21514d8981 104 * MACROS to support the legacy definition of PIN formats
AnnaBridge 156:ff21514d8981 105 * The STM_MODE_ defines contain the function and the Push-pull/OpenDrain
AnnaBridge 156:ff21514d8981 106 * configuration (legacy inheritance).
AnnaBridge 156:ff21514d8981 107 */
AnnaBridge 156:ff21514d8981 108 #define STM_PIN_DATA(FUNC_OD, PUPD, AFNUM) \
AnnaBridge 156:ff21514d8981 109 STM_PIN_DEFINE(FUNC_OD, PUPD, AFNUM)
AnnaBridge 156:ff21514d8981 110 #define STM_PIN_DATA_EXT(FUNC_OD, PUPD, AFNUM, CHANNEL, INVERTED) \
AnnaBridge 156:ff21514d8981 111 STM_PIN_DEFINE_EXT(FUNC_OD, PUPD, AFNUM, CHANNEL, INVERTED)
AnnaBridge 156:ff21514d8981 112
AnnaBridge 156:ff21514d8981 113 typedef enum {
AnnaBridge 156:ff21514d8981 114 STM_PIN_INPUT = 0,
AnnaBridge 156:ff21514d8981 115 STM_PIN_OUTPUT = 1,
AnnaBridge 156:ff21514d8981 116 STM_PIN_ALTERNATE = 2,
AnnaBridge 156:ff21514d8981 117 STM_PIN_ANALOG = 3,
AnnaBridge 156:ff21514d8981 118 } StmPinFunction;
AnnaBridge 156:ff21514d8981 119
AnnaBridge 156:ff21514d8981 120 #define STM_MODE_INPUT (STM_PIN_INPUT)
AnnaBridge 156:ff21514d8981 121 #define STM_MODE_OUTPUT_PP (STM_PIN_OUTPUT)
AnnaBridge 156:ff21514d8981 122 #define STM_MODE_OUTPUT_OD (STM_PIN_OUTPUT | STM_PIN_OD_BITS)
AnnaBridge 156:ff21514d8981 123 #define STM_MODE_AF_PP (STM_PIN_ALTERNATE)
AnnaBridge 156:ff21514d8981 124 #define STM_MODE_AF_OD (STM_PIN_ALTERNATE | STM_PIN_OD_BITS)
AnnaBridge 156:ff21514d8981 125 #define STM_MODE_ANALOG (STM_PIN_ANALOG)
AnnaBridge 156:ff21514d8981 126 #define STM_MODE_ANALOG_ADC_CONTROL (STM_PIN_ANALOG | STM_PIN_ANALOG_CONTROL_BIT)
AnnaBridge 156:ff21514d8981 127
AnnaBridge 156:ff21514d8981 128 // High nibble = port number (0=A, 1=B, 2=C, 3=D, 4=E, 5=F, 6=G, 7=H)
AnnaBridge 156:ff21514d8981 129 // Low nibble = pin number
AnnaBridge 156:ff21514d8981 130 #define STM_PORT(X) (((uint32_t)(X) >> 4) & 0xF)
AnnaBridge 156:ff21514d8981 131 #define STM_PIN(X) ((uint32_t)(X) & 0xF)
AnnaBridge 156:ff21514d8981 132
AnnaBridge 156:ff21514d8981 133 /* Defines to be used by application */
AnnaBridge 156:ff21514d8981 134 typedef enum {
AnnaBridge 156:ff21514d8981 135 PIN_INPUT = 0,
AnnaBridge 156:ff21514d8981 136 PIN_OUTPUT
AnnaBridge 156:ff21514d8981 137 } PinDirection;
AnnaBridge 156:ff21514d8981 138
AnnaBridge 156:ff21514d8981 139 typedef enum {
AnnaBridge 156:ff21514d8981 140 PullNone = 0,
AnnaBridge 156:ff21514d8981 141 PullUp = 1,
AnnaBridge 156:ff21514d8981 142 PullDown = 2,
AnnaBridge 156:ff21514d8981 143 OpenDrainPullUp = 3,
AnnaBridge 156:ff21514d8981 144 OpenDrainNoPull = 4,
AnnaBridge 156:ff21514d8981 145 OpenDrainPullDown = 5,
AnnaBridge 156:ff21514d8981 146 PushPullNoPull = PullNone,
AnnaBridge 156:ff21514d8981 147 PushPullPullUp = PullUp,
AnnaBridge 156:ff21514d8981 148 PushPullPullDown = PullDown,
AnnaBridge 156:ff21514d8981 149 OpenDrain = OpenDrainPullUp,
AnnaBridge 156:ff21514d8981 150 PullDefault = PullNone
AnnaBridge 156:ff21514d8981 151 } PinMode;
AnnaBridge 156:ff21514d8981 152
AnnaBridge 156:ff21514d8981 153 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 154 }
AnnaBridge 156:ff21514d8981 155 #endif
AnnaBridge 156:ff21514d8981 156
AnnaBridge 156:ff21514d8981 157 #endif
AnnaBridge 156:ff21514d8981 158