home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 392.lha / tracksalve_v1.3 / Manual < prev    next >
Text File  |  1990-07-03  |  12KB  |  218 lines
  1.  
  2.                              TRACKSALVE
  3.  
  4.     TrackSalve is made to improve the Trackdisk device.  TD has some
  5.     problems and lacks some options.  As far as I know there are three bugs,
  6.     from which one is very bad if more than one drive is connected.
  7.     SetPatch 1.3.2 tries to do something about it, but it is not enough.
  8.     There are people who do not like the sound of an empty drive.  Trackdisk
  9.     cannot handle a track with an error on it.  Then all data on that track
  10.     is lost.  We never know whether the just written data is well stored on
  11.     disk.  Some programs do not switch off the motor.  And yet we are poking
  12.     in Trackdisk, we can just as well make a drive optional readonly.
  13.  
  14.  
  15.                              FUNCTIONS
  16.  
  17.     As already stated, TrackSalve can perform six functions:
  18.  
  19.  1. Standard modification of Trackdisk existing of:  Bugs patched.  The
  20.     patch of the bugs (as far as I know them). These are the
  21.     TD_RAWREAD/TD_RAWWRITE bug and the NoDisk routine (oef!). Now it is save
  22.     to do I/O on one drive and let all your other drives empty.  Write to
  23.     protected disk returns an error, and leaves the unit undisturbed.
  24.     Prewrite mfm update.  Before a track is written back to disk, all timing
  25.     bits are validated again.  This is to prevent the declining of never
  26.     updated sectors on much used tracks.  New coding routines.  Now it is
  27.     possible to use fast memory to do I/O.  This has no obvious function
  28.     now, but imagine the effects when adopted by Commodore and the
  29.     Filesystem with AddBuffers.  If you have fast memory, you can use the
  30.     FastFileBuffer program to change the buffertype.
  31.  
  32.  2. Noclick.  Can be switched on and off for each drive apart.  I think the
  33.     situation is as follows:  Some drives have an electrical switch at the
  34.     home position to prevent stepping below zero.  Other types have a
  35.     mechanical stop.  These you cannot get completely silent.  I think it
  36.     is save to use noclick on the first.  For those with a mechanical stop
  37.     I would not switch noclick on.
  38.  
  39.  3. Readonly simulation.  Each drive can act as if the tab of the inserted
  40.     disk is open.  This is not as simple as it sounds.  The FileSystem
  41.     (DOS) keeps track of disk swapping.  And it asumes that you are not
  42.     able to shift the tab while a disk is in the drive.  Therefore IF there
  43.     is a disk in the drive AND its tab is closed (write-enabled), and the
  44.     drive is swithed over to read-only or read/write, a DiskChange is sent
  45.     out.  This is very unfriendly during a write, so this is delayed until
  46.     the motor is switched off.  Nevertheless, switch a drive from r/w to ro
  47.     or back only when it is quiet.
  48.  
  49.  4. TrackSalvage.  If Trackdisk gives up on a track, this function (if
  50.     enabled) comes to action.  The track is read again and analised.  All
  51.     unsuspicious data is recovered and stored in Trackdisk's buffers.  If
  52.     the requested data is recovered, no error is passed to the calling
  53.     task.  But an attempt to write to this track is denied and results into
  54.     a diskerror.  So faulting tracks are readonly.
  55.  
  56.  5. Verify.  TrackSalve can read back a just written track to check whether
  57.     the data well arrived on disk.  It reads the track into a special
  58.     buffer which is compared with the original write buffer.  Since the
  59.     Amiga is multitasking, it is not possible to know which task should be
  60.     notified about an error.  Therefore it is the user who must decide
  61.     about this.  He can choose between rewrite and ignore.  Rewrite writes
  62.     the original buffer again to disk, and ignore as if we never knew about
  63.     the bad track.  It may be that subsequent rewrites does not lead to a
  64.     good result.  At least the fact is known that something is wrong.  It
  65.     is possible to read-retry by repeating the command:  v read only once,
  66.     vv twice and vvv triple, subsequent v's are ignored.  Multiple reads
  67.     for verify may be useful for usage with very bad drives.
  68.  
  69.  6. Auto update.  The write to disk is delayed until the trackbuffer is
  70.     needed for another track or until an update command is received.  The
  71.     motor also keeps running until a motor off command is received.
  72.     TrackSalve can both do by itself if this function is enabled.  It is
  73.     delayed for about five seconds, that is, the track is updated five
  74.     seconds after the last write command.  The motor is switched off five
  75.     seconds after the last disk access.  Especially Sectorama (which was
  76.     intended for harddisks) will be helped with this function.  But there
  77.     are more. (Diskcopy:  try to diskcopy to a write protected disk).
  78.  
  79.  
  80.                                 COMMANDLINE
  81.  
  82.     If anywhere on the command line one of the chars h, H, or ? are found,
  83.     the whole command line is ignored and nothing is done but a small usage
  84.     explanation is printed:
  85.  
  86.     Syntax: TrackSalve  {[!]<unit>|a {<unit>} {<Command>}}
  87.     Function: Modify a Trackdisk device unit addressed by its unit number
  88.      <no args>         Show present status
  89.     Units:
  90.      0-3   Unit(s)     Succeeding commands are applied to listed units
  91.       a    All         Succeeding commands are applied to all TD units
  92.       !    Warning     Suppress error if the following unit does not exist
  93.     Commands:
  94.     <none> TD in RAM   No special functions (.=default), improved reliability
  95.       o    Original    Let TD execute in its original ROM code
  96.       s    SectorDisk  Let Trackdisk only give errors from bad sectors
  97.       t   .TrackDisk   Normal: Let TD give errors from bad tracks
  98.       n    NoClick     Perform noclick on the unit(s)
  99.       c   .Click       Normal: No noclick
  100.       r    ReadOnly    Make unit read-only, simulate open disk-tab
  101.       w   .WriteEnable Normal: Unit is read/write according to disk-tab
  102.       v    Verify      Read written track back and compare (vv, vvv)
  103.       b   .Believe     Normal: Asume track is written well
  104.       u    Update      Flush track and stop motor after 5 sec idling
  105.       e   .ExtUpdate   Normal: External update and motor off
  106.       /    Separator   E.g. "0/2n"  Units 0 and 2 in RAM, noclick only on 2
  107.      h ?   Explain     If given (anywhere), no commands are executed
  108.  
  109.     Comma's, spaces and dashes are completly ignored.  Characters which are
  110.     not defined lead to an abortion of the program without executing any
  111.     function.  This will be emphasised by a message via standard out.
  112.     Abortion always has a return value of 20.
  113.  
  114.     Units
  115.  
  116.     You must address an unit by its number instead of its DOS-name.  This
  117.     is because we are modifying an Exec-device and not a DOS-device.  This
  118.     device has nothing to do with DOS.  DOS uses it, and builds a system
  119.     around it.  The name of this system is for example "DF0:". Valid
  120.     numbers are 0, 1, 2, 3, a and A or any combination of them. 'A' means
  121.     all units.  Commands are single characters.  Before you give a command
  122.     you must specify one or more units to apply the command to.  A command
  123.     will be passed to all directly preceding listed units.  If a unit is
  124.     given that does not exist, then this is an error and nothing will be
  125.     done at all.  It can come handy if it is possible to give a unit that
  126.     does not exist.  Normal would be aborted with return code 20.  But if
  127.     a '!' is put before a possible non-existing unit, a message is printed
  128.     and the program continues normally, but returns 5.
  129.  
  130.     Commands
  131.  
  132.     Just a list of units and no commands results in the execution of
  133.     Trackdisk in RAM with repaired bugs. "TrackSalve a" or "TrackSalve
  134.     023". Commands are applied only to preceding units.  F.e. TrackSalve
  135.     01n lets units 0 and 1 stop clicking.  Now you can add new unit numbers
  136.     like:  TrackSalve 01n2r1s.  This results into noclick on units 0 and 1,
  137.     unit is 2 readonly and unit can salve tracks.  It is also possible to
  138.     give contradictory commands:  TrackSalve an1c lets all units except 1
  139.     noclicking.  The separator '/' is a donoting command or "unit list
  140.     reset". TrackSalve 012/2n lets the units 0, 1 and 2 execute in ram, but
  141.     noclick is only performed by unit 2. Reset to a defined state can be
  142.     done by TrackSalve ao followed by the new state.  TrackSalve without
  143.     any parameters prints the present situation and changes nothing.
  144.  
  145.  
  146.                               HOW TO USE IT
  147.  
  148.     Although Disksalv works well without, both programs work very well
  149.     together.  Disksalv with TrackSalve will generally operate faster and
  150.     more clearly.  It also is possible (not yet happened) that the
  151.     combination can salve more data.  Sometimes only one file is the effort
  152.     of salvage worthy, like the latest modification not yet on a backup.
  153.     Now there is a chance that the file can be saved with copy.  Might save
  154.     some time.  Then it is possible that immediately after disk insertion a
  155.     requester appears with "unreadable" and "diskdoctor" or so.  There is a
  156.     fair chance that with TrackSalve these requesters stay away and the
  157.     disk will be accepted as a DOS disk.  You can do more in that case.
  158.  
  159.  
  160.                              IMPLEMENTATION
  161.  
  162.     The Trackdisk code will be copied from the operating system program and
  163.     modified and extended.  For each unit apart, the unit task can execute
  164.     this code or stay with the original in ROM.  If a unit cannot be brought
  165.     to execute the patched code, this is told in a message on standard out
  166.     and the program will continue normally but its return value will be 10.
  167.     There are two functions which use a buffer of about 26k.  If not
  168.     available at the moment of enabling, every .5 second this is tried to
  169.     allocate again.  Until the allocation is successful, the function
  170.     becomes not active.  This is reported through a message and the return
  171.     value will be 10. Execute TrackSalve without parameters to be sure the
  172.     function became active.  This buffer is shared among all tasks.
  173.     Normally this will work smoothly and without delay except when a
  174.     requester is displayed.  The requester is used when a verify error has
  175.     been detected.  If for some reason it is not possible to pop up a
  176.     requester, TrackSalve will loop rewriting the track and blink the
  177.     drive's led until the conditions have changed.  These are:
  178.  
  179.     1. The disk is removed.
  180.     2. The track is found well on disk.
  181.     3. There is enough memory to display the requester.
  182.  
  183.  
  184.                               PERFORMANCE
  185.  
  186.     The mfm revalidation costs some time.  It is not an exact value, but it
  187.     will stay well under 2 procent.  The encoding routines and track
  188.     maintenance became much faster because these can now ignore the timing
  189.     bits.  Track verify takes a lot of time, but it is done very efficient
  190.     this close to the object.  I measured an average increase of 30 procent.
  191.     To get these results, I did a file level diskcopy of a 70 procent full
  192.     disk to a duplicate.
  193.  
  194.  
  195.                                 HISTORY
  196.  
  197.     Version 1.0 had a guru 3 type bug, but the faulting code was (almost)
  198.     never executed.  This version could be updated to 1.01 by a patch
  199.     program PatchTS.
  200.     Version 1.2 had multiple reads with verify implemented for users with
  201.     very bad drives.
  202.     Version 1.3 had mfm revalilidation adopted from Pcopy, new coding and
  203.     decoding routines allowing fast buffers and auto update implemented.
  204.     Also a write to a write protected disk is denied.  Verify comparision
  205.     is now done by the blitter.  And a unit is more likely to be caught.
  206.  
  207.  
  208.                                COPYRIGHT
  209.  
  210.     Copyright (c) 1990 D.W.Reisig.  This program may be distributed on
  211.     non-commercial base.  This program may not be distibuted on commercial
  212.     base without my permission.
  213.  
  214.     D.W.Reisig
  215.     Woudweeren 10
  216.     1151 AV  Broek in Waterland
  217.     Holland
  218.