Soon to be released REX Release 4.6: Difference between revisions

From Bitchin100 DocGarden
Jump to navigationJump to search
No edit summary
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Supported Models ==
== Supported Models ==
M100 and T102
M100 and T102, with either REX or REX2.




Line 16: Line 16:
== Bug Fixes ==
== Bug Fixes ==
*  the 12 block limitation in Release 4.5 is resolved
*  the 12 block limitation in Release 4.5 is resolved
*  an issue affecting overall stability was identified and fixed


== REX Operation Overview ==


== Upgrade Procedure ==
'''RAM/ROM/OS Menu'''
The upgrade procedure is quite simple.  The upgrade package contains a program called REXU1.CO (the upgrader tool) and a 16k binary image of the new REX software load called REX146.BR.


The upgrade tool REXU1 accesses
REX is an option ROM switcher that also includes RAM backup and switching functions.  REX manages RAM or ROM data in 32k blocks, refered to as images.  Option ROMs may be loaded into REX images and selected for use, and your system RAM may be copied to or restored from REX images.  Images are grouped by type (RAM/ROM/OS).  SYS images are reserved for system use.  Images may be 'Load'ed or 'Save'd to/from TPDD.


Filename extensions are
  .BX is used for Option ROM images
  .BY is used for RAM images
  .BZ is used for OS images
  .BR is used for REX system images


Images may be 'Name'd, 'Copy'd or 'Kill'ed. Up to 16 images of any one type are allowed, with 24 images in total. An Image is 'ACTIVE' when in use by REX, and is marked with a *.  There must always be one active RAM and one active ROM or OS image.  You cannot kill an active image.  Active status is changed by selection of a new image using the <ent> key.  OS images are option ROMs that act as independant operating systems.


Keyboard Commands


  b Block number information
  e Hints on <ENTER> key functions
  i Information on REX system
  c Checksum of menu entry image
  s Toggle directory sort order
  ent Take action for selection
  tab Show directory for next image type
  esc return to menu


Each REX ships with all the software needed for normal use of REX. 


Once REX is installed, and the REX system is installed, you will be able to access the REX Manager.
Function Keys
  F1 Display help screens
  F2 Load/Save image from/to TPDD
  F3 Copy image to REX
  F4 Delete image from REX
  F5 Rename the image
  F6 Reserved for future function
  F7 Deinstall REX software from laptop
  F8 Exit REX Manager


REX Manager allows the user to:
'''SYS Menu'''
* load and save binary OPTION ROM images to/from TPDD
* select an OPTION ROM for use from the list of stored images
* manage images in the directory (kill, name, copy, calculate checksum etc.)
* create and manage RAM images
* load and save binary RAM images to/from TPDD


This menu is used to manage system related tasks, primarily management of the loaded main ROM images used when REX is replacing the internal ROMs.  See the Wiki to learn the steps required to configure your laptop for ROM Replacement, and how to create ROM images that are compatible with REX. (ROMs require a small change so that REX can detect the hardware configuration.)  REX Manager screens now indicate the status of the ROM Replacement function.  In the top left corner there is a single highlighted character, one of (M, P, S).  This character indicates which system ROM is in use - internal or REX based.


REX ships with TS-DOS pre-loaded.  Once REX is completely installed, the user should be able to access TS-DOS immediately.
  M - standard internal ROMs in use
  P - Primary ROM (block 2)in use
  S - Secondary ROM (block 4) in use


A collection of tested good, fully compatible ROM images is available for download from this wikiTo load these images for use into REX, you must
When the internal ROM is in use, REX cannot provide ROM Replacement.  Primary or Secondary ROM images may be 'Load'ed via selection from menuWhen the laptop is configured to provide the system ROM, the power-up default is to use the Primary ROM in block 2.  It is a good idea to leave this block configured with the standard image.  'Use' command allows the user to select either Primary or Secondary ROMs for use.  This selection is tracked in the active block directory, so that system state is always restored on power up.  Timestamps are recorded also.  Messages are shown above the entries to give some information about the block under the cursor.
* download these binary files ( .BX extensions)
* place them on you favorite TPDD protocol based remote storage device (NADSBox, LaddieCon etc)
* make sure they are "visible" to TS-DOS (so they are ready to be read by REX)
* start REX Manager
* TAB to the ROM group
* place the cursor over a free slot
* press F2 to LOAD
* provide the filename for the desired ROM image as named on the TPDD device
* REX Manager will load that image into REX
* following a successful load, the user must ACTIVATE that OPTION ROM for use.


