Define the behaviour of FreeRTOS ASF read and write functions for a peripheral.
#include <freertos_peripheral_control.h>
Data Fields | |
| uint32_t | interrupt_priority |
| Sets the priority of the interrupt generated by the PDC, which MUST be between the lowest possible priority and configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY. More... | |
| enum peripheral_operation_mode | operation_mode |
| operation_mode is included to allow future FreeRTOS ASF driver versions to support multiple modes of operation on a single peripheral. More... | |
| uint8_t | options_flags |
| Individual bits in the options_flags value configure an aspect of the driver's behavior, where valid bits (which are documented as part of the FreeRTOS Peripheral Control documentation) are USE_TX_ACCESS_SEM, USE_RX_ACCESS_MUTEX, WAIT_TX_COMPLETE, WAIT_RX_COMPLETE. More... | |
| uint8_t * | receive_buffer |
| A pointer to a buffer into which the PDC will write received data. More... | |
| uint32_t | receive_buffer_size |
| The size, in bytes, of the buffer pointed to by the receive_buffer member. More... | |
| uint32_t freertos_peripheral_options::interrupt_priority |
Sets the priority of the interrupt generated by the PDC, which MUST be between the lowest possible priority and configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY.
PDC interrupts are configured and processed by the FreeRTOS ASF drivers. The application writer does not need to concern themselves with installing or handling interrupts. The interrupt priority must not be set above configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY, as defined in FreeRTOSConfig.h. Invalid priority values are trapped by an assert() in the driver code, but only if configASSERT() is defined in FreeRTOSConfig.h.
Referenced by freertos_spi_master_init(), freertos_twi_master_init(), freertos_uart_serial_init(), and freertos_usart_serial_init().
| enum peripheral_operation_mode freertos_peripheral_options::operation_mode |
operation_mode is included to allow future FreeRTOS ASF driver versions to support multiple modes of operation on a single peripheral.
Referenced by freertos_spi_master_init(), freertos_twi_master_init(), freertos_uart_serial_init(), and freertos_usart_serial_init().
| uint8_t freertos_peripheral_options::options_flags |
Individual bits in the options_flags value configure an aspect of the driver's behavior, where valid bits (which are documented as part of the FreeRTOS Peripheral Control documentation) are USE_TX_ACCESS_SEM, USE_RX_ACCESS_MUTEX, WAIT_TX_COMPLETE, WAIT_RX_COMPLETE.
Referenced by freertos_spi_master_init(), freertos_twi_master_init(), freertos_uart_serial_init(), and freertos_usart_serial_init().
| uint8_t* freertos_peripheral_options::receive_buffer |
A pointer to a buffer into which the PDC will write received data.
This parameter is, at the time of writing, only required by the USART/UART driver, and is ignored by other drivers.
Referenced by freertos_uart_serial_init(), and freertos_usart_serial_init().
| uint32_t freertos_peripheral_options::receive_buffer_size |
The size, in bytes, of the buffer pointed to by the receive_buffer member.
This parameter is, at the time of writing, only required by the USART/UART driver, and is ignored by other drivers.
Referenced by freertos_uart_serial_init(), and freertos_usart_serial_init().
1.8.5