PsiFS: SWI Calls

PsiFS_Get

PsiFS_Get
(SWI &520C3)

Read a PsiFS option or status value

On entry: R0 = option or status value to read

If the value specified by R0 is a string

R1 = pointer to buffer to contain null terminated string value

R2 = size of buffer

On exit: If the value specified by R0 is numeric

R1 = value of the option

If the value specified by R0 is a string

R2 =

number of spare bytes in the buffer including the null terminator, i.e.:

R2 > 0	implies there are (R2-1) completely unused bytes in the buffer; so R2=1 implies there are 0 unused bytes in the buffer, and therefore the terminator just fitted
R2 < 1	implies there are (1-R2) too many bytes to fit in the buffer, which has consequently not been filled in; so R2=0 implies there is 1 byte too many - the terminator - to fit in the buffer

Interrupts: Interrupt status is undefined
Fast interrupts are enabled

Processor mode: Processor is in SVC mode

Re-entrancy: SWI is not re-entrant

Use:

This call reads a PsiFS option or status value. An error may be returned if an attempt is made to read the value of an option that is meaningless for the current mode of operation.

The values that may be read are:

R0 Type Option

&0 numeric mode of operation

&100 string name of the serial block driver

&101 numeric serial block driver port number

&102 numeric serial block driver baud rate

&103 string optional extra serial block driver options

&104 numeric automatic baud rate identification mode

&110 numeric clock synchronization mode

&200 numeric number of bytes of serial data received

&201 numeric number of bytes of serial data transmitted

&210 numeric number of valid protocol frames received

&211 numeric number of invalid protocol frames received

&212 numeric number of retries for received protocol frames

&214 numeric number of protocol frames transmitted

&216 numeric number of retries for transmitted protocol frames

&1000 numeric status of the remote link

&1010 numeric type of the remote machine

&1011 string description of the remote machine type

&1012 numeric language of the remote machine

&1018 numeric major version of the remote machine operating system

&1019 numeric minor version of the remote machine operating system

&101A numeric build of remote machine operating system

&1020 numeric low word of the unique identifier of the remote machine

&1021 numeric high word of the unique identifier of the remote machine

&1030 string owner information of the remote machine

&11xx numeric status of the specified remote drive

&12xx string name of the specified remote drive

&13xx numeric unique identifier of the specified remote drive

&1800 numeric status of the main battery

&1801 numeric voltage of the main battery

&1802 numeric maximum voltage of the main battery

&1810 numeric status of the backup battery

&1811 numeric voltage of the backup battery

&1812 numeric maximum voltage of the backup battery

&1820 numeric status of external power

&2000 numeric status of the printer mirror

&2001 string name of the printer mirror destination

If a string value is specified this may be used as a two-pass process:

On entry, set R0 to specify the value to read, and R1 and R2 (the pointer to, and the size of, the buffer) to zero. On exit, R2 = -(length of string)
Claim a buffer of the right size (1-R2, not just -R2, as a space is needed for the terminator). On entry, ensure that R0 still specifies the value to read, that R1 is set to point to the buffer, and R2 contains the lenght of the buffer. On exit the buffer should be filled in, and R2 should be 1; but check to make sure.

Related SWIs: PsiFS_Set, PsiFS_Mode

Related vectors: None

PsiFS_Get &0
(SWI &520C3)

Get the mode of operation

On entry: R0 = &0

On exit: R1 = mode of operation

Use:

This call reads the current mode of operation. The possible values are:

Value	Meaning
0	inactive
1	remote link mode
2	printer mirror mode

`PsiFS_Get &100` `(SWI &520C3)`
	Get the serial block driver name

On entry:	R0 =	&100
	R1 =	pointer to buffer to contain null terminated serial block driver name
	R2 =	size of buffer

On exit:	R2 =	number of spare bytes in the buffer including the null terminator

Use:	This call reads the name of the configured serial block driver.

`PsiFS_Get &101` `(SWI &520C3)`
	Get the serial block driver port number

On entry:	R0 =	&101

On exit:	R1 =	port number (0 for the first)

Use:	This call reads the configured serial block driver port number.

`PsiFS_Get &102` `(SWI &520C3)`
	Get the serial block driver baud rate

On entry:	R0 =	&102

On exit:	R1 =	baud rate

Use:	This call reads the configured serial block driver baud rate. The actual baud rate used may be different if either the requested baud rate is not available or automatic baud rate identification is active.

`PsiFS_Get &103` `(SWI &520C3)`
	Get the serial block driver options

On entry:	R0 =	&103
	R1 =	pointer to buffer to contain null terminated serial block driver options
	R2 =	size of buffer

On exit:	R2 =	number of spare bytes in the buffer including the null terminator

Use:	This call reads the optional parameter string of the configured serial block driver.

`PsiFS_Get &104` `(SWI &520C3)`
	Get the automatic baud rate identification mode

On entry:	R0 =	&104

On exit:	R1 =	automatic baud rate identification (0 disables)

Use:	This call reads whether automatic baud rate identification is enabled. Only the remote link is affected; the printer mirror always uses the configured baud rate.

