- Generated by
1.9.6
|
Solar panel
|
#include <xc.h>#include <stdbool.h>#include <stdint.h>Go to the source code of this file.
Classes | |
| union | eusart1_status_t |
Macros | |
| #define | EUSART1_DataReady (EUSART1_is_rx_ready()) |
Functions | |
| 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)) |
Variables | |
| volatile uint8_t | eusart1TxBufferRemaining |
| volatile uint8_t | eusart1RxCount |
| void(* | EUSART1_RxDefaultInterruptHandler )(void) |
| #define EUSART1_DataReady (EUSART1_is_rx_ready()) |
EUSART1 Generated Driver API Header File
@Company Microchip Technology Inc.
@File Name eusart1.h
@Summary This is the generated header file for the EUSART1 driver using PIC10 / PIC12 / PIC16 / PIC18 MCUs
@Description This header file provides APIs for driver for EUSART1. Generation Information : Product Revision : PIC10 / PIC12 / PIC16 / PIC18 MCUs - 1.81.8 Device : PIC18F97J60 Driver Version : 2.1.1 The generated drivers are tested against the following: Compiler : XC8 2.36 and above MPLAB : MPLAB X 6.00 Section: Included Files Section: Macro Declarations
| eusart1_status_t EUSART1_get_last_status | ( | void | ) |
@Summary Gets the error status of the last read byte.
@Description This routine gets the error status of the last read byte.
@Preconditions EUSART1_Initialize() function should have been called before calling this function. The returned value is only updated after a read is called.
@Param None
@Returns the status of the last read byte
@Example void main(void) { volatile uint8_t rxData; volatile eusart1_status_t rxStatus;
Initialize the device SYSTEM_Initialize();
Enable the Global Interrupts INTERRUPT_GlobalInterruptEnable();
while(1) { Logic to echo received data if(EUSART1_is_rx_ready()) { rxData = EUSART1_Read(); rxStatus = EUSART1_get_last_status(); if(rxStatus.ferr){ LED_0_SetHigh(); } } } }
| void EUSART1_Initialize | ( | void | ) |
| bool EUSART1_is_rx_ready | ( | void | ) |
@Summary Checks if the EUSART1 receiver ready for reading
@Description This routine checks if EUSART1 receiver has received data and ready to be read
@Preconditions EUSART1_Initialize() function should be called before calling this function EUSART1 receiver should be enabled before calling this function
@Param None
@Returns Status of EUSART1 receiver TRUE: EUSART1 receiver is ready for reading FALSE: EUSART1 receiver is not ready for reading
@Example void main(void) { volatile uint8_t rxData;
Initialize the device SYSTEM_Initialize();
while(1) { Logic to echo received data if(EUSART1_is_rx_ready()) { rxData = UART1_Read(); if(EUSART1_is_tx_ready()) { EUSART1_Write(rxData); } } } }
| bool EUSART1_is_tx_done | ( | void | ) |
@Summary Checks if EUSART1 data is transmitted
@Description This function return the status of transmit shift register
@Preconditions EUSART1_Initialize() function should be called before calling this function EUSART1 transmitter should be enabled and EUSART1_Write should be called before calling this function
@Param None
@Returns Status of EUSART1 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(EUSART1_is_tx_ready()) { LED_0_SetHigh(); EUSART1Write(rxData); } if(EUSART1_is_tx_done() { LED_0_SetLow(); } } }
| bool EUSART1_is_tx_ready | ( | void | ) |
@Summary Checks if the EUSART1 transmitter is ready to transmit data
@Description This routine checks if EUSART1 transmitter is ready to accept and transmit data byte
@Preconditions EUSART1_Initialize() function should have been called before calling this function. EUSART1 transmitter should be enabled before calling this function
@Param None
@Returns Status of EUSART1 transmitter TRUE: EUSART1 transmitter is ready FALSE: EUSART1 transmitter is not ready
@Example void main(void) { volatile uint8_t rxData;
Initialize the device SYSTEM_Initialize();
while(1) { Logic to echo received data if(EUSART1_is_rx_ready()) { rxData = UART1_Read(); if(EUSART1_is_tx_ready()) { EUSART1Write(rxData); } } } }
| uint8_t EUSART1_Read | ( | void | ) |
@Summary Read a byte of data from the EUSART1.
@Description This routine reads a byte of data from the EUSART1.
@Preconditions EUSART1_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.
| void EUSART1_Receive_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 EUSART1_Initialize() function should have been called for the ISR to execute correctly.
@Param None
@Returns None
| void EUSART1_RxDataHandler | ( | void | ) |
@Summary Maintains the driver's receiver state machine
@Description This routine is called by the receive state routine and is used to maintain the driver's internal receiver state machine. It should be called by a custom ISR to maintain normal behavior
@Preconditions EUSART1_Initialize() function should have been called for the ISR to execute correctly.
@Param None
@Returns None
| void EUSART1_SetErrorHandler | ( | void(*)(void) | interruptHandler | ) |
| void EUSART1_SetFramingErrorHandler | ( | void(*)(void) | interruptHandler | ) |
@Summary Set EUSART1 Framing Error Handler
@Description This API sets the function to be called upon EUSART1 framing error
@Preconditions Initialize the EUSART1 before calling this API
@Param Address of function to be set as framing error handler
@Returns None
| void EUSART1_SetOverrunErrorHandler | ( | void(*)(void) | interruptHandler | ) |
@Summary Set EUSART1 Overrun Error Handler
@Description This API sets the function to be called upon EUSART1 overrun error
@Preconditions Initialize the EUSART1 module before calling this API
@Param Address of function to be set as overrun error handler
@Returns None
| void EUSART1_SetRxInterruptHandler | ( | void(*)(void) | interruptHandler | ) |
@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 EUSART1_Initialize() function should have been called for the ISR to execute correctly.
@Param A pointer to the new function
@Returns None
| void EUSART1_Write | ( | uint8_t | txData | ) |
@Summary Writes a byte of data to the EUSART1.
@Description This routine writes a byte of data to the EUSART1.
@Preconditions EUSART1_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 EUSART1
@Returns None
|
extern |
|
extern |
Section: Global variables
1.9.6