Documentation of kernel API

This commit is contained in:
Kyle J Cardoza 2024-07-08 23:25:58 -04:00
parent d7b98dbe86
commit 5d151c4e09
1 changed files with 15 additions and 15 deletions

View File

@ -17,7 +17,7 @@ successful. Any other value will indicate some specific error.
## 0x00: Terminate with Error Code ## 0x00: Terminate with Error Code
Arguments: Arguments:
C: 0x00 C: 0x00
X: Error code X: Error code
@ -317,51 +317,51 @@ and the X register will contain the number of bytes actually written. On error,
accumulator will contain a negative value indicating the specific error, and the X accumulator will contain a negative value indicating the specific error, and the X
register will contain the number of bytes actually written. register will contain the number of bytes actually written.
## 0x12: Seek in File ## 0x12: Seek in File
Arguments: Arguments:
C: 0x12 C: 0x12
X: Seek value X: Seek value
Y: Seek origin Y: Seek origin
0x00: Seek relative to the beginning of the file 0x00: Seek relative to the beginning of the file
0x01: Seek relative to the current position in the file 0x01: Seek relative to the current position in the file
0x02: Seek relative to the end of the file 0x02: Seek relative to the end of the file
Return value: Return value:
C: Status code C: Status code
X: New file position (31:16) X: New file position (31:16)
Y: New file position (15:0) Y: New file position (15:0)
This call moves the internal file pointer, the position in the specified file from This call moves the internal file pointer, the position in the specified file from
which data can be read or to which data can be written. On success, this call returns which data can be read or to which data can be written. On success, this call returns
STATUS_OK in C, and the new file position in X and Y. On error, C will contain a negative STATUS_OK in C, and the new file position in X and Y. On error, C will contain a negative
value indicating the specific error, and the new file position in X and Y. value indicating the specific error, and the new file position in X and Y.
## 0x13: Device I/O Control ## 0x13: Device I/O Control
This call performs driver-specific functions. This call performs driver-specific functions.
## 0x14: Delete File ## 0x14: Delete File
Arguments: Arguments:
C: 0x14 C: 0x14
X: Bank of pathname X: Bank of pathname
Y: Address of pathname Y: Address of pathname
Return Values: Return Values:
C: Status code C: Status code
This call attempts to delete the file indicated by the given NULL-terminated string, This call attempts to delete the file indicated by the given NULL-terminated string,
which must contain a fully-qualified pathname. On success, this C will contain which must contain a fully-qualified pathname. On success, this C will contain
STATUS_OK. On failure, C will contain a negative number indicating the specific STATUS_OK. On failure, C will contain a negative number indicating the specific
error. error.
## 0x15: Move File ## 0x15: Move File
Arguments: Arguments:
C: 0x15 C: 0x15
X: Bank of argument structure X: Bank of argument structure
Y: Address of argument structure Y: Address of argument structure
Return Values: Return Values:
C: Status code C: Status code
@ -374,5 +374,5 @@ Argument Structure:
}; };
This call attempts to move or rename the specified `source` file to `dest`. On success, This call attempts to move or rename the specified `source` file to `dest`. On success,
C will contain STATUS_OK. On error, C will contain a negative value indicating the C will contain STATUS_OK. On error, C will contain a negative value indicating the
specific error. specific error.