-
Notifications
You must be signed in to change notification settings - Fork 0
/
display.lcd.bt81x.spin
1605 lines (1286 loc) · 48.7 KB
/
display.lcd.bt81x.spin
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
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
---------------------------------------------------------------------------------------------------
Filename: display.lcd.bt81x.spin
Description: Driver for the Bridgetek Advanced Embedded Video Engine (EVE)
Author: Jesse Burt
Started: Sep 25, 2019
Updated: Aug 14, 2024
Copyright (c) 2024 - See end of file for terms of use.
---------------------------------------------------------------------------------------------------
}
CON
{ default I/O settings; these can be overridden in the parent object }
CS = 0
SCK = 1
MOSI = 2
MISO = 3
RST = 4
SPI_FREQ = 1_000_000
{ Recognized IDs }
BT815 = $00_0815_01
BT816 = $00_0816_01
{ Clock freq presets }
DEF = 60
HIGH = 72
LOW = 24
{ CPU Reset status }
READY = %000
RST_AUDIO = %100
RST_TOUCH = %010
RST_COPRO = %001
{ Output RGB signal swizzle }
SWIZZLE_RGBM = 0
SWIZZLE_RGBL = 1
SWIZZLE_BGRM = 2
SWIZZLE_BGRL = 3
SWIZZLE_BRGM = 8
SWIZZLE_BRGL = 9
SWIZZLE_GRBM = 10
SWIZZLE_GRBL = 11
SWIZZLE_GBRM = 12
SWIZZLE_GBRL = 13
SWIZZLE_RBGM = 14
SWIZZLE_RBGL = 15
{ Pixel clock polarity }
PCLKPOL_RISING = 0
PCLKPOL_FALLING = 1
{ Display list swap modes }
DLSWAP_LINE = 1
DLSWAP_FRAME = 2
{ Graphics primitives }
#1, BITMAPS, POINTS, LINES, LINE_STRIP, EDGE_STRIP_R, EDGE_STRIP_L, EDGE_STRIP_A, ...
EDGE_STRIP_B, RECTS
{ Various rendering options }
OPT_3D = 0
OPT_RGB565 = 0
OPT_MONO = 1
OPT_NODL = (1 << 1)
OPT_FLAT = (1 << 8)
OPT_SIGNED = (1 << 8)
OPT_CENTERX = (1 << 9)
OPT_CENTERY = (1 << 10)
OPT_CENTER = OPT_CENTERX | OPT_CENTERY
OPT_RIGHTX = (1 << 11)
OPT_NOBACK = (1 << 12)
OPT_FILL = (1 << 13)
OPT_FLASH = (1 << 6)
OPT_FORMAT = (1 << 12)
OPT_NOTICKS = (1 << 13)
OPT_NOHM = (1 << 14)
OPT_NOPOINTER = (1 << 14)
OPT_NOSECS = (1 << 15)
OPT_NOHANDS = OPT_NOPOINTER | OPT_NOSECS
OPT_NOTEAR = (1 << 2)
OPT_FULLSCREEN = (1 << 3)
OPT_MEDIAFIFO = (1 << 4)
OPT_SOUND = (1 << 5)
{ button state aliases }
UP = OPT_3D
RELEASED = OPT_3D
DOWN = OPT_FLAT
PUSHED = OPT_FLAT
{ Transform and screen rotation }
#0, ROT_LAND, ROT_INV_LAND, ROT_PORT, ROT_INV_PORT, ROT_MIR_LAND, ROT_MIR_INV_LAND, ...
ROT_MIR_PORT, ROT_MIR_INV_PORT
{ Spinner styles }
SPIN_CIRCLE_DOTS = 0
SPIN_LINE_DOTS = 1
SPIN_CLOCKHAND = 2
SPIN_ORBIT_DOTS = 3
{ Built-in fonts }
VGA8X8_ROM = 16 ' VGA ROM-like 8x8 font ($20..$7E)
VGA8X8_ROM_HI = 17 ' same, but $80..$FF mapped to $00..$7F
VGA8X12_ROM = 18 ' 8x12 variant of the above
VGA8X12_ROM_HI = 19
TCAL = $4c_41_43_54 ' "TCAL" magic number
VAR
long _CS, _RST
long _disp_width, _disp_height, _disp_xmax, _disp_ymax, _cent_x, _cent_y
long _hcyc_clks, _hoffs_cyc, _hsync0_cyc, _hsync1_cyc, _vcyc_clks
long _voffs_lns, _vsync0_cyc, _vsync1_cyc, _clkdiv, _swiz_md, _pclk_pol
long _clksprd, _dith_md, _ts_i2caddr
OBJ
spi: "com.spi.20mhz"
core: "core.con.bt81x"
time: "time"
PUB null()
' This is not a top-level object
PUB start(ptr_disp): status
' Start the driver using default I/O settings
' ptr_disp: pointer to display setup (see startx() below)
return startx(CS, SCK, MOSI, MISO, RST, ptr_disp)
PUB startx(CS_PIN, SCK_PIN, MOSI_PIN, MISO_PIN, RST_PIN, PTR_DISP): status
' Start the driver using custom I/O settings
' CS_PIN: SPI Chip Select
' SCK_PIN: SPI Clock
' MOSI_PIN: Master-Out Slave-In
' MISO_PIN: Master-In Slave-Out
' RST_PIN: Reset pin (optional; specify outside of the range 0..31 to ignore)
' PTR_DISP: pointer to display setup
' Structure (18 longs):
' WIDTH, HEIGHT, XMAX, YMAX, HCYCLE_CLKS, HOFFSET_CYCS, HSYNC0_CYCS,
' HSYNC1_CYCS, VCYCLE_CLKS, VOFFSET_LNS, VSYNC0_CYCS, VSYNC1_CYCS,
' CLKDIV, SWIZZLE_MD, PCLK_POL, CLKSPRD, DITHER_MD, TS_I2CADDR
if ( lookdown(CS_PIN: 0..31) and lookdown(SCK_PIN: 0..31) and ...
lookdown(MOSI_PIN: 0..31) and lookdown(MISO_PIN: 0..31) )
if ( status := spi.init(SCK_PIN, MOSI_PIN, MISO_PIN, core.SPI_MODE) )
_CS := CS_PIN
outa[_CS] := 1
dira[_CS] := 1
_RST := RST_PIN
reset()
pll_clk_ext()
clk_set_freq(DEF) ' set clock to default (60MHz)
repeat until ( dev_id() == core.CHIPID_VALID )
repeat until ( cpu_state() == READY )
if ( coproc_err() ) ' reset coprocessor if it's
reset_copro() ' in an error state
longmove(@_disp_width, PTR_DISP, 20)
defaults()
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
PUB stop()
' Stop the driver
powered(FALSE)
spi.deinit()
PUB defaults()
' Default settings, based on lcd chosen
' parameters for these are pulled from display definition #included in
' top-level application
disp_timings( _hcyc_clks, _hoffs_cyc, _hsync0_cyc, _hsync1_cyc, ...
_vcyc_clks, _voffs_lns, _vsync0_cyc, _vsync1_cyc )
swizzle(_swiz_md)
pix_clk_polarity(_pclk_pol)
clk_spread_ena(_clksprd)
dither_ena(_dith_md)
disp_width(_disp_width)
disp_height(_disp_height)
wait_rdy()
dl_start()
clear_color(0, 0, 0)
clear()
dl_end()
gpio_set_dir($FFFF)
gpio_set_state($FFFF)
' parameters for these are pulled from display definition #included in
' top-level application
disp_set_pix_clk_div(_clkdiv)
ts_i2c_addr(_ts_i2caddr)
PUB preset_high_perf()
' Like Defaults(), but sets clock to highest performance (72MHz)
defaults()
clk_set_freq(HIGH)
PUB attach_flash()'xxx api tentative
' Enable communication with the attached SPI flash chip
' NOTE: After calling this method, it is recommended to read the status of the SPI flash
' connection by reading the return value of flash_status()
coproc_cmd(core.CMD_FLASHATTACH)
PUB box(x1, y1, x2, y2, filled)
' Draw a box in the currently set color (set using color_rgb() or color_rgb24() )
' (x1, y1): upper-left corner
' (x2, y2): lower-right corner
if ( filled )
prim_begin(RECTS)
vertex_2f(x1, y1)
vertex_2f(x2, y2)
prim_end()
else
line(x1, y1, x2, y1)
line(x1, y2, x2, y2)
line(x1, y1, x1, y2)
line(x2, y1, x2, y2)
PUB brightness(): lvl
' Get display brightness
lvl := 0
readreg(core.PWM_DUTY, 1, @lvl)
PUB set_brightness(lvl)
' Set display brightness
' Valid values: 0..128 (clamped to range; default 128)
' Any other value polls the chip and returns the current setting
lvl := 0 #> lvl <# 128
writereg(core.PWM_DUTY, 1, @lvl)
PUB button(x, y, width, height, font, opts, ptr_str) | i, j
' Draw a button
' Valid values:
' (x, y): upper-left corner of button (0..display dimensions-1)
' width, height: dimensions of button, in pixels
' font: 0..31
' opts: OPT_3D (0), OPT_FLAT (256)
' ptr_str: Pointer to string to be displayed on button
x := 0 #> x <# _disp_xmax
y := 0 #> y <# _disp_ymax
width := 0 #> width <# _disp_xmax
height := 0 #> height <# _disp_ymax
coproc_cmd(core.CMD_BUTTON)
coproc_cmd((y << 16) + x)
coproc_cmd((height << 16) + width)
coproc_cmd((opts << 16) + font)
j := (strsize(ptr_str) + 4) / 4
repeat i from 1 to j
coproc_cmd( byte[ptr_str][3] << 24 + ...
byte[ptr_str][2] << 16 + ...
byte[ptr_str][1] << 8 + ...
byte[ptr_str][0] )
ptr_str += 4
PUB button_ptr(ptr_btndef) | x, y, width, height, font, opts, ptr_str
' Draw a button, reading from definition at ptr_btndef
' Structure:
' x, y, width, height, font, options, pointer to string
longmove(@x, ptr_btndef, 7)
button(x, y, width, height, font, opts, ptr_str)
PUB clear()
' Clear display
' NOTE: This clears color, stencil and tag buffers
clear_buffers(TRUE, TRUE, TRUE)
PUB clear_buffers(color, stencil, tag)
' Clear buffers to preset values
' Valid values: FALSE (0), TRUE (-1 or 1) for color, stencil, tag
coproc_cmd(core.CLR | ((color & 1) << core.COLOR) | ...
((stencil & 1) << core.STENCIL) | ...
(tag & 1))
PUB clear_color(r, g, b)
' Set color value used by a following clear()
' Valid values: 0..255 for r, g, b
' Any other value will be clipped to min/max limits
r := 0 #> r <# 255
g := 0 #> g <# 255
b := 0 #> b <# 255
coproc_cmd(core.CLR_COLOR_RGB | (r << 16) | (g << 8) | b)
PUB clear_screen(color)
' Clear screen using color (RGB24)
clear_color((color >> 16) & $FF, (color >> 8) & $FF, color & $FF)
clear()
PUB clk_freq(): freq
' Get clock frequency
' Returns: MHz
powered(TRUE)
readreg(core.FREQ, 4, @freq)
return (freq / 1_000_000)
PUB clk_set_freq(freq) | tmp
' Set clock frequency, in MHz
' Valid values: 24, 36, 48, *60, 72
' Any other value is ignored
' NOTE: Changing this value incurs a 300ms delay
case freq
24, 36, 48, 60, 72:
tmp := lookdown(freq: 24, 36, 48, 60, 72)
tmp := ((lookup(tmp: 0, 0, 1, 1, 1) << 6) | tmp) + 1
freq *= 1_000_000
sleep()
cmd(core.CLKSEL1, tmp)
powered(TRUE)
time.msleep(core.TPOR)
writereg(core.FREQ, 4, @freq)
other:
return
PUB clk_spread_ena(state): curr_state
' Enable output clock spreading, to reduce switching noise
' Valid values: TRUE (-1 or 1), FALSE (0)
' Any other value polls the chip and returns the current setting
case ||(state)
0, 1:
state := ||(state) & 1
writereg(core.CSPREAD, 1, @state)
other:
curr_state := 0
readreg(core.CSPREAD, 1, @curr_state)
return (curr_state & 1) == 1
PUB color_rgb(r, g, b)
' Specify color for following graphics primitive
' Valid values: 0..$ff (RGB 8, 8, 8)
r := 0 #> r <# 255
g := 0 #> g <# 255
b := 0 #> b <# 255
coproc_cmd(core.COLOR_RGB | (r << core.RED) | (g << core.GREEN) | b)
PUB color_rgb24(rgb24)
' Specify color for following graphics primitive
' Valid values: 0..$ff_ff_ff (RGB24)
rgb24 := 0 #> rgb24 <# $ff_ff_ff
coproc_cmd(core.COLOR_RGB | rgb24)
PUB coproc_cmd(command)
' Queue a coprocessor command
' NOTE: This method will always write 4 bytes to the FIFO,
' per Bridgetek AN033
writereg(core.CMDB_WRITE, 4, @command)
PUB coproc_err(): flag
' Flag indicating coprocessor error
' Returns:
' TRUE if the coprocessor has returned a fault, FALSE otherwise
readreg(core.CMD_READ, 2, @flag)
return (flag == $FFF)
PUB cpu_reset(mask)
' Reset any combination of audio, touch, and coprocessor engines
' Valid values (bitfield: 2..0):
' RST_AUDIO (4): Audio engine
' RST_TOUCH (2): Touch engine
' RST_COPRO (1): Coprocessor engine
' Example:
' cpu_reset(%010) will reset only the touch engine
' cpu_reset(%110) will reset the audio and touch engines
mask &= core.CPURESET_MASK
writereg(core.CPURESET, 2, @mask)
PUB cpu_state(): s
' Get current CPU state/reset status
' Returns:
' Bits: [2..0] (bit set/1: engine is in reset status, bit clear/0: engine is ready)
' RST_AUDIO (4): Audio engine
' RST_TOUCH (2): Touch engine
' RST_COPRO (1): Coprocessor engine
s := 0
readreg(core.CPURESET, 2, @s)
PUB detach_flash()'xxx api tentative
' Disable communication with the attached SPI flash chip
' NOTE: After calling this method, the following methods may be used to control the SPI bus
' the flash chip is connected to: flash_deselect(), flash_tx(), flash_rx()
coproc_cmd(core.CMD_FLASHDETACH)
PUB dev_id(): id
' Read device identification
' Returns: $7C
readreg(core.ID, 1, @id)
PUB dial(x, y, radius, opts, val)
' Draw a dial
x := 0 #> x <# _disp_xmax
y := 0 #> y <# _disp_ymax
radius := 0 #> radius <# _disp_xmax
coproc_cmd(core.CMD_DIAL)
coproc_cmd((y << 16) | x)
coproc_cmd((opts << 16) | radius)
coproc_cmd(val)
PUB disp_hcycle(): pclks
' Get horizontal total cycle count
' Returns: pixel clocks
pclks := 0
readreg(core.HCYCLE, 2, @pclks)
PUB disp_height(pixels)
' Set display height, in pixels
disp_set_vsize(pixels)
PUB disp_hoffset(): pclkc
' Get horizontal display start offset
' Returns: pixel clock cycles
pclkc := 0
readreg(core.HOFFSET, 2, @pclkc)
PUB disp_hsync0(pclk_cycles): curr_cyc
' Get horizontal sync fall offset
' Returns: pixel clock cycles
pclkc := 0
readreg(core.HSYNC0, 2, @pclkc)
PUB disp_hsync1(): pclkc
' Get horizontal sync rise offset
' Returns: pixel clock cycles
pclkc := 0
readreg(core.HSYNC1, 2, @pclkc)
PUB disp_pix_clk_div(): divisor
' Get pixel clock divisor
divisor := 0
readreg(core.PCLK, 2, @divisor)
PUB disp_rdy(): status | cmd_rd, cmd_wr
' Flag indicating display coprocessor is ready
' Returns: TRUE (-1) if coprocessor is idle/ready, FALSE (0) if busy
longfill(@cmd_rd, 0, 2)
readreg(core.CMD_READ, 4, @cmd_rd)
readreg(core.CMD_WRITE, 4, @cmd_wr)
return (cmd_rd == cmd_wr)
PUB disp_rot(orientation)
' Rotate the display
' Valid values:
' ROT_LAND (0), ROT_INV_LAND (1), ROT_MIR_LAND (4), ROT_MIR_INV_LAND (5):
' Landscape, inverted landscape, mirrored landscape,
' mirrored inverted landscape
' ROT_PORT (2), ROT_INV_PORT (3), ROT_MIR_PORT (6), ROT_MIR_INV_PORT (7):
' Portrait, inverted portrait, mirrored portrait,
' mirrored inverted portrait
' Any other value is ignored
case orientation
ROT_LAND, ROT_INV_LAND, ROT_PORT, ROT_INV_PORT, ROT_MIR_LAND, ROT_MIR_INV_LAND, ...
ROT_MIR_PORT, ROT_MIR_INV_PORT:
coproc_cmd(core.CMD_SETROTATE)
coproc_cmd(orientation)
other:
return
PUB disp_set_hoffset(pclkc)
' Set horizontal display start offset, in pixel clock cycles
' Valid values: 0..4095
' Any other value polls the chip and returns the current setting
pclkc := 0 #> pclkc <# 4095
writereg(core.HOFFSET, 2, @pclkc)
PUB disp_set_hcycle(pclks)
' Set horizontal total cycle count, in pixel clocks
' Valid values: 0..4095 (clamped to range)
pclks := 0 #> pclks <# 4095
writereg(core.HCYCLE, 2, @pclks)
PUB disp_set_hsync0(pclkc)
' Set horizontal sync fall offset, in pixel clock cycles
' Valid values: 0..4095 (clamped to range)
pclkc := 0 #> pclkc <# 4095
writereg(core.HSYNC0, 2, @pclkc)
PUB disp_set_hsync1(pclkc)
' Set horizontal sync rise offset, in pixel clock cycles
' Valid values: 0..4095 (clamped to range)
pclkc := 0 #> pclkc <# 4095
writereg(core.HSYNC1, 2, @pclkc)
PUB disp_set_pix_clk_div(divisor)
' Set pixel clock divisor
' Valid values: 0..1023 (clamped to range)
' NOTE: A setting of 0 disables the pixel clock output
divisor := 0 #> divisor <# 1023
writereg(core.PCLK, 2, @divisor)
PUB disp_set_voffset(lns)
' Set vertical display start offset, in lines
' Valid values: 0..4095 (clamped to range)
lns := 0 #> lns <# 4095
writereg(core.VOFFSET, 2, @lns)
PUB disp_set_vsize(lns)
' Set vertical display line count
' Valid values: 0..4095 (clamped to range)
lns := 0 #> lns <# 4095
writereg(core.VSIZE, 2, @lns)
PUB disp_set_vcycle(lns)
' Set vertical total cycle count, in lns
' Valid values: 0..4095 (clamped to range)
lns := 0 #> lns <# 4095
writereg(core.VCYCLE, 2, @lns)
PUB disp_set_vsync0(lns)
' Set vertical sync fall offset, in lns
' Valid values: 0..1023 (clamped to range)
lns := 0 #> lns <# 1023
writereg(core.VSYNC0, 2, @lns)
PUB disp_set_vsync1(lns)
' Set vertical sync rise offset, in lns
' Valid values: 0..1023 (clamped to range)
lns := 0 #> lns <# 1023
writereg(core.VSYNC1, 2, @lns)
PUB disp_timings(hc, ho, hs0, hs1, vc, vo, vs0, vs1)
' Set all display timings
disp_set_hcycle(hc)
disp_set_hoffset(ho)
disp_set_hsync0(hs0)
disp_set_hsync1(hs1)
disp_set_vcycle(vc)
disp_set_voffset(vo)
disp_set_vsync0(vs0)
disp_set_vsync1(vs1)
PUB disp_vcycle(): lns
' Get vertical total cycle count
' Returns: lines
lns := 0
readreg(core.VCYCLE, 2, @lns)
PUB disp_voffset(): lns
' Get vertical display start offset
' Returns: lines
lns := 0
readreg(core.VOFFSET, 2, @lns)
PUB disp_vsize(): lns
' Get vertical display line count
' Returns: lines
lns := 0
readreg(core.VSIZE, 2, @lns)
PUB disp_vsync0(): lns
' Get vertical sync fall offset
' Returns: lines
lns := 0
readreg(core.VSYNC0, 2, @lns)
PUB disp_vsync1(): lns
' Get vertical sync rise offset
' Returns: lines
readreg(core.VSYNC1, 2, @lns)
PUB disp_width(pixels)
' Set display width, in pixels
disp_set_hsize(pixels)
PUB dither_ena(state)
' Enable dithering on RGB output
' Valid values: *TRUE (non-zero), FALSE (0)
state := ((state <> 0) & 1)
writereg(core.DITHER, 1, @state)
PUB dl_append_from_flash(fl_addr, nr_bytes)'xxx api tentative
' Append data from flash to the display list
' fl_addr: flash memory address to start reading from
' nr_bytes: number of bytes to append to the display list
' NOTE: fl_addr must be 64-byte aligned
' NOTE: nr_bytes must be a multiple of 4
coproc_cmd(core.CMD_APPENDF)
coproc_cmd(fl_addr)
coproc_cmd(nr_bytes)
PUB dl_end()
' End a display list block and display the contents
coproc_cmd(core.DISPLAY)
coproc_cmd(core.CMD_SWAP)
PUB dl_ptr(): dl_ptr
' Returns: Current address pointer offset within display list RAM
readreg(core.CMD_DL, 2, @dl_ptr)
PUB dl_start()
' Begin a display list block
coproc_cmd(core.CMD_DLSTART)
PUB dl_swap_mode(mode): dl_status
' Set when the graphics engine will render the screen
' Valid values:
' DLSWAP_LINE (1): Render screen immediately after current line is
' scanned out (may cause visual tearing)
' DLSWAP_FRAME (2): Render screen immediately after current frame is
' scanned out
' Any other value polls the chip and returns the buffer readiness
' Returns:
' 0 - buffer ready
' 1 - buffer not ready
case mode
DLSWAP_LINE, DLSWAP_FRAME:
writereg(core.DLSWAP, 1, @mode)
other:
dl_status := 0
readreg(core.DLSWAP, 1, @dl_status)
return dl_status & %11
PUB flash_attach()'xxx api tentative
' Re-connect SPI flash
coproc_cmd(core.CMD_FLASHATTACH)
PUB flash_clear_cache()'xxx api tentative
' Clear EVE's internal flash cache
' NOTE: This should be called after modifying graphics data in flash with flash_bytemove() or
' flash_wrblk_lsbf(), otherwise bitmaps from flash may be outdated data.
' NOTE: This _must_ be called only when the display list is empty, e.g.:
' dl_start()
' flash_clear_cache()
' otherwise a coprocessor fault will be generated.
coproc_cmd(core.CMD_CLEARCACHE)
PUB flash_deselect()'XXX api tentative
' De-assert the flash CS signal
' NOTE: Use of this method is only valid when the flash is detached using flash_detach()
coproc_cmd(core.CMD_FLASHSPIDESEL)
PUB flash_detach()'xxx api tentative
' Place flash SPI device lines into Hi-Z state
' NOTE: Only the following flash-related methods are valid after calling flash_detach():
' flash_deselect(), flash_tx(), flash_rx(), flash_attach()
coproc_cmd(core.CMD_FLASHDETACH)
PUB flash_fastmode()'XXX api tentative
' Drive SPI flash chip in full-speed mode (if possible)
coproc_cmd(core.CMD_FLASHFAST)
PUB flash_rx(ram_addr, nr_bytes): b'XXX api tentative
' Read a block of data from the SPI Flash interface, and write to EVE RAM_G
' ram_addr: address in EVE RAM_G to write to
' nr_bytes: number of bytes to read
' NOTE: This method is only valid when flash has been detached using flash_detach()
coproc_cmd(core.CMD_FLASHSPIRX)
PUB flash_status(): s'xxx api tentative
' Get the current state of the connection to the SPI flash chip
' Returns:
' FLASH_INIT (0)
' FLASH_DETACHED (1)
' FLASH_BASIC (2)
' FLASH_FULL (3)
s := 0
readreg(core.FLASH_STATUS, 2, @s)
PUB flash_tx(ptr_buff, nr_bytes)'XXX api tentative
' Write a block of data over the EVE <-> SPI Flash interface
' ptr_buff: pointer to buffer of data to write from
' nr_bytes: number of bytes to write
coproc_cmd(core.CMD_FLASHSPITX)
coproc_cmd(nr_bytes)
repeat while nr_bytes--
coproc_cmd(byte[ptr_buff++])
PUB flash_rdblk_lsbf(ram_addr, fl_addr, nr_bytes)'XXX api tentative
' Read a block of data from flash to EVE RAM
' ram_addr: address in EVE RAM_G to write to
' fl_addr: flash memory address to start reading from
' nr_bytes: number of bytes to read
' NOTE: ram_addr must be 4-byte aligned
' NOTE: fl_addr must be 64-byte aligned
' NOTE: nr_bytes must be a multiple of 4
coproc_cmd(core.CMD_FLASHREAD)
coproc_cmd(ram_addr)
coproc_cmd(fl_addr)
coproc_cmd(nr_bytes)
PUB flash_bytemove(fl_addr, ptr_buff, nr_bytes)'XXX api tentative
' Write a block of data to flash from Propeller RAM
' fl_addr: flash memory address to start writing to
' ptr_buff: pointer to buffer of data to write
' nr_bytes: number of bytes to write
' NOTE: fl_addr must be 256-byte aligned
' NOTE: nr_bytes must be a multiple of 256
coproc_cmd(core.CMD_FLASHWRITE)
coproc_cmd(fl_addr)
coproc_cmd(nr_bytes)
repeat while nr_bytes-- ' keep going if > 0, and take one from the total
coproc_cmd(byte[ptr_buff++]) ' write from the buffer and advance to next byte
PUB flash_wrblk_lsbf(fl_addr, ram_addr, nr_bytes)'XXX api tentative
' Write a block of data to flash from EVE RAM
' fl_addr: flash memory address to start writing to
' ram_addr: address in EVE RAM_G to read from
' nr_bytes: number of bytes to write
' NOTE: If the data matches the existing contents of flash, nothing is done. Otherwise, the
' flash is erased in 4kB units, and the data is written.
' NOTE: ram_addr must be 4-byte aligned
' NOTE: fl_addr must be 4096-byte aligned
' NOTE: nr_bytes must be a multiple of 4096
coproc_cmd(core.CMD_FLASHREAD)
coproc_cmd(fl_addr) ' destination
coproc_cmd(ram_addr) ' source
coproc_cmd(nr_bytes)
PUB glyph_height(fnt_handle): h | offs
' Get height of a font
' fnt_handle: font handle/number (e.g., 31)
' Returns: height of font in pixels
offs := (core.ROM_FONT_ROOT + ( core.FNT_BLK_SZ * (fnt_handle-16) )) + core.SCR_HEIGHT
h := 0
readreg(offs, 4, @h)
PUB glyph_width(fnt_handle, ch): w | offs
' Get width of a glyph
' fnt_handle: font handle/number (e.g., 31)
' ch: glyph/character (e.g., "g")
' Returns: width of glyph in pixels
offs := (core.ROM_FONT_ROOT + (core.FNT_BLK_SZ * (fnt_handle-16)) ) + ch
w := 0
readreg(offs, 1, @w)
PUB gauge(x, y, radius, opts, major, minor, val, range)
' Draw a gauge
' (x, y): screen coordinates (gauge center)
' radius: radius of gauge, in pixels
' opts: rendering options (bitwise-or options together as needed)
' OPT_3D (default): 3D effect
' OPT_FLAT: no 3D effect
' OPT_NOBACK: background isn't drawn
' OPT_NOTICKS: tick marks aren't drawn
' OPT_NOPOINTER: pointer isn't drawn
' major: number of major subdivisions to draw on gauge (1..10)
' minor: number of minor subdivisions to draw on gauge (1..10)
' val: value to indicate on the gauge (u16)
' range: maximum value drawable on the gauge (u16)
x := 0 #> x <# _disp_xmax
y := 0 #> y <# _disp_ymax
radius := 0 #> radius <# _disp_xmax
coproc_cmd(core.CMD_GAUGE)
coproc_cmd((y << 16) | x)
coproc_cmd((opts << 16) | radius)
coproc_cmd(( (0 #> minor <# 10) << 16) | (0 #> major <# 10) )
coproc_cmd((range << 16) | val)
PUB gpio_state(): state
' Get GPIO pins state
state := 0
readreg(core.GPIOX, 2, @state)
PUB gpio_set_state(state)
' Set GPIO pins state
state &= $ffff
writereg(core.GPIOX, 2, @state)
PUB gpio_dir(): mask
' Get GPIO pins direction
mask := 0
readreg(core.GPIOX_DIR, 2, @mask)
PUB gpio_set_dir(mask)
' Set GPIO pins direction
mask &= $ffff
writereg(core.GPIOX_DIR, 2, @mask)
PUB gradient(x0, y0, rgb0, x1, y1, rgb1)
' Draw a smooth color gradient
' (x0, y0): screen coordinates of point 0 of gradient
' rgb0: color of point 0 (RGB24)
' (x1, y1): screen coordinates of point 1 of gradient
' rgb1: color of point 1 (RGB24)
' NOTE: use in conjunction with scissor_rect() is recommended to specify the region to draw the
' gradient (the gradient will otherwise fill the entire screen)
x0 := 0 #> x0 <# _disp_xmax
y0 := 0 #> y0 <# _disp_ymax
rgb0 := $00_00_00 #> rgb0 <# $FF_FF_FF
x1 := 0 #> x1 <# _disp_xmax
y1 := 0 #> y1 <# _disp_ymax
rgb1 := $00_00_00 #> rgb1 <# $FF_FF_FF
coproc_cmd(core.CMD_GRADIENT)
coproc_cmd((y0 << 16) | x0)
coproc_cmd(rgb0)
coproc_cmd((y1 << 16) | x1)
coproc_cmd(rgb1)
PUB gradient_trans(x0, y0, argb0, x1, y1, argb1)
' Draw a smooth color gradient, with transparency
' (x0, y0): screen coordinates of point 0 of gradient
' argb0: color of point 0 (ARGB32)
' (x1, y1): screen coordinates of point 1 of gradient
' argb1: color of point 1 (ARGB32)
' NOTE: 'A' is the alpha channel. $00 == fully transparent, $ff == fully opaque
' NOTE: use in conjunction with scissor_rect() is recommended to specify the region to draw the
' gradient (the gradient will otherwise fill the entire screen)
x0 := 0 #> x0 <# _disp_xmax
y0 := 0 #> y0 <# _disp_ymax
x1 := 0 #> x1 <# _disp_xmax
y1 := 0 #> y1 <# _disp_ymax
coproc_cmd(core.CMD_GRADIENTA)
coproc_cmd((y0 << 16) | x0)
coproc_cmd(argb0)
coproc_cmd((y1 << 16) | x1)
coproc_cmd(argb1)
PUB disp_hsize():pclks
' Get horizontal display pixel count
pclks := 0
readreg(core.HSIZE, 2, @pclks)
PUB disp_set_hsize(pclks)
' Set horizontal display pixel count
' Valid values: 0..4095 (clamped to range)
pclks := 0 #> pclks <# 4095
writereg(core.HSIZE, 2, @pclks)
PUB is_dither_ena(): s
' Get dithering state
' Returns: TRUE (-1) or FALSE (0)
s := 0
readreg(core.DITHER, 1, @s)
return ((s & 1) == 1)
PUB keys(x, y, width, height, font, opts, ptr_str) | i, j
' Draw a horizontal row of keys
' (x, y): upper-left corner of keyboard
' (width, height): dimensions of keyboard, in pixels
' font: 0..31
' opts: rendering options
' OPT_FLAT: no 3D effect (default on)
' OPT_CENTER: keys are drawn at minimum size, centered within (width, height)
' (otherwise, the keys are drawn expanded to fill the available space)
' ASCII values: the key with the matching label in ptr_str is drawn 'pressed' (like OPT_FLAT)
' ptr_str: string containing each key's label (one char per key)
' Example:
' keys(10, 10, 140, 30, 26, "2", @"12345")
' would draw a row of keys '1', '2', '3', '4', '5'
' and the '2' key would appear pressed down.
x := 0 #> x <# _disp_xmax
y := 0 #> y <# _disp_ymax
coproc_cmd(core.CMD_KEYS)
coproc_cmd((y << 16) | x)
coproc_cmd((height << 16) | width)
coproc_cmd((opts << 16) | font)
j := (strsize(ptr_str) + 4) / 4
repeat i from 1 to j
coproc_cmd( (byte[ptr_str][3] << 24) + ...
(byte[ptr_str][2] << 16) + ...
(byte[ptr_str][1] << 8) + ...
byte[ptr_str][0] )
ptr_str += 4
PUB line(x1, y1, x2, y2)
' Draw a line in the currently set color (set using color_rgb() or color_rgb24() )
' (x1, y1): point 1
' (x2, y2): point 2
prim_begin(core.LINES)
vertex_2f(x1, y1)
vertex_2f(x2, y2)
prim_end()
PUB line_width(pixels)
' Set width of line, in pixels
' NOTE: This affects the line() and box() primitives
pixels := 1 #> pixels <# 255
pixels <<= 4
coproc_cmd(core.LINE_WIDTH | pixels)
PUB model_id(): id
' Read chip model
' Returns:
' $00081501: BT815
' $00081601: BT816
' NOTE: This value is only guaranteed immediately after POR, as it is a RAM location,
' thus can be overwritten
readreg(core.CHIPID, 4, @id)
id.byte[3] := id.byte[2]
id.byte[2] := id.byte[0]
id.byte[0] := id.byte[3]
id.byte[3] := 0
PUB num(x, y, font, opts, val)
' Draw a 32-bit number, with radix/base specified by set_base()
' (x, y): upper-left pixel of text
' font: 0..31
' opts: rendering options
' OPT_CENTERX (512): horizontally center text
' OPT_CENTERY (1024): vertically center text
' OPT_CENTER (1536): horizontally and vertically center text
' OPT_SIGNED (256): draw a signed number (default unsigned 32bit)
' OPT_RIGHTX (2048): right-justify (x coordinate will be right-most pixel)
' width 1..9: pad 'val' with leading zeroes as necessary to draw 'width' digits
' val: number to draw
' Example: num(150, 20, 31, OPT_RIGHTX | 3, 42)
' would draw the number 42 right-justified, with 3 digits
' NOTE: If no preceeding set_base() is used, decimal will be used
x := 0 #> x <# _disp_xmax
y := 0 #> y <# _disp_ymax
coproc_cmd(core.CMD_NUMBER)
coproc_cmd((y << 16) | x)
coproc_cmd((opts << 16) | font)