Skip to content

MOS API

Jump to bottom
Dean Belfield edited this page Apr 14, 2023 · 27 revisions

What is the MOS API

The MOS API can be used by external applications to access MOS functionality

Usage from Z80 assembler

There are four RST instructions for accessing MOS functionality from Z80.

  • RST 00h: Reset the eZ80
  • RST 08h: Execute a MOS command
  • RST 10h: Output a single character to the VDP
  • RST 18h: Output a stream of characters to the VDP (MOS 1.03 or above)

In addition, you will probably want to include the file mos_api.inc in your project. This can be found in the folder src of project agon-mos.

NB:

  • Include the file mos_api.inc in your project
  • The RST.LIS ensures the MOS RST instructions are called regardless of the eZ80s current addressing mode

RST 08h: Execute a MOS command

Parameters:

  • A: MOS command number to execute

NB:

  • There is a macro in mos_api.inc with EQUs for all the MOS commands
  • Other MOS-command dependant parameters may be required

Macro:

;
; Macro for calling the API
; Parameters:
; - function: One of the function numbers listed above
;
MOSCALL:	MACRO	function
		LD	A, function
		RST.LIS	08h
		ENDMACRO

Example:

; OSRDCH: Read a character in from the ESP32 keyboard handler
;
OSRDCH:		MOSCALL	mos_getkey
		OR	A 		
		JR	Z, OSRDCH		; Loop until key is pressed
		RET

RST 10h: Output a single character to the VDP

Parameters:

  • A: Character to output

Example:

; OSWRCH: Write a character out to the ESP32 VDU handler via the MOS
; A: Character to write
;
OSWRCH:		RST.LIS	10h			; This calls a RST in the eZ80 address space
		RET

RST 18h: Output a stream of characters to the VPD (MOS 1.03 or above)

Parameters:

  • HL: Address of the data stream (16-bit for Z80 mode, 24-bit for ADL mode)
  • BC: Length of stream (or 0 if the stream is limited)
  • A: Stream delimiter (if BC=0)

Example:

; Write a stream of characters to the VDP
; HLU: Address of buffer containing data - if in 16-bit segment, U will be replaced by MB
;  BC: Number of characters to write out, or 0 if the data is delimited
;   A: End of data delimiter, i.e. 0 for C strings
;
		LD	HL, text		; Address of text
		LD	BC, 0			; Set to 0, so length ignored...
		LD	A, 0			; Use character in A as delimiter
		RST.LIS	18h			; This calls a RST in the eZ80 address space
		RET
;
text:		DB	"Hello World", 0

MOS commands

MOS commands can be executed from a classic 64K Z80 segment or whilst the eZ80 is running in 24-bit ADL mode. For classic mode, 16 bit registers are passed as pointers to the MOS commands; these are automatically promoted to 24 bit by adding the MB register to bits 16-23 of the register. When running in ADL mode, a 24-bit register will be passed, but MB must be set to 0.

See mos_api.asm for implementation

The following MOS commands are supported

0x00: mos_getkey

Read a keypress from the VDP

Parameters: None

Returns:

  • A: The keycode of the character pressed

0x01: mos_load

Load a file from SD card

Parameters:

  • HL(U): Address of filename (zero terminated)
  • DE(U): Address at which to load
  • BC(U): Maximum allowed size (bytes)

Returns:

  • A: File error, or 0 if OK
  • F: Carry reset if no room for file, otherwise set

0x02: mos_save

Save a file to SD card

Parameters:

  • HL(U): Address of filename (zero terminated)
  • DE(U): Address to save from
  • BC(U): Number of bytes to save

Returns:

  • A: File error, or 0 if OK
  • F: Carry set

0x03: mos_cd

Change current directory on the SD card

Parameters:

  • HL(U): Address of path (zero terminated)

Returns:

  • A: File error, or 0 if OK

0x04: mos_dir

List SD card folder contents

Parameters:

  • HL(U): Address of path (zero terminated)

Returns:

  • A: File error, or 0 if OK

0x05: mos_del

Delete a file or folder from the SD card

Parameters:

  • HL(U): Address of path (zero terminated)

Returns:

  • A: File error, or 0 if OK

0x06: mos_ren

Rename a file on the SD card

Parameters:

  • HL(U): Address of filename1 (zero terminated)
  • D(E)U: Address of filename2 (zero terminated)

Returns:

  • A: File error, or 0 if OK

0x07: mos_mkdir

Make a folder on the SD card

Parameters:

  • HL(U): Address of path (zero terminated)

Returns:

  • A: File error, or 0 if OK

0x08: mos_sysvars

Fetch a pointer to the system variables

Parameters: None

Returns:

  • IXU: Pointer to the MOS system variable area (this is always 24 bit)

0x09: mos_editline

Invoke the line editor

Parameters:

  • HL(U): Address of the buffer
  • BC(U): Buffer length
  • E: 0 to not clear buffer, 1 to clear

Returns:

  • A: Key that was used to exit the input loop (CR=13, ESC=27)

0x0A: mos_fopen

Get a file handle

Parameters:

  • HL(U): Address of filename (zero terminated)
  • C: Mode

Returns:

  • A: Filehandle, or 0 if couldn't open

Mode can be one of: fa_read, fa_write, fa_open_existing, fa_create_new, fa_create_always, fa_open_always or fa_open_append