`PsiFS_Get &110` `(SWI &520C3)`
	Get the clock synchronization mode

On entry:	R0 =	&110

On exit:	R1 =	clock synchronization mode (0 disables)

Use:	This call reads whether synchronization of clocks on connection of the remote link is enabled. This only affects EPOC devices; it is not possible to synchronize the clock of SIBO devices.

`PsiFS_Get &200` `(SWI &520C3)`
	Get the number of bytes of serial data received

On entry:	R0 =	&200

On exit:	R1 =	number of bytes of serial data received

Use:	This call reads the number of bytes of serial data received since the remote link or printer mirror was last enabled.

`PsiFS_Get &201` `(SWI &520C3)`
	Get the number of bytes of serial data transmitted

On entry:	R0 =	&200

On exit:	R1 =	number of bytes of serial data trasmitted

Use:	This call reads the number of bytes of serial data transmitted since the remote link or printer mirror was last enabled.

`PsiFS_Get &210` `(SWI &520C3)`
	Get the number of valid protocol frames received

On entry:	R0 =	&210

On exit:	R1 =	number of valid protocol frames received

Use:	This call reads the number of valid protocol frames received since the remote link was last enabled.

`PsiFS_Get &211` `(SWI &520C3)`
	Get the number of invalid protocol frames received

On entry:	R0 =	&211

On exit:	R1 =	number of invalid protocol frames received

Use:	This call reads the number of invalid protocol frames received since the remote link was last enabled.

`PsiFS_Get &212` `(SWI &520C3)`
	Get the number of retries for received protocol frames

On entry:	R0 =	&212

On exit:	R1 =	number of retries for received protocol frames

Use:	This call reads the number of retries for received protocol frames since the remote link was last enabled.

`PsiFS_Get &214` `(SWI &520C3)`
	Get the number of protocol frames transmitted

On entry:	R0 =	&214

On exit:	R1 =	number of protocol frames transmitted

Use:	This call reads the number of protocol frames transmitted since the remote link was last enabled.

`PsiFS_Get &216` `(SWI &520C3)`
	Get the number of retries for transmitted protocol frames

On entry:	R0 =	&216

On exit:	R1 =	number of retries for transmitted protocol frames

Use:	This call reads the number of retries for transmitted protocol frames since the remote link was last enabled.

PsiFS_Get &1000
(SWI &520C3)

Get the status of the remote link

On entry: R0 = &1000

On exit: R1 = remote link status

Use:

This call reads the status of the remote link. The bits of the result have the following meaning:

Bit	Meaning when set
0	remote link active
4	connected to a SIBO device
5	connected to an EPOC device

PsiFS_Get &1010
(SWI &520C3)

Get the type of the remote machine

On entry: R0 = &1010

On exit: R1 = type of the remote machine

Use:

This call reads the type of the remote machine. The possible values are:

Value	Meaning when set
&00	Unknown
&01	PC
&02	MC
&03	HC
&04	Series 3
&05	Series 3a, 3c, or 3mx
&06	Workabout
&07	Sienna
&08	Series 3c
&20	Series 5
&21	WinC

`PsiFS_Get &1011` `(SWI &520C3)`
	Get the description of the remote machine type

On entry:	R0 =	&1011
	R1 =	pointer to buffer to contain null terminated description
	R2 =	size of buffer

On exit:	R2 =	number of spare bytes in the buffer including the null terminator

Use:	This call reads the description of the remote machine type.

PsiFS_Get &1012
(SWI &520C3)

Get the language of the remote machine

On entry: R0 = &1012

On exit: R1 = language

Use:

This call reads the language of the remote machine. The possible values are:

Value	Meaning
&00	Test
&01	English
&02	French
&03	German
&04	Spanish
&05	Italian
&06	Swedish
&07	Danish
&08	Norwegian
&09	Finnish
&0A	American
&0B	Swiss French
&0C	Swiss German
&0D	Portuguese
&0E	Turkish
&0F	Icelandic
&10	Russian
&11	Hungarian
&12	Dutch
&13	Belgian Flemish
&14	Australian
&15	Belgian French
&16	Austrian
&17	New Zealand
&18	International French
&19	Czech
&1A	Slovak
&1B	Polish
&1C	Slovenian

This value is only available for EPOC devices.

`PsiFS_Get &1018` `(SWI &520C3)`
	Get the major version of the remote machine operating system

On entry:	R0 =	&1018

On exit:	R1 =	major version

Use:	This call reads the major version of the remote machine operating system. This value is only available for EPOC devices.

`PsiFS_Get &1019` `(SWI &520C3)`
	Get the minor version of the remote machine operating system

On entry:	R0 =	&1019

On exit:	R1 =	minor version

Use:	This call reads the minor version of the remote machine operating system. This value is only available for EPOC devices.

`PsiFS_Get &101A` `(SWI &520C3)`
	Get the build of the remote machine operating system

On entry:	R0 =	&101A

On exit:	R1 =	build

Use:	This call reads the build of the remote machine operating system. This value is only available for EPOC devices.