Keyboard Commands
  b Block number information
  i Information on REX system
  c Checksum of menu entry image
  tab Show directory for next image type
  esc return to menu
Function Keys
  F1 Display help screens
  F2 Load image from TPDD
  F3 Select ROM image for use
  F7 Deinstall REX software from laptop
  F8 Exit REX Manager


== Upgrade Procedure ==


'''Current beta release is dated October 17, 2010 and has a checksum of B5BF.'''


'''What you need'''
*  REXU1.CO
*  REX146.BR
*  your favorite TPDD device connected to the laptop


== REX SYSTEM Images ==
The upgrade procedure is quite simple.  The upgrade package contains a program called REXU1.CO (the upgrader tool) and a 16k binary image of the new REX software load called REX146.BR.


REX SYSTEM images contain the REX Manager software package, including the default directories, and are 32kbyte binary files.  For M100/T102, images have filenames of REX1XX.BR, and T200 images have filenames of REX2XX.BR, where XX is the release number.
<table border="1">
<tr><td>Status</td><td>Release</td><td>Model</td><td>Description</td><td>File</td><td>Submitter / Date</td></tr>
<tr><td>GA</td><td>4.5</td><td>M100/T102</td><td>Initial REXROM release</td><td>[[Media:REX145.BR|REX145.BR]]</td><td>[[User:Sadolph|Sadolph]] 11:56, 1 July 2009 (PDT)</td></tr>
</table>


== REXU - REX Upgrade Utility ==
Why 16k?
*  the goal of the upgrade is to jam in new software on top of your existing directory
*  we need to preserve your directory information




The upgrade assumes you have a working REX or REX2 running software release 4.5.  This is a mostly safe assumption, since all REX and REX2 to date have been only got Release 4.5.


<table border="1">
<tr><td>Status</td><td>Release</td><td>Model</td><td>Description</td><td>File</td><td>Submitter / Date</td></tr>
<tr><td>GA</td><td>2.0</td><td>M100/T102</td><td>REX Upgrade Tool</td><td>[[Media:REXU1.CO|REXU1.CO]]</td><td>[[User:Sadolph|Sadolph]] 11:57, 1 July 2009 (PDT)</td></tr>
</table>


The upgrade tool REXU1 runs in RAM and relies on a connected TPDD device to make the software upgrade image available.




REXU is a utility that allows the user to upgrade the internal REX Manager software. REXU first provides a mechanism to save the entire contents of block 0 of REX to a file on TPDD.  This is critical to allow a restore of your REX should there be a problem with the upgrade.
'''REXU1 Description'''


To use REXU, a TPDD device must be attached to the laptop, and be ready to use. The TPDD device must have a copy of the upgrade file, REX###.BR.
What will REXU1 do?  It will-
*  restore your system to nominal (hooks table, REX timer hook, delete OPTROM traces)
*  allow you to SAVE your SYSTEM (current software + directory, 32kb) to TPDD
*  load the 16kb new software load into block 0
* copy the contents of block 0 to block 1
*  restart REXMGR to reinstall the new version of REX


Follow your usual procedures to load REXU#.CO into your laptop.  Make sure you clear enough upper memory to RUNM this application.


The user is first asked if they wish to store the current SYSTEM to disk.  If not, then the user is sent to the next stage in the process.  If the user wishes to create a restore file, then the user must provide a 6 byte file name.  When entering a file name, <ESC> key aborts the process.


System images are 32kbyte binary files with the extension .BR.  When TPDD is ready to use, hitting any key commences a transfer of the SYSTEM to a TPDD file as specified.
'''Steps to a happy upgrade'''


