root/RF_BT_Tail/mcc_generated_files/dac.h

Revision 244, 3.7 kB (checked in by phil, 4 years ago)

added initial Tail Source Package

Line 
1 /**
2   DAC Generated Driver API Header File
3
4   @Company
5     Microchip Technology Inc.
6
7   @File Name
8     dac.h
9
10   @Summary
11     This is the generated header file for the DAC driver using PIC10 / PIC12 / PIC16 / PIC18 MCUs
12
13   @Description
14     This header file provides APIs for driver for DAC.
15     Generation Information :
16         Product Revision  :  PIC10 / PIC12 / PIC16 / PIC18 MCUs - 1.65.2
17         Device            :  PIC16F1579
18         Driver Version    :  2.10
19     The generated drivers are tested against the following:
20         Compiler          :  XC8 1.45
21         MPLAB             :  MPLAB X 4.15
22 */
23
24 /*
25     (c) 2018 Microchip Technology Inc. and its subsidiaries.
26    
27     Subject to your compliance with these terms, you may use Microchip software and any
28     derivatives exclusively with Microchip products. It is your responsibility to comply with third party
29     license terms applicable to your use of third party software (including open source software) that
30     may accompany Microchip software.
31    
32     THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
33     EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY
34     IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS
35     FOR A PARTICULAR PURPOSE.
36    
37     IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
38     INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
39     WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP
40     HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO
41     THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL
42     CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT
43     OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS
44     SOFTWARE.
45 */
46
47 #ifndef DAC_H
48 #define DAC_H
49
50 /**
51   Section: Included Files
52 */
53
54 #include <stdbool.h>
55 #include <stdint.h>
56
57 #ifdef __cplusplus  // Provide C++ Compatibility
58
59     extern "C" {
60
61 #endif
62
63 /**
64   Section: DAC APIs
65 */
66
67 /**
68   @Summary
69     Initializes the DAC
70
71   @Description
72     This routine initializes the DAC.
73     This routine must be called before any other DAC routine is called.
74     This routine should only be called once during system initialization.
75
76   @Preconditions
77     None
78
79   @Param
80     None
81
82   @Returns
83     None
84
85   @Comment
86    
87
88   @Example
89     <code>
90     DAC_Initialize();
91     </code>
92 */
93 void DAC_Initialize(void);
94
95 /**
96   @Summary
97     Set Input data into DAC.
98
99   @Description
100     This routine pass the digital input data into
101     DAC voltage reference control register.
102
103   @Preconditions
104     The DAC_Initialize() routine should be called
105     prior to use this routine.
106
107   @Param
108     inputData - 8bit digital data to DAC.
109
110   @Returns
111     None
112
113   @Example
114     <code>
115     uint8_t count=0;
116
117     DAC_Initialize();
118
119     for(count=0; count<=30; count++)
120     {
121         DAC_SetOutput(count);
122     }
123
124     while(1)
125     {
126     }
127     </code>
128 */
129 void DAC_SetOutput(uint8_t inputData);
130
131 /**
132   @Summary
133     Read input data fed to DAC.
134
135   @Description
136     This routine reads the digital input data fed to
137     DAC voltage reference control register.
138
139   @Preconditions
140     The DAC_Initialize() routine should be called
141     prior to use this routine.
142
143   @Param
144     None
145
146   @Returns
147     uint8_t inputData - digital data fed to DAC
148
149   @Example
150     <code>
151     uint8_t count=0;
152     uint8_t inputData;
153
154     DAC_Initialize();
155
156     inputData = DAC_GetOutput();
157
158     while(1)
159     {
160     }
161     </code>
162 */
163 uint8_t DAC_GetOutput(void);
164
165 #ifdef __cplusplus  // Provide C++ Compatibility
166
167     }
168
169 #endif
170
171 #endif // DAC_H
172 /**
173  End of File
174 */
Note: See TracBrowser for help on using the browser.