140 lines
3.2 KiB
C
140 lines
3.2 KiB
C
|
/**
|
||
|
|
FVR Generated Driver API Header File
|
||
|
|
|
||
|
|
@Company
|
||
|
|
Microchip Technology Inc.
|
||
|
|
|
||
|
|
@File Name
|
||
|
|
fvr.h
|
||
|
|
|
||
|
|
@Summary
|
||
|
|
This is the generated header file for the FVR driver using PIC10 / PIC12 / PIC16 / PIC18 MCUs
|
||
|
|
|
||
|
|
@Description
|
||
|
|
This header file provides APIs for driver for FVR.
|
||
|
|
Generation Information :
|
||
|
|
Product Revision : PIC10 / PIC12 / PIC16 / PIC18 MCUs - 1.81.3
|
||
|
|
Device : PIC16F1776
|
||
|
|
Driver Version : 2.01
|
||
|
|
The generated drivers are tested against the following:
|
||
|
|
Compiler : XC8 2.20 and above
|
||
|
|
MPLAB : MPLAB X 5.40
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*
|
||
|
|
(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 FVR_H
|
||
|
|
#define FVR_H
|
||
|
|
|
||
|
|
/**
|
||
|
|
Section: Included Files
|
||
|
|
*/
|
||
|
|
|
||
|
|
#include <stdbool.h>
|
||
|
|
#include <stdint.h>
|
||
|
|
|
||
|
|
#ifdef __cplusplus // Provide C++ Compatibility
|
||
|
|
|
||
|
|
extern "C" {
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/**
|
||
|
|
Section: FVR APIs
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
@Summary
|
||
|
|
Initializes the FVR
|
||
|
|
|
||
|
|
@Description
|
||
|
|
This routine initializes the FVR.
|
||
|
|
This routine must be called before any other FVR routine is called.
|
||
|
|
This routine should only be called once during system initialization.
|
||
|
|
|
||
|
|
@Preconditions
|
||
|
|
None
|
||
|
|
|
||
|
|
@Param
|
||
|
|
None
|
||
|
|
|
||
|
|
@Returns
|
||
|
|
None
|
||
|
|
|
||
|
|
@Comment
|
||
|
|
|
||
|
|
|
||
|
|
@Example
|
||
|
|
<code>
|
||
|
|
FVR_Initialize();
|
||
|
|
</code>
|
||
|
|
*/
|
||
|
|
void FVR_Initialize(void);
|
||
|
|
|
||
|
|
/**
|
||
|
|
@Summary
|
||
|
|
Gets the FVR output ready status.
|
||
|
|
|
||
|
|
@Description
|
||
|
|
This routine gets the FVR output ready status.
|
||
|
|
|
||
|
|
@Preconditions
|
||
|
|
The FVR_Initialize() routine should be called
|
||
|
|
prior to use this routine.
|
||
|
|
|
||
|
|
@Param
|
||
|
|
None
|
||
|
|
|
||
|
|
@Returns
|
||
|
|
true - FVR module is ready for use.
|
||
|
|
false - FVR module is not ready for use.
|
||
|
|
|
||
|
|
@Example
|
||
|
|
<code>
|
||
|
|
FVR_Initialize();
|
||
|
|
|
||
|
|
if(FVR_IsOutputReady())
|
||
|
|
{
|
||
|
|
//user code
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
//user code
|
||
|
|
}
|
||
|
|
</code>
|
||
|
|
*/
|
||
|
|
bool FVR_IsOutputReady(void);
|
||
|
|
|
||
|
|
#ifdef __cplusplus // Provide C++ Compatibility
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif // FVR_H
|
||
|
|
/**
|
||
|
|
End of File
|
||
|
|
*/
|
||
|
|
|