Apple-2-SW/A2osX
1
0
Fork 0
mirror of https://github.com/A2osX/A2osX.git synced 2025-08-09 23:25:15 +00:00
Code Issues Projects Releases Wiki Activity

Kernel version 0.9 : API doc cleanup

Browse Source
This commit is contained in:
Rémy GIBERT
2017-03-30 10:55:55 +02:00
parent 5157cd75d3
commit d38f055562
4 changed files with 616 additions and 869 deletions
Download Patch File Download Diff File Expand all files Collapse all files

175
_Docs/KERNEL.md
View File

@@ -1,115 +1,80 @@
*** Auto generated by docgen.cmd *** *** Auto generated by docgen.cmd ***
#GetArgC #GetArgC
Returns argument count in the process command line. Returns argument count in the process command line.
##In: ##In:
+ none. + none.
##Out: ##Out:
+ A = Command line Arg Count (Including /path/cmd) + A = Command line Arg Count (Including /path/cmd)
#GetArgA #GetArgA
##In: ##In:
+ A = argument index. + A = argument index.
##Out: ##Out:
+ CC : success + CC : success
+ Y,A = PStr To Arg[A] + Y,A = PStr To Arg[A]
+ CS : Out Of Bound + CS : Out Of Bound
#FPutCAY #FPutCAY
Print A (char) to File Print A (char) to File
##In: ##In:
+ A : char to print + A : char to print
+ Y = hFILE + Y = hFILE
##Out: ##Out:
+ CC = success + CC = success
#PutCA #PutCA
Print A (char) to StdOut Print A (char) to StdOut
##In: ##In:
+ A : char to print + A : char to print
##Out: ##Out:
+ CC = success + CC = success
#FGetCA #FGetCA
Get char from File Get char from File
##In: ##In:
+ A = hFILE + A = hFILE
##Out: ##Out:
+ CC = success + CC = success
+ A = char + A = char
#GetC #GetC
Get char from StdIn Get char from StdIn
##In: ##In:
+ none. + none.
##Out: ##Out:
+ CC = success + CC = success
+ A = char + A = char
#FPutS #FPutS
Write String to FILE Write String to FILE
##In: ##In:
+ PUSHW : CPtr + PUSHW : CPtr
+ PUSHB : hFILE + PUSHB : hFILE
##Out: ##Out:
+ CC = success + CC = success
#PutSYA #PutSYA
Write String to StdOut Write String to StdOut
##In: ##In:
+ Y,A : CPtr + Y,A : CPtr
##Out: ##Out:
+ CC = success + CC = success
#FGetS #FGetS
Read String From FILE Read String From FILE
##In: ##In:
+ PUSHW : CPtr + PUSHW : CPtr
+ PUSHB : hFILE + PUSHB : hFILE
##Out: ##Out:
+ CC = success + CC = success
#GetSYA #GetSYA
Read String From StdIn Read String From StdIn
##In: ##In:
+ Y,A : CPtr + Y,A : CPtr
##Out: ##Out:
+ CC = success + CC = success
#SScanF #SScanF
Scan a PStr (in progress) Scan a PStr (in progress)
##In: ##In:
+ PUSHW PTR to target buffer + PUSHW PTR to target buffer
+ PUSHW PSTR pattern (ex: "%d.%d.%d.%d") + PUSHW PSTR pattern (ex: "%d.%d.%d.%d")
+ %d : byte + %d : byte
+ PUSHW PSTR to scan (ex: "192.168.1.5") + PUSHW PSTR to scan (ex: "192.168.1.5")
##Out: ##Out:
#PPrintFYA/CPrintFYA #PPrintFYA/CPrintFYA
Prints Pascal/C-Style String Prints Pascal/C-Style String
##In: ##In:
+ Y,A = PTR to PStr/CStr + Y,A = PTR to PStr/CStr
+ %a : pull 2 bytes to Print Access right String 'drwxrwxrwx' + %a : pull 2 bytes to Print Access right String 'drwxrwxrwx'
@@ -143,85 +108,60 @@ Prints Pascal/C-Style String
+ %11s : 'ABCDEFGH ' + %11s : 'ABCDEFGH '
+ %011s : 'ABCDEFGH000' + %011s : 'ABCDEFGH000'
+ %2f : '3.14' + %2f : '3.14'
##Out: ##Out:
+ CC : success + CC : success
+ CS : I/O error from COut + CS : I/O error from COut
#GetDevByIDA #GetDevByIDA
##IN: ##IN:
+ A = DevID + A = DevID
##OUT: ##OUT:
+ CC = OK, CS = ERROR + CC = OK, CS = ERROR
+ Y,A = DEVSLOT + Y,A = DEVSLOT
+ note: X Unmodified + note: X Unmodified
#GetDevByNameYA #GetDevByNameYA
##IN: ##IN:
+ Y,A = Ptr to device name (PStr) + Y,A = Ptr to device name (PStr)
##OUT: ##OUT:
+ CC = OK, CS = ERROR + CC = OK, CS = ERROR
+ X = DEVID + X = DEVID
+ Y,A = DEVSLOT + Y,A = DEVSLOT
#GetDevStatusA #GetDevStatusA
##IN: ##IN:
+ A = DevID + A = DevID
##OUT: ##OUT:
+ CC = OK, CS = ERROR + CC = OK, CS = ERROR
+ Y,A = Ptr to S.DEVINFO + Y,A = Ptr to S.DEVINFO
#MkNodYA #MkNodYA
return a hFile for a given Device Name return a hFile for a given Device Name
##IN: ##IN:
+ Y,A=DevName + Y,A=DevName
##OUT: ##OUT:
+ CC = OK, CS = ERROR + CC = OK, CS = ERROR
+ A = hFILE + A = hFILE
#MkNodA #MkNodA
return a hFile for a given Socket return a hFile for a given Socket
##IN: ##IN:
+ A=hSocket + A=hSocket
##OUT: ##OUT:
+ CC = OK, CS = ERROR + CC = OK, CS = ERROR
+ A = hFILE + A = hFILE
#MKFIFO #MKFIFO
return a S.FILE to a new FIFO return a S.FILE to a new FIFO
##IN: ##IN:
##OUT: ##OUT:
+ CC = OK, CS = ERROR + CC = OK, CS = ERROR
+ A = hFILE + A = hFILE
#OpenDirYA #OpenDirYA
##In: ##In:
+ Y,A = PATH (PSTR) + Y,A = PATH (PSTR)
##Out: ##Out:
+ CC : success + CC : success
+ A = hDIR + A = hDIR
+ CS : error + CS : error
+ A = EC + A = EC
#ReadDirA #ReadDirA
##In: ##In:
+ A = hDIR + A = hDIR
##Out: ##Out:
+ CC : success + CC : success
+ X = hDIRENT + X = hDIRENT
@@ -229,68 +169,45 @@ return a S.FILE to a new FIFO
+ CS : error + CS : error
+ A = EC + A = EC
+ note : A = 0 means no more entry + note : A = 0 means no more entry
#CloseDirA #CloseDirA
##In: ##In:
+ A = hDIR + A = hDIR
##Out: ##Out:
+ none, always succeed. + none, always succeed.
#MKDirYA #MKDirYA
##In: ##In:
+ Y,A = DIR name + Y,A = DIR name
##Out: ##Out:
+ CC : success + CC : success
+ CS : error + CS : error
+ A = EC + A = EC
#ExpandPStrYA #ExpandPStrYA
##In: ##In:
+ Y,A = PTR to String to Expand (PSTR) + Y,A = PTR to String to Expand (PSTR)
##Out: ##Out:
+ X = hMem to Expanded String (PSTR) + X = hMem to Expanded String (PSTR)
+ Y,A = PTR to Expanded String + Y,A = PTR to Expanded String
#PutEnvYA #PutEnvYA
##In: ##In:
+ Y,A = PTR to String NAME=VALUE (PSTR) + Y,A = PTR to String NAME=VALUE (PSTR)
##Out: ##Out:
#SetEnv #SetEnv
##In: ##In:
+ PUSHW = PTR To Value (PSTR) + PUSHW = PTR To Value (PSTR)
+ PUSHW = PTR To Name (PSTR) + PUSHW = PTR To Name (PSTR)
##Out: ##Out:
#GetEnvYA #GetEnvYA
##In: ##In:
+ Y,A = PTR to NAME (PSTR) + Y,A = PTR to NAME (PSTR)
##Out: ##Out:
+ CC : Y,A = PTR to VALUE (PSTR) + CC : Y,A = PTR to VALUE (PSTR)
+ CS : not found + CS : not found
#UnsetEnvYA #UnsetEnvYA
##In: ##In:
+ Y,A = PTR To Name (PSTR) + Y,A = PTR To Name (PSTR)
##Out: ##Out:
#FOpen #FOpen
Open a file Open a file
##In : ##In :
+ PUSHW = AUXTYPE + PUSHW = AUXTYPE
+ PUSHB = TYPE + PUSHB = TYPE
@@ -301,149 +218,105 @@ Open a file
+ SYS.FOpen.T : Open/Append in Text mode + SYS.FOpen.T : Open/Append in Text mode
+ SYS.FOpen.X : Create if not exists + SYS.FOpen.X : Create if not exists
+ PUSHW = PATH (PSTR) + PUSHW = PATH (PSTR)
##Out : ##Out :
+ CC : A = hFILE + CC : A = hFILE
+ CS : A = EC + CS : A = EC
#FCloseA #FCloseA
Close a file Close a file
##In : ##In :
+ A = hFILE + A = hFILE
##Out : ##Out :
#FReadA #FReadA
Read ONE byte from file Read ONE byte from file
##In : ##In :
+ A = hFILE + A = hFILE
##Out : ##Out :
+ A = Byte Read + A = Byte Read
#FWriteAY #FWriteAY
##In: ##In:
+ A = hFILE + A = hFILE
+ Y = char + Y = char
#Out: #Out:
+ Y,A = Bytes Written + Y,A = Bytes Written
#FRead #FRead
Read bytes from file Read bytes from file
##In : ##In :
+ PUSHW = Dest Ptr + PUSHW = Dest Ptr
+ PUSHW = Bytes To Read + PUSHW = Bytes To Read
+ PUSHB = hFILE + PUSHB = hFILE
##Out : ##Out :
+ Y,A = Bytes Read + Y,A = Bytes Read
#FWrite #FWrite
##In: ##In:
+ PUSHW = Src Ptr + PUSHW = Src Ptr
+ PUSHW = Bytes To Write + PUSHW = Bytes To Write
+ PUSHB = hFILE + PUSHB = hFILE
#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
+ PUSHW = OffsetLo + PUSHW = OffsetLo
+ PUSHB = From + PUSHB = From
+ PUSHB = hFILE + PUSHB = hFILE
#FTellA #FTellA
##In: ##In:
+ A = hFILE + A = hFILE
##Out: ##Out:
+ Y,A,X = Offset + Y,A,X = Offset
#FEOFA #FEOFA
##In: ##In:
+ A = hFILE + A = hFILE
##Out: ##Out:
+ CC : + CC :
+ A=0 EOF + A=0 EOF
+ A =0 NOT EOF + A =0 NOT EOF
+ CS : + CS :
#RemoveYA #RemoveYA
#Rename #Rename
Rename a file Rename a file
##In : ##In :
+ PUSHW = New Name + PUSHW = New Name
+ PUSHW = Old Name + PUSHW = Old Name
##Out : ##Out :
#Stat #Stat
Return information about a file Return information about a file
##In : ##In :
+ PUSHW = PTR to S.STAT buffer + PUSHW = PTR to S.STAT buffer
+ PUSHW = PTR to Filename (PSTR) + PUSHW = PTR to Filename (PSTR)
##Out : ##Out :
#FileSearch #FileSearch
Search a file in the provided PATH list Search a file in the provided PATH list
And return, if found, the full path to it. And return, if found, the full path to it.
##In: ##In:
+ PUSHW = Ptr to Search Path (PSTR) %LIB%;/SYS/SLIB + PUSHW = Ptr to Search Path (PSTR) %LIB%;/SYS/SLIB
+ PUSHW = Ptr to File Name (PSTR) + PUSHW = Ptr to File Name (PSTR)
##Out: ##Out:
+ CC : success + CC : success
+ Y,A = PSTR to FilePath (PSTR) + Y,A = PSTR to FilePath (PSTR)
+ X = hMem to FilePath + X = hMem to FilePath
+ CS : not found + CS : not found
#GetFullPathYA #GetFullPathYA
##In : ##In :
+ Y,A = Filename (PSTR) + Y,A = Filename (PSTR)
##Out : ##Out :
+ CC : success + CC : success
+ Y,A = FullPath (PSTR) + Y,A = FullPath (PSTR)
+ X = hMem of FullPath + X = hMem of FullPath
+ CS : A = Error Code + CS : A = Error Code
#LoadFile #LoadFile
##In: ##In:
+ PUSHW = AUXTYPE (Handled by.... + PUSHW = AUXTYPE (Handled by....
+ PUSHB = TYPE ... + PUSHB = TYPE ...
+ PUSHB = MODE ... + PUSHB = MODE ...
+ PUSHW = PATH ...FOpen) + PUSHW = PATH ...FOpen)
##Out: ##Out:
+ Y,A = File Length + Y,A = File Length
+ X = hMem of Loaded File + X = hMem of Loaded File
#SaveFile #SaveFile
##In: ##In:
+ PUSHW = SrcLen + PUSHW = SrcLen
+ PUSHW = SrcPtr + PUSHW = SrcPtr
@@ -451,144 +324,100 @@ And return, if found, the full path to it.
+ PUSHB = TYPE ... + PUSHB = TYPE ...
+ PUSHB = MODE ... + PUSHB = MODE ...
+ PUSHW = PATH ...FOpen) + PUSHW = PATH ...FOpen)
#GetMem #GetMem
##In: ##In:
+ PUSHW = Size Requested + PUSHW = Size Requested
+ PUSHB = Options + PUSHB = Options
+ S.MEM.F.INIT0 : init memory with 00 + S.MEM.F.INIT0 : init memory with 00
+ S.MEM.F.ALIGN : page aligned + S.MEM.F.ALIGN : page aligned
##Out: ##Out:
+ CC : success + CC : success
+ YA = PTR to Mem + YA = PTR to Mem
* X = hMem * X = hMem
+ CS : + CS :
+ A = EC + A = EC
#FreeMemA #FreeMemA
##In: ##In:
+ A = hMem To Free + A = hMem To Free
##Out: ##Out:
+ none. + none.
+ (X,Y unmodified) + (X,Y unmodified)
#GetMemPtrA #GetMemPtrA
##In: ##In:
+ A = hMem + A = hMem
##Out: ##Out:
+ Y,A = PTR to MemBlock + Y,A = PTR to MemBlock
+ (X unmodified) + (X unmodified)
#GetMemByIDA #GetMemByIDA
##In: ##In:
+ A = hMem + A = hMem
##Out: ##Out:
+ Y,A = ZPMemMgrSPtr = PTR to S.MEM + Y,A = ZPMemMgrSPtr = PTR to S.MEM
+ X unmodified + X unmodified
#GetMemStatYA #GetMemStatYA
##In: ##In:
+ Y,A = 24 bytes buffer + Y,A = 24 bytes buffer
##Out: ##Out:
+ Buffer filled with memory stats + Buffer filled with memory stats
#ExecProcessNewEnvYA #ExecProcessNewEnvYA
#ExecProcessYA (Blocking Parent PID) #ExecProcessYA (Blocking Parent PID)
#CreateProcessNewEnvYA #CreateProcessNewEnvYA
#CreateProcessYA (Non Blocking) #CreateProcessYA (Non Blocking)
##In: ##In:
+ Y,A = PTR To Cmd Line + Y,A = PTR To Cmd Line
##Out: ##Out:
+ A = Child PSID + A = Child PSID
#GetPSByIDA #GetPSByIDA
##In : ##In :
+ A = PID + A = PID
##Out : ##Out :
+ Y,A = PTR to TSKSLOT + Y,A = PTR to TSKSLOT
#Sleep #Sleep
Make current process suspend until next RUN Make current process suspend until next RUN
##In : ##In :
+ (none) + (none)
##Out : ##Out :
+ (none) + (none)
#NewPStrYA #NewPStrYA
Create a new copy of PSTR Create a new copy of PSTR
##In: ##In:
+ Y,A = PTR to buffer + Y,A = PTR to buffer
##Out: ##Out:
+ CC : success + CC : success
+ Y,A = PTR to String + Y,A = PTR to String
+ X = hMem (PSTR) + X = hMem (PSTR)
+ CS : error + CS : error
+ A = SYS error code + A = SYS error code
#PStrCpy #PStrCpy
Copy string Copy string
##In: ##In:
+ PUSHW = Ptr to SRC (PSTR) + PUSHW = Ptr to SRC (PSTR)
+ PUSHW = Ptr to DST (PSTR) + PUSHW = Ptr to DST (PSTR)
##Out: ##Out:
+ DST = SRC (PSTR) + DST = SRC (PSTR)
#PStrCat #PStrCat
Append SRC to DST Append SRC to DST
##In: ##In:
+ PUSHW = Ptr to SRC (PSTR) + PUSHW = Ptr to SRC (PSTR)
+ PUSHW = Ptr to DST (PSTR) + PUSHW = Ptr to DST (PSTR)
##Out: ##Out:
+ DST = DST+SRC (PSTR) + DST = DST+SRC (PSTR)
#PStrMatch #PStrMatch
Compare a String against pattern Compare a String against pattern
##In: ##In:
+ PUSHW = PTR to Pattern (e.g. '*test?.txt') + PUSHW = PTR to Pattern (e.g. '*test?.txt')
+ PUSHW = PTR to Src String + PUSHW = PTR to Src String
##Out: ##Out:
+ CC : match + CC : match
+ CS : no match + CS : no match
#PStrUprYA/PStrLwrYA #PStrUprYA/PStrLwrYA
Convert string to UPPERCASE/lowercase Convert string to UPPERCASE/lowercase
##In: ##In:
+ Y,A = PTR to String (PSTR) + Y,A = PTR to String (PSTR)
##Out: ##Out:
+ Uppercased/lowercased String in Buffer + Uppercased/lowercased String in Buffer
#PStrFTime #PStrFTime
Convert S.TIME struct to PSTR Convert S.TIME struct to PSTR
##In: ##In:
+ PUSHW = Dst PTR To PSTR Buf + PUSHW = Dst PTR To PSTR Buf
+ PUSHW = Src PTR To Format String + PUSHW = Src PTR To Format String
@@ -607,16 +436,12 @@ Convert S.TIME struct to PSTR
+ %y : Year, last two digits (00-99) + %y : Year, last two digits (00-99)
+ %Y : Year four digits 2001 + %Y : Year four digits 2001
+ PUSHW = Src PTR To S.Time + PUSHW = Src PTR To S.Time
##Out: ##Out:
+ none. always succeed. + none. always succeed.
#PStr2StrArrayYA #PStr2StrArrayYA
Convert a PSTR (e.g. : command Line) to a Array of PSTRs (Args[]) Convert a PSTR (e.g. : command Line) to a Array of PSTRs (Args[])
##In: ##In:
+ Y,A = PTR to String + Y,A = PTR to String
##Out: ##Out:
+ CC : success + CC : success
+ Y,A = PTR to StrArray + Y,A = PTR to StrArray

