 |
MAX32665 Peripheral Driver API
Peripheral Driver API for the MAX32665
|
47 #include "uart_regs.h"
51 #define IBRO_FREQ HIRC8_FREQ
int MXC_UART_AbortTransmission(mxc_uart_regs_t *uart)
Aborts an ongoing UART Transmission.
uint32_t txCnt
Number of bytes actually transmitted from txData.
Definition: uart.h:138
mxc_uart_stop_t
The list of UART stop bit lengths supported.
Definition: uart.h:68
@ MXC_UART_PARITY_ODD
UART Parity Odd.
Definition: uart.h:80
int MXC_UART_ReadyForSleep(mxc_uart_regs_t *uart)
Checks if the given UART bus can be placed in sleep more.
int MXC_UART_GetActive(mxc_uart_regs_t *uart)
Checks the UART Peripheral for an ongoing transmission.
int MXC_UART_SetDataSize(mxc_uart_regs_t *uart, int dataSize)
Sets the number of bits per character.
@ MXC_UART_PARITY_MARK_1
UART Parity Mark, 1 based.
Definition: uart.h:88
int MXC_UART_WriteTXFIFODMA(mxc_uart_regs_t *uart, unsigned char *bytes, unsigned int len, mxc_uart_dma_complete_cb_t callback)
Loads bytes into the transmit FIFO using DMA for longer writes.
uint8_t * txData
Definition: uart.h:128
int MXC_UART_WriteCharacter(mxc_uart_regs_t *uart, uint8_t character)
Writes a character on the UART. This function will block until the character has been placed in the T...
uint32_t rxCnt
Number of bytes stored in rxData.
Definition: uart.h:139
int MXC_UART_SetRXThreshold(mxc_uart_regs_t *uart, unsigned int numBytes)
Set the receive threshold level.
int MXC_UART_SetClockSource(mxc_uart_regs_t *uart, int usePCLK)
Sets the clock source for the baud rate generator.
int MXC_UART_ReadRXFIFODMA(mxc_uart_regs_t *uart, unsigned char *bytes, unsigned int len, mxc_uart_dma_complete_cb_t callback)
Unloads bytes from the receive FIFO user DMA for longer reads.
int MXC_UART_Init(mxc_uart_regs_t *uart, unsigned int baud, sys_map_t map)
Initialize and enable UART peripheral.
unsigned int MXC_UART_ReadRXFIFO(mxc_uart_regs_t *uart, unsigned char *bytes, unsigned int len)
Unloads bytes from the receive FIFO.
@ MXC_UART_PARITY_EVEN_1
UART Parity Even, 1 based.
Definition: uart.h:84
void MXC_UART_AsyncCallback(mxc_uart_regs_t *uart, int retVal)
Async callback.
void MXC_UART_AsyncStop(mxc_uart_regs_t *uart)
stop any async callbacks
The information required to perform a complete UART transaction.
Definition: uart.h:126
void MXC_UART_DisableInt(mxc_uart_regs_t *uart, unsigned int intDis)
Disables specific interrupts.
@ MXC_UART_PARITY_SPACE_1
UART Parity Space, 1 based.
Definition: uart.h:90
uint8_t * rxData
Definition: uart.h:132
unsigned int MXC_UART_GetRXThreshold(mxc_uart_regs_t *uart)
Get the current receive threshold level.
@ MXC_UART_PARITY_MARK
UART Parity Mark.
Definition: uart.h:81
uint32_t txLen
Number of bytes to be sent from txData.
Definition: uart.h:136
unsigned int MXC_UART_GetStatus(mxc_uart_regs_t *uart)
Gets the status flags that are currently set.
int MXC_UART_SetFrequency(mxc_uart_regs_t *uart, unsigned int baud)
Set the frequency of the UART interface.
@ MXC_UART_STOP_1
UART Stop 1 clock cycle.
Definition: uart.h:69
mxc_uart_flow_t
The list of UART flow control options supported.
Definition: uart.h:97
@ MXC_UART_STOP_2
UART Stop 2 clock cycle (1.5 clocks for 5 bit characters)
Definition: uart.h:70
int MXC_UART_SetStopBits(mxc_uart_regs_t *uart, mxc_uart_stop_t stopBits)
Sets the number of stop bits sent at the end of a character.
Definition: uart_regs.h:88
unsigned int MXC_UART_WriteTXFIFO(mxc_uart_regs_t *uart, unsigned char *bytes, unsigned int len)
Loads bytes into the transmit FIFO.
void MXC_UART_ClearFlags(mxc_uart_regs_t *uart, unsigned int flags)
Clears the interrupt flags that are currently set.
int MXC_UART_SendBreak(mxc_uart_regs_t *uart)
Transmits a Break Frame (all bits 0)
int MXC_UART_TransactionDMA(mxc_uart_req_t *req)
Setup a DMA driven UART transaction.
void MXC_UART_ClearRXFIFO(mxc_uart_regs_t *uart)
Removes and discards all bytes currently in the receive FIFO.
mxc_uart_complete_cb_t callback
Pointer to function called when transaction is complete.
Definition: uart.h:141
unsigned int MXC_UART_GetTXThreshold(mxc_uart_regs_t *uart)
Get the current transmit threshold level.
void MXC_UART_AsyncHandler(mxc_uart_regs_t *uart)
The processing function for asynchronous transactions.
mxc_uart_regs_t * uart
Point to UART registers.
Definition: uart.h:127
int MXC_UART_Write(mxc_uart_regs_t *uart, uint8_t *byte, int *len)
Writes a byte on the UART.
int MXC_UART_SetTXThreshold(mxc_uart_regs_t *uart, unsigned int numBytes)
Set the transmit threshold level.
@ MXC_UART_FLOW_EN_LOW
UART Flow Control Enabled, Active Low.
Definition: uart.h:99
@ MXC_UART_FLOW_DIS
UART Flow Control Disabled.
Definition: uart.h:98
unsigned int MXC_UART_GetTXFIFOAvailable(mxc_uart_regs_t *uart)
Get the amount of free space available in the transmit FIFO.
mxc_uart_parity_t
The list of UART Parity options supported.
Definition: uart.h:77
@ MXC_UART_PARITY_EVEN_0
UART Parity Even, 0 based.
Definition: uart.h:83
@ MXC_UART_PARITY_DISABLE
UART Parity Disabled.
Definition: uart.h:78
int MXC_UART_SetParity(mxc_uart_regs_t *uart, mxc_uart_parity_t parity)
Sets the type of parity generation used.
int MXC_UART_ReadCharacter(mxc_uart_regs_t *uart)
Reads the next available character. This function will block until a character is available or a UART...
int MXC_UART_SetFlowCtrl(mxc_uart_regs_t *uart, mxc_uart_flow_t flowCtrl, int rtsThreshold, sys_map_t map)
Sets the flow control used.
void MXC_UART_AbortAsync(mxc_uart_regs_t *uart)
Abort any asynchronous requests in progress.
int MXC_UART_GetFrequency(mxc_uart_regs_t *uart)
Get the frequency of the UART interface.
int MXC_UART_TransactionAsync(mxc_uart_req_t *req)
Setup an interrupt-driven UART transaction.
int MXC_UART_WriteCharacterRaw(mxc_uart_regs_t *uart, uint8_t character)
Writes a character on the UART. If the character cannot be written because the transmit FIFO is curre...
int MXC_UART_SetNullModem(mxc_uart_regs_t *uart, int nullModem)
Enables or Disables the built-in null modem.
@ MXC_UART_PARITY_SPACE_0
UART Parity Space, 0 based.
Definition: uart.h:89
@ MXC_UART_PARITY_MARK_0
UART Parity Mark, 0 based.
Definition: uart.h:87
@ MXC_UART_PARITY_SPACE
UART Parity Space.
Definition: uart.h:82
int MXC_UART_Shutdown(mxc_uart_regs_t *uart)
Disable and shutdown UART peripheral.
int MXC_UART_Transaction(mxc_uart_req_t *req)
Performs a blocking UART transaction.
int MXC_UART_ReadCharacterRaw(mxc_uart_regs_t *uart)
Reads the next available character. If no character is available, this function will return an error.
uint32_t rxLen
Number of bytes to be stored in rxData.
Definition: uart.h:137
void MXC_UART_EnableInt(mxc_uart_regs_t *uart, unsigned int intEn)
Enables specific interrupts.
unsigned int MXC_UART_GetRXFIFOAvailable(mxc_uart_regs_t *uart)
Get the number of bytes currently available in the receive FIFO.
@ MXC_UART_PARITY_EVEN
UART Parity Even.
Definition: uart.h:79
void MXC_UART_ClearTXFIFO(mxc_uart_regs_t *uart)
Removes and discards all bytes currently in the transmit FIFO.
void(* mxc_uart_dma_complete_cb_t)(mxc_uart_req_t *req, int num, int result)
The callback routine used to indicate the transaction has terminated.
Definition: uart.h:118
@ MXC_UART_FLOW_EN_HIGH
UART Flow Control Enabled, Active High.
Definition: uart.h:100
@ MXC_UART_PARITY_ODD_1
UART Parity Odd, 1 based.
Definition: uart.h:86
unsigned int MXC_UART_GetFlags(mxc_uart_regs_t *uart)
Gets the interrupt flags that are currently set.
void(* mxc_uart_complete_cb_t)(mxc_uart_req_t *req, int result)
The callback routine used to indicate the transaction has terminated.
Definition: uart.h:109
@ MXC_UART_PARITY_ODD_0
UART Parity Odd, 0 based.
Definition: uart.h:85
int MXC_UART_Read(mxc_uart_regs_t *uart, uint8_t *buffer, int *len)
Reads the next available character.