|  | Dual Active Bridge Development Board (Part-No. ) |
Content |  |  |  |  |  |

Loading...
Searching...
No Matches
Macros | Functions | Variables
uart1.h File Reference
MPLABX MCC Melody Code Generator » UART Driver

This is the generated driver header file for the UART1 driver. More...

`#include <stdbool.h>`
`#include <stdint.h>`
`#include <stddef.h>`
`#include "uart_interface.h"`
Include dependency graph for uart1.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Macros
#define | UART1_Drv_Initialize UART1_Initialize
| This macro defines the Custom Name for UART1_Initialize API.
#define | UART1_Drv_Deinitialize UART1_Deinitialize
| This macro defines the Custom Name for UART1_Deinitialize API.
#define | UART1_Drv_Read UART1_Read
| This macro defines the Custom Name for UART1_Read API.
#define | UART1_Drv_Write UART1_Write
| This macro defines the Custom Name for UART1_Write API.
#define | UART1_Drv_IsRxReady UART1_IsRxReady
| This macro defines the Custom Name for UART1_IsRxReady API.
#define | UART1_Drv_IsTxReady UART1_IsTxReady
| This macro defines the Custom Name for UART1_IsTxReady API.
#define | UART1_Drv_IsTxDone UART1_IsTxDone
| This macro defines the Custom Name for UART1_IsTxDone API.
#define | UART1_Drv_TransmitEnable UART1_TransmitEnable
| This macro defines the Custom Name for UART1_TransmitEnable API.
#define | UART1_Drv_TransmitDisable UART1_TransmitDisable
| This macro defines the Custom Name for UART1_TransmitDisable API.
#define | UART1_Drv_AutoBaudSet UART1_AutoBaudSet
| This macro defines the Custom Name for UART1_AutoBaudSet API.
#define | UART1_Drv_AutoBaudQuery UART1_AutoBaudQuery
| This macro defines the Custom Name for UART1_AutoBaudQuery API.
#define | UART1_Drv_AutoBaudEventEnableGet UART1_AutoBaudEventEnableGet
| This macro defines the Custom Name for UART1_AutoBaudEventEnableGet API.
#define | UART1_Drv_ErrorGet UART1_ErrorGet
| This macro defines the Custom Name for UART1_ErrorGet API.
#define | UART1_Drv_BRGCountSet UART1_BRGCountSet
| This macro defines the Custom Name for UART1_BRGCountSet API.
#define | UART1_Drv_BRGCountGet UART1_BRGCountGet
| This macro defines the Custom Name for UART1_BRGCountGet API.
#define | UART1_Drv_BaudRateSet UART1_BaudRateSet
| This macro defines the Custom Name for UART1_BaudRateSet API.
#define | UART1_Drv_BaudRateGet UART1_BaudRateGet
| This macro defines the Custom Name for UART1_BaudRateGet API.

## Functions
void | UART1_Initialize (void)
| Initializes the UART driver.
void | UART1_Deinitialize (void)
| Deinitializes the UART to POR values.
uint8_t | UART1_Read (void)
| Reads a byte of data from the UART1.
void | UART1_Write (uint8_t data)
| Writes a byte of data to the UART1.
bool | UART1_IsRxReady (void)
| Returns a boolean value if data is available to read.
bool | UART1_IsTxReady (void)
| Returns a boolean value if data can be written.
bool | UART1_IsTxDone (void)
| Indicates if all bytes have been transferred.
void | UART1_TransmitEnable (void)
| Enables UART1 transmit.
void | UART1_TransmitDisable (void)
| Disables UART1 transmit.
void | UART1_AutoBaudSet (bool enable)
| Enables or disables UART1 Auto-Baud detection.
bool | UART1_AutoBaudQuery (void)
| Returns the status of Auto-Baud detection.
bool | UART1_AutoBaudEventEnableGet (void)
| Returns enable state of the Auto-Baud feature.
void | UART1_BRGCountSet (uint32_t brgValue)
| Sets the BRG value of UART1.
uint32_t | UART1_BRGCountGet (void)
| Gets the BRG value of UART1.
void | UART1_BaudRateSet (uint32_t baudRate)
| Sets the calculated Baud-Rate of UART1.
uint32_t | UART1_BaudRateGet (void)
| Gets the actual Baud-Rate of UART1.
size_t | UART1_ErrorGet (void)
| Returns the error status of UART1.

## Variables
const struct UART_INTERFACE | UART1_Drv
| Structure object of type UART_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. UART1 can be changed by the user in the UART user interface. This allows defining a structure with application specific name using the 'Custom Name' field. Application specific name allows the API Portability.

## Detailed Description

UART1 Generated Driver Header File

Definition in file uart1.h.