home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / programming / dasupport / ReadMe < prev    next >
Encoding:
Text File  |  1998-01-16  |  2.4 KB  |  95 lines
  1.  
  2.                                   DASupport Module
  3.                                   ————————————————
  4.                                   
  5.                                (version 0.04 16/01/98)
  6.                        Liam Gretton for Leicester University
  7.                                  16th January 1998
  8.  
  9. This document describes the SWI calls provided by the DASupport module. It
  10. provides facilities to simplify the management of dynamic areas by external
  11. clients.
  12.  
  13. The module’s SWI chunk base is &50540, which has been allocated by Acorn, and
  14. so shouldn’t clash with other modules out there.
  15.  
  16. I can be contacted by e-mail at ljg@star.le.ac.uk, so if you find any
  17. problems with this module, please get in touch. The latest version can be
  18. obtained from http://xmm4.xra.le.ac.uk.
  19.  
  20. The file 'SWIs' supplied is an Ovation Pro version of this text file.
  21.  
  22.  
  23. Changes
  24. ———————
  25.  
  26. 0.04 - Added DASupport_Fill.
  27.  
  28. 0.03 - Altered DASupport_Claim: added ability to fill a newly created area with
  29.        a particular word.
  30.  
  31.  
  32.  
  33. SWI Calls
  34. —————————
  35.  
  36. DASupport_Claim
  37.  
  38. Used to create a dynamic area.
  39.  
  40. On entry
  41.     R0 = size of area to create
  42.          bit 31 set means fill the area with the word in R2
  43.     R1 = pointer to ctrl-terminated name to use for area
  44.     R2 = word to fill area with (if bit 31 of R0 set)
  45.  
  46. On exit
  47.     R0 = 0 if area created successfully
  48.          1 if area not created
  49.     R1 = base address of area if R0 = 0.
  50.     All other registers preserved.
  51.  
  52. Use
  53. This SWI attempts to create a dynamic area of the specified size, giving it
  54. the name pointed to by R1. Currently DASupport can manage up to 500 dynamic
  55. areas. If an attempt is made to create more, the error 'DASupport cannot claim
  56. any more areas' will be reported.
  57.  
  58. If bit 31 of R0 is set, the area is filled with the word given in R2.
  59.  
  60.  
  61.  
  62. DASupport_Release
  63.  
  64. Used to remove a dynamic area.
  65.  
  66. On entry
  67.     R1 = base address of area to remove (as returned from DASupport_Claim)
  68.  
  69. On exit
  70.     R0 = 0 if area removed successfully
  71.          1 if area not removed
  72.     All other registers preserved.
  73.  
  74. Use
  75. This SWI removes a dynamic area created with DASupport_Claim.
  76.  
  77.  
  78.  
  79. DASupport_Fill
  80.  
  81. Used to fill an existing area.
  82.  
  83. On entry
  84.         R1 = base address of area to fill (as returned from DASupport_Claim)
  85.     R2 = value to fill area with
  86.         
  87. On exit
  88.         R0 = 0 if area filled successfully
  89.            = 1 if area not filled
  90.         All other registers preserved.
  91.         
  92. Use
  93. This SWI fills one of DASupport's dynamic areas with the value passed in R2.
  94.  
  95.