-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathxc8-pic-conf_8h.html
339 lines (310 loc) · 17.1 KB
/
xc8-pic-conf_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>YALI: xc8-pic-conf.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">YALI
</div>
<div id="projectbrief">Yet Another LCD Interface</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2f5d4dc2aa7396302b01cf706e4f5e78.html">unilcd-pic16.X</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">xc8-pic-conf.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>MPLAB XC C (PIC) configuration file for YALI module.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "unilcd-config.h"</code><br />
<code>#include <xc.h></code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for xc8-pic-conf.h:</div>
<div class="dyncontent">
<div class="center"><img src="xc8-pic-conf_8h__incl.png" border="0" usemap="#axc8-pic-conf_8h" alt=""/></div>
<map name="axc8-pic-conf_8h" id="axc8-pic-conf_8h">
<area shape="rect" title="MPLAB XC C (PIC) configuration file for YALI module." alt="" coords="61,5,174,32"/>
<area shape="rect" title=" " alt="" coords="5,80,123,107"/>
<area shape="rect" title=" " alt="" coords="147,80,197,107"/>
</map>
</div>
</div>
<p><a href="xc8-pic-conf_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a2c74706b367ac749c7020d55c3df0cf5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a2c74706b367ac749c7020d55c3df0cf5">XC8_PIC_MID</a>   1</td></tr>
<tr class="separator:a2c74706b367ac749c7020d55c3df0cf5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb4c6eae5cf1614c7a1c346541dad77d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#acb4c6eae5cf1614c7a1c346541dad77d">SHIFTREG_PORT</a>   PORTB</td></tr>
<tr class="separator:acb4c6eae5cf1614c7a1c346541dad77d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1111b9fee729d58c7cb69424984cbf12"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a1111b9fee729d58c7cb69424984cbf12">SHIFTREG_TRIS</a>   TRISB</td></tr>
<tr class="separator:a1111b9fee729d58c7cb69424984cbf12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad904b8dcc283d1014acd9429adbcb6d3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#ad904b8dcc283d1014acd9429adbcb6d3">SHIFTREG_CLK_PIN</a>   0</td></tr>
<tr class="separator:ad904b8dcc283d1014acd9429adbcb6d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae370d5cc3dc41a35adafa43ea93b6ff5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#ae370d5cc3dc41a35adafa43ea93b6ff5">SHIFTREG_DATA_PIN</a>   1</td></tr>
<tr class="separator:ae370d5cc3dc41a35adafa43ea93b6ff5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a557a9482dc2e5521c95ae251af471c60"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a557a9482dc2e5521c95ae251af471c60">SHIFTREG_LATCH_PIN</a>   2</td></tr>
<tr class="separator:a557a9482dc2e5521c95ae251af471c60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a1dc6d243c6f75bb42f87e3f69649e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a9a1dc6d243c6f75bb42f87e3f69649e4">UCHAR</a>   unsigned char</td></tr>
<tr class="separator:a9a1dc6d243c6f75bb42f87e3f69649e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35cd67ba7bb0db8105eb6267467535d7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a35cd67ba7bb0db8105eb6267467535d7">CHAR</a>   char</td></tr>
<tr class="separator:a35cd67ba7bb0db8105eb6267467535d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f319bfc2492a2136964194204e7a8cf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a7f319bfc2492a2136964194204e7a8cf">VOID</a>   void</td></tr>
<tr class="separator:a7f319bfc2492a2136964194204e7a8cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a070d2ce7b6bb7e5c05602aa8c308d0c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>   0</td></tr>
<tr class="separator:a070d2ce7b6bb7e5c05602aa8c308d0c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58ce36916c399104e18d32ff090f21c6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a58ce36916c399104e18d32ff090f21c6">MAX_STR_LEN</a>   16</td></tr>
<tr class="separator:a58ce36916c399104e18d32ff090f21c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7499edcf444b0375c1f81f0639cffed0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#a7499edcf444b0375c1f81f0639cffed0">DELAY_LONG</a>()   __delay_ms(5)</td></tr>
<tr class="separator:a7499edcf444b0375c1f81f0639cffed0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa37efc42bcff8ebdec3a32a41e1e45d0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xc8-pic-conf_8h.html#aa37efc42bcff8ebdec3a32a41e1e45d0">DELAY_SHORT</a>()   __delay_us(30)</td></tr>
<tr class="separator:aa37efc42bcff8ebdec3a32a41e1e45d0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>MPLAB XC C (PIC) configuration file for YALI module. </p>
<dl class="section author"><dt>Author</dt><dd>Dilshan R Jayakody (<a href="#" onclick="location.href='mai'+'lto:'+'jay'+'ak'+'ody'+'20'+'00l'+'k@'+'gma'+'il'+'.co'+'m'; return false;">jayak<span style="display: none;">.nosp@m.</span>ody2<span style="display: none;">.nosp@m.</span>000lk<span style="display: none;">.nosp@m.</span>@gma<span style="display: none;">.nosp@m.</span>il.co<span style="display: none;">.nosp@m.</span>m</a>) </dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2023-03-23</dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2023 Dilshan R Jayakody.</dd></dl>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a35cd67ba7bb0db8105eb6267467535d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35cd67ba7bb0db8105eb6267467535d7">◆ </a></span>CHAR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CHAR   char</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mapping for char. </p>
</div>
</div>
<a id="a7499edcf444b0375c1f81f0639cffed0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7499edcf444b0375c1f81f0639cffed0">◆ </a></span>DELAY_LONG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DELAY_LONG</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   __delay_ms(5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function mapping for long delay. </p>
</div>
</div>
<a id="aa37efc42bcff8ebdec3a32a41e1e45d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa37efc42bcff8ebdec3a32a41e1e45d0">◆ </a></span>DELAY_SHORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DELAY_SHORT</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   __delay_us(30)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function mapping for short delay. </p>
</div>
</div>
<a id="a58ce36916c399104e18d32ff090f21c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58ce36916c399104e18d32ff090f21c6">◆ </a></span>MAX_STR_LEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAX_STR_LEN   16</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum string length allowed by the YALI library. </p>
</div>
</div>
<a id="a070d2ce7b6bb7e5c05602aa8c308d0c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a070d2ce7b6bb7e5c05602aa8c308d0c4">◆ </a></span>NULL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NULL   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition for NULL. </p>
</div>
</div>
<a id="ad904b8dcc283d1014acd9429adbcb6d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad904b8dcc283d1014acd9429adbcb6d3">◆ </a></span>SHIFTREG_CLK_PIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SHIFTREG_CLK_PIN   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Clock output which connected to the CLK terminal of the YALI module. </p>
</div>
</div>
<a id="ae370d5cc3dc41a35adafa43ea93b6ff5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae370d5cc3dc41a35adafa43ea93b6ff5">◆ </a></span>SHIFTREG_DATA_PIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SHIFTREG_DATA_PIN   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Data output which connected to the DAT terminal of the YALL module. </p>
</div>
</div>
<a id="a557a9482dc2e5521c95ae251af471c60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a557a9482dc2e5521c95ae251af471c60">◆ </a></span>SHIFTREG_LATCH_PIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SHIFTREG_LATCH_PIN   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Latch control pin which is connected to the LAT terminal of the YALI module. </p>
</div>
</div>
<a id="acb4c6eae5cf1614c7a1c346541dad77d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb4c6eae5cf1614c7a1c346541dad77d">◆ </a></span>SHIFTREG_PORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SHIFTREG_PORT   PORTB</td>
</tr>
</table>
</div><div class="memdoc">
<p>Port used to drive the YALI module. </p>
</div>
</div>
<a id="a1111b9fee729d58c7cb69424984cbf12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1111b9fee729d58c7cb69424984cbf12">◆ </a></span>SHIFTREG_TRIS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SHIFTREG_TRIS   TRISB</td>
</tr>
</table>
</div><div class="memdoc">
<p>TRIS register used to drive the YALI module. </p>
</div>
</div>
<a id="a9a1dc6d243c6f75bb42f87e3f69649e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a1dc6d243c6f75bb42f87e3f69649e4">◆ </a></span>UCHAR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCHAR   unsigned char</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mapping for Unsigned char. </p>
</div>
</div>
<a id="a7f319bfc2492a2136964194204e7a8cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f319bfc2492a2136964194204e7a8cf">◆ </a></span>VOID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define VOID   void</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mapping for void. </p>
</div>
</div>
<a id="a2c74706b367ac749c7020d55c3df0cf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c74706b367ac749c7020d55c3df0cf5">◆ </a></span>XC8_PIC_MID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XC8_PIC_MID   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag to indicate the Microchip MPLAB XC8 C project. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>