Apple-2-SW/A2osX
1
0
Fork 0
mirror of https://github.com/A2osX/A2osX.git synced 2024-12-26 11:30:07 +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 11:03:23 +02:00
parent 9639812b91
commit c20ea8b40f
4 changed files with 863 additions and 615 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1073
_Docs/KERNEL.md
View File

File diff suppressed because it is too large Load Diff

91
_Docs/LIBBLKDEV.md
View File

@ -1,41 +1,52 @@
*** Auto generated by docgen.cmd ***
#GetProDOSCatSize
+ Compute space needed for ProDOS Catalog
##In :
+ PUSHW = DevSize (in 512b blocks)
##Out :
+ X=BlockCount (max 22)
+ A=PageCount (max 44)
#BuildProDOSCat
##In :
+ PUSHW = DevSize (in 512b blocks)
+ PUSHW = VolName (PSTR)
+ PUSHW = DstBuf (Zero filled)
+ Blk0 : ProDOS.BootBlk
+ Blk1 : SOS.BootBlk
+ Blk2,3,4,5 : Volume Directory
+ Blk6.... : Volume Bitmap (4096/Blk)
+ max devSize = 65535 -> max 16 Bitmap Blk
+ absolute MAX DstBuf size=
+ 7 for Disk II(280blk),3.5(1600),3.5HD(2880)
+ 22 for 32mb Hardisk...
#TrkW16s
Write a track (16 sectors)
##In:
+ PUSHW = Ptr to 16*256 buffer
+ PUSHB = TrackNum * 4 : 0->140+
+ PUSHB = DSSS0000
##Out:
+ CC : success
+ CS : A = Error
+ A=0, currently starting/seeking...
#TrkWNIB
Write a track (NIBBLE)
##In:
+ PUSHW = Ptr to NIBBLE buffer (0 ended)
+ PUSHB = TrackNum * 4 : 0->140+
+ PUSHB = DSSS0000
##Out:
+ CC : success
+ CS : A = Error
+ A=0, currently starting/seeking...
# GetProDOSCatSize
+ Compute space needed for ProDOS Catalog
## In :
+ PUSHW = DevSize (in 512b blocks)
## Out :
+ X=BlockCount (max 22)
+ A=PageCount (max 44)
# BuildProDOSCat
## In :
+ PUSHW = DevSize (in 512b blocks)
+ PUSHW = VolName (PSTR)
+ PUSHW = DstBuf (Zero filled)
+ Blk0 : ProDOS.BootBlk
+ Blk1 : SOS.BootBlk
+ Blk2,3,4,5 : Volume Directory
+ Blk6.... : Volume Bitmap (4096/Blk)
+ max devSize = 65535 -> max 16 Bitmap Blk
+ absolute MAX DstBuf size=
+ 7 for Disk II(280blk),3.5(1600),3.5HD(2880)
+ 22 for 32mb Hardisk...
# TrkW16s
Write a track (16 sectors)
## In:
+ PUSHW = Ptr to 16*256 buffer
+ PUSHB = TrackNum * 4 : 0->140+
+ PUSHB = DSSS0000
## Out:
+ CC : success
+ CS : A = Error
+ A=0, currently starting/seeking...
# TrkWNIB
Write a track (NIBBLE)
## In:
+ PUSHW = Ptr to NIBBLE buffer (0 ended)
+ PUSHB = TrackNum * 4 : 0->140+
+ PUSHB = DSSS0000
## Out:
+ CC : success
+ CS : A = Error
+ A=0, currently starting/seeking...

311
_Docs/LIBTCPIP.md
View File

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

3
_Tools/docgen.cmd
View File

@ -66,7 +66,8 @@ for /f %%F in ('dir /b /ogn "%SRCDIR%\%FILTER%"') do (
if "!line:~0,4!" EQU "* " set LINE= + !LINE:~4!
if "!line:~0,3!" EQU "* " set LINE=+ !LINE:~3!
if "!line:~0,2!" EQU "* " set LINE=!LINE:~2!
(echo !LINE! )>>!DOCFILE!
if "!line:~0,1!" EQU "#" echo.>>!DOCFILE!
(echo !LINE!)>>!DOCFILE!
)
)
)