The next stage is the flash upgrade processHere the user must select what type of upgrade is desired - either a 16k upgrade, or a 32k upgradeIn the REX SYSTEM image, the software exists in the first 16k of the image file, and the directories (specific to each REX in use) is stored in the upper 16k. Typically the user will want to keep their directory, and upgrade their software only.  This would be a 16k upgrade.
1Start the upgrade from a cold booted laptopWhile not necessary, it ensures the laptop is working nominally with no lurking problems.  If you have important data please save your current RAM image to REX, and then to TPDD if needed.  


Again, the typical selection is to do a 16k upgrade of the software only.


Only in special cases will the user actually want to do a full 32k upgradeDoing so restores the directories to their original state, erasing any record of the contents of REX.
2.  Regarding your saved RAM images with important data saved within - please back those up to an external TPDD device using the SAVE functionIn case there is a problem, you will be glad you did - it will ensure your data is safe should the REX directory get garbled. This takes only a few minutes.


The user can choose to exit the application at this point by typing <Q> or <ESC>Choosing <1> or <2> selects either 16k or 32k upgrade respectively.
3Download the upgrade package, and place the 2 files in your favorite TPDD device or emulator so they are accessible to the LAPTOP.


Once the size of the upgrade is chosen, the user is again prompted for a 6 byte filename. This filename should be the name of the upgrade file on the TPDD device.  After entering the name, ensure the TPDD device is ready, and hit any key to proceed.
'''DELETE ANY PREVIOUS COPIES OF REXU1.CO and REX146.BR!!!!'''


The flash upgrade of REX commences at this point.


Be careful to keep the laptop powered up during the flash process!
4.  Upload the program REXU1.CO to the laptop.  Issue the command CLEAR0,59960 in BASIC so that REXU1.CO can run.




5.  At the prompt, press Y to save your current SYSTEM to TPDD.  It is recommended that you save your existing image just to be safe.  Keeping the system image allows you to revert to that if something unforseen happens during the upgrade.  Provide a unique filename (something like REXBAK to safely identify the system image backup.




6.  At the prompt, proceed to upgrade the software image by pressing Y, or quit the application using N, Q or ESC. (N, Q and ESC are equivalent).  Confirm your intention to upgrade the system by confirming with Y at the next prompt, or abandon using N.  If you confirm the upgrade, the upgrade process will proceed by erasing the first 16k of the system image, containing the system software, and replacing it with the binary image REX146.BR stored on TPDD.




'''Be careful to keep the laptop powered up during the flash process!'''




REXU will load the new software into block 0, and copy the software to block 1, then it will restart REXMGR to complete the installation.






'''DONE!'''


REXMR.CO is a utility that allows the user to program upgraded main rom images into REX for use in "ROM Replacement" installations.
== REX Release 4.6 Upgrade Package ==


Standard REX SYSTEM images contain the REX Manager software (16kb) and the default directories (16kb), and are 32kb binary files.




== Rel. 4.5 testing: bug reports/fixes ==
Upgrade images include only the REX manager software (16kb).




1)  It has been pointed out that if one deletes REXMGR.BA, it can be difficult to get it back. I'm thinking of an emergency keystroke that will allow one to recover from this.
For M100/T102, images have filenames of REX1XX.BR, and T200 images have filenames of REX2XX.BR, where XX is the release number.


2)  REX is limited to 12 images right now.  I will have a fix ready in the next release.


Upgrade program REXU1.CO or REXU2.CO are included as applicable in the upgrade package.


== Rel. 4.3 Beta testing: bug reports/fixes ==


I should not have sent out the "4.3 beta" a few weeks ago as it was too alpha.
Once the upgrade is GA I will post it here.


I found a number of bugs that were subtle and affected stability.  Now that those are resolved, and the TPDD routines are robust to TPDD problems, I now have a candidate final load.  All the features I have considered have been implemented.


R4.3b supports M100/T102 only right now.
<table border="1">
 
<tr><td>Status</td><td>Release</td><td>Model</td><td>Description</td><td>File</td><td>Submitter / Date</td></tr>
Tested drive targets include:  NADSbox, LaddieCon, TPDD-1, TPDD-2
<tr><td>Beta</td><td>1.0</td><td>M100/T102</td><td>REX Upgrade Package</td><td>TBD, private</td><td>[[User:Sadolph|Sadolph]] 13:06, 13 June 2010 (PDT)</td></tr>
 
