linux/drivers/scsi/st.h
<<
>>
Prefs
   1
   2#ifndef _ST_H
   3#define _ST_H
   4
   5#include <linux/completion.h>
   6#include <linux/mutex.h>
   7#include <linux/kref.h>
   8#include <scsi/scsi_cmnd.h>
   9
  10/* Descriptor for analyzed sense data */
  11struct st_cmdstatus {
  12        int midlevel_result;
  13        struct scsi_sense_hdr sense_hdr;
  14        int have_sense;
  15        u64 uremainder64;
  16        u8 flags;
  17        u8 remainder_valid;
  18        u8 fixed_format;
  19        u8 deferred;
  20};
  21
  22struct scsi_tape;
  23
  24/* scsi tape command */
  25struct st_request {
  26        unsigned char cmd[MAX_COMMAND_SIZE];
  27        unsigned char sense[SCSI_SENSE_BUFFERSIZE];
  28        int result;
  29        struct scsi_tape *stp;
  30        struct completion *waiting;
  31};
  32
  33/* The tape buffer descriptor. */
  34struct st_buffer {
  35        unsigned char dma;      /* DMA-able buffer */
  36        unsigned char do_dio;   /* direct i/o set up? */
  37        int buffer_size;
  38        int buffer_blocks;
  39        int buffer_bytes;
  40        int read_pointer;
  41        int writing;
  42        int syscall_result;
  43        struct st_request *last_SRpnt;
  44        struct st_cmdstatus cmdstat;
  45        unsigned char *b_data;
  46        unsigned short use_sg;  /* zero or max number of s/g segments for this adapter */
  47        unsigned short sg_segs;         /* number of segments in s/g list */
  48        unsigned short orig_frp_segs;   /* number of segments allocated at first try */
  49        unsigned short frp_segs;        /* number of buffer segments */
  50        unsigned int frp_sg_current;    /* driver buffer length currently in s/g list */
  51        struct st_buf_fragment *frp;    /* the allocated buffer fragment list */
  52        struct scatterlist sg[1];       /* MUST BE last item */
  53};
  54
  55/* The tape buffer fragment descriptor */
  56struct st_buf_fragment {
  57        struct page *page;
  58        unsigned int length;
  59};
  60
  61/* The tape mode definition */
  62struct st_modedef {
  63        unsigned char defined;
  64        unsigned char sysv;     /* SYS V semantics? */
  65        unsigned char do_async_writes;
  66        unsigned char do_buffer_writes;
  67        unsigned char do_read_ahead;
  68        unsigned char defaults_for_writes;
  69        unsigned char default_compression;      /* 0 = don't touch, etc */
  70        short default_density;  /* Forced density, -1 = no value */
  71        int default_blksize;    /* Forced blocksize, -1 = no value */
  72        struct cdev *cdevs[2];  /* Auto-rewind and non-rewind devices */
  73};
  74
  75/* Number of modes can be changed by changing ST_NBR_MODE_BITS. The maximum
  76   number of modes is 16 (ST_NBR_MODE_BITS 4) */
  77#define ST_NBR_MODE_BITS 2
  78#define ST_NBR_MODES (1 << ST_NBR_MODE_BITS)
  79#define ST_MODE_SHIFT (7 - ST_NBR_MODE_BITS)
  80#define ST_MODE_MASK ((ST_NBR_MODES - 1) << ST_MODE_SHIFT)
  81
  82#define ST_MAX_TAPES 128
  83#define ST_MAX_TAPE_ENTRIES  (ST_MAX_TAPES << (ST_NBR_MODE_BITS + 1))
  84
  85/* The status related to each partition */
  86struct st_partstat {
  87        unsigned char rw;
  88        unsigned char eof;
  89        unsigned char at_sm;
  90        unsigned char last_block_valid;
  91        u32 last_block_visited;
  92        int drv_block;          /* The block where the drive head is */
  93        int drv_file;
  94};
  95
  96#define ST_NBR_PARTITIONS 4
  97
  98/* The tape drive descriptor */
  99struct scsi_tape {
 100        struct scsi_driver *driver;
 101        struct scsi_device *device;
 102        struct mutex lock;      /* For serialization */
 103        struct completion wait; /* For SCSI commands */
 104        struct st_buffer *buffer;
 105
 106        /* Drive characteristics */
 107        unsigned char omit_blklims;
 108        unsigned char do_auto_lock;
 109        unsigned char can_bsr;
 110        unsigned char can_partitions;
 111        unsigned char two_fm;
 112        unsigned char fast_mteom;
 113        unsigned char immediate;
 114        unsigned char restr_dma;
 115        unsigned char scsi2_logical;
 116        unsigned char default_drvbuffer;        /* 0xff = don't touch, value 3 bits */
 117        unsigned char cln_mode;                 /* 0 = none, otherwise sense byte nbr */
 118        unsigned char cln_sense_value;
 119        unsigned char cln_sense_mask;
 120        unsigned char use_pf;                   /* Set Page Format bit in all mode selects? */
 121        unsigned char try_dio;                  /* try direct i/o in general? */
 122        unsigned char try_dio_now;              /* try direct i/o before next close? */
 123        unsigned char c_algo;                   /* compression algorithm */
 124        unsigned char pos_unknown;                      /* after reset position unknown */
 125        int tape_type;
 126        int long_timeout;       /* timeout for commands known to take long time */
 127
 128        unsigned long max_pfn;  /* the maximum page number reachable by the HBA */
 129
 130        /* Mode characteristics */
 131        struct st_modedef modes[ST_NBR_MODES];
 132        int current_mode;
 133
 134        /* Status variables */
 135        int partition;
 136        int new_partition;
 137        int nbr_partitions;     /* zero until partition support enabled */
 138        struct st_partstat ps[ST_NBR_PARTITIONS];
 139        unsigned char dirty;
 140        unsigned char ready;
 141        unsigned char write_prot;
 142        unsigned char drv_write_prot;
 143        unsigned char in_use;
 144        unsigned char blksize_changed;
 145        unsigned char density_changed;
 146        unsigned char compression_changed;
 147        unsigned char drv_buffer;
 148        unsigned char density;
 149        unsigned char door_locked;
 150        unsigned char autorew_dev;   /* auto-rewind device */
 151        unsigned char rew_at_close;  /* rewind necessary at close */
 152        unsigned char inited;
 153        unsigned char cleaning_req;  /* cleaning requested? */
 154        int block_size;
 155        int min_block;
 156        int max_block;
 157        int recover_count;     /* From tape opening */
 158        int recover_reg;       /* From last status call */
 159
 160#if DEBUG
 161        unsigned char write_pending;
 162        int nbr_finished;
 163        int nbr_waits;
 164        int nbr_requests;
 165        int nbr_dio;
 166        int nbr_pages;
 167        int nbr_combinable;
 168        unsigned char last_cmnd[6];
 169        unsigned char last_sense[16];
 170#endif
 171        struct gendisk *disk;
 172        struct kref     kref;
 173};
 174
 175/* Bit masks for use_pf */
 176#define USE_PF      1
 177#define PF_TESTED   2
 178
 179/* Values of eof */
 180#define ST_NOEOF        0
 181#define ST_FM_HIT       1
 182#define ST_FM           2
 183#define ST_EOM_OK       3
 184#define ST_EOM_ERROR    4
 185#define ST_EOD_1        5
 186#define ST_EOD_2        6
 187#define ST_EOD          7
 188/* EOD hit while reading => ST_EOD_1 => return zero => ST_EOD_2 =>
 189   return zero => ST_EOD, return ENOSPC */
 190/* When writing: ST_EOM_OK == early warning found, write OK
 191                 ST_EOD_1  == allow trying new write after early warning
 192                 ST_EOM_ERROR == early warning found, not able to write all */
 193
 194/* Values of rw */
 195#define ST_IDLE         0
 196#define ST_READING      1
 197#define ST_WRITING      2
 198
 199/* Values of ready state */
 200#define ST_READY        0
 201#define ST_NOT_READY    1
 202#define ST_NO_TAPE      2
 203
 204/* Values for door lock state */
 205#define ST_UNLOCKED     0
 206#define ST_LOCKED_EXPLICIT 1
 207#define ST_LOCKED_AUTO  2
 208#define ST_LOCK_FAILS   3
 209
 210/* Positioning SCSI-commands for Tandberg, etc. drives */
 211#define QFA_REQUEST_BLOCK       0x02
 212#define QFA_SEEK_BLOCK          0x0c
 213
 214/* Setting the binary options */
 215#define ST_DONT_TOUCH  0
 216#define ST_NO          1
 217#define ST_YES         2
 218
 219#define EXTENDED_SENSE_START  18
 220
 221/* Masks for some conditions in the sense data */
 222#define SENSE_FMK   0x80
 223#define SENSE_EOM   0x40
 224#define SENSE_ILI   0x20
 225
 226#endif
 227