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 Events Macros | |
I2C Configuration Functions | |
Defined behavior | |
Synchronous I2C Hardware Abstraction Layer for slave | |
Asynchronous I2C Hardware Abstraction Layer | |
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 | |
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_pinmap_t |
struct | CAN_Message |
Holder for single CAN message. More... | |
struct | crc_mbed_config |
struct | i2c_t |
Asynch I2C HAL structure. More... | |
struct | i2c_pinmap_t |
class | LowPowerTickerWrapper |
struct | PinMap |
struct | PinList |
struct | PeripheralList |
struct | serial_t |
Asynch serial HAL structure. More... | |
struct | serial_pinmap_t |
struct | serial_fc_pinmap_t |
struct | spi_t |
Asynch SPI HAL structure. More... | |
struct | spi_pinmap_t |
struct | spi_capabilities_t |
Describes the capabilities of a SPI peripherals. 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... | |
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 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_uart_restricted_peripherals (void) |
Get the pin list of peripherals per interface to avoid during testing. More... | |
const PinList * | pinmap_gpio_restricted_pins (void) |
Get the pin list of pins to avoid during GPIO/GPIO_IRQ testing. More... | |
USBPhy * | get_usb_phy () |
Return a the USBPhy instance for this hardware. More... | |
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 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.
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 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 |
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 |
const PinList* pinmap_gpio_restricted_pins | ( | void | ) |
Get the pin list of pins to avoid during GPIO/GPIO_IRQ testing.
The GPIO restricted pin list is used to indicate to testing that a pin should be skipped due to some caveat about it.
Targets should override the weak implementation of this function if they have peripherals which should be skipped during testing.
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 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 CONSOLE_RX and CONSOLE_TX 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.
const PeripheralList* pinmap_uart_restricted_peripherals | ( | void | ) |
Get the pin list of peripherals per interface 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.