Add timezone functionality for fn_clock: apple2, atari

Author: markjfisher

apple2/apple2-6502/fn_clock/clock_get_time.s

@@ -1,24 +1,68 @@
         .export         _clock_get_time
+        .export         _clock_get_time_tz
 
         .import         _sp_count
         .import         _sp_get_clock_id
         .import         _sp_payload
         .import         _sp_status
 
+        .import         _clock_set_alternate_tz
+
         .import         incsp2
+        .import         incsp4
         .import         popax
         .import         pusha
         .import         return0
         .import         return1
 
         .include        "macros.inc"
+        .include        "fujinet-network.inc"           ; for FN_ERR_* codes
         .include        "zp.inc"
 
-; uint8_t clock_get_time(uint8_t* time_data, TimeFormat format);
+; for apple2 we support 6 
+TIMEFORMAT_COUNT                := $06
+
+
+; uint8_t clock_get_time_tz(uint8_t* time_data, const char* tz, TimeFormat format);
+_clock_get_time_tz:
+        ldx     #$20                    ; convert to lower case
+        stx     lower_mask
+
+        sta     time_format
+        cmp     #TIMEFORMAT_COUNT      ; was the format value in range?
+        bcc     valid_format
+
+        jsr     incsp4
+bad_cmd:
+        ldx     #$00
+        lda     #FN_ERR_BAD_CMD
+        rts
+
+valid_format:
+        ; first read tz from string given, and set it as the alternate TZ in fujinet.
+        jsr     popax
+        jsr     _clock_set_alternate_tz
 
+        beq     common_tz
+        ; an error, but we still have an arg on software stack
+        jsr     incsp2
+        jmp     return1         ; FN_ERR_IO_ERROR
+
+
+; uint8_t clock_get_time(uint8_t* time_data, TimeFormat format);
 _clock_get_time:
-        sta     time_format             ; format, save it where we need it! saves a BSS byte
+        ldx     #$00            ; don't alter the byte, keep upper case
+        stx     lower_mask
 
+        sta     time_format
+        cmp     #TIMEFORMAT_COUNT       ; was the format value in range?
+        bcc     common_tz
+
+        ; exit after removing params from stack
+        jsr     incsp2
+        jmp     bad_cmd
+
+common_tz:
         ; get the device id of the clock, this is stored in _sp_clock_id, but also returned so we can check if it failed (0 is error)
         jsr     _sp_get_clock_id
         bne     got_id
@@ -31,23 +75,23 @@ error:
 
 got_id:
         ; call sp_status(uint8_t dest, uint8_t statcode)
-        sta     tmp1                    ; save the clock device id
 
         ; convert the time format to the appropriate device specific code.
         ; SIMPLE_BINARY     (0) -> 'T'
         ; PRODOS_BINARY     (1) -> 'P'
-        ; APETIME_TZ_BINARY (2) -> 'A'
-        ; APETIME_BINARY    (3) -> 'B'
-        ; TZ_ISO_STRING     (4) -> 'S'
+        ; APETIME_TZ_BINARY (2) -> 0x99
+        ; APETIME_BINARY    (3) -> 0x93
+        ; TZ_ISO_STRING     (4) -> 'I'
         ; UTC_ISO_STRING    (5) -> 'Z'
+        ; APPLE3 SOS format (6) -> 'S'
 
+        jsr     pusha                   ; A = destination device (clock id)
         ldx     #$00
 time_format     = *-1
-        ; ensure the value is valid
-        cpx     #$06
-        bcs     error
-        jsr     pusha
         lda     code_table, x
+        ; convert to lower case if needed (set bit 0x20), caller sets the next byte to use
+        ora     #$00
+lower_mask = *-1
 
         jsr     _sp_status
         bne     error
@@ -62,9 +106,8 @@ time_format     = *-1
         cpy     _sp_count
         bne     :-
 
-        jmp     return0
+        jmp     return0         ; FN_ERR_OK
 
 .data
 code_table:
-        .byte 'T', 'P', 'A', 'B', 'S', 'Z'
-
+        .byte 'T', 'P', 'A', 'I', 'Z', 'S'

apple2/apple2-6502/fn_clock/clock_set_tz.s

@@ -1,4 +1,5 @@
         .export         _clock_set_tz
+        .export         _clock_set_alternate_tz
 
         .import         _fn_error
         .import         _memcpy
@@ -15,15 +16,29 @@
         .include        "macros.inc"
         .include        "zp.inc"
 
+
+; uint8_t clock_set_alternate_tz(char *tz);
+; same as clock_set_tz, but sends 't' ctrl code
+_clock_set_alternate_tz:
+        ldy     #'t'
+        sty     ctrl_code
+        bne     _clock_set_tz_common    ; always
+
 ; uint8_t clock_set_tz(char *tz);
-_clock_set_tz:        
+; sends 'T' ctrl code
+_clock_set_tz:
+        ldy     #'T'
+        sty     ctrl_code
+        ; fall through
+
+_clock_set_tz_common:
         axinto  tmp_tz_ptr              ; save the tz
 
         ; get the device id of the clock, this is stored in _sp_clock_id, but also returned so we can check if it failed (0 is error)
         jsr     _sp_get_clock_id
         bne     got_id
 
