/** EUSART Generated Driver API Header File @Company Microchip Technology Inc. @File Name eusart.h @Summary This is the generated header file for the EUSART driver using PIC10 / PIC12 / PIC16 / PIC18 MCUs @Description This header file provides APIs for driver for EUSART. Generation Information : Product Revision : PIC10 / PIC12 / PIC16 / PIC18 MCUs - 1.65.2 Device : PIC16F1579 Driver Version : 2.01 The generated drivers are tested against the following: Compiler : XC8 1.45 MPLAB : MPLAB X 4.15 */ /* (c) 2018 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. It is your responsibility to comply with third party license terms applicable to your use of third party software (including open source software) that may accompany Microchip software. THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND 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 IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE. */ #ifndef EUSART_H #define EUSART_H /** Section: Included Files */ #include #include #include #ifdef __cplusplus // Provide C++ Compatibility extern "C" { #endif /** Section: Macro Declarations */ #define EUSART_DataReady (EUSART_is_rx_ready()) /** Section: Data Type Definitions */ /** Section: Global variables */ extern volatile uint8_t eusartTxBufferRemaining; extern volatile uint8_t eusartRxCount; /** Section: EUSART APIs */ void (*EUSART_TxDefaultInterruptHandler)(void); void (*EUSART_RxDefaultInterruptHandler)(void); /** @Summary Initialization routine that takes inputs from the EUSART GUI. @Description This routine initializes the EUSART driver. This routine must be called before any other EUSART routine is called. @Preconditions None @Param None @Returns None @Comment */ void EUSART_Initialize(void); /** @Summary Checks if the EUSART transmitter is ready @Description This routine checks if EUSART transmitter is empty and ready for next transmission @Preconditions EUSART_Initialize() function should have been called before calling this function. EUSART transmitter should be enabled before calling this function @Param None @Returns The number of available bytes that EUSART has remaining in its transmit buffer @Example void main(void) { volatile uint8_t rxData; // Initialize the device SYSTEM_Initialize(); // Enable the Global Interrupts INTERRUPT_GlobalInterruptEnable(); // Enable the Peripheral Interrupts INTERRUPT_PeripheralInterruptEnable(); while(1) { // Logic to echo received data if(EUSART_is_rx_ready()) { rxData = UART1_Read(); if(EUSART_is_tx_ready()) { EUSART_Write(rxData); } } } } */ uint8_t EUSART_is_tx_ready(void); /** @Summary Checks if EUSART receiver is empty @Description This routine returns the available number of bytes to be read from EUSART receiver @Preconditions EUSART_Initialize() function should be called before calling this function EUSART receiver should be enabled before calling this function @Param None @Returns The number of bytes EUSART has available for reading @Example void main(void) { volatile uint8_t rxData; // Initialize the device SYSTEM_Initialize(); // Enable the Global Interrupts INTERRUPT_GlobalInterruptEnable(); // Enable the Peripheral Interrupts INTERRUPT_PeripheralInterruptEnable(); while(1) { // Logic to echo received data if(EUSART_is_rx_ready()) { rxData = UART1_Read(); if(EUSART_is_tx_ready()) { EUSARTT_Write(rxData); } } } } */ uint8_t EUSART_is_rx_ready(void); /** @Summary Checks if EUSART data is transmitted @Description This function return the status of transmit shift register @Preconditions EUSART_Initialize() function should be called before calling this function EUSART transmitter should be enabled and EUSART_Write should be called before calling this function @Param None @Returns Status of EUSART receiver TRUE: Data completely shifted out if the USART shift register FALSE: Data is not completely shifted out of the shift register @Example void main(void) { volatile uint8_t rxData; // Initialize the device SYSTEM_Initialize(); while(1) { if(EUSART_is_tx_ready()) { LED_0_SetHigh(); EUSARTWrite(rxData); } if(EUSART_is_tx_done() { LED_0_SetLow(); } } } */ bool EUSART_is_tx_done(void); /** @Summary Read a byte of data from the EUSART. @Description This routine reads a byte of data from the EUSART. @Preconditions EUSART_Initialize() function should have been called before calling this function. The transfer status should be checked to see if the receiver is not empty before calling this function. @Param None @Returns A data byte received by the driver. */ uint8_t EUSART_Read(void); /** @Summary Writes a byte of data to the EUSART. @Description This routine writes a byte of data to the EUSART. @Preconditions EUSART_Initialize() function should have been called before calling this function. The transfer status should be checked to see if transmitter is not busy before calling this function. @Param txData - Data byte to write to the EUSART @Returns None */ void EUSART_Write(uint8_t txData); /** @Summary Maintains the driver's transmitter state machine and implements its ISR. @Description This routine is used to maintain the driver's internal transmitter state machine.This interrupt service routine is called when the state of the transmitter needs to be maintained in a non polled manner. @Preconditions EUSART_Initialize() function should have been called for the ISR to execute correctly. @Param None @Returns None */ void EUSART_Transmit_ISR(void); /** @Summary Maintains the driver's receiver state machine and implements its ISR @Description This routine is used to maintain the driver's internal receiver state machine.This interrupt service routine is called when the state of the receiver needs to be maintained in a non polled manner. @Preconditions EUSART_Initialize() function should have been called for the ISR to execute correctly. @Param None @Returns None */ void EUSART_Receive_ISR(void); /** @Summary Sets the transmit handler function to be called by the interrupt service @Description Calling this function will set a new custom function that will be called when the transmit interrupt needs servicing. @Preconditions EUSART_Initialize() function should have been called for the ISR to execute correctly. @Param A pointer to the new function @Returns None */ void EUSART_SetTxInterruptHandler(void (* interruptHandler)(void)); /** @Summary Sets the receive handler function to be called by the interrupt service @Description Calling this function will set a new custom function that will be called when the receive interrupt needs servicing. @Preconditions EUSART_Initialize() function should have been called for the ISR to execute correctly. @Param A pointer to the new function @Returns None */ void EUSART_SetRxInterruptHandler(void (* interruptHandler)(void)); #ifdef __cplusplus // Provide C++ Compatibility } #endif #endif // EUSART_H /** End of File */