Macros
#define	_CHIBIOS_HAL_CONF_

#define	_CHIBIOS_HAL_CONF_VER_8_4_

#define	HAL_USE_PAL TRUE
	Enables the PAL subsystem. More...

#define	HAL_USE_ADC FALSE
	Enables the ADC subsystem. More...

#define	HAL_USE_CAN FALSE
	Enables the CAN subsystem. More...

#define	HAL_USE_CRY FALSE
	Enables the cryptographic subsystem. More...

#define	HAL_USE_DAC FALSE
	Enables the DAC subsystem. More...

#define	HAL_USE_EFL FALSE
	Enables the EFlash subsystem. More...

#define	HAL_USE_GPT FALSE
	Enables the GPT subsystem. More...

#define	HAL_USE_I2C FALSE
	Enables the I2C subsystem. More...

#define	HAL_USE_I2S FALSE
	Enables the I2S subsystem. More...

#define	HAL_USE_ICU FALSE
	Enables the ICU subsystem. More...

#define	HAL_USE_MAC FALSE
	Enables the MAC subsystem. More...

#define	HAL_USE_MMC_SPI FALSE
	Enables the MMC_SPI subsystem. More...

#define	HAL_USE_PWM TRUE
	Enables the PWM subsystem. More...

#define	HAL_USE_RTC FALSE
	Enables the RTC subsystem. More...

#define	HAL_USE_SDC FALSE
	Enables the SDC subsystem. More...

#define	HAL_USE_SERIAL FALSE
	Enables the SERIAL subsystem. More...

#define	HAL_USE_SERIAL_USB FALSE
	Enables the SERIAL over USB subsystem. More...

#define	HAL_USE_SIO FALSE
	Enables the SIO subsystem. More...

#define	HAL_USE_SPI FALSE
	Enables the SPI subsystem. More...

#define	HAL_USE_TRNG FALSE
	Enables the TRNG subsystem. More...

#define	HAL_USE_UART FALSE
	Enables the UART subsystem. More...

#define	HAL_USE_USB FALSE
	Enables the USB subsystem. More...

#define	HAL_USE_WDG FALSE
	Enables the WDG subsystem. More...

#define	HAL_USE_WSPI FALSE
	Enables the WSPI subsystem. More...

#define	PAL_USE_CALLBACKS FALSE
	Enables synchronous APIs. More...

#define	PAL_USE_WAIT TRUE
	Enables synchronous APIs. More...

#define	ADC_USE_WAIT TRUE
	Enables synchronous APIs. More...

#define	ADC_USE_MUTUAL_EXCLUSION TRUE
	Enables the `adcAcquireBus()` and `adcReleaseBus()` APIs. More...

#define	CAN_USE_SLEEP_MODE TRUE
	Sleep mode related APIs inclusion switch. More...

#define	CAN_ENFORCE_USE_CALLBACKS FALSE
	Enforces the driver to use direct callbacks rather than OSAL events. More...

#define	HAL_CRY_USE_FALLBACK FALSE
	Enables the SW fall-back of the cryptographic driver. More...

#define	HAL_CRY_ENFORCE_FALLBACK FALSE
	Makes the driver forcibly use the fall-back implementations. More...

#define	DAC_USE_WAIT TRUE
	Enables synchronous APIs. More...

#define	DAC_USE_MUTUAL_EXCLUSION TRUE
	Enables the `dacAcquireBus()` and `dacReleaseBus()` APIs. More...

#define	I2C_USE_MUTUAL_EXCLUSION TRUE
	Enables the mutual exclusion APIs on the I2C bus. More...

#define	MAC_USE_ZERO_COPY FALSE
	Enables the zero-copy API. More...

#define	MAC_USE_EVENTS TRUE
	Enables an event sources for incoming packets. More...

#define	MMC_IDLE_TIMEOUT_MS 1000
	Timeout before assuming a failure while waiting for card idle. More...

#define	MMC_USE_MUTUAL_EXCLUSION TRUE
	Mutual exclusion on the SPI bus. More...

#define	SDC_INIT_RETRY 100
	Number of initialization attempts before rejecting the card. More...

