MAX32675 Peripheral Driver API
Peripheral Driver API for the MAX32675
uart.h
1 
6 /* ****************************************************************************
7  * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be included
17  * in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
23  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  *
27  * Except as contained in this notice, the name of Maxim Integrated
28  * Products, Inc. shall not be used except as stated in the Maxim Integrated
29  * Products, Inc. Branding Policy.
30  *
31  * The mere transfer of this software does not imply any licenses
32  * of trade secrets, proprietary technology, copyrights, patents,
33  * trademarks, maskwork rights, or any other form of intellectual
34  * property whatsoever. Maxim Integrated Products, Inc. retains all
35  * ownership rights.
36  *
37  *************************************************************************** */
38 
39  /* Define to prevent redundant inclusion */
40 #ifndef _MXC_UART_H_
41 #define _MXC_UART_H_
42 
43 /***** Definitions *****/
44 #include "uart_regs.h"
45 #include "mxc_sys.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
57 typedef struct _mxc_uart_req_t mxc_uart_req_t;
62 typedef enum {
66 
71 typedef enum {
78 
83 typedef enum {
87 
90 typedef enum {
91  MXC_UART_APB_CLK = 0,
92  MXC_UART_EXT_CLK = 1,
93  /*8M (IBRO) and 32M (EFRO) clocks can be used for UARTs 0,1 and 2*/
94  MXC_UART_IBRO_CLK = 2,
95  MXC_UART_ERFO_CLK = 3,
96  /*32K (ERTCO) clock can only be used for UART3*/
97  MXC_UART_ERTCO_CLK = 4,
99 
106 typedef void (*mxc_uart_complete_cb_t)(mxc_uart_req_t* req, int result);
107 
115 typedef void (*mxc_uart_dma_complete_cb_t)(mxc_uart_req_t* req, int num, int result);
116 
125  const uint8_t *txData;
126  uint8_t *rxData;
130  uint32_t txLen;
134  uint32_t rxLen;
135  uint32_t txCnt;
136  uint32_t rxCnt;
137 
139 };
140 
141 /***** Function Prototypes *****/
142 
143 /* ************************************************************************* */
144 /* Control/Configuration functions */
145 /* ************************************************************************* */
146 
166 int MXC_UART_Init(mxc_uart_regs_t* uart, unsigned int baud, mxc_uart_clock_t clock);
167 
176 
190 
201 int MXC_UART_SetFrequency(mxc_uart_regs_t* uart, unsigned int baud, mxc_uart_clock_t clock);
202 
213 
222 int MXC_UART_SetDataSize(mxc_uart_regs_t* uart, int dataSize);
223 
233 
243 
253 int MXC_UART_SetFlowCtrl(mxc_uart_regs_t* uart, mxc_uart_flow_t flowCtrl, int rtsThreshold);
254 
265 
266 /* ************************************************************************* */
267 /* Low-level functions */
268 /* ************************************************************************* */
269 
280 
289 
299 
309 int MXC_UART_WriteCharacterRaw (mxc_uart_regs_t* uart, uint8_t character);
310 
319 
328 int MXC_UART_WriteCharacter(mxc_uart_regs_t* uart, uint8_t character);
329 
341 int MXC_UART_Read(mxc_uart_regs_t* uart, uint8_t* buffer, int* len);
342 
352 int MXC_UART_Write(mxc_uart_regs_t* uart, const uint8_t* byte, int* len);
353 
363 unsigned int MXC_UART_ReadRXFIFO(mxc_uart_regs_t* uart, unsigned char* bytes,
364  unsigned int len);
365 
376 int MXC_UART_ReadRXFIFODMA(mxc_uart_regs_t* uart, unsigned char* bytes,
377  unsigned int len, mxc_uart_dma_complete_cb_t callback);
378 
386 unsigned int MXC_UART_GetRXFIFOAvailable(mxc_uart_regs_t* uart);
387 
397 unsigned int MXC_UART_WriteTXFIFO(mxc_uart_regs_t* uart, const unsigned char* bytes,
398  unsigned int len);
399 
410 int MXC_UART_WriteTXFIFODMA(mxc_uart_regs_t* uart, const unsigned char* bytes,
411  unsigned int len, mxc_uart_dma_complete_cb_t callback);
412 
420 unsigned int MXC_UART_GetTXFIFOAvailable(mxc_uart_regs_t* uart);
421 
430 
439 
457 int MXC_UART_SetRXThreshold(mxc_uart_regs_t* uart, unsigned int numBytes);
458 
466 unsigned int MXC_UART_GetRXThreshold(mxc_uart_regs_t* uart);
467 
485 int MXC_UART_SetTXThreshold(mxc_uart_regs_t* uart, unsigned int numBytes);
486 
494 unsigned int MXC_UART_GetTXThreshold(mxc_uart_regs_t* uart);
495 
506 unsigned int MXC_UART_GetFlags(mxc_uart_regs_t* uart);
507 
519 int MXC_UART_ClearFlags(mxc_uart_regs_t* uart, unsigned int flags);
520 
532 int MXC_UART_EnableInt(mxc_uart_regs_t* uart, unsigned int mask);
533 
545 int MXC_UART_DisableInt(mxc_uart_regs_t* uart, unsigned int mask);
546 
554 unsigned int MXC_UART_GetStatus(mxc_uart_regs_t* uart);
555 
556 /* ************************************************************************* */
557 /* Transaction level functions */
558 /* ************************************************************************* */
559 
571 int MXC_UART_Transaction(mxc_uart_req_t* req);
572 
583 int MXC_UART_TransactionAsync(mxc_uart_req_t* req);
584 
598 int MXC_UART_TransactionDMA(mxc_uart_req_t* req);
599 
608 int MXC_UART_AsyncCallback (mxc_uart_regs_t* uart, int retVal);
609 
618 
631 
644 
647 #ifdef __cplusplus
648 }
649 #endif
650 
651 #endif /* _MXC_UART_H_ */
MXC_UART_AbortTransmission
int MXC_UART_AbortTransmission(mxc_uart_regs_t *uart)
Aborts an ongoing UART Transmission.
_mxc_uart_req_t::txCnt
uint32_t txCnt
Number of bytes actually transmitted from txData.
Definition: uart.h:135
mxc_uart_stop_t
mxc_uart_stop_t
The list of UART stop bit lengths supported.
Definition: uart.h:62
MXC_UART_AsyncHandler
int MXC_UART_AsyncHandler(mxc_uart_regs_t *uart)
The processing function for asynchronous transactions.
mxc_uart_clock_t
mxc_uart_clock_t
Clock settings.
Definition: uart.h:90
MXC_UART_Write
int MXC_UART_Write(mxc_uart_regs_t *uart, const uint8_t *byte, int *len)
Writes a byte on the UART.
MXC_UART_ReadyForSleep
int MXC_UART_ReadyForSleep(mxc_uart_regs_t *uart)
Checks if the given UART bus can be placed in sleep more.
MXC_UART_GetActive
int MXC_UART_GetActive(mxc_uart_regs_t *uart)
Checks the UART Peripheral for an ongoing transmission.
MXC_UART_SetDataSize
int MXC_UART_SetDataSize(mxc_uart_regs_t *uart, int dataSize)
Sets the number of bits per character.
MXC_UART_ClearRXFIFO
int MXC_UART_ClearRXFIFO(mxc_uart_regs_t *uart)
Removes and discards all bytes currently in the receive FIFO.
MXC_UART_WriteCharacter
int MXC_UART_WriteCharacter(mxc_uart_regs_t *uart, uint8_t character)
Writes a character on the UART.
_mxc_uart_req_t::rxCnt
uint32_t rxCnt
Number of bytes stored in rxData.
Definition: uart.h:136
MXC_UART_SetRXThreshold
int MXC_UART_SetRXThreshold(mxc_uart_regs_t *uart, unsigned int numBytes)
Set the receive threshold level.
_mxc_uart_req_t::txData
const uint8_t * txData
Definition: uart.h:125
MXC_UART_AbortAsync
int MXC_UART_AbortAsync(mxc_uart_regs_t *uart)
Abort any asynchronous requests in progress.
MXC_UART_ReadRXFIFODMA
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.
MXC_UART_AsyncStop
int MXC_UART_AsyncStop(mxc_uart_regs_t *uart)
stop any async callbacks
MXC_UART_ReadRXFIFO
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
@ MXC_UART_PARITY_EVEN_1
UART Parity Even, 1 based.
Definition: uart.h:74
MXC_UART_Init
int MXC_UART_Init(mxc_uart_regs_t *uart, unsigned int baud, mxc_uart_clock_t clock)
Initialize and enable UART peripheral.
MXC_UART_EnableInt
int MXC_UART_EnableInt(mxc_uart_regs_t *uart, unsigned int mask)
Enables specific interrupts.
MXC_UART_ClearTXFIFO
int MXC_UART_ClearTXFIFO(mxc_uart_regs_t *uart)
Removes and discards all bytes currently in the transmit FIFO.
_mxc_uart_req_t
The information required to perform a complete UART transaction.
Definition: uart.h:123
_mxc_uart_req_t::rxData
uint8_t * rxData
Definition: uart.h:129
MXC_UART_GetRXThreshold
unsigned int MXC_UART_GetRXThreshold(mxc_uart_regs_t *uart)
Get the current receive threshold level.
_mxc_uart_req_t::txLen
uint32_t txLen
Number of bytes to be sent from txData.
Definition: uart.h:133
MXC_UART_GetStatus
unsigned int MXC_UART_GetStatus(mxc_uart_regs_t *uart)
Gets the status flags that are currently set.
MXC_UART_STOP_1
@ MXC_UART_STOP_1
UART Stop 1 clock cycle.
Definition: uart.h:63
MXC_UART_WriteTXFIFO
unsigned int MXC_UART_WriteTXFIFO(mxc_uart_regs_t *uart, const unsigned char *bytes, unsigned int len)
Loads bytes into the transmit FIFO.
mxc_uart_flow_t
mxc_uart_flow_t
The list of UART flow control options supported.
Definition: uart.h:83
MXC_UART_STOP_2
@ MXC_UART_STOP_2
UART Stop 2 clock cycle (1.5 clocks for 5 bit characters)
Definition: uart.h:64
MXC_UART_SetStopBits
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.
mxc_uart_regs_t
Definition: uart_regs.h:88
MXC_UART_FLOW_EN
@ MXC_UART_FLOW_EN
UART Flow Control Enabled.
Definition: uart.h:85
MXC_UART_TransactionDMA
int MXC_UART_TransactionDMA(mxc_uart_req_t *req)
Setup a DMA driven UART transaction.
_mxc_uart_req_t::callback
mxc_uart_complete_cb_t callback
Pointer to function called when transaction is complete.
Definition: uart.h:138
MXC_UART_GetTXThreshold
unsigned int MXC_UART_GetTXThreshold(mxc_uart_regs_t *uart)
Get the current transmit threshold level.
_mxc_uart_req_t::uart
mxc_uart_regs_t * uart
Point to UART registers.
Definition: uart.h:124
MXC_UART_SetTXThreshold
int MXC_UART_SetTXThreshold(mxc_uart_regs_t *uart, unsigned int numBytes)
Set the transmit threshold level.
MXC_UART_FLOW_DIS
@ MXC_UART_FLOW_DIS
UART Flow Control Disabled.
Definition: uart.h:84
MXC_UART_GetTXFIFOAvailable
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
mxc_uart_parity_t
The list of UART Parity options supported.
Definition: uart.h:71
MXC_UART_PARITY_EVEN_0
@ MXC_UART_PARITY_EVEN_0
UART Parity Even, 0 based.
Definition: uart.h:73
MXC_UART_PARITY_DISABLE
@ MXC_UART_PARITY_DISABLE
UART Parity Disabled.
Definition: uart.h:72
MXC_UART_SetParity
int MXC_UART_SetParity(mxc_uart_regs_t *uart, mxc_uart_parity_t parity)
Sets the type of parity generation used.
MXC_UART_ReadCharacter
int MXC_UART_ReadCharacter(mxc_uart_regs_t *uart)
Reads the next available character.
MXC_UART_ClearFlags
int MXC_UART_ClearFlags(mxc_uart_regs_t *uart, unsigned int flags)
Clears the interrupt flags that are currently set.
MXC_UART_SetFlowCtrl
int MXC_UART_SetFlowCtrl(mxc_uart_regs_t *uart, mxc_uart_flow_t flowCtrl, int rtsThreshold)
Sets the flow control used.
MXC_UART_DisableInt
int MXC_UART_DisableInt(mxc_uart_regs_t *uart, unsigned int mask)
Disables specific interrupts.
MXC_UART_GetFrequency
int MXC_UART_GetFrequency(mxc_uart_regs_t *uart)
Get the frequency of the UART interface.
MXC_UART_WriteTXFIFODMA
int MXC_UART_WriteTXFIFODMA(mxc_uart_regs_t *uart, const unsigned char *bytes, unsigned int len, mxc_uart_dma_complete_cb_t callback)
Loads bytes into the transmit FIFO using DMA for longer writes.
MXC_UART_TransactionAsync
int MXC_UART_TransactionAsync(mxc_uart_req_t *req)
Setup an interrupt-driven UART transaction.
MXC_UART_AsyncCallback
int MXC_UART_AsyncCallback(mxc_uart_regs_t *uart, int retVal)
Async callback.
MXC_UART_WriteCharacterRaw
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...
MXC_UART_Shutdown
int MXC_UART_Shutdown(mxc_uart_regs_t *uart)
Disable and shutdown UART peripheral.
MXC_UART_Transaction
int MXC_UART_Transaction(mxc_uart_req_t *req)
Performs a blocking UART transaction.
MXC_UART_ReadCharacterRaw
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.
_mxc_uart_req_t::rxLen
uint32_t rxLen
Number of bytes to be stored in rxData.
Definition: uart.h:134
MXC_UART_GetRXFIFOAvailable
unsigned int MXC_UART_GetRXFIFOAvailable(mxc_uart_regs_t *uart)
Get the number of bytes currently available in the receive FIFO.
mxc_uart_dma_complete_cb_t
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:115
MXC_UART_SetClockSource
int MXC_UART_SetClockSource(mxc_uart_regs_t *uart, mxc_uart_clock_t clock)
Sets the clock source for the baud rate generator.
MXC_UART_PARITY_ODD_1
@ MXC_UART_PARITY_ODD_1
UART Parity Odd, 1 based.
Definition: uart.h:76
MXC_UART_SetFrequency
int MXC_UART_SetFrequency(mxc_uart_regs_t *uart, unsigned int baud, mxc_uart_clock_t clock)
Set the frequency of the UART interface.
MXC_UART_GetFlags
unsigned int MXC_UART_GetFlags(mxc_uart_regs_t *uart)
Gets the interrupt flags that are currently set.
mxc_uart_complete_cb_t
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:106
MXC_UART_PARITY_ODD_0
@ MXC_UART_PARITY_ODD_0
UART Parity Odd, 0 based.
Definition: uart.h:75
MXC_UART_Read
int MXC_UART_Read(mxc_uart_regs_t *uart, uint8_t *buffer, int *len)
Reads the next available character.