</table>
 
 
1)  fixed in 4.3 - timeout of TPDD 1/2 - after loading an image, a command response times out at the end...need to extend the timeout delay.
 
== Rel. 4.2 Beta testing: bug reports/fixes ==
 
1)  DONE R4.3 - found error in code - Year bug - the year data is not correctly preserved by REX when RAM images are saved and loaded.  Solution - implement a mechanism that maintains the year data properly.
 
2)  directory bug with entry for block 31 - it appears that the name entry for block 31 is not displayed correctly, investigation continuing.
 
3)  DONE R4.3 - sound is disabled - sounds - currently REX uses audible clicks to indicate progress, which can be annoying.  Solution - disable audio, replace with some other mechanism.
 
4) DONE R4.3 - directories are now sorted in descending order of date/time - directory order - current directory entries are displayed in order of block number, which is problematic since this causes reordering whenever REX garbage collection forces an image to be moved from one block to another. 
 
5)  DONE R4.3 - Overall stability - Identified and fixed two subtle bugs relating to interrupt handling and bank switching.
 
6)  DONE R4.3 - Robustness for TPDD routines - major rewrite of the TPDD routines in 4.3.
 
7)  DONE R4.3 - included choice for refresh or revert - Restore from current ram image - there is no easy way to restore from the current backup image.  Solution TBD. work around is to copy the backup image to a new block, and then install that image.
 
8)  DONE R4.3 - non-blank block recovery - it is possible that REX attempts to copy an image to a non blank block.  This situation is indicitive of a problem with the system since this should never happen.  If it does occur, the system gets in a deadlock condition.  Solution - make sure REX has no bugs in this functionality first, but an option to "name" or "delete" the offending block would be a nice safety system.
 
9)  DONE R4.3 - enter function displayed on line 2 - state function of <enter> for cursor item on screen somewhere - don't leave it to memory only


10) DONE R4.3 - <TAB> is included in top line now - indicate <tab> is used to toggle groups.
== About Main ROM Management  ==
Please see the main REX wiki page for a description of this feature - how to prepare a ROM image, how to modify the hardware, and how to load REX with images.


11) DONE R4.3 - order is now RAM ROM OS (SYS) (SYS is a superuser feature) - change group display order to avoid tabbing past OS type.
== Rel. 4.6 Known Issues ==
*  Startup of REX Manager is slow.  I will be making improvements in the next release.
*  No ability to transfer files from stored RAM images is a pain.  Look to the next release.


== Rel. 4.6 bug reports/work arounds ==


None yet!


== Enhancement Requests ==
== Enhancement Requests ==
Line 170: Line 181:
<tr><td>Unknown</td><td>Support for so called Paired Switching, where a RAM image is swapped and an OPTROM image is switched in the same step. </td><td>[[User:Sadolph|Sadolph]] 05:17, 15 August 2009 (PDT)</td></tr>
<tr><td>Unknown</td><td>Support for so called Paired Switching, where a RAM image is swapped and an OPTROM image is switched in the same step. </td><td>[[User:Sadolph|Sadolph]] 05:17, 15 August 2009 (PDT)</td></tr>
<tr><td>Unknown</td><td>Support import of file from frozen RAM image to the thawed RAM image. RAM images can be used in a way similar to subdirectories. Therefore it is useful to be able to retrieve files from frozen RAM images</td><td>[[User:Jhoger|Jhoger]] 08:16, 16 April 2009 (PDT)</td></tr>
<tr><td>Unknown</td><td>Support import of file from frozen RAM image to the thawed RAM image. RAM images can be used in a way similar to subdirectories. Therefore it is useful to be able to retrieve files from frozen RAM images</td><td>[[User:Jhoger|Jhoger]] 08:16, 16 April 2009 (PDT)</td></tr>
<tr><td>Done R4.3</td><td>Suggestion: make the TAB order OptROM, RAM image, Main ROM since Main ROM switch will be significantly less used. (order is now RAM ROM OS SYS)</td><td>[[User:Jhoger|Jhoger]] 19:54, 18 April 2009 (PDT)</td></tr>
<tr><td>Done R4.3</td><td>Add a visual progress indicator for flash functions.</td><td>[[User:Sadolph|Sadolph]] 04:36, 19 April 2009 (PDT)</td></tr>
<tr><td>unknown</td><td>Support for TPDD-2, for drive 1: (0: is supported).</td><td>[[User:Sadolph|Sadolph]] 04:36, 19 April 2009 (PDT)</td></tr>
<tr><td>unknown</td><td>Support for TPDD-2, for drive 1: (0: is supported).</td><td>[[User:Sadolph|Sadolph]] 04:36, 19 April 2009 (PDT)</td></tr>
</table>
</table>

