home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / emulate / amems101.lha / AmigaEMS.Doc < prev    next >
Text File  |  1992-06-08  |  20KB  |  517 lines
  1.                                  AMIGAEMS
  2.                                  ========
  3.  
  4.                               »Version 1.00«
  5.  
  6.                    Copyright (c) 1992 by drs. A.D. Hagen
  7.  
  8.  
  9.     COPYRIGHT, DISTRIBUTION AND LICENSE
  10.     -----------------------------------
  11.  
  12.     All rights about this program and it's documentation remain
  13.     with the author. However, you are granted a limited license.
  14.     Here are the terms:
  15.  
  16.       1) This software may be copied freely.
  17.  
  18.       2) Distribution in whatever form must include the files
  19.          listed below.
  20.  
  21.          /-------------------------------------------------------\
  22.          | File              | Description                       |
  23.          |-------------------------------------------------------|
  24.          | AmigaEMS          | EMS Emulator for the Amiga        |
  25.          | AmigaEMS.info     | AmigaEMS workbench info file      |
  26.          | AmigsEMS.Sys      | EMS Device Driver for the PC      |
  27.          | AmigsEMS.Doc      | Documentation for AmigaEMS        |
  28.          | AmigaEMS.Doc.info | Documentation workbench info file |
  29.          | ResetEMS.Exe      | Reset EMS after a PC reset        |
  30.          | HideEMS.Exe       | (Un)hide the EMS memory for the PC|
  31.          \-------------------------------------------------------/
  32.  
  33.          With the word "programs" in the next statements, all these
  34.          files are ment.
  35.  
  36.       3) The AmigaEMS keyfile must never be distributed. The same
  37.          applies to any additional programs accompaning the registered
  38.          version.
  39.  
  40.       4) All programs must keep their original names, as listed in
  41.          the table above.
  42.  
  43.       5) None of the programs may be altered. A translation into a
  44.          foreign language is allowed, provided:
  45.            a) The english version is included as well.
  46.            b) The name of the program, the name of the author, the
  47.               version and revision number and the copyright
  48.               message remain unchanged.
  49.            c) All rights of the translated program or
  50.               documentation will belong to the author of the
  51.               english version!
  52.            d) You've sent a copy of the translated files to the
  53.               author of the english version. No distribution may
  54.               take place until he has acknowledged the receipt of
  55.               the translated programs.
  56.  
  57.       6) If a fee is charged for a disk containing the programs,
  58.          it may not exceed the fee used by Fred Fish. Also, the
  59.          disk must be full for at least 75%.
  60.  
  61.       7) The programs may not accompany any commercial product without
  62.          obtaining a written agreement from the author of AmigaEMS
  63.          first. This includes all hardware, all commercial
  64.          software and all magazines.
  65.  
  66.       8) The programs are shareware. If after a certain evaluation
  67.          period you find the program useful, you are encouraged to
  68.          register. The time you'll need for evaluation is up to you.
  69.  
  70.       9) These programs have been tested extensively. However,
  71.          using them is at your own risk. Under no circumstances will
  72.          the author of the program (or anyone else) be held
  73.          responsible for any damage caused direct or indirect by
  74.          this program. If the legal situation in your country is
  75.          such that this statement does not apply to you, the use
  76.          of this program is forbidden, unless you agree to this
  77.          statement.
  78.  
  79.  
  80.     THE PROGRAMS
  81.     ------------
  82.  
  83.     AmigaEMS is a utility program for the Amiga bridgeboard. At the
  84.     moment it will work only with the A2088 XT and the A2286 AT board.
  85.     It should work with the A2386 SX as well. It does not work with any
  86.     other PC expansions and it never will, unless they use Commodore's
  87.     janus software interface.
  88.  
  89.     AmigaEMS and all the icons that come with it have been designed for
  90.     use with kickstart version 2.0. If you don't have this version yet,
  91.     don't worry. AmigaEMS will work with version 1.2 and 1.3 as well.
  92.     However, the graphic images might look less attractive to you.
  93.     Sorry for that. Future versions of AmigaEMS might require Kickstart
  94.     2.0 though.
  95.  
  96.     One of the main obstacles in a PC environment is the 640 Kb RAM
  97.     limit. The only alternative so far is to buy an extended or
  98.     expanded memory card for the bridgeboard. This will use one of
  99.     the few slots available. Also, some memory expansions don't seem to
  100.     work on the bridgeboard. However, many people have already
  101.     installed a memory expansion card in their Amiga. This is where
  102.     AmigaEMS comes in. AmigaEMS allows you to use Amiga RAM as expanded
  103.     memory for the bridgeboard. AmigaEMS is LIM/EMS 4.0 compatible.
  104.     The unregistered version is LIM/EMS 3.2 compatible.
  105.  
  106.     Although AmigaEMS will be installed in the Config.Sys file on
  107.     your PC, it will not work with PC programs that use expanded memory
  108.     and are started in the Config.Sys file as well. E.g. ramdrives for
  109.     the PC won't work. This is a limitation of the janus software.
  110.  
  111.     AmigaEMS supports non-volatile expanded memory. This means the
  112.     contents of expanded memory can survive a reset. This feature is
  113.     found on very expensive PC expanded memory cards only. AmigaEMS
  114.     has difficulty in losing expanded memory. This is why ResetEMS is
  115.     included in the package. However, the program will work only on the
  116.     registered version! Simply add ResetEMS to the Autoexec.bat file to
  117.     reset AmigaEMS. ResetEMS does not require any parameters.
  118.     Unregistered users will have to terminate AmigaEMS and start it
  119.     again each time the PC resets.
  120.  
  121.     The HideEMS program is included in this package as well. It hides
  122.     EMS memory from the system. Calling HideEMS again will make EMS
  123.     visible again. HideEMS does not require any parameters.
  124.  
  125.     On the PC AmigaEMS allocates a 64 Kb page swap area. If you have
  126.     only 512 Kb of RAM on the PC you might run low on conventional
  127.     PC memory. For this reason I recommend you upgrade the A2088XT to
  128.     640 Kb anyway.
  129.  
  130.     Everything about starting this program is explained in the
  131.     section titled "INSTALLATION". Removing AmigaEMS is even more
  132.     simple. Just click on the close-gadget in the control window.
  133.     Please note that this will remove the Amiga side of the
  134.     program immediately. It will not remove the AmigaEMS expanded
  135.     memory manager from the PC-side. Removing AmigaEMS while a PC
  136.     program is using expanded memory might lock-up your bridgeboard
  137.     after a reset.
  138.     
  139.     If AmigaEMS on the Amiga isn't running, all EMS requests will
  140.     return an error code. However, some badly written PC programs
  141.     assume the EMS handler is working correctly if it's present.
  142.  
  143.  
  144.     PERFORMANCE
  145.     -----------
  146.  
  147.     Copying memory from the PC to the Amiga (vice versa) thru the janus
  148.     interface takes time. For this reason AmigaEMS isn't as fast as a
  149.     true EMS card. However, AmigaEMS is faster than an EMS driver with
  150.     a disk-based swapping area!
  151.  
  152.     Unfortunately, there aren't any real figures about the speed of
  153.     AmigaEMS. No PC utility for measuring expanded memory speed seems
  154.     to be able to measure the speed of AmigaEMS. Some tools indicate a
  155.     speed of about 10 times as fast as a 80386/25. Unfortunately this
  156.     is slightly exaggerated and is caused by the way the janus software
  157.     handles interupts.
  158.  
  159.     Expanded memory with AmigaEMS is always slower than conventional PC
  160.     memory. Hence, unless you really need expanded memory, use
  161.     conventional memory whenever possible.
  162.  
  163.     Nevertheless, AmigaEMS should be useful for all bridgeboard users
  164.     that, occasionally need some extra memory on their bridgeboard and
  165.     would use an expanded memory manager with a disk-based swapping
  166.     area.
  167.  
  168.  
  169.     SHAREWARE AND REGISTRATION
  170.     --------------------------
  171.  
  172.     AmigaEMS is made available to you under the concept of shareware.
  173.     
  174.     If you want to support my efforts to control the bridgeboard, you
  175.     can register this program. The registration fee is 50 Dutch Guilders
  176.     (approx US$ 30). Don't forget to mention which program you are
  177.     registering. All registered users will receive a registration
  178.     confirmation together with their registration key. The keyfile will
  179.     disable all built-in limitations of the unregistered version. The
  180.     registered version is fully LIM/EMS 4.0 compatible. Registered users
  181.     are entitled to updates and will be notified when they are released.
  182.  
  183.     There are numerous ways you can send me the registration fee. But,
  184.     NEVER SEND COINS!!! My address is given in the section titled
  185.     "SUPPORT". If you like, you can transfer the registration fee to
  186.     my bank-account. Please note: The address shown is that of the bank!
  187.  
  188.          /-------------------------------------------------\
  189.          | Account: 5.683.208 of | Bank: Postbank N.V.     |
  190.          |          A.D. Hagen   |       P.O. Box 41900    |
  191.          |                       |       1009 CD Amsterdam |
  192.          |                       |       The Netherlands   |
  193.          \-------------------------------------------------/
  194.  
  195.     In some countries, there is no legal obligation to register
  196.     for shareware programs. If this applies to you, you should
  197.     nevertheless feel morally obliged to pay for the program. It's
  198.     more than worth the small amount!
  199.  
  200.  
  201.     PARAMETERS
  202.     ----------
  203.  
  204.     AmigaEMS is ment to be very flexible. Hence, a number of
  205.     options have been included. Although both the CLI parameters
  206.     and the workbench tool types obey the same syntax, the workbench
  207.     tool types are case-sensitive, while the CLI parameters are not.
  208.     Some options are not available in the unregistered version. If
  209.     specified they are simply ignored. All examples show the default
  210.     values for the registered version.
  211.  
  212.     PAGES
  213.  
  214.     With the PAGES option you can specify the amount of logical EMS
  215.     pages that will be allocated in Amiga memory. Each EMS page is
  216.     16 Kb in size. The LIM/EMS 3.2 standard supports 512 pages (8 Mb).
  217.     The LIM/EMS 4.0 standard supports 2048 pages (32 Mb). The default
  218.     value is 24 EMS pages (384 Kb). The unregistered supports only 24
  219.     EMS pages.
  220.  
  221.         Example: PAGES=24
  222.  
  223.     HANDLES
  224.  
  225.     AmigaEMS allows you to specify up to 255 handles. Each handle can
  226.     allocate 0 or more logical EMS pages. LIM/EMS 3.2 will allocate
  227.     64 handles by default. LIM/EMS 4.0 will start with the maximum of
  228.     255 handles.
  229.  
  230.         Example: HANDLES=255
  231.  
  232.     EMS (registerd)
  233.  
  234.     This option is available in the registered version only. It allows
  235.     you to switch back to LIM/EMS 3.2 without any of the limitations of
  236.     the unregistered version. The default value for the registered
  237.     version is 4.0. The unregistered version uses 3.2 and cannot be
  238.     changed.
  239.  
  240.         Example: EMS=4.0
  241.  
  242.     MAPS (registered)
  243.  
  244.     LIM/EMS 3.2 does not support real alternate page mapping register
  245.     sets. However, LIM/EMS 4.0 does. This option tells AmigaEMS the
  246.     number of available alternate maps. The default value is 255.
  247.  
  248.         Example: MAPS=255
  249.  
  250.     BUFFERSIZE
  251.  
  252.     The more janus applications are developped, the less janus dual
  253.     port memory remains. By default AmigaEMS uses 16 Kb to transfer
  254.     a logical EMS from the PC to the Amiga vice versa. If you need
  255.     more dual port memory, you can change the buffer size to 8 Kb or
  256.     4 Kb. However, this will increase communication overhead and hence
  257.     decrease expanded memory performance.
  258.  
  259.         Example: BUFFERSIZE=16384
  260.  
  261.     SERVICE
  262.  
  263.     To avoid any problems with other janus services, AmigaEMS allows
  264.     you to pick any of the 32 janus services. By default AmigaEMS
  265.     uses service 31. In the current janus release service 0 thru 17
  266.     are already used. Be sure to specify the same service on the PC
  267.     and on the Amiga.
  268.  
  269.         Example: SERVICE=31
  270.  
  271.     CONTROL
  272.  
  273.     The location of the status window can be modified. In order to
  274.     change the position of the control window add the tool type or
  275.     parameter "CONTROL=(x,y)". X and y are measured in pixels and
  276.     represent the desired position.
  277.  
  278.         Example: CONTROL=(0,0)
  279.  
  280.     QUIET (registered)
  281.  
  282.     The QUIET option allows you to by-pass the copyright requester at
  283.     startup. It can list either "QUIET=ON" or "QUIET=OFF". If you have
  284.     added AmigaEMS to the Startup-Sequence, you might want to choose
  285.     QUIET=ON. The default value is QUIET=OFF.
  286.  
  287.         Example: QUIET=OFF
  288.  
  289.     LOGLEVEL (registered)
  290.  
  291.     For debugging purposes of AmigaEMS the loglevel feature was created.
  292.     In case you want to develop your own EMS programs this option is
  293.     provided in the registered version.
  294.     
  295.     AmigaEMS can log all EMS requests from the PC. The default value is
  296.     0. Loglevel 1 thru 9 are available. This is a list of registered
  297.     data. The actual data logged depends on the EMS function.
  298.  
  299.                                   0  1  2  3  4  5  6  7  8  9
  300.         Function calls           x  x  x  x  x  x  x  x  x
  301.         Returncode                  x  x  x  x  x  x  x  x
  302.         In/Out-reg                     x  x  x  x  x  x  x
  303.         Data struct (In)                  x  x  x  x  x  x
  304.         Data struct (In/Out)                 x  x  x  x  x
  305.         EMS memory (Before)                     x  x  x  x
  306.         EMS memory (Before/After)                  x  x  x
  307.         Amiga struct (In)                             x  x
  308.         Amiga struct (In/Out)                            x
  309.  
  310.     Warning: Loglevel 6 thru 9 will give a significant performance
  311.              fall-back on EMS requests from the bridgeboard.
  312.  
  313.         Example: LOGLEVEL=0
  314.  
  315.     LOGFILE (registered)
  316.  
  317.     The logging information is written to file "AMIGAEMS.LOG". This
  318.     parameter allows you to change that name. The name should not
  319.     exceed 255 characters.
  320.  
  321.         Example: LOGFILE=AMIGAEMS.LOG
  322.  
  323.  
  324.     INSTALLATION
  325.     ------------
  326.  
  327.     The installation of AmigaEMS is straight forward. Just follow the
  328.     instructions and it should work.
  329.  
  330.     Some of the programs included in this package have to be transfered
  331.     to the PC (or Amiga). The following list shows the files that
  332.     belong on the PC-side. The files should be placed in the \SYSTEM
  333.     directory:
  334.  
  335.         AmigaEMS.Sys
  336.         ResetEMS.Exe
  337.         HideEMS.Exe
  338.  
  339.     All remaing files belong on the Amiga side. To transfer files from
  340.     the Amiga to the PC, please consult your Bridgeboard User's Guide.
  341.     Don't forget to specify the /b parameter on the ARead/Awrite
  342.     command.
  343.  
  344.     If you completed the previous step succesfully you've finished the
  345.     hard part. Next, on the PC, the AmigaEMS.sys device driver has to
  346.     be added to your CONFIG.SYS file. Your MS-DOS User's Guide explains
  347.     how to act. The following line should be added:
  348.  
  349.         DEVICE=\SYSTEM\AMIGAEMS.SYS 31
  350.  
  351.     This will load the Amiga expanded memory manager when booting your
  352.     PC. The default janus service (31) can be omitted. However, if
  353.     you've used the SERVICE parameter on the Amiga you must specify
  354.     the same janus service on this line!
  355.  
  356.     On the Amiga, The AmigaEMS program and it's icon should be located
  357.     in the SYS:PC/Services directory. However, you are free to put it
  358.     anywhere else.
  359.  
  360.     After rebooting your Amiga AmigaEMS is ready for use. Issue the
  361.     command SYS:PC/Services/AmigaEMS or add this line to your
  362.     startup-sequence.
  363.  
  364.  
  365.     ERROR MESSAGES
  366.     --------------
  367.  
  368.     If AmigaEMS is unable to do it's job, it informs you about what
  369.     went wrong. Here is a list of possible error messages:
  370.  
  371.     AmigaEMS opens several libraries    AmigaEMS requires the
  372.     At least one of these libraries        following libraries:
  373.     couldn't be opened. Consult the        intuition.library, graphics.
  374.     manual for more details.        library, diskfont.library,
  375.                         icon.library, janus.library
  376.                         and exec.library.
  377.  
  378.     AmigaEMS uses the Topaz/8 and the    The font, probably Ruby 15,
  379.     Ruby/15 font. At least one of these    isn't available on your
  380.     fonts couldn't be opened.        system.
  381.  
  382.     AmigaEMS opens a control window on    Opening a window usually
  383.     the Workbench screen. Opening this    fails on low-memory
  384.     window failed.                conditions only.
  385.  
  386.     AmigaEMS was unable to allocate all    Most definitely a low-memory
  387.     the Logical Pages you requested.    problem.
  388.  
  389.     AmigaEMS allocates some memory in    Too many programs use the
  390.     janus memory. There wasn't enough    dual-ported janus memory.
  391.     memory available to satisfy the        Try to reduce the buffersize
  392.     request.                of AmigaEMS with the
  393.                         BUFFERSIZE parameter.
  394.  
  395.     AmigaEMS claims the JSERV_READPC    AmigaEMS is already running
  396.     service. This janus service is        or another program uses this
  397.     already in use.                janus interrupt. Reconfigure
  398.                         AmigaEMS for another
  399.                         interrupt with the SERVICE
  400.                         parameter.
  401.  
  402.     AmigaEMS creates an Interrupt        If you shut-down and start
  403.     Handler that deals with all janus    AmigaEMS often this message
  404.     signals. Creating this Interrupt    appears. It's a bug in the
  405.     Handler failed.                janus software itself.
  406.  
  407.  
  408.     BUGS
  409.     ----
  410.  
  411.     Development of AmigaEMS was done with great care. The author
  412.     realises the impact any malfunction in AmigaEMS could have on your
  413.     data files. For this reason the release data has been postponed
  414.     several times just to allow for the necessary testing.
  415.  
  416.     The basis of AmigaEMS was formed by the Lotus/Intel/Microsoft
  417.     Expanded Memory Specification (EMS) Version 4.0, updated October
  418.     1987. The author used the machine-readable form by Dick Flanagan.
  419.  
  420.     To test the correct implementation according to the "EMS bible"
  421.     the EMSTEST.COM program by PC Labs was used. However, measuring
  422.     the speed of AmigaEMS with MOVETEST.COM failed. This is not a fault
  423.     of AmigaEMS but is caused by the fact that MOVETEST does not allow
  424.     enough time for AmigaEMS to complete the EMS request.
  425.  
  426.     Meanwhile tests were performed with several programs that support
  427.     EMS, including WordPerfect 5.1 and Lotus 1-2-3. All tests on the
  428.     AT-board were done by Arno Griffioen, while tests on the XT-board
  429.     were performed by myself.
  430.  
  431.     Just to make sure the functions behave like they should, additional
  432.     test programs were written. This was done with Microsoft's Quick C.
  433.  
  434.     If you should experience any problems with AmigaEMS please send me
  435.     your bug-report. If you're a registered user, please use the
  436.     LOGLEVEL (level 9) parameter to capture the error. Send the logfile
  437.     - preferably on disk or by email - to my address. Beware, logfiles
  438.     tend to become very large; proceed with care.
  439.  
  440.     The LOGLEVEL parameter is NOT available in the unregistered version.
  441.     If you did not register your copy, please describe as detailed as
  442.     possible how the error occured and how it can be reproduced. If the
  443.     program that causes the error is PD or Shareware, please include it
  444.     in your report. Otherwise state the name and version of the program
  445.     you're using.
  446.  
  447.     Unfortunately, some errors are not caused by AmigaEMS. The janus
  448.     interface is a very complex piece of software. Especially old
  449.     versions of that software are loaded with bugs. If you use the
  450.     janus.library 33.1 and janus handler 2.63 (or earlier), your
  451.     chanches of getting AmigaEMS to work aren't that good. You might
  452.     contact CATS for a Janus Software Update or try a dealer near you.
  453.  
  454.  
  455.     SUPPORT
  456.     -------
  457.  
  458.     Your registration, questions and remarks can be send to:
  459.  
  460.         Drs. A.D. Hagen
  461.         Newtonstraat 20
  462.         4532 KH Terneuzen
  463.         The Netherlands
  464.  
  465.     If you prefer electronic mail, you can address your messages to:
  466.  
  467.         FIDO: 2:285/1.2 to Alexander Hagen
  468.         UUCP: alexhagn@neabbs.UUCP
  469.  
  470.     Please note, my FIDO address has changed since the release of
  471.     version 2.0 of my PCStatus program. Also, I empty my UUCP mailbox
  472.     only once a month!
  473.  
  474.     End-user support is available through the FIDO-area AMIGA_BRIDGE.
  475.  
  476.     The Unregistered Amiga Bridgeboard Developer,
  477.  
  478.     Alexander Hagen
  479.  
  480.  
  481.     REGISTRATION FORM
  482.     -----------------
  483.  
  484.     Hello Alexander, I would like to register your AmigaEMS program.
  485.     I've read the license agreement and agree to it's terms. This is
  486.     my address:
  487.     
  488.     Name: ___________________________________________________________
  489.     
  490.     Address: ________________________________________________________
  491.     
  492.     Place: _________________________________ ZIP-code: ______________
  493.     
  494.     Country: ________________________________________________________
  495.     
  496.     I'm already a registered user of the following programs you've
  497.     written:
  498.     
  499.     _________________________________________________________________
  500.     
  501.     _________________________________________________________________
  502.     
  503.     The registration fee of 50 Dutch Guilders (or the equivalent in my
  504.     local currency) is:
  505.                           ___ enclosed
  506.     
  507.                           ___ transferred to your bankaccount
  508.  
  509.     Please send me my personal key file and the latest version of
  510.     AmigaEMS as soon as my registration has been processed.
  511.  
  512.  
  513.     Place: _______________________
  514.  
  515.     Date:  __________                  Signature: ____________________
  516.  
  517.