-        ; no clock found, return 1 as an error (FN_ERR_IO_ERROR)
+        ; no clock found, return 1 as an error
         jmp     return1
 
 got_id:
@@ -47,7 +62,9 @@ got_id:
         jsr     _memcpy
 
         ; src/dst were both stored on s/w stack already
-        lda     #'T'                    ; set 'T'imezone
+        ; This is written to by the appropriate function, either 'T' for system TZ or 't' for alternate TZ
+        lda     #$00
+ctrl_code = *-1
         jsr     _sp_control
 
         ; convert to fujinet ok/error code

atari/src/fn_clock/clock_get_time.s

@@ -2,52 +2,65 @@
         .export         _clock_get_time_tz
 
         .import         _bus
-        .import         _fuji_success
+        .import         _fn_error
         .import         _clock_set_alternate_tz
 
         .import         incsp2
+        .import         incsp4
         .import         popax
         .import         return0
+        .import         return1
 
+        .include        "clock.inc"
         .include        "device.inc"
-        .include        "fujinet-clock.inc"
+        .include        "fujinet-network.inc"           ; for the FN_ERR codes
         .include        "macros.inc"
         .include        "zp.inc"
 
 
-; either 2 or 4 bytes to increase sp4 by
-exit_bad_tz4:
-        jsr     incsp2
-
-exit_bad_tz2:
-        jsr     incsp2
-        jmp     return0
-
-
 ; uint8_t clock_get_time_tz(uint8_t* time_data, const char* tz, TimeFormat format);
 _clock_get_time_tz:
-        cmp     #$06                    ; was the format value in range?
-        bcs     exit_bad_tz4            ; too large, exit and remove 2 pointers (4 bytes) from stack
+        sta     time_format
+        cmp     #TIMEFORMAT_COUNT      ; was the format value in range?
+        bcc     valid_format
 
-        ; save it while we deal with the TZ string
-        sta     tmp_format
+        jsr     incsp4
+bad_cmd:
+        ldx     #$00
+        lda     #FN_ERR_BAD_CMD
+        rts
+
+valid_format:
         ; first read tz from string given, and set it as the alternate TZ in fujinet.
+        ; use alternate FN timezone when calling FN
+        mva     #$01, aux1_val
         jsr     popax
         jsr     _clock_set_alternate_tz
+        beq     alternate_ok            ; returns success status
 
         ; an error, but we still have an arg on software stack
-        bne     exit_bad_tz2
+        jsr     incsp2
+        jmp     return1         ; FN_ERR_IO_ERROR
 
-        ldy     tmp_format
-        bpl     common_tz               ; it's between 0 and 6 validated, so this will always branch
+alternate_ok:
+        ldy     #$00
+time_format = *-1
+        bpl     common_tz               ; always
 
 ; uint8_t clock_get_time(uint8_t* time_data, TimeFormat format);
 _clock_get_time:
         tay                             ; time format enum
-        cpy     #$06                    ; was the format value in range?
-        bcs     exit_bad_tz2
+        ; use system FN timezone when calling FN
+        mva     #$00, aux1_val
+        cpy     #TIMEFORMAT_COUNT       ; was the format value in range?
+        bcc     common_tz
+
+        ; exit after removing params from stack
+        jsr     incsp2
+        jmp     bad_cmd
 
 common_tz:
+
         lda     t_clock_get_time_cmd, y
         sta     IO_DCB::dcomnd
         lda     t_clock_get_time_len, y
@@ -60,25 +73,27 @@ common_tz:
         mva     #$40, IO_DCB::dstats
         ldx     #$00
         stx     IO_DCB::dunuse
-        stx     IO_DCB::daux1
         stx     IO_DCB::daux2
         stx     IO_DCB::dbythi
         inx                            ; x = 1
         stx     IO_DCB::dunit
         inx                            ; x = 2 - as this is a FN non network call, we can keep this low
         stx     IO_DCB::dtimlo
-        jsr     _bus
-        jmp     _fuji_success
 
-.bss
-tmp_format:     .res 1
+        ; need to set daux1 to 1 if this is an alternate tz call
+        ldx     #$00
+aux1_val = *-1
+        stx     IO_DCB::daux1
+
+        jsr     _bus
+        jmp     _fn_error
 
 .rodata
 
 ; tables for the commands that have to be sent for the different types of time command
 ; see fuji_clock.h
 t_clock_get_time_cmd:
-        .byte 'T', 'P', SIO_APETIMECMD_GETTZTIME, SIO_APETIMECMD_GETTIME, 'S', 'Z'
+        .byte 'T', 'P', SIO_APETIMECMD_GETTIME, 'I', 'Z', 'S'
 
 t_clock_get_time_len:
-        .byte 7, 4, 6, 6, 25, 25
+        .byte 7, 4, 6, 25, 25, 19

atari/src/fn_clock/clock_get_tz.s

@@ -1,13 +1,13 @@
         .export         _clock_get_tz
 
         .import         _bus