`PsiFS_Get &1020` `(SWI &520C3)`
	Get the low word of the unique identifier of the remote machine

On entry:	R0 =	&1020

On exit:	R1 =	low word of unique identifier

Use:	This call reads the low word of the unique identifier of the remote machine. This value is only available for EPOC devices.

`PsiFS_Get &1021` `(SWI &520C3)`
	Get the high word of the unique identifier of the remote machine

On entry:	R0 =	&1021

On exit:	R1 =	high word of unique identifier

Use:	This call reads the high word of the unique identifier of the remote machine. This value is only available for EPOC devices.

`PsiFS_Get &1030` `(SWI &520C3)`
	Get the owner information of the remote machine

On entry:	R0 =	&1030
	R1 =	pointer to buffer to contain null terminated owner information
	R2 =	size of buffer

On exit:	R2 =	number of spare bytes in the buffer including the null terminator

Use:	This call reads the owner information of the remote machine.

PsiFS_Get &11xx
(SWI &520C3)

Get the status of the specified remote drive

On entry: R0 = &1100 + drive

On exit: R1 = remote drive status

Use:

This call reads the status of a single remote drive. The bits of the result have the following meaning:

Bit	Meaning when set
0	drive present
8	ROM drive

The drive may be specified in one of three ways:

a zero based index (0 for drive A, through to 25 for drive Z)
the ASCII code of the drive letter in upper case (65 for drive A, through to 90 for drive Z)
the ASCII code of the drive letter in lower case (97 for drive A, through to 122 for drive Z)

`PsiFS_Get &12xx` `(SWI &520C3)`
	Get the name of the specified remote drive

On entry:	R0 =	&1200 + drive
	R1 =	pointer to buffer to contain null terminated drive name
	R2 =	size of buffer

On exit:	R2 =	number of spare bytes in the buffer including the null terminator

Use:	This call reads the name of a single remote drive. The drive may be specified in one of three ways: a zero based index (0 for drive A, through to 25 for drive Z) the ASCII code of the drive letter in upper case (65 for drive A, through to 90 for drive Z) the ASCII code of the drive letter in lower case (97 for drive A, through to 122 for drive Z)

`PsiFS_Get &13xx` `(SWI &520C3)`
	Get the unique identifier of the specified remote drive

On entry:	R0 =	&1300 + drive

On exit:	R1 =	remote drive unique identifier

Use:	This call reads the unique identifier of a single remote drive.

PsiFS_Get &1800
(SWI &520C3)

Get the status of the main battery

On entry: R0 = &1800

On exit: R1 = main battery status

Use:

This call reads the status of the main battery. The possible values are:

Value	Meaning
0	dead
1	very low
2	low
3	good

This value is only available for EPOC devices.

`PsiFS_Get &1801` `(SWI &520C3)`
	Get the voltage of the main battery

On entry:	R0 =	&1801

On exit:	R1 =	main battery voltage

Use:	This call reads the voltage of the main battery in milli-volts. This value is only available for EPOC devices.

`PsiFS_Get &1802` `(SWI &520C3)`
	Get the maximum voltage of the main battery

On entry:	R0 =	&1802

On exit:	R1 =	main battery maximum voltage

Use:	This call reads the maximum voltage of the main battery in milli-volts. This value is only available for EPOC devices.

PsiFS_Get &1810
(SWI &520C3)

Get the status of the backup battery

On entry: R0 = &1810

On exit: R1 = backup battery status

Use:

This call reads the status of the backup battery. The possible values are:

Value	Meaning
0	dead
1	very low
2	low
3	good

This value is only available for EPOC devices.

`PsiFS_Get &1811` `(SWI &520C3)`
	Get the voltage of the backup battery

On entry:	R0 =	&1811

On exit:	R1 =	backup battery voltage

Use:	This call reads the voltage of the backup battery in milli-volts. This value is only available for EPOC devices.

`PsiFS_Get &1812` `(SWI &520C3)`
	Get the maximum voltage of the backup battery

On entry:	R0 =	&1812

On exit:	R1 =	backup battery maximum voltage

Use:	This call reads the maximum voltage of the backup battery in milli-volts. This value is only available for EPOC devices.

`PsiFS_Get &1820` `(SWI &520C3)`
	Get the status of external power

On entry:	R0 =	&1820

On exit:	R1 =	status of external power (0 not present)

Use:	This call reads the status of external power. This value is only available for EPOC devices.

PsiFS_Get &2000
(SWI &520C3)

Get the status of the printer mirror

On entry: R0 = &2000

On exit: R1 = printer mirror status

Use:

This call reads the status of the printer mirror. The bits of the result have the following meaning:

Bit	Meaning when set
0	printer mirror active

`PsiFS_Get &2001` `(SWI &520C3)`
	Get the name of the printer mirror destination

On entry:	R0 =	&2001
	R1 =	pointer to buffer to contain null terminated printer mirror destination
	R2 =	size of buffer

On exit:	R2 =	number of spare bytes in the buffer including the null terminator

Use:	This call reads the name of the printer mirror destination.

[Contents] [Up]