mirror of
https://github.com/A2osX/A2osX.git
synced 2024-07-05 21:28:59 +00:00
Kernel version 0.9 : API doc cleanup
This commit is contained in:
Rémy GIBERT
parent
5157cd75d3
commit
d38f055562
1073
_Docs/KERNEL.md
1073
_Docs/KERNEL.md
File diff suppressed because it is too large
Load Diff
@ -1,52 +1,41 @@
|
|||||||
*** 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 :
|
||||||
|
+ PUSHW = DevSize (in 512b blocks)
|
||||||
##In :
|
##Out :
|
||||||
+ PUSHW = DevSize (in 512b blocks)
|
+ X=BlockCount (max 22)
|
||||||
|
+ A=PageCount (max 44)
|
||||||
##Out :
|
#BuildProDOSCat
|
||||||
+ X=BlockCount (max 22)
|
##In :
|
||||||
+ A=PageCount (max 44)
|
+ PUSHW = DevSize (in 512b blocks)
|
||||||
|
+ PUSHW = VolName (PSTR)
|
||||||
#BuildProDOSCat
|
+ PUSHW = DstBuf (Zero filled)
|
||||||
|
+ Blk0 : ProDOS.BootBlk
|
||||||
##In :
|
+ Blk1 : SOS.BootBlk
|
||||||
+ PUSHW = DevSize (in 512b blocks)
|
+ Blk2,3,4,5 : Volume Directory
|
||||||
+ PUSHW = VolName (PSTR)
|
+ Blk6.... : Volume Bitmap (4096/Blk)
|
||||||
+ PUSHW = DstBuf (Zero filled)
|
+ max devSize = 65535 -> max 16 Bitmap Blk
|
||||||
+ Blk0 : ProDOS.BootBlk
|
+ absolute MAX DstBuf size=
|
||||||
+ Blk1 : SOS.BootBlk
|
+ 7 for Disk II(280blk),3.5(1600),3.5HD(2880)
|
||||||
+ Blk2,3,4,5 : Volume Directory
|
+ 22 for 32mb Hardisk...
|
||||||
+ Blk6.... : Volume Bitmap (4096/Blk)
|
#TrkW16s
|
||||||
+ max devSize = 65535 -> max 16 Bitmap Blk
|
Write a track (16 sectors)
|
||||||
+ absolute MAX DstBuf size=
|
##In:
|
||||||
+ 7 for Disk II(280blk),3.5(1600),3.5HD(2880)
|
+ PUSHW = Ptr to 16*256 buffer
|
||||||
+ 22 for 32mb Hardisk...
|
+ PUSHB = TrackNum * 4 : 0->140+
|
||||||
|
+ PUSHB = DSSS0000
|
||||||
#TrkW16s
|
##Out:
|
||||||
Write a track (16 sectors)
|
+ CC : success
|
||||||
|
+ CS : A = Error
|
||||||
##In:
|
+ A=0, currently starting/seeking...
|
||||||
+ PUSHW = Ptr to 16*256 buffer
|
#TrkWNIB
|
||||||
+ PUSHB = TrackNum * 4 : 0->140+
|
Write a track (NIBBLE)
|
||||||
+ PUSHB = DSSS0000
|
##In:
|
||||||
|
+ PUSHW = Ptr to NIBBLE buffer (0 ended)
|
||||||
##Out:
|
+ PUSHB = TrackNum * 4 : 0->140+
|
||||||
+ CC : success
|
+ PUSHB = DSSS0000
|
||||||
+ CS : A = Error
|
##Out:
|
||||||
+ A=0, currently starting/seeking...
|
+ CC : success
|
||||||
|
+ CS : A = Error
|
||||||
#TrkWNIB
|
+ A=0, currently starting/seeking...
|
||||||
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...
|
|
||||||
|
|||||||
@ -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 :
|
||||||
|
##Out :
|
||||||
##In :
|
#ARP.Query
|
||||||
|
+ Query ARP Cache and returns HW address
|
||||||
##Out :
|
##In:
|
||||||
|
+ PUSHW PTR to MAC (to fill)
|
||||||
#ARP.Query
|
+ PUSHW PTR to IP
|
||||||
+ Query ARP Cache and returns HW address
|
##Out:
|
||||||
|
+ CC: hit: MAC filled
|
||||||
##In:
|
+ CS: missed
|
||||||
+ PUSHW PTR to MAC (to fill)
|
#ARP.Add
|
||||||
+ PUSHW PTR to IP
|
+ Add a static ARP cache record
|
||||||
|
##In:
|
||||||
##Out:
|
+ PUSHW PTR to MAC
|
||||||
+ CC: hit: MAC filled
|
+ PUSHW PTR to IP
|
||||||
+ CS: missed
|
#ARP.GetCache
|
||||||
|
+ Return a Ptr to ARP Cache Table
|
||||||
#ARP.Add
|
##In:
|
||||||
+ Add a static ARP cache record
|
##Out:
|
||||||
|
+ Y,A = PTR to ARP.CACHE
|
||||||
##In:
|
#DNS.Clear
|
||||||
+ PUSHW PTR to MAC
|
+ Clear DNS Cache
|
||||||
+ PUSHW PTR to IP
|
##In :
|
||||||
|
##Out :
|
||||||
#ARP.GetCache
|
#DNS.Query
|
||||||
+ Return a Ptr to ARP Cache Table
|
+ Query DNS for specified host
|
||||||
|
##In:
|
||||||
##In:
|
+ PUSHW = PTR to IP to fill with cached data
|
||||||
|
* PUSHW = hostname PTR to PSTR
|
||||||
##Out:
|
##Out:
|
||||||
+ Y,A = PTR to ARP.CACHE
|
+ CC: hit: IP filled with address
|
||||||
|
+ CS: missed
|
||||||
#DNS.Clear
|
#DNS.Add
|
||||||
+ Clear DNS Cache
|
+ Add a static DNS record
|
||||||
|
##In:
|
||||||
##In :
|
+ PUSHW = PTR to IP
|
||||||
|
+ PUSHW = hostname PSTR to Add
|
||||||
##Out :
|
#DNS.GetCache
|
||||||
|
+ Return a Ptr to DNS Cache Table
|
||||||
#DNS.Query
|
##In:
|
||||||
+ Query DNS for specified host
|
##Out:
|
||||||
|
+ Y,A = PTR to DNS.CACHE
|
||||||
##In:
|
#SKT.New
|
||||||
+ PUSHW = PTR to IP to fill with cached data
|
+ Create a new socket
|
||||||
* PUSHW = hostname PTR to PSTR
|
##In :
|
||||||
|
+ PUSHW = PTR to S.SOCKET template
|
||||||
##Out:
|
##Out :
|
||||||
+ CC: hit: IP filled with address
|
+ YA = PTR to new S.SOCKET
|
||||||
+ CS: missed
|
+ X = hSocket
|
||||||
|
#SKT.CloseA
|
||||||
#DNS.Add
|
+ Close socket
|
||||||
+ Add a static DNS record
|
##In :
|
||||||
|
+ A = hSocket
|
||||||
##In:
|
##Out :
|
||||||
+ PUSHW = PTR to IP
|
#SKT.GetA
|
||||||
+ PUSHW = hostname PSTR to Add
|
+ Get Ptr to socket
|
||||||
|
##In :
|
||||||
#DNS.GetCache
|
+ A = hSocket
|
||||||
+ Return a Ptr to DNS Cache Table
|
##Out :
|
||||||
|
+ Y,A = pS.SOCKET
|
||||||
##In:
|
#SKT.GetTable
|
||||||
|
+ Get socket table
|
||||||
##Out:
|
##In :
|
||||||
+ Y,A = PTR to DNS.CACHE
|
##Out :
|
||||||
|
+ Y,A = pS.SOCKET
|
||||||
#SKT.New
|
#SKT.AcceptA
|
||||||
+ Create a new socket
|
+ Check for an incoming connection
|
||||||
|
##In :
|
||||||
##In :
|
+ A = hListeningSocket
|
||||||
+ PUSHW = PTR to S.SOCKET template
|
##Out :
|
||||||
|
+ A = hSocket
|
||||||
##Out :
|
#SKT.MkNodA
|
||||||
+ YA = PTR to new S.SOCKET
|
+ Create a new file from TCP socket
|
||||||
+ X = hSocket
|
##In :
|
||||||
|
+ A = hSocket
|
||||||
#SKT.CloseA
|
##Out :
|
||||||
+ Close socket
|
+ A = hFile
|
||||||
|
#SKT.Write (DGRAM,STREAM,RAW)
|
||||||
##In :
|
+ Send block of data
|
||||||
+ A = hSocket
|
##In :
|
||||||
|
+ PUSHB = hSocket
|
||||||
##Out :
|
+ PUSHW = pBuf
|
||||||
|
+ PUSHW = len
|
||||||
#SKT.GetA
|
##Out :
|
||||||
+ Get Ptr to socket
|
#SKT.ReadA (DGRAM,RAW)
|
||||||
|
##In :
|
||||||
##In :
|
+ A = hSocket
|
||||||
+ A = hSocket
|
##Out :
|
||||||
|
+ A = hFrame
|
||||||
##Out :
|
#SKT.PutC (STREAM)
|
||||||
+ Y,A = pS.SOCKET
|
+ Write a Char To Stream
|
||||||
|
##In :
|
||||||
#SKT.GetTable
|
+ PUSHB = hSocket
|
||||||
+ Get socket table
|
+ PUSHB = Char
|
||||||
|
##Out :
|
||||||
##In :
|
#SKT.PutS (STREAM)
|
||||||
|
+ Write Line in pBuf
|
||||||
##Out :
|
##In :
|
||||||
+ Y,A = pS.SOCKET
|
+ PUSHB = hSocket
|
||||||
|
+ PUSHW = PSTR
|
||||||
#SKT.AcceptA
|
##Out :
|
||||||
+ Check for an incoming connection
|
#SKT.GetCA (STREAM)
|
||||||
|
+ Read a Char From Stream in A
|
||||||
##In :
|
##In :
|
||||||
+ A = hListeningSocket
|
+ A = hSocket
|
||||||
|
##Out :
|
||||||
##Out :
|
+ A = char
|
||||||
+ A = hSocket
|
#SKT.GetS (STREAM)
|
||||||
|
+ Read a CR terminated Line in pBuf
|
||||||
#SKT.MkNodA
|
##In :
|
||||||
+ Create a new file from TCP socket
|
+ PUSHB = hSocket
|
||||||
|
+ PUSHW = pBuf
|
||||||
##In :
|
+ PUSHW = len
|
||||||
+ A = hSocket
|
##Out :
|
||||||
|
+ Y,A = bytes read
|
||||||
##Out :
|
#SKT.Read (STREAM)
|
||||||
+ A = hFile
|
+ Read data in pBuf
|
||||||
|
##In :
|
||||||
#SKT.Write (DGRAM,STREAM,RAW)
|
+ PUSHB = hSocket
|
||||||
+ Send block of data
|
+ PUSHW = pBuf
|
||||||
|
+ PUSHW = len
|
||||||
##In :
|
##Out :
|
||||||
+ PUSHB = hSocket
|
+ Y,A = bytes transfered
|
||||||
+ 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
|
|
||||||
|
|||||||
@ -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,8 +66,7 @@ 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!
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user