eusart1.h

Go to the documentation of this file.

 
/*
    (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 EUSART1_H
#define EUSART1_H
 
#include <xc.h>
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus  // Provide C++ Compatibility
 
    extern "C" {
 
#endif
 
 
#define EUSART1_DataReady  (EUSART1_is_rx_ready())
 
typedef union {
    struct {
        unsigned perr : 1;
        unsigned ferr : 1;
        unsigned oerr : 1;
        unsigned reserved : 5;
    };
    uint8_t status;
}eusart1_status_t;
 
extern volatile uint8_t eusart1TxBufferRemaining;
extern volatile uint8_t eusart1RxCount;
 
extern void (*EUSART1_RxDefaultInterruptHandler)(void);
 
void EUSART1_Initialize(void);
 
bool EUSART1_is_tx_ready(void);
 
bool EUSART1_is_rx_ready(void);
 
bool EUSART1_is_tx_done(void);
 
eusart1_status_t EUSART1_get_last_status(void);
 
uint8_t EUSART1_Read(void);
 
void EUSART1_Write(uint8_t txData);
 
 
void EUSART1_Receive_ISR(void);
 
void EUSART1_RxDataHandler(void);
 
void EUSART1_SetFramingErrorHandler(void (* interruptHandler)(void));
 
void EUSART1_SetOverrunErrorHandler(void (* interruptHandler)(void));
 
void EUSART1_SetErrorHandler(void (* interruptHandler)(void));
 
 
void EUSART1_SetRxInterruptHandler(void (* interruptHandler)(void));
 
#ifdef __cplusplus  // Provide C++ Compatibility
 
    }
 
#endif
 
#endif  // EUSART1_H