uart1.h

Go to the documentation of this file.

 
/*
© [2024] Microchip Technology Inc. and its subsidiaries.
 
    Subject to your compliance with these terms, you may use Microchip 
    software and any derivatives exclusively with Microchip products. 
    You are responsible for complying with 3rd party license terms  
    applicable to your use of 3rd party software (including open source  
    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
    WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY 
    KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF 
    MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
    FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S 
    TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT 
    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
    THIS SOFTWARE.
*/
 
#ifndef UART1_H
#define UART1_H
 
// Section: Included Files
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include "uart_interface.h"
 
// Section: Data Type Definitions
 
extern const struct UART_INTERFACE UART1_Drv;
 
#define UART1_Drv_Initialize UART1_Initialize
 
#define UART1_Drv_Deinitialize UART1_Deinitialize
 
#define UART1_Drv_Read UART1_Read
 
#define UART1_Drv_Write UART1_Write
 
#define UART1_Drv_IsRxReady UART1_IsRxReady
 
#define UART1_Drv_IsTxReady UART1_IsTxReady
 
#define UART1_Drv_IsTxDone UART1_IsTxDone
 
#define UART1_Drv_TransmitEnable UART1_TransmitEnable
 
#define UART1_Drv_TransmitDisable UART1_TransmitDisable
 
#define UART1_Drv_AutoBaudSet UART1_AutoBaudSet
 
#define UART1_Drv_AutoBaudQuery UART1_AutoBaudQuery
 
#define UART1_Drv_AutoBaudEventEnableGet UART1_AutoBaudEventEnableGet
 
#define UART1_Drv_ErrorGet UART1_ErrorGet
 
#define UART1_Drv_BRGCountSet UART1_BRGCountSet
 
#define UART1_Drv_BRGCountGet UART1_BRGCountGet
 
#define UART1_Drv_BaudRateSet UART1_BaudRateSet
 
#define UART1_Drv_BaudRateGet UART1_BaudRateGet
 
// Section: UART1 Driver Routines
 
void UART1_Initialize(void);
 
void UART1_Deinitialize(void);
 
uint8_t UART1_Read(void);
 
void UART1_Write(uint8_t data);
 
bool UART1_IsRxReady(void);
 
bool UART1_IsTxReady(void);
 
bool UART1_IsTxDone(void);
 
void UART1_TransmitEnable(void);
 
void UART1_TransmitDisable(void);
 
void UART1_AutoBaudSet(bool enable);
 
bool UART1_AutoBaudQuery(void);
 
bool UART1_AutoBaudEventEnableGet(void);
 
void UART1_BRGCountSet(uint32_t brgValue);
 
uint32_t UART1_BRGCountGet(void);
 
void UART1_BaudRateSet(uint32_t baudRate);
 
uint32_t UART1_BaudRateGet(void);
 
size_t UART1_ErrorGet(void);
 
#endif  // UART1_H