Apple-2-SW/A2osX
1
0
Fork 0
mirror of https://github.com/A2osX/A2osX.git synced 2024-10-10 12:23:45 +00:00
Code Issues Projects Releases Wiki Activity

Kernel version 0.8 : Docs...

Browse Source
This commit is contained in:
Rémy GIBERT 2016-10-26 22:46:16 +02:00
parent 2fd44770d2
commit aab7c77e4d
1 changed files with 91 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
_Docs/KERNEL.md
View File

@ -1,6 +1,7 @@
*** Auto generated by docgen.cmd *** *** Auto generated by docgen.cmd ***
#GetArgC #GetArgC
Returns argument count in the process command line.
##In: ##In:
+ none. + none.
@ -11,7 +12,7 @@
#GetArgA #GetArgA
##In: ##In:
+ none. + A = argument index.
##Out: ##Out:
+ CC : success + CC : success
@ -65,14 +66,43 @@ Prints C-Style String
##Out: ##Out:
#GetDevByIDA
##IN:
+ A = DevID
##OUT:
+ CC = OK, CS = ERROR
+ Y,A = devslot
+ note: X Unmodified
#GetDevIDByNameYA
##IN:
+ Y,A = Ptr to device name (PStr)
##OUT:
+ CC = OK, CS = ERROR
+ X = DEVID
+ Y,A = pDev
#GetDevInfoA
##IN:
+ A = DevID
##OUT:
+ CC = OK, CS = ERROR
+ Y,A = Ptr to S.DEVINFO
#OpenDirYA #OpenDirYA
##In: ##In:
+ Y,A = PATH (PSTR) + Y,A = PATH (PSTR)
##Out : ##Out:
+ CC : success + CC : success
+ Y,A = PTR to S.DIR + A = hDIR
+ CS : error + CS : error
+ A = EC + A = EC
@ -81,7 +111,7 @@ Prints C-Style String
##In: ##In:
+ A = hDIR + A = hDIR
##Out : ##Out:
+ CC : success + CC : success
+ X = hDIRENT + X = hDIRENT
+ Y,A = PTR to S.DIRENT + Y,A = PTR to S.DIRENT
@ -97,6 +127,16 @@ Prints C-Style String
##Out: ##Out:
+ none, always succeed. + none, always succeed.
#MKDirYA
##In:
+ Y,A = DIR name
##Out:
+ CC : success
+ CS : error
+ A = EC
#FOpen #FOpen
Open a file Open a file
@ -144,12 +184,12 @@ Read bytes from file
#Out: #Out:
+ Y,A = Bytes Written + Y,A = Bytes Written
#FFLUSHA #FFlushA
##In: ##In:
+ A = hFILE + A = hFILE
#FSEEK #FSeek
##In: ##In:
+ PUSHW = OffsetHi + PUSHW = OffsetHi
@ -157,7 +197,7 @@ Read bytes from file
+ PUSHB = From + PUSHB = From
+ PUSHB = hFILE + PUSHB = hFILE
#FTELLA #FTellA
##In: ##In:
+ A = hFILE + A = hFILE
@ -176,9 +216,9 @@ Read bytes from file
+ A =0 NOT EOF + A =0 NOT EOF
+ CS : + CS :
#REMOVEYA #RemoveYA
#RENAME #Rename
Rename a file Rename a file
##In : ##In :
@ -187,7 +227,7 @@ Rename a file
##Out : ##Out :
#STAT #Stat
Return information about a file Return information about a file
##In : ##In :
@ -196,6 +236,47 @@ Return information about a file
##Out : ##Out :
#FileSearch
##In:
+ PUSHW = PSTR to Search Path (PSTRING) %LIB%;/SYS/SLIB
+ PUSHW = PSTR to File Name (PSTRING)
#Out:
+ Y,A = PSTR to FilePath (PSTRING)
+ X = hMem to FilePath
#GetFullPathYA
##In :
+ Y,A = Filename (PSTRING)
#Out :
+ Y,A = FullPath (PSTRING)
+ X = hMem of FullPath
#LoadFile
##In:
+ PUSHW = AUXTYPE (Handled by....
+ PUSHB = TYPE ...
+ PUSHB = MODE ...
+ PUSHW = PATH ...FOPEN)
##Out:
+ Y,A = File Length
+ X = hMem of Loaded File
#SaveFile
##In:
+ PUSHW = SrcLen
+ PUSHW = SrcPtr
+ PUSHW = AUXTYPE (Handled by....
+ PUSHB = TYPE ...
+ PUSHB = MODE ...
+ PUSHW = PATH ...FOPEN)
#GetMem #GetMem
##In: ##In: