home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / utils / asmutl / asmlib.lbr / PROM150.HLP < prev    next >
Encoding:
Text File  |  1991-06-25  |  18.0 KB  |  477 lines

  1.      -------------------------------------------------------
  2.      ****                            ****
  3.      **** THIS IS THE HELP FILE FOR THE PROM150 PROGRAM ****
  4.      ****   Last modified by Richard Holmes 26-01-85    ****
  5.      ****                            ****
  6.      -------------------------------------------------------
  7.  
  8.     This file is scanned and displayed by the PROM150 program.
  9. As various portions of PROM150 are executed, various screens within 
  10. this file can be displayed. This all adds up to the ability to display 
  11. help screens to the user at any time.
  12.  
  13.     Another advantage is that the user can enter or customize these 
  14. screens so that notes or other information can be displayed at certain 
  15. times within the program. This was especially in mind for the CRC routines,
  16. and one particular customer.
  17. :: Section 1
  18.             +------------------------------------+
  19.             | PROM150 Eprom Programmer Help File |
  20.             +------------------------------------+
  21.  
  22.     You have loaded and run the PROM150 program for the PGC-150  
  23. Eprom Programmer Card from SME Systems.
  24.  
  25.     This program allows you to do many powerful and sophistocated
  26. things with proms as well as providing a large range of useful auxiliary
  27. features such as disk file support, editing of data, CRC and checksum 
  28. abilities to name just a few. 
  29.  
  30.     This program is the result of many months of work by SME Systems 
  31. to produce a truly powerful general purpose eprom programmer package. Due
  32. to the investment in time and effort and a commitment to constant 
  33. improvement, SME Systems welcome bug reports, bug fixes, and especially
  34. invite helpful suggestions.
  35.  
  36.     You may address all the above correspondance to Richard Holmes C/o-
  37. SME Systems 22 Queen Street Mitcham 3132, Vict.
  38. >
  39. Pressing Keys
  40. -------------
  41.  
  42.     If you enter a '^C' then the program will terminate. This also
  43. applies to most of the places in the program where a response is being
  44. asked of you. It allows you to quickly exit the program.
  45.  
  46.     In the same way, an ESCape key press will usually get you out 
  47. of what is currently going on and return you to the main menu. This is 
  48. also an escape mechanism.
  49.  
  50.     The '?' key has been provided so that you can get immediate help 
  51. on most of the aspects of the program at any time.
  52. >
  53. The EPROM.DAT Logging File
  54. --------------------------
  55.  
  56.     There is a logging file maintained by this program. It is 
  57. called EPROM.DAT and contains information about the program as well
  58. as some special information that is done by a part of the program.
  59.  
  60.     At MOST TIMES in the program, a Control C will immediately 
  61. exit the program AFTER updating the loggin file.
  62.  
  63.  
  64. Currently
  65. ---------
  66.  
  67.     AT PRESENT, the program is asking if you want to test the
  68. memory buffers. If you respond 'Y' then two memory test routines are 
  69. used to verify that your memory is not faulty. You should do this
  70. occasionally or if you suspect that there is a hardware problem in
  71. your machine.
  72. >
  73. Glossary Of Terms and Usages
  74. ----------------------------
  75.  
  76. BUFFER............An area in the computers memory set to hold a proms' data
  77. EPROM.............Erasable Programmable Read Only Memory
  78. FUSE LINK PROM....A prom that is programmed by blowing out fuses within it
  79. LOAD FROM DISK....Copying a disk file into the computers memory
  80. LOGGING FILE......A file that records activities of the program
  81. MONITOR...........A program that gives basic access to the computer
  82. PROM..............Programmable Read Only Memory. Not erasable
  83. READ A PROM.......Copy the proms data into computer memory
  84. SAVE TO DISK......Copy computer memory into a disk file
  85. TO PROGRAM a PROM.To copy some of system memory into a prom or eprom
  86. VERIFY............Compare two proms or memory and prom
  87. :: Section 2
  88.             +-----------------------+
  89.              | Main Menu Help Screen |
  90.             +-----------------------+
  91.  
  92. SELECTING MENU OPTIONS
  93. ----------------------
  94.  
  95.     You are currently at the MAIN MENU level. From here you can
  96. select options by pressing a single letter that corresponds to a menu
  97. item. The '?' key that got this displayed is an example of this.
  98.  
  99.     Examples of this are pressing 'P' for program a prom or 'R' to
  100. read a prom.
  101.  
  102.     When the letter is pressed, the action is immediately performed, 
  103. there is no need to press the return key.
  104.  
  105. NOTE: You are strongly recommended to always use the program in the same way
  106.       so that mistakes are reduced. It is also for this reason that the 
  107.       buffers have been provided.
  108. >
  109. BUFFERS 1 and 2
  110. ---------------
  111.  
  112.     The two memory buffers have been provided to reduce the need for
  113. giving exact addresses. The idea is for the user to specify a '1' or a '2'
  114. to tell the program to use buffer one or two. This has been done throughout 
  115. the program as an aid to the user. This is also a safety measure, it is so 
  116. easy to type a '1' or '2' that you should rarely make a mistake.
  117.  
  118.  
  119. SELECTING PROMS
  120. ---------------
  121.  
  122.     When you select a prom option, the program immediately initializes
  123. the prom programmer board then displays the NEW PROM type in REVERSE VIDEO.
  124.  
  125.     It is absolutely vital that you always select the correct type of 
  126. prom on the menu. If you do not then you can destroy an incorrect prom. 
  127. The reason for this is that some proms have different pin connections and
  128. when another prom is loaded in its place damage can result.
  129. :: Section 3
  130.         +-----------------------------+
  131.         | Disk File Load Help Section |
  132.         +-----------------------------+
  133.  
  134.     The PROM150 program can load disk files into memory in one
  135. of two ways.
  136.  
  137. 1) As a pure binary image or .COM file. These are the standard type 
  138.    of file and are how the 'SAVE FILE' saves data to disk.
  139.  
  140. 2) As an Intel 'HEX' File. These files are usually the result of an
  141.    assembler or similar. The program will load these files and place 
  142.    them in memory where you specify.
  143.  
  144.     After the load from disk, a message will be displayed to indicate 
  145. the number of bytes loaded and the last address loaded.
  146.  
  147.     The best and most recommended way of doing any disk activity is
  148. via the memory buffers. You do this by telling the program to load a buffer
  149. which the program will then do in one go. 
  150. >
  151.     The loading of large disk files can be tricky. This is because when 
  152. you want to program a large file, you must give the address to start loading 
  153. into memory and the number of bytes to load. If the file is larger than a 
  154. buffer and you load a buffer using the '1' or '2' options then only enough 
  155. bytes will be loaded so that some of your file will be ignored, only a 
  156. buffer full will be loaded.
  157.  
  158.     An example to load a 10 K bte file from disk into memory at 5000h
  159. is to:-
  160.  
  161.     1) Enter the file name as usual
  162.     2) Specify a 'M'emory load
  163.     3) Give the address to start the load as 5000h
  164.     4) Give the number of bytes as 27ffh
  165.     
  166.     After this a little disk activity will show that your file is 
  167. being loaded and when finished, the screen should show the number of 
  168. bytes loaded and the last address used.
  169. :: Section 4
  170.         +---------------------------+
  171.          | Save to disk Help Section |
  172.         +---------------------------+
  173.  
  174.     When you read a prom or do modifications that you want to save
  175. for later use, you can create a disk file and save your work in it.
  176.  
  177.     This is called saving to disk. You copy memory straight to a disk
  178. file. It is worthwhile. The disk file then contains an exact copy of the
  179. memory.
  180.  
  181.     The advantage of this is that the disk file can be later used 
  182. or checked against the contents of the prom for verification. Also,
  183. if it is saved on disk, you can use many programs to do operations
  184. on the file which could not be done while it was in a prom.
  185.  
  186.     When this section of the program is run, the program will ask for 
  187. the disk file name to save the data in. You should type in a short 
  188. descriptive name. Examples are 'MBSBC800.001' which could mean MonBios
  189. SBC-800 version 1.
  190. :: Section 5
  191.         +---------------------------------------+
  192.         | Byte-by-Byte Verify ERROR Help Screen |
  193.         +---------------------------------------+
  194.  
  195.     A byte has not verified while attempting to program your prom. 
  196.  
  197.        You can PRESS an 'I' to ignore the error and continue
  198.                 or
  199.         PRESS a 'Q' to quit programming the prom.
  200.  
  201.             USUAL CAUSES OF THIS ARE
  202.  
  203. 1) Faulty prom                4) Trying AMD devcies with IQS options
  204. 2) Not erased prom            5) Incorrect insertion of the prom
  205. 3) Faulty programmer card        6) Wrong prom type
  206.  
  207.     You should check the above list before proceeding.
  208. >
  209.  
  210.     When a prom is being programmed, each byte in the prom is 
  211. checked that it matches exactly what was asked to be programmed into 
  212. the prom. This is called verification, you check that the data in the 
  213. prom matches the data in your computers memory.
  214.  
  215.     The byte-by-byte error occurs when a byte is written to the prom
  216. and it does not 'take'. Usual caused are outlined on the provious page but 
  217. usually mean that something went wrong with the prom, the programmer or you 
  218. inserted the prom type.
  219.  
  220.     After checking the above list, you can try another prom and see 
  221. if it was just the prom at fault. If the new prom does in fact program 
  222. all right then you have a dud original prom
  223. :: Section 6
  224.         +--------------------------+
  225.          | Final Verify Help Screen |
  226.         +--------------------------+
  227.  
  228.     After all the bytes were programmed AND individually verified, Your 
  229. prom HAS NOT VERIFIED. This verify is done is standard read mode.
  230.  
  231.     You can enter a 'Q' to quit the verify or an 'I' to ignore the 
  232. error and to continue the verification.
  233.  
  234.         Here are some things to check.
  235.  
  236. 1) If there was no byte-by-byte verify error then you have a speed
  237.    problem as the prom has passed an initial verify. Suspect prom.
  238. 2) Are the prom legs dirty - clean with meths if necessary.
  239. 3) Is the prom inserted correctly into the socket?
  240. 4) Are the switches set correctly?
  241. 5) Did you select the correct prom type?
  242. 6) AMD brand proms will not program with IQS options.
  243. >
  244.  
  245.     The PROM150 program is very belt-and-braces in that each byte is
  246. checked immediately after is has been programmed and again when all bytes 
  247. in the prom have been programmed. This is a double verify and has been
  248. put into the program as a means of testing and reassurance to the user that
  249. errors are always spotted.
  250.  
  251.     The previous list of things should be checked before any keys are
  252. pressed. The most usual causes for this error are faulty proms, poor switch 
  253. settings and operator mistakes in general.
  254. :: Section 7
  255.             +-----------------------------+
  256.             | Memory or PROM CRC Routines |
  257.             +-----------------------------+
  258.  
  259.     This section of PROM150 allows you to get the CRC and the CHECKSUM
  260. of any portion of memory in the computer you are now using.
  261.  
  262.     The recommended use for this is to read a prom into a buffer from 
  263. either disk or from the programmer card then extract the CRC and CHECKSUM 
  264. that you require by giving the appropriate commands.
  265.  
  266.     AT PRESENT the program is asking you if you wish to do the 
  267. calculations on BUFFERS or MEMORY.
  268.  
  269.     If you enter a 'B' then the two memory buffers are used and the 
  270. screen displays the CRC and CHECKSUMS for these whole regions of memory.
  271.  
  272.     If you enter a 'M' then the program will then ask for a starting
  273. address (in hex) and the (hex) number of bytes to do. A second later the
  274. CRC and CHECKSUMS will be displayed along with their compliments.
  275. ..over for more
  276. >
  277.         +---------------*---------------+
  278.         |     SPECIAL INFO SECTION    |
  279.         +---------------*---------------+
  280.  
  281.     Use this page to display informaton about where your special
  282. proms need have their CRCs or CHECKSUMS take from.
  283.  
  284. NAME        Start   Size    ---- Comment ----
  285. ------------------------------------------------------------------------
  286. Scale        5000    1CFE    Put LOW byte of checksum at 51CF
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294. ------------------------------------------------------------------------
  295.  
  296.  
  297.  
  298.  
  299. :: Section 8
  300.             +------------------------------+
  301.             | CRC and Checksum Help Screen |
  302.             +------------------------------+
  303.  
  304.     The CRC and Checksum routines allow you to get the 'personality' 
  305. of the contents of memory regions or the complete memory buffers. Uses 
  306. for this include protection and tracing of piracy and checking of prom 
  307. integrity.
  308.  
  309.     The most popular choice for this is the standard CHECKSUM mode 
  310. which is a simple addition of the specified number of bytes. This addition 
  311. can then be saved into the prom for later checking. Some small machines
  312. require their checksum to be saved in their roms for them to operate at
  313. all. This is the main reason for this part of the program.
  314. :: Section 9
  315.         +-----------------------+
  316.         | Special Help Screen 1 |
  317.         +-----------------------+
  318.  
  319.     This help screen is supplied for the user to change as required 
  320. so that at a later date reference can be made back to know a required 
  321. fact. This screen is displayed when the 'H' option in the program is 
  322. entered. The next screen is also displayed when required.
  323.  
  324. :: Section 10
  325.         +-----------------------+
  326.         | Special Help Screen 2 |
  327.         +-----------------------+
  328.  
  329.  
  330.  
  331. :: Section 11
  332.         +--------------------------------+
  333.         | Standard PROM CRC routine Help |
  334.         +--------------------------------+
  335.  
  336.     This section of PROM150 allows you to get the CRC or CHECKSUM of 
  337. the prom buffers. This is very useful if you wish to check a prom 
  338. against a previously known value. In this way you can determine if 
  339. a prom has changed which may be causing your problems.
  340.  
  341.     When this routine is used, the state of the AUTO CRC flag selects
  342. whether or not the routine tests the generated against an assumed stored
  343. crc at the rear of the prom. In this way, you can load the CRC into a prom
  344. and then at a later date, do a 'U' option with the 'O' options auto CRC
  345. flag set on and you will check whether or not the data in the prom 
  346. matches the crc saved in the prom. 
  347.  
  348.     If the auto crc flag is off, the CRC is displayed. Note that the
  349. state of the CRC-CHECKSUM flag determines the type of value returned. If 
  350. CRC then the CCITT value is returned else the more simple addition value 
  351. is returned.
  352. :: Section 12
  353.             +----------------------+
  354.             | Defaults Help Screen |
  355.             +----------------------+
  356.  
  357.     The defaults section allows you to alter the way the program works
  358. by changing the contents of the EPROM.DAT file. Since the changes are saved, 
  359. you only rarely need to use this ability. The following is a description of
  360. what changes you can make.
  361.  
  362. *******************
  363. * Auto Serializer *
  364. *******************
  365.  
  366.     When the AUTO SERIALIZER is set to ON, the program will offer to 
  367. set the last two locations in your prom to the serial number maintained 
  368. by this program. This is only useful if you have the last two locations
  369. in your prom free for use by this.
  370.  
  371. >
  372. *****************
  373. * Serial Number *
  374. *****************
  375.  
  376.     The serial number maintained by this program is an incrementing 
  377. number that is a count of the number of proms programmed. In this way, 
  378. you can (say) program ten proms and so then each will have a different 
  379. serial number, each one greater than the previous one.
  380.  
  381.     This facility is very useful for security purposes as it allows 
  382. you to note where proms are going so that you can keep a track on the 
  383. circulation of your proms.
  384.  
  385. >
  386. ************
  387. * Auto CRC *
  388. ************
  389.  
  390.     Like the auto serializer, the AUTO CRC facility allows you to place
  391. a CRC or CHCKSUM into your prom at two location just previous to the auto
  392. serializer. This allows you to save the 'personality' of your prom so that 
  393. it can check itself for errors etc. 
  394.  
  395. ************
  396. * CRC MODE *
  397. ************
  398.  
  399.     The CRC MODE toggle has two  basic modes, CCITT CRC and CHECKSUM.
  400.  
  401. -- The CCITT mode uses the proper 16 bit polynomial to generate the CRC 
  402.    of your prom.
  403. -- The CHECKSUM mode uses a simple addition of all the bytes in your prom
  404.    to generate the value.
  405. >
  406. ********************
  407. * Buffer 1 Address *
  408. ********************
  409.  
  410.     There are two buffers used by this program for holding the contents 
  411. of proms ready for programming or for reading proms into. Buffer 1 is the 
  412. most used of the two buffers and it is this buffer that the 'E'dit option 
  413. comes into by default. 
  414.  
  415.     You are strongly recommended to set this address to 5000 (hex) as 
  416. this leaves enough room for the second buffer and misses the program.
  417.  
  418. ********************
  419. * Buffer 2 Address *
  420. ********************
  421.  
  422.     This is the second prom I/O buffer. You are recommended to set
  423. the address of this buffer to 9000 hex.
  424. :: 13
  425.             +--------------------------+
  426.             + Verify Proms Help Screen +
  427.             +--------------------------+
  428.  
  429.     The verify proms option has been included to allow you to check if
  430. the contents of two proms are the same. This is very useful if you have 
  431. done a run of programming proms and one or more of your proms have failed 
  432. in the end users machine. Using this option you can read a known good prom
  433. into buffer 1 then compare this to a prom read into buffer 2.
  434.  
  435.     The things to remember with this routine are that the two memory 
  436. buffers are loaded from the prom (over written). You can skip this by 
  437. entering an 'S' to skip the load. In this case the current contents of 
  438. the buffer are used for the verify.
  439. :: 14
  440.              +-------------------------+
  441.                      + Fill Memory Help Screen +
  442.                      +-------------------------+
  443.  
  444.     This routine has been provided on the main menu to allow you to
  445. quickly and safely fill memory and or buffer areas with a single byte.
  446.  
  447.     The most common reason for this is to pre-initialize memory before
  448. reading a disk file into it or prior to reading a portion of a prom into a
  449. buffer. By filling the buffer with a single set byte, you are often able to
  450. reduce the time taken to program a prom since this program does not try to 
  451. program blank bytes into a blank prom.
  452.  
  453.     An example of this would be to load buffer 1 with 'FF' bytes, load 
  454. a program from disk into the buffer so that if the file is not exactly the
  455. length of the buffer, the rest of the buffer is blank.
  456. :: Section 15
  457.  
  458.               +------------------------------+
  459.               + Prom Programming Help Screen +
  460.               +------------------------------+
  461.  
  462.  
  463.  
  464.  
  465.  
  466. :: Section 16
  467.             +--------------------------+
  468.             + Prom Reading Help Screen +
  469.             +--------------------------+
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476. ..end
  477.