From 5d151c4e094f410b6120a925c45b6b9a33c03db8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kyle=20J=C2=A0Cardoza?= Date: Mon, 8 Jul 2024 23:25:58 -0400 Subject: [PATCH] Documentation of kernel API --- doc/syscalls.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/syscalls.md b/doc/syscalls.md index d3434de..0f0681d 100644 --- a/doc/syscalls.md +++ b/doc/syscalls.md @@ -17,7 +17,7 @@ successful. Any other value will indicate some specific error. ## 0x00: Terminate with Error Code -Arguments: +Arguments: C: 0x00 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 register will contain the number of bytes actually written. -## 0x12: Seek in File +## 0x12: Seek in File Arguments: C: 0x12 X: Seek value Y: Seek origin 0x00: Seek relative to the beginning of the file - 0x01: Seek relative to the current position in the file - 0x02: Seek relative to the end of the file + 0x01: Seek relative to the current position in the file + 0x02: Seek relative to the end of the file Return value: C: Status code 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 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 -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. -## 0x14: Delete File +## 0x14: Delete File Arguments: C: 0x14 X: Bank of pathname - Y: Address of pathname + Y: Address of pathname Return Values: C: Status code 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 -STATUS_OK. On failure, C will contain a negative number indicating the specific +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 error. ## 0x15: Move File Arguments: - C: 0x15 - X: Bank of argument structure - Y: Address of argument structure + C: 0x15 + X: Bank of argument structure + Y: Address of argument structure Return Values: C: Status code @@ -374,5 +374,5 @@ Argument Structure: }; 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.