Mercurial > public > hwos_code
annotate src/comm.asm @ 655:c7b7b8a358cd default tip
hwOS tech 3.22 release
author | heinrichsweikamp |
---|---|
date | Mon, 29 Apr 2024 13:05:18 +0200 |
parents | 75e90cd0c2c3 |
children |
rev | line source |
---|---|
0 | 1 ;============================================================================= |
2 ; | |
636 | 3 ; File comm.asm * combined next generation V3.10.0 |
0 | 4 ; |
5 ; RS232 via USB | |
6 ; | |
654 | 7 ; Copyright (c) 2012, JD Gascuel, heinrichs weikamp gmbh, all right reserved. |
0 | 8 ;============================================================================= |
9 ; HISTORY | |
10 ; 2011-08-22 : [mH] Creation | |
631 | 11 ; 2012-02-11 : [jDG] Added 0x63 set custom text, and "i" identify |
0 | 12 |
275 | 13 #include "hwos.inc" |
0 | 14 #include "eeprom_rs232.inc" |
15 #include "tft.inc" | |
16 #include "wait.inc" | |
17 #include "strings.inc" | |
18 #include "convert.inc" | |
19 #include "external_flash.inc" | |
20 #include "tft_outputs.inc" | |
21 #include "surfmode.inc" | |
22 #include "rtc.inc" | |
23 #include "adc_lightsensor.inc" | |
299
6c4800af27ac
Make char_I_bottom_usage and char_I_deco_usage configurable from PC
heinrichsweikamp
parents:
275
diff
changeset
|
24 #include "shared_definitions.h" |
604 | 25 #include "math.inc" |
631 | 26 #include "i2c.inc" |
27 #include "logbook.inc" | |
634 | 28 #include "colorschemes.inc" |
631 | 29 |
0 | 30 |
582 | 31 extern restart |
32 extern option_reset_all | |
631 | 33 extern option_check_and_store_all |
34 extern option_read_serial | |
35 extern option_write_serial | |
582 | 36 extern gaslist_cleanup_list |
631 | 37 extern eeprom_deco_data_write |
634 | 38 extern eeprom_memorize_fw_checksum |
0 | 39 |
40 | |
631 | 41 ; timeouts |
42 #DEFINE timeout_comm_pre_mode .240 ; [sec] timeout before communication is established | |
43 #DEFINE timeout_service_mode .120 ; [sec] timeout when communication is established | |
582 | 44 |
631 | 45 ; positioning of title |
46 #DEFINE comm_title_row .0 | |
623 | 47 #DEFINE comm_title_column_usb .40 |
582 | 48 #DEFINE comm_title_column_ble .25 |
0 | 49 |
631 | 50 ; positioning of host-sent text messages |
51 #DEFINE comm_string_row .30 | |
582 | 52 #DEFINE comm_string_column .40 |
53 | |
631 | 54 ; positioning of COMM mode status messages |
55 #DEFINE comm_status1_row .70 | |
582 | 56 #DEFINE comm_status1_column .10 |
57 #DEFINE comm_status2_row .100 | |
58 #DEFINE comm_status2_column comm_status1_column | |
59 #DEFINE comm_status3_row .130 | |
60 #DEFINE comm_status3_column comm_status1_column | |
604 | 61 #DEFINE comm_status4_row .160 |
62 #DEFINE comm_status4_column comm_status1_column | |
634 | 63 #DEFINE comm_status5_row .190 |
64 #DEFINE comm_status5_column comm_status1_column | |
65 | |
604 | 66 |
631 | 67 ; positioning of COMM mode warning icon |
68 #DEFINE comm_warning_row .160 | |
623 | 69 #DEFINE comm_warning_column .65 |
582 | 70 |
0 | 71 |
631 | 72 ;#DEFINE testloop_avail ; uncomment if testloop code is available |
73 | |
634 | 74 ;============================================================================= |
604 | 75 comm CODE |
76 ;============================================================================= | |
0 | 77 |
634 | 78 ;----------------------------------------------------------------------------- |
79 ; Entry Point for Comm Mode / USB | |
80 ; | |
623 | 81 global comm_mode_usb |
82 comm_mode_usb: ; entry point for comm mode via USB | |
83 WAITMS d'1' ; wait 1 ms | |
84 btfss vusb_in ; USB still plugged in? | |
85 return ; NO - it was only a glitch, abort | |
631 | 86 WAITMS d'1' ; YES - wait 1 ms |
87 btfss vusb_in ; - USB still plugged in? | |
88 return ; NO - it was only a glitch, abort | |
89 bsf aux_flag ; YES - remember to show USB title | |
90 bra comm_mode_common ; - continue with common part | |
623 | 91 |
634 | 92 |
93 ;----------------------------------------------------------------------------- | |
94 ; Entry Point for Comm Mode / BT | |
95 ; | |
96 global comm_mode_bt | |
97 comm_mode_bt: ; entry point for comm mode via BT | |
623 | 98 bcf aux_flag ; remember to show BLE title |
99 ;bra comm_mode_common ; continue with common part | |
100 | |
634 | 101 |
102 ;----------------------------------------------------------------------------- | |
103 ; Common Part of Comm Mode Entry | |
104 ; | |
623 | 105 comm_mode_common: |
631 | 106 clrf STKPTR ; reset addresses stack |
623 | 107 call TFT_ClearScreen ; clear screen |
634 | 108 FONT_COLOR color_greenish ; set color |
631 | 109 |
623 | 110 btfss aux_flag ; shall show USB title? |
634 | 111 bra comm_mode_common_bt ; NO - show BT title |
112 ;bra comm_mode_common_usb ; YES - show USB title | |
631 | 113 |
634 | 114 comm_mode_common_usb: |
115 WIN_SMALL comm_title_column_usb, comm_title_row ; set USB title position | |
116 STRCPY_TEXT_PRINT tUsbTitle ; print USB title text | |
117 bra comm_mode_common_logo ; continue with logo | |
631 | 118 |
634 | 119 comm_mode_common_bt: |
120 WIN_SMALL comm_title_column_ble, comm_title_row ; set BT title position | |
121 STRCPY_TEXT_PRINT tBleTitle ; print BT title text | |
122 ;bra comm_mode_common_logo ; continue with logo | |
123 | |
124 comm_mode_common_logo: | |
631 | 125 WIN_TOP .10 ; set position of USB/BLE logo, row |
126 WIN_LEFT .1 ; set position of USB/BLE logo, column | |
634 | 127 btfss battery_gauge_available ; "+" bootloader ? |
128 bra comm_mode_common_logo2 ; YES - show logo type 2 | |
129 ;bra comm_mode_common_logo1 ; NO - show logo type 1 | |
130 | |
131 comm_mode_common_logo1: | |
132 TFT_WRITE_PROM_IMAGE_BY_ADDR comm_logo_1 ; show USB/BT logo | |
133 bra comm_mode_common_start ; continue with starting message | |
631 | 134 |
634 | 135 comm_mode_common_logo2: |
654 | 136 btfsc dn_flag |
137 bra comm_mode_common_logo3 | |
634 | 138 TFT_WRITE_PROM_IMAGE_BY_ADDR comm_logo_2 ; show BT logo / OSTC+ |
654 | 139 bra comm_mode_common_start ; continue with starting message |
631 | 140 |
654 | 141 comm_mode_common_logo3: |
142 TFT_WRITE_PROM_IMAGE_BY_ADDR comm_logo_3 ; show BT logo / dn | |
143 | |
634 | 144 comm_mode_common_start: |
145 WIN_SMALL comm_status1_column,comm_status1_row ; set position | |
146 FONT_COLOR_MEMO ; set standard color | |
147 STRCPY_TEXT_PRINT tUsbStarting ; print status message "starting..." | |
631 | 148 |
623 | 149 WIN_TINY .40,.240-.16 ; set output position to bottom line |
634 | 150 call TFT_print_serial_and_firmware ; show serial number and firmware version |
604 | 151 |
152 IFDEF _screendump | |
631 | 153 bcf screen_dump_avail ; disable screen dump function |
604 | 154 ENDIF |
155 | |
631 | 156 bcf switch_right ; clear potential left-over right button event |
157 call enable_rs232 ; enable serial comm, also sets CPU to normal speed | |
158 | |
634 | 159 WIN_SMALL comm_status1_column+.80,comm_status1_row ; set position after starting message |
160 FONT_COLOR_MEMO ; set standard color | |
161 STRCPY_TEXT_PRINT tUsbStartDone ; print (adding to status message) "done..." | |
631 | 162 |
163 movlw timeout_comm_pre_mode ; get timeout for phase without communication established yet | |
164 movwf comm_timeout_timer ; initialize timeout counter | |
634 | 165 ;bra comm_mode_selection_loop ; continue with mode selection loop |
0 | 166 |
634 | 167 |
168 ;----------------------------------------------------------------------------- | |
169 ; Mode Selection Loop: Download Mode or Service Mode | |
170 ; | |
631 | 171 comm_mode_selection_loop: |
172 bcf trigger_full_second ; clear 'one second elapsed' flag | |
173 bcf LEDr ; switch off red LED / power down TR co-processor | |
174 dcfsnz comm_timeout_timer,F ; decrement timeout, reached zero? | |
175 bra comm_service_exit ; YES - timeout, exit comm mode | |
176 ;bra comm_mode_selection_loop_1 ; NO - try to receive a byte | |
177 comm_mode_selection_loop_1: | |
178 SERIAL_CC_RECEIVE lo ; (try to) receive 1 byte | |
179 btfsc rs232_rx_timeout ; timeout? | |
180 bra comm_mode_selection_loop_2 ; YES - check for comm mode termination | |
181 movf lo,W ; NO - copy received byte to lo | |
182 xorlw 0xAA ; - service mode start byte received? | |
183 bz comm_service_mode_check ; YES - check if correct key will be send | |
184 movf lo,W ; NO - copy received byte to lo again | |
185 xorlw 0xBB ; - download mode start byte received? | |
634 | 186 bz comm_download_mode ; YES - enter command loop |
187 ;bra comm_mode_selection_loop_2 ; NO - check for comm mode termination | |
631 | 188 comm_mode_selection_loop_2: |
634 | 189 btfsc ble_available ; BT available? |
631 | 190 bra comm_mode_selection_loop_3 ; YES - skip USB check check (required for very old OSTC sport) |
191 btfss vusb_in ; NO - USB plugged in? | |
192 bra comm_service_exit_nousb_delay ; NO - disconnected, check for vusb_in glitch | |
193 ;bra comm_mode_selection_loop_3 ; YES - check for exit button or continue looping | |
194 comm_mode_selection_loop_3: | |
195 btfsc switch_right ; right button pressed? | |
196 bra comm_service_exit ; YES - exit comm mode | |
197 btfsc trigger_full_second ; NO - did 1 second elapsed meanwhile? | |
198 bra comm_mode_selection_loop ; YES - loop with clocking down timeout counter | |
199 bra comm_mode_selection_loop_1 ; NO - loop without clocking down timeout counter | |
0 | 200 |
201 | |
202 ;----------------------------------------------------------------------------- | |
634 | 203 ; Check Service Mode Pass-Key and notify Service Mode on Success |
0 | 204 ; |
631 | 205 comm_service_mode_check: |
206 SERIAL_LC_SEND 0x4B ; request peer to send service key | |
207 | |
208 ; receive a 3 byte service key transmitted in big-endian, echo each byte | |
209 | |
210 clrf WREG ; clear WREG | |
211 | |
212 SERIAL_CC_RECEIVE lo ; receive 1st byte, store in lo | |
213 xorwf lo,W ; exclusive-or received byte into WREG | |
214 xorlw UPPER (comm_service_key) ; exclusive-or expected byte into WREG | |
215 SERIAL_CC_SEND lo ; echo 1st byte | |
0 | 216 |
631 | 217 SERIAL_CC_RECEIVE lo ; receive 2nd byte, store in lo |
218 xorwf lo,W ; exclusive-or received byte into WREG | |
219 xorlw HIGH (comm_service_key & 0xFFFF) ; exclusive-or expected byte into WREG | |
220 SERIAL_CC_SEND lo ; echo 2nd byte | |
221 | |
222 SERIAL_CC_RECEIVE lo ; receive 3rd byte, store in lo | |
223 xorwf lo,W ; exclusive-or received byte into WREG | |
224 xorlw LOW (comm_service_key & 0xFFFF) ; exclusive-or expected byte into WREG | |
225 SERIAL_CC_SEND lo ; echo 3rd byte | |
226 | |
227 ; check for correct service key | |
228 tstfsz WREG ; received expected service key? | |
229 bra comm_mode_selection_loop ; NO - back to mode selection loop | |
230 WIN_SMALL comm_status2_column, comm_status2_row ; YES - print service mode enabled message | |
634 | 231 FONT_COLOR_MEMO ; - set standard color |
631 | 232 STRCPY_TEXT_PRINT tUsbServiceMode ; - ... |
233 bsf comm_service_mode ; - enable service mode commands | |
234 bra comm_command_loop ; - enter command loop | |
0 | 235 |
623 | 236 |
0 | 237 ;----------------------------------------------------------------------------- |
634 | 238 ; Notify RX Timeout occurred |
239 ; | |
240 comm_command_timeout: | |
241 WIN_SMALL comm_status4_column, comm_status4_row ; select font and output position | |
242 FONT_COLOR_WARNING ; set warning color | |
243 STRCPY_PRINT "Data Rx Timeout" ; print failure message | |
244 FONT_COLOR_MEMO ; back to standard color | |
245 bra comm_drain_rx_queue ; continue with draining the RX queue | |
246 | |
247 | |
248 ;----------------------------------------------------------------------------- | |
249 ; Notify Error in Parameters | |
250 ; | |
251 comm_command_error: | |
252 WIN_SMALL comm_status4_column, comm_status4_row ; select font and output position | |
253 FONT_COLOR_WARNING ; set warning color | |
640 | 254 STRCPY_PRINT "Unknown Parameter" ; print failure message |
634 | 255 FONT_COLOR_MEMO ; back to standard color |
640 | 256 bra comm_service_exit ; abort |
634 | 257 ;bra comm_drain_rx_queue ; continue with draining the RX queue |
258 | |
259 | |
260 ;----------------------------------------------------------------------------- | |
261 ; Drain the RX Queue until next Timeout | |
262 ; | |
263 comm_drain_rx_queue: | |
264 bsf INTCON,GIE ; re-enable all interrupts | |
265 comm_drain_rx_queue_loop: | |
266 btfsc switch_right ; right button (abort) pressed? | |
267 bra comm_service_exit ; YES - exit comm mode | |
268 SERIAL_CC_RECEIVE WREG ; NO - (try to) receive one byte | |
269 btfss rs232_rx_timeout ; - got a byte? | |
270 bra comm_drain_rx_queue_loop ; YES - try to drain more bytes | |
271 bra comm_command_loop ; NO - re-enter command loop | |
272 | |
273 | |
274 ;----------------------------------------------------------------------------- | |
275 ; Debug Code - show Number of Bytes received | |
276 ; | |
277 IFDEF _comm_debug | |
278 comm_command_debug: | |
279 WIN_SMALL comm_status5_column, comm_status5_row ; select font and output position | |
280 FONT_COLOR_MEMO ; set standard color | |
281 STRCPY "last RX: " ; print label | |
282 output_9999 ; print number of bytes received (0-9999) | |
283 STRCAT_PRINT " Byte" ; finalize output | |
284 bra comm_command_loop ; re-enter command loop | |
285 ENDIF | |
286 | |
287 | |
288 ;----------------------------------------------------------------------------- | |
289 ; Notify Download Mode selected | |
623 | 290 ; |
631 | 291 comm_download_mode: |
292 SERIAL_LC_SEND 0xBB ; inform peer download mode will be started | |
0 | 293 |
634 | 294 WIN_SMALL comm_status2_column, comm_status2_row ; set position |
295 FONT_COLOR_MEMO ; set standard color | |
296 STRCPY_TEXT_PRINT tUsbDownloadMode ; print download mode enabled message | |
631 | 297 bcf comm_service_mode ; disable service mode commands |
634 | 298 ;bra comm_command_loop ; enter command loop |
631 | 299 |
0 | 300 |
301 ;----------------------------------------------------------------------------- | |
634 | 302 ; Command Loop: await, decode and execute Commands |
623 | 303 ; |
631 | 304 comm_command_loop: |
305 bsf INTCON,GIE ; re-enable all interrupts | |
634 | 306 |
307 ; restart command timeout | |
631 | 308 movlw timeout_service_mode ; get timeout value |
309 movwf comm_timeout_timer ; reload timeout timer | |
0 | 310 |
631 | 311 ; request peer to send a command |
312 movlw 0x4D ; default request code is 0x4D for download mode active | |
313 btfsc comm_service_mode ; service mode enabled? | |
314 movlw 0x4C ; YES - change request to 0x4C for service mode active | |
315 SERIAL_CC_SEND WREG ; send request | |
0 | 316 |
631 | 317 ; wait for peer to send a command |
318 comm_command_loop_wait: | |
319 SERIAL_CC_RECEIVE lo ; (try to) receive a command byte | |
320 btfss rs232_rx_timeout ; timeout? | |
321 bra comm_command_decode ; NO - decode and execute the command | |
322 btfsc comm_service_mode ; YES - service mode enabled? | |
323 btg LEDr ; YES - blink in service mode | |
634 | 324 btfsc ble_available ; - BT available? |
631 | 325 bra comm_command_loop_wait_1 ; YES - skip USB check (required for very old OSTC sport) |
326 btfss vusb_in ; NO - USB still plugged in? | |
327 bra comm_service_exit_nousb ; NO - disconnected -> exit comm mode | |
634 | 328 ;bra comm_command_loop_wait_1 ; YES - proceed |
329 | |
631 | 330 comm_command_loop_wait_1: |
331 btfsc switch_right ; right button (abort) pressed? | |
332 bra comm_service_exit ; YES - exit comm mode | |
333 btfss trigger_full_second ; NO - did 1 second elapsed meanwhile? | |
334 bra comm_command_loop_wait ; NO - loop | |
335 dcfsnz comm_timeout_timer,F ; YES - decrement the timeout timer, reached zero? | |
336 bra comm_service_exit ; YES - exit comm mode | |
337 bcf trigger_full_second ; NO - clear 'one second elapsed' flag | |
338 bra comm_command_loop_wait ; - loop | |
346
cf9ce6053dee
New option to download "Compact Headers". Improved BLE support (OSTC 2 and OSTC 3+), updated OSTC interface documentation
heinrichsweikamp
parents:
337
diff
changeset
|
339 |
cf9ce6053dee
New option to download "Compact Headers". Improved BLE support (OSTC 2 and OSTC 3+), updated OSTC interface documentation
heinrichsweikamp
parents:
337
diff
changeset
|
340 |
cf9ce6053dee
New option to download "Compact Headers". Improved BLE support (OSTC 2 and OSTC 3+), updated OSTC interface documentation
heinrichsweikamp
parents:
337
diff
changeset
|
341 ;----------------------------------------------------------------------------- |
634 | 342 ; Macro for easier writing of Command Decoding Rules |
631 | 343 ; |
344 command_decode macro command_id,command_function | |
634 | 345 movf lo,W ; copy received command to WREG |
346 xorlw command_id ; exclusive-or with command ID | |
347 btfsc STATUS,Z ; received command = command ID ? | |
348 goto command_function ; YES - execute command | |
631 | 349 endm |
0 | 350 |
634 | 351 |
0 | 352 ;----------------------------------------------------------------------------- |
634 | 353 ; Decode and execute a Command |
631 | 354 ; |
355 comm_command_decode: | |
356 bcf LEDr ; switch off red led | |
80 | 357 |
631 | 358 ; decode and execute standard commands |
359 command_decode 0x6E,comm_show_text ; n show a text on the screen | |
360 command_decode 0x69,comm_identify ; i send ID: serial, firmware, and custom text | |
361 command_decode 0x6A,comm_hardware_descriptor ; j send ID: hardware descriptor byte | |
362 command_decode 0x60,comm_feature_and_hardware ; ' send ID: more detailed information | |
363 command_decode 0x6D,comm_send_headers_short ; m send all headers in compact format | |
364 command_decode 0x61,comm_send_headers_full ; a send all headers is full format | |
365 command_decode 0x66,comm_send_dive ; f send header and profile for one dive | |
366 command_decode 0x62,comm_set_time ; b set the real time clock | |
367 command_decode 0x63,comm_set_custom_text ; c write a new custom text | |
368 command_decode 0x72,comm_read_option ; r read an option value | |
369 command_decode 0x77,comm_write_option ; w write an option value (into RAM) | |
370 command_decode 0x78,comm_option_reset_all ; x reset all option values to their factory default | |
371 command_decode 0xFF,comm_service_exit ; exit comm mode | |
372 IFDEF _screendump | |
636 | 373 command_decode 0x6C,TFT_dump_screen_comm ; l dump the screen contents |
631 | 374 ENDIF |
375 | |
376 btfss comm_service_mode ; service mode enabled? | |
377 bra comm_command_loop ; NO - ignore unrecognized command, back to command loop | |
378 | |
379 ; decode and execute additional service mode commands | |
380 command_decode 0x23,comm_reset_battery_gauge ; # reset the battery gauge registers | |
381 command_decode 0x22,comm_erase_complete_logbook ; " reset all logbook pointers and the logbook | |
634 | 382 command_decode 0x20,comm_read_range ;' ' read a memory range from the external FLASH |
383 command_decode 0x40,comm_erase_single_4kb ; @ erase a single 4 kB block - Warning: no confirmation or built-in safety here... | |
384 command_decode 0x42,comm_erase_range_4kb ; B erase a range of 4 kB blocks - Warning: no confirmation or built-in safety here... | |
631 | 385 command_decode 0x30,comm_write_range_stream ; 0 write a stream of bytes starting at ext_flash_address:3 until timeout |
386 command_decode 0x31,comm_write_range_block ; 1 write a block of 256 bytes starting at ext_flash_address:3 | |
387 command_decode 0x50,comm_firmware_update ; P initiate firmware update | |
388 command_decode 0xC1,comm_cold_start ; start low-level bootloader | |
389 IFDEF testloop_avail | |
390 command_decode 0x74,testloop ; t start raw-data test loop | |
391 ENDIF | |
392 | |
393 bra comm_command_loop ; ignore unrecognized command, back to command loop | |
394 | |
80 | 395 |
396 ;----------------------------------------------------------------------------- | |
636 | 397 ; Screendump |
398 ; | |
399 IFDEF _screendump | |
400 TFT_dump_screen_comm: | |
401 call TFT_dump_screen ; dump the screen contents and set screen_dump_avail | |
402 ;bra comm_service_exit ; exit comm mode | |
403 ENDIF | |
404 | |
405 | |
406 ;----------------------------------------------------------------------------- | |
634 | 407 ; Exit Comm Mode |
631 | 408 ; |
409 comm_service_exit: | |
410 WIN_SMALL comm_status3_column, comm_status3_row ; print "Exited" message | |
634 | 411 FONT_COLOR_MEMO ; set standard color |
631 | 412 STRCPY_TEXT_PRINT tUsbExit ; ... |
413 bra comm_service_exit_common ; acknowledge exit command and restart | |
0 | 414 |
631 | 415 comm_service_exit_nousb_delay: |
416 WAITMS d'200' ; wait 200 ms | |
417 btfsc vusb_in ; USB sensed again? | |
418 bra comm_mode_selection_loop_3 ; YES - was just a glitch, continue | |
419 ;bra comm_service_exit_nousb ; NO - proceed exiting | |
0 | 420 |
631 | 421 comm_service_exit_nousb: |
422 WIN_SMALL comm_status3_column, comm_status3_row ; print "Port closed" message | |
634 | 423 FONT_COLOR_MEMO ; set standard color |
631 | 424 STRCPY_TEXT_PRINT tUsbClosed ; ... |
425 ;bra comm_service_exit_common ; proceed exiting | |
426 | |
427 comm_service_exit_common: | |
428 SERIAL_LC_SEND 0xFF ; acknowledge exit command | |
634 | 429 WAITS .1 ; wait 1 second to give the serial I/F time |
430 ; to send the 0xFF before it gets shut down | |
631 | 431 call disable_rs232 ; shut down comm port |
432 bcf LEDr ; switch off red LED | |
634 | 433 WAITS .1 ; wait 1 second for BT module supply to drain |
631 | 434 goto restart ; restart |
435 | |
0 | 436 |
437 ;----------------------------------------------------------------------------- | |
631 | 438 ; Set Real-Time-Clock |
0 | 439 ; |
631 | 440 comm_set_time: |
634 | 441 bcf INTCON,GIE ; disable all interrupts |
631 | 442 SERIAL_LC_SEND 0x62 ; acknowledge command |
634 | 443 SERIAL_RR_RECEIVE mpr,.6 ; (try to) receive 6 bytes: hour, minute, second, month, day, year |
444 bsf INTCON,GIE ; re-enable all interrupts | |
631 | 445 |
634 | 446 btfsc rs232_rx_timeout ; got all 6 bytes? |
447 bra comm_command_timeout ; NO - show rx timeout message and back to command loop | |
631 | 448 |
634 | 449 movff mpr+0,rtc_latched_hour ; map the received bytes onto the rtc_latched variables |
450 movff mpr+1,rtc_latched_mins ; ... | |
451 movff mpr+2,rtc_latched_secs ; ... | |
452 movff mpr+3,rtc_latched_month ; ... | |
453 movff mpr+4,rtc_latched_day ; ... | |
454 movff mpr+5,rtc_latched_year ; ... | |
631 | 455 call rtc_set_rtc ; write time and date to RTC module |
456 bra comm_command_loop ; done, back to command loop | |
457 | |
458 | |
459 ;----------------------------------------------------------------------------- | |
634 | 460 ; Write a 15 char Text to the OSTC Display |
631 | 461 ; |
462 comm_show_text: | |
634 | 463 ; set font and output position (needs to be done before SERIAL_RR_RECEIVE) |
631 | 464 WIN_SMALL comm_string_column, comm_string_row |
634 | 465 FONT_COLOR_MEMO ; set standard color |
631 | 466 |
634 | 467 bcf INTCON,GIE ; disable all interrupts |
631 | 468 SERIAL_LC_SEND 0x6E ; acknowledge command |
634 | 469 SERIAL_RR_RECEIVE buffer,.16 ; (try to) receive 16 chars into the string buffer |
470 bsf INTCON,GIE ; re-enable all interrupts | |
631 | 471 |
634 | 472 movlw .15 ; set maximum text length |
473 call TFT_buffer_trim_length ; fill or trim the text to correct length | |
474 PRINT ; print text to screen | |
475 bra comm_command_loop ; done, back to command loop | |
476 | |
477 | |
478 ;----------------------------------------------------------------------------- | |
479 ; Send Serial (2 bytes low:high), Firmware (major.minor) and Custom Text | |
480 ; | |
481 comm_identify: | |
482 SERIAL_LC_SEND 0x69 ; acknowledge command | |
483 | |
484 ; send OSTC serial number | |
485 call eeprom_serial_number_read ; read OSTC serial number | |
486 SERIAL_CC_SEND mpr+0 ; send serial number, low byte | |
487 SERIAL_CC_SEND mpr+1 ; send serial number, high byte | |
488 | |
489 ; send firmware version | |
490 SERIAL_LC_SEND fw_version_major ; send firmware version, major | |
491 SERIAL_LC_SEND fw_version_minor ; send firmware version, minor | |
492 | |
493 ; send custom text | |
494 SERIAL_RR_SEND opt_name,opt_name_length | |
631 | 495 |
496 bra comm_command_loop ; done, back to command loop | |
497 | |
0 | 498 |
499 ;----------------------------------------------------------------------------- | |
634 | 500 ; Send short Hardware Descriptor |
0 | 501 ; |
634 | 502 comm_hardware_descriptor: |
503 SERIAL_LC_SEND 0x6A ; acknowledge command | |
504 rcall comm_helper_hw_descriptor ; send hardware descriptor | |
631 | 505 bra comm_command_loop ; done, back to command loop |
0 | 506 |
623 | 507 |
235
23311219dacc
under construction: new hardware_flag to configure different hardware versions
heinrichsweikamp
parents:
223
diff
changeset
|
508 ;----------------------------------------------------------------------------- |
634 | 509 ; Helper Function for sending Hardware Descriptor |
235
23311219dacc
under construction: new hardware_flag to configure different hardware versions
heinrichsweikamp
parents:
223
diff
changeset
|
510 ; |
634 | 511 comm_helper_hw_descriptor: |
623 | 512 movf HW_descriptor,W ; get hardware descriptor |
513 bcf WREG,6 ; clear bit 6 for reason of compatibility with 3rd party software | |
514 bcf WREG,7 ; clear bit 7 for reason of compatibility with 3rd party software | |
631 | 515 SERIAL_CC_SEND WREG ; send modified hardware descriptor |
634 | 516 return |
623 | 517 |
0 | 518 |
631 | 519 ;----------------------------------------------------------------------------- |
634 | 520 ; Send detailed Hardware Descriptor |
631 | 521 ; |
441
360acdcda0d7
+BUGFIX: Compatibility with "hwOS Config" fixed
heinrichsweikamp
parents:
426
diff
changeset
|
522 comm_feature_and_hardware: |
631 | 523 SERIAL_LC_SEND 0x60 ; acknowledge command |
623 | 524 |
634 | 525 SERIAL_LC_SEND 0x00 ; send hardware high byte (fixed zero) |
526 rcall comm_helper_hw_descriptor ; send hardware descriptor | |
527 SERIAL_LC_SEND 0x00 ; send feature high byte (fixed zero) | |
528 SERIAL_LC_SEND 0x00 ; send feature low byte (fixed zero) | |
631 | 529 SERIAL_LC_SEND 0x00 ; send model descriptor byte (fixed zero) |
623 | 530 |
631 | 531 bra comm_command_loop ; done, back to command loop |
623 | 532 |
604 | 533 |
534 ;----------------------------------------------------------------------------- | |
634 | 535 ; Helper Function to retrieve a Header, hide the internal Profile Version, |
536 ; and to check if the Header is empty | |
537 ; | |
538 comm_helper_read_header: | |
539 ; copy header from FLASH into memory | |
540 call log_header_addr_by_index ; compute header start address from index in WREG | |
541 FLASH_RR_READ header_buffer,.256 ; copy from FLASH to header buffer | |
0 | 542 |
634 | 543 ; hide internal profile version ID from the outside |
544 movff header_buffer+index_profile_version,WREG ; get byte at the profile version position | |
545 infsnz WREG,W ; was the byte = 0xFF (i.e. empty header) ? | |
546 return ; YES - leave it as it is (WREG now 0) | |
547 decf WREG,W ; NO - restore the profile version | |
548 andlw b'00111111' ; - keep only the external part | |
549 movff WREG,header_buffer+index_profile_version ; - write back the cleaned byte | |
550 return ; - done (WREG now ext. profile version) | |
582 | 551 |
0 | 552 |
553 ;----------------------------------------------------------------------------- | |
634 | 554 ; Send Dive Headers in short or full Format |
555 ; | |
556 comm_send_headers_short: | |
557 SERIAL_LC_SEND 0x6D ; acknowledge command | |
558 bcf aux_flag ; send short headers | |
559 bra comm_send_headers_common ; continue with common part | |
0 | 560 |
631 | 561 comm_send_headers_full: |
562 SERIAL_LC_SEND 0x61 ; acknowledge command | |
634 | 563 bsf aux_flag ; send full headers |
564 ;bra comm_send_headers_common ; continue with common part | |
631 | 565 |
634 | 566 comm_send_headers_common: |
567 clrf ex ; start with dive having index 0 | |
568 | |
569 comm_send_headers_loop: | |
570 movf ex,W ; get index into WREG | |
571 rcall comm_helper_read_header ; get header into header_buffer | |
572 | |
573 btfss aux_flag ; shall send full headers? | |
574 bra comm_send_headers_loop_short; NO - send short headers | |
575 ;bra comm_send_headers_loop_full ; YES - send full headers | |
631 | 576 |
634 | 577 comm_send_headers_loop_full: |
578 SERIAL_RR_SEND header_buffer,.256 ; send the full header | |
579 bra comm_send_headers_loop_com ; continue with common part | |
580 | |
581 comm_send_headers_loop_short: | |
582 ; send the fractions of the short header (16 byte/dive) | |
583 SERIAL_RR_SEND header_buffer+index_profile_byte_count,.13 | |
584 SERIAL_RR_SEND header_buffer+index_total_dives, .2 | |
585 SERIAL_CC_SEND header_buffer+index_profile_version ; .1 | |
586 ;bra comm_send_headers_loop_com ; continue with common part | |
587 | |
588 comm_send_headers_loop_com: | |
589 incfsz ex ; increment index, wrap-around. i.e. all dives done ? | |
590 bra comm_send_headers_loop ; NO - loop | |
591 bra comm_command_loop ; YES - done, back to command loop | |
631 | 592 |
593 | |
594 ;----------------------------------------------------------------------------- | |
634 | 595 ; Send one full Dive |
631 | 596 ; |
597 comm_send_dive: | |
598 SERIAL_LC_SEND 0x66 ; acknowledge command | |
599 | |
634 | 600 SERIAL_CC_RECEIVE WREG ; (try to) receive the dive index |
631 | 601 btfsc rs232_rx_timeout ; got dive index? |
634 | 602 bra comm_command_timeout ; NO - show rx timeout message and back to command loop |
631 | 603 |
634 | 604 rcall comm_helper_read_header ; read header into header_buffer |
605 bz comm_send_dive_exit ; abort if header contains no dive | |
631 | 606 |
634 | 607 ; get the start and end address of the profile data |
631 | 608 MOVTT header_buffer+index_profile_start_address,ext_flash_address |
609 MOVTT header_buffer+index_profile_end_address, ext_flash_end_pointer | |
634 | 610 |
611 ; header start code sequence present? | |
612 bcf aux_flag ; default to no profile available | |
631 | 613 |
634 | 614 FLASH_CW_READ_0x20 ; get the 1st byte of profile data |
615 xorlw 0xFA ; 1st byte = header start byte? | |
616 bnz comm_send_dive_modify_header; NO - no profile data available | |
617 | |
618 FLASH_CW_READ_0x20 ; get the 2nd byte of profile data | |
619 xorlw 0xFA ; 2nd byte = header start byte? | |
620 bnz comm_send_dive_modify_header; NO - no profile data available | |
621 | |
622 EXT_FLASH_INC_ADDRESS_0x20 .2 ; skip the 3rd and 4th byte (dive number) | |
631 | 623 |
634 | 624 FLASH_CW_READ_0x20 ; get the 5th byte of profile data |
625 xorlw 0xFA ; 5th byte = header start byte? | |
626 bnz comm_send_dive_modify_header; NO - no profile data available | |
627 | |
628 FLASH_CW_READ_0x20 ; get the 6th byte of profile data | |
629 xorlw 0xFA ; 6th byte = header start byte? | |
630 bnz comm_send_dive_modify_header; NO - no profile data available | |
631 | 631 |
634 | 632 bsf aux_flag ; memorize profile data available |
633 bra comm_send_dive_header ; continue with sending header | |
631 | 634 |
634 | 635 comm_send_dive_modify_header: |
636 ; set profile data start and end address to 0x000000 | |
637 CLRR header_buffer+index_profile_start_address,.6 | |
638 | |
639 ; set hi = 0x00, lo = 0x08 | |
640 MOVLI 0x0008,mpr | |
604 | 641 |
634 | 642 ; set byte count to 0x000008 |
643 movff lo,header_buffer+index_profile_byte_count+0 ; = 0x08 | |
644 movff hi,header_buffer+index_profile_byte_count+1 ; = 0x00 | |
645 movff hi,header_buffer+index_profile_byte_count+2 ; = 0x00 | |
646 | |
647 comm_send_dive_header: | |
648 SERIAL_RR_SEND header_buffer,.256 ; send the header from the buffer | |
649 | |
650 btfss aux_flag ; profile data available? | |
651 bra comm_send_dive_empty_profile; NO - send empty profile | |
652 | |
653 comm_send_dive_profile: | |
654 FLASH_CW_READ_0x20 ; read one byte and increment address with rollover at 0x200000 | |
655 SERIAL_CC_SEND WREG ; transmit the byte | |
656 | |
657 ; 24 bit compare of current address with end address | |
658 movf ext_flash_end_pointer+0,W ; check low byte of addresses | |
659 cpfseq ext_flash_address+0 ; current address = end address ? | |
660 bra comm_send_dive_profile ; NO - more bytes to do, loop | |
631 | 661 |
634 | 662 movf ext_flash_end_pointer+1,W ; check high byte of addresses |
663 cpfseq ext_flash_address+1 ; current address = end address ? | |
664 bra comm_send_dive_profile ; NO - more bytes to do, loop | |
665 | |
666 movf ext_flash_end_pointer+2,W ; check upper byte of addresses | |
667 cpfseq ext_flash_address+2 ; current address = end address ? | |
668 bra comm_send_dive_profile ; NO - more bytes to do, loop | |
669 | |
670 comm_send_dive_exit: | |
671 bra comm_command_loop ; done, back to command loop | |
672 | |
673 comm_send_dive_empty_profile: | |
674 | |
675 ; send profile length | |
676 SERIAL_RR_SEND header_buffer+index_profile_byte_count,.3 | |
677 | |
678 SERIAL_LC_SEND 0xFD ; send end-of-profile sequence, byte 1 | |
679 SERIAL_LC_SEND 0xFD ; send end-of-profile sequence, byte 2 | |
680 | |
681 bra comm_command_loop ; done, back to command loop | |
631 | 682 |
604 | 683 |
631 | 684 ;----------------------------------------------------------------------------- |
685 ; Reset all Options to Factory Default | |
686 ; | |
687 comm_option_reset_all: | |
688 SERIAL_LC_SEND 0x78 ; acknowledge command | |
689 call option_reset_all ; reset all options to factory default | |
690 bra comm_command_loop ; done, back to command loop | |
691 | |
692 | |
693 ;----------------------------------------------------------------------------- | |
634 | 694 ; Set Custom Text (opt_name_length ASCII chars) |
631 | 695 ; |
696 comm_set_custom_text: | |
634 | 697 CLRR opt_name,opt_name_length ; clear old custom text |
631 | 698 |
634 | 699 bcf INTCON,GIE ; disable all interrupts |
700 SERIAL_LC_SEND 0x63 ; acknowledge command | |
701 SERIAL_RR_RECEIVE opt_name,opt_name_length ; receive new custom text | |
702 bsf INTCON,GIE ; re-enable all interrupts | |
703 bsf option_changed ; flag that EEPROM needs to be updated | |
631 | 704 |
634 | 705 bra comm_command_loop ; done, back to command loop |
631 | 706 |
707 | |
708 ;----------------------------------------------------------------------------- | |
709 ; Reset Battery Gauge | |
710 ; | |
711 comm_reset_battery_gauge: | |
712 ; SERIAL_LC_SEND 0x23 ; acknowledge command (not done) | |
713 call reset_battery_gauge_and_lt2942 ; reset battery registers and battery gauge chip | |
714 bra comm_command_loop ; done, back to command loop | |
715 | |
604 | 716 |
631 | 717 ;----------------------------------------------------------------------------- |
718 ; Erase complete Logbook | |
719 ; | |
720 comm_erase_complete_logbook: | |
634 | 721 ; SERIAL_LC_SEND 0x22 ; acknowledge command (not done) |
722 call erase_complete_logbook ; erase complete logbook | |
723 bra comm_command_loop ; done, back to command loop | |
631 | 724 |
725 | |
726 ;----------------------------------------------------------------------------- | |
727 ; Start Bootloader (aka perform cold start) | |
728 ; | |
729 comm_cold_start: | |
730 ; SERIAL_LC_SEND 0xC1 ; acknowledge command (not done) | |
731 | |
634 | 732 WIN_SMALL comm_status3_column, comm_status3_row ; set position |
733 FONT_COLOR_MEMO ; set standard color | |
734 STRCPY_TEXT_PRINT tUsbLlBld ; print "Low-level Bootloader" message | |
631 | 735 |
736 WIN_TOP comm_warning_row ; set row for icon | |
737 WIN_LEFT comm_warning_column ; set column for icon | |
738 TFT_WRITE_PROM_IMAGE_BY_LABEL dive_warning2_block ; show a warning icon | |
739 | |
740 bsf LEDr ; switch on red LED | |
741 | |
742 call eeprom_deco_data_write ; update deco data in EEPROM | |
743 call eeprom_battery_gauge_write ; update battery gauge in EEPROM | |
634 | 744 btfsc option_changed ; do the options need to be stored to EEPROM ? |
631 | 745 call option_check_and_store_all ; YES - check and store all option values in EEPROM |
746 | |
634 | 747 ; WAITS .1 ; wait 1 second to give the serial I/F time |
748 ; ; to send the ackn before it gets shut down | |
749 | |
750 goto 0x1FF0C ; jump into the bootloader code for cold start | |
631 | 751 |
752 | |
753 ;----------------------------------------------------------------------------- | |
634 | 754 ; Send Firmware to Bootloader (aka initiate Firmware Update) |
631 | 755 ; |
756 comm_firmware_update: | |
634 | 757 bcf INTCON,GIE ; disable all interrupts |
631 | 758 SERIAL_LC_SEND 0x50 ; acknowledge command |
634 | 759 SERIAL_RR_RECEIVE buffer,.5 ; (try to) receive 5 byte checksum |
760 bsf INTCON,GIE ; re-enable all interrupts | |
631 | 761 |
762 btfsc rs232_rx_timeout ; got all 5 bytes? | |
763 bra comm_send_firmware_abort ; NO - abort | |
582 | 764 |
631 | 765 ; check the checksum |
766 movlw 0x55 ; initialize checksum check-byte | |
767 movwf hi ; store in hi | |
634 | 768 INIT_BUFFER ; go back to start of the buffer |
631 | 769 movlw .5 ; 5 bytes to process |
770 movwf lo ; initialize loop counter | |
771 comm_firmware_update_loop: | |
772 movf POSTINC2,W ; get a checksum byte | |
773 xorwf hi,F ; xor checksum byte with check-byte | |
774 rlncf hi,F ; rotate check-byte | |
775 decfsz lo,F ; decrement loop counter, done? | |
776 bra comm_firmware_update_loop ; NO - loop | |
777 tstfsz hi ; YES - check-byte zero? | |
778 bra comm_send_firmware_failed ; NO - checksum not valid | |
779 | |
780 ; checksum is valid | |
781 SERIAL_LC_SEND 0x4C ; inform checksum is ok | |
634 | 782 WAITS .1 ; wait 1 second to give the serial I/F time |
783 ; to send the 0x4C before it gets shut down | |
784 ;bra comm_firmware_update_exec ; execute update | |
631 | 785 |
634 | 786 global comm_firmware_update_exec |
787 comm_firmware_update_exec: | |
788 call eeprom_memorize_fw_checksum ; memorize fw checksum in EEPROM | |
631 | 789 call eeprom_deco_data_write ; update deco data in EEPROM |
790 call eeprom_battery_gauge_write ; update battery gauge in EEPROM | |
634 | 791 btfsc option_changed ; do the options need to be stored to EEPROM ? |
631 | 792 call option_check_and_store_all ; YES - check and store all option values in EEPROM |
634 | 793 goto 0x1FDF0 ; jump into the bootloader code for firmware update |
631 | 794 |
795 | |
796 comm_send_firmware_failed: | |
797 ; select font and output position | |
798 WIN_SMALL comm_string_column, comm_string_row | |
634 | 799 FONT_COLOR_WARNING ; set warning color |
631 | 800 STRCPY_PRINT "Checksum failed" ; print failure message (fill to 15 chars) |
801 ;bra comm_send_firmware_abort ; abort | |
802 | |
803 comm_send_firmware_abort: | |
634 | 804 SERIAL_LC_SEND 0xFF ; send checksum failure message |
805 bra comm_command_loop ; done, back to command loop | |
806 | |
807 | |
808 ;----------------------------------------------------------------------------- | |
809 ; Erase a single Block or a Range of Blocks | |
810 ; | |
811 comm_erase_single_4kb: | |
812 bcf INTCON,GIE ; disable all interrupts | |
813 bcf aux_flag ; do a single block only | |
814 ; SERIAL_LC_SEND 0x40 ; acknowledge command (not done) | |
815 bra comm_erase_get_start ; continue with getting start address | |
816 | |
817 comm_erase_range_4kb: | |
818 bcf INTCON,GIE ; disable all interrupts | |
819 bsf aux_flag ; do a range of blocks | |
820 SERIAL_LC_SEND 0x42 ; acknowledge command | |
821 ;bra comm_erase_get_start ; continue with getting start address | |
822 | |
823 comm_erase_get_start: | |
824 rcall comm_get_start_address ; (try to) get the start address | |
825 btfsc rs232_rx_timeout ; got start address? | |
826 bra comm_command_timeout ; NO - show rx timeout message and back to command loop | |
827 btfsc aux_flag ; YES - shall erase a range of blocks? | |
828 bra comm_erase_get_count ; YES - get the block count | |
829 movlw .1 ; NO - set 1 block to do | |
830 movwf WREG ; - ... | |
831 bra comm_erase_common ; - start the erasing | |
832 | |
833 comm_erase_get_count: | |
834 SERIAL_CC_RECEIVE WREG ; (try to) receive the block count | |
835 btfsc rs232_rx_timeout ; got block count? | |
836 bra comm_command_timeout ; NO - show rx timeout message and back to command loop | |
837 tstfsz WREG ; YES - block count = 0 ? | |
838 bra comm_erase_common ; NO - start the erasing | |
839 bra comm_command_error ; YES - invalid, show error message and back to command loop | |
840 | |
841 comm_erase_common: | |
842 bsf INTCON,GIE ; re-enable all interrupts | |
843 call ext_flash_erase_range ; erase #WREG 4kB blocks starting at ext_flash_address | |
631 | 844 bra comm_command_loop ; done, back to command loop |
845 | |
846 | |
847 ;----------------------------------------------------------------------------- | |
634 | 848 ; Write a Stream of Bytes to the FLASH beginning at given Start Address, finish on Timeout |
631 | 849 ; |
634 | 850 comm_write_range_stream: |
851 bcf INTCON,GIE ; disable all interrupts | |
852 SERIAL_LC_SEND 0x30 ; acknowledge command | |
631 | 853 |
634 | 854 rcall comm_get_start_address ; (try to) get the start address |
855 btfsc rs232_rx_timeout ; got a complete start address? | |
856 bra comm_command_timeout ; NO - show rx timeout message and back to command loop | |
857 | |
858 IFDEF _comm_debug | |
859 CLRI mpr ; clear mpr to be used as a 16 bit counter | |
860 ENDIF | |
631 | 861 |
634 | 862 comm_write_range_stream_loop: |
863 SERIAL_CC_RECEIVE WREG ; (try to) receive one byte | |
864 btfsc rs232_rx_timeout ; got a byte? | |
865 IFNDEF _comm_debug | |
866 bra comm_command_loop ; NO - timeout, done, back to command loop | |
867 ELSE | |
868 bra comm_command_debug ; NO - timeout, done, show number of bytes received | |
869 ENDIF | |
870 ; bsf NCTS ; YES - hold Bluetooth chip (requires PC/Android/iOS side to use flow control...) | |
871 call ext_flash_write_byte_0x40_nowait; - write byte to FLASH, increase address with rollover at 0x400000, does not wait on FLASH | |
872 ; bcf NCTS ; - release Bluetooth chip (requires PC/Android/iOS side to use flow control...) | |
873 IFDEF _comm_debug | |
874 INCI mpr ; increment counter | |
875 ENDIF | |
876 bra comm_write_range_stream_loop ; - loop | |
157
5ee76921e359
make new parameters configurable through pc
heinrichsweikamp
parents:
150
diff
changeset
|
877 |
631 | 878 |
879 ;----------------------------------------------------------------------------- | |
634 | 880 ; Write a Block of 256 Bytes to the FLASH beginning at given Start Address (low byte needs to be zero) |
631 | 881 ; |
634 | 882 comm_write_range_block: |
883 bcf INTCON,GIE ; disable all interrupts | |
884 SERIAL_LC_SEND 0x31 ; acknowledge command | |
885 | |
886 rcall comm_get_start_address ; (try to) get the start address | |
887 btfsc rs232_rx_timeout ; got a complete start address? | |
888 bra comm_command_timeout ; NO - show rx timeout message and back to command loop | |
631 | 889 |
634 | 890 tstfsz ext_flash_address+0 ; low byte of start address = 0 ? |
891 bra comm_command_error ; NO - show error message and back to command loop | |
892 | |
893 SERIAL_RR_RECEIVE buffer,.256 ; (try to) receive 256 byte and buffer them in memory | |
894 bsf INTCON,GIE ; re-enable all interrupts | |
895 btfsc rs232_rx_timeout ; got all 256 bytes? | |
896 bra comm_command_timeout ; NO - show rx timeout message and back to command loop | |
897 | |
898 FLASH_RR_WRITE buffer,.256 ; copy from memory to FLASH | |
899 bra comm_command_loop ; done, back to command loop | |
631 | 900 |
901 | |
902 ;----------------------------------------------------------------------------- | |
634 | 903 ; Read a Memory Range from FLASH given by Start Address and Byte Count |
631 | 904 ; |
905 comm_read_range: | |
634 | 906 bcf INTCON,GIE ; disable all interrupts |
631 | 907 SERIAL_LC_SEND 0x20 ; acknowledge command |
908 | |
909 ; receive start address | |
910 rcall comm_get_start_address ; (try to) get the start address | |
911 btfsc rs232_rx_timeout ; got a complete start address? | |
634 | 912 bra comm_command_timeout ; NO - show rx timeout message and back to command loop |
913 | |
914 ; receive byte count | |
915 rcall comm_get_length ; (try to) get the byte count | |
916 btfsc rs232_rx_timeout ; got a complete byte count? | |
917 bra comm_command_timeout ; NO - show rx timeout message and back to command loop | |
631 | 918 |
634 | 919 bsf INTCON,GIE ; re-enable all interrupts |
920 | |
921 ; decrement byte counter by 1 so that all bytes will be done when the counter wraps around to 0xFFFFFF | |
922 EXT_FLASH_DEC_LENGTH | |
923 | |
924 ; check validity of the byte count | |
925 movlw 0x40 ; now the byte count is allowed to be 0x3FFFFF at max | |
926 cpfslt ext_flash_length_counter+2 ; length count < 0x40(0000) ? | |
927 bra comm_command_error ; NO - show error message and back to command loop | |
631 | 928 |
929 ; stream bytes from FLASH | |
634 | 930 call ext_flash_read_block_start ; read first byte from FLASH into WREG |
931 bra comm_read_range_loop_start ; jump into transmit loop | |
631 | 932 comm_read_range_loop: |
933 call ext_flash_read_block_0x40 ; read next byte into WREG | |
934 comm_read_range_loop_start: | |
935 SERIAL_CC_SEND WREG ; transmit byte | |
634 | 936 EXT_FLASH_DEC_LENGTH ; decrement byte counter |
631 | 937 btfss ext_flash_length_counter+2,7; under-run? |
938 bra comm_read_range_loop ; NO - continue loop | |
939 call ext_flash_read_block_stop ; YES - end reading from FLASH | |
940 bra comm_command_loop ; - done, back to command loop | |
941 | |
942 | |
943 ;----------------------------------------------------------------------------- | |
944 ; Receive a 3 byte FLASH address (on serial: big-endian, in memory: little-endian) | |
945 ; | |
946 comm_get_start_address: | |
634 | 947 SERIAL_RR_RECEIVE ext_flash_address,.3 ; (try to) receive 3 bytes |
948 btfsc rs232_rx_timeout ; timeout? | |
949 return ; YES - abort, no usable address available | |
631 | 950 |
951 ; remap address from network byte format (big endian) to host format (little-endian) | |
952 movf ext_flash_address+0,W | |
953 movff ext_flash_address+2,ext_flash_address+0 | |
954 movwf ext_flash_address+2 | |
955 | |
634 | 956 return ; done, complete start address available |
631 | 957 |
958 | |
959 ;----------------------------------------------------------------------------- | |
960 ; Receive a 3 byte length (on serial: big-endian, in memory: little-endian) | |
961 ; | |
962 comm_get_length: | |
634 | 963 SERIAL_RR_RECEIVE ext_flash_length_counter,.3 ; receive 3 bytes |
964 btfsc rs232_rx_timeout ; timeout? | |
965 return ; YES - abort, no usable address available | |
631 | 966 |
967 ; remap address from network byte format (big endian) to host format (little-endian) | |
968 movf ext_flash_length_counter+0,W | |
969 movff ext_flash_length_counter+2,ext_flash_length_counter+0 | |
970 movwf ext_flash_length_counter+2 | |
971 | |
634 | 972 return ; done, complete start address available |
631 | 973 |
974 | |
975 ;----------------------------------------------------------------------------- | |
976 ; Read an Option Value | |
977 ; | |
978 comm_read_option: | |
979 SERIAL_LC_SEND 0x72 ; acknowledge command | |
980 SERIAL_CC_RECEIVE lo ; (try to) receive option index | |
981 btfsc rs232_rx_timeout ; received option index? | |
634 | 982 bra comm_command_loop ; NO - show rx timeout message and back to command loop |
651 | 983 |
631 | 984 ; option index 0x00 - 0x0F: unused |
985 movlw 0x0F ; last option index of the unused range | |
986 cpfsgt lo ; received option index > end of unused range ? | |
634 | 987 bra comm_command_error ; NO - show error message and back to command loop |
631 | 988 |
989 ; option index 0x10 - 0x19: gases & diluents | |
990 movlw 0x19 ; last option index for gases / diluents | |
991 cpfsgt lo ; received option index > end of gas/dil range ? | |
992 bra comm_read_gas_dil ; NO - process gas/dil read | |
993 | |
994 ; option index 0x1A - 0x1E: setpoints | |
995 movlw 0x1E ; last option index for setpoint | |
996 cpfsgt lo ; received option index > end of setpoint range ? | |
997 bra comm_read_sp ; NO - process setpoint read | |
998 | |
999 ; option index = 0x49 - special handling button polarity | |
651 | 1000 movlw 0x49 |
1001 cpfseq lo ; received option index for button polarity ? | |
1002 bra $+4 ; NO | |
1003 bra comm_read_button_polarity ; YES - process button polarity read | |
631 | 1004 |
634 | 1005 ; option index 0x1F - 0xF9: options managed by option table |
1006 movlw 0xF9 ; last option index for options | |
1007 cpfsgt lo ; received option index > end of options range? | |
1008 bra comm_read_option_index ; YES - process option value read via index | |
631 | 1009 |
634 | 1010 bra comm_command_error ; NO - illegal option index |
631 | 1011 |
1012 | |
1013 ;----------------------------------------------------------------------------- | |
1014 ; Write an Option Value | |
1015 ; | |
1016 comm_write_option: | |
634 | 1017 bcf INTCON,GIE ; disable all interrupts |
631 | 1018 SERIAL_LC_SEND 0x77 ; acknowledge command |
1019 SERIAL_CC_RECEIVE lo ; (try to) receive option index | |
1020 btfsc rs232_rx_timeout ; got a byte? | |
634 | 1021 bra comm_command_timeout ; NO - show rx timeout message and back to command loop |
631 | 1022 |
1023 ; option index 0x00 - 0x0F: unused | |
1024 movlw 0x0F ; last option index of the unused range | |
1025 cpfsgt lo ; received option index > end of unused range ? | |
1026 bra comm_write_unused ; NO - but need to consume the option value | |
1027 | |
1028 ; option index 0x10 - 0x19: gases & diluents | |
1029 movlw 0x19 ; last option index for gases / diluents | |
1030 cpfsgt lo ; received option index > end of gas/dil range ? | |
1031 bra comm_write_gas_dil ; NO - process gas/dil write | |
1032 | |
1033 ; option index 0x1A - 0x1E: setpoints | |
1034 movlw 0x1E ; last option index for setpoint | |
1035 cpfsgt lo ; received option index > end of setpoint range ? | |
1036 bra comm_write_sp ; NO - process setpoint write | |
1037 | |
1038 ; option index = 0x49 - special handling button polarity | |
651 | 1039 movlw 0x49 |
1040 cpfseq lo ; received option index for button polarity ? | |
1041 bra $+4 ; NO | |
1042 bra comm_write_button_polarity ; YES - process button polarity write | |
631 | 1043 |
634 | 1044 ; option index 0x1F - 0xF9: options managed by option table |
1045 movlw 0xF9 ; last option index for options | |
1046 cpfsgt lo ; received option index > end of options range? | |
1047 bra comm_write_option_index ; YES - process option value write via index | |
1048 | |
1049 bra comm_write_unused ; NO - illegal option index | |
1050 | |
1051 | |
1052 ;----------------------------------------------------------------------------- | |
1053 ; Read an Option Value via its Serial Index | |
1054 ; | |
1055 comm_read_option_index: | |
1056 call option_read_serial ; try to find the option and read its value | |
1057 tstfsz WREG ; option found? | |
1058 bra comm_read_setting_fail ; NO - send dummy value | |
1059 SERIAL_CC_SEND hi ; YES - send read value | |
1060 bra comm_command_loop ; - done, back to command loop | |
1061 | |
1062 comm_read_setting_fail: | |
1063 SERIAL_LC_SEND 0x00 ; send a dummy value | |
1064 bra comm_command_error ; back to command loop with failure message | |
1065 | |
1066 | |
1067 ;----------------------------------------------------------------------------- | |
1068 ; Write an Option Value via its Serial Index | |
1069 ; | |
1070 comm_write_option_index: | |
631 | 1071 SERIAL_CC_RECEIVE hi ; (try to) receive option value |
1072 btfsc rs232_rx_timeout ; got a byte? | |
1073 bra comm_command_timeout ; NO - abort | |
1074 call option_write_serial ; YES - try to find the option and write new value | |
1075 tstfsz WREG ; - option found and new value valid ? | |
1076 bra comm_command_error ; NO - back to command loop with failure message | |
1077 bra comm_command_loop ; YES - done, back to command loop | |
1078 | |
1079 comm_write_unused: | |
1080 SERIAL_CC_RECEIVE WREG ; consume unused option value | |
1081 bra comm_command_error ; done, back to command loop | |
1082 | |
1083 | |
1084 ;----------------------------------------------------------------------------- | |
634 | 1085 ; Read Button Polarity |
631 | 1086 ; |
1087 comm_read_button_polarity: | |
1088 SERIAL_CC_SEND button_polarity ; send current button polarity setting | |
1089 bra comm_command_loop ; done, back to command loop | |
1090 | |
1091 | |
1092 ;----------------------------------------------------------------------------- | |
634 | 1093 ; Write Button Polarity |
631 | 1094 ; |
1095 comm_write_button_polarity: | |
1096 SERIAL_CC_RECEIVE hi ; (try to) receive configuration value | |
1097 btfsc rs232_rx_timeout ; got configuration value? | |
634 | 1098 bra comm_command_timeout ; NO - show rx timeout message and back to command loop |
631 | 1099 movff hi,button_polarity ; YES - store button polarity in memory and EEPROM |
1100 EEPROM_CC_WRITE button_polarity,eeprom_button_polarity | |
1101 bra comm_command_loop ; - done, back to command loop | |
1102 | |
1103 | |
1104 ;----------------------------------------------------------------------------- | |
634 | 1105 ; Read a Gas/Diluent Dataset |
631 | 1106 ; |
634 | 1107 ; memory map is as follows: |
604 | 1108 ; ------------------------- |
1109 ; opt_gas_O2_ratio res 5 ; O2 ratios of OC/bailout gases | |
1110 ; opt_dil_O2_ratio res 5 ; O2 ratios of diluents | |
1111 ; opt_gas_He_ratio res 5 ; He ratios of OC/bailout gases | |
1112 ; opt_dil_He_ratio res 5 ; He ratios of diluents | |
1113 ; opt_gas_type res 5 ; OC/bailout gas type | |
1114 ; opt_dil_type res 5 ; dil type | |
1115 ; opt_gas_change res 5 ; change depths for OC/Bailout gases | |
1116 ; opt_dil_change res 5 ; change depths for diluents | |
631 | 1117 ; |
604 | 1118 comm_read_gas_dil: |
1119 lfsr FSR0,opt_gas_O2_ratio ; load base address of gas data arrays | |
631 | 1120 movlw 0x10 ; compute gas index from option index... |
1121 subwf lo,W ; ...making WREG point to O2 ratio | |
1122 SERIAL_CC_SEND PLUSW0 ; send O2 ratio | |
1123 addlw .10 ; increment WREG by 10 to point to He ratio | |
1124 SERIAL_CC_SEND PLUSW0 ; send He ratio | |
1125 addlw .10 ; increment WREG by 10 to point to gas/diluent type | |
1126 SERIAL_CC_SEND PLUSW0 ; send gas/diluent type | |
1127 addlw .10 ; increment WREG by 10 to point to change depth | |
1128 SERIAL_CC_SEND PLUSW0 ; send change depth | |
1129 bra comm_command_loop ; done, back to command loop | |
110 | 1130 |
79
0fc8113ddf6d
new command in download mode: "r" - read setting
mh@mh-THINK.localdomain
parents:
69
diff
changeset
|
1131 |
631 | 1132 ; ---------------------------------------------------------------------------- |
634 | 1133 ; Write a Gas/Diluent Dataset |
631 | 1134 ; |
634 | 1135 ; memory map is as follows: |
604 | 1136 ; ------------------------- |
1137 ; opt_gas_O2_ratio res 5 ; O2 ratios of OC/bailout gases | |
1138 ; opt_dil_O2_ratio res 5 ; O2 ratios of diluents | |
1139 ; opt_gas_He_ratio res 5 ; He ratios of OC/bailout gases | |
1140 ; opt_dil_He_ratio res 5 ; He ratios of diluents | |
1141 ; opt_gas_type res 5 ; OC/bailout gas type | |
1142 ; opt_dil_type res 5 ; dil type | |
1143 ; opt_gas_change res 5 ; change depths for OC/Bailout gases | |
1144 ; opt_dil_change res 5 ; change depths for diluents | |
631 | 1145 ; |
1146 comm_write_gas_dil: | |
634 | 1147 SERIAL_RR_RECEIVE hi,.4 ; (try to) receive 4 option values |
631 | 1148 btfsc rs232_rx_timeout ; got all 4 bytes? |
634 | 1149 bra comm_command_timeout ; NO - show rx timeout message and back to command loop |
80 | 1150 |
631 | 1151 ; check validity of O2 value |
1152 movlw gaslist_min_o2-.1 ; get min value minus 1 | |
1153 cpfsgt hi ; received O2% >= min ? | |
634 | 1154 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1155 movlw gaslist_max_o2+.1 ; get max value plus 1 |
1156 cpfslt hi ; received O2% <= max ? | |
634 | 1157 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1158 |
1159 ; check validity of He value | |
1160 movlw gaslist_max_He+.1 ; get max value plus 1 | |
1161 cpfslt up ; received O2% <= max ? | |
634 | 1162 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1163 |
634 | 1164 IFDEF _helium |
631 | 1165 ; check O2% + He% <= 100% |
634 | 1166 movlw .100 ; load WREG with 100% |
631 | 1167 bsf STATUS,C ; set carry = clear borrow |
634 | 1168 subfwb hi,W ; subtract O2% from WREG |
1169 subfwb up,W ; subtract He% from WREG | |
631 | 1170 btfss STATUS,C ; result negative? |
634 | 1171 bra comm_command_error ; YES - show error message and back to command loop |
1172 ENDIF ; _helium | |
631 | 1173 |
1174 ; check validity of type | |
1175 movlw 0x14 ; last option index for gases | |
1176 cpfsgt lo ; received option index > end of gas range ? | |
636 | 1177 bra comm_write_check_gas ; NO - check type for gases |
1178 ;bra comm_write_check_dil ; YES - check type for diluents | |
1179 | |
1180 comm_write_check_dil: | |
1181 ; check validity of type for a diluent | |
1182 movlw num_dil_types ; load number of diluent types | |
1183 bra comm_write_check_com ; continue with common part | |
631 | 1184 |
634 | 1185 comm_write_check_gas: |
631 | 1186 ; check validity of type for a gas |
1187 movlw num_gas_types ; load number of gas types | |
634 | 1188 ;bra comm_write_check_com ; continue with common part |
631 | 1189 |
634 | 1190 comm_write_check_com: |
631 | 1191 cpfslt ex ; received type < max ? |
634 | 1192 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1193 |
1194 ; check validity of change depth | |
1195 movlw gaslist_max_change_depth+.1 ; get max value plus 1 | |
1196 cpfslt ul ; received change depth <= max ? | |
634 | 1197 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1198 |
1199 ; all values ok, can finally be written | |
604 | 1200 lfsr FSR0,opt_gas_O2_ratio ; load base address of gas data arrays |
631 | 1201 movlw 0x10 ; compute gas index from option index... |
1202 subwf lo,W ; ...making WREG point to O2 ratio | |
634 | 1203 |
631 | 1204 movff hi,PLUSW0 ; set O2 ratio |
1205 addlw .10 ; increment WREG by 10 to point to He ratio | |
1206 movff up,PLUSW0 ; set He ratio | |
1207 addlw .10 ; increment WREG by 10 to point to gas/dil type | |
1208 movff ex,PLUSW0 ; set gas/dil type | |
1209 addlw .10 ; increment WREG by 10 to point to change depth | |
1210 movff ul,PLUSW0 ; set change depth | |
1211 | |
634 | 1212 bsf option_changed ; flag that EEPROM needs to be updated |
631 | 1213 bra comm_command_loop ; done, back to command loop |
80 | 1214 |
604 | 1215 |
631 | 1216 ;----------------------------------------------------------------------------- |
634 | 1217 ; Read a Setpoint Dataset |
631 | 1218 ; |
634 | 1219 ; memory map is as follows: |
604 | 1220 ; ------------------------- |
623 | 1221 ; opt_setpoint_cbar res 5 ; setpoints in cbar |
1222 ; opt_setpoint_change res 5 ; change depth for the setpoints in meter | |
631 | 1223 ; |
1224 comm_read_sp: | |
623 | 1225 lfsr FSR0,opt_setpoint_cbar ; load base address of setpoint cbar values |
631 | 1226 movlw 0x1A ; compute SP index from option index... |
1227 subwf lo,W ; ...making WREG point to cbar value | |
1228 SERIAL_CC_SEND PLUSW0 ; send setpoint cbar value | |
1229 addlw .5 ; increment WREG by 5 to point to change depth | |
1230 SERIAL_CC_SEND PLUSW0 ; send change depth | |
1231 bra comm_command_loop ; done, back to command loop | |
1232 | |
1233 | |
1234 ;----------------------------------------------------------------------------- | |
634 | 1235 ; Write a Setpoint Dataset |
631 | 1236 ; |
634 | 1237 ; memory map is as follows: |
631 | 1238 ; ------------------------- |
1239 ; opt_setpoint_cbar res 5 ; setpoints in cbar | |
1240 ; opt_setpoint_change res 5 ; change depths in meter | |
1241 ; | |
1242 comm_write_sp: | |
634 | 1243 SERIAL_RR_RECEIVE hi,.2 ; (try to) receive 2 option values |
631 | 1244 btfsc rs232_rx_timeout ; got both bytes? |
634 | 1245 bra comm_command_timeout ; NO - show rx timeout message and back to command loop |
631 | 1246 |
1247 ; check validity of setpoint value | |
1248 movlw gaslist_sp_min-.1 ; get min value minus 1 | |
1249 cpfsgt hi ; received O2% >= min ? | |
634 | 1250 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1251 movlw gaslist_sp_max+.1 ; get max value plus 1 |
1252 cpfslt hi ; received O2% <= max ? | |
634 | 1253 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1254 |
1255 ; check validity of change depth | |
634 | 1256 movlw gaslist_sp_max_depth+.1 ; get max value plus 1 |
631 | 1257 cpfslt up ; received change depth <= max ? |
634 | 1258 bra comm_command_error ; NO - show error message and back to command loop |
631 | 1259 |
1260 lfsr FSR0,opt_setpoint_cbar ; load base address of setpoint cbar values | |
1261 movlw 0x1A ; compute SP index from option index... | |
1262 subwf lo,W ; ...making WREG point to cbar value | |
634 | 1263 |
1264 bnz comm_write_sp_exec ; selected SP is 2...5 -> execute write | |
1265 tstfsz up ; SP1: change depth = 0 ? | |
1266 bra comm_command_error ; NO - show error message and back to command loop | |
1267 | |
1268 comm_write_sp_exec: | |
631 | 1269 movff hi,PLUSW0 ; set cbar value |
1270 addlw .5 ; increment WREG by 5 to point to change depth | |
1271 movff up,PLUSW0 ; set change depth | |
1272 | |
634 | 1273 bsf option_changed ; flag that EEPROM needs to be updated |
631 | 1274 bra comm_command_loop ; done, back to command loop |
80 | 1275 |
79
0fc8113ddf6d
new command in download mode: "r" - read setting
mh@mh-THINK.localdomain
parents:
69
diff
changeset
|
1276 ;----------------------------------------------------------------------------- |
0fc8113ddf6d
new command in download mode: "r" - read setting
mh@mh-THINK.localdomain
parents:
69
diff
changeset
|
1277 |
582 | 1278 END |