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