0x0B: mos_fclose

Close a file handle

Parameters:

  • C: Filehandle, or 0 to close all open files

Returns:

  • A: Number of files still open

0x0C: mos_fgetc

Get a character from an open file

Parameters:

  • C: Filehandle

Returns:

  • A: Character read
  • F: C set if last character in file, otherwise NC

0x0D: mos_fputc

Write a character to an open file

Parameters:

  • C: Filehandle
  • B: Character to write

Returns: None

0x0E: mos_feof

Check for end of file

Parameters:

  • C: Filehandle

Returns:

  • A: 1 if at end of file, otherwise 0

0x0F: mos_getError

Copy an error string to a buffer

Parameters:

  • E: The error code
  • HL(U): Address of buffer to copy message into
  • BC(U): Size of buffer

Returns: None

0x10: mos_oscli

Execute a MOS command

Parameters:

  • HLU: Pointer the the MOS command string
  • DEU: Pointer to additional command structure
  • BCU: Number of additional commands

Returns:

  • A: MOS error code

0x11: mos_copy

Copy a file on the SD card

Parameters:

  • HL(U): Address of filename1 (zero terminated)
  • D(E)U: Address of filename2 (zero terminated)

Returns:

  • A: File error, or 0 if OK

NB: Requires MOS 1.03 or greater

0x12: mos_getrtc

Get a time string from the RTC (Requires MOS 1.03 or above)

Parameters:

  • HLU: Pointer to a buffer to copy the string to (at least 32 bytes)

Returns:

  • A: Length of time string

0x13: mos_setrtc

Set the RTC (Requires MOS 1.03 or above)

Parameters:

  • HLU: Pointer to a 6-byte buffer with the time data in
+0: Year (offset from 1980, so 1989 is 9)
+1: Month (1 to 12)
+2: Day of Month (1 to 31)
+3: Hour (0 to 23)
+4: Minute (0 to 59)
+5: Second (0 to 59)

Returns: None

0x14: mos_setintvector

Set an interrupt vector (Requires MOS 1.03 or above)

Parameters:

  • E: Interrupt vector number to set
  • HLU: Address of new interrupt vector (24-bit pointer)

Returns:

  • HLU: Address of the previous interrupt vector (24-bit pointer)

0x15: mos_uopen

Open UART1 (Requires MOS 1.03 RC3 or above)

Parameters:

  • IXU: Pointer to a UART struct
+0: Baud rate (24-bit, little endian)
+3: Data bits (5, 6, 7 or 8)
+4: Stop bits (1 or 2)
+5: Parity bits (0: None, 1: Odd, 3: Even)
+6: Flow control (0: None, 1: Hardware)
+7: Enabled interrupts
    - Bit 0: Set to enable received data interrupt
    - Bit 1: Set to enable transmit data interrupt
    - Bit 2: Set to enable line status change interrupt
    - Bit 3: Set to enable modem status change interrupt
    - Bit 4: Set to enable transmit complete interrupt

To handle the received interrupts, you will need to assign a handler to UART1's interrupt vector (0x1A).

Returns:

  • A: Error code (always 0)

0x16: mos_uclose

Close UART1 (Requires MOS 1.03 RC3 or above)

0x17: mos_ugetc

Read a character from UART1 (Requires MOS 1.03 RC3 or above)

Returns:

  • A: The character read
  • F: C if successful, NC if the UART is closed

0x18: mos_uputc

Write a character to UART1 (Requires MOS 1.03 RC3 or above)

Parameters:

  • C: The character to write

Returns:

  • F: C if successful, NC if the UART is closed

FatFS commands

In addition to the MOS commands, it is possible to access FatFS at a lower level

0x80: ffs_fopen

Open a file (Requires MOS 1.04 RC4 or above)

Parameters:

  • HL(U): Pointer to an empty FIL structure
  • DE(U): Pointer to a C (zero-terminated) filename string
  • C: File open mode

Returns:

  • A: FRESULT

0x81: ffs_fclose

Close a file (Requires MOS 1.04 RC4 or above)

Parameters:

  • HL(U): Pointer to a FIL structure

Returns:

  • A: FRESULT

0x82: ffs_fread

Read from a file (Requires MOS 1.04 RC4 or above)

Parameters:

  • HL(U): Pointer to a FIL structure
  • DE(U): Pointer to a buffer to store the data in
  • BC(U): Number of bytes to read (typically the size of the buffer)

Returns:

  • BC(U): Number of bytes read
  • A: FRESULT

0x83: ffs_fwrite

Write to a file (Requires MOS 1.04 RC4 or above)

Parameters:

  • HL(U): Pointer to a FIL structure
  • DE(U): Pointer to a buffer to read the data from
  • BC(U): Number of bytes to write (typically the size of the buffer)

Returns:

  • BC(U): Number of bytes written
  • A: FRESULT

0x8E: ffs_feof

Detect end of file (Requires MOS 1.04 RC4 or above)

Parameters:

  • HL(U): Pointer to a FIL structure

Returns:

  • A: 1 if at the end of the file, otherwise 0

0x96: ffs_stat

Get file information (Requires MOS 1.04 RC4 or above)

Parameters:

  • HL(U): Pointer to a FILINFO structure
  • DE(U): Pointer to a C (zero-terminated) filename string

Returns:

  • A: FRESULT
Clone this wiki locally