HAL_CONF

Macros
#define	HAL_USE_PAL   TRUE
	Enables the PAL subsystem. More...
#define	HAL_USE_ADC   TRUE
	Enables the ADC subsystem. More...
#define	HAL_USE_CAN   FALSE
	Enables the CAN subsystem. More...
#define	HAL_USE_DAC   FALSE
	Enables the DAC subsystem. More...
#define	HAL_USE_EXT   TRUE
	Enables the EXT subsystem. More...
#define	HAL_USE_GPT   FALSE
	Enables the GPT subsystem. We don't need it on most boards in ArduPilot, so it is disabled by default. More...
#define	HAL_USE_I2C   TRUE
	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_QSPI   FALSE
	Enables the QSPI subsystem. More...
#define	HAL_USE_RTC   FALSE
	Enables the RTC subsystem. More...
#define	HAL_USE_SDC   TRUE
	Enables the SDC subsystem. More...
#define	HAL_USE_SERIAL   TRUE
	Enables the SERIAL subsystem. More...
#define	HAL_USE_SERIAL_USB   FALSE
	Enables the SERIAL over USB subsystem. More...
#define	HAL_USE_SPI   TRUE
	Enables the SPI 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	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	I2C_USE_MUTUAL_EXCLUSION   TRUE
	Enables the mutual exclusion APIs on the I2C bus. More...
#define	MAC_USE_ZERO_COPY   FALSE
	Enables an event sources for incoming packets. More...
#define	MAC_USE_EVENTS   TRUE
	Enables an event sources for incoming packets. More...
#define	MMC_NICE_WAITING   TRUE
	Delays insertions. 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	SERIAL_DEFAULT_BITRATE   38400
	Default bit rate. More...
#define	SERIAL_BUFFERS_SIZE   1024
	Serial buffers size. 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_MUTUAL_EXCLUSION   TRUE
	Enables the spiAcquireBus() and spiReleaseBus() APIs. 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...

Detailed Description

Macro Definition Documentation

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 212 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 204 of file halconf.h.

CAN_USE_SLEEP_MODE

#define CAN_USE_SLEEP_MODE   TRUE

Sleep mode related APIs inclusion switch.

Definition at line 223 of file halconf.h.

HAL_USE_ADC

#define HAL_USE_ADC   TRUE

Enables the ADC subsystem.

Definition at line 58 of file halconf.h.

HAL_USE_CAN

#define HAL_USE_CAN   FALSE

Enables the CAN subsystem.

Definition at line 65 of file halconf.h.

HAL_USE_DAC

#define HAL_USE_DAC   FALSE

Enables the DAC subsystem.

Definition at line 72 of file halconf.h.

HAL_USE_EXT

#define HAL_USE_EXT   TRUE

Enables the EXT subsystem.

Definition at line 79 of file halconf.h.

HAL_USE_GPT

#define HAL_USE_GPT   FALSE

Enables the GPT subsystem. We don't need it on most boards in ArduPilot, so it is disabled by default.

Definition at line 87 of file halconf.h.

HAL_USE_I2C

#define HAL_USE_I2C   TRUE

Enables the I2C subsystem.

Definition at line 94 of file halconf.h.

HAL_USE_I2S

#define HAL_USE_I2S   FALSE

Enables the I2S subsystem.

Definition at line 101 of file halconf.h.

HAL_USE_ICU

#define HAL_USE_ICU   FALSE

Enables the ICU subsystem.

Definition at line 108 of file halconf.h.

HAL_USE_MAC

#define HAL_USE_MAC   FALSE

Enables the MAC subsystem.

Definition at line 115 of file halconf.h.

HAL_USE_MMC_SPI

#define HAL_USE_MMC_SPI   FALSE

Enables the MMC_SPI subsystem.

Definition at line 122 of file halconf.h.

HAL_USE_PAL

#define HAL_USE_PAL   TRUE

Enables the PAL subsystem.

Definition at line 51 of file halconf.h.

HAL_USE_PWM

#define HAL_USE_PWM   TRUE

Enables the PWM subsystem.

Definition at line 129 of file halconf.h.

HAL_USE_QSPI

#define HAL_USE_QSPI   FALSE

Enables the QSPI subsystem.

Definition at line 136 of file halconf.h.

HAL_USE_RTC

#define HAL_USE_RTC   FALSE

Enables the RTC subsystem.

Definition at line 143 of file halconf.h.

HAL_USE_SDC

#define HAL_USE_SDC   TRUE

Enables the SDC subsystem.

Definition at line 150 of file halconf.h.

HAL_USE_SERIAL

#define HAL_USE_SERIAL   TRUE

Enables the SERIAL subsystem.

Definition at line 157 of file halconf.h.

HAL_USE_SERIAL_USB

#define HAL_USE_SERIAL_USB   FALSE

Enables the SERIAL over USB subsystem.

Definition at line 164 of file halconf.h.

HAL_USE_SPI

#define HAL_USE_SPI   TRUE

Enables the SPI subsystem.

Definition at line 171 of file halconf.h.

HAL_USE_UART

#define HAL_USE_UART   FALSE

Enables the UART subsystem.

Definition at line 178 of file halconf.h.

HAL_USE_USB

#define HAL_USE_USB   FALSE

Enables the USB subsystem.

Definition at line 185 of file halconf.h.

HAL_USE_WDG

#define HAL_USE_WDG   FALSE

Enables the WDG subsystem.

Definition at line 192 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 234 of file halconf.h.

MAC_USE_EVENTS

#define MAC_USE_EVENTS   TRUE

Enables an event sources for incoming packets.

Definition at line 252 of file halconf.h.

MAC_USE_ZERO_COPY

#define MAC_USE_ZERO_COPY   FALSE

Enables an event sources for incoming packets.

Definition at line 245 of file halconf.h.

MMC_NICE_WAITING

#define MMC_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. This option is recommended also if the SPI driver does not use a DMA channel and heavily loads the CPU.

Definition at line 268 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 280 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 289 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 299 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 323 of file halconf.h.

SERIAL_DEFAULT_BITRATE

#define SERIAL_DEFAULT_BITRATE   38400

Default bit rate.

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

Definition at line 312 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 346 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 338 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 366 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 358 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 386 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 378 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 398 of file halconf.h.