/
ks0108.c
381 lines (350 loc) · 10.6 KB
/
ks0108.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
/*! \file ks0108.c \brief Graphic LCD driver for HD61202/KS0108 displays. */
//*****************************************************************************
//
// File Name : 'ks0108.c'
// Title : Graphic LCD driver for HD61202/KS0108 displays
// Author : Pascal Stang - Copyright (C) 2001-2003
// Date : 10/19/2002
// Revised : 5/5/2003
// Version : 0.5
// Target MCU : Atmel AVR
// Editor Tabs : 4
//
// NOTE: This code is currently below version 1.0, and therefore is considered
// to be lacking in some functionality or documentation, or may not be fully
// tested. Nonetheless, you can expect most functions to work.
//
// This code is distributed under the GNU Public License
// which can be found at http://www.gnu.org/licenses/gpl.txt
//
//*****************************************************************************
#ifndef WIN32
// AVR specific includes
#include <avr/io.h>
#include <avr/interrupt.h>
#endif
#include "global.h"
#include "ks0108.h"
// global variables
GrLcdStateType GrLcdState;
/*************************************************************/
/********************** LOCAL FUNCTIONS **********************/
/*************************************************************/
void glcdInitHW(void)
{
// initialize I/O ports
// if I/O interface is in use
#ifdef GLCD_PORT_INTERFACE
//TODO: make setup of chip select lines contingent on how
// many controllers are actually in the display
// initialize LCD control lines levels
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RS);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS0);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS1);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS2);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS3);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RESET);
// initialize LCD control port to output
sbi(GLCD_CTRL_DDR, GLCD_CTRL_RS);
sbi(GLCD_CTRL_DDR, GLCD_CTRL_RW);
sbi(GLCD_CTRL_DDR, GLCD_CTRL_E);
sbi(GLCD_CTRL_DDR, GLCD_CTRL_CS0);
sbi(GLCD_CTRL_DDR, GLCD_CTRL_CS1);
sbi(GLCD_CTRL_DDR, GLCD_CTRL_CS2);
sbi(GLCD_CTRL_DDR, GLCD_CTRL_CS3);
sbi(GLCD_CTRL_DDR, GLCD_CTRL_RESET);
// initialize LCD data
outb(GLCD_DATA_PORT, 0x00);
// initialize LCD data port to output
outb(GLCD_DATA_DDR, 0xFF);
#endif
}
void glcdControllerSelect(uint8_t controller)
{
#ifdef GLCD_PORT_INTERFACE
//TODO: make control of chip select lines contingent on how
// many controllers are actually in the display
// unselect all controllers
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS0);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS1);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS2);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_CS3);
// select requested controller
switch(controller)
{
case 0: sbi(GLCD_CTRL_PORT, GLCD_CTRL_CS0); break;
case 1: sbi(GLCD_CTRL_PORT, GLCD_CTRL_CS1); break;
case 2: sbi(GLCD_CTRL_PORT, GLCD_CTRL_CS2); break;
case 3: sbi(GLCD_CTRL_PORT, GLCD_CTRL_CS3); break;
default: break;
}
#endif
}
void glcdBusyWait(uint8_t controller)
{
#ifdef GLCD_PORT_INTERFACE
cli();
// wait until LCD busy bit goes to zero
// select the controller chip
glcdControllerSelect(controller);
// do a read from control register
outb(GLCD_DATA_PORT, 0xFF);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RS);
outb(GLCD_DATA_DDR, 0x00);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
asm volatile ("nop"); asm volatile ("nop");
while(inb(GLCD_DATA_PIN) & GLCD_STATUS_BUSY)
{
cbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
sbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
}
cbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
outb(GLCD_DATA_DDR, 0xFF);
sei();
#else
// sbi(MCUCR, SRW); // enable RAM waitstate
// wait until LCD busy bit goes to zero
while(*(volatile unsigned char *)
(GLCD_CONTROLLER0_CTRL_ADDR + GLCD_CONTROLLER_ADDR_OFFSET*controller) & GLCD_STATUS_BUSY);
// cbi(MCUCR, SRW); // disable RAM waitstate
#endif
}
void glcdControlWrite(uint8_t controller, uint8_t data)
{
#ifdef GLCD_PORT_INTERFACE
cli();
glcdBusyWait(controller); // wait until LCD not busy
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RS);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
outb(GLCD_DATA_DDR, 0xFF);
outb(GLCD_DATA_PORT, data);
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
cbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
sei();
#else
//sbi(MCUCR, SRW); // enable RAM waitstate
glcdBusyWait(controller); // wait until LCD not busy
*(volatile unsigned char *) (GLCD_CONTROLLER0_CTRL_ADDR + GLCD_CONTROLLER_ADDR_OFFSET*controller) = data;
//cbi(MCUCR, SRW); // disable RAM waitstate
#endif
}
uint8_t glcdControlRead(uint8_t controller)
{
register uint8_t data;
#ifdef GLCD_PORT_INTERFACE
cli();
glcdBusyWait(controller); // wait until LCD not busy
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RS);
outb(GLCD_DATA_DDR, 0x00);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
data = inb(GLCD_DATA_PIN);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
outb(GLCD_DATA_DDR, 0xFF);
sei();
#else
//sbi(MCUCR, SRW); // enable RAM waitstate
glcdBusyWait(controller); // wait until LCD not busy
data = *(volatile unsigned char *) (GLCD_CONTROLLER0_CTRL_ADDR + GLCD_CONTROLLER_ADDR_OFFSET*controller);
//cbi(MCUCR, SRW); // disable RAM waitstate
#endif
return data;
}
void glcdDataWrite(uint8_t data)
{
register uint8_t controller = (GrLcdState.lcdXAddr/GLCD_CONTROLLER_XPIXELS);
#ifdef GLCD_PORT_INTERFACE
cli();
glcdBusyWait(controller); // wait until LCD not busy
sbi(GLCD_CTRL_PORT, GLCD_CTRL_RS);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
outb(GLCD_DATA_DDR, 0xFF);
outb(GLCD_DATA_PORT, data);
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
cbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
sei();
#else
//sbi(MCUCR, SRW); // enable RAM waitstate
glcdBusyWait(controller); // wait until LCD not busy
*(volatile unsigned char *) (GLCD_CONTROLLER0_CTRL_ADDR + GLCD_CONTROLLER_ADDR_OFFSET*controller) = data;
//cbi(MCUCR, SRW); // disable RAM waitstate
#endif
// increment our local address counter
GrLcdState.ctrlr[controller].xAddr++;
GrLcdState.lcdXAddr++;
if(GrLcdState.lcdXAddr >= GLCD_XPIXELS)
{
GrLcdState.lcdYAddr++;
glcdSetYAddress(GrLcdState.lcdYAddr);
glcdSetXAddress(0);
}
}
uint8_t glcdDataRead(void)
{
register uint8_t data;
register uint8_t controller = (GrLcdState.lcdXAddr/GLCD_CONTROLLER_XPIXELS);
#ifdef GLCD_PORT_INTERFACE
cli();
glcdBusyWait(controller); // wait until LCD not busy
sbi(GLCD_CTRL_PORT, GLCD_CTRL_RS);
outb(GLCD_DATA_DDR, 0x00);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
sbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
asm volatile ("nop"); asm volatile ("nop");
data = inb(GLCD_DATA_PIN);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_E);
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RW);
sei();
#else
//sbi(MCUCR, SRW); // enable RAM waitstate
glcdBusyWait(controller); // wait until LCD not busy
data = *(volatile unsigned char *) (GLCD_CONTROLLER0_CTRL_ADDR + GLCD_CONTROLLER_ADDR_OFFSET*controller);
//cbi(MCUCR, SRW); // disable RAM waitstate
#endif
// increment our local address counter
GrLcdState.ctrlr[controller].xAddr++;
GrLcdState.lcdXAddr++;
if(GrLcdState.lcdXAddr >= GLCD_XPIXELS)
{
GrLcdState.lcdYAddr++;
glcdSetYAddress(GrLcdState.lcdYAddr);
glcdSetXAddress(0);
}
return data;
}
void glcdReset(uint8_t resetState)
{
// reset lcd if argument is true
// run lcd if argument is false
#ifdef GLCD_PORT_INTERFACE
if(resetState)
cbi(GLCD_CTRL_PORT, GLCD_CTRL_RESET);
else
sbi(GLCD_CTRL_PORT, GLCD_CTRL_RESET);
#endif
}
void glcdSetXAddress(uint8_t xAddr)
{
uint8_t i;
// record address change locally
GrLcdState.lcdXAddr = xAddr;
// clear y (col) address on all controllers
for(i=0; i<GLCD_NUM_CONTROLLERS; i++)
{
glcdControlWrite(i, GLCD_SET_Y_ADDR | 0x00);
GrLcdState.ctrlr[i].xAddr = 0;
}
// set y (col) address on destination controller
glcdControlWrite((GrLcdState.lcdXAddr/GLCD_CONTROLLER_XPIXELS),
GLCD_SET_Y_ADDR | (GrLcdState.lcdXAddr & 0x3F));
}
void glcdSetYAddress(uint8_t yAddr)
{
uint8_t i;
// record address change locally
GrLcdState.lcdYAddr = yAddr;
// set page address for all controllers
for(i=0; i<GLCD_NUM_CONTROLLERS; i++)
{
glcdControlWrite(i, GLCD_SET_PAGE | yAddr);
}
}
/*************************************************************/
/********************* PUBLIC FUNCTIONS **********************/
/*************************************************************/
void glcdInit()
{
uint8_t i;
// initialize hardware
glcdInitHW();
// bring lcd out of reset
glcdReset(FALSE);
// Turn on LCD
for(i=0; i<GLCD_NUM_CONTROLLERS; i++)
{
glcdControlWrite(i, GLCD_ON_CTRL | GLCD_ON_DISPLAY);
}
// clear lcd
glcdClearScreen();
// initialize positions
glcdHome();
}
void glcdHome(void)
{
uint8_t i;
// initialize addresses/positions
glcdStartLine(0);
glcdSetAddress(0,0);
// initialize local data structures
for(i=0; i<GLCD_NUM_CONTROLLERS; i++)
{
GrLcdState.ctrlr[i].xAddr = 0;
GrLcdState.ctrlr[i].yAddr = 0;
}
}
void glcdClearScreen(void)
{
uint8_t pageAddr;
uint8_t xAddr;
// clear LCD
// loop through all pages
for(pageAddr=0; pageAddr<(GLCD_YPIXELS>>3); pageAddr++)
{
// set page address
glcdSetAddress(0, pageAddr);
// clear all lines of this page of display memory
for(xAddr=0; xAddr<GLCD_XPIXELS; xAddr++)
{
glcdDataWrite(0x00);
}
}
}
void glcdStartLine(uint8_t start)
{
glcdControlWrite(0, GLCD_START_LINE | start);
glcdControlWrite(1, GLCD_START_LINE | start);
}
void glcdSetAddress(uint8_t x, uint8_t yLine)
{
// set addresses
glcdSetYAddress(yLine);
glcdSetXAddress(x);
}
void glcdGotoChar(uint8_t line, uint8_t col)
{
glcdSetAddress(col*6, line);
}
void glcdDelay(uint16_t p) // 1-8us ...2-13us ...5-31us
{ // 10-60us ...50-290us
unsigned int i; // 100-580us ...500-2,9ms
unsigned char j; // 1000-5,8ms ...5000-29ms
// 10000-56ms ...30000-170ms
// 50000-295ms...60000-345ms
// for (i = 0; i < p; i++) for (j = 0; j < 10; j++) asm volatile ("nop");
for (i = 0; i < p; i++) for (j = 0; j < 10; j++);
}
// Higher level functionality has been moved to the API-layer glcd.c/glcd.h