Moving arrows from a chest to a pack should never remove more than the pack can hold.
Use it in a project
Zero count requires kind zero; a nonempty stack requires a nonzero kind. Both counts must be at most CAPACITY. AMOUNT requests up to that many items from source into destination. A nonempty destination accepts only the same kind. MOVED reports the actual minimum of requested, available and free space; zero is a valid refusal. On success clear an emptied source kind and assign the source kind to an empty destination. Invalid stack representation or capacity sets VALID=0 without changing either stack.
Include component.inc once (MOS callers include the shared 6502 implementation through it). Reserve the public fields in this exact order: MOVED, VALID, SOURCE_KIND, SOURCE_COUNT, DEST_KIND, DEST_COUNT, CAPACITY, AMOUNT. They occupy 8 contiguous bytes. Also reserve the private workspace: T0 (1 bytes). Array names in the explanation refer to the numbered consecutive bindings, such as C0, C1 and so on.
Call inventory_transfer_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 inventory_transfer_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 | source and destination kinds/counts |
| Supply before service | CAPACITY and AMOUNT |
| Read after service | updated stacks, MOVED and VALID |
Validate both representations before writing, calculate the complete accepted amount, then commit both counts and kinds. Conservation of the total item count is the central invariant.
Reusable initialisation and service
; SPDX-License-Identifier: MIT
; Transfer Inventory Stacks Atomically. See README.md for the byte interface and ownership.
; init clears the public fields and private workspace; set inputs afterwards.
inventory_transfer_init:
move.b #0,d0
move.b d0,MOVED
move.b d0,VALID
move.b d0,SOURCE_KIND
move.b d0,SOURCE_COUNT
move.b d0,DEST_KIND
move.b d0,DEST_COUNT
move.b d0,CAPACITY
move.b d0,AMOUNT
move.b d0,T0
rts
inventory_transfer_step:
; MOVED = 0
move.b #0,d0
move.b d0,MOVED
; VALID = 0
move.b #0,d0
move.b d0,VALID
; if SOURCE_COUNT > CAPACITY:
move.b SOURCE_COUNT,d0
move.b CAPACITY,d1
cmp.b d1,d0
bhi inventory_transfer_L1
jmp inventory_transfer_L2
inventory_transfer_L1:
; return
rts
jmp inventory_transfer_L3
inventory_transfer_L2:
inventory_transfer_L3:
; if DEST_COUNT > CAPACITY:
move.b DEST_COUNT,d0
move.b CAPACITY,d1
cmp.b d1,d0
bhi inventory_transfer_L4
jmp inventory_transfer_L5
inventory_transfer_L4:
; return
rts
jmp inventory_transfer_L6
inventory_transfer_L5:
inventory_transfer_L6:
; if SOURCE_COUNT == 0:
move.b SOURCE_COUNT,d0
cmp.b #0,d0
beq inventory_transfer_L7
jmp inventory_transfer_L8
inventory_transfer_L7:
; if SOURCE_KIND != 0:
move.b SOURCE_KIND,d0
cmp.b #0,d0
bne inventory_transfer_L10
jmp inventory_transfer_L11
inventory_transfer_L10:
; return
rts
jmp inventory_transfer_L12
inventory_transfer_L11:
inventory_transfer_L12:
jmp inventory_transfer_L9
inventory_transfer_L8:
; if SOURCE_KIND == 0:
move.b SOURCE_KIND,d0
cmp.b #0,d0
beq inventory_transfer_L13
jmp inventory_transfer_L14
inventory_transfer_L13:
; return
rts
jmp inventory_transfer_L15
inventory_transfer_L14:
inventory_transfer_L15:
inventory_transfer_L9:
; if DEST_COUNT == 0:
move.b DEST_COUNT,d0
cmp.b #0,d0
beq inventory_transfer_L16
jmp inventory_transfer_L17
inventory_transfer_L16:
; if DEST_KIND != 0:
move.b DEST_KIND,d0
cmp.b #0,d0
bne inventory_transfer_L19
jmp inventory_transfer_L20
inventory_transfer_L19:
; return
rts
jmp inventory_transfer_L21
inventory_transfer_L20:
inventory_transfer_L21:
jmp inventory_transfer_L18
inventory_transfer_L17:
; if DEST_KIND == 0:
move.b DEST_KIND,d0
cmp.b #0,d0
beq inventory_transfer_L22
jmp inventory_transfer_L23
inventory_transfer_L22:
; return
rts
jmp inventory_transfer_L24
inventory_transfer_L23:
inventory_transfer_L24:
inventory_transfer_L18:
; VALID = 1
move.b #1,d0
move.b d0,VALID
; if SOURCE_COUNT == 0:
move.b SOURCE_COUNT,d0
cmp.b #0,d0
beq inventory_transfer_L25
jmp inventory_transfer_L26
inventory_transfer_L25:
; return
rts
jmp inventory_transfer_L27
inventory_transfer_L26:
inventory_transfer_L27:
; if DEST_COUNT != 0:
move.b DEST_COUNT,d0
cmp.b #0,d0
bne inventory_transfer_L28
jmp inventory_transfer_L29
inventory_transfer_L28:
; if DEST_KIND != SOURCE_KIND:
move.b DEST_KIND,d0
move.b SOURCE_KIND,d1
cmp.b d1,d0
bne inventory_transfer_L31
jmp inventory_transfer_L32
inventory_transfer_L31:
; return
rts
jmp inventory_transfer_L33
inventory_transfer_L32:
inventory_transfer_L33:
jmp inventory_transfer_L30
inventory_transfer_L29:
inventory_transfer_L30:
; T0 = CAPACITY - DEST_COUNT
move.b CAPACITY,d0
move.b DEST_COUNT,d1
sub.b d1,d0
move.b d0,T0
; if AMOUNT < T0:
move.b AMOUNT,d0
move.b T0,d1
cmp.b d1,d0
bcs inventory_transfer_L34
jmp inventory_transfer_L35
inventory_transfer_L34:
; T0 = AMOUNT
move.b AMOUNT,d0
move.b d0,T0
jmp inventory_transfer_L36
inventory_transfer_L35:
inventory_transfer_L36:
; if SOURCE_COUNT < T0:
move.b SOURCE_COUNT,d0
move.b T0,d1
cmp.b d1,d0
bcs inventory_transfer_L37
jmp inventory_transfer_L38
inventory_transfer_L37:
; T0 = SOURCE_COUNT
move.b SOURCE_COUNT,d0
move.b d0,T0
jmp inventory_transfer_L39
inventory_transfer_L38:
inventory_transfer_L39:
; if T0 == 0:
move.b T0,d0
cmp.b #0,d0
beq inventory_transfer_L40
jmp inventory_transfer_L41
inventory_transfer_L40:
; return
rts
jmp inventory_transfer_L42
inventory_transfer_L41:
inventory_transfer_L42:
; DEST_KIND = SOURCE_KIND
move.b SOURCE_KIND,d0
move.b d0,DEST_KIND
; DEST_COUNT = DEST_COUNT + T0
move.b DEST_COUNT,d0
move.b T0,d1
add.b d1,d0
move.b d0,DEST_COUNT
; SOURCE_COUNT = SOURCE_COUNT - T0
move.b SOURCE_COUNT,d0
move.b T0,d1
sub.b d1,d0
move.b d0,SOURCE_COUNT
; MOVED = T0
move.b T0,d0
move.b d0,MOVED
; if SOURCE_COUNT == 0:
move.b SOURCE_COUNT,d0
cmp.b #0,d0
beq inventory_transfer_L43
jmp inventory_transfer_L44
inventory_transfer_L43:
; SOURCE_KIND = 0
move.b #0,d0
move.b d0,SOURCE_KIND
jmp inventory_transfer_L45
inventory_transfer_L44:
inventory_transfer_L45:
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. The samples use fixed symbol bindings. Scope or rename every label and binding, including the component_end measurement marker, and allocate a separate block for each independent instance. Different helpers can also use common field names, so combining them needs separate namespaces or explicitly renamed bindings. 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:
MOVED: dc.b 0
VALID: dc.b 0
SOURCE_KIND: dc.b 0
SOURCE_COUNT: dc.b 0
DEST_KIND: dc.b 0
DEST_COUNT: dc.b 0
CAPACITY: dc.b 0
AMOUNT: dc.b 0
T0: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XNIGHTTWO000",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
; SOURCE_KIND = 2
move.b #2,d0
move.b d0,SOURCE_KIND
; SOURCE_COUNT = 4
move.b #4,d0
move.b d0,SOURCE_COUNT
; CAPACITY = 4
move.b #4,d0
move.b d0,CAPACITY
; AMOUNT = 255
move.b #255,d0
move.b d0,AMOUNT
ifne BROKEN
; AMOUNT = 0
move.b #0,d0
move.b d0,AMOUNT
endif
bsr checked_step
bsr emit_state
ifne BROKEN
; AMOUNT = 0
move.b #0,d0
move.b d0,AMOUNT
endif
bsr checked_step
bsr emit_state
rts
else
; SOURCE_KIND = 3
move.b #3,d0
move.b d0,SOURCE_KIND
; SOURCE_COUNT = 7
move.b #7,d0
move.b d0,SOURCE_COUNT
; DEST_KIND = 3
move.b #3,d0
move.b d0,DEST_KIND
; DEST_COUNT = 8
move.b #8,d0
move.b d0,DEST_COUNT
; CAPACITY = 10
move.b #10,d0
move.b d0,CAPACITY
; AMOUNT = 5
move.b #5,d0
move.b d0,AMOUNT
ifne BROKEN
; AMOUNT = 0
move.b #0,d0
move.b d0,AMOUNT
endif
bsr checked_step
bsr emit_state
; DEST_KIND = 0
move.b #0,d0
move.b d0,DEST_KIND
; DEST_COUNT = 0
move.b #0,d0
move.b d0,DEST_COUNT
; AMOUNT = 5
move.b #5,d0
move.b d0,AMOUNT
ifne BROKEN
; AMOUNT = 0
move.b #0,d0
move.b d0,AMOUNT
endif
bsr checked_step
bsr emit_state
endif
rtsCustomise it
Move the whole source into an empty four-item destination, then try the now-empty source again. 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:
MOVED: dc.b 0
VALID: dc.b 0
SOURCE_KIND: dc.b 0
SOURCE_COUNT: dc.b 0
DEST_KIND: dc.b 0
DEST_COUNT: dc.b 0
CAPACITY: dc.b 0
AMOUNT: dc.b 0
T0: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XNIGHTTWO000",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 00 01 00 00 02 04 04 FF. The full client trace in the source explains how it gets there.
Mistake and repair
The wrong client clears the transfer request before service. Both stacks remain unchanged and MOVED is zero. Keep the requested amount until it has been consumed.
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:
MOVED: dc.b 0
VALID: dc.b 0
SOURCE_KIND: dc.b 0
SOURCE_COUNT: dc.b 0
DEST_KIND: dc.b 0
DEST_COUNT: dc.b 0
CAPACITY: dc.b 0
AMOUNT: dc.b 0
T0: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XNIGHTTWO000",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 468 code bytes; public state is 8 bytes and private scratch is 1 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 with no array search. Full inventory placement can scan candidate stacks first and invoke this transaction under the same mutation owner.
One source and one destination are borrowed exclusively during a call. This does not find stacks, merge an entire inventory, reserve network transactions or support different per-item caps. The capacity is shared by these two stacks; use a larger transaction for several destinations.
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
Inventory stacks: Reuse the existing stack rules when adding or removing items without a second container.