SmartBox OS - Revision history

Benryves: /* Changelog */ Put changelog in table

2023-11-04T17:44:44Z

Changelog: Put changelog in table

Benryves: /* Modules */ Tidied up layout of modules documentation

2023-11-04T17:42:37Z

Modules: Tidied up layout of modules documentation

← Older revision		Revision as of 17:42, 4 November 2023
Line 1,194:		Line 1,194:
	&8000):		&8000):

	~~<nowiki>~~Offset ~~value comment~~		{\|class="wikitable"
	0 "Module" The OS checks for this string		!Offset!!Value!!Comment
	6 0 End of check string		\|-
	7 Language entry Address of 'Language' entry		\|0\|\|"Module"\|\|The OS checks for this string
	9 Service entry Address of 'Service' entry		\|-
	11 "<Module Title>" Module title		\|6\|\|0\|\|End of check string
	0 End of Module title		\|-
			\|7\|\|Language entry\|\|Address of 'Language' entry
	"<Module part>" Part Module Title		\|-
	0 End of Part Module Title		\|9\|\|Service entry\|\|Address of 'Service' entry
	"x.xx" Part version number		\|-
			\|11\|\|"<Module Title>"\|\|Module title
	&FF End of parts list~~</nowiki>~~		\|-
			\| \|\|0\|\|End of Module title
			\|-
			\| \|\|"<Module part>"\|\|Part Module Title
			\|-
			\| \|\|0\|\|End of Part Module Title
			\|-
			\| \|\|"x.xx"\|\|Part version number
			\|-
			\| \|\|&FF\|\|End of parts list
			\|}

	The language entry is a 2 byte value holding the address of the language		The language entry is a 2 byte value holding the address of the language
Line 1,215:		Line 1,225:

	The service entry is a 2 byte value holding the address of the service		The service entry is a 2 byte value holding the address of the service
	entry routine, this is called at various ~~appropiate~~ moments with service		entry routine, this is called at various appropriate moments with service
	numbers in A. A list of current calls is thus:		numbers in A. A list of current calls is thus:

	~~<nowiki>~~ 0 - Not used		* 0 - Not used
	1 - Unknown Job Code		* 1 - Unknown Job Code
	2 - Centisecond call		* 2 - Centisecond call
	3 - ~~Irq2~~ (unknown IRQ)		* 3 - irq2 (unknown IRQ)
	4 - internal_vec call (exit with A=0 to claim)		* 4 - internal_vec call (exit with A=0 to claim)
	254 - RESET		* 254 - RESET
	255 - BRK~~</nowiki>~~		* 255 - BRK

	On exit all registers and flags should be preserved. For call 1 the		On exit all registers and flags should be preserved. For call 1 the
	unknown job value is held in the Y register, the ~~enviroment~~ is held in the		unknown job value is held in the Y register, the environment is held in the
	X register, on exit, X should contain the flag, as A does from the exit of		X register, on exit, X should contain the flag, as A does from the exit of
	unknownjob_vec. For the rest of calls, X and Y are undefined.		unknownjob_vec. For the rest of calls, X and Y are undefined.

Benryves: /* Example JobCall */ Tidied up formatting/indentation

2023-11-04T17:38:21Z

Example JobCall: Tidied up formatting/indentation

Show changes

Benryves: Moved OS_PRINTER into OS Calls section and added header to Modules description

2023-11-04T17:33:13Z

Moved OS_PRINTER into OS Calls section and added header to Modules description

@@ Line 739: / Line 739: @@
 Sets the reset vector to address supplied and sets check bytes in
 workspace.
 |}
@@ Line 1,154: / Line 1,179: @@
 and not needed again.
-== Other miscellaneous calls ==
+== Modules ==
 The module is located at &8000 in memory, and should be a EPROM placed
@@ Line 1,226: / Line 1,233: @@
 For both Service and Language entry points, a value of 0 means "there is
 no valid routine" and the module isn't called for that type of entry.
 Finally a full implementation of a JobCall, from start to finish.

Benryves: /* OS_DECODEJOB */

2023-11-04T17:27:52Z

OS_DECODEJOB

← Older revision		Revision as of 17:27, 4 November 2023
Line 284:		Line 284:
	So for OS_DECODEJOB:		So for OS_DECODEJOB:

	~~<nowiki> Call : OS_DECODEJOB~~		{\|class="calltable"
	Entry : A = JobCode		\|Entry\|\|
	X, Y, c, z = undefined		* A = JobCode
	jobin_buf should contain any input data		* X, Y, c, z = undefined
	Exit : A = flag		* jobin_buf should contain any input data
	X = number of bytes given back by routine		\|-
	Y = undefined		\|Exit\|\|
	c = status, if set JobCall does not exist		* A = flag
	z = status, if set JobCall cannot be called internally		* X = number of bytes given back by routine
	jobout_buf contains any data sent from routine~~</nowiki>~~		* Y = undefined
			* c = status, if set JobCall does not exist
			* z = status, if set JobCall cannot be called internally
			* jobout_buf contains any data sent from routine
			\|}

	A typical example would be:		A typical example would be:

Benryves: /* OS_READJOB and OS_SENDJOB */

2023-11-04T17:26:17Z

OS_READJOB and OS_SENDJOB