Latest revision as of 18:15, 22 October 2010

Supported Models

M100 and T102, with either REX or REX2.


New Features

  • Main ROM Replacement feature, allowing users to load and update the main system ROM
  • ROM2/Cleuseau is now supported
  • REX system information and acknowledgements display added
  • Checksum added into TPDD routines
  • Improved bank switching
  • Stronger directory structure testing
  • Minor changes to MENU controls
  • More descriptive Help files


Bug Fixes

  • the 12 block limitation in Release 4.5 is resolved
  • an issue affecting overall stability was identified and fixed

REX Operation Overview

RAM/ROM/OS Menu

REX is an option ROM switcher that also includes RAM backup and switching functions. REX manages RAM or ROM data in 32k blocks, refered to as images. Option ROMs may be loaded into REX images and selected for use, and your system RAM may be copied to or restored from REX images. Images are grouped by type (RAM/ROM/OS). SYS images are reserved for system use. Images may be 'Load'ed or 'Save'd to/from TPDD.

Filename extensions are

 .BX is used for Option ROM images
 .BY is used for RAM images
 .BZ is used for OS images
 .BR is used for REX system images

Images may be 'Name'd, 'Copy'd or 'Kill'ed. Up to 16 images of any one type are allowed, with 24 images in total. An Image is 'ACTIVE' when in use by REX, and is marked with a *. There must always be one active RAM and one active ROM or OS image. You cannot kill an active image. Active status is changed by selection of a new image using the <ent> key. OS images are option ROMs that act as independant operating systems.

Keyboard Commands

 b Block number information
 e Hints on <ENTER> key functions
 i Information on REX system
 c Checksum of menu entry image
 s Toggle directory sort order
 ent Take action for selection
 tab Show directory for next image type
 esc return to menu


Function Keys

 F1 Display help screens
 F2 Load/Save image from/to TPDD
 F3 Copy image to REX
 F4 Delete image from REX
 F5 Rename the image
 F6 Reserved for future function
 F7 Deinstall REX software from laptop
 F8 Exit REX Manager

SYS Menu

This menu is used to manage system related tasks, primarily management of the loaded main ROM images used when REX is replacing the internal ROMs. See the Wiki to learn the steps required to configure your laptop for ROM Replacement, and how to create ROM images that are compatible with REX. (ROMs require a small change so that REX can detect the hardware configuration.) REX Manager screens now indicate the status of the ROM Replacement function. In the top left corner there is a single highlighted character, one of (M, P, S). This character indicates which system ROM is in use - internal or REX based.

 M - standard internal ROMs in use
 P - Primary ROM (block 2)in use
 S - Secondary ROM (block 4) in use

When the internal ROM is in use, REX cannot provide ROM Replacement. Primary or Secondary ROM images may be 'Load'ed via selection from menu. When the laptop is configured to provide the system ROM, the power-up default is to use the Primary ROM in block 2. It is a good idea to leave this block configured with the standard image. 'Use' command allows the user to select either Primary or Secondary ROMs for use. This selection is tracked in the active block directory, so that system state is always restored on power up. Timestamps are recorded also. Messages are shown above the entries to give some information about the block under the cursor.

Keyboard Commands

 b Block number information
 i Information on REX system
 c Checksum of menu entry image
 tab Show directory for next image type
 esc return to menu

Function Keys

 F1 Display help screens
 F2 Load image from TPDD
 F3 Select ROM image for use
 F7 Deinstall REX software from laptop
 F8 Exit REX Manager

Upgrade Procedure

Current beta release is dated October 17, 2010 and has a checksum of B5BF.

What you need

  • REXU1.CO
  • REX146.BR
  • your favorite TPDD device connected to the laptop