11
_Docs/LIBBLKDEV.md
View File

@@ -1,17 +1,12 @@
*** Auto generated by docgen.cmd *** *** Auto generated by docgen.cmd ***
#GetProDOSCatSize #GetProDOSCatSize
+ Compute space needed for ProDOS Catalog + Compute space needed for ProDOS Catalog
##In : ##In :
+ PUSHW = DevSize (in 512b blocks) + PUSHW = DevSize (in 512b blocks)
##Out : ##Out :
+ X=BlockCount (max 22) + X=BlockCount (max 22)
+ A=PageCount (max 44) + A=PageCount (max 44)
#BuildProDOSCat #BuildProDOSCat
##In : ##In :
+ PUSHW = DevSize (in 512b blocks) + PUSHW = DevSize (in 512b blocks)
+ PUSHW = VolName (PSTR) + PUSHW = VolName (PSTR)
@@ -24,28 +19,22 @@
+ absolute MAX DstBuf size= + absolute MAX DstBuf size=
+ 7 for Disk II(280blk),3.5(1600),3.5HD(2880) + 7 for Disk II(280blk),3.5(1600),3.5HD(2880)
+ 22 for 32mb Hardisk... + 22 for 32mb Hardisk...
#TrkW16s #TrkW16s
Write a track (16 sectors) Write a track (16 sectors)
##In: ##In:
+ PUSHW = Ptr to 16*256 buffer + PUSHW = Ptr to 16*256 buffer
+ PUSHB = TrackNum * 4 : 0->140+ + PUSHB = TrackNum * 4 : 0->140+
+ PUSHB = DSSS0000 + PUSHB = DSSS0000
##Out: ##Out:
+ CC : success + CC : success
+ CS : A = Error + CS : A = Error
+ A=0, currently starting/seeking... + A=0, currently starting/seeking...
#TrkWNIB #TrkWNIB
Write a track (NIBBLE) Write a track (NIBBLE)
##In: ##In:
+ PUSHW = Ptr to NIBBLE buffer (0 ended) + PUSHW = Ptr to NIBBLE buffer (0 ended)
+ PUSHB = TrackNum * 4 : 0->140+ + PUSHB = TrackNum * 4 : 0->140+
+ PUSHB = DSSS0000 + PUSHB = DSSS0000
##Out: ##Out:
+ CC : success + CC : success
+ CS : A = Error + CS : A = Error

