A pause screen should not quietly spend the player’s time allowance.
Use it in a project
RESET takes priority and clears the 16-bit low-byte-first active counter. Otherwise PAUSED nonzero freezes it; a running call adds one modulo 65,536. Inputs remain caller-owned. The clock measures serviced active ticks, not seconds.
Include component.inc once (MOS callers include the shared 6502 implementation through it). Reserve the public fields in this exact order: TIME_LO, TIME_HI, PAUSED, RESET. They occupy 4 contiguous bytes. Also reserve the private workspace: none (0 bytes). Array names in the explanation refer to the numbered consecutive bindings, such as C0, C1 and so on.
Call pause_clock_init once at the intended reset boundary. It clears inputs as well as outputs and workspace. Set your starting state and configuration afterwards, then call pause_clock_step whenever the described event occurs. The helper reads no device, waits for no frame and installs no interrupt handler.
| Ownership | Fields |
|---|---|
| Retain between calls | TIME_LO and TIME_HI |
| Supply before service | PAUSED and RESET |
| Read after service | the two counter bytes |
A display frame and an active play tick are different events. The clock deliberately counts only the latter. You can keep an always-running clock alongside it for menus or pause-screen animation.
Reusable initialisation and service
; SPDX-License-Identifier: MIT
; Count Active Play Time. See README.md for the byte interface and ownership.
; init clears the public fields and private workspace; set inputs afterwards.
pause_clock_init:
move.b #0,d0
move.b d0,TIME_LO
move.b d0,TIME_HI
move.b d0,PAUSED
move.b d0,RESET
rts
pause_clock_step:
; if RESET != 0:
move.b RESET,d0
cmp.b #0,d0
bne pause_clock_L1
jmp pause_clock_L2
pause_clock_L1:
; TIME_LO = 0
move.b #0,d0
move.b d0,TIME_LO
; TIME_HI = 0
move.b #0,d0
move.b d0,TIME_HI
; return
rts
jmp pause_clock_L3
pause_clock_L2:
pause_clock_L3:
; if PAUSED != 0:
move.b PAUSED,d0
cmp.b #0,d0
bne pause_clock_L4
jmp pause_clock_L5
pause_clock_L4:
; return
rts
jmp pause_clock_L6
pause_clock_L5:
pause_clock_L6:
; TIME_LO = TIME_LO + 1
move.b TIME_LO,d0
add.b #1,d0
move.b d0,TIME_LO
; if TIME_LO == 0:
move.b TIME_LO,d0
cmp.b #0,d0
beq pause_clock_L7
jmp pause_clock_L8
pause_clock_L7:
; TIME_HI = TIME_HI + 1
move.b TIME_HI,d0
add.b #1,d0
move.b d0,TIME_HI
jmp pause_clock_L9
pause_clock_L8:
pause_clock_L9:
rts
component_end:Machine contract
D0–D3/A0–A1/CCR may change; D4–D7/A2–A6 are preserved. A direct BSR/JSR needs four return-address stack bytes. The helper makes no nested calls and adds no other stack use. Its named scratch is private workspace, not a pointer, a ROM variable or shared zero-page space that the game may borrow concurrently. Scope or rename routine and field labels and allocate a separate block for each independent instance. Give each block one mutation owner.
The A500 OCS diagnostic cold-boots an OFS disk, owns the Copper and bitplane and disables interrupt/DMA sources. The helper does not take over hardware or allocate Chip RAM.
Adapt the caller
demo.asm supplies the bindings and include order. exercise.inc first runs table cases, then a separate client retaining state between calls. A game can call the public step entry directly and remove the diagnostic packet and display. Do not copy the diagnostic’s hardware takeover into an existing game loop.
Build with make ASM198X=/path/to/asm198x and BUILD198X=/path/to/build198x. The Makefile produces normal, custom, deliberately wrong and repaired programs. Tools must already be installed; the sample downloads nothing.
Bindings and include order
section code,code_c
CUSTOM = 0
BROKEN = 0
COYOTE_STEPS = 4
BUFFER_STEPS = 4
TEXT_CAP = 8
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
TIME_LO: dc.b 0
TIME_HI: dc.b 0
PAUSED: dc.b 0
RESET: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XGAMEKIT0000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0A client retaining state between calls
preview_rules:
ifne CUSTOM
; TIME_LO = 255
move.b #255,d0
move.b d0,TIME_LO
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
; PAUSED = 1
move.b #1,d0
move.b d0,PAUSED
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
rts
else
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
; PAUSED = 1
move.b #1,d0
move.b d0,PAUSED
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; PAUSED = 0
move.b #0,d0
move.b d0,PAUSED
endif
bsr checked_step
bsr emit_state
endif
rtsCustomise it
Begin at 255 to exercise the carry into the high byte. The maintained custom caller changes its inputs or client sequence rather than hiding a different implementation behind the same label. Compare every state of the two clients, not only their final display.
Custom client selection
section code,code_c
CUSTOM = 1
BROKEN = 0
COYOTE_STEPS = 2
BUFFER_STEPS = 2
TEXT_CAP = 4
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 49
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
TIME_LO: dc.b 0
TIME_HI: dc.b 0
PAUSED: dc.b 0
RESET: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XGAMEKIT0000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0The custom diagnostic row is 03 01 00 00 00 00 00 00. The full client trace in the source explains how it gets there.
Mistake and repair
The wrong caller forces PAUSED to zero. Calls made while the pause screen is open still spend active play time. Feed the actual pause state, or deliberately stop servicing the active clock.
The BROKEN branch lives in the sequential client, not the reusable helper. wrong.asm selects it; repaired.asm restores the normal call sequence. The repaired executable matches the normal program (for Spectrum, compare loaded CODE rather than the tape filename).
Select the deliberately wrong client
section code,code_c
CUSTOM = 0
BROKEN = 1
COYOTE_STEPS = 4
BUFFER_STEPS = 4
TEXT_CAP = 8
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
TIME_LO: dc.b 0
TIME_HI: dc.b 0
PAUSED: dc.b 0
RESET: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XGAMEKIT0000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0
Cost and alternatives
The measured helper extent is 128 code bytes; public state is 4 bytes and private scratch is 0 bytes. There are no immutable helper tables. Caller data, the test cases, return-address stack, alignment and display buffers cost additional space. These are assembled sizes, not cycle measurements.
Constant work; carry into the high byte occurs only on a low-byte wrap. A wider counter extends the range at the cost of state and carry handling.
Do not mix this active clock with a deadline taken from a continuously running hardware counter. Longer sessions need wider storage or explicit wrap-aware comparisons.
Execution evidence
Four variants run on A500 OCS PAL, Kickstart1.3 OFS cold boot, using Asm198x 0.0.72, Emu198x 0.44.2 and Build198x 0.2.9. Each executes 64 boundary/varied/error table cases, dirty initialisation and the separate retained-state client. An independent mathematical/container model checks every public byte after every call. This is bounded example coverage, not exhaustive correctness for every possible state.
The records retain loaded immutable code, completion, register sentinels, full packets, source/tool/firmware hashes and captures. The public gate validates these retained observations and rejects altered evidence; it does not run restricted firmware. No firmware is distributed. The eight displayed bytes are the first eight public fields, zero-padded when shorter; the packet includes every field.
Where it fits
Rational tick division: Rate division decides when a tick is due; the pause policy decides whether active play should consume it.