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