12345678911234567892123456789312345678941234567895123456789612345678971234567898 HYPERDISK CONFIGURATION UTILITY USER MANUAL Version 3.30 29th May, 2003 Product Version: HyperCFG - 3.3 PURPOSE: This document details the revisions made in this version of the product. This document is intended for users. GENERAL DESCRIPTION: HYPERCFG is a DOS command line utility for HYPERDISK IDE RAID. The main features supported in this version of the utility are: 1. Automatic Configuration of RAID for RAID 0, 1 and 10 2. Special RAID 0 Configuration support. 3. Display RAID configuration information. 4. Save RAID configuration information to file 5. Configure RAID from file 6. Set/Reset specified global RAID flags (Write Cache, Virus Protection and DMA ) 7. Display RAID BIOS version 8. Read/Update timestamp of RAID configuration 9. Read and display specified sector from drive 10. Dump specified sector to BIN file 11. Dump BIN file to specified sector. 12. BIOS keyboard interfaces have been replaced with DOS keyboard interfaces, so input can be redirected. 13. BIOS video interfaces have been replaced with DOS video interfaces, so output can be redirected. 14. Error code information added. 15. Set Max Address feature added 16. DUMP ID command pkt. Data to bin file 17. Reset MAX address to Native max address. 18. SMART feature enable/disable. 19. New features flag defined - bit:5 - Pause Flag, bit:6 R0- >R1 promotion 20. New options added for saving and restoring config. Using bin files. 21. Support for 680 controller added. 22. New Feature added for displaying the Rebuilding status of a logical Drive, if any of its Physical Drive is in Rebuilding state. USAGE: HYPERCFG [CONFIGURATION OPTIONS] [DRIVE-ID] [DISPLAY OPTIONS] [MISCELLANEOUS OPTIONS] [ /S ] [ /F[FILENAME] ] /X /S - Silent Operation: When this option is set, the utility does not prompt the user. /F[FILENAME]: This Option redirects the output to the specified FILENAME If FILENAME is not specified then the default file is taken to be HYPERCFG.DAT. CONFIGURATION OPTIONS: These options are used to configure the RAID. The valid switches are: /A[m] [/!] [/2]- Automatic RAID configuration m = S[STRIPE SIZE] - configures RAID in STRIPE MODE(RAID-0) with specified STRIPE SIZE. STRIPE SIZE must lie within the range [32, 64, 128, 256, 512, 1024, 2048, 4096]. If invalid STRIPE SIZE is specified the utility assumes 64K STRIPE SIZE. Default STRIPE SIZE is 64k m = M - configures RAID in MIRROR MODE (RAID-1) m = R[STRIPE SIZE] - configures RAID in RAID 10 mode with specified STRIPE SIZE. STRIPE SIZE must lie within the range [64...4096], in multiples of 4K. /! - When invoked with this option, only one drive is configured in RAID-0 mode and the other drive is added as spare. This option works only when two drives are present in the system. This is invoked with /AS option. /2 - Enable 2mb size reduction for drive size reported in IRCD. DRIVE-ID: Drive id is specified by /C[n] /D[cd] /C[n] - Specifies the card no. If n is not specified, then it is taken to be 0 /D[cd] - Specifies the drive no. c = Channel No. (0 - for Primary, 1- for Secondary) - default is 0 d = Master/Slave (0 - for Master, 1 - for Slave) - default is 0 /T[o] /C[n] /D[cd] - Reads / Updates time stamp information in configuration. O = R - Reads and displays the time stamp info in: DD/MM/YYYY - HH:MM:SS format. This option expects valid O = I - Inserts the current time stamp info in the configuration. Default Option: If [o] is not specified then the default option is [I] /O[oooooo] - Sets / resets the RAID global flags - Write Cache and Virus Protection ooooo = W - Switches ON Write Cache flag ooooo = B - Switches ON Virus Protection flag ooooo = D - Switches ON DMA flag ooooo = P - Set No-Pause-on-Prompt flag. BIOS would not pause on any messages if this flag is set ooooo = M - Set R0->R1 promotion flag BIOS would configure any new drives by promoting a single RAID 0 with single drive to RAID 1 and adding the new drive in rebuild state Resetting this flag would configure new drives as SPARE. ooooo = R - Resets specified flags, if no flags are specified, all flags are reset Default Option: If [oooooo] is not specified then the default option is [R] /L /C[n] /D[cd] [/b[filename]]- Displays the configuration sector of the specified drive - If ONLY /L is used, the configuration sector of the first available drive is displayed. The order of searching for the first available drive is: Card 0 Channel 0 Drive 0 - Primary Master Card 0 Channel 0 Drive 1 - Primary Slave Card 0 Channel 1 Drive 0 - Secondary Master Card 0 Channel 1 Drive 1 - Secondary Slave Card 1 Channel 0 Drive 0 - Teritiary Master. - If either /D or /C is specified then the configuration sector of the specified drive is displayed - /b[fn] - saves the IRCD in a bin file - fn. If fn is not specified, default is HYPERCFG.BIN /E /C[n] /D[cd] - Erases the configuration/error log sector of specified drive o = C - Erases the configuration sector o = E - Erases the error log sector o = A - Erases both configuration and error log sector /@[textfile ] [/B[binfile] - Configures the RAID from specified configuration file To restore configuration from verbose mode text file use /@[textfile] if textfile is not specified, then default is HYPERCFG.CFG To restore configuration from binary file use /@ /b[binfile] if binfile is not specified, then default is HYPERCFG.BIN DISPLAY OPTIONS: This option determines how the data is displayed. This option is valid only for /I option. /W[o] - Specifies display mode o = V - Display in verbose mode Default Option: If [o] is not specified, then display will be as HEX Dump. MISCELLANEOUS OPTIONS: /M[r/] /C[n] /D[cd] This option allows the user to set the maximum accessible sectors on the Harddrive that supports this feature. The address is specified in HEX /Mr - Resets the max. address to NATIVE MAX ADDRESS of HDD. /P[S] /C[n] /D[cd] - Switches the drive to specified state. S = S - Drive is powered on in Suspend state. Default Option: If [S] is not specified, then the drive is switched on in Active state. /V - Detects the Presence of RAID BIOS and displays the version of BIOS /R[n] [/$[FILENAME]] [/B[FILENAME]] /C[n] /D[cd] - Reads and displays the 'n'th sector If 'n' is not specified then sector no. is taken to be 0 /B option dumps specified sector to the specified file in BIN format /$ option dumps specified BIN file to the 'n'th sector The default filename is HYPERCFG.BIN /X - This option pauses and waits for keystroke if any error occurs on executing HyperCFG. /I[a] /C[n] /D[cd] [/B[filename]] - Displays the information about the specified drive /Ia displays ID Device Packet for all drives present. /Bfilename - Saves the 512 byte ID info. Pkt. To filename. If filename is not specified, then the default filename is HYPERCFG.BIN This option should NOT be used with /Ia option. /Z[E/D] - Enables / Disables SMART feature. Default option is ENABLE Getstatus 'N' - Displays the Rebuilding Status of the Logical Drives in a given Adapter if any of its Physical Drive is in rebuilding state. Where - 'N' is the Adapter number (1,2,3,4) Note: Exit code returned can be modified using qualifer /Q. When /Q is specified, config. related commands return ARRAY COUNT on SUCCESS. In all other cases ERROR LEVEL is returned.( Refer ERROR LEVEL for various error codes and their meanings ). All the other options except /S, /F, /B, /@, /$ & /W will have default arg as zero. CONFIGURATION FILE: This file is used for configuring the RAID. The configuration file is case insensitive and ignores white spaces and tabs. The configuration file contains 3 logical blocks strictly in the specified order. 1. RAID INFO 2. LOGICAL DRIVE INFO 3. PHYSICAL DRIVE INFO RAID INFO: This logical block starts with the keyword TOTAL_LOGICAL_ARRAYS. This block must be organized as follows: TOTAL_LOGICAL_ARRAYS : TOTAL_PHYSICAL_DRIVES : OPTIONS :<+/-WRITE_CACHE +/-VIRUS_PROTECTION +/-DMA_ENABLED +/-PAUSE_ENABLED, +/-R0R1_ENABLED> The valid choices for the OPTIONS field are: WRITE_CACHE, VIRUS_PROTECTION, DMA_ENABLED. A '+' prefix to the option value sets the option and a '-' resets the option. LOGICAL ARRAY INFO: This logical block starts with the keyword LOGICAL_ARRAY This block must be organized as follows: LOGICAL_ARRAY : RAID_MODE : STRIPE_SIZE : TOTAL_STRIPES : TOTAL_PHYDICAL_DRIVES : PHYSICAL DRIVE INFO: This logical block starts with the keyword PHYSICAL_DRIVE This block must be organized as follows: PHYSICAL_DRIVE : DRIVE_ID : DRIVE_SIZE : The logical blocks can be separated by any no. of blank lines but, the lines within the logical block must be consecutive - i.e., blank lines are not allowed within the logical block. There will be as many PHYSICAL DRIVE INFO blocks as the number of drives participating in the array. All the PHYSICAL DRIVE INFO blocks for a logical array must follow the LOGICAL ARRAY INFO block before the start of next LOGICAL ARRAY INFO block. SPARE ARRAY information should not be included in the configuration file. Drives other than those specified in the config. File are configured as SPARE DRIVES. To force configuration of SPARE DRIVE do not include that drive in the configuration file. This drive will be automatically configured as SPARE. Any other lines which does not contain keywords are regarded as comments. CONFIGURING SPARE DRIVES: SPARE drives cannot be directly configured using command line. The following steps should be followed: Adding SPARE(S) to existing configuration: 1) Save the current configuration to a file using the /L /Dcn /Cn /Ffilename option. 2) Connect the new drives. 3) Create new configuration with the command line /@filename The new drives would be configured as SPARE drives. Auto-configuring SPARE: 1) Up to one SPARE drive can be auto-configured with /Am option when odd number of drives are present. CREATING MIXED CONFIGURATIONS: Mixed configurations (MIRROR and/or STRIPE and/or SPARE) cannot be made directly using command line option. Such configurations can be done using a CONFIGURATION SCRIPT file. Please refer the CONFIGURATIO FILE section for details about the SCRIPT file. Sample Script file: Drives present in the system: 00h - Primary Master 01h - Primary Slave 10h - Secondary master 11h - Secondary Slave Configuration to be made: Mirror - Primary Master & Secondary Slave Stripe - Secondary Master Spare - Primary Slave Script file to make the above configuration: TOTAL_LOGICAL_ARRAYS :2 TOTAL_PHYSICAL_DRIVES :3 OPTIONS :+WRITE_CACHE -DMA_ENABLED LOGICAL_ARRAY :01 RAID_MODE :MIRROR STRIPE_SIZE :64KB TOTAL_STRIPES :01 TOTAL_PHYSICAL_DRIVES :02 PHYSICAL_DRIVE :01 DRIVE_ID :00 DRIVE_SIZE :2024 PHYSICAL_DRIVE :02 DRIVE_ID :11 DRIVE_SIZE :2024 LOGICAL_ARRAY :02 RAID_MODE :MIRROR STRIPE_SIZE :64KB TOTAL_STRIPES :01 TOTAL_PHYSICAL_DRIVES :01 PHYSICAL_DRIVE :01 DRIVE_ID :10 DRIVE_SIZE :2024 Note: Drive that is to be configured as spare drives ( Primary Slave here (01) ) Is not included in the configuration script file. This drive will be automatically configured as SPARE DRIVE. The TOTAL_LOGICAL_ARRAYS field and TOTAL_PHYSICAL_DRIVES field should not include SPARE arrays and corresponding drives. The DRIVE_SIZE field can be filled with any dummy size. The original physical drive size would be automatically taken during runtime. RETURN CODE: The HYPERCFG utility returns a 8-bit code on exit to the OS. This code should be interpreted as follows: Bits 7:6 -- Data Type returned Bits 5:0 -- Data Bits 7:6 = 00 - bits 5:0 contain Error info. 01 - bits 5:0 contain array count info. 1x - Reserved Return codes on Error Condition: 0 - No Error 2 - Reserved 3 - Reserved 4 - Reserved 5 - Reserved 6 - Array not formed due to inadequate drives 7 - Reserved 8 - Reserved 9 - Reserved 10 - Hard disk(s) not found 11 - Raid controller timed out on read/write 12 - Reserved 13 - Reserved 14 - Error opening Array information file 15 - Array information file format incorrect 16 - Error opening log file 17 - Reserved 18 - Array not formed as required drives not found 19 - Array not formed , excess drives found 20 - Reserved 21 - Reserved 22 - Invalid configuration present 23 - Configuration mismatch in drives 24 - Error reading file 25 - Error writing file 26 - Warning!! Truncating file as filesize > 512 bytes 27 - Raid BIOS not found 28 - Feature not available in IDE Drive 29 - Invalid Command line arguments 30 - Reserved 31 - Reserved When /Q is specified, config. related commands return ARRAY COUNT on SUCCESS. In all other cases ERROR LEVEL is returned