[atari] Fix return code for clock_get_time/tz

Author: markjfisher

atari/src/bus/fn_error.s

@@ -17,7 +17,10 @@
 ; and returns 0/false (by design FN_ERR_OK), or 1/true (by design FN_ERR_IO_ERROR)
 ; which are inverted but correct. Most functions return the success status (0 = false = error), but we flip that into FN_ERR_OK/FN_ERR_IO_ERROR
 
+; THIS RETURNS FN_ERR_* VALUES, NOT BOOLEANS (although it only returns FN_ERR_OK and FN_ERR_IO_ERROR at the moment)
 .proc _fn_error
         sta     _fn_device_error
+        ; this is utilising the common code in fuji_error, which returns booleans which match our FN_ERR_OK or FN_ERR_IO_ERROR codes
+        ; because fuji_error returns the "is error" boolean, true meaning there was an error, and its value is 1
         jmp     fuji_error_cmp
 .endproc

atari/src/fn_clock/clock_get_time.s

@@ -86,6 +86,7 @@ aux1_val = *-1
         stx     IO_DCB::daux1
 
         jsr     _bus
+        lda     IO_DCB::dstats
         jmp     _fn_error
 
 .rodata

testing/unit/atari/fn_clock/clock_get_time/test_clock_get_time.s

@@ -13,12 +13,17 @@
 .export t5_end
 .export t6
 .export t6_end
+.export t7
+.export t7_end
 .export output_buffer
+.export dstats_called_with
+.export return_err
 
 .export _bus
 .export _clock_set_alternate_tz
-.export _fn_error
+.export _fn_device_error
 
+.import _fn_error
 .import _clock_get_time
 
 .import pushax
@@ -30,6 +35,7 @@
 .code
 _main:
 
+        mva     #$01, return_err
         mwa     #clock0, clock_ptr
         pushax  #output_buffer
         lda     #0
@@ -77,6 +83,15 @@ t6:
         jsr     _clock_get_time
 t6_end:
 
+        ; emulate a bus error
+        mva     #$80, return_err
+        lda     #$00
+t7:
+        jsr     _clock_get_time
+t7_end:
+
+
+
         rts
 
 ; mocks
@@ -85,6 +100,7 @@ _bus:
         ; clock_ptr points to the correct return data
         mwa     clock_ptr, ptr1
         mwa     IO_DCB::dbuflo, ptr2
+        mva     IO_DCB::dstats, dstats_called_with
 
         ldy     #$00                  ; size to copy, e.g. 6
 :       mva     {(ptr1), y}, {(ptr2), y}
@@ -95,18 +111,24 @@ _bus:
         ; add a zero to finish the buffer off
         lda     #$00
         sta     (ptr2), y
-        rts
 
-_fn_error:
+        ; return the custom error via dstats
+        mva     return_err, IO_DCB::dstats
         rts
 
 _clock_set_alternate_tz:
         rts
 
 .bss
 
-clock_ptr:      .res 2
-output_buffer:  .res 31
+clock_ptr:              .res 2
+output_buffer:          .res 31
+_fn_device_error:       .res 1
+dstats_called_with:     .res 1
+
+.data
+; return value for fn_error
+return_err:     .byte 0
 
 .rodata
 clock0:         .byte $00, $01, $02, $03, $04, $05, $06

testing/unit/atari/fn_clock/clock_get_time/test_clock_get_time.txt

@@ -9,47 +9,57 @@ run $_main while CP != $t0
 registers set cycle_count = 0
 run while CP != $t0_end
 assert $output_buffer ~ 0x(00,01,02,03,04,05,06,00) $$t0: T format has 7 bytes$$
-assert #0x0300 ~ 0x(45,01,54,40)                    $$t0: IO_DCB matches first 4 bytes$$
+assert #0x0300 ~ 0x(45,01,54)                       $$t0: IO_DCB matches first 3 bytes$$
+assert $dstats_called_with = 0x40                   $$t0: IO_DCB::dstats set to 0x40$$
 assert #0x0306 ~ 0x(02,00,07,00,00,00)              $$t0: IO_DCB matches last 6 bytes$$
 
 run while CP != $t1
 registers set cycle_count = 0
 run while CP != $t1_end
 assert $output_buffer ~ 0x(10,11,12,13,00)          $$t1: Prodos format has 4 bytes$$
