LXR linux/drivers/s390/char/tape

   1/*
   2 *    standard tape device functions for ibm tapes.
   3 *
   4 *    Copyright IBM Corp. 2001, 2006
   5 *    Author(s): Carsten Otte <cotte@de.ibm.com>
   6 *               Tuan Ngo-Anh <ngoanh@de.ibm.com>
   7 *               Martin Schwidefsky <schwidefsky@de.ibm.com>
   8 */
   9
  10#ifndef _TAPE_STD_H
  11#define _TAPE_STD_H
  12
  13#include <asm/tape390.h>
  14
  15/*
  16 * Biggest block size to handle. Currently 64K because we only build
  17 * channel programs without data chaining.
  18 */
  19#define MAX_BLOCKSIZE   65535
  20
  21/*
  22 * The CCW commands for the Tape type of command.
  23 */
  24#define INVALID_00              0x00    /* Invalid cmd */
  25#define BACKSPACEBLOCK          0x27    /* Back Space block */
  26#define BACKSPACEFILE           0x2f    /* Back Space file */
  27#define DATA_SEC_ERASE          0x97    /* Data security erase */
  28#define ERASE_GAP               0x17    /* Erase Gap */
  29#define FORSPACEBLOCK           0x37    /* Forward space block */
  30#define FORSPACEFILE            0x3F    /* Forward Space file */
  31#define FORCE_STREAM_CNT        0xEB    /* Forced streaming count # */
  32#define NOP                     0x03    /* No operation */
  33#define READ_FORWARD            0x02    /* Read forward */
  34#define REWIND                  0x07    /* Rewind */
  35#define REWIND_UNLOAD           0x0F    /* Rewind and Unload */
  36#define SENSE                   0x04    /* Sense */
  37#define NEW_MODE_SET            0xEB    /* Guess it is Mode set */
  38#define WRITE_CMD               0x01    /* Write */
  39#define WRITETAPEMARK           0x1F    /* Write Tape Mark */
  40
  41#define ASSIGN                  0xB7    /* 3420 REJECT,3480 OK  */
  42#define CONTROL_ACCESS          0xE3    /* Set high speed */
  43#define DIAG_MODE_SET           0x0B    /* 3420 NOP, 3480 REJECT */
  44#define LOAD_DISPLAY            0x9F    /* 3420 REJECT,3480 OK */
  45#define LOCATE                  0x4F    /* 3420 REJ, 3480 NOP */
  46#define LOOP_WRITE_TO_READ      0x8B    /* 3480 REJECT */
  47#define MODE_SET_DB             0xDB    /* 3420 REJECT,3480 OK */
  48#define MODE_SET_C3             0xC3    /* for 3420 */
  49#define MODE_SET_CB             0xCB    /* for 3420 */
  50#define MODE_SET_D3             0xD3    /* for 3420 */
  51#define READ_BACKWARD           0x0C    /* */
  52#define READ_BLOCK_ID           0x22    /* 3420 REJECT,3480 OK */
  53#define READ_BUFFER             0x12    /* 3420 REJECT,3480 OK */
  54#define READ_BUFF_LOG           0x24    /* 3420 REJECT,3480 OK */
  55#define RELEASE                 0xD4    /* 3420 NOP, 3480 REJECT */
  56#define REQ_TRK_IN_ERROR        0x1B    /* 3420 NOP, 3480 REJECT */
  57#define RESERVE                 0xF4    /* 3420 NOP, 3480 REJECT */
  58#define SENSE_GROUP_ID          0x34    /* 3420 REJECT,3480 OK */
  59#define SENSE_ID                0xE4    /* 3420 REJECT,3480 OK */
  60#define READ_DEV_CHAR           0x64    /* Read device characteristics */
  61#define SET_DIAGNOSE            0x4B    /* 3420 NOP, 3480 REJECT */
  62#define SET_GROUP_ID            0xAF    /* 3420 REJECT,3480 OK */
  63#define SET_TAPE_WRITE_IMMED    0xC3    /* for 3480 */
  64#define SUSPEND                 0x5B    /* 3420 REJ, 3480 NOP */
  65#define SYNC                    0x43    /* Synchronize (flush buffer) */
  66#define UNASSIGN                0xC7    /* 3420 REJECT,3480 OK */
  67#define PERF_SUBSYS_FUNC        0x77    /* 3490 CMD */
  68#define READ_CONFIG_DATA        0xFA    /* 3490 CMD */
  69#define READ_MESSAGE_ID         0x4E    /* 3490 CMD */
  70#define READ_SUBSYS_DATA        0x3E    /* 3490 CMD */
  71#define SET_INTERFACE_ID        0x73    /* 3490 CMD */
  72
  73#define SENSE_COMMAND_REJECT            0x80
  74#define SENSE_INTERVENTION_REQUIRED     0x40
  75#define SENSE_BUS_OUT_CHECK             0x20
  76#define SENSE_EQUIPMENT_CHECK           0x10
  77#define SENSE_DATA_CHECK                0x08
  78#define SENSE_OVERRUN                   0x04
  79#define SENSE_DEFERRED_UNIT_CHECK       0x02
  80#define SENSE_ASSIGNED_ELSEWHERE        0x01
  81
  82#define SENSE_LOCATE_FAILURE            0x80
  83#define SENSE_DRIVE_ONLINE              0x40
  84#define SENSE_RESERVED                  0x20
  85#define SENSE_RECORD_SEQUENCE_ERR       0x10
  86#define SENSE_BEGINNING_OF_TAPE         0x08
  87#define SENSE_WRITE_MODE                0x04
  88#define SENSE_WRITE_PROTECT             0x02
  89#define SENSE_NOT_CAPABLE               0x01
  90
  91#define SENSE_CHANNEL_ADAPTER_CODE      0xE0
  92#define SENSE_CHANNEL_ADAPTER_LOC       0x10
  93#define SENSE_REPORTING_CU              0x08
  94#define SENSE_AUTOMATIC_LOADER          0x04
  95#define SENSE_TAPE_SYNC_MODE            0x02
  96#define SENSE_TAPE_POSITIONING          0x01
  97
  98/* discipline functions */
  99struct tape_request *tape_std_read_block(struct tape_device *, size_t);
 100void tape_std_read_backward(struct tape_device *device,
 101                            struct tape_request *request);
 102struct tape_request *tape_std_write_block(struct tape_device *, size_t);
 103void tape_std_check_locate(struct tape_device *, struct tape_request *);
 104
 105/* Some non-mtop commands. */
 106int tape_std_assign(struct tape_device *);
 107int tape_std_unassign(struct tape_device *);
 108int tape_std_read_block_id(struct tape_device *device, __u64 *id);
 109int tape_std_display(struct tape_device *, struct display_struct *disp);
 110int tape_std_terminate_write(struct tape_device *);
 111
 112/* Standard magnetic tape commands. */
 113int tape_std_mtbsf(struct tape_device *, int);
 114int tape_std_mtbsfm(struct tape_device *, int);
 115int tape_std_mtbsr(struct tape_device *, int);
 116int tape_std_mtcompression(struct tape_device *, int);
 117int tape_std_mteom(struct tape_device *, int);
 118int tape_std_mterase(struct tape_device *, int);
 119int tape_std_mtfsf(struct tape_device *, int);
 120int tape_std_mtfsfm(struct tape_device *, int);
 121int tape_std_mtfsr(struct tape_device *, int);
 122int tape_std_mtload(struct tape_device *, int);
 123int tape_std_mtnop(struct tape_device *, int);
 124int tape_std_mtoffl(struct tape_device *, int);
 125int tape_std_mtreset(struct tape_device *, int);
 126int tape_std_mtreten(struct tape_device *, int);
 127int tape_std_mtrew(struct tape_device *, int);
 128int tape_std_mtsetblk(struct tape_device *, int);
 129int tape_std_mtunload(struct tape_device *, int);
 130int tape_std_mtweof(struct tape_device *, int);
 131
 132/* Event handlers */
 133void tape_std_default_handler(struct tape_device *);
 134void tape_std_unexpect_uchk_handler(struct tape_device *);
 135void tape_std_irq(struct tape_device *);
 136void tape_std_process_eov(struct tape_device *);
 137
 138// the error recovery stuff:
 139void tape_std_error_recovery(struct tape_device *);
 140void tape_std_error_recovery_has_failed(struct tape_device *,int error_id);
 141void tape_std_error_recovery_succeded(struct tape_device *);
 142void tape_std_error_recovery_do_retry(struct tape_device *);
 143void tape_std_error_recovery_read_opposite(struct tape_device *);
 144void tape_std_error_recovery_HWBUG(struct tape_device *, int condno);
 145
 146/* S390 tape types */
 147enum s390_tape_type {
 148        tape_3480,
 149        tape_3490,
 150        tape_3590,
 151        tape_3592,
 152};
 153
 154#endif // _TAPE_STD_H
 155