mirror of
https://github.com/wwarthen/RomWBW.git
synced 2026-02-06 22:13:13 -06:00
Clean Up NVRAM Switch Terminology
- Essentially, switch from the term "default boot" to the term "boot options". See Issue #451
This commit is contained in:
Wayne Warthen
@@ -398,23 +398,23 @@ system configuration.
|
||||
|
||||
### Basic Operation
|
||||
|
||||
The application is an interactive application it does not have command line syntax.
|
||||
The application is an interactive application; it does not have a command line syntax.
|
||||
Instead commands are executed from within the application in a command line structure.
|
||||
|
||||
When you first start the (`SYSCONF`) utility it will display the current switches
|
||||
followed by a command listing.
|
||||
|
||||
When you first run the (`SYSCONF`) utility the NVRAM will be uninitialised, and can
|
||||
be initialised using the (R)eset command, which write default values to NVRAM.
|
||||
be initialised using the (R)eset command, which writes default values to NVRAM.
|
||||
|
||||
Updates are done immediately to NVRAM as you enter them, i.e. there is no confirm
|
||||
changes step. If you make an incorrect changes you simply need to enter a new
|
||||
changes step. If you make any incorrect changes, you simply need to enter a new
|
||||
command to set the Switch value correctly.
|
||||
|
||||
Once a change has been made it is available, however may not take effect until
|
||||
Once a change has been made it is available, however it may not take effect until
|
||||
the next system reboot. This is dependent on the Switch itself.
|
||||
|
||||
If no NVRAM is provided by your hardware then running this application will just
|
||||
If no NVRAM is provided by your hardware, then running this application will just
|
||||
report the missing hardware and exit immediately.
|
||||
|
||||
To exit from the application use the (Q)uit command.
|
||||
@@ -445,7 +445,7 @@ character is used to delimit parameters in the command.
|
||||
|
||||
This switch will define if the system will perform auto boot at the RomWBW boot prompt.
|
||||
Enabling this will not prevent a user from typing a boot command, so long as the timeout is not
|
||||
exceeded. When configured this replaces the (`BOOT_DEFAULT`) variable
|
||||
exceeded. When configured this replaces the (`AUTO_CMD`) variable
|
||||
defined in build configuration.
|
||||
|
||||
Making changes to auto boot has no affect until the next reboot.
|
||||
@@ -465,13 +465,13 @@ Making changes to auto boot has no affect until the next reboot.
|
||||
| S AB E,10 | Enable Auto Boot with 10 second delay |
|
||||
| S AB D | Disable Auto Boot |
|
||||
|
||||
#### Default Boot (DB)
|
||||
#### Boot Options (BO)
|
||||
|
||||
This switch will define the default boot command to be executed when pressing enter
|
||||
at the RomWBW boot prompt. When configured this replaces the (`BOOT_TIMEOUT`) variable
|
||||
defined in build configuration.
|
||||
This switch will define the boot command to be executed when auto boot is
|
||||
enabled. When configured this replaces the (`AUTO_CMD`) variable
|
||||
defined in the ROM build configuration.
|
||||
|
||||
Making changes to auto boot has no affect until the next reboot.
|
||||
Making changes to boot options has no affect until the next reboot.
|
||||
|
||||
**Arguments**
|
||||
|
||||
@@ -487,8 +487,8 @@ Making changes to auto boot has no affect until the next reboot.
|
||||
|
||||
| Command | Description |
|
||||
|-------------|----------------------------------------------------------|
|
||||
| S DB D,2,14 | Set the default boot from Disk; Unit 2, Slice 14 |
|
||||
| S DB R,M | Set the default boot to be the (M)onitor Rom Application |
|
||||
| S BO D,2,14 | Set the default boot from Disk; Unit 2, Slice 14 |
|
||||
| S BO R,M | Set the default boot to be the (M)onitor Rom Application |
|
||||
|
||||
## CP/M 2.2
|
||||
|
||||
|
||||
@@ -531,7 +531,7 @@ The following switch ID's are defined, and described in sections below.
|
||||
| Switch Number | Name | Description |
|
||||
|---------------|--------------|-----------------------------------------------|
|
||||
| 0x00 | -reserved- | Reserved |
|
||||
| 0x01 | Default Boot | Default boot, either a Rom App or Disk Boot |
|
||||
| 0x01 | Boot Options | ROM or Disk Boot Settings |
|
||||
| 0x02 | -n/a- | -n/a- high order byte of previous switch |
|
||||
| 0x03 | Auto Boot | Automatically boot enabled without user input |
|
||||
| 0x04 - 0xFE | -future- | Future general usage |
|
||||
@@ -544,18 +544,19 @@ the bytes in NVRAM to check for authenticity before using the configuration.
|
||||
|-------------|--------------|-----------------------------------|
|
||||
| 0x00 | Header Byte | Header Signature Byte 'W' |
|
||||
| 0x01 - 0x03 | Switch Data | Actual Switch Data |
|
||||
| 0x04 | Parity Check | Parity byte to check authenticity |
|
||||
| 0x04 | Parity Check | Checksum byte to check integrity |
|
||||
|
||||
The above data is copied into the HBIOS Configuration Block (HCB) at startup at
|
||||
the location starting at CB_SWITCHES.
|
||||
|
||||
### Default Boot (NVSW_DEFBOOT)
|
||||
### Boot Options (NVSW_BOOTOPTS)
|
||||
|
||||
16 bit Switch defining the default Rom application or Disk device to boot.
|
||||
16 bit Switch defining the ROM application or Disk device to boot if
|
||||
automatic booting is enabled.
|
||||
|
||||
| Bit 15 | Bits 14-8 | Bits 7-0 |
|
||||
|-------------|-------------------|--------------------|
|
||||
| 1 = Rom App | -undefined- | App to Boot (Char) |
|
||||
| 1 = ROM App | -undefined- | App to Boot (Char) |
|
||||
| 0 = Disk | Disk Unit (0-127) | Disk Slice (0-255) |
|
||||
|
||||
### Auto Boot (NVSW_AUTOBOOT)
|
||||
|
||||
@@ -905,24 +905,24 @@ some limited configuration option options inside this NVRAM.
|
||||
Several configuration options are currently supported, these are known as Switches
|
||||
|
||||
* Specify Automatic boot at startup, after an optional delay (AB)
|
||||
* Define the Default Disk or ROM App to be booted at startup (DB)
|
||||
* Define the Disk or ROM App to be booted at for automatic boot (BO)
|
||||
|
||||
RomWBW uses bytes located at the start of RTC NVRAM, and includes a Parity check of
|
||||
the bytes in NVRAM to check for authenticity before using the configuration.
|
||||
RomWBW uses bytes located at the start of RTC NVRAM, and includes a checksum of
|
||||
the bytes in NVRAM to check for integrity before using the configuration.
|
||||
|
||||
Initially NVRAM has to be reset (with default values), before it can be used.
|
||||
As well as setting defaults, it also writes the correct parity, and allows the
|
||||
NVRAM to be accessed and to store RomWBW config.
|
||||
As well as setting defaults, it also writes the correct checksum, and allows the
|
||||
NVRAM to be accessed and to store the RomWBW config.
|
||||
|
||||
This is an explicit step that must be done, as any existing data stored is overitten.
|
||||
If you are using NVRAM for other purposes then you can continue to do so
|
||||
This is an explicit step that must be done, as any existing data stored is overwritten.
|
||||
If you are using NVRAM for other purposes, then you can continue to do so
|
||||
so long as you do NOT perform this Reset step.
|
||||
|
||||
NVRAM may also need to be reset in these circumstances
|
||||
NVRAM may also need to be reset in these circumstances:
|
||||
|
||||
* When there has been a loss of power to the NVRAM.
|
||||
* When upgrading to a new RomWBW version, or a RomWBW version that has new switches.
|
||||
* If the NVRAM has been overitten by another application.
|
||||
* If the NVRAM has been overwritten by another application.
|
||||
|
||||
If you want to continue to use NVRAM in your applications you may want to consider storing
|
||||
your data above the RomWBW Switch data.
|
||||
|
||||
Reference in New Issue
Block a user