This repository has been archived by the owner on Mar 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lcd.c
500 lines (431 loc) · 34.8 KB
/
lcd.c
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
/* Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [2017] [Selvarajah N.]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
//------------------------------------------------------------------------------------------//
// Author : Selvarajah N. //
// Title : 4x16 LCD library //
// File name: lcd.c //
// Compiler : GNU-C, Xilinx SDK resp. Eclipse //
// Target : MicroBlaze with PL-Bus resp. PLB //
// Created : 08.02.17 //
// Changed : 17.12.21 //
// Version : 1.0 //
// Summary : LCD library to communicate and print with resp. on it //
// Revision : - Added print_lcd (), which allows entering format-string. //
// - Added d = int, o(ctal), p(ointer) and n format specifier. //
// - Added x = hex format specifier. //
// - Datatype of the argument was changed to correspond //
// to the changes in Header-file. //
//------------------------------------------------------------------------------------------//
#include "lcd.h"
//******************************************************************
// Function definitions
//******************************************************************
inline void lcd_init (void) { // Sets display direction from left-to-right and cursor placement in incremental way.
lcd_command (LCD_FunctionSet);
lcd_command (LCD_DisplayOn & ~LCD_CursorShowBlink);
lcd_command (LCD_Clear);
lcd_command (LCD_EntryMode);
}
void lcd_clear (void) { // Clears the display.
MB_Sleep (10); // Take a nap, my sweety.
/* lcd_write_xy (" ", 1, 1); // Fill the LCD with spaces.
lcd_write_xy (" ", 2, 1); // Fill the LCD with spaces.
lcd_write_xy (" ", 3, 1); // Fill the LCD with spaces.
lcd_write_xy (" ", 4, 1); // Fill the LCD with spaces.
*/
lcd_command (LCD_Clear);
}
void lcd_command (lcd_command_t command) { // Writes out command value in 8-bit format.
// command = reverse_char (command); // Swap the command bits. Only necessary if the MicroBlaze registers follow Big-Endian.
command <<= 4; // Shift command bits 4 left, in order to not get in hassle with control-signals (R/W, RS and EN).
XGpio_DiscreteWrite (&GPIO_LCD, 1, (((command | en) & ~rs) & rw)); // Send a command.
MB_Sleep (10); // Take a nap, my sweety.
XGpio_DiscreteWrite (&GPIO_LCD, 1, disable); // Disable LCD to not receive something.
MB_Sleep (10); // Take a nap, my sweety.
}
void lcd_write (charptr_t string) { // Writes out a string, but one char by another.
MB_Sleep (10); // Take a nap, my sweety.
while (*string) { // Same as *string != '\0'; Circles around while the string termination char won't appear.
lcd_write_char (*string); // Put the char on LCD.
string++; // Jump to next array element.
}
}
void lcd_write_xy (charptr_t string, int row, int column) { // Writes out a string, although one char by another, in addition at defined place.
MB_Sleep (5); // Take a nap, my sweety.
while (*string) { // Same as *string != '\0'; Circles around while the string termination char won't appear.
cursor (row, column); // Set the cursor of LCD.
lcd_write_char (*string); // Put the char on LCD.
string++; // Jump to next array element.
column++; // Jump to next sign on LCD.
}
}
void lcd_write_char (int ascii) { // Puts the dedicated char on LCD.
ascii = special_character (ascii); // Convert the special chars if necessary.
// ascii = reverse_char (ascii); // Swap the ASCII bits.
ascii <<= 4; // Shift ASCII bits 4 left, in order to not get in hassle with control-signals (R/W, RS and EN).
XGpio_DiscreteWrite (&GPIO_LCD, 1, ((rs | ascii | en) & rw)); // Write on display with dedicated char.
MB_Sleep (10); // Take a nap, my sweety.
XGpio_DiscreteWrite (&GPIO_LCD, 1, disable); // Disable LCD to receive something.
MB_Sleep (10); // Take a nap, my sweety.
}
void lcd_print (charptr_t string, ...) { // Writes out a string, like lcd_write, in addition, it accepts format-string and multiple arguments.
va_list arguments; // Initialize complex variable by the provided data type by stdarg.h.
volatile charptr_t str1; // Initialize pointer to save later on string and tell the compiler that the variable shan't be in any case optimized, else there's a bug in system.
uint8_t counter = 1; // Initialize counter for the for-loop.
uint32_t mul = 1; // Initialize precision variable for storing how many significances after the comma should be saved later on.
int whole = 0, thousandths = 0, nr2 = 0, chr = 0, prc = 0; // Initialize variables to store the integer value and the integer value after comma. Along these nr2 is needed to store integer read by va_arg as argument and chr is needed to store char as ASCII number. Last but not least, prc ist needed as condition for the for-loop to meet the significance after comma.
double nr1 = 0; // Initialize variable to store float-number.
MB_Sleep (10); // Put the MicroBlaze asleep.
va_start (arguments, string); // Count the unknown arguments provided when the actual function is scoped.
while (*string) { // Same as *string != '\0'; Circles around while the string termination char as long as doesn't appear.
if (*string == '%') { // Check if format-string is active.
string++; // Jump to the next array element.
switch (*string) { // Check, which format-string was typed in (capitalization of char doesn't matter).
// Is the format-string again %, then the user wants really a %.
case '%': lcd_write_char ('%'); // Again % then put the char on LCD.
break;
case 'F': // Is the format-specifier likely to be either double or float then...
case 'L':
case 'l': // ...it doesn't matter if it's a long format or float, cause va_arg doesn't allow float hence they're promoted to double
case 'f': nr1 = va_arg (arguments, double); // Take the next argument and save it.
whole = nr1; // Take only the integer value of nr1.
if (*(string + 1) == '.') { // Increment but don't save it and check if there's a dot to determine whether a precision number is afterwards entered.
string += 2; // Then increment two times, cause we weren't sure before whether there was a dot or not
prc = *string - '0'; // Now get the precision number.
for (counter = 1; counter <= prc; counter++) { // Loop through until the precision is met.
mul *= 10; // Multiply by 10 in order to get the maximum number of significant value after comma.
}
thousandths = abs (((double) nr1 - whole) * mul); // Multiply the number with only comma values by previously calculated precision variable.
}
else { // No precision initiator.
thousandths = abs (((double) nr1 - whole) * 1000); // Multiply the number with only comma values by default precision of three significants after comma.
}
if (nr1 < 0 && nr1 > -1) { // Check if the value is in minus area
lcd_write ("-0"); // Then print a minus before the number, cause -0 can't be saved in int data type and print on LCD.
}
else if (nr1 >= 0 && nr1 < 1) { // Check if the value is between 0 and 1.
lcd_write_char ('0'); // Then print a zero on LCD.
}
else { // Check if the integer before comma is rather not 0 resp. -0.
itoa (whole, str1); // Convert the integer to string.
lcd_write (str1); // Put the integer string on LCD.
}
lcd_write_char ('.'); // Add a dot on LCD.
itoa (thousandths, str1); // Convert the integer to string.
// xil_printf ("str1: %s\n", str1); // Debug Code. Not necessary for actual design.
lcd_write (str1); // Put the integer resp. comma string on LCD.
break;
case 'D': // Is the format-specifier an integer?
case 'I':
case 'd':
case 'i': nr2 = va_arg (arguments, int); // Take the next argument and save it.
itoa (nr2, str1); // Convert the integer to string.
lcd_write (str1); // Put the integer string on LCD.
break;
case 'C': // Is the format-specifier a char?
case 'c': chr = va_arg (arguments, int); // Take the next argument and save it.
lcd_write_char (chr); // Put the char on LCD.
break;
case 'S': // Is the format-specifier a string?
case 's': str1 = va_arg (arguments, charptr_t); // Take the next argument and save it.
lcd_write (str1); // Write out the string on LCD.
break;
case 'U': // Is the format-specifier a uint?
case 'u': nr2 = va_arg (arguments, int); // Take the next argument and save it.
nr2 = abs (nr2); // Convert the int to uint, in order to get rid of the '-'.
itoa (nr2, str1); // Convert the integer to string.
lcd_write (str1); // Put the integer string on LCD.
break;
case 'X': // Is the format-specifier a hex?
case 'x': nr2 = va_arg (arguments, int); // Take the next argument and save it
nr2 = abs (nr2); // Convert the int to uint, in order to get rid of the '-'.
str1 = hex_to_ascii (nr2); // Convert the integer to string.
lcd_write (str1); // Put the hex string on LCD.
break;
// Too large code.
/* case 'P': // Is the format-specifier a pointer address?
case 'p': ptr = va_arg (arguments, void *); // Take the next argument and save it.
nr2 = (int) &ptr; // Save the address of pointer.
itoa (nr2, str1); // Convert the integer to string.
lcd_write_char ('D'); // Add an indicator that the following number would be a decimal.
lcd_write (str1); // Write out the string on LCD.
break;
case 'O': // Is the format-specifier an int to octal?
case 'o': nr2 = va_arg (arguments, int); // Take the next argument and save it.
nr2 = abs (nr2); // Convert the int to uint, in order to get rid of the '-'.
if (nr2 != 0) { // Check whether it's a zero or not.
while (nr2 != 0) { // Loop through unless it's zero.
nr2 /= 8; // Divide by 8 and save it.
itoa (nr2 % 8, str1); // Use modulo and convert int to string.
lcd_write (str1); // Write out the string.
}
}
else {
itoa (nr2, str1); // Convert the integer to string.
lcd_write (str1); // Put the integer string on LCD.
}
break;*/
// case 'N':
// case 'n': // According printf, if it's an 'n' then nothing will be printed. This case will be counted as a default value.
default: continue; // If no valid char resp. format-string succeeded, then continue.
}
}
else { // If there's no format-string initiator.
lcd_write_char (*string); // Put the char on LCD, along the special chars.
}
string++; // Jump to next array element.
}
va_end (arguments); // End of reading further arguments.
}
void cursor (int row, int column) { // Set the cursor on LCD
switch (row) { // Selects the row
case 1: lcd_command (0x80 | (0x00 + (column - 1))); // Send the command, to set position with dedicated significant value
break;
case 2: lcd_command (0x80 | (0x40 + (column - 1))); // Send the command, to set position with dedicated significant value
break;
case 3: lcd_command (0x80 | (0x10 + (column - 1))); // Send the command, to set position with dedicated significant value
break;
case 4: lcd_command (0x80 | (0x50 + (column - 1))); // Send the command, to set position with dedicated significant value
break;
}
}
char special_character (char character) { // Returns the right value according CGROM chart by Hitachi if the char is a special character.
switch (character) { // Check the character.
case 'ä': return 0x84;
break;
case 'ö': return 0x94;
break;
case 'ü': return 0x9A;
break;
case '°': return 0xDF;
break;
default: return character;
break;
}
}
int reverse_char (int x) { // Swaps the bits of int variables.
int counter, data = 0; // Initialize counter and return data.
int array_8_bit [8]; // And the temporary bit holder.
memset (array_8_bit, 0, 8); // Clear the array.
for (counter = 1; counter <= 8; counter++) { // Loop until the bit significance is met.
array_8_bit [counter - 1] = x & (1 << (counter - 1)); // Save the bit of the loaded value.
}
for (counter = 8; counter <= 1; counter--) { // Loop until the swap is finished.
data |= ((array_8_bit [counter - 1] & 0x01) << (counter - 1)); // Mask the bit value.
}
return data; // return the bit swapped number.
}
void reverse (char s[]) { // Reverts the whole string
int i, j; // Initialize variables; i: primary counter, j: secondary counter
char c; // Temporary char stack
for (i = 0, j = strlen (s) - 1; i < j; i++, j--) { // Circles through two variables; j starts at the last value of significant of array and i starts from zero.
c = s [i]; // Cache the char of the highest array element .
s [i] = s [j]; // Save the char of the lowest of array element at the swapped resp. higher place of array element.
s [j] = c; // Save the char of the highest array element as cache.
}
}
void itoa (int n, char s[]) { // Converts integer value to string, extracted from K&Rs book.
int i, sign; // Initialize variables; i: counter, sign:
if ((sign = n) < 0) // Record sign.
n = -n; // Make n positive.
i = 0; // Reset counter.
do { // Generate digits in reverse order.
s [i++] = n % 10 + '0'; // Get next digit and add shift to the place, where the nr. in ASCII begin.
}
while ((n /= 10) > 0); // Delete it.
if (sign < 0) // Is it a negative number?
s [i++] = '-'; // Print minus char at first place.
s [i] = '\0'; // Print string termination char at the end.
reverse (s); // Revert the string.
}
void significant_zero_place (float number) { // If the coordinate values are only 0 then the last two significant values on LCD aren't updated.
if (number == (float) 0) { // Checks if the value is really zero.
lcd_write ("00 "); // Print two zeroes for each significance along spaces on LCD.
}
}
charptr_t hex_to_ascii (uint32_t hex) {
uint8_t temp; // Dummy variable that will hold the decimal number.
uint8_t counter; // Counter to circle through hex.
charptr_t string = NULL; // Temporary string holding variable.
for (counter = 0; counter < 8; counter++) {
temp = (hex >> (counter * 4)) & 0x0F; // Obtain the 4 bits (F) of hex number.
if (temp > 9) { // Check if the number is a letter.
temp += 0x37; // Convert the number to a letter in ASCII.
}
else {
temp += 0x30; // Convert the number to ASCII number.
}
string [counter] = temp; // Save the ASCII number in string array.
}
string [8] = '\0'; // Add the string terminator.
reverse (string);
return (string); // Return the hex string.
}