-
Notifications
You must be signed in to change notification settings - Fork 0
/
sensor.range.tmf8828.spin
745 lines (589 loc) · 22.7 KB
/
sensor.range.tmf8828.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
{
----------------------------------------------------------------------------------------------------
Filename: sensor.range.tmf8828.spin
Description: Driver for the TMF8828 dToF 8x8 range/proximity sensor
Author: Jesse Burt
Started: Dec 10, 2022
Updated: May 4, 2024
Copyright (c) 2024 - See end of file for terms of use.
----------------------------------------------------------------------------------------------------
}
#include "sensor.temp.common.spinh"
CON
{ default I/O configuration - these can be overridden by the parent object }
SCL = 28
SDA = 29
I2C_FREQ = 1_000_000
EN_M = 0
INT_M = 1
SLAVE_WR = core.SLAVE_ADDR
SLAVE_RD = core.SLAVE_ADDR | 1
{ interrupts }
INT_STATUS = (1 << core.INT7_ENAB)
INT_CMD_RECVD = (1 << core.INT6_ENAB)
INT_HISTO_RDY = (1 << core.INT4_ENAB)
INT_MEAS_RDY = (1 << core.INT2_ENAB)
INT_ALL = core.INT_STATUS_MASK
{ device modes }
TMF8820_21_28 = $00
TMF8828 = $08
{ packet offsets }
PKT_START = core.RESULT_NUMBER
PKT_OFFS_TEMP = core.TEMPERATURE-PKT_START
PKT_OFFS_AMBIENT_LIGHT = core.AMBIENT_LIGHT_0-PKT_START
PKT_OFFS_PHOTON_COUNT = core.PHOTON_COUNT_0-PKT_START
PKT_OFFS_REFERENCE_COUNT= core.REFERENCE_COUNT_0-PKT_START
PKT_OFFS_SYS_TICK = core.SYS_TICK_0-PKT_START
PKT_OFFS_CONFIDENCE_ZN = core.RES_CONFIDENCE_0-PKT_START
PKT_OFFS_DISTANCE_ZN = core.RES_DISTANCE_0_LSB-PKT_START
OBJ
{ decide: Bytecode I2C engine, or PASM? Default is PASM if BC isn't specified }
#ifdef TMF8828_I2C_BC
i2c: "com.i2c.nocog" ' BC I2C engine
#else
i2c: "com.i2c" ' PASM I2C engine
#endif
core: "core.con.tmf8828" ' TMF8828-specific constants
time: "time" ' timekeeping methods
dbg= DBG_OBJECT ' "virtual" instance of debug device driver
VAR
long dptr ' pointer to debug output driver
long _ptr_fw ' pointer to firmware image
word _img_sz ' size of image
byte _cal_status ' calibration status last read
byte _image[64*2], _confidence[64] ' composited range "image" and confidence array
byte _fact_cal[192*4] ' factory calibration buffer
byte _ramdump[132] ' measurement result raw dump
PUB null()
' This is not a top-level object
pub dbg_attach(p_dbg)
' Attach to debugging output device driver
' p_dbg: pointer to terminal device driver object
dptr := p_dbg
dbg[dptr].strln(@"[TMF8828] debug started")
if ( @_image & 1 )
dbg[dptr].printf1(@"[TMF8828]: \033[1;33mWARNING:\033[m image buffer isn't word-aligned (@%04.4x)\n\r", @_image)
PUB start(): status
' Start using default I2C pins and bus speed
return startx(SCL, SDA, I2C_FREQ, EN_M, INT_M)
PUB startx(SCL_PIN, SDA_PIN, I2C_HZ, ENA_PIN, INT_PIN): status
' Start using custom I/O settings
' SCL_PIN: I2C clock
' SDA_PIN: I2C data
' I2C_HZ: I2C bus speed
' ENA_PIN: TMF8828 ENABLE pin
' INT_PIN: TMF8828 INT_M pin
' Returns:
' cog ID+1 of running I2C engine on success
' 0 on failure
if ( status := i2c.init(SCL_PIN, SDA_PIN, I2C_HZ) )
outa[ENA_PIN] := 0 ' toggle EN_M low
dira[ENA_PIN] := 1
time.usleep(core.T_POR)
outa[ENA_PIN] := 1 ' then high
time.usleep(core.T_POR)
dira[INT_PIN] := 0 ' make INT_M an input
if ( dev_id() == core.DEVID_RESP )
_cal_status := -1
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
i2c.deinit()
_ptr_fw := _img_sz := 0
PUB preset_tmf8828_8x8(): s | aid, ver_m, ver_p
' Preset:
' TMF8828 mode
' 8x8 SPAD
' Returns:
' 1, 2: ROM version (loads firmware if v2)
' 3: measurement app already running
' negative numbers: error
aid := app_id()
ver_m := aid.byte[1]
ver_p := aid.byte[2]
aid &= $ff
if ( aid == core.BL_RUNNING )
if ( ver_m == $29 ) ' ROM v2
' TMF882X ROM v2 requires firmware download before a valid measurement can be done (s 3.2)
' TMF8828 ROM v2 requires the download of an application patch.
if ( _ptr_fw and _img_sz )
fw_load(_ptr_fw, _img_sz)
else
dbg[dptr].strln(@"[TMF8828] error: no firmware image set")
abort -1 ' error: no firmware image set
return 2
elseif ( ver_m == $26 ) ' ROM v1
return 1
else
dbg[dptr].printf1(@"[TMF8828] error: unknown ROM version %x\n\r", ver_m)
abort -2
elseif ( aid == core.MEAS_APP_RUNNING )
return core.MEAS_APP_RUNNING
else
dbg[dptr].printf1(@"[TMF8828] error: unknown app_id %x\n\r", aid)
abort -3
PUB app_id(): id
' Get currently running application
' Returns:
' id.byte[0]: application ID
' $03: measurement application
' $80: bootloader
' id.byte[1]: application minor version
' $26: ROM v1
' $29: ROM v2
' id.byte[2]: application patch level
id := 0
readreg(core.APPID, 3, @id)
PUB calibration_status(): s
' Get last read calibration status
' Returns:
' $ff: calibration status not updated
' $31: no factory calibration loaded
' $32: factory calibration doesn't match currently set SPAD mask
return _cal_status
PUB cmd_status(): s
' Get status of last command
' Returns:
' STAT_OK ($00)
' STAT_ACCEPTED ($01)
' STAT_ERR_CFG ($02)
' STAT_ERR_APP ($03)
' STAT_ERR_WAKEUP_TIMED ($04)
' STAT_ERR_RESET_UNEXPECTED ($05)
' STAT_ERR_UNKNOWN_CMD ($06)
' STAT_ERR_NO_REF_SPAD ($07)
' STAT_ERR_UNKNOWN_CID ($09)
' STAT_WARN_CFG_SPAD1_NOT_ACCEPT ($0a)
' STAT_WARN_CFG_SPAD2_NOT_ACCEPT ($0b)
' STAT_WARN_OSC_TRIM_NOT_ACCEPT ($0c)
' STAT_WARN_I2C_ADDR_NOT_ACCEPT ($0d)
' STAT_ERR_UNKNOWN_MODE ($0e)
s := 0
readreg(core.CMD_STAT, 1, @s)
PUB confidence(zone_nr): c
' Get confidence of object presence rating of zone
' zone_nr: zone number to rate (0..35)
' Returns: confidence rating of 0 (no obj. detected) .. 255 (highest confidence)
return _ramdump[PKT_OFFS_CONFIDENCE_ZN + (zone_nr * 3)]
PUB configure() | status, tmp, mask_nr
' 4.1
command(core.CMD_LD_CFG_PG_COM)
ifnot ( config_page_is_loaded(core.CMD_LD_CFG_PG_COM) )
dbg[dptr].strln(@"load common config page failed")
abort -1
writereg(core.PERIOD_MS_LSB, 2, $00_64) ' set measurement period to 100ms
writereg(core.SPAD_MAP_ID, 1, $06) ' set SPAD mask #6
writereg(core.GPIO_0, 1, $03) ' GPIO0: set low when VCSEL is emitting
command(core.CMD_WRITE_CFG_PG) ' write common page
writereg(core.INT_ENAB, 1, $02) ' enable interrupts
writereg(core.INT_STATUS, 1, $ff) ' clear all interrupts
PUB cpu_ready(): flag
' Flag indicating the sensor CPU is ready
flag := 0
readreg(core.ENABLE, 1, @flag)
return ( ( (flag >> core.CPU_RDY) & 1) == 1)
PUB dev_id(): id
' Get device ID
' Returns: $08
id := 0
readreg(core.ID, 1, @id)
PUB dev_mode(): mode
' Get current device operating mode
' Returns:
' TMF8820_21_28 ($00): TMF8820/21/28 mode
' TMF8828 ($08): TMF8828 mode
mode := 0
readreg(core.MODE, 1, @mode)
PUB distance(zone_nr): d
' Get measured distance of zone
' zone_nr: zone number to read distance
' Returns: distance in millimeters
d := 0
bytemove(@d, @_ramdump+PKT_OFFS_DISTANCE_ZN + (zone_nr * 3), 2)
PUB factory_calibration(): s | status, tmp, mask_nr
'4.4.3) TMF8828 factory cal
command(core.CMD_LD_CFG_PG_COM)
ifnot ( config_page_is_loaded(core.COMMON_CID) )
dbg[dptr].strln(@"verification failed - halting")
abort -1
command(core.CMD_WRITE_CFG_PG)
command(core.CMD_RESET_FACTORY_CAL) ' ensure we're starting at the first cal page
repeat tmp from 1 to 4 ' write the factory cal for each SPAD mask
command(core.CMD_FACTORY_CAL) ' writing the cal automatically advances the page
command(core.CMD_RESET_FACTORY_CAL) ' ensure we're starting at the first cal page
repeat mask_nr from 0 to 3
command(core.CMD_LD_CFG_PG_FACT_CAL)
readreg(core.CONFIG_RESULT, 192, @_fact_cal+(mask_nr*192))
command(core.CMD_WRITE_CFG_PG)
command(core.CMD_RESET_FACTORY_CAL)
repeat mask_nr from 0 to 3
command(core.CMD_LD_CFG_PG_FACT_CAL)
ifnot ( config_page_is_loaded(core.CMD_LD_CFG_PG_FACT_CAL) )
dbg[dptr].strln(@"verification failed - halting")
abort -2
writereg(core.FACTORY_CALIBR_FIRST, 192-4, @_fact_cal+(mask_nr*192)+4)
return 1
PUB fw_load(p_fw, fw_sz): status | img_remain, img_ptr, chunk_sz, img_csum, tries, tmp, aid
' Load a firmware image
' p_fw: pointer to firmware image
' fw_sz: size of image, in bytes
bl_command(core.DOWNLOAD_INIT, 1, $29) ' $29: seed (not otherwise documented)
bl_wait_rdy()
bl_command(core.ADDR_RAM, 2, $00_00)
bl_wait_rdy()
{ load RAM }
img_remain := fw_sz
img_ptr := p_fw ' init pointer to start of FW image
dbg[dptr].printf2(@"[TMF8828]: writing firmware from %04.4x, size %d\n\r", img_ptr, img_remain)
tries := 0
repeat
chunk_sz := img_remain <# 128 ' chunk size is the remaining size, up to 128 bytes
'dbg[dptr].printf2(@"[TMF8828]: about to write offset %x, size %d\n\r", img_ptr, chunk_sz)
i2c.start()
i2c.write(SLAVE_WR)
i2c.write(core.BL_CMD_STAT)
i2c.write(core.W_RAM)
i2c.write(chunk_sz) ' BL_SIZE (number of bytes to write; up to 128)
i2c.wrblock_lsbf(img_ptr, chunk_sz)
{ calc checksum }
img_csum := 0
img_csum += core.W_RAM
img_csum += chunk_sz
repeat tmp from img_ptr to (img_ptr+(chunk_sz-1))
img_csum += byte[tmp] ' calc rolling checksum
i2c.write(img_csum ^ $ff) ' one's comp. so sum of 0 doesn't yield chksum of 0
i2c.stop()
tries := 0
repeat
status := 0
readreg(core.BL_CMD_STAT, 1, @status)
if ( ++tries > 9 ) ' give up after 10 tries
dbg[dptr].printf1(@"[TMF8828]: \033[0;31mWRITE FAILED\033[m: status %06.8x\n\r", status)
abort -1 ' error writing firmware
until ( status == $00 )
img_ptr += chunk_sz
img_remain -= chunk_sz
while img_remain
bl_command(core.RAMREMAP_RESET, 0, 0)
tries := 0
repeat
aid := 0
readreg(core.APPID, 1, @aid)
{ should respond with $03 after no more than 2.5ms }
time.usleep(500)
if (++tries > 5)
repeat
until (aid == core.MEAS_APP_RUNNING)
PUB get_config_page(): p
' Get currently set configuration page
p := 0
readreg(core.CONFIG_RESULT, 1, @p)
PUB get_frame(p_img=0): s | tmp, int_s, sc, src, x, y, maj_x, min_x, yo, xo, zone, dest, cdest, sc_xo
' Get a frame of range data
' p_img (optional): copy image to buffer (defaults to driver's internal buffer)
_cal_status := 0
readreg(core.CALIBRATION_STATUS, 1, @_cal_status)
ifnot ( p_img ) ' use the driver internal img buffer if one
p_img := @_image ' isn't specified
zone := 0
repeat 4 ' read all four subcaptures
' dbg[dptr].str(@"waiting for interrupt...")
repeat until ( ina[INT_M] == 0 ) ' wait for a measurement to complete
' dbg[dptr].strln(@"asserted")
int_s := interrupt()
int_clear(int_s) ' clear interrupt
readreg(PKT_START, 128, @_ramdump)
sc := _ramdump[0] & $03
' dbg[dptr].printf1(@"sub-capture %d\n\r", sc)
case sc ' determine subcapture-specific X and Y offsets
0:
sc_xo := 0
yo := 0
1:
sc_xo := 4
yo := 0
2:
sc_xo := 0
yo := -1
3:
sc_xo := 4
yo := -1
src := @_ramdump+$14 ' set source pointer to start of range data
cdest := @_confidence ' and per-zone confidence data
zone := 1
x := 0 ' init x,y coords to lower-left (reference
y := 7 ' figure 37 in the datasheet)
xo := 0
repeat 16
' set dest pointer to lower-left of image array
dest := p_img + ((y+yo) * 16) + (x+xo+sc_xo)
bytemove(cdest++, src++, 1) ' copy zone confidence value
bytemove(dest, src, 2) ' copy range data
src += 2 ' point to next zone
x += 8 ' go to next x major offset
if ( x > 8 ) ' wrap around
x := 0
y := y - 2 ' go up two rows
if ( y < 1 ) ' wrap around
y := 7
zone++
if ( zone > 8 )
src += 3 ' skip zone 9; not used
xo := 2
if ( zone > 17 )
zone := 0
xo := 0
return _cal_status
PUB gpio0(mode): curr_mode
' Set GPIO0 mode
case mode
0..$df:
writereg(core.GPIO_0, 1, (mode & core.GPIO_0_MASK))
other:
curr_mode := 0
readreg(core.GPIO_0, 1, @curr_mode)
PUB gpio1(mode): curr_mode
' Set GPIO0 mode
case mode
0..$df:
writereg(core.GPIO_1, 1, (mode & core.GPIO_1_MASK))
other:
curr_mode := 0
readreg(core.GPIO_1, 1, @curr_mode)
PUB int_clear(mask)
' Clear asserted interrupt(s)
' Bits:
' 6 (INT_STATUS): status registers
' 5 (INT_CMD_RECVD): received command
' 3 (INT_HISTO_RDY): raw histogram is ready
' 1 (INT_MEAS_RDY): measurement result is ready
writereg(core.INT_STATUS, 1, (mask & core.INT_STATUS_MASK))
PUB int_mask(): curr_mask
' Get current interrupt mask
' Bits:
' 6 (INT_STATUS): status registers
' 5 (INT_CMD_RECVD): received command
' 3 (INT_HISTO_RDY): raw histogram is ready
' 1 (INT_MEAS_RDY): measurement result is ready
curr_mask := 0
readreg(core.INT_ENAB, 1, @curr_mask)
PUB int_set_mask(mask)
' Set interrupt mask
' Bits:
' 6 (INT_STATUS): status registers
' 5 (INT_CMD_RECVD): received command
' 3 (INT_HISTO_RDY): raw histogram is ready
' 1 (INT_MEAS_RDY): measurement result is ready
' NOTE: Unused bits 7, 4, 2, 0 masked off
writereg(core.INT_ENAB, 1, (mask & core.INT_ENAB_MASK))
PUB interrupt(): int_src
' Get currently asserted interrupt(s)
' Bits:
' 6 (INT_STATUS): status registers
' 5 (INT_CMD_RECVD): received command
' 3 (INT_HISTO_RDY): raw histogram is ready
' 1 (INT_MEAS_RDY): measurement result is ready
int_src := 0
readreg(core.INT_STATUS, 1, @int_src)
PUB ir_data(): ir
' Get sum of IR ambient light received by all channels
ir := 0
bytemove(@ir, @_ramdump+PKT_OFFS_AMBIENT_LIGHT, 4)
PUB meas_per(): per
' Get currently set measurement period
' Returns: milliseconds
per := 0
readreg(core.PERIOD_MS_LSB, 2, @per)
CON ' Operating modes
#0, MODE_MEASURE
PUB opmode(m): s
' Set operating mode
case m
MODE_MEASURE:
command(core.CMD_MEASURE)
PUB packet_cnt(): p
' Get running counter of measurement packet results
' NOTE: In TMF8828 mode, the 2LSBs are sub-capture # and the bits 7..2 are the counter
return _ramdump[PKT_OFFS_RESULT_NUMBER]
PUB packet_ptr(): p
' Get pointer to driver's internal packet buffer
return @_ramdump
PUB photon_cnt(): p
' Get the summed weight of the target peak of the closest target and all targets within 10cm
' of this target
p := 0
bytemove(@p, @_ramdump+PKT_OFFS_PHOTON_COUNT, 4)
PUB powered(state): curr_state
' Enable sensor power
' Valid values: TRUE (-1 or 1), FALSE (0)
' Any other value polls the chip and returns the current setting
curr_state := 0
readreg(core.ENABLE, 1, @curr_state)
case ||(state)
0, 1:
state &= 1
state := ((curr_state & core.PON_MASK & core.PWRUP_SEL_MASK) | (state & 1))
writereg(core.ENABLE, 1, state)
other:
return ((curr_state & 1) == 1)
PUB rd_packet(ptr_pkt)
' Read sensor data packet
' ptr_pkt:
' pointer to buffer to copy packet to
' or 0 to use the driver internal buffer
ifnot (ptr_pkt)
ptr_pkt := @_ramdump
readreg(core.CONFIG_RESULT, 132, ptr_pkt)
PUB reference_cnt(): r
' Get weight of the reference channel peak
r := 0
bytemove(@r, @_ramdump+PKT_OFFS_REFERENCE_COUNT, 4)
PUB serial_num(ptr_buff)
' Read device serial number
' ptr_buff: pointer to buffer to copy serial number to (4 bytes)
readreg(core.SERIAL_NUMBER_0, 4, ptr_buff)
PUB set_fw_image(ptr_img, img_sz)
' Setup firmware image
' ptr_img: pointer to firmware/application image
' img_sz: size of image, in bytes
_ptr_fw := ptr_img
_img_sz := img_sz
PUB set_meas_period(per)
' Set measurement period, in milliseconds
' Valid values: 0..65535
writereg(core.PERIOD_MS_LSB, 2, (0 #> per <# 65535))
PUB set_spad_map(id)
' Set SPAD map/define field of view (FoV)
if (lookdown(id: 1..7, 10..15))
writereg(core.SPAD_MAP_ID, 1, @id)
PUB spad_map(): id
' Get currently set SPAD map/FoV
id := 0
readreg(core.SPAD_MAP_ID, 1, @id)
PUB sys_tick(): t
' Get current system tick
t := 0
bytemove(@t, @_ramdump+PKT_OFFS_SYS_TICK, 4)
PUB temp_data(): t
' Get temperature data from sensor packet
' NOTE: The sensor must be in measurement mode for this data to be valid
return _ramdump[PKT_OFFS_TEMP]
PUB temp_word2deg(t_wd)
' Convert temperature word to degrees Celsius (compatibility method)
return t_wd ' no calc needed; sensor data is 1:1
PRI bl_command(cmd, len, ptr_args) | ck
' Execute bootloader command
i2c.start()
i2c.write(SLAVE_WR)
i2c.write(core.BL_CMD_STAT)
i2c.write(cmd)
i2c.write(len) ' BL_SIZE
ck := cmd + len
if (len > 4)
i2c.wrblock_lsbf(ptr_args, len)
ck += sum_blk(ptr_args, len)
elseif (len == 0)
ck := ck
elseif (len < 4)
i2c.wrblock_lsbf(@ptr_args, len)
ck += sum_blk(@ptr_args, len)
i2c.write(ck.byte[0] ^ $ff) ' cksum
i2c.stop()
PRI bl_status(): status
status := 0
readreg(core.BL_CMD_STAT, 1, @status)
PRI bl_wait_rdy() | tries, ena
' Wait for bootloader to signal ready
{ poll bootloader - READY? }
tries := 0
repeat
ena := 0
readreg(core.BL_CMD_STAT, 3, @ena)
++tries
until (ena == $ff_00_00)
pri config_page_is_loaded(cid): s | tmp
' Check if a particular config page is loaded
' cid: configuration page id
' Returns: TRUE (-1) or FALSE (0)
tmp := 0
readreg(core.CONFIG_RESULT, 4, @tmp)
{ verify the config page was loaded by checking the first few bytes: [cid][xx][$bc][$00] }
if ( (tmp.byte[0] == cid) and (tmp.word[1] == $00_bc) )
return true
else
return false
PRI wr_command(cmd): status
' Execute application command
' cmd: command to execute
' Returns:
' $00: success
' $01: command accepted
' $02..$0f: error
i2c.start()
i2c.write(SLAVE_WR)
i2c.write(core.CMD_STAT)
i2c.write(cmd)
i2c.stop()
repeat
status := 0
readreg(core.CMD_STAT, 1, @status)
until ( (status => $00) and (status =< $0f) )
PRI command(cmd): status
' Send command
' Return on success
' Display error message and halt on error
status := wr_command(cmd)
if ( status > $01 )
dbg[dptr].printf1(@"[TMF8828] command(): \033[0;31merror %02.2x\033[m\n\r", status)
repeat
PRI readreg(reg_nr, nr_bytes, ptr_buff)
' Read register(s) from the device
' reg_nr: (starting) register number
' nr_bytes: number of bytes to read
' ptr_buff: pointer to buffer to read data to
i2c.start()
i2c.write(SLAVE_WR)
i2c.write(reg_nr)
i2c.start()
i2c.write(SLAVE_RD)
i2c.rdblock_lsbf(ptr_buff, nr_bytes, i2c.NAK)
i2c.stop()
PRI sum_blk(ptr_data, len): ck | tmp
' Sum a block of data
ck := 0
repeat tmp from 0 to len-1
ck += byte[ptr_data][tmp]
PRI writereg(reg_nr, nr_bytes, ptr_buff)
' Write to device register(s)
' reg_nr: (starting) register number
' nr_bytes: number of bytes to write
' ptr_buff: if nr_bytes is 1..4, the value(s) to write
' if nr_bytes is >4, a pointer to the buffer of data to write
i2c.start()
i2c.write(SLAVE_WR)
i2c.write(reg_nr)
if ((nr_bytes => 1) and (nr_bytes =< 4))
i2c.wrblock_lsbf(@ptr_buff, nr_bytes)
else
i2c.wrblock_lsbf(ptr_buff, nr_bytes) ' indirect
i2c.stop()
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.
}