Add the porting guide for the explicit pin-map extension.

docs/porting/target/static_pinmap.md

@@ -0,0 +1,183 @@
+<h2 id="static-pinmap-port">Static Pinmap extension</h2>
+
+The **Static Pinmap extension** allows the peripheral configuration (pin/periheral/function) to be staticly specified in the HAL API function.
+
+### Overview and background
+
+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.
+
+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.
+
+Supported peripherals:
+ - `PWM`
+ - `AnalogIn`
+ - `AnalogOut`
+ - `SPI`
+ - `I2C`
+ - `UART`
+ - `QSPI`
+ - `CAN`
+
+### Requirements and assumptions
+
+1. Provide types which will hold static pinmaps for peripherals(`PWM`, `AnalogIn`, `AnalogOut`, `SPI`, `I2C`, `UART`, `QSPI`, `CAN`).
+2. Provide `xxx_init_direct(xxx_t *obj, static_pinmap_t *)` functions to HAL API (these functions will not use pinmap tables).
+3. Provide additional constructors in drivers layer which will use the `xxx_init_direct(xxx_t *obj, static_pinmap_t*)` HAL functions.
+4. Provide default weak implementations of `xxx_init_direct(static_pinmap_t *)` functions. These functions will call standard `xxx_init(xxx_t *obj, PinName, ...)` function (backward compatibility for targets which do not support static pinmap mechanism).
+5. Provide `constexpr` utility functions to lookup for pin mapping in compile time (requires C++14).
+6. Provide `constexpr` pin-map tables in the header file.
+7. Provide macros for the pin-map tables.
+8. Provide `STATIC_PINMAP_READY` macro in `PinNames.h`.
+
+### Implementing static pin-map extension
+
+Most of the above points are already implemented. If you want to make static pinmap available on your platform please perform the following steps:  
+
+- Provide implementation of `xxx_init_direct(xxx_t *obj, static_pinmap_t *)` function (which does not use pinmap tables).
+    - `xxx_init()` will use pinmap tables to determine associated peripheral/function with the given pins, populate the pin-map structure and call void `xxx_init_direct()`.
+    - `xxx_init_direct()` will perform peripheral initialization using given static pinmap structure.
+
+Example implementation below:
+
+```
+void xxx_init_direct(xxx_t *obj, const PinMap *pinmap)
+{
+    obj->spi.instance = pinmap->peripheral;
+
+    // pin out the xxx pins
+    pin_function(pinmap->pin, pinmap->function);
+    pin_mode(pinmap->pin, PullNone);
+
+    // Some additional init code
+}
+
+void xxx_init(xxx_t *obj, PinName pin)
+{
+    int peripheral = (int)pinmap_peripheral(pin, PinMap_xxx);
+    int function = (int)pinmap_find_function(pin, PinMap_xxx);
+
+    const PinMap static_pinmap = {pin, peripheral, function};
+
+    xxx_init_direct(obj, &static_pinmap);
+}
+```
+
+- Provide `constexpr` pin-map tables in the header file.
+
+Move pinmap tables from `PeripheralPins.c` to `PeripheralPinMaps.h` (create new file) and add `constexpr` specifier in the pin-map table declarations.
+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.
+
+**Note:**
+Please include `<mstd_cstddef>` module and use `MSTD_CONSTEXPR_OBJ_11` macro instead `constexpr` specifier. This must be done for backward compatibility with `ARM 5` compiler which does not support constant expressions. When `ARM 5` compiler is in use `MSTD_CONSTEXPR_OBJ_11` will be translated to `const`.  
+
+Example pin-map table below:
+
+```
+#include <mstd_cstddef>
+
+MSTD_CONSTEXPR_OBJ_11 PinMap PinMap_ADC[] = {
+    {P0_23, ADC0_SE0,    0},
+    {P0_10, ADC0_SE1,    0},
+    {P0_31, ADC0_SE3,    0},
+    {P1_8,  ADC0_SE4,    0},
+    {P2_0,  ADC0_SE5,    0},
+    {P2_13, ADC0_SE6,    0},
+    {P2_11, ADC0_SE7,    0},
+    {NC   , NC      ,    0}
+};
+
+```
+
+- Provide macros for pin-map tables  
+
+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:
+
+```
+#define PINMAP_ANALOGIN [PinMap ADC]
+#define PINMAP_ANALOGOUT [PinMap DAC]
+#define PINMAP_I2C_SDA [PinMap I2C SDA]
+#define PINMAP_I2C_SCL [PinMap I2C SCL]
+#define PINMAP_UART_TX [PinMap UART TX]
+#define PINMAP_UART_RX [PinMap UART RX]
+#define PINMAP_UART_CTS [PinMap UART CTS]
+#define PINMAP_UART_RTS [PinMap UART RTS]
+#define PINMAP_SPI_SCLK [PinMap SPI SCLK]
+#define PINMAP_SPI_MOSI [PinMap SPI MOSI]
+#define PINMAP_SPI_MISO [PinMap SPI MISO]
+#define PINMAP_SPI_SSEL [PinMap SPI SSEL]
+#define PINMAP_PWM [PinMap PWM]
+#define PINMAP_QSPI_DATA0 [PinMap QSPI DATA0]
+#define PINMAP_QSPI_DATA1 [PinMap QSPI DATA1]
+#define PINMAP_QSPI_DATA2 [PinMap QSPI DATA2]
+#define PINMAP_QSPI_DATA3 [PinMap QSPI DATA3]
+#define PINMAP_QSPI_SCLK [PinMap QSPI SCLK]
+#define PINMAP_QSPI_SSEL [PinMap QSPI SSEL]
+#define PINMAP_CAN_RD [PinMap CAN RD]
+#define PINMAP_CAN_TD [PinMap CAN RD]
+```
+
+- Provide `STATIC_PINMAP_READY` macro in `PinNames.h`  
+
+Adding this macro will enable the static pin-map support for the target.
+
+```
+/* If this macro is defined, then constexpr utility functions for pin-map seach can be used. */
+#define STATIC_PINMAP_READY 1
+```
+
+### Example usage/testing
+
+Use code below to check if static pinmap extension works.
+
+```
+int main()
+{
+    /* Regular use */
+    SPI spi(D1, D2, D3, D4);
+
+    /* Static pinmap */
+    const spi_pinmap_t static_spi_pinmap = {SPI_1, D1, 2, D2, 2, D3, 2, D4, 2};
+    SPI spi(static_spi_pinmap);
+
+    /* Static pinmap with constexpr utility function */
+    constexpr spi_pinmap_t static_spi_pinmap = get_spi_pinmap(D1, D2, D3, D4);
+    SPI spi(static_spi_pinmap);
+
+    return 0;
+}
+```
+
+When static pinmap extension is used we should get some ROM savings:  
+
+```
+| Module                          |        .text |   .data |       .bss |
+|---------------------------------|--------------|---------|------------|
+| [lib]\c_w.l                     |    11175(+0) |  16(+0) |    348(+0) |
+| [lib]\fz_wm.l                   |       34(+0) |   0(+0) |      0(+0) |
+| [lib]\m_wm.l                    |       48(+0) |   0(+0) |      0(+0) |
+| anon$$obj.o                     |       32(+0) |   0(+0) | 197888(+0) |
+| drivers\source                  |      192(+0) |   0(+0) |      0(+0) |
+| features\netsocket              |      143(+0) |   0(+0) |      0(+0) |
+| hal\mbed_critical_section_api.o |      154(+0) |   0(+0) |      2(+0) |
+| hal\mbed_gpio.o                 |       96(+0) |   0(+0) |      0(+0) |
+| hal\mbed_pinmap_common.o        |      0(-272) |   0(+0) |      0(+0) |  // removed pinmap lib (this is common for all peripherals)
+| hal\mbed_ticker_api.o           |      978(+0) |   0(+0) |      0(+0) |
+| hal\mbed_us_ticker_api.o        |      114(+0) |   4(+0) |     65(+0) |
+| main.o                          |      70(+32) |   0(+0) |      0(+0) |  // extra space for static pinmap structure in application
+| platform\source                 |    5683(+46) |  64(+0) |    249(+0) |  // extra space for UART static pinmap structure to initialize the console
+| rtos\source                     |     8990(+0) | 168(+0) |   6626(+0) |
+| targets\TARGET_Freescale        |  16581(-816) |  12(+0) |    340(+0) |  // removed pinmaps + driver code reduction
+| Subtotals                       | 44290(-1010) | 264(+0) | 205518(+0) |
+Total Static RAM memory (data + bss): 205782(+0) bytes
+Total Flash memory (text + data): 44554(-1010) bytes
+```
+
+Run FPGA tests to check if your implementation is valid:
+
+```
+ mbed test -t ARM -m K64F -n tests-mbed_hal_fpga_ci_test_shield*
+```
+
+**Note:**
+Your target must be ready to run FPGA-Test-Shield tests.
+Currently the following peripherals can be tested: `Analogin`, `SPI`, `I2C`, `PWM`, `UART`.