#define	SDC_MMC_SUPPORT FALSE
	Include support for MMC cards. More...

#define	SDC_NICE_WAITING TRUE
	Delays insertions. More...

#define	SDC_INIT_OCR_V20 0x50FF8000U
	OCR initialization constant for V20 cards. More...

#define	SDC_INIT_OCR 0x80100000U
	OCR initialization constant for non-V20 cards. More...

#define	SERIAL_DEFAULT_BITRATE 57600
	Default bit rate. More...

#define	SERIAL_BUFFERS_SIZE 1024
	Serial buffers size. More...

#define	SIO_DEFAULT_BITRATE 38400
	Default bit rate. More...

#define	SIO_USE_SYNCHRONIZATION TRUE
	Support for thread synchronization API. More...

#define	SERIAL_USB_BUFFERS_SIZE 256
	Serial over USB buffers size. More...

#define	SERIAL_USB_BUFFERS_NUMBER 2
	Serial over USB number of buffers. More...

#define	SPI_USE_WAIT TRUE
	Enables synchronous APIs. More...

#define	SPI_USE_ASSERT_ON_ERROR TRUE
	Inserts an assertion on function errors before returning. More...

#define	SPI_USE_MUTUAL_EXCLUSION TRUE
	Enables the `spiAcquireBus()` and `spiReleaseBus()` APIs. More...

#define	SPI_SELECT_MODE SPI_SELECT_MODE_PAD
	Handling method for SPI CS line. More...

#define	UART_USE_WAIT FALSE
	Enables synchronous APIs. More...

#define	UART_USE_MUTUAL_EXCLUSION FALSE
	Enables the `uartAcquireBus()` and `uartReleaseBus()` APIs. More...

#define	USB_USE_WAIT FALSE
	Enables synchronous APIs. More...

#define	WSPI_USE_WAIT TRUE
	Enables synchronous APIs. More...

#define	WSPI_USE_MUTUAL_EXCLUSION TRUE
	Enables the `wspiAcquireBus()` and `wspiReleaseBus()` APIs. More...

Detailed Description

Macro Definition Documentation

◆ _CHIBIOS_HAL_CONF_

#define _CHIBIOS_HAL_CONF_

Definition at line 31 of file halconf.h.

◆ _CHIBIOS_HAL_CONF_VER_8_4_

#define _CHIBIOS_HAL_CONF_VER_8_4_

Definition at line 32 of file halconf.h.

◆ ADC_USE_MUTUAL_EXCLUSION

#define ADC_USE_MUTUAL_EXCLUSION TRUE

Enables the adcAcquireBus() and adcReleaseBus() APIs.

Note: Disabling this option saves both code and data space.

Definition at line 282 of file halconf.h.

◆ ADC_USE_WAIT

#define ADC_USE_WAIT TRUE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 274 of file halconf.h.

◆ CAN_ENFORCE_USE_CALLBACKS

#define CAN_ENFORCE_USE_CALLBACKS FALSE

Enforces the driver to use direct callbacks rather than OSAL events.

Definition at line 300 of file halconf.h.

◆ CAN_USE_SLEEP_MODE

#define CAN_USE_SLEEP_MODE TRUE

Sleep mode related APIs inclusion switch.

Definition at line 293 of file halconf.h.

◆ DAC_USE_MUTUAL_EXCLUSION

#define DAC_USE_MUTUAL_EXCLUSION TRUE

Enables the dacAcquireBus() and dacReleaseBus() APIs.

Note: Disabling this option saves both code and data space.

Definition at line 342 of file halconf.h.

◆ DAC_USE_WAIT

#define DAC_USE_WAIT TRUE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 334 of file halconf.h.

◆ HAL_CRY_ENFORCE_FALLBACK

#define HAL_CRY_ENFORCE_FALLBACK FALSE

Makes the driver forcibly use the fall-back implementations.

Definition at line 322 of file halconf.h.

◆ HAL_CRY_USE_FALLBACK

#define HAL_CRY_USE_FALLBACK FALSE

Enables the SW fall-back of the cryptographic driver.

When enabled, this option, activates a fall-back software implementation for algorithms not supported by the underlying hardware.

Note: Fall-back implementations may not be present for all algorithms.

