home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilst / vmectrl / !VMECtrl / ModuleDocs < prev    next >
Text File  |  1995-05-06  |  6KB  |  139 lines
  1. VMEcontrol 1.22  © Angelos tou Thanatou 1995
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. First off, to use this you'll need
  4.     * A VIDC enhancer that uses IO1 (eg. Atomwide, Risc Developments, etc)
  5.       as its 'enable' control. (also works with Andreas Barth's DIY
  6.       enhancer).
  7.       Support for other enhancers will be added if there's any call for it
  8.     * An 'old' machine; ie. one that had to have a VIDC enhancer fitted
  9.       (the 'newer' machines have it built in)
  10.  
  11. NB: No checks are made for hardware/OS version... If you don't know what you've
  12. got, "*fx 0" from the command line/in a taskwindow will tell you the OS
  13. version. You can try it with your VIDC enhancer and if it works, good. If not,
  14. let me know and I'll try to sort it out.
  15.  
  16. When I say VIDC enhancer, I mean a third party add-on, not the clock switcher
  17. built into the newer machines. (Just to clear that bit up)
  18.  
  19.  
  20. What it does...
  21. ~~~~~~~~~~~~~~~
  22. The VMEcontrol module listens to mode change messages and enables/disables the
  23. VIDC enhance (VME) as appropriate. "Haha!" you cry, "How does it know?" Well,
  24. the answer's simple: you tell it. [by default modes 29,30,31 & 32 are marked as
  25. 'enhanced'].
  26.  
  27. If when you load the module you supply a filename, eg.
  28.     *RMEnsure VMEcontrol 1.21 RMLoad VMEcontrol myfile
  29. then that file will be loaded (as if you had followed the rmload with a
  30. *loadmap command). NB: If the load operation fails, the module will *not*
  31. be installed. So, try:
  32.     *RMEnsure VMEcontrol 1.21 RMLoad VMEcontrol myfile
  33.     *RMEnsure VMEcontrol 1.21 RMLoad VMEcontrol
  34. to be on the extra-safe side :-)
  35.  
  36. [note, this facility has been largely superceded by the !VMEctrl application's
  37. 'generate custom module' facility]
  38.  
  39.  
  40. *COMMANDS:
  41. ~~~~~~~~~~
  42. *Vme [On|Off]
  43.     With no parameter displays the current VME status, otherwise
  44.     enables/diables the VME.
  45.  
  46. *Mode [<ModeNumber> [On|Off]]
  47.     With no parameter displays the current screen mode, VME status, and
  48.     whether the mode is marked as 'enhanced' (ie. VME on)
  49.     With just the <ModeNumber> attempts to change to mode <ModeNumber>
  50.     If the <ModeNumber> is followed by 'On' or 'Off' (after a space, of
  51.     course...), the mode will be marked appropriately. If you mark the mode
  52.     that you are currently in, the VME will be altered too. No mode change
  53.     takes place.
  54.  
  55. *ShowMap
  56.     Displays a list of the modes currently marked as 'enhanced'
  57.  
  58. *SaveMap
  59. *LoadMap
  60.     Saves/Loads the map to/from a file (type 9a5 - if the filetype doesn't
  61.     suit, simply edit the source). This enables you to have a complex
  62.     mode table that is easily set-up from a boot file.
  63.  
  64.  
  65. SWIs provided:
  66. ~~~~~~~~~~~~~~
  67. &C3F40 "VME_Status"
  68.     On exit, R0 contains the VME status (0 for off, non-zero for on)
  69.  
  70. &C3F41 "VME_Control"
  71.     On entry R0 holds the state to set the VME to.
  72.     R0 == 0 turns the VME off, R0 non-zero turns it on.
  73.  
  74. &C3F42 "VME_ReadMap"
  75.     On entry, R0 is the mode in question
  76.     On exit, R0 preserved, R1=VME state for that mode (non-zero = On)
  77.  
  78. &C3F43 "VME_WriteMap"
  79.     On entry, R0 is the mode in question & R1 is the new VME state for that
  80.     mode (non-zero = On).
  81.  
  82. &C3F44 "VME_LoadMap"                                 _
  83.     On entry, R0 points to the filename to use.   \
  84.     On exit, r0-r6 may be currupted                \
  85.                                                        /
  86. &C3F45 "VME_SaveMap"                                  /
  87.     On entry, R0 points to the filename to use.   > better off using the
  88.     On exit, r0-r6 may be currupted               \ *commands anyway
  89.                                                        \
  90. &C3F46 "VME_ShowMap"                                   /
  91.     On exit, r0-r6 may be currupted               /
  92.                                                      ~
  93.  
  94. Disclaimer
  95. ~~~~~~~~~~
  96. Use of this software is completely at your own risk. The author can accept no
  97. responsibility for any damage/loss arising from the use, or inability to use
  98. this software. No warranty, express or implied, applies to this software.
  99. This is not PD: the Copyright in this software belongs at all times to the
  100. author. However, permission is granted for unrestricted distribution
  101. prodividing that *no* charge is made for the distribution [a charge may be made
  102. for handling/media] and that the whole of the software is supplied intact and
  103. unaltered. Permission is also granted for unrestricted use and alteration of
  104. the software [but if you fix a bug / add anything nice, let me know so I can
  105. patch the 'master' version].
  106.  
  107. Bug reports / comments / etc to:
  108. Angelos tou Thanatou c/o 23 Baronsway, Whitkirk, Leeds, LS15 7AW, England.
  109. (until Sept-ish '95: n0ae2@newton.ncl.ac.uk, voice 0191 2301292)
  110.  
  111. Basically I wrote this because after waiting a *month* for the Beebug VME to
  112. arrive in the post (we had a 2 week postal strike start the day I ordered it
  113. :-) [...and having failed to buy a 36MHz oscillator anywhere so I could build
  114. my own VME, but that's a different story], I was more than a little disapointed
  115. with the software that came with it (not to mention the Installation
  116. instructions...) and, well, I wasn't going to sleep that night anyway so...
  117.  
  118. So, having hacked it together in a night and now finding it useful, I thought
  119. I'd share it just incase anyone else out there is feeling let down by their
  120. supplied VIDC enhancer software.
  121.  
  122. History:
  123.     v0.00    First hacky test version 'to get a feel for it' *unreleased*
  124.     v0.10    First working version, just vme command & service handler
  125.         implemented *unreleased*
  126.     v0.20    now has *Mode *Vme *ShowMap commands,
  127.         swis to read/write the map, but still no configuration
  128.         *unreleased*
  129.     v1.00    Added *loadmap and *savemap *unreleased*
  130.     v1.01    fixed a little bug :-( *unreleased*
  131.     v1.10    Added *mode configuration command
  132.     v1.20    No longer dependant on RISC OS 3.11 (should've fixed this sooner
  133.         but as none of the above were marked for release, I didn't
  134.         bother). Also tidied up error messages a bit. *unreleased*
  135.     v1.21    added facility to load mapfile at startup. *released 04-May-95*
  136.     v1.22    moved the default mode tabel to the end of the module so that
  137.         the WIMP front-end can easily replace it with a different
  138.         size one. *released 08-May-95*
  139.