Add clock_get_time_tz, remove feature tests, add soft65c02 tests

Author: markjfisher

.cursor/rules/fujinet-lib-rules.mdc

@@ -0,0 +1,15 @@
+---
+description: 
+globs: 
+alwaysApply: true
+---
+you are an expert in 6502 assembly language, and C for the cc65 development 8 bit computer environment.
+you will follow existing layout of assembly files.
+you will prefer lowercase labels and instructions.
+the project uses cc65 to compile C and asm files.
+The C standard is c99, with all variables being defined at the top of block structures, rather than inline.
+The asm is compiled with ca65.
+This project is for 8 bit machines, where memory is limited.
+For any C files, you must try not to use expensive library functions such as printf, but stdlib and memory efficient functions like memmove and memcpy are prefered.
+The preferred convention for passing parameters to functions in asm files is the cc65 C conventions of passing values via the software stack.
+Your responses should be to the point. You will say when you do not know the answer rather than guessing, or at least indicate that you are postulating a solution, or need more information to formulate a better response.

.gitignore

@@ -7,3 +7,5 @@ build/
 .vscode/
 
 Makefile.options
+
+_temp

Changelog.md

@@ -6,6 +6,7 @@
 
 - [atari] fix software stack leak in clock_get_time when timeformat value is not valid [Mark Fisher]
 - [atari] add block reading for directories [Mark Fisher]
+- [atari] align apetime functionality with original intent with optional alternate TZ for some applications
 
 ## [4.7.5] - 2025-04-18
 

Makefile

@@ -8,7 +8,7 @@ TARGETS = adam atari c64 apple2 apple2enh apple2gs coco
 # TARGETS = msdos
 PROGRAM := fujinet.lib
 
-SUB_TASKS := clean disk test release
+SUB_TASKS := clean disk test release unit-test
 .PHONY: all help $(SUB_TASKS)
 
 all:
@@ -32,3 +32,4 @@ help:
 	@echo "all       - do all compilation tasks, create app in build directory"
 	@echo "clean     - remove all build artifacts"
 	@echo "release   - create a release of the executable in the dist/ dir"
+	@echo "unit-test - run unit tests"

application.mk

@@ -0,0 +1,3 @@
+# for application specific settings
+
+-include makefiles/unit_tests.mk

atari/src/fn_clock/clock_get_time.s

@@ -1,7 +1,9 @@
         .export         _clock_get_time
+        .export         _clock_get_time_tz
 
         .import         _bus
         .import         _fuji_success
+        .import         _clock_set_alternate_tz
 
         .import         incsp2
         .import         popax
@@ -12,17 +14,40 @@
         .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
+
+        ; save it while we deal with the TZ string
+        sta     tmp_format
+        ; first read tz from string given, and set it as the alternate TZ in fujinet.
+        jsr     popax
+        jsr     _clock_set_alternate_tz
+
+        ; an error, but we still have an arg on software stack
+        bne     exit_bad_tz2
+
+        ldy     tmp_format
+        bpl     common_tz               ; it's between 0 and 6 validated, so this will always branch
+
 ; uint8_t clock_get_time(uint8_t* time_data, TimeFormat format);
 _clock_get_time:
-        tay
+        tay                             ; time format enum
         cpy     #$06                    ; was the format value in range?
-        bcc     ok
+        bcs     exit_bad_tz2
 
-        ; return an error status
-        jsr     incsp2                  ; remove stack parameter
-        jmp     return0
-
-ok:
+common_tz:
         lda     t_clock_get_time_cmd, y
         sta     IO_DCB::dcomnd
         lda     t_clock_get_time_len, y
@@ -45,6 +70,9 @@ ok:
         jsr     _bus
         jmp     _fuji_success
 
+.bss
+tmp_format:     .res 1
+
 .rodata
 
 ; tables for the commands that have to be sent for the different types of time command

atari/src/fn_clock/clock_set_tz.s

@@ -1,3 +1,4 @@
+        .export         _clock_set_apetime_tz
         .export         _clock_set_tz
 
         .import         _bus
@@ -11,8 +12,21 @@
         .include        "macros.inc"
         .include        "zp.inc"
 
+
+; uint8_t clock_set_alternate_tz(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);
 _clock_set_tz:
+        ldy     #'t'
+        sty     IO_DCB::dcomnd
+        ; ... fallthrough
+
+_clock_set_tz_common:
         axinto  IO_DCB::dbuflo          ; the TZ string to send, will be null terminated
         jsr     _strlen
 
@@ -24,9 +38,6 @@ _clock_set_tz:
 :       axinto  IO_DCB::dbytlo
         axinto  IO_DCB::daux1
 
-        lda     #SIO_APETIMECMD_SETTZ
-        sta     IO_DCB::dcomnd
-
 ; the SIO clock device follows the APETIME device ID:
 ; #define SIO_DEVICEID_APETIME 0x45
 

fujinet-clock.h

@@ -43,13 +43,23 @@ uint8_t clock_set_tz(const char *tz);
 uint8_t clock_get_tz(char *tz);
 
 /**
- * @brief  Get the current time in the format specified.
+ * @brief  Get the current time in the format specified using the FN timezone.
  * @param  time_data pointer to buffer for the response. This is uint8_t, but for STRING formats, will be null terminated and can be treated as a string.
  * @param  format a TimeFormat value to specify how the data should be returned.
  * @return fujinet-clock status/error code (See FN_ERR_* values)
  */
 uint8_t clock_get_time(uint8_t* time_data, TimeFormat format);
 
+/**
+ * @brief  Get the current time in the format specified for the given timezone without affecting the system timezone
+ * @param  time_data pointer to buffer for the response. This is uint8_t, but for STRING formats, will be null terminated and can be treated as a string.
+ * @param  tz pointer to the receiving timezone buffer.
+ * @param  format a TimeFormat value to specify how the data should be returned.
+ * @return fujinet-clock status/error code (See FN_ERR_* values)
+ */
+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

makefiles/unit_tests.mk

@@ -0,0 +1,24 @@
+# Find all test_*.yaml files under testing/unit
+UNIT_TEST_FILES := $(shell find testing/unit/$(CURRENT_TARGET) -name "test_*.yaml")
+
+# Create temp directory if it doesn't exist
+/tmp/fujinet-lib-unit:
+	@mkdir -p /tmp/fujinet-lib-unit
+
+# Run all unit tests
+.PHONY: unit-test
+unit-test: /tmp/fujinet-lib-unit
+	@echo "Running unit tests..."
+	@failed=0; \
+	for test in $(UNIT_TEST_FILES); do \
+		echo "Running $$test..."; \
+		if ! WS_ROOT=$(CURDIR) UNIT_TEST_DIR=$(CURDIR)/testing/unit soft65c02_unit -b /tmp/fujinet-lib-unit -i $$test; then \
+			echo "FAILED: $$test"; \
+			failed=1; \
+		fi; \
+	done; \
+	if [ $$failed -eq 1 ]; then \
+		echo "One or more tests failed"; \
+		exit 1; \
+	fi
+	@echo "All unit tests passed"