-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdisplay.oled-alpha.us2066.spin2
947 lines (783 loc) · 29.9 KB
/
display.oled-alpha.us2066.spin2
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
{
----------------------------------------------------------------------------------------------------
Filename: display.oled.us2066.spin2
Description: Driver for US2066-based OLED alphanumeric displays
Author: Jesse Burt
Started: Mar 2, 2020
Updated: Dec 27, 2024
Copyright (c) 2024 - See end of file for terms of use.
----------------------------------------------------------------------------------------------------
}
#include "terminal.common.spin2h" ' use code common to all terminal I/O drivers
CON
{ default I/O settings; these can be overridden in the parent object }
{ display dimensions }
WIDTH = 20
HEIGHT = 4
{ I2C }
SCL = 0
SDA = 1
RST = 4
I2C_FREQ = 100_000
I2C_ADDR = 0
{ SPI }
CS = 0
SCK = 1
MOSI = 2
MISO = 3
RST = 4
SPI_FREQ = 1_000_000
XMAX = WIDTH-1
YMAX = HEIGHT-1
CENTERX = WIDTH/2
CENTERY = HEIGHT/2
' I2C driver internal
SLAVE_WR = core.SLAVE_ADDR
SLAVE_RD = SLAVE_WR|1
R = 1
I2C_MAX_FREQ = core.I2C_MAX_FREQ
' Build some basic headers for I2C transactions
CMD_HDR = ((core.CTRLBYTE_CMD << 8) | SLAVE_WR)
DAT_HDR = ((core.CTRLBYTE_DATA << 8) | SLAVE_WR)
CMDSET_FUND = 0
CMDSET_EXTD = 1
CMDSET_EXTD_IS = 2
CMDSET_OLED = 3
LEFT = core.DISP_LEFT
RIGHT = core.DISP_RIGHT
' Display visibility modes
OFF = 0
NORM = 1
ON = 1
INVERT = 2
' Flag top-level objects can use to tell this is the PASM version
PASM = TRUE
' Character attributes
CHAR_PROC = (1 << 1)
VAR
long _char_attrs
byte _CS, _RESET
byte _addr_bits
{ shadow registers }
byte _entry_mode_set
byte _funct_sel_b
byte _funct_sel_c
byte _funct_set_1
byte _disp_clkdiv_freq
byte _set_seg_pins
byte _set_phase_len
byte _fnt_wid, _curs_invert, _disp_lines_nw
byte _disp_en, _curs_en, _blink_en
byte _disp_lines_n, _dblht_en
byte _fadeblink
byte _disp_width, _disp_height, _disp_xmax, _disp_ymax
OBJ
#ifdef US2066_SPI
spi: "com.spi.10mhz" ' SPI engine
#else
i2c: "com.i2c" ' I2C engine
#endif
core: "core.con.us2066" ' HW-specific constants
PUB null()
' This is not a top-level object
#ifdef US2066_SPI
PUB start(): status
' Start using default I/O settings
return startx(CS, SCK, MOSI, MISO, SPI_FREQ, RST, HEIGHT)
PUB startx(CS_PIN, SCK_PIN, MOSI_PIN, MISO_PIN, SCK_HZ, RST_PIN, DISP_HT): status
' Start the driver with custom I/O settings
' CS_PIN: SPI chip select, 0..63
' SCK_PIN: SPI clock, 0..63
' MOSI_PIN: SPI Master-out slave-in, 0..63
' MISO_PIN: SPI Master-in slave-out, 0..63
' SCK_HZ: SPI bus speed (max spec is 1_000_000 but is unenforced)
' RST_PIN: display reset, 0..63 (optional; use -1 to disable)
' DISP_HT: display height (2, 4 are common heights)
' Returns:
' cog ID+1 of SPI engine on success (= calling cog ID+1, if the bytecode SPI engine is used)
' 0 on failure
if (lookdown(CS_PIN: 0..63) and lookdown(SCK_PIN: 0..63) and ...
lookdown(MOSI_PIN: 0..63) and lookdown(MISO_PIN: 0..63) and ...
lookdown(DISP_HT: 2, 4) )
if ( status := spi.init(SCK_PIN, MOSI_PIN, MISO_PIN, core.SPI_MODE, SCK_HZ) )
waitus(core.T_POR)
_RESET := RST_PIN
_CS := CS_PIN
pinh(_CS)
if ( DISP_HT == 2 )
preset_2x16()
elseif ( DISP_HT == 4 )
preset_4x20()
reset()
defaults()
if ( dev_id() == core.DEVID_RESP )
return
return
' if this point is reached, something above failed
' Double check I/O pin assignments, connections, power
' Lastly - make sure you have at least one free core/cog
return FALSE
#else
PUB start(): status
' Start using default I/O settings
return startx(SCL, SDA, RST, I2C_FREQ, I2C_ADDR, HEIGHT)
PUB startx(SCL_PIN, SDA_PIN, RST_PIN, I2C_HZ, ADDR_BITS, DISP_HT): status
' Start the driver with custom I/O settings
' SCL_PIN: I2C clock, 0..63
' SDA_PIN: I2C data, 0..63
' RST_PIN: display reset, 0..63 (optional; use -1 to disable)
' I2C_HZ: I2C clock speed (max official specification is 400_000 but is unenforced)
' ADDR_BITS: I2C alternate address bit, 0..1
' DISP_HT: display height (2, 4 are common heights)
' Returns:
' cog ID+1 of I2C engine on success (= calling cog ID+1, if the bytecode I2C engine is used)
' 0 on failure
if ( lookdown(SCL_PIN: 0..63) and lookdown(SDA_PIN: 0..63) and lookdown(DISP_HT: 2, 4) )
if ( status := i2c.init(SCL_PIN, SDA_PIN, I2C_HZ) )
waitus(core.T_POR)
_RESET := RST_PIN
if ( ADDR_BITS )
_addr_bits := (1 << 1)
else
_addr_bits := 0
if ( DISP_HT == 2 )
preset_2x16()
elseif ( DISP_HT == 4 )
preset_4x20()
reset()
defaults()
if ( dev_id() == core.DEVID_RESP )
return
' if this point is reached, something above failed
' Double check I/O pin assignments, connections, power
' Lastly - make sure you have at least one free core/cog
return FALSE
#endif
PUB stop()
' Turn the display visibility off and stop the I2C cog
visibility(OFF)
#ifdef US2066_SPI
spi.deinit()
#else
i2c.deinit()
#endif
PUB defaults()
' Factory default settings - initialize shadow registers
_fnt_wid := core.FNTWIDTH_5
_curs_invert := core.CURS_NORM
_disp_lines_n := core.DISP_LINES_2_4
_dblht_en := 0
_disp_en := 0
_curs_en := 0
_blink_en := 0
_funct_sel_b := core.CG_ROM240_RAM8 | core.CHAR_ROM_A
_disp_clkdiv_freq := (%0111 << core.OSC_FREQ) | %0000
_entry_mode_set := core.SEG0_99 | core.COM0_31
_set_seg_pins := core.SEG_LR_REMAP_DIS | core.ALT_SEGPINCFG
_funct_sel_c := (INT << core.VSL) | GPIO_OUT_LOW
_set_phase_len := (7 << core.PHASE2) | 8
_funct_set_1 := core.CGRAM_BLINK_DIS | core.NORM_DISP
_fadeblink := 0
PUB preset_2x16()
' Set up for 2x16 displays
_disp_width := 16
_disp_height := 2
_disp_xmax := (_disp_width-1)
_disp_ymax := (_disp_height-1)
_disp_lines_nw := core.NW_1_2_LINE
PUB preset_4x20()
' Set up for 4x20 displays
_disp_width := 20
_disp_height := 4
_disp_xmax := (_disp_width-1)
_disp_ymax := (_disp_height-1)
_disp_lines_nw := core.NW_3_4_LINE
PUB char_attrs(attr)
' Set character attributes
' Valid values:
' CHAR_PROC (2) - process control codes (0 to print literal char)
_char_attrs := attr
PUB char_gen(pd)
' Select number of pre-defined vs free user-defined character cells
' Valid values:
' 240 (leaves 8 available user-defined characters)
' 248 (leaves 8 available user-defined characters)
' 250 (leaves 6 available user-defined characters)
' 256 (leaves 0 available user-defined characters)
case pd
240:
pd := core.CG_ROM240_RAM8
248:
pd := core.CG_ROM248_RAM8
250:
pd := core.CG_ROM250_RAM6
256:
pd := core.CG_ROM256_RAM0
other:
return
_funct_sel_b := (_funct_sel_b & core.OPR_MASK) | pd
writereg(2, CMDSET_EXTD, core.FUNCT_SEL_B, _funct_sel_b)
CON
ROM_A = 0
ROM_B = 1
ROM_C = 2
PUB char_rom(rf): s
' Select ROM font / character set
' Valid values:
' ROM_A (0)
' ROM_B (1)
' ROM_C (2)
case rf
ROM_A..ROM_C:
rf <<= core.ROM
other:
return
_funct_sel_b := (_funct_sel_b & core.ROM_MASK) | rf
writereg(2, CMDSET_EXTD, core.FUNCT_SEL_B, _funct_sel_b)
PUB clear()
' Clear display
writereg(0, CMDSET_FUND, core.CLEAR_DISP, 0)
PUB clear_line(line)
' Clear specified line
' Valid values: 0..3 (dependent on display's total lines)
' Any other value is ignored
if ((line >= 0) and (line <= _disp_ymax))
pos_xy(0, line)
repeat _disp_width
char(" ")
PUB clk_freq(f)
' Set display internal oscillator frequency, in kHz
' Valid values:
' 454..556 (clamped to range; see table below; POR: 501)
f := ((0 #> lookdown(freq: 454, 460, 467, 474, 481, 488, 494, 501, 508, 515, 522, 528, ...
535, 542, 549, 556) <# 15) << core.OSC_FREQ)
_disp_clkdiv_freq := (_disp_clkdiv_freq & core.OSC_FREQ_MASK) | f
writereg(1, CMDSET_OLED, core.DISP_CLKDIV_OSC, _disp_clkdiv_freq)
PUB clk_div(d)
' Set clock frequency divider used by the display controller
' Valid values: 1..16 (clamped to range; POR: 1)
d := ( (1 #> d <# 16) - 1)
_disp_clkdiv_freq := (_disp_clkdiv_freq & core.CLK_DIV_MASK) | d
writereg(1, CMDSET_OLED, core.DISP_CLKDIV_OSC, _disp_clkdiv_freq)
PUB com_logic_high_lvl(level)
' Set COMmon pins high logic level relative to Vcc ((level / 100) * Vcc)
' Valid values:
' 0_65, 0_71, 0_77, 0_83, 1_00 (clamped to range; POR: 0_77)
level := ((0 #> lookdownz(level: 0_65, 0_71, 0_77, 0_83, 1_00) <# 4) << core.VCOMH)
writereg(1, CMDSET_OLED, core.SET_VCOMH_DESEL, level)
PUB contrast(level)
' Set display contrast level
' Valid values: 0..127 (clamped to range; POR: 127)
writereg(1, CMDSET_OLED, core.SET_CONTRAST, (0 #> level <# 127))
PUB cursor_blink_ena(state)
' Enable cursor blinking
' Valid values:
' *FALSE (0): Steady cursor
' TRUE (non-zero): Blinking cursor
_blink_en := state := ((state <> 0) & 1)
writereg(0, CMDSET_FUND, core.DISP_ONOFF | (_disp_en | _curs_en | _blink_en), 0)
PUB cursor_invert_ena(state)
' Invert cursor
' Valid values:
' *FALSE (0): Normal cursor
' TRUE (non-zero): Inverted cursor
_curs_invert := state := (((state <> 0) & 1) << 1)
writereg(1, CMDSET_EXTD, core.EXTD_FUNCSET | (_fnt_wid | _curs_invert | _disp_lines_nw), 0)
PUB cursor_mode(type)
' Select cursor display mode
' Valid values:
' 0: No cursor
' 1: Block, blinking
' 2: Underscore, no blinking
' 3: Underscore, block blinking
case type
0:
_curs_invert := _blink_en := _curs_en := FALSE
1:
_curs_en := core.CURS_OFF
_curs_invert := core.CURS_INVERT
_blink_en := core.BLINK_ON
2:
_curs_en := core.CURS_ON
_curs_invert := core.CURS_NORM
_blink_en := core.BLINK_OFF
3:
_curs_en := core.CURS_ON
_curs_invert := core.CURS_NORM
_blink_en := core.BLINK_ON
other:
return
writereg(0, CMDSET_FUND, core.DISP_ONOFF | (_disp_en |_curs_en | _blink_en), 0)
cursor_invert_ena(_curs_invert >> 1)
PUB dev_id(): id
' Read device ID
' Returns: $21 if successful
writereg(0, CMDSET_FUND, $00, 0)
#ifdef US2066_SPI
rd_byte() ' dummy read
id := rd_byte()
#else
i2c.start()
i2c.write(SLAVE_RD | _addr_bits)
i2c.read(i2c.ACK) ' dummy read
id := i2c.read(i2c.NAK) ' Second read gets the Part ID
i2c.stop()
#endif
CON
FADE_BLINK_DIS = %00 << core.FB_MODE
FADE_OUT_ENA = %10 << core.FB_MODE
BLINK_ENA = %11 << core.FB_MODE
PUB disp_blink_tm(t)
' Set time interval for display blink/gradual fade in/out, in number of frames
' Valid values:
' 0, 8..128 (rounded to nearest multiple of 8; clamped to range; default is 0)
' NOTE: 0 effectively disables the setting
_fadeblink := (_fadeblink & core.FB_TIMEINT_MASK)
if ( t )
_fadeblink := (_fadeblink | BLINK_ENA | ( ( (8 #> t <# 128) / 8) - 1) )
else
_fadeblink &= core.FB_MODE_MASK ' turn off blinking/fading
writereg(1, CMDSET_OLED, core.FADE_BLINK, _fadeblink)
PUB disp_fade_tm(t)
' Set time interval for display fade out, in number of frames
' Valid values:
' 0, 8..128 (rounded to nearest multiple of 8; clamped to range; default is 0)
' NOTE: The fade will occur only once
' NOTE: 0 effectively disables the function
_fadeblink := (_fadeblink & core.FB_TIMEINT_MASK)
if ( t )
_fadeblink := (_fadeblink | FADE_OUT_ENA | ( ( (8 #> t <# 128) / 8) - 1) )
else
_fadeblink &= core.FB_MODE_MASK
writereg(1, CMDSET_OLED, core.FADE_BLINK, _fadeblink)
PUB disp_lines(lines)
' Set number of display lines
' Valid values:
' 1..4
case lines
1:
_disp_lines_n := core.DISP_LINES_1_3
_disp_lines_nw := core.NW_1_2_LINE
2:
_disp_lines_n := core.DISP_LINES_2_4
_disp_lines_nw := core.NW_1_2_LINE
3:
_disp_lines_n := core.DISP_LINES_1_3
_disp_lines_nw := core.NW_3_4_LINE
4:
_disp_lines_n := core.DISP_LINES_2_4
_disp_lines_nw := core.NW_3_4_LINE
other:
return
writereg(1, CMDSET_FUND, core.FUNCT_SET_0 | (_disp_lines_n | _dblht_en), 0)
writereg(1, CMDSET_EXTD, core.EXTD_FUNCSET | (_fnt_wid | _curs_invert | _disp_lines_nw), 0)
PUB disp_rdy(): flag
' Flag indicating display is ready
' Returns: TRUE (-1) or FALSE (0)
writereg(0, CMDSET_FUND, 0, 0)
#ifdef US2066_SPI
flag := rd_byte()
#else
i2c.start()
i2c.write(SLAVE_RD | _addr_bits)
flag := i2c.read(i2c.NAK)
i2c.stop()
#endif
return (((flag >> 7) & 1) <> 1)
PUB disp_shift(direction)
' Shift the display left or right by one character cell's width
' Valid values:
' LEFT (2)
' RIGHT (3)
' Any other value is ignored
writereg(0, CMDSET_FUND, core.CURS_DISP_SHIFT | (LEFT #> direction <# RIGHT), 0)
PUB dbl_height(mode)
' Set double-height font style mode
' Valid values:
' *0: Standard height font all 4 lines / double-height disabled
' 1: Bottom two lines form one double-height line (top 2 lines standard height,
' effectively 3 lines)
' 2: Middle two lines form one double-height line (top and bottom lines standard height,
' effectively 3 lines)
' 3: Top and bottom lines each form a double-height line (effectively 2 lines)
' 4: Top two lines form one double-height line (bottom 2 lines standard height,
' effectively 3 lines)
' NOTE: Takes effect immediately - will affect current screen contents
case mode
0:
_dblht_en := 0
writereg( 1, ...
CMDSET_EXTD, ...
core.FUNCT_SET_0 | (core.DISP_LINES_2_4 | core.DBLHT_FNT_DIS), ...
0)
return
1..4:
mode := (mode-1) << 2
other:
return
_dblht_en := core.DBLHT_FNT_EN
writereg(1, CMDSET_EXTD, core.DBLHT | mode, 0)
PUB fnt_width(sz)
' Set Font width, in pixels
' Valid values: 5 or 6 (clamped to range; POR: 5)
_fnt_wid := sz := ((0 #> (sz-5) <# 1) << core.FNTWIDTH)
writereg(1, CMDSET_EXTD, core.EXTD_FUNCSET | (_fnt_wid | _curs_invert | _disp_lines_nw), 0)
PUB get_pos(): addr
' Get current pos in display RAM
' Returns: Display address of current cursor pos
writereg(0, CMDSET_FUND, 0, 0)
#ifdef US2066_SPI
addr := rd_byte()
#else
i2c.start()
i2c.write(SLAVE_RD | _addr_bits)
addr := i2c.read(TRUE)
i2c.stop()
#endif
CON
GPIO_HIZ_INP_DIS= 0
GPIO_HIZ_INP_ENA= 1
GPIO_OUT_LOW = 2 ' POR default
GPIO_OUT_HIGH = 3
PUB gpio_state(s)
' Set state of GPIO pin
' Valid values:
' 0: GPIO pin HiZ, input disabled (always read as low)
' 1: GPIO pin HiZ, input enabled
' 2: GPIO pin output, low (POR)
' 3: GPIO pin output, high
_funct_sel_c := (_funct_sel_c & core.GPIO_MASK) | (0 #> s <# 3)
writereg(1, CMDSET_OLED, core.FUNCT_SEL_C, s)
PUB home()
' Returns cursor to home pos (0, 0)
' NOTE: Doesn't clear the display
writereg(0, CMDSET_FUND, core.HOME_DISP, 0)
PUB invert_colors(state)
' Invert display colors
' Valid values:
' TRUE (non-zero), FALSE (0)
state := (((state <> 0) & 1) + 1)
visibility(state)
PUB mirror_h(state)
' Mirror display, horizontally
' Valid values: TRUE (non-zero), FALSE (0)
_entry_mode_set := (_entry_mode_set & core.S_MASK) | ((state <> 0) & 1)
writereg(1, CMDSET_EXTD, core.ENTRY_MODE_SET | _entry_mode_set, 0)
PUB mirror_v(state)
' Mirror display, vertically
' Valid values: TRUE (non-zero), FALSE (0)
_entry_mode_set := (_entry_mode_set & core.ID_MASK) | ((( (state <> 0) & 1) ^ 1) << 1)
writereg(1, CMDSET_EXTD, core.ENTRY_MODE_SET | _entry_mode_set, 0)
PUB pin_cfg(c)
' Change mapping between display data column address and segment driver.
' Valid values:
' 0: Sequential SEG pin cfg
' 1: Alternative (odd/even) SEG pin cfg
' NOTE: Only affects subsequent data input. Data already displayed/in DDRAM will be unchanged.
_set_seg_pins := (_set_seg_pins & core.SEG_PINCFG_MASK) | (0 #> c <# 1) << core.SEG_PINCFG
writereg(1, CMDSET_OLED, core.SET_SEG_PINS, _set_seg_pins)
PUB phase1_period(clocks)
' Set length of phase 1 of segment waveform of the driver
' Valid values: 0..32 clocks
_set_phase_len := (_set_phase_len & core.PHASE1_MASK) | ( ( (2 #> clocks <# 32) >> 1) - 1)
writereg(1, CMDSET_OLED, core.SET_PHASE_LEN, _set_phase_len)
PUB phase2_period(clocks)
' Set length of phase 2 of segment waveform of the driver
' Valid values: 1..15 clocks (POR: 7)
_set_phase_len := (_set_phase_len & core.PHASE2_MASK) | ( (1 #> clocks <# 15) << core.PHASE2)
writereg(1, CMDSET_OLED, core.SET_PHASE_LEN, _set_phase_len)
PUB position = pos_xy
PUB pos_xy(column, row) | offset
' Set current cursor position
case column
0..19:
case row
0..3:
offset := ($20 * row) + column <# ($20 * row) + $13
other:
return
other:
return
writereg(0, CMDSET_FUND, core.SET_DDRAM_ADDR | offset, 0)
PUB tx = putchar
PUB char = putchar
PUB putchar(ch) | col, row, pos
' Display single character.
if (_char_attrs & CHAR_PROC) ' interpret control characters
case ch
7:
{ bell; flash display }
visibility(INVERT)
waitms(50)
visibility(NORM)
return
BS, $7F:
{ backspace }
pos := get_pos() ' get current display pointer
row := (pos / $20) ' extract row from it
col := pos - (row * $20) ' extract column from it
if (col > 0) ' not left-most column?
pos_xy(col-1, row) ' then back up one
wr_data(" ") ' erase it with a space
pos_xy(col-1, row) ' move back again
else ' otherwise, see if the cursor
if (row > 0) ' can move back a row
pos_xy(_disp_xmax, row-1)' but limit to (0, 0)
wr_data(" ")
pos_xy(_disp_xmax, row-1)
return
LF:
{ line-feed }
pos := get_pos()
row := (pos / $20)
col := pos - (row * $20)
if (col > 0) ' not already on the first col?
col-- ' move to col below prev char
if (row < _disp_ymax) ' not already on the last row?
pos_xy(col, row+1) ' go to same col, next row
else ' otherwise, go to same col,
pos_xy(col, 0) ' first row
return
CB:
{ clear display }
clear()
return
CR:
{ carriage-return }
pos := get_pos()
row := (pos / $20)
col := pos - (row * $20)
pos_xy(0, row)
return
{ displayable character }
wr_data(ch)
PUB reset()
' Send reset signal to display controller
if ( lookdown(_RESET: 0..63) )
pinl(_RESET)
#ifdef __OUTPUT_ASM__
' wait with RESETn low for the minimum width
' but only if FlexSpin's PASM build backend is used; interpreted SPIN is
' far too slow for it to be needed
waitus(core.TRES)
#endif
pinh(_RESET)
waitus(core.T_POR)
CON
' SEG Voltage reference/enable or disable internal regulator
INT = 0
EXT = 1
PUB seg_voltage_ref(r)
' Select segment voltage reference
' Valid values:
' INT (0): Internal VSL (POR)
' EXT (1): External VSL
_funct_sel_c := (_funct_sel_c & core.VSL_MASK) | ( (INT #> r <# EXT) << core.VSL )
writereg(1, CMDSET_OLED, core.FUNCT_SEL_C, _funct_sel_c)
PUB supply_voltage(v)
' Set supply voltage (enable/disable internal regulator)
' Valid values:
' 5: Enable internal regulator (use for 5V operation; POR)
' other: Disable internal regulator (3.3V/low-voltage operation)
if (v)
v := core.INT_REG_EN
else
v := core.INT_REG_DIS
writereg(2, CMDSET_EXTD, core.FUNCT_SEL_A, v)
PUB text_dir(d)
' Change mapping between display data column address and segment driver.
' Valid values:
' 0: Disable SEG left/right remap (POR)
' 1: Enable SEG left/right remap
' NOTE: Only affects subsequent data input. Data already displayed/in DDRAM will be unchanged.
_set_seg_pins := (_set_seg_pins & core.SEG_LR_REMAP_MASK) | ...
( (0 #> d <# 1) << core.SEG_LR_REMAP)
writereg(1, CMDSET_OLED, core.SET_SEG_PINS, _set_seg_pins)
PUB visibility(mode)
' Set display visibility
' Valid values:
' OFF (0): Display off
' NORM (1): Normal display
' INVERT (2): Inverted display
' NOTE: Takes effect immediately. Does not affect display RAM contents
' NOTE: Display may appear dimmer, overall, when inverted
case mode
OFF:
_disp_en := 0
NORM:
_disp_en := core.DISP_ON
_funct_set_1 := (_funct_set_1 & core.REV_EN_MASK)
INVERT:
_disp_en := core.DISP_ON
_funct_set_1 := (_funct_set_1 | core.REV_DISP)
other:
return
writereg(1, CMDSET_FUND, core.DISP_ONOFF | (_disp_en |_curs_en | _blink_en), 0)
writereg(1, CMDSET_EXTD, core.FUNCT_SET_1 | _funct_set_1, 0)
PRI wr_data(dbyte) | cmd_pkt
' Write bytes with the DATA control byte set
#ifdef US2066_SPI
' SPI
pinl(_CS)
start_data()
wrbyte_as_nibbles(dbyte)
pinh(_CS)
#else
' I2C
cmd_pkt.byte[0] := (SLAVE_WR | _addr_bits)
cmd_pkt.byte[1] := core.CTRLBYTE_DATA
cmd_pkt.byte[2] := dbyte
i2c.start()
i2c.wrblock_lsbf(@cmd_pkt, 3)
i2c.stop()
#endif
#ifdef US2066_SPI
PRI rd_byte(): b
' Read a byte from the display
pinl(_CS)
start_data(core.READ)
b := spi.rdbits_lsbf(8)
pinh(_CS)
PRI start_cmd(rw=0)
' Send start/synchronization string to the display, indicating a command is to follow
spi.wr_byte(core.SPI_START_BYTE | rw)
PRI start_data(rw=0)
' Send start/synchronization string to the display, indicating data is to follow
spi.wr_byte(core.SPI_START_BYTE | core.DC_DATA | rw)
PRI wrbyte_as_nibbles(b)
' SPI: write a byte as two zero-padded nibbles
' the US2066 expects data bytes to be split up into nibbles, transmitted LSBit-first,
' but still 8 bits at a time; split the byte into two nibbles and mask off the other
' 4 bits so they get transmitted as zeroes
spi.wrbits_lsbf(b & $0f, 8) ' b0..3, then %0000
spi.wrbits_lsbf( (b >> 4) & $0f, 8) ' b4..7, then %0000
PRI writereg(nr_bytes, cmd_set, cmd, val) | cmd_pkt[4]
' Write command/value to register
pinl(_CS)
case cmd_set
CMDSET_FUND:
start_cmd()
wrbyte_as_nibbles(cmd)
CMDSET_EXTD:
case nr_bytes
1:
start_cmd()
wrbyte_as_nibbles(core.CMDSET_EXTD | _disp_lines_n | _dblht_en)
start_cmd()
wrbyte_as_nibbles(cmd)
start_cmd()
wrbyte_as_nibbles(core.CMDSET_FUND | _disp_lines_n | _dblht_en)
2:
start_cmd()
wrbyte_as_nibbles(core.CMDSET_EXTD | _disp_lines_n | _dblht_en)
wrbyte_as_nibbles(cmd)
start_data()
wrbyte_as_nibbles(val)
start_cmd()
wrbyte_as_nibbles(core.CMDSET_FUND | _disp_lines_n | _dblht_en)
CMDSET_EXTD_IS:
case nr_bytes
1:
start_cmd()
wrbyte_as_nibbles(core.CMDSET_EXTD | _disp_lines_n | _dblht_en | 1)
wrbyte_as_nibbles(cmd)
wrbyte_as_nibbles(core.CMDSET_FUND | _disp_lines_n | _dblht_en)
2:
start_cmd()
wrbyte_as_nibbles(core.CMDSET_EXTD | _disp_lines_n | _dblht_en)
wrbyte_as_nibbles(cmd)
start_data()
wrbyte_as_nibbles(val)
start_cmd()
wrbyte_as_nibbles(core.CMDSET_FUND | _disp_lines_n | _dblht_en)
CMDSET_OLED:
start_cmd()
wrbyte_as_nibbles(core.CMDSET_EXTD | _disp_lines_n | _dblht_en)
wrbyte_as_nibbles(core.OLED_CMDSET_ENA)
wrbyte_as_nibbles(cmd)
wrbyte_as_nibbles(val) ' yes, this is supposed to be command, not data
wrbyte_as_nibbles(core.OLED_CMDSET_DIS)
wrbyte_as_nibbles(core.CMDSET_FUND | _disp_lines_n | _dblht_en)
pinh(_CS)
#else
' I2C
PRI writereg(nr_bytes, cmd_set, cmd, val) | cmd_pkt[4]
' Write cmd with param 'val' from command set
cmd_pkt.word[0] := CMD_HDR | _addr_bits
case cmd_set
CMDSET_FUND:
cmd_pkt.byte[2] := cmd
nr_bytes := 3
CMDSET_EXTD:
case nr_bytes
1:
cmd_pkt.byte[2] := core.CMDSET_EXTD | _disp_lines_n | _dblht_en
cmd_pkt.byte[3] := core.CTRLBYTE_CMD
cmd_pkt.byte[4] := cmd
cmd_pkt.byte[5] := core.CTRLBYTE_CMD
cmd_pkt.byte[6] := core.CMDSET_FUND | _disp_lines_n | _dblht_en
nr_bytes := 7
2:
cmd_pkt.byte[2] := core.CMDSET_EXTD | _disp_lines_n | _dblht_en
cmd_pkt.byte[3] := core.CTRLBYTE_CMD
cmd_pkt.byte[4] := cmd
cmd_pkt.byte[5] := core.CTRLBYTE_DATA
cmd_pkt.byte[6] := val
cmd_pkt.byte[7] := core.CTRLBYTE_CMD
cmd_pkt.byte[8] := core.CMDSET_FUND | _disp_lines_n | _dblht_en
nr_bytes := 9
other:
return
CMDSET_EXTD_IS:
case nr_bytes
1:
cmd_pkt.byte[2] := core.CMDSET_EXTD | _disp_lines_n | _dblht_en | 1
cmd_pkt.byte[3] := core.CTRLBYTE_CMD
cmd_pkt.byte[4] := cmd
cmd_pkt.byte[5] := core.CTRLBYTE_CMD
cmd_pkt.byte[6] := core.CMDSET_FUND | _disp_lines_n | _dblht_en
nr_bytes := 7
2:
cmd_pkt.byte[2] := core.CMDSET_EXTD | _disp_lines_n | _dblht_en
cmd_pkt.byte[3] := core.CTRLBYTE_CMD
cmd_pkt.byte[4] := cmd
cmd_pkt.byte[5] := core.CTRLBYTE_DATA
cmd_pkt.byte[6] := val
cmd_pkt.byte[7] := core.CTRLBYTE_CMD
cmd_pkt.byte[8] := core.CMDSET_FUND | _disp_lines_n | _dblht_en
nr_bytes := 9
other:
return
CMDSET_OLED:
cmd_pkt.byte[2] := core.CMDSET_EXTD | _disp_lines_n | _dblht_en
cmd_pkt.byte[3] := core.CTRLBYTE_CMD
cmd_pkt.byte[4] := core.OLED_CMDSET_ENA
cmd_pkt.byte[5] := core.CTRLBYTE_CMD
cmd_pkt.byte[6] := cmd
cmd_pkt.byte[7] := core.CTRLBYTE_CMD
cmd_pkt.byte[8] := val
cmd_pkt.byte[9] := core.CTRLBYTE_CMD
cmd_pkt.byte[10] := core.OLED_CMDSET_DIS
cmd_pkt.byte[11] := core.CTRLBYTE_CMD
cmd_pkt.byte[12] := core.CMDSET_FUND | _disp_lines_n | _dblht_en
nr_bytes := 13
i2c.start()
i2c.wrblock_lsbf(@cmd_pkt, nr_bytes)
i2c.stop()
#endif
DAT
{
Copyright 2024 Jesse Burt
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:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
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.
}