Definition at line 315 of file halconf.h.

◆ HAL_USE_ADC

#define HAL_USE_ADC FALSE

Enables the ADC subsystem.

Definition at line 50 of file halconf.h.

◆ HAL_USE_CAN

#define HAL_USE_CAN FALSE

Enables the CAN subsystem.

Definition at line 61 of file halconf.h.

◆ HAL_USE_CRY

#define HAL_USE_CRY FALSE

Enables the cryptographic subsystem.

Definition at line 69 of file halconf.h.

◆ HAL_USE_DAC

#define HAL_USE_DAC FALSE

Enables the DAC subsystem.

Definition at line 79 of file halconf.h.

◆ HAL_USE_EFL

#define HAL_USE_EFL FALSE

Enables the EFlash subsystem.

Definition at line 87 of file halconf.h.

◆ HAL_USE_GPT

#define HAL_USE_GPT FALSE

Enables the GPT subsystem.

Definition at line 98 of file halconf.h.

◆ HAL_USE_I2C

#define HAL_USE_I2C FALSE

Enables the I2C subsystem.

Definition at line 109 of file halconf.h.

◆ HAL_USE_I2S

#define HAL_USE_I2S FALSE

Enables the I2S subsystem.

Definition at line 117 of file halconf.h.

◆ HAL_USE_ICU

#define HAL_USE_ICU FALSE

Enables the ICU subsystem.

Definition at line 127 of file halconf.h.

◆ HAL_USE_MAC

#define HAL_USE_MAC FALSE

Enables the MAC subsystem.

Definition at line 135 of file halconf.h.

◆ HAL_USE_MMC_SPI

#define HAL_USE_MMC_SPI FALSE

Enables the MMC_SPI subsystem.

Definition at line 142 of file halconf.h.

◆ HAL_USE_PAL

#define HAL_USE_PAL TRUE

Enables the PAL subsystem.

Definition at line 40 of file halconf.h.

◆ HAL_USE_PWM

#define HAL_USE_PWM TRUE

Enables the PWM subsystem.

Definition at line 149 of file halconf.h.

◆ HAL_USE_RTC

#define HAL_USE_RTC FALSE

Enables the RTC subsystem.

Definition at line 156 of file halconf.h.

◆ HAL_USE_SDC

#define HAL_USE_SDC FALSE

Enables the SDC subsystem.

Definition at line 163 of file halconf.h.

◆ HAL_USE_SERIAL

#define HAL_USE_SERIAL FALSE

Enables the SERIAL subsystem.

Definition at line 173 of file halconf.h.

◆ HAL_USE_SERIAL_USB

#define HAL_USE_SERIAL_USB FALSE

Enables the SERIAL over USB subsystem.

Definition at line 184 of file halconf.h.

◆ HAL_USE_SIO

#define HAL_USE_SIO FALSE

Enables the SIO subsystem.

Definition at line 192 of file halconf.h.

◆ HAL_USE_SPI

#define HAL_USE_SPI FALSE

Enables the SPI subsystem.

Definition at line 202 of file halconf.h.

◆ HAL_USE_TRNG

#define HAL_USE_TRNG FALSE

Enables the TRNG subsystem.

Definition at line 210 of file halconf.h.

◆ HAL_USE_UART

#define HAL_USE_UART FALSE

Enables the UART subsystem.

Definition at line 217 of file halconf.h.

◆ HAL_USE_USB

#define HAL_USE_USB FALSE

Enables the USB subsystem.

Definition at line 227 of file halconf.h.

◆ HAL_USE_WDG

#define HAL_USE_WDG FALSE

Enables the WDG subsystem.

Definition at line 235 of file halconf.h.

◆ HAL_USE_WSPI

#define HAL_USE_WSPI FALSE

Enables the WSPI subsystem.

Definition at line 242 of file halconf.h.

◆ I2C_USE_MUTUAL_EXCLUSION

#define I2C_USE_MUTUAL_EXCLUSION TRUE

Enables the mutual exclusion APIs on the I2C bus.

Definition at line 353 of file halconf.h.

◆ MAC_USE_EVENTS

#define MAC_USE_EVENTS TRUE

