release/src-rt-6.x/linux/linux-2.6/drivers/scsi/pcmcia/nsp_cs.h

   1 /*=======================================================/
   2   Header file for nsp_cs.c
   3       By: YOKOTA Hiroshi <yokota@netlab.is.tsukuba.ac.jp>
   4
   5     Ver.1.0 : Cut unused lines.
   6     Ver 0.1 : Initial version.
   7
   8     This software may be used and distributed according to the terms of
   9     the GNU General Public License.
  10
  11 =========================================================*/
  12
  13 /* $Id: nsp_cs.h,v 1.19 2003/08/18 11:09:19 elca Exp $ */
  14
  15 #ifndef  __nsp_cs__
  16 #define  __nsp_cs__
  17
  18 /* for debugging */
  19 //#define NSP_DEBUG 9
  20
  21 /*
  22 #define static
  23 #define inline
  24 */
  25
  26 /************************************
  27  * Some useful macros...
  28  */
  29
  30 /* SCSI initiator must be ID 7 */
  31 #define NSP_INITIATOR_ID  7
  32
  33 #define NSP_SELTIMEOUT 200
  34
  35 /***************************************************************************
  36  * register definitions
  37  ***************************************************************************/
  38 /*========================================================================
  39  * base register
  40  ========================================================================*/
  41 #define IRQCONTROL      0x00  /* R */
  42 #  define IRQCONTROL_RESELECT_CLEAR     BIT(0)
  43 #  define IRQCONTROL_PHASE_CHANGE_CLEAR BIT(1)
  44 #  define IRQCONTROL_TIMER_CLEAR        BIT(2)
  45 #  define IRQCONTROL_FIFO_CLEAR         BIT(3)
  46 #  define IRQCONTROL_ALLMASK            0xff
  47 #  define IRQCONTROL_ALLCLEAR           (IRQCONTROL_RESELECT_CLEAR     | \
  48                                          IRQCONTROL_PHASE_CHANGE_CLEAR | \
  49                                          IRQCONTROL_TIMER_CLEAR        | \
  50                                          IRQCONTROL_FIFO_CLEAR          )
  51 #  define IRQCONTROL_IRQDISABLE         0xf0
  52
  53 #define IRQSTATUS       0x00  /* W */
  54 #  define IRQSTATUS_SCSI  BIT(0)
  55 #  define IRQSTATUS_TIMER BIT(2)
  56 #  define IRQSTATUS_FIFO  BIT(3)
  57 #  define IRQSTATUS_MASK  0x0f
  58
  59 #define IFSELECT        0x01 /* W */
  60 #  define IF_IFSEL    BIT(0)
  61 #  define IF_REGSEL   BIT(2)
  62
  63 #define FIFOSTATUS      0x01 /* R */
  64 #  define FIFOSTATUS_CHIP_REVISION_MASK 0x0f
  65 #  define FIFOSTATUS_CHIP_ID_MASK       0x70
  66 #  define FIFOSTATUS_FULL_EMPTY         BIT(7)
  67
  68 #define INDEXREG        0x02 /* R/W */
  69 #define DATAREG         0x03 /* R/W */
  70 #define FIFODATA        0x04 /* R/W */
  71 #define FIFODATA1       0x05 /* R/W */
  72 #define FIFODATA2       0x06 /* R/W */
  73 #define FIFODATA3       0x07 /* R/W */
  74
  75 /*====================================================================
  76  * indexed register
  77  ====================================================================*/
  78 #define EXTBUSCTRL      0x10 /* R/W,deleted */
  79
  80 #define CLOCKDIV        0x11 /* R/W */
  81 #  define CLOCK_40M 0x02
  82 #  define CLOCK_20M 0x01
  83 #  define FAST_20   BIT(2)
  84
  85 #define TERMPWRCTRL     0x13 /* R/W */
  86 #  define POWER_ON BIT(0)
  87
  88 #define SCSIIRQMODE     0x15 /* R/W */
  89 #  define SCSI_PHASE_CHANGE_EI BIT(0)
  90 #  define RESELECT_EI          BIT(4)
  91 #  define FIFO_IRQ_EI          BIT(5)
  92 #  define SCSI_RESET_IRQ_EI    BIT(6)
  93
  94 #define IRQPHASESENCE   0x16 /* R */
  95 #  define LATCHED_MSG      BIT(0)
  96 #  define LATCHED_IO       BIT(1)
  97 #  define LATCHED_CD       BIT(2)
  98 #  define LATCHED_BUS_FREE BIT(3)
  99 #  define PHASE_CHANGE_IRQ BIT(4)
 100 #  define RESELECT_IRQ     BIT(5)
 101 #  define FIFO_IRQ         BIT(6)
 102 #  define SCSI_RESET_IRQ   BIT(7)
 103
 104 #define TIMERCOUNT      0x17 /* R/W */
 105
 106 #define SCSIBUSCTRL     0x18 /* R/W */
 107 #  define SCSI_SEL         BIT(0)
 108 #  define SCSI_RST         BIT(1)
 109 #  define SCSI_DATAOUT_ENB BIT(2)
 110 #  define SCSI_ATN         BIT(3)
 111 #  define SCSI_ACK         BIT(4)
 112 #  define SCSI_BSY         BIT(5)
 113 #  define AUTODIRECTION    BIT(6)
 114 #  define ACKENB           BIT(7)
 115
 116 #define SCSIBUSMON      0x19 /* R */
 117
 118 #define SETARBIT        0x1A /* W */
 119 #  define ARBIT_GO         BIT(0)
 120 #  define ARBIT_FLAG_CLEAR BIT(1)
 121
 122 #define ARBITSTATUS     0x1A /* R */
 123 /*#  define ARBIT_GO        BIT(0)*/
 124 #  define ARBIT_WIN        BIT(1)
 125 #  define ARBIT_FAIL       BIT(2)
 126 #  define RESELECT_FLAG    BIT(3)
 127
 128 #define PARITYCTRL      0x1B  /* W */
 129 #define PARITYSTATUS    0x1B  /* R */
 130
 131 #define COMMANDCTRL     0x1C  /* W */
 132 #  define CLEAR_COMMAND_POINTER BIT(0)
 133 #  define AUTO_COMMAND_GO       BIT(1)
 134
 135 #define RESELECTID      0x1C  /* R   */
 136 #define COMMANDDATA     0x1D  /* R/W */
 137
 138 #define POINTERCLR      0x1E  /*   W */
 139 #  define POINTER_CLEAR      BIT(0)
 140 #  define ACK_COUNTER_CLEAR  BIT(1)
 141 #  define REQ_COUNTER_CLEAR  BIT(2)
 142 #  define HOST_COUNTER_CLEAR BIT(3)
 143 #  define READ_SOURCE        (BIT(4) | BIT(5))
 144 #    define ACK_COUNTER        (0)
 145 #    define REQ_COUNTER        (BIT(4))
 146 #    define HOST_COUNTER       (BIT(5))
 147
 148 #define TRANSFERCOUNT   0x1E  /* R   */
 149
 150 #define TRANSFERMODE    0x20  /* R/W */
 151 #  define MODE_MEM8   BIT(0)
 152 #  define MODE_MEM32  BIT(1)
 153 #  define MODE_ADR24  BIT(2)
 154 #  define MODE_ADR32  BIT(3)
 155 #  define MODE_IO8    BIT(4)
 156 #  define MODE_IO32   BIT(5)
 157 #  define TRANSFER_GO BIT(6)
 158 #  define BRAIND      BIT(7)
 159
 160 #define SYNCREG         0x21 /* R/W */
 161 #  define SYNCREG_OFFSET_MASK  0x0f
 162 #  define SYNCREG_PERIOD_MASK  0xf0
 163 #  define SYNCREG_PERIOD_SHIFT 4
 164
 165 #define SCSIDATALATCH   0x22 /*   W */
 166 #define SCSIDATAIN      0x22 /* R   */
 167 #define SCSIDATAWITHACK 0x23 /* R/W */
 168 #define SCAMCONTROL     0x24 /*   W */
 169 #define SCAMSTATUS      0x24 /* R   */
 170 #define SCAMDATA        0x25 /* R/W */
 171
 172 #define OTHERCONTROL    0x26 /* R/W */
 173 #  define TPL_ROM_WRITE_EN BIT(0)
 174 #  define TPWR_OUT         BIT(1)
 175 #  define TPWR_SENSE       BIT(2)
 176 #  define RA8_CONTROL      BIT(3)
 177
 178 #define ACKWIDTH        0x27 /* R/W */
 179 #define CLRTESTPNT      0x28 /*   W */
 180 #define ACKCNTLD        0x29 /*   W */
 181 #define REQCNTLD        0x2A /*   W */
 182 #define HSTCNTLD        0x2B /*   W */
 183 #define CHECKSUM        0x2C /* R/W */
 184
 185 /************************************************************************
 186  * Input status bit definitions.
 187  ************************************************************************/
 188 #define S_MESSAGE       BIT(0)    /* Message line from SCSI bus      */
 189 #define S_IO            BIT(1)    /* Input/Output line from SCSI bus */
 190 #define S_CD            BIT(2)    /* Command/Data line from SCSI bus */
 191 #define S_BUSY          BIT(3)    /* Busy line from SCSI bus         */
 192 #define S_ACK           BIT(4)    /* Acknowlege line from SCSI bus   */
 193 #define S_REQUEST       BIT(5)    /* Request line from SCSI bus      */
 194 #define S_SELECT        BIT(6)    /*                                 */
 195 #define S_ATN           BIT(7)    /*                                 */
 196
 197 /***********************************************************************
 198  * Useful Bus Monitor status combinations.
 199  ***********************************************************************/
 200 #define BUSMON_SEL         S_SELECT
 201 #define BUSMON_BSY         S_BUSY
 202 #define BUSMON_REQ         S_REQUEST
 203 #define BUSMON_IO          S_IO
 204 #define BUSMON_ACK         S_ACK
 205 #define BUSMON_BUS_FREE    0
 206 #define BUSMON_COMMAND     ( S_BUSY | S_CD |                    S_REQUEST )
 207 #define BUSMON_MESSAGE_IN  ( S_BUSY | S_CD | S_IO | S_MESSAGE | S_REQUEST )
 208 #define BUSMON_MESSAGE_OUT ( S_BUSY | S_CD |        S_MESSAGE | S_REQUEST )
 209 #define BUSMON_DATA_IN     ( S_BUSY |        S_IO |             S_REQUEST )
 210 #define BUSMON_DATA_OUT    ( S_BUSY |                           S_REQUEST )
 211 #define BUSMON_STATUS      ( S_BUSY | S_CD | S_IO |             S_REQUEST )
 212 #define BUSMON_SELECT      (                 S_IO |                        S_SELECT )
 213 #define BUSMON_RESELECT    (                 S_IO |                        S_SELECT )
 214 #define BUSMON_PHASE_MASK  (          S_CD | S_IO | S_MESSAGE |            S_SELECT )
 215
 216 #define BUSPHASE_SELECT      ( BUSMON_SELECT      & BUSMON_PHASE_MASK )
 217 #define BUSPHASE_COMMAND     ( BUSMON_COMMAND     & BUSMON_PHASE_MASK )
 218 #define BUSPHASE_MESSAGE_IN  ( BUSMON_MESSAGE_IN  & BUSMON_PHASE_MASK )
 219 #define BUSPHASE_MESSAGE_OUT ( BUSMON_MESSAGE_OUT & BUSMON_PHASE_MASK )
 220 #define BUSPHASE_DATA_IN     ( BUSMON_DATA_IN     & BUSMON_PHASE_MASK )
 221 #define BUSPHASE_DATA_OUT    ( BUSMON_DATA_OUT    & BUSMON_PHASE_MASK )
 222 #define BUSPHASE_STATUS      ( BUSMON_STATUS      & BUSMON_PHASE_MASK )
 223
 224 /*====================================================================*/
 225
 226 typedef struct scsi_info_t {
 227         struct pcmcia_device    *p_dev;
 228         struct Scsi_Host      *host;
 229 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,74))
 230         dev_node_t             node;
 231 #else
 232         int                    ndev;
 233         dev_node_t             node[8];
 234         struct bus_operations *bus;
 235 #endif
 236         int                    stop;
 237 } scsi_info_t;
 238
 239
 240 /* synchronous transfer negotiation data */
 241 typedef struct _sync_data {
 242         unsigned int SyncNegotiation;
 243 #define SYNC_NOT_YET 0
 244 #define SYNC_OK      1
 245 #define SYNC_NG      2
 246
 247         unsigned int  SyncPeriod;
 248         unsigned int  SyncOffset;
 249         unsigned char SyncRegister;
 250         unsigned char AckWidth;
 251 } sync_data;
 252
 253 typedef struct _nsp_hw_data {
 254         unsigned int  BaseAddress;
 255         unsigned int  NumAddress;
 256         unsigned int  IrqNumber;
 257
 258         unsigned long MmioAddress;
 259 #define NSP_MMIO_OFFSET 0x0800
 260         unsigned long MmioLength;
 261
 262         unsigned char ScsiClockDiv;
 263
 264         unsigned char TransferMode;
 265
 266         int           TimerCount;
 267         int           SelectionTimeOut;
 268         struct scsi_cmnd *CurrentSC;
 269         //int           CurrnetTarget;
 270
 271         int           FifoCount;
 272
 273 #define MSGBUF_SIZE 20
 274         unsigned char MsgBuffer[MSGBUF_SIZE];
 275         int MsgLen;
 276
 277 #define N_TARGET 8
 278         sync_data     Sync[N_TARGET];
 279
 280         char nspinfo[110];     /* description */
 281         spinlock_t Lock;
 282
 283         scsi_info_t   *ScsiInfo; /* attach <-> detect glue */
 284
 285
 286 #ifdef NSP_DEBUG
 287         int CmdId; /* Accepted command serial number.
 288                       Used for debugging.             */
 289 #endif
 290 } nsp_hw_data;
 291
 292 /****************************************************************************
 293  *
 294  */
 295
 296 /* Card service functions */
 297 static void        nsp_cs_detach (struct pcmcia_device *p_dev);
 298 static void        nsp_cs_release(struct pcmcia_device *link);
 299 static int        nsp_cs_config (struct pcmcia_device *link);
 300
 301 /* Linux SCSI subsystem specific functions */
 302 static struct Scsi_Host *nsp_detect     (struct scsi_host_template *sht);
 303 static const  char      *nsp_info       (struct Scsi_Host *shpnt);
 304 static        int        nsp_proc_info  (
 305                                          struct Scsi_Host *host,
 306                                          char   *buffer,
 307                                          char  **start,
 308                                          off_t   offset,
 309                                          int     length,
 310                                          int     inout);
 311 static int nsp_queuecommand(struct scsi_cmnd *SCpnt,
 312                             void (* done)(struct scsi_cmnd *SCpnt));
 313
 314 /* Error handler */
 315 /*static int nsp_eh_abort       (struct scsi_cmnd *SCpnt);*/
 316 /*static int nsp_eh_device_reset(struct scsi_cmnd *SCpnt);*/
 317 static int nsp_eh_bus_reset    (struct scsi_cmnd *SCpnt);
 318 static int nsp_eh_host_reset   (struct scsi_cmnd *SCpnt);
 319 static int nsp_bus_reset       (nsp_hw_data *data);
 320
 321 /* */
 322 static int  nsphw_init           (nsp_hw_data *data);
 323 static int  nsphw_start_selection(struct scsi_cmnd *SCpnt);
 324 static void nsp_start_timer      (struct scsi_cmnd *SCpnt, int time);
 325 static int  nsp_fifo_count       (struct scsi_cmnd *SCpnt);
 326 static void nsp_pio_read         (struct scsi_cmnd *SCpnt);
 327 static void nsp_pio_write        (struct scsi_cmnd *SCpnt);
 328 static int  nsp_nexus            (struct scsi_cmnd *SCpnt);
 329 static void nsp_scsi_done        (struct scsi_cmnd *SCpnt);
 330 static int  nsp_analyze_sdtr     (struct scsi_cmnd *SCpnt);
 331 static int  nsp_negate_signal    (struct scsi_cmnd *SCpnt,
 332                                   unsigned char mask, char *str);
 333 static int  nsp_expect_signal    (struct scsi_cmnd *SCpnt,
 334                                   unsigned char current_phase,
 335                                   unsigned char  mask);
 336 static int  nsp_xfer             (struct scsi_cmnd *SCpnt, int phase);
 337 static int  nsp_dataphase_bypass (struct scsi_cmnd *SCpnt);
 338 static int  nsp_reselected       (struct scsi_cmnd *SCpnt);
 339 static struct Scsi_Host *nsp_detect(struct scsi_host_template *sht);
 340
 341 /* Interrupt handler */
 342 //static irqreturn_t nspintr(int irq, void *dev_id);
 343
 344 /* Module entry point*/
 345 static int  __init nsp_cs_init(void);
 346 static void __exit nsp_cs_exit(void);
 347
 348 /* Debug */
 349 #ifdef NSP_DEBUG
 350 static void show_command (struct scsi_cmnd *SCpnt);
 351 static void show_phase   (struct scsi_cmnd *SCpnt);
 352 static void show_busphase(unsigned char stat);
 353 static void show_message (nsp_hw_data *data);
 354 #else
 355 # define show_command(ptr)   /* */
 356 # define show_phase(SCpnt)   /* */
 357 # define show_busphase(stat) /* */
 358 # define show_message(data)  /* */
 359 #endif
 360
 361 /*
 362  * SCSI phase
 363  */
 364 enum _scsi_phase {
 365         PH_UNDETERMINED ,
 366         PH_ARBSTART     ,
 367         PH_SELSTART     ,
 368         PH_SELECTED     ,
 369         PH_COMMAND      ,
 370         PH_DATA         ,
 371         PH_STATUS       ,
 372         PH_MSG_IN       ,
 373         PH_MSG_OUT      ,
 374         PH_DISCONNECT   ,
 375         PH_RESELECT     ,
 376         PH_ABORT        ,
 377         PH_RESET
 378 };
 379
 380 enum _data_in_out {
 381         IO_UNKNOWN,
 382         IO_IN,
 383         IO_OUT
 384 };
 385
 386 enum _burst_mode {
 387         BURST_IO8   = 0,
 388         BURST_IO32  = 1,
 389         BURST_MEM32 = 2,
 390 };
 391
 392 /**************************************************************************
 393  * SCSI messaage
 394  */
 395 #define MSG_COMMAND_COMPLETE 0x00
 396 #define MSG_EXTENDED         0x01
 397 #define MSG_ABORT            0x06
 398 #define MSG_NO_OPERATION     0x08
 399 #define MSG_BUS_DEVICE_RESET 0x0c
 400
 401 #define MSG_EXT_SDTR         0x01
 402
 403 /* scatter-gather table */
 404 #  define BUFFER_ADDR ((char *)((unsigned int)(SCpnt->SCp.buffer->page) + SCpnt->SCp.buffer->offset))
 405
 406 #endif  /*__nsp_cs__*/
 407 /* end */