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/PinNamesTypes.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_PINNAMESTYPES_H
Anna Bridge 160:5571c4ff569f 31 #define MBED_PINNAMESTYPES_H
Anna Bridge 160:5571c4ff569f 32
Anna Bridge 160:5571c4ff569f 33 #include "cmsis.h"
Anna Bridge 160:5571c4ff569f 34
Anna Bridge 160:5571c4ff569f 35 #ifdef __cplusplus
Anna Bridge 160:5571c4ff569f 36 extern "C" {
Anna Bridge 160:5571c4ff569f 37 #endif
Anna Bridge 160:5571c4ff569f 38
Anna Bridge 160:5571c4ff569f 39 /* STM PIN data as used in pin_function is coded on 32 bits as below
AnnaBridge 170:e95d10626187 40 * [2:0] Function (like in MODER reg) : Input / Output / Alt / Analog
Anna Bridge 160:5571c4ff569f 41 * [3] Output Push-Pull / Open Drain (as in OTYPER reg)
Anna Bridge 160:5571c4ff569f 42 * [5:4] as in PUPDR reg: No Pull, Pull-up, Pull-Donc
Anna Bridge 160:5571c4ff569f 43 * [7:6] Reserved for speed config (as in OSPEEDR), but not used yet
Anna Bridge 160:5571c4ff569f 44 * [11:8] Alternate Num (as in AFRL/AFRG reg)
Anna Bridge 160:5571c4ff569f 45 * [16:12] Channel (Analog/Timer specific)
Anna Bridge 160:5571c4ff569f 46 * [17] Inverted (Analog/Timer specific)
Anna Bridge 160:5571c4ff569f 47 * [18] Analog ADC control - Only valid for specific families
Anna Bridge 160:5571c4ff569f 48 * [32:19] Reserved
Anna Bridge 160:5571c4ff569f 49 */
Anna Bridge 160:5571c4ff569f 50
Anna Bridge 160:5571c4ff569f 51 #define STM_PIN_FUNCTION_MASK 0x07
Anna Bridge 160:5571c4ff569f 52 #define STM_PIN_FUNCTION_SHIFT 0
Anna Bridge 160:5571c4ff569f 53 #define STM_PIN_FUNCTION_BITS (STM_PIN_FUNCTION_MASK << STM_PIN_FUNCTION_SHIFT)
Anna Bridge 160:5571c4ff569f 54
Anna Bridge 160:5571c4ff569f 55 #define STM_PIN_OD_MASK 0x01
Anna Bridge 160:5571c4ff569f 56 #define STM_PIN_OD_SHIFT 3
Anna Bridge 160:5571c4ff569f 57 #define STM_PIN_OD_BITS (STM_PIN_OD_MASK << STM_PIN_OD_SHIFT)
Anna Bridge 160:5571c4ff569f 58
Anna Bridge 160:5571c4ff569f 59 #define STM_PIN_PUPD_MASK 0x03
Anna Bridge 160:5571c4ff569f 60 #define STM_PIN_PUPD_SHIFT 4
Anna Bridge 160:5571c4ff569f 61 #define STM_PIN_PUPD_BITS (STM_PIN_PUPD_MASK << STM_PIN_PUPD_SHIFT)
Anna Bridge 160:5571c4ff569f 62
Anna Bridge 160:5571c4ff569f 63 #define STM_PIN_SPEED_MASK 0x03
Anna Bridge 160:5571c4ff569f 64 #define STM_PIN_SPEED_SHIFT 6
Anna Bridge 160:5571c4ff569f 65 #define STM_PIN_SPEED_BITS (STM_PIN_SPEED_MASK << STM_PIN_SPEED_SHIFT)
Anna Bridge 160:5571c4ff569f 66
Anna Bridge 160:5571c4ff569f 67 #define STM_PIN_AFNUM_MASK 0x0F
Anna Bridge 160:5571c4ff569f 68 #define STM_PIN_AFNUM_SHIFT 8
Anna Bridge 160:5571c4ff569f 69 #define STM_PIN_AFNUM_BITS (STM_PIN_AFNUM_MASK << STM_PIN_AFNUM_SHIFT)
Anna Bridge 160:5571c4ff569f 70
Anna Bridge 160:5571c4ff569f 71 #define STM_PIN_CHAN_MASK 0x1F
Anna Bridge 160:5571c4ff569f 72 #define STM_PIN_CHAN_SHIFT 12
Anna Bridge 160:5571c4ff569f 73 #define STM_PIN_CHANNEL_BIT (STM_PIN_CHAN_MASK << STM_PIN_CHAN_SHIFT)
Anna Bridge 160:5571c4ff569f 74
Anna Bridge 160:5571c4ff569f 75 #define STM_PIN_INV_MASK 0x01
Anna Bridge 160:5571c4ff569f 76 #define STM_PIN_INV_SHIFT 17
Anna Bridge 160:5571c4ff569f 77 #define STM_PIN_INV_BIT (STM_PIN_INV_MASK << STM_PIN_INV_SHIFT)
Anna Bridge 160:5571c4ff569f 78
Anna Bridge 160:5571c4ff569f 79 #define STM_PIN_AN_CTRL_MASK 0x01
Anna Bridge 160:5571c4ff569f 80 #define STM_PIN_AN_CTRL_SHIFT 18
Anna Bridge 160:5571c4ff569f 81 #define STM_PIN_ANALOG_CONTROL_BIT (STM_PIN_AN_CTRL_MASK << STM_PIN_AN_CTRL_SHIFT)
Anna Bridge 160:5571c4ff569f 82
Anna Bridge 160:5571c4ff569f 83 #define STM_PIN_FUNCTION(X) (((X) >> STM_PIN_FUNCTION_SHIFT) & STM_PIN_FUNCTION_MASK)
Anna Bridge 160:5571c4ff569f 84 #define STM_PIN_OD(X) (((X) >> STM_PIN_OD_SHIFT) & STM_PIN_OD_MASK)
Anna Bridge 160:5571c4ff569f 85 #define STM_PIN_PUPD(X) (((X) >> STM_PIN_PUPD_SHIFT) & STM_PIN_PUPD_MASK)
Anna Bridge 160:5571c4ff569f 86 #define STM_PIN_SPEED(X) (((X) >> STM_PIN_SPEED_SHIFT) & STM_PIN_SPEED_MASK)
Anna Bridge 160:5571c4ff569f 87 #define STM_PIN_AFNUM(X) (((X) >> STM_PIN_AFNUM_SHIFT) & STM_PIN_AFNUM_MASK)
Anna Bridge 160:5571c4ff569f 88 #define STM_PIN_CHANNEL(X) (((X) >> STM_PIN_CHAN_SHIFT) & STM_PIN_CHAN_MASK)
Anna Bridge 160:5571c4ff569f 89 #define STM_PIN_INVERTED(X) (((X) >> STM_PIN_INV_SHIFT) & STM_PIN_INV_MASK)
Anna Bridge 160:5571c4ff569f 90 #define STM_PIN_ANALOG_CONTROL(X) (((X) >> STM_PIN_AN_CTRL_SHIFT) & STM_PIN_AN_CTRL_MASK)
Anna Bridge 160:5571c4ff569f 91
Anna Bridge 160:5571c4ff569f 92 #define STM_PIN_DEFINE(FUNC_OD, PUPD, AFNUM) ((int)(FUNC_OD) |\
Anna Bridge 160:5571c4ff569f 93 ((PUPD & STM_PIN_PUPD_MASK) << STM_PIN_PUPD_SHIFT) |\
Anna Bridge 160:5571c4ff569f 94 ((AFNUM & STM_PIN_AFNUM_MASK) << STM_PIN_AFNUM_SHIFT))
Anna Bridge 160:5571c4ff569f 95
Anna Bridge 160:5571c4ff569f 96 #define STM_PIN_DEFINE_EXT(FUNC_OD, PUPD, AFNUM, CHAN, INV) \
Anna Bridge 160:5571c4ff569f 97 ((int)(FUNC_OD) |\
Anna Bridge 160:5571c4ff569f 98 ((PUPD & STM_PIN_PUPD_MASK) << STM_PIN_PUPD_SHIFT) |\
Anna Bridge 160:5571c4ff569f 99 ((AFNUM & STM_PIN_AFNUM_MASK) << STM_PIN_AFNUM_SHIFT) |\
Anna Bridge 160:5571c4ff569f 100 ((CHAN & STM_PIN_CHAN_MASK) << STM_PIN_CHAN_SHIFT) |\
Anna Bridge 160:5571c4ff569f 101 ((INV & STM_PIN_INV_MASK) << STM_PIN_INV_SHIFT))
Anna Bridge 160:5571c4ff569f 102
Anna Bridge 160:5571c4ff569f 103 /*
Anna Bridge 160:5571c4ff569f 104 * MACROS to support the legacy definition of PIN formats
Anna Bridge 160:5571c4ff569f 105 * The STM_MODE_ defines contain the function and the Push-pull/OpenDrain
Anna Bridge 160:5571c4ff569f 106 * configuration (legacy inheritance).
Anna Bridge 160:5571c4ff569f 107 */
Anna Bridge 160:5571c4ff569f 108 #define STM_PIN_DATA(FUNC_OD, PUPD, AFNUM) \
Anna Bridge 160:5571c4ff569f 109 STM_PIN_DEFINE(FUNC_OD, PUPD, AFNUM)
Anna Bridge 160:5571c4ff569f 110 #define STM_PIN_DATA_EXT(FUNC_OD, PUPD, AFNUM, CHANNEL, INVERTED) \
Anna Bridge 160:5571c4ff569f 111 STM_PIN_DEFINE_EXT(FUNC_OD, PUPD, AFNUM, CHANNEL, INVERTED)
Anna Bridge 160:5571c4ff569f 112
Anna Bridge 160:5571c4ff569f 113 typedef enum {
Anna Bridge 160:5571c4ff569f 114 STM_PIN_INPUT = 0,
Anna Bridge 160:5571c4ff569f 115 STM_PIN_OUTPUT = 1,
Anna Bridge 160:5571c4ff569f 116 STM_PIN_ALTERNATE = 2,
Anna Bridge 160:5571c4ff569f 117 STM_PIN_ANALOG = 3,
Anna Bridge 160:5571c4ff569f 118 } StmPinFunction;
Anna Bridge 160:5571c4ff569f 119
Anna Bridge 160:5571c4ff569f 120 #define STM_MODE_INPUT (STM_PIN_INPUT)
Anna Bridge 160:5571c4ff569f 121 #define STM_MODE_OUTPUT_PP (STM_PIN_OUTPUT)
Anna Bridge 160:5571c4ff569f 122 #define STM_MODE_OUTPUT_OD (STM_PIN_OUTPUT | STM_PIN_OD_BITS)
Anna Bridge 160:5571c4ff569f 123 #define STM_MODE_AF_PP (STM_PIN_ALTERNATE)
Anna Bridge 160:5571c4ff569f 124 #define STM_MODE_AF_OD (STM_PIN_ALTERNATE | STM_PIN_OD_BITS)
Anna Bridge 160:5571c4ff569f 125 #define STM_MODE_ANALOG (STM_PIN_ANALOG)
Anna Bridge 160:5571c4ff569f 126 #define STM_MODE_ANALOG_ADC_CONTROL (STM_PIN_ANALOG | STM_PIN_ANALOG_CONTROL_BIT)
Anna Bridge 160:5571c4ff569f 127
Anna Bridge 160:5571c4ff569f 128 // High nibble = port number (0=A, 1=B, 2=C, 3=D, 4=E, 5=F, 6=G, 7=H)
Anna Bridge 160:5571c4ff569f 129 // Low nibble = pin number
Anna Bridge 160:5571c4ff569f 130 #define STM_PORT(X) (((uint32_t)(X) >> 4) & 0xF)
Anna Bridge 160:5571c4ff569f 131 #define STM_PIN(X) ((uint32_t)(X) & 0xF)
Anna Bridge 160:5571c4ff569f 132
Anna Bridge 160:5571c4ff569f 133 /* Defines to be used by application */
Anna Bridge 160:5571c4ff569f 134 typedef enum {
Anna Bridge 160:5571c4ff569f 135 PIN_INPUT = 0,
Anna Bridge 160:5571c4ff569f 136 PIN_OUTPUT
Anna Bridge 160:5571c4ff569f 137 } PinDirection;
Anna Bridge 160:5571c4ff569f 138
Anna Bridge 160:5571c4ff569f 139 typedef enum {
Anna Bridge 160:5571c4ff569f 140 PullNone = 0,
Anna Bridge 160:5571c4ff569f 141 PullUp = 1,
Anna Bridge 160:5571c4ff569f 142 PullDown = 2,
Anna Bridge 160:5571c4ff569f 143 OpenDrainPullUp = 3,
Anna Bridge 160:5571c4ff569f 144 OpenDrainNoPull = 4,
Anna Bridge 160:5571c4ff569f 145 OpenDrainPullDown = 5,
Anna Bridge 160:5571c4ff569f 146 PushPullNoPull = PullNone,
Anna Bridge 160:5571c4ff569f 147 PushPullPullUp = PullUp,
Anna Bridge 160:5571c4ff569f 148 PushPullPullDown = PullDown,
Anna Bridge 160:5571c4ff569f 149 OpenDrain = OpenDrainPullUp,
Anna Bridge 160:5571c4ff569f 150 PullDefault = PullNone
Anna Bridge 160:5571c4ff569f 151 } PinMode;
Anna Bridge 160:5571c4ff569f 152
Anna Bridge 160:5571c4ff569f 153 #ifdef __cplusplus
Anna Bridge 160:5571c4ff569f 154 }
Anna Bridge 160:5571c4ff569f 155 #endif
Anna Bridge 160:5571c4ff569f 156
Anna Bridge 160:5571c4ff569f 157 #endif
Anna Bridge 160:5571c4ff569f 158