61
_Docs/LIBTCPIP.md
View File

@@ -1,187 +1,126 @@
*** Auto generated by docgen.cmd *** *** Auto generated by docgen.cmd ***
#ARP.Clear #ARP.Clear
+ Clear ARP Cache + Clear ARP Cache
##In : ##In :
##Out : ##Out :
#ARP.Query #ARP.Query
+ Query ARP Cache and returns HW address + Query ARP Cache and returns HW address
##In: ##In:
+ PUSHW PTR to MAC (to fill) + PUSHW PTR to MAC (to fill)
+ PUSHW PTR to IP + PUSHW PTR to IP
##Out: ##Out:
+ CC: hit: MAC filled + CC: hit: MAC filled
+ CS: missed + CS: missed
#ARP.Add #ARP.Add
+ Add a static ARP cache record + Add a static ARP cache record
##In: ##In:
+ PUSHW PTR to MAC + PUSHW PTR to MAC
+ PUSHW PTR to IP + PUSHW PTR to IP
#ARP.GetCache #ARP.GetCache
+ Return a Ptr to ARP Cache Table + Return a Ptr to ARP Cache Table
##In: ##In:
##Out: ##Out:
+ Y,A = PTR to ARP.CACHE + Y,A = PTR to ARP.CACHE
#DNS.Clear #DNS.Clear
+ Clear DNS Cache + Clear DNS Cache
##In : ##In :
##Out : ##Out :
#DNS.Query #DNS.Query
+ Query DNS for specified host + Query DNS for specified host
##In: ##In:
+ PUSHW = PTR to IP to fill with cached data + PUSHW = PTR to IP to fill with cached data
* PUSHW = hostname PTR to PSTR * PUSHW = hostname PTR to PSTR
##Out: ##Out:
+ CC: hit: IP filled with address + CC: hit: IP filled with address
+ CS: missed + CS: missed
#DNS.Add #DNS.Add
+ Add a static DNS record + Add a static DNS record
##In: ##In:
+ PUSHW = PTR to IP + PUSHW = PTR to IP
+ PUSHW = hostname PSTR to Add + PUSHW = hostname PSTR to Add
#DNS.GetCache #DNS.GetCache
+ Return a Ptr to DNS Cache Table + Return a Ptr to DNS Cache Table
##In: ##In:
##Out: ##Out:
+ Y,A = PTR to DNS.CACHE + Y,A = PTR to DNS.CACHE
#SKT.New #SKT.New
+ Create a new socket + Create a new socket
##In : ##In :
+ PUSHW = PTR to S.SOCKET template + PUSHW = PTR to S.SOCKET template
##Out : ##Out :
+ YA = PTR to new S.SOCKET + YA = PTR to new S.SOCKET
+ X = hSocket + X = hSocket
#SKT.CloseA #SKT.CloseA
+ Close socket + Close socket
##In : ##In :
+ A = hSocket + A = hSocket
##Out : ##Out :
#SKT.GetA #SKT.GetA
+ Get Ptr to socket + Get Ptr to socket
##In : ##In :
+ A = hSocket + A = hSocket
##Out : ##Out :
+ Y,A = pS.SOCKET + Y,A = pS.SOCKET
#SKT.GetTable #SKT.GetTable
+ Get socket table + Get socket table
##In : ##In :
##Out : ##Out :
+ Y,A = pS.SOCKET + Y,A = pS.SOCKET
#SKT.AcceptA #SKT.AcceptA
+ Check for an incoming connection + Check for an incoming connection
##In : ##In :
+ A = hListeningSocket + A = hListeningSocket
##Out : ##Out :
+ A = hSocket + A = hSocket
#SKT.MkNodA #SKT.MkNodA
+ Create a new file from TCP socket + Create a new file from TCP socket
##In : ##In :
+ A = hSocket + A = hSocket
##Out : ##Out :
+ A = hFile + A = hFile
#SKT.Write (DGRAM,STREAM,RAW) #SKT.Write (DGRAM,STREAM,RAW)
+ Send block of data + Send block of data
##In : ##In :
+ PUSHB = hSocket + PUSHB = hSocket
+ PUSHW = pBuf + PUSHW = pBuf
+ PUSHW = len + PUSHW = len
##Out : ##Out :
#SKT.ReadA (DGRAM,RAW) #SKT.ReadA (DGRAM,RAW)
##In : ##In :
+ A = hSocket + A = hSocket
##Out : ##Out :
+ A = hFrame + A = hFrame
#SKT.PutC (STREAM) #SKT.PutC (STREAM)
+ Write a Char To Stream + Write a Char To Stream
##In : ##In :
+ PUSHB = hSocket + PUSHB = hSocket
+ PUSHB = Char + PUSHB = Char
##Out : ##Out :
#SKT.PutS (STREAM) #SKT.PutS (STREAM)
+ Write Line in pBuf + Write Line in pBuf
##In : ##In :
+ PUSHB = hSocket + PUSHB = hSocket
+ PUSHW = PSTR + PUSHW = PSTR
##Out : ##Out :
#SKT.GetCA (STREAM) #SKT.GetCA (STREAM)
+ Read a Char From Stream in A + Read a Char From Stream in A
##In : ##In :
+ A = hSocket + A = hSocket
##Out : ##Out :
+ A = char + A = char
#SKT.GetS (STREAM) #SKT.GetS (STREAM)
+ Read a CR terminated Line in pBuf + Read a CR terminated Line in pBuf
##In : ##In :
+ PUSHB = hSocket + PUSHB = hSocket
+ PUSHW = pBuf + PUSHW = pBuf
+ PUSHW = len + PUSHW = len
##Out : ##Out :
+ Y,A = bytes read + Y,A = bytes read
#SKT.Read (STREAM) #SKT.Read (STREAM)
+ Read data in pBuf + Read data in pBuf
##In : ##In :
+ PUSHB = hSocket + PUSHB = hSocket
+ PUSHW = pBuf + PUSHW = pBuf
+ PUSHW = len + PUSHW = len
##Out : ##Out :
+ Y,A = bytes transfered + Y,A = bytes transfered