-assert #0x0300 ~ 0x(45,01,50,40)                    $$t1: IO_DCB matches first 4 bytes$$
+assert #0x0300 ~ 0x(45,01,50)                       $$t1: IO_DCB matches first 3 bytes$$
+assert $dstats_called_with = 0x40                   $$t1: IO_DCB::dstats set to 0x40$$
 assert #0x0306 ~ 0x(02,00,04,00,00,00)              $$t1: IO_DCB matches last 6 bytes$$
 
 // this will be deprecated
 run while CP != $t2
 registers set cycle_count = 0
 run while CP != $t2_end
 assert $output_buffer ~ 0x(20,21,22,23,24,25,00)    $$t2: Apetime TZ 0x93$$
-assert #0x0300 ~ 0x(45,01,93,40)                    $$t2: IO_DCB matches first 4 bytes$$
+assert #0x0300 ~ 0x(45,01,93)                       $$t2: IO_DCB matches first 3 bytes$$
+assert $dstats_called_with = 0x40                   $$t2: IO_DCB::dstats set to 0x40$$
 assert #0x0306 ~ 0x(02,00,06,00,00,00)              $$t2: IO_DCB matches last 6 bytes$$
 
 run while CP != $t3
 registers set cycle_count = 0
 run while CP != $t3_end
 assert $output_buffer ~ "YYYY-MM-DDTHH:MM:SS+HHMM\0"$$t3: ISO TZ 'I' (0x49)$$
-assert #0x0300 ~ 0x(45,01,49,40)                    $$t3: IO_DCB matches first 4 bytes$$
+assert #0x0300 ~ 0x(45,01,49)                       $$t3: IO_DCB matches first 3 bytes$$
+assert $dstats_called_with = 0x40                   $$t3: IO_DCB::dstats set to 0x40$$
 assert #0x0306 ~ 0x(02,00,19,00,00,00)              $$t3: IO_DCB matches last 6 bytes$$
 
 run while CP != $t4
 registers set cycle_count = 0
 run while CP != $t4_end
 assert $output_buffer ~ "2025-06-11T20:19:00+0100\0"$$t4: ISO ZULU 'Z' (0x5A)$$
-assert #0x0300 ~ 0x(45,01,5A,40)                    $$t4: IO_DCB matches first 4 bytes$$
+assert #0x0300 ~ 0x(45,01,5A)                       $$t4: IO_DCB matches first 3 bytes$$
+assert $dstats_called_with = 0x40                   $$t4: IO_DCB::dstats set to 0x40$$
 assert #0x0306 ~ 0x(02,00,19,00,00,00)              $$t4: IO_DCB matches last 6 bytes$$
 
 run while CP != $t5
 registers set cycle_count = 0
 run while CP != $t5_end
 assert $output_buffer ~ "YYYYMMDD0HHMMSS000\0"      $$t5: APPLE 3 SOS 'S' (0x53)$$
-assert #0x0300 ~ 0x(45,01,53,40)                    $$t5: IO_DCB matches first 4 bytes$$
+assert #0x0300 ~ 0x(45,01,53)                       $$t5: IO_DCB matches first 3 bytes$$
+assert $dstats_called_with = 0x40                   $$t5: IO_DCB::dstats set to 0x40$$
 assert #0x0306 ~ 0x(02,00,13,00,00,00)              $$t5: IO_DCB matches last 6 bytes$$
 
 run while CP != $t6
 registers set cycle_count = 0
 run while CP != $t6_end
 assert A = 2                                        $$t6: invalid format returns FN_ERR_BAD_CMD$$
 
+run while CP != $t7
+registers set cycle_count = 0
+run while CP != $t7_end
+assert A = 1                                        $$t7: bus error returns FN_ERR_IO_ERROR (1)$$

testing/unit/atari/fn_clock/clock_get_time/test_clock_get_time.yaml

@@ -4,6 +4,8 @@ configs:
   - ${UNIT_TEST_DIR}/base_configs/base_test_atari.yaml
 
 src_files:
+  - ${WS_ROOT}/atari/src/fn_fuji/fuji_error.s
+  - ${WS_ROOT}/atari/src/bus/fn_error.s
   - ${WS_ROOT}/atari/src/fn_clock/clock_get_time.s
   - test_clock_get_time.s