← Older revision		Revision as of 17:26, 4 November 2023
Line 230:		Line 230:
	stop.		stop.

	~~<nowiki> Call :~~ OS_READJOB		==== OS_READJOB: Read job value from the user ====
	~~Purpose~~: ~~To read~~ job value from the user
	~~Entry : A, X, Y, c, z~~ = ~~undefined~~
	~~Exit : A~~ = ~~byte read~~
	~~X, Y is preserved~~
	~~c, z~~ = ~~undefined~~
	~~Note : When coming from the serial port it waits for a character to be~~
	~~received, if you are doing a serial only call and wish to have a loop~~
	~~checking for a character from the user while doing "your own thing", then~~
	~~OS_READBYTE should be used. For internal calls this reads data out of~~
	~~jobin_buf.</nowiki>~~

	~~<nowiki> Call : OS_SENDJOB~~		{\|class="calltable"
	~~Purpose: To give a job value back to the user~~		\|Entry\|\|
	~~Entry :~~ A ~~= byte to give~~		* A, X, Y, c, z = undefined
	X, Y, c, z = undefined		\|-
	Exit : A, X, Y is preserved		\|Exit\|\|
	c, z = undefined		* A = byte read
	Note ~~: This will send either out to~~ the serial port ~~or place~~ a ~~byte in~~		* X, Y is preserved
	~~jobout_buf~~. For internal calls this ~~stores the value in jobout_buf, which~~		* c, z = undefined
	~~is allocated 128 bytes, no bound checking is done so sending more than 128~~		\|-
	~~bytes to OS_SENDJOB will cause corruption~~ of ~~some memory~~.~~</nowiki>~~		\|Note\|\|
			When coming from the serial port it waits for a character to be received, if you are doing a serial only call and wish to have a loop checking for a character from the user while doing "your own thing", then OS_READBYTE should be used. For internal calls this reads data out of jobin_buf.
			\|}

			==== OS_SENDJOB: Give a job value back to the user ====

			{\|class="calltable"
			\|Entry\|\|
			* A = byte to give
			* X, Y, c, z = undefined
			\|-
			\|Exit\|\|
			* A, X, Y is preserved
			* c, z = undefined
			\|-
			\|Note\|\|
			This will send either out to the serial port or place a byte in jobout_buf.
			For internal calls this stores the value in jobout_buf, which is allocated 128 bytes, no bound checking is done so sending more than 128 bytes to OS_SENDJOB will cause corruption of some memory.
			\|}

	=== OS_DECODEJOB ===		=== OS_DECODEJOB ===

Benryves: /* Serial Port */

2023-11-04T17:23:01Z

Serial Port

← Older revision		Revision as of 17:23, 4 November 2023
Line 172:		Line 172:
	in and WHY.		in and WHY.

	=== Serial Port ===		=== OS_READBYTE and OS_SENDBYTE: Serial Port ===

	The serial port on the controller is currently based on the 6850		The serial port on the controller is currently based on the 6850
Line 185:		Line 185:

	As said, there are two calls OS_READBYTE and OS_SENDBYTE.		As said, there are two calls OS_READBYTE and OS_SENDBYTE.

			==== OS_READBYTE ====

	OS_READBYTE tests the serial input buffer and returns the character (if any		OS_READBYTE tests the serial input buffer and returns the character (if any
	in the A register), the c flag states whether there was a character		in the A register), the c flag states whether there was a character
	returned.		returned.

	~~<nowiki> Call : OS_READBYTE~~		{\|class="calltable"
	Entry : A, X, Y, c, z = undefined		\|Entry\|\|
	Exit : X, Y preserved		A, X, Y, c, z = undefined
	z = undefined		\|-
	if c = 1 (no character received)		\|Exit\|\|
	A is preserved		* X, Y preserved
	if c = 0 (character received)		* z = undefined
	A = character received~~</nowiki>~~		* if c = 1 (no character received)
			*: A is preserved
			* if c = 0 (character received)
			*: A = character received
			\|}

			==== OS_SENDBYTE ====

	OS_SENDBYTE sends the character in the A register out of the serial		OS_SENDBYTE sends the character in the A register out of the serial
	port, taking into consideration flow control etc.		port, taking into consideration flow control etc.

	~~<nowiki> Call : OS_SENDBYTE~~		{\|class="calltable"
	Entry : A = character to send		\|Entry\|\|
	X, Y, c, z = undefined		* A = character to send
	Exit : A, X, Y, c is preserved		* X, Y, c, z = undefined
	z = undefined~~</nowiki>~~		\|-
			\|Exit\|\|
			* A, X, Y, c is preserved
			* z = undefined
			\|}

	=== OS_READJOB and OS_SENDJOB ===		=== OS_READJOB and OS_SENDJOB ===

Benryves: /* Vectors */ Converted plaintext documentation to call tables

2023-11-04T09:41:35Z

Vectors: Converted plaintext documentation to call tables

Show changes

Benryves: /* OS_CALLOS */ Converted plaintext documentation to call tables

2023-11-04T09:22:29Z

OS_CALLOS: Converted plaintext documentation to call tables

Show changes

Benryves: /* CallOS */ Restructured OS_CALLOS headers for more consistent names and to include routine description

2023-11-04T08:54:51Z

CallOS: Restructured OS_CALLOS headers for more consistent names and to include routine description

Show changes