8
_Tools/docgen.cmd
View File

@@ -16,23 +16,18 @@ set /a c=0
set DOCFILE=%~dp0..\_Docs\KERNEL.md set DOCFILE=%~dp0..\_Docs\KERNEL.md
set SRCDIR=%~dp0..\SYS set SRCDIR=%~dp0..\SYS
set FILTER=KERNEL.S*.txt set FILTER=KERNEL.S*.txt
Call :SCAN Call :SCAN
set DOCFILE=%~dp0..\_Docs\LIBTCPIP.md set DOCFILE=%~dp0..\_Docs\LIBTCPIP.md
set SRCDIR=%~dp0..\LIB set SRCDIR=%~dp0..\LIB
set FILTER=LIBTCPIP.S*.txt set FILTER=LIBTCPIP.S*.txt
Call :SCAN Call :SCAN
set DOCFILE=%~dp0..\_Docs\LIBBLKDEV.md set DOCFILE=%~dp0..\_Docs\LIBBLKDEV.md
set SRCDIR=%~dp0..\LIB set SRCDIR=%~dp0..\LIB
set FILTER=LIBBLKDEV.S*.txt set FILTER=LIBBLKDEV.S*.txt
Call :SCAN Call :SCAN
set FILTER=LIBTCPIP.S*.txt
echo. echo.
echo All done : !c! Files scanned. echo All done : !c! Files scanned.
echo. echo.
@@ -43,7 +38,7 @@ exit 0
:SCAN :SCAN
echo *** Auto generated by docgen.cmd *** >!DOCFILE! (echo *** Auto generated by docgen.cmd *** )>!DOCFILE!
echo. echo.
echo Scanning %FILTER% Files... echo Scanning %FILTER% Files...
@@ -71,7 +66,6 @@ for /f %%F in ('dir /b /ogn "%SRCDIR%\%FILTER%"') do (
if "!line:~0,4!" EQU "* " set LINE= + !LINE:~4! if "!line:~0,4!" EQU "* " set LINE= + !LINE:~4!
if "!line:~0,3!" EQU "* " set LINE=+ !LINE:~3! if "!line:~0,3!" EQU "* " set LINE=+ !LINE:~3!
if "!line:~0,2!" EQU "* " set LINE=!LINE:~2! if "!line:~0,2!" EQU "* " set LINE=!LINE:~2!
if "!line:~0,1!" EQU "#" echo.>>!DOCFILE!
(echo !LINE! )>>!DOCFILE! (echo !LINE! )>>!DOCFILE!
) )
) )