Enables an event sources for incoming packets.

Definition at line 371 of file halconf.h.

◆ MAC_USE_ZERO_COPY

#define MAC_USE_ZERO_COPY FALSE

Enables the zero-copy API.

Definition at line 364 of file halconf.h.

◆ MMC_IDLE_TIMEOUT_MS

#define MMC_IDLE_TIMEOUT_MS 1000

Timeout before assuming a failure while waiting for card idle.

Note: Time is in milliseconds.

Definition at line 383 of file halconf.h.

◆ MMC_USE_MUTUAL_EXCLUSION

#define MMC_USE_MUTUAL_EXCLUSION TRUE

Mutual exclusion on the SPI bus.

Definition at line 390 of file halconf.h.

◆ PAL_USE_CALLBACKS

#define PAL_USE_CALLBACKS FALSE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 254 of file halconf.h.

◆ PAL_USE_WAIT

#define PAL_USE_WAIT TRUE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 262 of file halconf.h.

◆ SDC_INIT_OCR

#define SDC_INIT_OCR 0x80100000U

OCR initialization constant for non-V20 cards.

Definition at line 435 of file halconf.h.

◆ SDC_INIT_OCR_V20

#define SDC_INIT_OCR_V20 0x50FF8000U

OCR initialization constant for V20 cards.

Definition at line 428 of file halconf.h.

◆ SDC_INIT_RETRY

#define SDC_INIT_RETRY 100

Number of initialization attempts before rejecting the card.

Note: Attempts are performed at 10mS intervals.

Definition at line 402 of file halconf.h.

◆ SDC_MMC_SUPPORT

#define SDC_MMC_SUPPORT FALSE

Include support for MMC cards.

Note: MMC support is not yet implemented so this option must be kept at FALSE.

Definition at line 411 of file halconf.h.

◆ SDC_NICE_WAITING

#define SDC_NICE_WAITING TRUE

Delays insertions.

If enabled this options inserts delays into the MMC waiting routines releasing some extra CPU time for the threads with lower priority, this may slow down the driver a bit however.

Definition at line 421 of file halconf.h.

◆ SERIAL_BUFFERS_SIZE

#define SERIAL_BUFFERS_SIZE 1024

Serial buffers size.

Configuration parameter, you can change the depth of the queue buffers depending on the requirements of your application.

Note: The default is 16 bytes for both the transmission and receive buffers.

Definition at line 459 of file halconf.h.

◆ SERIAL_DEFAULT_BITRATE

#define SERIAL_DEFAULT_BITRATE 57600

Default bit rate.

Configuration parameter, this is the baud rate selected for the default configuration.

Definition at line 448 of file halconf.h.

◆ SERIAL_USB_BUFFERS_NUMBER

#define SERIAL_USB_BUFFERS_NUMBER 2

Serial over USB number of buffers.

Note: The default is 2 buffers.

Definition at line 502 of file halconf.h.

◆ SERIAL_USB_BUFFERS_SIZE

#define SERIAL_USB_BUFFERS_SIZE 256

Serial over USB buffers size.

Configuration parameter, the buffer size must be a multiple of the USB data endpoint maximum packet size.

Note: The default is 256 bytes for both the transmission and receive buffers.

Definition at line 494 of file halconf.h.

◆ SIO_DEFAULT_BITRATE

#define SIO_DEFAULT_BITRATE 38400

Default bit rate.

Configuration parameter, this is the baud rate selected for the default configuration.

Definition at line 472 of file halconf.h.

◆ SIO_USE_SYNCHRONIZATION

#define SIO_USE_SYNCHRONIZATION TRUE

Support for thread synchronization API.

Definition at line 479 of file halconf.h.

◆ SPI_SELECT_MODE

#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD

Handling method for SPI CS line.

Note: Disabling this option saves both code and data space.

Definition at line 537 of file halconf.h.

◆ SPI_USE_ASSERT_ON_ERROR

#define SPI_USE_ASSERT_ON_ERROR TRUE

Inserts an assertion on function errors before returning.

Definition at line 521 of file halconf.h.

◆ SPI_USE_MUTUAL_EXCLUSION