-        .import         _fuji_success
+        .import         _fn_error
 
         .import         popax
         .import         return0
 
         .include        "device.inc"
-        .include        "fujinet-clock.inc"
+        .include        "clock.inc"
         .include        "macros.inc"
         .include        "zp.inc"
 
@@ -33,8 +33,9 @@ _clock_get_tz:
         jsr     _bus
 
         ; check if we had a success (dstats holds status result)
-        jsr     _fuji_success
-        bne     ok
+        lda     IO_DCB::dstats
+        jsr     _fn_error
+        beq     ok
 
         ; error return, we weren't able to find the length of the current timezone
         rts
@@ -57,7 +58,8 @@ ok:
         ; inx                            ; x = 2 - as this is a FN non network call, we can keep this low
         ; stx     IO_DCB::dtimlo
         jsr     _bus
-        jmp     _fuji_success
+        lda     IO_DCB::dstats
+        jmp     _fn_error
 
 
 .bss

atari/src/fn_clock/clock_set_tz.s

@@ -1,26 +1,26 @@
-        .export         _clock_set_apetime_tz
         .export         _clock_set_tz
+        .export         _clock_set_alternate_tz
 
         .import         _bus
-        .import         _fuji_success
+        .import         _fn_error
         .import         _strlen
 
         .import         popax
 
         .include        "device.inc"
-        .include        "fujinet-clock.inc"
         .include        "macros.inc"
         .include        "zp.inc"
+        .include        "clock.inc"
 
 
-; uint8_t clock_set_alternate_tz(char *tz);
+; uint8_t clock_set_alternate_tz(const char *tz);
 _clock_set_alternate_tz:
         ; for backwards compatibility, this is the same as the old "APETIME" settz
         ldy     #SIO_APETIMECMD_SETTZ
         sty     IO_DCB::dcomnd
         bne     _clock_set_tz_common
 
-; uint8_t clock_set_tz(char *tz);
+; uint8_t clock_set_tz(const char *tz);
 _clock_set_tz:
         ldy     #'t'
         sty     IO_DCB::dcomnd
@@ -50,4 +50,5 @@ _clock_set_tz_common:
         inx                             ; x = 2
         stx     IO_DCB::dtimlo
         jsr     _bus
-        jmp     _fuji_success
+        lda     IO_DCB::dstats
+        jmp     _fn_error

atari/src/include/clock.inc

@@ -0,0 +1,7 @@
+SIO_APETIMECMD_GETTIME          := $93
+SIO_APETIMECMD_SETTZ            := $99
+
+SIO_CLOCK_DEVICE_ID 			:= $45
+
+; the number of timeformat entries, values are 0.. (TIMEFORMAT_COUNT - 1)
+TIMEFORMAT_COUNT                := $07

fujinet-clock.h

@@ -19,12 +19,14 @@ typedef enum time_format_t {
 	// BINARY formats are just the numbers, not ascii characters for the number.
 	SIMPLE_BINARY,      // 7 bytes: [Y(century, e.g. 20), Y(hundreds, e.g. 24), M(1-12), D(1-31), H(0-23), M(0-59), S(0-59)] - Uses the current FN Timezone
 	PRODOS_BINARY,      // 4 bytes: special PRODOS format, see https://prodos8.com/docs/techref/adding-routines-to-prodos/ - Uses the current FN Timezone
-	APETIME_TZ_BINARY,  // 6 bytes: [Day, Mon, Yr (YY), Hour, Min, Sec] - This version honours the Timezone either set in the WebUI or below in the clock_set_tz (both of which update the FN global timezone value)
-	APETIME_BINARY,     // 6 bytes: [Day, Mon, Yr (YY), Hour, Min, Sec] - UTC version of the apetime data. This is for backwards compatibility for Atari Apetime with no TZ set.
+	APETIME_BINARY,     // 6 bytes: [Day, Mon, Yr (YY), Hour, Min, Sec]
 
 	// STRING formats are full null terminated strings
 	TZ_ISO_STRING,      // an ISO format: YYYY-MM-DDTHH:MM:SS+HHMM - Uses the current FN Timezone
-	UTC_ISO_STRING      // Current UTC time, still ISO format, but with 0000 offset: YYYY-MM-DDTHH:MM:SS+HHMM
+	UTC_ISO_STRING,     // Current UTC time, still ISO format, but with 0000 offset: YYYY-MM-DDTHH:MM:SS+HHMM
+
+	// APPLE 3 SOS format
+	APPLE3_SOS_BINARY   // Apple 3 SOS format, YYYYMMDD0HHMMSS000
 
 } TimeFormat;
 
@@ -59,10 +61,4 @@ uint8_t clock_get_time(uint8_t* time_data, TimeFormat format);
  */
 uint8_t clock_get_time_tz(uint8_t* time_data, const char* tz, TimeFormat format);
 
-// for C implementations, these shouldn't be used by consumer
-#define SIO_APETIMECMD_GETTIME 0x93
-#define SIO_APETIMECMD_SETTZ 0x99
-#define SIO_APETIMECMD_GETTZTIME 0x9A
-
-
 #endif // FUJINET_CLOCK_H