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_DISCO_F407VG/TARGET_STM/PinNamesTypes.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
161:aa5281ff4a02
Child:
170:e95d10626187
mbed library. Release version 162

Who changed what in which revision?

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