#define SPI_USE_MUTUAL_EXCLUSION TRUE

Enables the spiAcquireBus() and spiReleaseBus() APIs.

Note: Disabling this option saves both code and data space.

Definition at line 529 of file halconf.h.

◆ SPI_USE_WAIT

#define SPI_USE_WAIT TRUE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 514 of file halconf.h.

◆ UART_USE_MUTUAL_EXCLUSION

#define UART_USE_MUTUAL_EXCLUSION FALSE

Enables the uartAcquireBus() and uartReleaseBus() APIs.

Note: Disabling this option saves both code and data space.

Definition at line 557 of file halconf.h.

◆ UART_USE_WAIT

#define UART_USE_WAIT FALSE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 549 of file halconf.h.

◆ USB_USE_WAIT

#define USB_USE_WAIT FALSE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 569 of file halconf.h.

◆ WSPI_USE_MUTUAL_EXCLUSION

#define WSPI_USE_MUTUAL_EXCLUSION TRUE

Enables the wspiAcquireBus() and wspiReleaseBus() APIs.

Note: Disabling this option saves both code and data space.

Definition at line 589 of file halconf.h.

◆ WSPI_USE_WAIT

#define WSPI_USE_WAIT TRUE

Enables synchronous APIs.

Note: Disabling this option saves both code and data space.

Definition at line 581 of file halconf.h.

Macros

Detailed Description

Macro Definition Documentation

◆ _CHIBIOS_HAL_CONF_

◆ _CHIBIOS_HAL_CONF_VER_8_4_

◆ ADC_USE_MUTUAL_EXCLUSION

◆ ADC_USE_WAIT

◆ CAN_ENFORCE_USE_CALLBACKS

◆ CAN_USE_SLEEP_MODE

◆ DAC_USE_MUTUAL_EXCLUSION

◆ DAC_USE_WAIT

◆ HAL_CRY_ENFORCE_FALLBACK

◆ HAL_CRY_USE_FALLBACK

◆ HAL_USE_ADC

◆ HAL_USE_CAN

◆ HAL_USE_CRY

◆ HAL_USE_DAC

◆ HAL_USE_EFL

◆ HAL_USE_GPT

◆ HAL_USE_I2C

◆ HAL_USE_I2S

◆ HAL_USE_ICU

◆ HAL_USE_MAC

◆ HAL_USE_MMC_SPI

◆ HAL_USE_PAL

◆ HAL_USE_PWM

◆ HAL_USE_RTC

◆ HAL_USE_SDC

◆ HAL_USE_SERIAL

◆ HAL_USE_SERIAL_USB

◆ HAL_USE_SIO

◆ HAL_USE_SPI

◆ HAL_USE_TRNG

◆ HAL_USE_UART

◆ HAL_USE_USB

◆ HAL_USE_WDG

◆ HAL_USE_WSPI

◆ I2C_USE_MUTUAL_EXCLUSION

◆ MAC_USE_EVENTS

◆ MAC_USE_ZERO_COPY

◆ MMC_IDLE_TIMEOUT_MS

◆ MMC_USE_MUTUAL_EXCLUSION

◆ PAL_USE_CALLBACKS

◆ PAL_USE_WAIT

◆ SDC_INIT_OCR

◆ SDC_INIT_OCR_V20

◆ SDC_INIT_RETRY

◆ SDC_MMC_SUPPORT

◆ SDC_NICE_WAITING

◆ SERIAL_BUFFERS_SIZE

◆ SERIAL_DEFAULT_BITRATE

◆ SERIAL_USB_BUFFERS_NUMBER

◆ SERIAL_USB_BUFFERS_SIZE

◆ SIO_DEFAULT_BITRATE

◆ SIO_USE_SYNCHRONIZATION

◆ SPI_SELECT_MODE

◆ SPI_USE_ASSERT_ON_ERROR

◆ SPI_USE_MUTUAL_EXCLUSION

◆ SPI_USE_WAIT

◆ UART_USE_MUTUAL_EXCLUSION

◆ UART_USE_WAIT

◆ USB_USE_WAIT

◆ WSPI_USE_MUTUAL_EXCLUSION

◆ WSPI_USE_WAIT