Modules | |
| Analogin hal functions | |
Defined behaviour | |
| Analogout hal functions | |
Defined behaviour | |
| Hardware CRC | |
| The Hardware CRC HAL API provides a low-level interface to the Hardware CRC module of a target platform. | |
| Critical Section HAL functions | |
| Flash HAL API | |
| GPIO HAL functions | |
Defined behavior | |
| GPIO IRQ HAL functions | |
Defined behavior | |
| I2C hal | |
| The I2C hal provides a low level interface to the I2C interface of a target. | |
| Instrumented Trace Macrocell HAL API | |
| Low Power Ticker | |
| Low level interface to the low power ticker of a target. | |
| MPU hal | |
| The MPU hal provides a simple MPU API to enhance device security by preventing execution from ram. | |
| Port HAL functions | |
| Pwmout hal functions | |
Defined behavior | |
| QSPI HAL | |
| ResetReason HAL API | |
| Low-level interface to the ResetReason of a target. | |
| RTC hal | |
| The RTC hal provides a low level interface to the Real Time Counter (RTC) of a target. | |
| Serial TX Events Macros | |
| Serial RX Events Macros | |
| Serial Configuration Functions | |
Defined behavior | |
| Asynchronous Serial Hardware Abstraction Layer | |
| sleep hal requirements | |
| Low level interface to the sleep mode of a target. | |
| SPI Configuration Functions | |
Defined behavior | |
| Synchronous SPI Hardware Abstraction Layer | |
| Asynchronous SPI Hardware Abstraction Layer | |
| SPM HAL API | |
| The HAL functions for PSA SPM. | |
| Ticker HAL functions | |
| TRNG hal functions | |
| Microsecond Ticker | |
| Low level interface to the microsecond ticker of a target. | |
| Watchdog HAL API | |
| Low-level interface to the Independent Watchdog Timer of a target. | |
Data Structures | |
| struct | buffer_s |
| Generic buffer structure. More... | |
| struct | CAN_Message |
| Holder for single CAN message. More... | |
| struct | crc_mbed_config |
| class | LowPowerTickerWrapper |
| struct | PinMap |
| struct | PinList |
| struct | PeripheralList |
| struct | serial_t |
| Asynch serial HAL structure. More... | |
| struct | spi_t |
| Asynch SPI HAL structure. More... | |
| struct | _ARM_DRIVER_VERSION |
| Driver Version. More... | |
| struct | _ARM_STORAGE_BLOCK_ATTRIBUTES |
| Attributes of the storage range within a storage block. More... | |
| struct | _ARM_STORAGE_BLOCK |
| A storage block is a range of memory with uniform attributes. More... | |
| struct | _ARM_STORAGE_SECURITY_FEATURES |
| Device Data Security Protection Features. More... | |
| struct | _ARM_STORAGE_INFO |
| Storage information. More... | |
| struct | _ARM_STORAGE_STATUS |
| Operating status of the storage controller. More... | |
| struct | _ARM_STORAGE_CAPABILITIES |
| Storage Driver API Capabilities. More... | |
| struct | _ARM_DRIVER_STORAGE |
| This is the set of operations constituting the Storage driver. More... | |
| struct | ticker_event_s |
| Ticker's event structure. More... | |
| struct | ticker_info_t |
| Information about the ticker implementation. More... | |
| struct | ticker_interface_t |
| Ticker's interface structure - required API for a ticker. More... | |
| struct | ticker_event_queue_t |
| Ticker's event queue structure. More... | |
| struct | ticker_data_t |
| Ticker's data structure. More... | |
Macros | |
| #define | ARM_DRIVER_OK 0 |
| Operation succeeded. More... | |
| #define | ARM_DRIVER_ERROR -1 |
| Unspecified error. More... | |
| #define | ARM_DRIVER_ERROR_BUSY -2 |
| Driver is busy. More... | |
| #define | ARM_DRIVER_ERROR_TIMEOUT -3 |
| Timeout occurred. More... | |
| #define | ARM_DRIVER_ERROR_UNSUPPORTED -4 |
| Operation not supported. More... | |
| #define | ARM_DRIVER_ERROR_PARAMETER -5 |
| Parameter error. More... | |
| #define | ARM_DRIVER_ERROR_SPECIFIC -6 |
| Start of driver specific errors. More... | |
| #define | ARM_STORAGE_INVALID_OFFSET (0xFFFFFFFFFFFFFFFFULL) |
| Invalid address (relative to a storage controller's. More... | |
| #define | ARM_STORAGE_INVALID_ADDRESS (0xFFFFFFFFUL) |
| Invalid address within the processor's memory address space. More... | |
| #define | ARM_STORAGE_ERROR_NOT_ERASABLE (ARM_DRIVER_ERROR_SPECIFIC - 1) |
| Part (or all) of the range provided to Erase() isn't erasable. More... | |
| #define | ARM_STORAGE_ERROR_NOT_PROGRAMMABLE (ARM_DRIVER_ERROR_SPECIFIC - 2) |
| Part (or all) of the range provided to ProgramData() isn't programmable. More... | |
| #define | ARM_STORAGE_ERROR_PROTECTED (ARM_DRIVER_ERROR_SPECIFIC - 3) |
| Part (or all) of the range to Erase() or ProgramData() is protected. More... | |
| #define | ARM_STORAGE_ERROR_RUNTIME_OR_INTEGRITY_FAILURE (ARM_DRIVER_ERROR_SPECIFIC - 4) |
| Runtime or sanity-check failure. More... | |
| #define | ARM_STORAGE_VALID_BLOCK(BLK) (((BLK)->addr != ARM_STORAGE_INVALID_OFFSET) && ((BLK)->size != 0)) |
| The check for a valid ARM_STORAGE_BLOCK. More... | |
| #define | ARM_STORAGE_PROGRAMMABILITY_RAM (0x0) |
| Values for encoding storage memory-types with respect to programmability. More... | |
| #define | ARM_STORAGE_PROGRAMMABILITY_ROM (0x1) |
| Read-only memory. More... | |
| #define | ARM_STORAGE_PROGRAMMABILITY_WORM (0x2) |
| write-once-read-only-memory (WORM). More... | |
| #define | ARM_STORAGE_PROGRAMMABILITY_ERASABLE (0x3) |
| re-programmable based on erase. Supports multiple writes. More... | |
| #define | ARM_RETENTION_WHILE_DEVICE_ACTIVE (0x0) |
| Values for encoding data-retention levels for storage blocks. More... | |
| #define | ARM_RETENTION_ACROSS_SLEEP (0x1) |
| Data is retained across processor sleep. More... | |
| #define | ARM_RETENTION_ACROSS_DEEP_SLEEP (0x2) |
| Data is retained across processor deep-sleep. More... | |
| #define | ARM_RETENTION_BATTERY_BACKED (0x3) |
| Data is battery-backed. Device can be powered off. More... | |
| #define | ARM_RETENTION_NVM (0x4) |
| Data is retained in non-volatile memory. More... | |
| #define | ARM_STORAGE_PROGRAM_CYCLES_INFINITE (0UL) |
| Infinite or unknown endurance for reprogramming. More... | |
Typedefs | |
| typedef struct analogin_s | analogin_t |
| Analogin hal structure. More... | |
| typedef struct dac_s | dac_t |
| Analogout hal structure. More... | |
| typedef struct buffer_s | buffer_t |
| Generic buffer structure. More... | |
| typedef enum crc_polynomial | crc_polynomial_t |
| CRC Polynomial value. More... | |
| typedef struct gpio_irq_s | gpio_irq_t |
| GPIO IRQ HAL structure. More... | |
| typedef struct port_s | port_t |
| Port HAL structure. More... | |
| typedef struct pwmout_s | pwmout_t |
| Pwmout hal structure. More... | |
| typedef struct _ARM_DRIVER_VERSION | ARM_DRIVER_VERSION |
| Driver Version. More... | |
| typedef enum _ARM_POWER_STATE | ARM_POWER_STATE |
| General power states. More... | |
| typedef struct _ARM_STORAGE_BLOCK_ATTRIBUTES | ARM_STORAGE_BLOCK_ATTRIBUTES |
| Attributes of the storage range within a storage block. More... | |
| typedef struct _ARM_STORAGE_BLOCK | ARM_STORAGE_BLOCK |
| A storage block is a range of memory with uniform attributes. More... | |
| typedef struct _ARM_STORAGE_SECURITY_FEATURES | ARM_STORAGE_SECURITY_FEATURES |
| Device Data Security Protection Features. More... | |
| typedef struct _ARM_STORAGE_INFO | ARM_STORAGE_INFO |
| Storage information. More... | |
| typedef struct _ARM_STORAGE_STATUS | ARM_STORAGE_STATUS |
| Operating status of the storage controller. More... | |
| typedef struct _ARM_STORAGE_CAPABILITIES | ARM_STORAGE_CAPABILITIES |
| Storage Driver API Capabilities. More... | |
| typedef enum _ARM_STORAGE_OPERATION | ARM_STORAGE_OPERATION |
| Command opcodes for Storage. More... | |
| typedef void(* | ARM_Storage_Callback_t) (int32_t status, ARM_STORAGE_OPERATION operation) |
| Declaration of the callback-type for command completion. More... | |
| typedef struct _ARM_DRIVER_STORAGE | ARM_DRIVER_STORAGE |
| This is the set of operations constituting the Storage driver. More... | |
| typedef uint32_t | timestamp_t |
| Legacy format representing a timestamp in us. More... | |
| typedef uint64_t | us_timestamp_t |
| A us timestamp stored in a 64 bit integer. More... | |
| typedef struct ticker_event_s | ticker_event_t |
| Ticker's event structure. More... | |
| typedef struct trng_s | trng_t |
| TRNG HAL structure. More... | |
Enumerations |
Functions | |
| const PinMap * | can_rd_pinmap (void) |
| Get the pins that support CAN RD. More... | |
| const PinMap * | can_td_pinmap (void) |
| Get the pins that support CAN TD. More... | |
| void | lp_ticker_wrapper_irq_handler (ticker_irq_handler_type handler) |
| Interrupt handler for the wrapped lp ticker. More... | |
| const ticker_data_t * | get_lp_ticker_wrapper_data (const ticker_data_t *data) |
| Get wrapped lp ticker data. More... | |
| void | lp_ticker_wrapper_suspend (void) |
| Suspend the wrapper layer code. More... | |
| void | lp_ticker_wrapper_resume (void) |
| Resume the wrapper layer code. More... | |
| bool | pinmap_find_peripheral_pins (const PinList *whitelist, const PinList *blacklist, int per, const PinMap *const *maps, PinName **pins, uint32_t count) |
| Find a combination of pins suitable for use given the constraints. More... | |
| bool | pinmap_list_has_pin (const PinList *list, PinName pin) |
| Check if the pin is in the list. More... | |
| bool | pinmap_list_has_peripheral (const PeripheralList *list, int peripheral) |
| Check if the peripheral is in the list. More... | |
| const PinList * | pinmap_restricted_pins (void) |
| Get the pin list of pins to avoid during testing. More... | |
| const PeripheralList * | pinmap_restricted_peripherals (void) |
| Get the pin list of peripherals to avoid during testing. More... | |
| USBPhy * | get_usb_phy () |
| Return a the USBPhy instance for this hardware. More... | |
Variables | |
| struct i2c_s | i2c |
| Target specific I2C structure. More... | |
| struct buffer_s | tx_buff |
| Tx buffer. More... | |
| struct buffer_s | rx_buff |
| Rx buffer. More... | |
| uint32_t | minimum_frequency |
| < Minimum frequency supported must be set by target device More... | |
| uint32_t | maximum_frequency |
| If true, the device can handle I2C slave mode. More... | |
| bool | supports_slave_mode |
| If true, supports 10-bit addressing. More... | |
| bool | supports_10bit_addressing |
| If true, the device handle multimaster collisions and arbitration safely. More... | |
| bool | supports_multi_master |
| If true, supports configuring clock stretching. More... | |
| #define ARM_DRIVER_ERROR -1 |
Unspecified error.
Definition at line 42 of file Driver_Common.h.
| #define ARM_DRIVER_ERROR_BUSY -2 |
Driver is busy.
Definition at line 43 of file Driver_Common.h.
| #define ARM_DRIVER_ERROR_PARAMETER -5 |
Parameter error.
Definition at line 46 of file Driver_Common.h.
| #define ARM_DRIVER_ERROR_SPECIFIC -6 |
Start of driver specific errors.
Definition at line 47 of file Driver_Common.h.
| #define ARM_DRIVER_ERROR_TIMEOUT -3 |
Timeout occurred.
Definition at line 44 of file Driver_Common.h.
| #define ARM_DRIVER_ERROR_UNSUPPORTED -4 |
Operation not supported.
Definition at line 45 of file Driver_Common.h.
| #define ARM_DRIVER_OK 0 |
Operation succeeded.
Definition at line 41 of file Driver_Common.h.
| #define ARM_RETENTION_ACROSS_DEEP_SLEEP (0x2) |
Data is retained across processor deep-sleep.
Definition at line 115 of file Driver_Storage.h.
| #define ARM_RETENTION_ACROSS_SLEEP (0x1) |
Data is retained across processor sleep.
Definition at line 114 of file Driver_Storage.h.
| #define ARM_RETENTION_BATTERY_BACKED (0x3) |
Data is battery-backed. Device can be powered off.
Definition at line 116 of file Driver_Storage.h.
| #define ARM_RETENTION_NVM (0x4) |
Data is retained in non-volatile memory.
Definition at line 117 of file Driver_Storage.h.
| #define ARM_RETENTION_WHILE_DEVICE_ACTIVE (0x0) |
Values for encoding data-retention levels for storage blocks.
Please ensure that the maximum of the following retention types doesn't exceed 16; we encode this in a 4-bit field within ARM_STORAGE_INFO::retention_level.Data is retained only during device activity.
Definition at line 113 of file Driver_Storage.h.
| #define ARM_STORAGE_ERROR_NOT_ERASABLE (ARM_DRIVER_ERROR_SPECIFIC - 1) |
Part (or all) of the range provided to Erase() isn't erasable.
Definition at line 47 of file Driver_Storage.h.
| #define ARM_STORAGE_ERROR_NOT_PROGRAMMABLE (ARM_DRIVER_ERROR_SPECIFIC - 2) |
Part (or all) of the range provided to ProgramData() isn't programmable.
Definition at line 48 of file Driver_Storage.h.
| #define ARM_STORAGE_ERROR_PROTECTED (ARM_DRIVER_ERROR_SPECIFIC - 3) |
Part (or all) of the range to Erase() or ProgramData() is protected.
Definition at line 49 of file Driver_Storage.h.
| #define ARM_STORAGE_ERROR_RUNTIME_OR_INTEGRITY_FAILURE (ARM_DRIVER_ERROR_SPECIFIC - 4) |
Runtime or sanity-check failure.
Definition at line 50 of file Driver_Storage.h.
| #define ARM_STORAGE_INVALID_ADDRESS (0xFFFFFFFFUL) |
Invalid address within the processor's memory address space.
Refer to memory-mapped storage, i.e. < ARM_DRIVER_STORAGE::ResolveAddress().
Definition at line 43 of file Driver_Storage.h.
| #define ARM_STORAGE_INVALID_OFFSET (0xFFFFFFFFFFFFFFFFULL) |
Invalid address (relative to a storage controller's.
address space). A storage block may never start at this address.
Definition at line 40 of file Driver_Storage.h.
| #define ARM_STORAGE_PROGRAM_CYCLES_INFINITE (0UL) |
Infinite or unknown endurance for reprogramming.
Definition at line 141 of file Driver_Storage.h.
| #define ARM_STORAGE_PROGRAMMABILITY_ERASABLE (0x3) |
re-programmable based on erase. Supports multiple writes.
Definition at line 105 of file Driver_Storage.h.
| #define ARM_STORAGE_PROGRAMMABILITY_RAM (0x0) |
Values for encoding storage memory-types with respect to programmability.
Please ensure that the maximum of the following memory types doesn't exceed 16; we encode this in a 4-bit field within ARM_STORAGE_INFO::programmability.
Definition at line 102 of file Driver_Storage.h.
| #define ARM_STORAGE_PROGRAMMABILITY_ROM (0x1) |
Read-only memory.
Definition at line 103 of file Driver_Storage.h.
| #define ARM_STORAGE_PROGRAMMABILITY_WORM (0x2) |
write-once-read-only-memory (WORM).
Definition at line 104 of file Driver_Storage.h.
| #define ARM_STORAGE_VALID_BLOCK | ( | BLK | ) | (((BLK)->addr != ARM_STORAGE_INVALID_OFFSET) && ((BLK)->size != 0)) |
The check for a valid ARM_STORAGE_BLOCK.
Definition at line 94 of file Driver_Storage.h.
| typedef struct analogin_s analogin_t |
Analogin hal structure.
analogin_s is declared in the target's hal
Definition at line 34 of file analogin_api.h.
| typedef struct _ARM_DRIVER_STORAGE ARM_DRIVER_STORAGE |
This is the set of operations constituting the Storage driver.
Their implementation is platform-specific, and needs to be supplied by the porting effort.
Some APIs within ARM_DRIVER_STORAGE will always operate synchronously: GetVersion, GetCapabilities, GetStatus, GetInfo, ResolveAddress, GetNextBlock, and GetBlock. This means that control returns to the caller with a relevant status code only after the completion of the operation (or the discovery of a failure condition).
The remainder of the APIs: Initialize, Uninitialize, PowerControl, ReadData, ProgramData, Erase, EraseAll, can function asynchronously if the underlying controller supports it–i.e. if ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. In the case of asynchronous operation, the invocation returns early (with ARM_DRIVER_OK) and results in a completion callback later. If ARM_STORAGE_CAPABILITIES::asynchronous_ops is not set, then all such APIs execute synchronously, and control returns to the caller with a status code only after the completion of the operation (or the discovery of a failure condition).
If ARM_STORAGE_CAPABILITIES::asynchronous_ops is set, a storage driver may still choose to execute asynchronous operations in a synchronous manner. If so, the driver returns a positive value to indicate successful synchronous completion (or an error code in case of failure) and no further invocation of completion callback should be expected. The expected return value for synchronous completion of such asynchronous operations varies depending on the operation. For operations involving data access, it often equals the amount of data transferred or affected. For non data-transfer operations, such as EraseAll or Initialize, it is usually 1.
Here's a code snippet to suggest how asynchronous APIs might be used by callers to handle both synchronous and asynchronous execution by the underlying storage driver:
| typedef struct _ARM_DRIVER_VERSION ARM_DRIVER_VERSION |
Driver Version.
| typedef enum _ARM_POWER_STATE ARM_POWER_STATE |
General power states.
| typedef struct _ARM_STORAGE_BLOCK ARM_STORAGE_BLOCK |
A storage block is a range of memory with uniform attributes.
Storage blocks combine to make up the address map of a storage controller.
| typedef struct _ARM_STORAGE_BLOCK_ATTRIBUTES ARM_STORAGE_BLOCK_ATTRIBUTES |
Attributes of the storage range within a storage block.
| typedef void(* ARM_Storage_Callback_t) (int32_t status, ARM_STORAGE_OPERATION operation) |
Declaration of the callback-type for command completion.
| [in] | status | A code to indicate the status of the completed operation. For data transfer operations, the status field is overloaded in case of success to return the count of items successfully transferred; this can be done safely because error codes are negative values. |
| [in] | operation | The command op-code. This value isn't essential for the callback in the presence of the command instance-id, but it is expected that this information could be a quick and useful filter. |
Definition at line 242 of file Driver_Storage.h.
| typedef struct _ARM_STORAGE_CAPABILITIES ARM_STORAGE_CAPABILITIES |
Storage Driver API Capabilities.
This data structure is designed to fit within a single word so that it can be fetched cheaply using a call to driver->GetCapabilities().
| typedef struct _ARM_STORAGE_INFO ARM_STORAGE_INFO |
Storage information.
This contains device-metadata. It is the return value from calling GetInfo() on the storage driver.
These fields serve a different purpose than the ones contained in ARM_STORAGE_CAPABILITIES, which is another structure containing device-level metadata. ARM_STORAGE_CAPABILITIES describes the API capabilities, whereas ARM_STORAGE_INFO describes the device. Furthermore ARM_STORAGE_CAPABILITIES fits within a single word, and is designed to be passed around by value; ARM_STORAGE_INFO, on the other hand, contains metadata which doesn't fit into a single word and requires the use of pointers to be moved around.
| typedef enum _ARM_STORAGE_OPERATION ARM_STORAGE_OPERATION |
Command opcodes for Storage.
Completion callbacks use these codes to refer to completing commands. Refer to ARM_Storage_Callback_t.
| typedef struct _ARM_STORAGE_SECURITY_FEATURES ARM_STORAGE_SECURITY_FEATURES |
Device Data Security Protection Features.
Applicable mostly to EXTERNAL_NVM.
| typedef struct _ARM_STORAGE_STATUS ARM_STORAGE_STATUS |
Operating status of the storage controller.
| typedef enum crc_polynomial crc_polynomial_t |
CRC Polynomial value.
Different polynomial values supported
| typedef struct dac_s dac_t |
Analogout hal structure.
dac_s is declared in the target's hal
Definition at line 34 of file analogout_api.h.
| typedef struct gpio_irq_s gpio_irq_t |
GPIO IRQ HAL structure.
gpio_irq_s is declared in the target's HAL
Definition at line 42 of file gpio_irq_api.h.
| typedef struct port_s port_t |
Port HAL structure.
port_s is declared in the target's HAL
Definition at line 33 of file port_api.h.
| typedef struct pwmout_s pwmout_t |
Pwmout hal structure.
pwmout_s is declared in the target's hal
Definition at line 34 of file pwmout_api.h.
| typedef struct ticker_event_s ticker_event_t |
Ticker's event structure.
| typedef uint32_t timestamp_t |
Legacy format representing a timestamp in us.
Given it is modeled as a 32 bit integer, this type can represent timestamp up to 4294 seconds (71 minutes). Prefer using us_timestamp_t which store timestamp as 64 bits integer.
Definition at line 33 of file ticker_api.h.
| typedef struct trng_s trng_t |
TRNG HAL structure.
trng_s is declared in the target's HAL
Definition at line 30 of file trng_api.h.
| typedef uint64_t us_timestamp_t |
A us timestamp stored in a 64 bit integer.
Can store timestamp up to 584810 years.
Definition at line 39 of file ticker_api.h.
| enum _ARM_POWER_STATE |
General power states.
| Enumerator | |
|---|---|
| ARM_POWER_OFF |
Power off: no operation possible. |
| ARM_POWER_LOW |
Low Power mode: retain state, detect and signal wake-up events. |
| ARM_POWER_FULL |
Power on: full operation at maximum performance. |
Definition at line 52 of file Driver_Common.h.
Command opcodes for Storage.
Completion callbacks use these codes to refer to completing commands. Refer to ARM_Storage_Callback_t.
Definition at line 211 of file Driver_Storage.h.
| enum CANFormat |
Values that represent CAN Format.
Definition at line 35 of file can_helper.h.
| enum CANType |
Values that represent CAN Type.
Definition at line 48 of file can_helper.h.
| enum crc_polynomial |
CRC Polynomial value.
Different polynomial values supported
| enum gpio_irq_event |
GPIO IRQ events.
Definition at line 34 of file gpio_irq_api.h.
| enum SerialIrq |
Serial interrupt sources.
| Enumerator | |
|---|---|
| RxIrq |
Receive Data Register Full. |
| TxIrq |
Transmit Data Register Empty. |
Definition at line 75 of file serial_api.h.
| const PinMap* can_rd_pinmap | ( | void | ) |
| const PinMap* can_td_pinmap | ( | void | ) |
| const ticker_data_t* get_lp_ticker_wrapper_data | ( | const ticker_data_t * | data | ) |
Get wrapped lp ticker data.
| data | hardware low power ticker object |
| USBPhy* get_usb_phy | ( | ) |
| void lp_ticker_wrapper_irq_handler | ( | ticker_irq_handler_type | handler | ) |
Interrupt handler for the wrapped lp ticker.
| handler | the function which would normally be called by the lp ticker handler when it is not wrapped |
| void lp_ticker_wrapper_resume | ( | void | ) |
Resume the wrapper layer code.
Resume operation of the wrapper layer. Interrupts will be filtered as normal and the microsecond timer will be used for interrupts scheduled too quickly back-to-back.
| void lp_ticker_wrapper_suspend | ( | void | ) |
Suspend the wrapper layer code.
Pass through all interrupts to the low power ticker and stop using the microsecond ticker.
| bool pinmap_find_peripheral_pins | ( | const PinList * | whitelist, |
| const PinList * | blacklist, | ||
| int | per, | ||
| const PinMap *const * | maps, | ||
| PinName ** | pins, | ||
| uint32_t | count | ||
| ) |
Find a combination of pins suitable for use given the constraints.
This function finds pins which meet these specific properties:
Example:
| whitelist | List of pins to choose from |
| blacklist | List of pins which cannot be used |
| per | Peripheral to which the pins belong |
| maps | An array of pin maps to select from |
| pins | An array of pins to find. Pins already set to a value will be left unchanged. Only pins initialized to NC will be updated by this function |
| count | The size of maps and pins |
| bool pinmap_list_has_peripheral | ( | const PeripheralList * | list, |
| int | peripheral | ||
| ) |
Check if the peripheral is in the list.
| list | peripheral list to check |
| peripheral | peripheral to check for in the list |
| bool pinmap_list_has_pin | ( | const PinList * | list, |
| PinName | pin | ||
| ) |
Check if the pin is in the list.
| list | pin list to check |
| pin | pin to check for in the list |
| const PeripheralList* pinmap_restricted_peripherals | ( | void | ) |
Get the pin list of peripherals to avoid during testing.
The restricted peripheral list is used to indicate to testing that a peripheral should be skipped due to some caveat about it. For example, using the USB serial port during tests will interfere with the test runner and should be avoided.
Targets should override the weak implementation of this function if they have peripherals which should be skipped during testing.
| const PinList* pinmap_restricted_pins | ( | void | ) |
Get the pin list of pins to avoid during testing.
The restricted pin list is used to indicate to testing that a pin should be skipped due to some caveat about it. For example, using USBRX and USBTX during tests will interfere with the test runner and should be avoided.
Targets should override the weak implementation of this function if they have additional pins which should be skipped during testing.
| uint32_t maximum_frequency |
| uint32_t minimum_frequency |
| bool supports_10bit_addressing |
| bool supports_multi_master |
| bool supports_slave_mode |
