Files
Beslan 0ef1717155
Some checks failed
Basic Checks / license-check (push) Has been cancelled
Basic Checks / include-check (push) Has been cancelled
Basic Checks / style-check (push) Has been cancelled
Basic Checks / docs-check (push) Has been cancelled
Basic Checks / python-tests (push) Has been cancelled
Basic Checks / pin-validation (push) Has been cancelled
Basic Checks / cmake-checks (push) Has been cancelled
Basic Checks / frozen-tools-check (push) Has been cancelled
Publish or Update docker image for head of branch / prepare-tags (push) Has been cancelled
Release or update docker image for a released mbed-os version / prepare-tags (push) Has been cancelled
Publish or Update docker image for head of branch / build-container (push) Has been cancelled
Publish or Update docker image for head of branch / test-container (linux/amd64) (push) Has been cancelled
Publish or Update docker image for head of branch / test-container (linux/arm64) (push) Has been cancelled
Publish or Update docker image for head of branch / deploy-container (push) Has been cancelled
Release or update docker image for a released mbed-os version / build-container (push) Has been cancelled
Release or update docker image for a released mbed-os version / test-container (linux/amd64) (push) Has been cancelled
Release or update docker image for a released mbed-os version / test-container (linux/arm64) (push) Has been cancelled
Release or update docker image for a released mbed-os version / deploy-container (push) Has been cancelled
Prune temporary docker images / prune-images (push) Has been cancelled
Mirror mbed-os-6.15.0
2026-07-10 18:42:39 +03:00

157 lines
4.7 KiB
C

/* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited and affiliates.
* 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 PINMAP_EX_H
#define PINMAP_EX_H
#include "PinNames.h"
#ifdef __cplusplus
extern "C" {
#endif
/* Data structure for pre-allocated I2C instances. */
typedef struct {
PinName sda;
PinName scl;
int instance;
} PinMapI2C;
extern const PinMapI2C PinMap_I2C[];
/* Data structure for pre-allocated SPI instances. */
typedef struct {
PinName mosi;
PinName miso;
PinName clk;
int instance;
} PinMapSPI;
extern const PinMapSPI PinMap_SPI[];
/* Data structure for pre-allocated PWM instances. */
typedef struct {
PinName pwm;
int instance;
} PinMapPWM;
extern const PinMapPWM PinMap_PWM[];
/* Data structure for pre-allocated UART instances. */
typedef struct {
PinName tx;
PinName rx;
int instance;
} PinMapUART;
extern const PinMapUART PinMap_UART[];
/**
* @brief Find hardware instance for the provided I2C pins.
*
* The function will search the PeripheralPin map for a pre-allocated
* assignment. If none is found the allocation map will be searched
* to see if the same pins have been assigned an instance before.
*
* If no assignement is found and there is an empty slot left in the
* map, the pins are stored in the map and the hardware instance is
* returned.
*
* If no free instances are available, the default instance is returned.
*
* @param[in] sda sda pin.
* @param[in] scl scl pin.
*
* @return Hardware instance associated with provided pins.
*/
int pin_instance_i2c(PinName sda, PinName scl);
/**
* @brief Find hardware instance for the provided SPI pins.
*
* The function will search the PeripheralPin map for a pre-allocated
* assignment. If none is found the allocation map will be searched
* to see if the same pins have been assigned an instance before.
*
* If no assignement is found and there is an empty slot left in the
* map, the pins are stored in the map and the hardware instance is
* returned.
*
* If no free instances are available, the default instance is returned.
*
* @param[in] mosi mosi pin.
* @param[in] miso miso pin.
* @param[in] clk clk pin.
*
* @return Hardware instance associated with provided pins.
*/
int pin_instance_spi(PinName mosi, PinName miso, PinName clk);
/**
* @brief Find hardware instance for the provided PWM pins.
*
* The function will search the PeripheralPin map for a pre-allocated
* assignment. If none is found the allocation map will be searched
* to see if the same pins have been assigned an instance before.
*
* If no assignement is found and there is an empty slot left in the
* map, the pins are stored in the map and the hardware instance is
* returned.
*
* If no free instances are available, the default instance is returned.
*
* @param[in] pwm pwm pin.
*
* @return Hardware instance associated with provided pins.
*/
int pin_instance_pwm(PinName pwm);
/**
* Brief Find hardware instance for the provided PWM pin and free it
*
* Parameter pwm pwm pin.
*
* Return Nothing
*/
void pin_instance_pwm_free(PinName pwm);
/**
* @brief Find hardware instance for the provided UART pins.
*
* The function will search the PeripheralPin map for a pre-allocated
* assignment. If none is found the allocation map will be searched
* to see if the same pins have been assigned an instance before.
*
* If no assignement is found and there is an empty slot left in the
* map, the pins are stored in the map and the hardware instance is
* returned.
*
* If no free instances are available, the default instance is returned.
*
* @param[in] tx tx pin.
* @param[in] rx rx pin.
*
* @return Hardware instance associated with provided pins.
*/
int pin_instance_uart(PinName tx, PinName rx);
#ifdef __cplusplus
}
#endif
#endif // PINMAP_EX_H