drivers/char/ftape/qic117.h

/* */
   1 #ifndef _QIC117_H
   2 #define _QIC117_H
   3 
   4 /*
   5  *      Copyright (C) 1993-1995 Bas Laarhoven.
   6 
   7  This program is free software; you can redistribute it and/or modify
   8  it under the terms of the GNU General Public License as published by
   9  the Free Software Foundation; either version 2, or (at your option)
  10  any later version.
  11 
  12  This program is distributed in the hope that it will be useful,
  13  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  GNU General Public License for more details.
  16 
  17  You should have received a copy of the GNU General Public License
  18  along with this program; see the file COPYING.  If not, write to
  19  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20 
  21  *
  22  $Source: /home/bas/distr/ftape-2.03b/RCS/qic117.h,v $
  23  $Author: bas $
  24  *
  25  $Revision: 1.27 $
  26  $Date: 1995/05/01 19:02:20 $
  27  $State: Beta $
  28  *
  29  *      This file contains QIC-117 spec. related definitions
  30  *      for the QIC-40/80 floppy-tape driver for Linux.
  31  *
  32  *      These data were taken from the Quarter-Inch Cartridge
  33  *      Drive Standards, Inc. document titled:
  34  *      `Common Command Set Interface Specification for Flexible
  35  *       Disk Controller Based Minicartridge Tape Drives'
  36  *       document QIC-117 Revision C, 3 Dec 92.
  37  *      For more information, contact:
  38  *       Quarter-Inch Cartridge Drive Standards, Inc.
  39  *       311 East Carrillo Street
  40  *       Santa Barbara, California 93101
  41  *       Telephone (805) 963-3853
  42  *       Fax       (805) 962-1541
  43  *
  44  *      Current QIC standard revisions (of interest) are:
  45  *       QIC-80-MC,   Rev. M, 15 Jun 95.
  46  *       QIC-117,     Rev. I, 15 Mar 95.
  47  *       QIC-122,     Rev. B,  6 Mar 91.
  48  *       QIC-130,     Rev. C,  2 Sep 92.
  49  *       QIC-3010-MC, Rev. F, 14 Jun 95.
  50  *       QIC-3020-MC, Rev. G, 31 Aug 95.
  51  *       QIC-CRF3,    Rev. B, 15 Jun 95.
  52  *
  53  */
  54 
  55 /*
  56  *      QIC-117 common command set rev. I.
  57  *      These commands are sent to the tape unit
  58  *      as number of pulses over the step line.
  59  */
  60 
  61 #define QIC_RESET                       1
  62 #define QIC_REPORT_NEXT_BIT             2
  63 #define QIC_PAUSE                       3
  64 #define QIC_MICRO_STEP_PAUSE            4
  65 #define QIC_ALTERNATE_TIMEOUT           5
  66 #define QIC_REPORT_DRIVE_STATUS         6
  67 #define QIC_REPORT_ERROR_CODE           7
  68 #define QIC_REPORT_DRIVE_CONFIGURATION  8
  69 #define QIC_REPORT_ROM_VERSION          9
  70 #define QIC_LOGICAL_FORWARD             10
  71 #define QIC_PHYSICAL_REVERSE            11
  72 #define QIC_PHYSICAL_FORWARD            12
  73 #define QIC_SEEK_HEAD_TO_TRACK          13
  74 #define QIC_SEEK_LOAD_POINT             14
  75 #define QIC_ENTER_FORMAT_MODE           15
  76 #define QIC_WRITE_REFERENCE_BURST       16
  77 #define QIC_ENTER_VERIFY_MODE           17
  78 #define QIC_STOP_TAPE                   18
  79 /* commands 19-20: reserved */
  80 #define QIC_MICRO_STEP_HEAD_UP          21
  81 #define QIC_MICRO_STEP_HEAD_DOWN        22
  82 #define QIC_SOFT_SELECT                 23
  83 #define QIC_SOFT_DESELECT               24
  84 #define QIC_SKIP_REVERSE                25
  85 #define QIC_SKIP_FORWARD                26
  86 #define QIC_SELECT_RATE                 27
  87 /* command 27, in ccs2: Select Rate or Format */
  88 #define QIC_ENTER_DIAGNOSTIC_1          28
  89 #define QIC_ENTER_DIAGNOSTIC_2          29
  90 #define QIC_ENTER_PRIMARY_MODE          30
  91 /* command 31: vendor unique */
  92 #define QIC_REPORT_VENDOR_ID            32
  93 #define QIC_REPORT_TAPE_STATUS          33
  94 #define QIC_SKIP_EXTENDED_REVERSE       34
  95 #define QIC_SKIP_EXTENDED_FORWARD       35
  96 #define QIC_CALIBRATE_TAPE_LENGTH       36
  97 #define QIC_REPORT_FORMAT_SEGMENTS      37
  98 #define QIC_SET_FORMAT_SEGMENTS         38
  99 /* commands 39-45: reserved */
 100 #define QIC_PHANTOM_SELECT              46
 101 #define QIC_PHANTOM_DESELECT            47
 102 
 103 typedef enum {
 104         discretional = 0, required, ccs1, ccs2
 105 } qic_compatibility;
 106 
 107 typedef enum {
 108         unused, mode, motion, report
 109 } command_types;
 110 
 111 struct qic117_command_table {
 112         char *name;
 113         byte mask;
 114         byte state;
 115         byte cmd_type;
 116         byte non_intr;
 117         byte level;
 118 };
 119 
 120 #define QIC117_COMMANDS {\
 121 /* command                           mask  state cmd_type           */\
 122 /* |    name                         |     |     |       non_intr   */\
 123 /* |    |                            |     |     |       |  level   */\
 124 /* 0*/ {NULL,                        0x00, 0x00, mode,   0, discretional},\
 125 /* 1*/ {"soft reset",                0x00, 0x00, motion, 1, required},\
 126 /* 2*/ {"report next bit",           0x00, 0x00, report, 0, required},\
 127 /* 3*/ {"pause",                     0x36, 0x24, motion, 1, required},\
 128 /* 4*/ {"micro step pause",          0x36, 0x24, motion, 1, required},\
 129 /* 5*/ {"alternate command timeout", 0x00, 0x00, mode,   0, required},\
 130 /* 6*/ {"report drive status",       0x00, 0x00, report, 0, required},\
 131 /* 7*/ {"report error code",         0x01, 0x01, report, 0, required},\
 132 /* 8*/ {"report drive configuration",0x00, 0x00, report, 0, required},\
 133 /* 9*/ {"report rom version",        0x00, 0x00, report, 0, required},\
 134 /*10*/ {"logical forward",           0x37, 0x25, motion, 0, required},\
 135 /*11*/ {"physical reverse",          0x17, 0x05, motion, 0, required},\
 136 /*12*/ {"physical forward",          0x17, 0x05, motion, 0, required},\
 137 /*13*/ {"seek head to track",        0x37, 0x25, motion, 0, required},\
 138 /*14*/ {"seek load point",           0x17, 0x05, motion, 1, required},\
 139 /*15*/ {"enter format mode",         0x1f, 0x05, mode,   0, required},\
 140 /*16*/ {"write reference burst",     0x1f, 0x05, motion, 1, required},\
 141 /*17*/ {"enter verify mode",         0x37, 0x25, mode,   0, required},\
 142 /*18*/ {"stop tape",                 0x00, 0x00, motion, 1, required},\
 143 /*19*/ {"reserved (19)",             0x00, 0x00, unused, 0, discretional},\
 144 /*20*/ {"reserved (20)",             0x00, 0x00, unused, 0, discretional},\
 145 /*21*/ {"micro step head up",        0x02, 0x00, motion, 0, required},\
 146 /*22*/ {"micro step head down",      0x02, 0x00, motion, 0, required},\
 147 /*23*/ {"soft select",               0x00, 0x00, mode,   0, discretional},\
 148 /*24*/ {"soft deselect",             0x00, 0x00, mode,   0, discretional},\
 149 /*25*/ {"skip segments reverse",     0x36, 0x24, motion, 1, required},\
 150 /*26*/ {"skip segments forward",     0x36, 0x24, motion, 1, required},\
 151 /*27*/ {"select rate [or format]",   0x03, 0x01, mode,   0, required /* [ccs2] */},\
 152 /*28*/ {"enter diag mode 1",         0x00, 0x00, mode,   0, discretional},\
 153 /*29*/ {"enter diag mode 2",         0x00, 0x00, mode,   0, discretional},\
 154 /*30*/ {"enter primary mode",        0x00, 0x00, mode,   0, required},\
 155 /*31*/ {"vendor unique (31)",        0x00, 0x00, unused, 0, discretional},\
 156 /*32*/ {"report vendor id",          0x00, 0x00, report, 0, required},\
 157 /*33*/ {"report tape status",        0x04, 0x04, report, 0, ccs1},\
 158 /*34*/ {"skip extended reverse",     0x36, 0x24, motion, 1, ccs1},\
 159 /*35*/ {"skip extended forward",     0x36, 0x24, motion, 1, ccs1},\
 160 /*36*/ {"calibrate tape length",     0x17, 0x05, motion, 1, ccs2},\
 161 /*37*/ {"report format segments",    0x17, 0x05, report, 0, ccs2},\
 162 /*38*/ {"set format segments",       0x17, 0x05, mode,   0, ccs2},\
 163 /*39*/ {"reserved (39)",             0x00, 0x00, unused, 0, discretional},\
 164 /*40*/ {"vendor unique (40)",        0x00, 0x00, unused, 0, discretional},\
 165 /*41*/ {"vendor unique (41)",        0x00, 0x00, unused, 0, discretional},\
 166 /*42*/ {"vendor unique (42)",        0x00, 0x00, unused, 0, discretional},\
 167 /*43*/ {"vendor unique (43)",        0x00, 0x00, unused, 0, discretional},\
 168 /*44*/ {"vendor unique (44)",        0x00, 0x00, unused, 0, discretional},\
 169 /*45*/ {"vendor unique (45)",        0x00, 0x00, unused, 0, discretional},\
 170 /*46*/ {"phantom select",            0x00, 0x00, mode,   0, discretional},\
 171 /*47*/ {"phantom deselect",          0x00, 0x00, mode,   0, discretional},\
 172 }
 173 
 174 /*
 175  *      Status bits returned by QIC_REPORT_DRIVE_STATUS
 176  */
 177 
 178 #define QIC_STATUS_READY        0x01    /* Drive is ready or idle. */
 179 #define QIC_STATUS_ERROR        0x02    /* Error detected, must read
 180                                            error code to clear this */
 181 #define QIC_STATUS_CARTRIDGE_PRESENT 0x04       /* Tape is present */
 182 #define QIC_STATUS_WRITE_PROTECT 0x08   /* Tape is write protected */
 183 #define QIC_STATUS_NEW_CARTRIDGE 0x10   /* New cartridge inserted, must
 184                                            read error status to clear. */
 185 #define QIC_STATUS_REFERENCED   0x20    /* Cartridge appears to have been
 186                                            formatted. */
 187 #define QIC_STATUS_AT_BOT       0x40    /* Cartridge is at physical
 188                                            beginning of tape. */
 189 #define QIC_STATUS_AT_EOT       0x80    /* Cartridge is at physical end
 190                                            of tape. */
 191 /*
 192  *      Status bits returned by QIC_REPORT_DRIVE_CONFIGURATION
 193  */
 194 
 195 #define QIC_CONFIG_RATE_MASK    0x18
 196 #define QIC_CONFIG_RATE_SHIFT   3
 197 #define QIC_CONFIG_RATE_250     0
 198 #define QIC_CONFIG_RATE_500     2
 199 #define QIC_CONFIG_RATE_1000    3
 200 #define QIC_CONFIG_RATE_2000    1
 201 
 202 #define QIC_CONFIG_LONG         0x40    /* Extra Length Tape Detected */
 203 #define QIC_CONFIG_80           0x80    /* QIC-80 detected. */
 204 
 205 /*
 206  *      Status bits returned by QIC_REPORT_TAPE_STATUS
 207  */
 208 
 209 #define QIC_TAPE_STD_MASK       0x0f
 210 #define QIC_TAPE_QIC40          0x01
 211 #define QIC_TAPE_QIC80          0x02
 212 #define QIC_TAPE_QIC3020        0x03
 213 #define QIC_TAPE_QIC3010        0x04
 214 
 215 #define QIC_TAPE_LEN_MASK       0x70
 216 #define QIC_TAPE_205FT          0x10
 217 #define QIC_TAPE_307FT          0x20
 218 #define QIC_TAPE_400FT          0x30
 219 #define QIC_TAPE_1100FT         0x40
 220 #define QIC_TAPE_FLEX           0x60
 221 
 222 #define QIC_TAPE_WIDE           0x80
 223 
 224 /*
 225  *      Errors: List of error codes, and their severity.
 226  */
 227 
 228 typedef struct {
 229         char *message;          /* Text describing the error. */
 230         int fatal;              /* Non-zero if the error is fatal. */
 231 } ftape_error;
 232 
 233 #define QIC117_ERRORS {\
 234   /* 0*/ { "No error", 0, },\
 235   /* 1*/ { "Command Received while Drive Not Ready", 0, },\
 236   /* 2*/ { "Cartridge Not Present or Removed", 1, },\
 237   /* 3*/ { "Motor Speed Error (not within 1%)", 1, },\
 238   /* 4*/ { "Motor Speed Fault (jammed, or gross speed error", 1, },\
 239   /* 5*/ { "Cartridge Write Protected", 1, },\
 240   /* 6*/ { "Undefined or Reserved Command Code", 1, },\
 241   /* 7*/ { "Illegal Track Address Specified for Seek", 1, },\
 242   /* 8*/ { "Illegal Command in Report Subcontext", 0, },\
 243   /* 9*/ { "Illegal Entry into a Diagnostic Mode", 1, },\
 244   /*10*/ { "Broken Tape Detected (based on hole sensor)", 1, },\
 245   /*11*/ { "Warning--Read Gain Setting Error", 1, },\
 246   /*12*/ { "Command Received While Error Status Pending (obs)", 1, },\
 247   /*13*/ { "Command Received While New Cartridge Pending", 1, },\
 248   /*14*/ { "Command Illegal or Undefined in Primary Mode", 1, },\
 249   /*15*/ { "Command Illegal or Undefined in Format Mode", 1, },\
 250   /*16*/ { "Command Illegal or Undefined in Verify Mode", 1, },\
 251   /*17*/ { "Logical Forward Not a Logical BOT or no Format Segments in Format Mode", 1, },\
 252   /*18*/ { "Logical EOT Before All Segments generated", 1, },\
 253   /*19*/ { "Command Illegal When Cartridge Not Referenced", 1, },\
 254   /*20*/ { "Self-Diagnostic Failed (cannot be cleared)", 1, },\
 255   /*21*/ { "Warning EEPROM Not Initialized, Defaults Set", 1, },\
 256   /*22*/ { "EEPROM Corrupted or Hardware Failure", 1, },\
 257   /*23*/ { "Motion Time-out Error", 1, },\
 258   /*24*/ { "Data Segment Too Long -- Logical Forward or Pause", 1, },\
 259   /*25*/ { "Transmit Overrun (obs)", 1, },\
 260   /*26*/ { "Power On Reset Occurred", 0, },\
 261   /*27*/ { "Software Reset Occurred", 0, },\
 262   /*28*/ { "Diagnostic Mode 1 Error", 1, },\
 263   /*29*/ { "Diagnostic Mode 2 Error", 1, },\
 264   /*30*/ { "Command Received During Non-Interruptable Process", 1, },\
 265   /*31*/ { "Rate or Format Selection Error", 1, },\
 266   /*32*/ { "Illegal Command While in High Speed Mode", 1, },\
 267   /*33*/ { "Illegal Seek Segment Value", 1, },\
 268   /*34*/ { "Invalid Media", 1, },\
 269   /*35*/ { "Head Positioning Failure", 1, },\
 270   /*36*/ { "Write Reference Burst Failure", 1, },\
 271   /*37*/ { "Prom Code Missing", 1, },\
 272   /*38*/ { "Invalid Format", 1, },\
 273   /*39*/ { "EOT/BOT System Failure", 1, },\
 274   /*40*/ { "Prom A Checksum Error", 1, },\
 275   /*41*/ { "Drive Wakeup Reset Occurred", 1, },\
 276   /*42*/ { "Prom B Checksum Error", 1, },\
 277   /*43*/ { "Illegal Entry into Format Mode", 1, },\
 278 }
 279 
 280 #endif                          /* _QIC117_H */
/* */
root/drivers/char/ftape/qic117.h

INCLUDED FROM
