Mbed OS Reference | static_pinmap.h Source File

 /* mbed Microcontroller Library
  * Copyright (c) 2018-2019 ARM Limited
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 #ifndef STATIC_PINMAP_H
 #define STATIC_PINMAP_H
 
 #include "PinNames.h"
 #include "spi_api.h"
 #include "pwmout_api.h"
 #include "analogin_api.h"
 #include "analogout_api.h"
 #include "i2c_api.h"
 #include "serial_api.h"
 #include "qspi_api.h"
 #include "can_api.h"
 #include <mstd_cstddef>
 
 #if STATIC_PINMAP_READY
 #include "PeripheralPinMaps.h"
 
 
 #if defined(DEVICE_PWMOUT) && defined(PINMAP_PWM)
 MSTD_CONSTEXPR_FN_14 PinMap get_pwm_pinmap(const PinName pin)
 {
     for (const PinMap &pinmap : PINMAP_PWM) {
         if (pinmap.pin == pin) {
             return {pin, pinmap.peripheral, pinmap.function};
         }
     }
     return {NC, (int) NC, (int) NC};
 }
 #endif // DEVICE_PWMOUT
 
 #if defined(DEVICE_ANALOGIN) && defined(PINMAP_ANALOGIN)
 MSTD_CONSTEXPR_FN_14 PinMap get_analogin_pinmap(const PinName pin)
 {
     for (const PinMap &pinmap : PINMAP_ANALOGIN) {
         if (pinmap.pin == pin) {
             return {pin, pinmap.peripheral, pinmap.function};
         }
     }
 
 #if PINMAP_ANALOGIN_INTERNAL
     for (const PinMap &pinmap : PINMAP_ANALOGIN_INTERNAL) {
         if (pinmap.pin == pin) {
             return {pin, pinmap.peripheral, pinmap.function};
         }
     }
 #endif
 
     return {NC, (int) NC, (int) NC};
 }
 #endif // DEVICE_ANALOGIN
 
 #if defined(DEVICE_ANALOGOUT) && defined(PINMAP_ANALOGOUT)
 MSTD_CONSTEXPR_FN_14 PinMap get_analogout_pinmap(const PinName pin)
 {
     for (const PinMap &pinmap : PINMAP_ANALOGOUT) {
         if (pinmap.pin == pin) {
             return {pin, pinmap.peripheral, pinmap.function};
         }
     }
     return {NC, (int) NC, (int) NC};
 }
 #endif // DEVICE_ANALOGOUT
 
 #if defined(DEVICE_I2C) && defined(PINMAP_I2C_SDA) && defined(PINMAP_I2C_SCL)
 MSTD_CONSTEXPR_FN_14 i2c_pinmap_t get_i2c_pinmap(const PinName sda, const PinName scl)
 {
     const PinMap *sda_map = nullptr;
     for (const PinMap &pinmap : PINMAP_I2C_SDA) {
         if (pinmap.pin == sda) {
             sda_map = &pinmap;
             break;
         }
     }
 
     const PinMap *scl_map = nullptr;
     for (const PinMap &pinmap : PINMAP_I2C_SCL) {
         if (pinmap.pin == scl) {
             scl_map = &pinmap;
             break;
         }
     }
 
     if (!sda_map || !scl_map || sda_map->peripheral != scl_map->peripheral) {
         return {(int) NC, NC, (int) NC, NC, (int) NC};
     }
 
     return {sda_map->peripheral, sda_map->pin, sda_map->function, scl_map->pin, scl_map->function};
 }
 #endif //DEVICE_I2C
 
 #if defined(DEVICE_SERIAL) && defined(PINMAP_UART_TX) && defined(PINMAP_UART_RX)
 MSTD_CONSTEXPR_FN_14 serial_pinmap_t get_uart_pinmap(const PinName tx, const PinName rx)
 {
     const PinMap *tx_map = nullptr;
     for (const PinMap &pinmap : PINMAP_UART_TX) {
         if (pinmap.pin == tx) {
             tx_map = &pinmap;
             break;
         }
     }
 
     const PinMap *rx_map = nullptr;
     for (const PinMap &pinmap : PINMAP_UART_RX) {
         if (pinmap.pin == rx) {
             rx_map = &pinmap;
             break;
         }
     }
 
     if (!tx_map || !rx_map || rx_map->peripheral != tx_map->peripheral) {
         return {(int) NC, NC, (int) NC, NC, (int) NC, false};
     }
 
     if (tx_map->pin == STDIO_UART_TX && rx_map->pin == STDIO_UART_RX) {
         return {tx_map->peripheral, tx_map->pin, tx_map->function, rx_map->pin, rx_map->function, true};
     } else {
         return {tx_map->peripheral, tx_map->pin, tx_map->function, rx_map->pin, rx_map->function, false};
     }
 }
 
 #if defined(DEVICE_SERIAL_FC) && defined(PINMAP_UART_RTS) && defined(PINMAP_UART_CTS)
 MSTD_CONSTEXPR_FN_14 serial_fc_pinmap_t get_uart_fc_pinmap(const PinName rxflow, const PinName txflow)
 {
     const PinMap *rts_map = nullptr;
     for (const PinMap &pinmap : PINMAP_UART_RTS) {
         if (pinmap.pin == rxflow) {
             rts_map = &pinmap;
             break;
         }
     }
 
     const PinMap *cts_map = nullptr;
     for (const PinMap &pinmap : PINMAP_UART_CTS) {
         if (pinmap.pin == txflow) {
             cts_map = &pinmap;
             break;
         }
     }
 
     if ((!rts_map || !cts_map) || (rts_map->peripheral != cts_map->peripheral)) {
         return {(int) NC, NC, (int) NC, NC, (int) NC};
     }
 
     return {cts_map->peripheral, cts_map->pin, cts_map->function, rts_map->pin, rts_map->function};
 }
 #endif // DEVICE_SERIAL_FC
 #endif // DEVICE_SERIAL
 
 #if defined(DEVICE_SPI) && defined(PINMAP_SPI_MOSI) && defined(PINMAP_SPI_MISO) && defined(PINMAP_SPI_SCLK) && defined(PINMAP_SPI_SSEL)
 MSTD_CONSTEXPR_FN_14 spi_pinmap_t get_spi_pinmap(const PinName mosi, const PinName miso, const PinName sclk, const PinName ssel)
 {
     const PinMap *mosi_map = nullptr;
     for (const PinMap &pinmap : PINMAP_SPI_MOSI) {
         if (pinmap.pin == mosi) {
             mosi_map = &pinmap;
             break;
         }
     }
 
     const PinMap *miso_map = nullptr;
     for (const PinMap &pinmap : PINMAP_SPI_MISO) {
         if (pinmap.pin == miso) {
             miso_map = &pinmap;
             break;
         }
     }
 
     const PinMap *sclk_map = nullptr;
     for (const PinMap &pinmap : PINMAP_SPI_SCLK) {
         if (pinmap.pin == sclk) {
             sclk_map = &pinmap;
             break;
         }
     }
 
     const PinMap *ssel_map = nullptr;
     for (const PinMap &pinmap : PINMAP_SPI_SSEL) {
         if (pinmap.pin == ssel) {
             ssel_map = &pinmap;
             break;
         }
     }
 
     if ((!mosi_map || !miso_map || !sclk_map || !ssel_map) ||
             (mosi_map->peripheral != miso_map->peripheral || mosi_map->peripheral != sclk_map->peripheral) ||
             (ssel_map->pin != NC && mosi_map->peripheral != ssel_map->peripheral)) {
         return {(int) NC, NC, (int) NC, NC, (int) NC, NC, (int) NC, NC, (int) NC};
     }
 
     return {mosi_map->peripheral, mosi_map->pin, mosi_map->function, miso_map->pin, miso_map->function, sclk_map->pin, sclk_map->function, ssel_map->pin, ssel_map->function};
 }
 #endif // DEVICE_SPI
 
 #if defined(DEVICE_CAN) && defined(PINMAP_CAN_RD) && defined(PINMAP_CAN_TD)
 MSTD_CONSTEXPR_FN_14 can_pinmap_t get_can_pinmap(const PinName rd, const PinName td)
 {
     const PinMap *rd_map = nullptr;
     for (const PinMap &pinmap : PINMAP_CAN_RD) {
         if (pinmap.pin == rd) {
             rd_map = &pinmap;
             break;
         }
     }
 
     const PinMap *td_map = nullptr;
     for (const PinMap &pinmap : PINMAP_CAN_TD) {
         if (pinmap.pin == td) {
             td_map = &pinmap;
             break;
         }
     }
 
     if (!rd_map || !td_map || rd_map->peripheral != td_map->peripheral) {
         return {(int) NC, NC, (int) NC, NC, (int) NC};
     }
 
     return {rd_map->peripheral, rd_map->pin, rd_map->function, td_map->pin, td_map->function};
 }
 #endif //DEVICE_CAN
 
 #if defined(DEVICE_QSPI) && defined(PINMAP_QSPI_DATA0) && defined(PINMAP_QSPI_DATA1) && defined(PINMAP_QSPI_DATA2) && defined(PINMAP_QSPI_DATA3) && defined(PINMAP_QSPI_SCLK) && defined(PINMAP_QSPI_SSEL)
 MSTD_CONSTEXPR_FN_14 qspi_pinmap_t get_qspi_pinmap(const PinName data0, const PinName data1, const PinName data2, const PinName data3, const PinName sclk, const PinName ssel)
 {
     const PinMap *data0_map = nullptr;
     for (const PinMap &pinmap : PINMAP_QSPI_DATA0) {
         if (pinmap.pin == data0) {
             data0_map = &pinmap;
             break;
         }
     }
 
     const PinMap *data1_map = nullptr;
     for (const PinMap &pinmap : PINMAP_QSPI_DATA1) {
         if (pinmap.pin == data1) {
             data1_map = &pinmap;
             break;
         }
     }
 
     const PinMap *data2_map = nullptr;
     for (const PinMap &pinmap : PINMAP_QSPI_DATA2) {
         if (pinmap.pin == data2) {
             data2_map = &pinmap;
             break;
         }
     }
 
     const PinMap *data3_map = nullptr;
     for (const PinMap &pinmap : PINMAP_QSPI_DATA3) {
         if (pinmap.pin == data3) {
             data3_map = &pinmap;
             break;
         }
     }
 
     const PinMap *sclk_map = nullptr;
     for (const PinMap &pinmap : PINMAP_QSPI_SCLK) {
         if (pinmap.pin == sclk) {
             sclk_map = &pinmap;
             break;
         }
     }
 
     const PinMap *ssel_map = nullptr;
     for (const PinMap &pinmap : PINMAP_QSPI_SSEL) {
         if (pinmap.pin == ssel) {
             ssel_map = &pinmap;
             break;
         }
     }
 
     if (!data0_map || !data1_map || !data2_map || !data3_map || !sclk_map || !ssel_map || data0_map->peripheral != data1_map->peripheral || data0_map->peripheral != data2_map->peripheral  || data0_map->peripheral != data3_map->peripheral || data0_map->peripheral != sclk_map->peripheral || data0_map->peripheral != ssel_map->peripheral) {
         return {(int) NC, NC, (int) NC, NC, (int) NC, NC, (int) NC, NC, (int) NC};
     }
 
     return {data0_map->peripheral, data0_map->pin, data0_map->function, data1_map->pin, data1_map->function, data2_map->pin, data2_map->function, data3_map->pin, data3_map->function, sclk_map->pin, sclk_map->function, ssel_map->pin, ssel_map->function};
 }
 #endif //DEVICE_QSPI
 
 #else // STATIC_PINMAP_READY
 
 #if DEVICE_PWMOUT
 MSTD_CONSTEXPR_FN_14 PinMap get_pwm_pinmap(const PinName pin)
 {
     return {pin, (int) NC, (int) NC};
 }
 #endif // DEVICE_PWMOUT
 
 #if DEVICE_ANALOGIN
 MSTD_CONSTEXPR_FN_14 PinMap get_analogin_pinmap(const PinName pin)
 {
     return {pin, (int) NC, (int) NC};
 }
 #endif // DEVICE_ANALOGIN
 
 #if DEVICE_ANALOGOUT
 MSTD_CONSTEXPR_FN_14 PinMap get_analogout_pinmap(const PinName pin)
 {
     return {pin, (int) NC, (int) NC};
 }
 #endif // DEVICE_ANALOGOUT
 
 #if DEVICE_I2C
 MSTD_CONSTEXPR_FN_14 i2c_pinmap_t get_i2c_pinmap(const PinName sda, const PinName scl)
 {
     return {(int) NC, sda, (int) NC, scl, (int) NC};
 }
 #endif //DEVICE_I2C
 
 #if DEVICE_SERIAL
 MSTD_CONSTEXPR_FN_14 serial_pinmap_t get_uart_pinmap(const PinName tx, const PinName rx)
 {
     return {(int) NC, tx, (int) NC, rx, (int) NC, false};
 }
 
 #if DEVICE_SERIAL_FC
 MSTD_CONSTEXPR_FN_14 serial_fc_pinmap_t get_uart_fc_pinmap(const PinName rxflow, const PinName txflow)
 {
     return {(int) NC, txflow, (int) NC, rxflow, (int) NC};
 }
 #endif // DEVICE_SERIAL_FC
 #endif // DEVICE_SERIAL
 
 #if DEVICE_SPI
 MSTD_CONSTEXPR_FN_14 spi_pinmap_t get_spi_pinmap(const PinName mosi, const PinName miso, const PinName sclk, const PinName ssel)
 {
     return {(int) NC, mosi, (int) NC, miso, (int) NC, sclk, (int) NC, ssel, (int) NC};
 }
 #endif // DEVICE_SERIAL
 
 #if DEVICE_CAN
 MSTD_CONSTEXPR_FN_14 can_pinmap_t get_can_pinmap(const PinName rd, const PinName td)
 {
     return {(int) NC, rd, (int) NC, td, (int) NC};
 }
 #endif //DEVICE_CAN
 
 #if DEVICE_QSPI
 MSTD_CONSTEXPR_FN_14 qspi_pinmap_t get_qspi_pinmap(const PinName data0, const PinName data1, const PinName data2, const PinName data3, const PinName sclk, const PinName ssel)
 {
     return {(int) NC, data0, (int) NC, data1, (int) NC, data2, (int) NC, data3, (int) NC, sclk, (int) NC, ssel, (int) NC};
 }
 #endif //DEVICE_QSPI
 
 #endif // STATIC_PINMAP_READY
 
 #endif // STATIC_PINMAP_H
Important Information for this Arm website
