changeset 2461:9fc6566ada9c

Updated comments
author boisy
date Sat, 27 Feb 2010 14:24:52 +0000
parents c840e05abdac
children 95a64ea1c621
files level1/modules/rfm.asm
diffstat 1 files changed, 78 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/level1/modules/rfm.asm	Sat Feb 27 08:26:46 2010 +0000
+++ b/level1/modules/rfm.asm	Sat Feb 27 14:24:52 2010 +0000
@@ -1,9 +1,13 @@
 ********************************************************************
 * RFM - Remote File Manager
 *
+* $Id$
 *
-*  1       2010/02/20  AAW
-*          first version - just send ops
+* Edt/Rev  YYYY/MM/DD  Modified by
+* Comment
+* ------------------------------------------------------------------
+*   1      2010/02/20  Aaron Wolfe
+* initial version - just sends ops to server
 
                nam       RFM
                ttl       Remote File Manager
@@ -21,7 +25,6 @@
 
                mod       eom,RFMName,tylg,atrv,RFMEnt,size
 
-
 size           equ       .
 
 
@@ -29,7 +32,6 @@
                fcb       edition
 
 
-
 ******************************
 *
 * file manager entry point
@@ -52,10 +54,25 @@
                lbra      setstt              Set Status
                lbra      close               Close path
 
+
+******************************
+*
+* Create - creates a file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
 create         ldb       #DW.create
                bra       create1
 
 
+******************************
+*
+* Open - opens a file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
 open           ldb       #DW.open
 create1        
                ldx       PD.DEV,y            ; get ptr to our device memory
@@ -177,6 +194,13 @@
                lbra      sendit
                
                
+******************************
+*
+* Seek - seeks into a file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
 * seek = send dwop, rfmop, path, caller's X + U               
 seek        pshs		y,u
 			
@@ -211,16 +235,37 @@
                puls  y,u,pc
 
 
+******************************
+*
+* Read - reads data from a file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
 read           ldb       #DW.read
                bra       read1               ; join readln routine
 
 
 
+******************************
+*
+* Write - writes data to a file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
 write          lda       #DW.write
                lbra      sendit
 
 
 
+******************************
+*
+* ReadLn - reads a line of data from a file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
 readln         ldb       #DW.readln
 read1          ldx       PD.DEV,y            ; to our static storage
                ldx       V$STAT,x
@@ -326,18 +371,25 @@
 readln2        puls      y,u,pc
 
 
+******************************
+*
+* WritLn - writes a line of data to a file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
 writln         lda       #DW.writln
                lbra      sendit
 
+******************************
 *
-* I$GetStat Entry Point
-*
-* Entry:
+* GetStat - obtain status of file on the remote device
 *
-* Exit:
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
 *
-* Error: CC Carry set
-*        B = errcode
+* Exit:  CC.Carry = 0 (no error), 1 (error)
+*        B = error code (if CC.Carry == 1)
 *
 getstt                   
                lda       #DW.getstt
@@ -416,15 +468,15 @@
 
 
 
+******************************
 *
-* I$SetStat Entry Point
-*
-* Entry:
+* SetStat - change status of file on the remote device
 *
-* Exit:
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
 *
-* Error: CC Carry set
-*        B = errcode
+* Exit:  CC.Carry = 0 (no error), 1 (error)
+*        B = error code (if CC.Carry == 1)
 *
 setstt 
                lda       #DW.setstt
@@ -458,6 +510,16 @@
                rts       
 
 
+******************************
+*
+* Close - close path to file on the remote device
+*
+* Entry: Y = Path descriptor pointer
+*        U = Callers register stack pointer
+*
+* Exit:  CC.Carry = 0 (no error), 1 (error)
+*        B = error code (if CC.Carry == 1)
+*
 close          
                pshs      y,u