You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The **Static Pinmap extension** allows the peripheral configuration (pin/periheral/function) to be staticly specified in the HAL API function.
3
+
The **Static Pinmap extension** allows you to statically specify the peripheral configuration (pin, peripheral or function) in the HAL API function.
4
4
5
-
### Overview and background
5
+
In modern MCUs, you can often map peripherals to different pins, and each pin can have multiple functions. Mbed supports dynamic pin mapping, meaning you can reconfigure pins at run time for different drivers to use. That provides great flexibility, but it's not free. There's a nontrivial ROM cost to maintain the pin map tables and infrastructure to parse it. In some use cases, this flexibility is worth the cost. Often, pin configuration is frozen at the hardware design stage and doesn't require run time modification. Shifting this configuration to compile time allows free memory associated with the dynamic approach.
6
6
7
-
In modern MCUs peripherals often can be mapped to different pins and each pin can have multiple functions. Mbed supports dynamic pin mapping, meaning that pins can be reconfigured at run time to be used by different driver. That provides great flexibility, but it's not free. There's non trivial ROM cost to maintain the pinmap tables and infrastructure to parse it. In some use cases this flexibility is worth the cost. Quite often pin configuration is frozen at hw design stage and doesn't require runtime modification. Shifting this configuration to compile time will allow us free memory associated with the dynamic approach.
8
-
9
-
HAL APIs making use of pins take these pins in their constructor and use those pins to lookup which peripheral/function to use. The process of looking up the peripheral/function requires there to be a pinmap table that maps pins to peripherals/functions. This pinmap table takes up ROM which could be saved if the pinmap wasn't used. Static pinmap extension provides additional HAL API/constructors which takes pinmap as a parameter where pin/peripheral/function is specified staticly and there is no need to use the pinmap tables.
7
+
HAL APIs using pins take these pins in their constructor and use those pins to look up which peripheral or function to use. The process of looking up the peripheral or function requires there to be a pin map table that maps pins to peripherals or functions. This pin map table takes up ROM. Static pinmap extension provides additional HAL API constructors, which take pin map as a parameter where the pin, peripheral or function is specified statically, and there is no need to use the pin map tables.
10
8
11
9
Supported peripherals:
12
-
- `PWM`
13
-
- `AnalogIn`
14
-
- `AnalogOut`
15
-
- `SPI`
16
-
- `I2C`
17
-
- `UART`
18
-
- `QSPI`
19
-
- `CAN`
10
+
11
+
-`PWM`.
12
+
-`AnalogIn`.
13
+
-`AnalogOut`.
14
+
-`SPI`.
15
+
-`I2C`.
16
+
-`UART`.
17
+
-`QSPI`.
18
+
-`CAN`.
20
19
21
-
###Implementing static pin-map extension
20
+
## Implementing static pinmap extension
22
21
23
-
If you want to make static pinmap available on your platform please perform the following steps:
22
+
If you want to make static pin map available on your platform please perform the following steps:
24
23
25
24
- Provide implementation of `xxx_init_direct(xxx_t *obj, static_pinmap_t *)` function and update implementation of `xxx_init()`.
26
-
- `xxx_init()`usees pinmap tables to determine associated peripheral/function with the given pins, populates the pin-map structure and calls void `xxx_init_direct()`.
27
-
- `xxx_init_direct()` performs peripheral initialization using given static pinmap structure.
25
+
-`xxx_init()`uses pin map tables to determine the associated peripheral or function with the given pins, populates the pinmap structure and calls void `xxx_init_direct()`.
26
+
-`xxx_init_direct()` performs peripheral initialization using given static pin map structure.
- Provide `constexpr` pin-map tables in the header file.
55
54
56
-
Move pinmap tables from `PeripheralPins.c` to `PeripheralPinMaps.h` (create new file) and add `constexpr` specifier in the pin-map table declarations.
57
-
The tables are required in the header file, so can be included and used by constant expression utility functions to find and return mapping without pulling the pin-map table into the image.
55
+
Move pin map tables from `PeripheralPins.c` to `PeripheralPinMaps.h` (create new file) and add `constexpr` specifier in the pin map table declarations.
58
56
59
-
**Note:**
60
-
Please include `<mstd_cstddef>` module and use `MSTD_CONSTEXPR_OBJ_11` macro instead `constexpr` specifier. When `PeripheralPinMaps.h` is included from the Mbed OS C++ code, we need to see it as `constexpr`, but if the target code includes it from C, it has to have it as `const`.
57
+
The tables are required in the header file, so constant expression utility functions can include and use them to find and return mapping without pulling the pin map table into the image.
61
58
62
-
Example pin-map table below:
59
+
<spanclass="notes">**Note:** Please include the `<mstd_cstddef>` module, and use the `MSTD_CONSTEXPR_OBJ_11` macro instead of the `constexpr` specifier. When `PeripheralPinMaps.h` is included from the Mbed OS C++ code, we need to see it as `constexpr`, but if the target code includes it from C, it has to have it as `const`.</span>
63
60
64
-
```
65
-
#include <mstd_cstddef>
66
-
67
-
MSTD_CONSTEXPR_OBJ_11 PinMap PinMap_ADC[] = {
68
-
{P0_23, ADC0_SE0, 0},
69
-
{P0_10, ADC0_SE1, 0},
70
-
{P0_31, ADC0_SE3, 0},
71
-
{P1_8, ADC0_SE4, 0},
72
-
{P2_0, ADC0_SE5, 0},
73
-
{P2_13, ADC0_SE6, 0},
74
-
{P2_11, ADC0_SE7, 0},
75
-
{NC , NC , 0}
76
-
};
61
+
Example pin map table:
77
62
78
-
```
63
+
```
64
+
#include <mstd_cstddef>
79
65
80
-
- Provide macros for pin-map tables
66
+
MSTD_CONSTEXPR_OBJ_11 PinMap PinMap_ADC[] = {
67
+
{P0_23, ADC0_SE0, 0},
68
+
{P0_10, ADC0_SE1, 0},
69
+
{P0_31, ADC0_SE3, 0},
70
+
{P1_8, ADC0_SE4, 0},
71
+
{P2_0, ADC0_SE5, 0},
72
+
{P2_13, ADC0_SE6, 0},
73
+
{P2_11, ADC0_SE7, 0},
74
+
{NC , NC , 0}
75
+
};
81
76
82
-
Since pin-map table names are not common across all targets the following macros for available pin-map tables are required in `PeripheralPinMaps.h` file:
77
+
```
83
78
84
-
```
85
-
#define PINMAP_ANALOGIN [PinMap ADC]
86
-
#define PINMAP_ANALOGOUT [PinMap DAC]
87
-
#define PINMAP_I2C_SDA [PinMap I2C SDA]
88
-
#define PINMAP_I2C_SCL [PinMap I2C SCL]
89
-
#define PINMAP_UART_TX [PinMap UART TX]
90
-
#define PINMAP_UART_RX [PinMap UART RX]
91
-
#define PINMAP_UART_CTS [PinMap UART CTS]
92
-
#define PINMAP_UART_RTS [PinMap UART RTS]
93
-
#define PINMAP_SPI_SCLK [PinMap SPI SCLK]
94
-
#define PINMAP_SPI_MOSI [PinMap SPI MOSI]
95
-
#define PINMAP_SPI_MISO [PinMap SPI MISO]
96
-
#define PINMAP_SPI_SSEL [PinMap SPI SSEL]
97
-
#define PINMAP_PWM [PinMap PWM]
98
-
#define PINMAP_QSPI_DATA0 [PinMap QSPI DATA0]
99
-
#define PINMAP_QSPI_DATA1 [PinMap QSPI DATA1]
100
-
#define PINMAP_QSPI_DATA2 [PinMap QSPI DATA2]
101
-
#define PINMAP_QSPI_DATA3 [PinMap QSPI DATA3]
102
-
#define PINMAP_QSPI_SCLK [PinMap QSPI SCLK]
103
-
#define PINMAP_QSPI_SSEL [PinMap QSPI SSEL]
104
-
#define PINMAP_CAN_RD [PinMap CAN RD]
105
-
#define PINMAP_CAN_TD [PinMap CAN RD]
106
-
```
79
+
- Provide macros for pin map tables.
107
80
108
-
- Provide `STATIC_PINMAP_READY` macro in `PinNames.h`
81
+
Because pin map table names are not common across all targets, the following macros for available pin map tables are required in the `PeripheralPinMaps.h`file:
109
82
110
-
Adding this macro will enable the static pin-map support for the target.
83
+
```
84
+
#define PINMAP_ANALOGIN [PinMap ADC]
85
+
#define PINMAP_ANALOGOUT [PinMap DAC]
86
+
#define PINMAP_I2C_SDA [PinMap I2C SDA]
87
+
#define PINMAP_I2C_SCL [PinMap I2C SCL]
88
+
#define PINMAP_UART_TX [PinMap UART TX]
89
+
#define PINMAP_UART_RX [PinMap UART RX]
90
+
#define PINMAP_UART_CTS [PinMap UART CTS]
91
+
#define PINMAP_UART_RTS [PinMap UART RTS]
92
+
#define PINMAP_SPI_SCLK [PinMap SPI SCLK]
93
+
#define PINMAP_SPI_MOSI [PinMap SPI MOSI]
94
+
#define PINMAP_SPI_MISO [PinMap SPI MISO]
95
+
#define PINMAP_SPI_SSEL [PinMap SPI SSEL]
96
+
#define PINMAP_PWM [PinMap PWM]
97
+
#define PINMAP_QSPI_DATA0 [PinMap QSPI DATA0]
98
+
#define PINMAP_QSPI_DATA1 [PinMap QSPI DATA1]
99
+
#define PINMAP_QSPI_DATA2 [PinMap QSPI DATA2]
100
+
#define PINMAP_QSPI_DATA3 [PinMap QSPI DATA3]
101
+
#define PINMAP_QSPI_SCLK [PinMap QSPI SCLK]
102
+
#define PINMAP_QSPI_SSEL [PinMap QSPI SSEL]
103
+
#define PINMAP_CAN_RD [PinMap CAN RD]
104
+
#define PINMAP_CAN_TD [PinMap CAN RD]
105
+
```
111
106
112
-
```
113
-
/* If this macro is defined, then constexpr utility functions for pin-map seach can be used. */
114
-
#define STATIC_PINMAP_READY 1
115
-
```
107
+
- Provide `STATIC_PINMAP_READY` macro in `PinNames.h`
108
+
109
+
Adding this macro enables the static pin map support for the target.
110
+
111
+
```
112
+
/* If this macro is defined, you can use constexpr utility functions for pin map search. */
113
+
#define STATIC_PINMAP_READY 1
114
+
```
116
115
117
-
### Example usage/testing
116
+
##Testing
118
117
119
-
Use code below to check if static pinmap extension works.
118
+
Use the code below to test the static pin map extension:
120
119
121
120
```
122
121
int main()
@@ -136,36 +135,41 @@ int main()
136
135
}
137
136
```
138
137
139
-
When static pinmap extension is used we should get some ROM savings:
138
+
When you use the static pin map extension, you save on ROM:
0 commit comments