The upgrade procedure is quite simple. The upgrade package contains a program called REXU1.CO (the upgrader tool) and a 16k binary image of the new REX software load called REX146.BR.


Why 16k?

  • the goal of the upgrade is to jam in new software on top of your existing directory
  • we need to preserve your directory information


The upgrade assumes you have a working REX or REX2 running software release 4.5. This is a mostly safe assumption, since all REX and REX2 to date have been only got Release 4.5.


The upgrade tool REXU1 runs in RAM and relies on a connected TPDD device to make the software upgrade image available.


REXU1 Description

What will REXU1 do? It will-

  • restore your system to nominal (hooks table, REX timer hook, delete OPTROM traces)
  • allow you to SAVE your SYSTEM (current software + directory, 32kb) to TPDD
  • load the 16kb new software load into block 0
  • copy the contents of block 0 to block 1
  • restart REXMGR to reinstall the new version of REX


Steps to a happy upgrade

1. Start the upgrade from a cold booted laptop. While not necessary, it ensures the laptop is working nominally with no lurking problems. If you have important data please save your current RAM image to REX, and then to TPDD if needed.


2. Regarding your saved RAM images with important data saved within - please back those up to an external TPDD device using the SAVE function. In case there is a problem, you will be glad you did - it will ensure your data is safe should the REX directory get garbled. This takes only a few minutes.


3. Download the upgrade package, and place the 2 files in your favorite TPDD device or emulator so they are accessible to the LAPTOP.

DELETE ANY PREVIOUS COPIES OF REXU1.CO and REX146.BR!!!!


4. Upload the program REXU1.CO to the laptop. Issue the command CLEAR0,59960 in BASIC so that REXU1.CO can run.


5. At the prompt, press Y to save your current SYSTEM to TPDD. It is recommended that you save your existing image just to be safe. Keeping the system image allows you to revert to that if something unforseen happens during the upgrade. Provide a unique filename (something like REXBAK to safely identify the system image backup.


6. At the prompt, proceed to upgrade the software image by pressing Y, or quit the application using N, Q or ESC. (N, Q and ESC are equivalent). Confirm your intention to upgrade the system by confirming with Y at the next prompt, or abandon using N. If you confirm the upgrade, the upgrade process will proceed by erasing the first 16k of the system image, containing the system software, and replacing it with the binary image REX146.BR stored on TPDD.


Be careful to keep the laptop powered up during the flash process!


REXU will load the new software into block 0, and copy the software to block 1, then it will restart REXMGR to complete the installation.


DONE!

REX Release 4.6 Upgrade Package

Standard REX SYSTEM images contain the REX Manager software (16kb) and the default directories (16kb), and are 32kb binary files.


Upgrade images include only the REX manager software (16kb).


For M100/T102, images have filenames of REX1XX.BR, and T200 images have filenames of REX2XX.BR, where XX is the release number.


Upgrade program REXU1.CO or REXU2.CO are included as applicable in the upgrade package.


Once the upgrade is GA I will post it here.


StatusReleaseModelDescriptionFileSubmitter / Date
Beta1.0M100/T102REX Upgrade PackageTBD, privateSadolph 13:06, 13 June 2010 (PDT)

About Main ROM Management

Please see the main REX wiki page for a description of this feature - how to prepare a ROM image, how to modify the hardware, and how to load REX with images.

Rel. 4.6 Known Issues

  • Startup of REX Manager is slow. I will be making improvements in the next release.
  • No ability to transfer files from stored RAM images is a pain. Look to the next release.

Rel. 4.6 bug reports/work arounds

None yet!

Enhancement Requests

StatusDescriptionRequester / Date
UnknownSupport for so called Paired Switching, where a RAM image is swapped and an OPTROM image is switched in the same step. Sadolph 05:17, 15 August 2009 (PDT)
UnknownSupport import of file from frozen RAM image to the thawed RAM image. RAM images can be used in a way similar to subdirectories. Therefore it is useful to be able to retrieve files from frozen RAM imagesJhoger 08:16, 16 April 2009 (PDT)
unknownSupport for TPDD-2, for drive 1: (0: is supported).Sadolph 04:36, 19 April 2009 (PDT)


nb: to put a username+datestamp just type 4 tildes ~~~~