drivers/scsi/nsp32.h

   1 /*
   2  * Workbit NinjaSCSI-32Bi/UDE PCI/CardBus SCSI Host Bus Adapter driver
   3  * Basic data header
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14 */
  15
  16 #ifndef _NSP32_H
  17 #define _NSP32_H
  18
  19 //#define NSP32_DEBUG 9
  20
  21 /*
  22  * VENDOR/DEVICE ID
  23  */
  24 #define PCI_VENDOR_ID_IODATA  0x10fc
  25
  26 #define PCI_DEVICE_ID_NINJASCSI_32BI_CBSC_II   0x0005
  27 #define PCI_DEVICE_ID_NINJASCSI_32BI_KME       0xf007
  28 #define PCI_DEVICE_ID_NINJASCSI_32BI_WBT       0x8007
  29 #define PCI_DEVICE_ID_WORKBIT_STANDARD         0xf010
  30 #define PCI_DEVICE_ID_WORKBIT_DUALEDGE         0xf011
  31 #define PCI_DEVICE_ID_NINJASCSI_32BI_LOGITEC   0xf012
  32 #define PCI_DEVICE_ID_NINJASCSI_32BIB_LOGITEC  0xf013
  33 #define PCI_DEVICE_ID_NINJASCSI_32UDE_MELCO    0xf015
  34 #define PCI_DEVICE_ID_NINJASCSI_32UDE_MELCO_II 0x8009
  35
  36 /*
  37  * MODEL
  38  */
  39 enum {
  40         MODEL_IODATA        = 0,
  41         MODEL_KME           = 1,
  42         MODEL_WORKBIT       = 2,
  43         MODEL_LOGITEC       = 3,
  44         MODEL_PCI_WORKBIT   = 4,
  45         MODEL_PCI_LOGITEC   = 5,
  46         MODEL_PCI_MELCO     = 6,
  47 };
  48
  49 static char * nsp32_model[] = {
  50         "I-O DATA CBSC-II CardBus card",
  51         "KME SCSI CardBus card",
  52         "Workbit duo SCSI CardBus card",
  53         "Logitec CardBus card with external ROM",
  54         "Workbit / I-O DATA PCI card",
  55         "Logitec PCI card with external ROM",
  56         "Melco CardBus/PCI card with external ROM",
  57 };
  58
  59
  60 /*
  61  * SCSI Generic Definitions
  62  */
  63 #define EXTENDED_SDTR_LEN       0x03
  64
  65 /* Little Endian */
  66 typedef u32 u32_le;
  67 typedef u16 u16_le;
  68
  69 /*
  70  * MACRO
  71  */
  72 #define BIT(x)      (1UL << (x))
  73
  74 /*
  75  * BASIC Definitions
  76  */
  77 #ifndef TRUE
  78 # define TRUE  1
  79 #endif
  80 #ifndef FALSE
  81 # define FALSE 0
  82 #endif
  83 #define ASSERT 1
  84 #define NEGATE 0
  85
  86
  87 /*******************/
  88 /* normal register */
  89 /*******************/
  90 /*
  91  * Don't access below register with Double Word:
  92  * +00, +04, +08, +0c, +64, +80, +84, +88, +90, +c4, +c8, +cc, +d0.
  93  */
  94 #define IRQ_CONTROL 0x00        /* BASE+00, W, W */
  95 #define IRQ_STATUS  0x00        /* BASE+00, W, R */
  96 # define IRQSTATUS_LATCHED_MSG      BIT(0)
  97 # define IRQSTATUS_LATCHED_IO       BIT(1)
  98 # define IRQSTATUS_LATCHED_CD       BIT(2)
  99 # define IRQSTATUS_LATCHED_BUS_FREE BIT(3)
 100 # define IRQSTATUS_RESELECT_OCCUER  BIT(4)
 101 # define IRQSTATUS_PHASE_CHANGE_IRQ BIT(5)
 102 # define IRQSTATUS_SCSIRESET_IRQ    BIT(6)
 103 # define IRQSTATUS_TIMER_IRQ        BIT(7)
 104 # define IRQSTATUS_FIFO_SHLD_IRQ    BIT(8)
 105 # define IRQSTATUS_PCI_IRQ          BIT(9)
 106 # define IRQSTATUS_BMCNTERR_IRQ     BIT(10)
 107 # define IRQSTATUS_AUTOSCSI_IRQ     BIT(11)
 108 # define PCI_IRQ_MASK               BIT(12)
 109 # define TIMER_IRQ_MASK             BIT(13)
 110 # define FIFO_IRQ_MASK              BIT(14)
 111 # define SCSI_IRQ_MASK              BIT(15)
 112 # define IRQ_CONTROL_ALL_IRQ_MASK   (PCI_IRQ_MASK   | \
 113                                      TIMER_IRQ_MASK | \
 114                                      FIFO_IRQ_MASK  | \
 115                                      SCSI_IRQ_MASK  )
 116 # define IRQSTATUS_ANY_IRQ          (IRQSTATUS_RESELECT_OCCUER  | \
 117                                      IRQSTATUS_PHASE_CHANGE_IRQ | \
 118                                      IRQSTATUS_SCSIRESET_IRQ    | \
 119                                      IRQSTATUS_TIMER_IRQ        | \
 120                                      IRQSTATUS_FIFO_SHLD_IRQ    | \
 121                                      IRQSTATUS_PCI_IRQ          | \
 122                                      IRQSTATUS_BMCNTERR_IRQ     | \
 123                                      IRQSTATUS_AUTOSCSI_IRQ     )
 124
 125 #define TRANSFER_CONTROL        0x02    /* BASE+02, W, W */
 126 #define TRANSFER_STATUS         0x02    /* BASE+02, W, R */
 127 # define CB_MMIO_MODE        BIT(0)
 128 # define CB_IO_MODE          BIT(1)
 129 # define BM_TEST             BIT(2)
 130 # define BM_TEST_DIR         BIT(3)
 131 # define DUAL_EDGE_ENABLE    BIT(4)
 132 # define NO_TRANSFER_TO_HOST BIT(5)
 133 # define TRANSFER_GO         BIT(7)
 134 # define BLIEND_MODE         BIT(8)
 135 # define BM_START            BIT(9)
 136 # define ADVANCED_BM_WRITE   BIT(10)
 137 # define BM_SINGLE_MODE      BIT(11)
 138 # define FIFO_TRUE_FULL      BIT(12)
 139 # define FIFO_TRUE_EMPTY     BIT(13)
 140 # define ALL_COUNTER_CLR     BIT(14)
 141 # define FIFOTEST            BIT(15)
 142
 143 #define INDEX_REG               0x04    /* BASE+04, Byte(R/W), Word(R) */
 144
 145 #define TIMER_SET               0x06    /* BASE+06, W, R/W */
 146 # define TIMER_CNT_MASK (0xff)
 147 # define TIMER_STOP     BIT(8)
 148
 149 #define DATA_REG_LOW            0x08    /* BASE+08, LowW, R/W */
 150 #define DATA_REG_HI             0x0a    /* BASE+0a, Hi-W, R/W */
 151
 152 #define FIFO_REST_CNT           0x0c    /* BASE+0c, W, R/W */
 153 # define FIFO_REST_MASK       0x1ff
 154 # define FIFO_EMPTY_SHLD_FLAG BIT(14)
 155 # define FIFO_FULL_SHLD_FLAG  BIT(15)
 156
 157 #define SREQ_SMPL_RATE          0x0f    /* BASE+0f, B, R/W */
 158 # define SREQSMPLRATE_RATE0 BIT(0)
 159 # define SREQSMPLRATE_RATE1 BIT(1)
 160 # define SAMPLING_ENABLE    BIT(2)
 161 #  define SMPL_40M (0)                   /* 40MHz:   0-100ns/period */
 162 #  define SMPL_20M (SREQSMPLRATE_RATE0)  /* 20MHz: 100-200ns/period */
 163 #  define SMPL_10M (SREQSMPLRATE_RATE1)  /* 10Mhz: 200-   ns/period */
 164
 165 #define SCSI_BUS_CONTROL        0x10    /* BASE+10, B, R/W */
 166 # define BUSCTL_SEL         BIT(0)
 167 # define BUSCTL_RST         BIT(1)
 168 # define BUSCTL_DATAOUT_ENB BIT(2)
 169 # define BUSCTL_ATN         BIT(3)
 170 # define BUSCTL_ACK         BIT(4)
 171 # define BUSCTL_BSY         BIT(5)
 172 # define AUTODIRECTION      BIT(6)
 173 # define ACKENB             BIT(7)
 174
 175 #define CLR_COUNTER             0x12    /* BASE+12, B, W */
 176 # define ACK_COUNTER_CLR       BIT(0)
 177 # define SREQ_COUNTER_CLR      BIT(1)
 178 # define FIFO_HOST_POINTER_CLR BIT(2)
 179 # define FIFO_REST_COUNT_CLR   BIT(3)
 180 # define BM_COUNTER_CLR        BIT(4)
 181 # define SAVED_ACK_CLR         BIT(5)
 182 # define CLRCOUNTER_ALLMASK    (ACK_COUNTER_CLR       | \
 183                                 SREQ_COUNTER_CLR      | \
 184                                 FIFO_HOST_POINTER_CLR | \
 185                                 FIFO_REST_COUNT_CLR   | \
 186                                 BM_COUNTER_CLR        | \
 187                                 SAVED_ACK_CLR         )
 188
 189 #define SCSI_BUS_MONITOR        0x12    /* BASE+12, B, R */
 190 # define BUSMON_MSG BIT(0)
 191 # define BUSMON_IO  BIT(1)
 192 # define BUSMON_CD  BIT(2)
 193 # define BUSMON_BSY BIT(3)
 194 # define BUSMON_ACK BIT(4)
 195 # define BUSMON_REQ BIT(5)
 196 # define BUSMON_SEL BIT(6)
 197 # define BUSMON_ATN BIT(7)
 198
 199 #define COMMAND_DATA            0x14    /* BASE+14, B, R/W */
 200
 201 #define PARITY_CONTROL          0x16    /* BASE+16, B, W */
 202 # define PARITY_CHECK_ENABLE BIT(0)
 203 # define PARITY_ERROR_CLEAR  BIT(1)
 204 #define PARITY_STATUS           0x16    /* BASE+16, B, R */
 205 //# define PARITY_CHECK_ENABLE BIT(0)
 206 # define PARITY_ERROR_NORMAL BIT(1)
 207 # define PARITY_ERROR_LSB    BIT(1)
 208 # define PARITY_ERROR_MSB    BIT(2)
 209
 210 #define RESELECT_ID             0x18    /* BASE+18, B, R */
 211
 212 #define COMMAND_CONTROL         0x18    /* BASE+18, W, W */
 213 # define CLEAR_CDB_FIFO_POINTER BIT(0)
 214 # define AUTO_COMMAND_PHASE     BIT(1)
 215 # define AUTOSCSI_START         BIT(2)
 216 # define AUTOSCSI_RESTART       BIT(3)
 217 # define AUTO_PARAMETER         BIT(4)
 218 # define AUTO_ATN               BIT(5)
 219 # define AUTO_MSGIN_00_OR_04    BIT(6)
 220 # define AUTO_MSGIN_02          BIT(7)
 221 # define AUTO_MSGIN_03          BIT(8)
 222
 223 #define SET_ARBIT               0x1a    /* BASE+1a, B, W */
 224 # define ARBIT_GO    BIT(0)
 225 # define ARBIT_CLEAR BIT(1)
 226
 227 #define ARBIT_STATUS            0x1a    /* BASE+1a, B, R */
 228 //# define ARBIT_GO             BIT(0)
 229 # define ARBIT_WIN            BIT(1)
 230 # define ARBIT_FAIL           BIT(2)
 231 # define AUTO_PARAMETER_VALID BIT(3)
 232 # define SGT_VALID            BIT(4)
 233
 234 #define SYNC_REG                0x1c    /* BASE+1c, B, R/W */
 235
 236 #define ACK_WIDTH               0x1d    /* BASE+1d, B, R/W */
 237
 238 #define SCSI_DATA_WITH_ACK      0x20    /* BASE+20, B, R/W */
 239 #define SCSI_OUT_LATCH_TARGET_ID 0x22   /* BASE+22, B, W */
 240 #define SCSI_DATA_IN            0x22    /* BASE+22, B, R */
 241
 242 #define SCAM_CONTROL            0x24    /* BASE+24, B, W */
 243 #define SCAM_STATUS             0x24    /* BASE+24, B, R */
 244 # define SCAM_MSG    BIT(0)
 245 # define SCAM_IO     BIT(1)
 246 # define SCAM_CD     BIT(2)
 247 # define SCAM_BSY    BIT(3)
 248 # define SCAM_SEL    BIT(4)
 249 # define SCAM_XFEROK BIT(5)
 250
 251 #define SCAM_DATA               0x26    /* BASE+26, B, R/W */
 252 # define SD0    BIT(0)
 253 # define SD1    BIT(1)
 254 # define SD2    BIT(2)
 255 # define SD3    BIT(3)
 256 # define SD4    BIT(4)
 257 # define SD5    BIT(5)
 258 # define SD6    BIT(6)
 259 # define SD7    BIT(7)
 260
 261 #define SACK_CNT                0x28    /* BASE+28, DW, R/W */
 262 #define SREQ_CNT                0x2c    /* BASE+2c, DW, R/W */
 263
 264 #define FIFO_DATA_LOW           0x30    /* BASE+30, B/W/DW, R/W */
 265 #define FIFO_DATA_HIGH          0x32    /* BASE+32, B/W, R/W */
 266 #define BM_START_ADR            0x34    /* BASE+34, DW, R/W */
 267
 268 #define BM_CNT                  0x38    /* BASE+38, DW, R/W */
 269 # define BM_COUNT_MASK 0x0001ffffUL
 270 # define SGTEND        BIT(31)      /* Last SGT marker */
 271
 272 #define SGT_ADR                 0x3c    /* BASE+3c, DW, R/W */
 273 #define WAIT_REG                0x40    /* Bi only */
 274
 275 #define SCSI_EXECUTE_PHASE      0x40    /* BASE+40, W, R */
 276 # define COMMAND_PHASE     BIT(0)
 277 # define DATA_IN_PHASE     BIT(1)
 278 # define DATA_OUT_PHASE    BIT(2)
 279 # define MSGOUT_PHASE      BIT(3)
 280 # define STATUS_PHASE      BIT(4)
 281 # define ILLEGAL_PHASE     BIT(5)
 282 # define BUS_FREE_OCCUER   BIT(6)
 283 # define MSG_IN_OCCUER     BIT(7)
 284 # define MSG_OUT_OCCUER    BIT(8)
 285 # define SELECTION_TIMEOUT BIT(9)
 286 # define MSGIN_00_VALID    BIT(10)
 287 # define MSGIN_02_VALID    BIT(11)
 288 # define MSGIN_03_VALID    BIT(12)
 289 # define MSGIN_04_VALID    BIT(13)
 290 # define AUTOSCSI_BUSY     BIT(15)
 291
 292 #define SCSI_CSB_IN             0x42    /* BASE+42, B, R */
 293
 294 #define SCSI_MSG_OUT            0x44    /* BASE+44, DW, R/W */
 295 # define MSGOUT_COUNT_MASK (BIT(0)|BIT(1))
 296 # define MV_VALID           BIT(7)
 297
 298 #define SEL_TIME_OUT            0x48    /* BASE+48, W, R/W */
 299 #define SAVED_SACK_CNT          0x4c    /* BASE+4c, DW, R */
 300
 301 #define HTOSDATADELAY           0x50    /* BASE+50, B, R/W */
 302 #define STOHDATADELAY           0x54    /* BASE+54, B, R/W */
 303 #define ACKSUMCHECKRD           0x58    /* BASE+58, W, R */
 304 #define REQSUMCHECKRD           0x5c    /* BASE+5c, W, R */
 305
 306
 307 /********************/
 308 /* indexed register */
 309 /********************/
 310
 311 #define CLOCK_DIV               0x00    /* BASE+08, IDX+00, B, R/W */
 312 # define CLOCK_2  BIT(0)        /* MCLK/2 */
 313 # define CLOCK_4  BIT(1)        /* MCLK/4 */
 314 # define PCICLK   BIT(7)        /* PCICLK (33MHz) */
 315
 316 #define TERM_PWR_CONTROL        0x01    /* BASE+08, IDX+01, B, R/W */
 317 # define BPWR  BIT(0)
 318 # define SENSE BIT(1)   /* Read Only */
 319
 320 #define EXT_PORT_DDR            0x02    /* BASE+08, IDX+02, B, R/W */
 321 #define EXT_PORT                0x03    /* BASE+08, IDX+03, B, R/W */
 322 # define LED_ON  (0)
 323 # define LED_OFF BIT(0)
 324
 325 #define IRQ_SELECT              0x04    /* BASE+08, IDX+04, W, R/W */
 326 # define IRQSELECT_RESELECT_IRQ      BIT(0)
 327 # define IRQSELECT_PHASE_CHANGE_IRQ  BIT(1)
 328 # define IRQSELECT_SCSIRESET_IRQ     BIT(2)
 329 # define IRQSELECT_TIMER_IRQ         BIT(3)
 330 # define IRQSELECT_FIFO_SHLD_IRQ     BIT(4)
 331 # define IRQSELECT_TARGET_ABORT_IRQ  BIT(5)
 332 # define IRQSELECT_MASTER_ABORT_IRQ  BIT(6)
 333 # define IRQSELECT_SERR_IRQ          BIT(7)
 334 # define IRQSELECT_PERR_IRQ          BIT(8)
 335 # define IRQSELECT_BMCNTERR_IRQ      BIT(9)
 336 # define IRQSELECT_AUTO_SCSI_SEQ_IRQ BIT(10)
 337
 338 #define OLD_SCSI_PHASE          0x05    /* BASE+08, IDX+05, B, R */
 339 # define OLD_MSG  BIT(0)
 340 # define OLD_IO   BIT(1)
 341 # define OLD_CD   BIT(2)
 342 # define OLD_BUSY BIT(3)
 343
 344 #define FIFO_FULL_SHLD_COUNT    0x06    /* BASE+08, IDX+06, B, R/W */
 345 #define FIFO_EMPTY_SHLD_COUNT   0x07    /* BASE+08, IDX+07, B, R/W */
 346
 347 #define EXP_ROM_CONTROL         0x08    /* BASE+08, IDX+08, B, R/W */ /* external ROM control */
 348 # define ROM_WRITE_ENB BIT(0)
 349 # define IO_ACCESS_ENB BIT(1)
 350 # define ROM_ADR_CLEAR BIT(2)
 351
 352 #define EXP_ROM_ADR             0x09    /* BASE+08, IDX+09, W, R/W */
 353
 354 #define EXP_ROM_DATA            0x0a    /* BASE+08, IDX+0a, B, R/W */
 355
 356 #define CHIP_MODE               0x0b    /* BASE+08, IDX+0b, B, R   */ /* NinjaSCSI-32Bi only */
 357 # define OEM0 BIT(1)  /* OEM select */ /* 00=I-O DATA, 01=KME, 10=Workbit, 11=Ext ROM */
 358 # define OEM1 BIT(2)  /* OEM select */
 359 # define OPTB BIT(3)  /* KME mode select */
 360 # define OPTC BIT(4)  /* KME mode select */
 361 # define OPTD BIT(5)  /* KME mode select */
 362 # define OPTE BIT(6)  /* KME mode select */
 363 # define OPTF BIT(7)  /* Power management */
 364
 365 #define MISC_WR                 0x0c    /* BASE+08, IDX+0c, W, R/W */
 366 #define MISC_RD                 0x0c
 367 # define SCSI_DIRECTION_DETECTOR_SELECT BIT(0)
 368 # define SCSI2_HOST_DIRECTION_VALID     BIT(1)  /* Read only */
 369 # define HOST2_SCSI_DIRECTION_VALID     BIT(2)  /* Read only */
 370 # define DELAYED_BMSTART                BIT(3)
 371 # define MASTER_TERMINATION_SELECT      BIT(4)
 372 # define BMREQ_NEGATE_TIMING_SEL        BIT(5)
 373 # define AUTOSEL_TIMING_SEL             BIT(6)
 374 # define MISC_MABORT_MASK               BIT(7)
 375 # define BMSTOP_CHANGE2_NONDATA_PHASE   BIT(8)
 376
 377 #define BM_CYCLE                0x0d    /* BASE+08, IDX+0d, B, R/W */
 378 # define BM_CYCLE0               BIT(0)
 379 # define BM_CYCLE1               BIT(1)
 380 # define BM_FRAME_ASSERT_TIMING  BIT(2)
 381 # define BM_IRDY_ASSERT_TIMING   BIT(3)
 382 # define BM_SINGLE_BUS_MASTER    BIT(4)
 383 # define MEMRD_CMD0              BIT(5)
 384 # define SGT_AUTO_PARA_MEMED_CMD BIT(6)
 385 # define MEMRD_CMD1              BIT(7)
 386
 387
 388 #define SREQ_EDGH               0x0e    /* BASE+08, IDX+0e, B, W */
 389 # define SREQ_EDGH_SELECT BIT(0)
 390
 391 #define UP_CNT                  0x0f    /* BASE+08, IDX+0f, B, W */
 392 # define REQCNT_UP  BIT(0)
 393 # define ACKCNT_UP  BIT(1)
 394 # define BMADR_UP   BIT(4)
 395 # define BMCNT_UP   BIT(5)
 396 # define SGT_CNT_UP BIT(7)
 397
 398 #define CFG_CMD_STR             0x10    /* BASE+08, IDX+10, W, R */
 399 #define CFG_LATE_CACHE          0x11    /* BASE+08, IDX+11, W, R/W */
 400 #define CFG_BASE_ADR_1          0x12    /* BASE+08, IDX+12, W, R */
 401 #define CFG_BASE_ADR_2          0x13    /* BASE+08, IDX+13, W, R */
 402 #define CFG_INLINE              0x14    /* BASE+08, IDX+14, W, R */
 403
 404 #define SERIAL_ROM_CTL          0x15    /* BASE+08, IDX+15, B, R */
 405 # define SCL BIT(0)
 406 # define ENA BIT(1)
 407 # define SDA BIT(2)
 408
 409 #define FIFO_HST_POINTER        0x16    /* BASE+08, IDX+16, B, R/W */
 410 #define SREQ_DELAY              0x17    /* BASE+08, IDX+17, B, R/W */
 411 #define SACK_DELAY              0x18    /* BASE+08, IDX+18, B, R/W */
 412 #define SREQ_NOISE_CANCEL       0x19    /* BASE+08, IDX+19, B, R/W */
 413 #define SDP_NOISE_CANCEL        0x1a    /* BASE+08, IDX+1a, B, R/W */
 414 #define DELAY_TEST              0x1b    /* BASE+08, IDX+1b, B, R/W */
 415 #define SD0_NOISE_CANCEL        0x20    /* BASE+08, IDX+20, B, R/W */
 416 #define SD1_NOISE_CANCEL        0x21    /* BASE+08, IDX+21, B, R/W */
 417 #define SD2_NOISE_CANCEL        0x22    /* BASE+08, IDX+22, B, R/W */
 418 #define SD3_NOISE_CANCEL        0x23    /* BASE+08, IDX+23, B, R/W */
 419 #define SD4_NOISE_CANCEL        0x24    /* BASE+08, IDX+24, B, R/W */
 420 #define SD5_NOISE_CANCEL        0x25    /* BASE+08, IDX+25, B, R/W */
 421 #define SD6_NOISE_CANCEL        0x26    /* BASE+08, IDX+26, B, R/W */
 422 #define SD7_NOISE_CANCEL        0x27    /* BASE+08, IDX+27, B, R/W */
 423
 424
 425 /*
 426  * Useful Bus Monitor status combinations.
 427  */
 428 #define BUSMON_BUS_FREE    0
 429 #define BUSMON_COMMAND     ( BUSMON_BSY |                          BUSMON_CD | BUSMON_REQ )
 430 #define BUSMON_MESSAGE_IN  ( BUSMON_BSY | BUSMON_MSG | BUSMON_IO | BUSMON_CD | BUSMON_REQ )
 431 #define BUSMON_MESSAGE_OUT ( BUSMON_BSY | BUSMON_MSG |             BUSMON_CD | BUSMON_REQ )
 432 #define BUSMON_DATA_IN     ( BUSMON_BSY |              BUSMON_IO |             BUSMON_REQ )
 433 #define BUSMON_DATA_OUT    ( BUSMON_BSY |                                      BUSMON_REQ )
 434 #define BUSMON_STATUS      ( BUSMON_BSY |              BUSMON_IO | BUSMON_CD | BUSMON_REQ )
 435 #define BUSMON_RESELECT    (                           BUSMON_IO                          | BUSMON_SEL)
 436 #define BUSMON_PHASE_MASK  (              BUSMON_MSG | BUSMON_IO | BUSMON_CD              | BUSMON_SEL)
 437
 438 #define BUSPHASE_COMMAND     ( BUSMON_COMMAND     & BUSMON_PHASE_MASK )
 439 #define BUSPHASE_MESSAGE_IN  ( BUSMON_MESSAGE_IN  & BUSMON_PHASE_MASK )
 440 #define BUSPHASE_MESSAGE_OUT ( BUSMON_MESSAGE_OUT & BUSMON_PHASE_MASK )
 441 #define BUSPHASE_DATA_IN     ( BUSMON_DATA_IN     & BUSMON_PHASE_MASK )
 442 #define BUSPHASE_DATA_OUT    ( BUSMON_DATA_OUT    & BUSMON_PHASE_MASK )
 443 #define BUSPHASE_STATUS      ( BUSMON_STATUS      & BUSMON_PHASE_MASK )
 444 #define BUSPHASE_SELECT      ( BUSMON_SEL | BUSMON_IO )
 445
 446
 447 /************************************************************************
 448  * structure for DMA/Scatter Gather list
 449  */
 450 #define NSP32_SG_SIZE           SG_ALL
 451
 452 typedef struct _nsp32_sgtable {
 453         /* values must be little endian */
 454         u32_le addr; /* transfer address */
 455         u32_le len;  /* transfer length. BIT(31) is for SGT_END mark */
 456 } __attribute__ ((packed)) nsp32_sgtable;
 457
 458 typedef struct _nsp32_sglun {
 459         nsp32_sgtable sgt[NSP32_SG_SIZE+1];     /* SG table */
 460 } __attribute__ ((packed)) nsp32_sglun;
 461 #define NSP32_SG_TABLE_SIZE (sizeof(nsp32_sgtable) * NSP32_SG_SIZE * MAX_TARGET * MAX_LUN)
 462
 463 /* Auto parameter mode memory map.   */
 464 /* All values must be little endian. */
 465 typedef struct _nsp32_autoparam {
 466         u8     cdb[4 * 0x10];    /* SCSI Command                      */
 467         u32_le msgout;           /* outgoing messages                 */
 468         u8     syncreg;          /* sync register value               */
 469         u8     ackwidth;         /* ack width register value          */
 470         u8     target_id;        /* target/host device id             */
 471         u8     sample_reg;       /* hazard killer sampling rate       */
 472         u16_le command_control;  /* command control register          */
 473         u16_le transfer_control; /* transfer control register         */
 474         u32_le sgt_pointer;      /* SG table physical address for DMA */
 475         u32_le dummy[2];
 476 } __attribute__ ((packed)) nsp32_autoparam;  /* must be packed struct */
 477
 478 /*
 479  * host data structure
 480  */
 481 /* message in/out buffer */
 482 #define MSGOUTBUF_MAX           20
 483 #define MSGINBUF_MAX            20
 484
 485 /* flag for trans_method */
 486 #define NSP32_TRANSFER_BUSMASTER        BIT(0)
 487 #define NSP32_TRANSFER_MMIO             BIT(1)  /* Not supported yet */
 488 #define NSP32_TRANSFER_PIO              BIT(2)  /* Not supported yet */
 489
 490
 491 /*
 492  * structure for connected LUN dynamic data
 493  *
 494  * Note: Currently tagged queuing is disabled, each nsp32_lunt holds
 495  *       one SCSI command and one state.
 496  */
 497 #define DISCPRIV_OK             BIT(0)          /* DISCPRIV Enable mode */
 498 #define MSGIN03                 BIT(1)          /* Auto Msg In 03 Flag  */
 499
 500 typedef struct _nsp32_lunt {
 501         Scsi_Cmnd       *SCpnt;     /* Current Handling Scsi_Cmnd */
 502         unsigned long    save_datp;  /* Save Data Pointer - saved position from initial address */
 503         int              msgin03;       /* auto msg in 03 flag     */
 504         unsigned int     sg_num;        /* Total number of SG entries */
 505         int              cur_entry;     /* Current SG entry number */
 506         nsp32_sglun     *sglun;         /* sg table per lun        */
 507         dma_addr_t       sglun_paddr;   /* sglun physical address  */
 508 } nsp32_lunt;
 509
 510
 511 /*
 512  * SCSI TARGET/LUN definition
 513  */
 514 #define NSP32_HOST_SCSIID    7  /* SCSI initiator is everytime defined as 7 */
 515 #define MAX_TARGET           8
 516 #define MAX_LUN              8  /* XXX: In SPI3, max number of LUN is 64. */
 517
 518
 519 typedef struct _nsp32_sync_table {
 520         unsigned char   period_num;     /* period number                  */
 521         unsigned char   ackwidth;       /* ack width designated by period */
 522         unsigned char   start_period;   /* search range - start period    */
 523         unsigned char   end_period;     /* search range - end period      */
 524         unsigned char   sample_rate;    /* hazard killer parameter        */
 525 } nsp32_sync_table;
 526
 527
 528 /*
 529  * structure for target device static data
 530  */
 531 /* flag for nsp32_target.sync_flag */
 532 #define SDTR_INITIATOR    BIT(0)    /* sending SDTR from initiator        */
 533 #define SDTR_TARGET       BIT(1)    /* sending SDTR from target           */
 534 #define SDTR_DONE         BIT(2)    /* exchanging SDTR has been processed */
 535
 536 /* syncronous period value for nsp32_target.config_max */
 537 #define FAST5M                  0x32
 538 #define FAST10M                 0x19
 539 #define ULTRA20M                0x0c
 540
 541 /* flag for nsp32_target.{sync_offset}, period */
 542 #define ASYNC_OFFSET            0       /* asynchronous transfer           */
 543 #define SYNC_OFFSET             0xf     /* synchronous transfer max offset */
 544
 545 /* syncreg:
 546   bit:07 06 05 04 03 02 01 00
 547       ---PERIOD-- ---OFFSET--   */
 548 #define TO_SYNCREG(period, offset) (((period) & 0x0f) << 4 | ((offset) & 0x0f))
 549
 550 typedef struct _nsp32_target {
 551         unsigned char   syncreg;        /* value for SYNCREG   */
 552         unsigned char   ackwidth;       /* value for ACKWIDTH  */
 553         unsigned char   period;         /* sync period (0-255) */
 554         unsigned char   offset;         /* sync offset (0-15)  */
 555         int             sync_flag;      /* SDTR_*, 0           */
 556         int             limit_entry;    /* max speed limit entry designated
 557                                            by EEPROM configuration */
 558         unsigned char   sample_reg;     /* SREQ hazard killer register */
 559 } nsp32_target;
 560
 561 typedef struct _nsp32_hw_data {
 562         int           IrqNumber;
 563         int           BaseAddress;
 564         int           NumAddress;
 565         unsigned long MmioAddress;
 566 #define NSP32_MMIO_OFFSET 0x0800
 567         unsigned long MmioLength;
 568
 569         Scsi_Cmnd *CurrentSC;
 570
 571         struct pci_dev             *Pci;
 572         const struct pci_device_id *pci_devid;
 573         struct Scsi_Host           *Host;
 574         spinlock_t                  Lock;
 575
 576         char info_str[100];
 577
 578         /* allocated memory region */
 579         nsp32_sglun      *sg_list;      /* sglist virtuxal address         */
 580         dma_addr_t        sg_paddr;     /* physical address of hw_sg_table */
 581         nsp32_autoparam  *autoparam;    /* auto parameter transfer region  */
 582         dma_addr_t        auto_paddr;   /* physical address of autoparam   */
 583         int               cur_entry;    /* current sgt entry               */
 584
 585         /* target/LUN */
 586         nsp32_lunt       *cur_lunt;     /* Current connected LUN table */
 587         nsp32_lunt        lunt[MAX_TARGET][MAX_LUN];  /* All LUN table */
 588
 589         nsp32_target     *cur_target;   /* Current connected SCSI ID    */
 590         nsp32_target      target[MAX_TARGET];        /* SCSI ID */
 591         int               cur_id;       /* Current connected target ID  */
 592         int               cur_lun;      /* Current connected target LUN */
 593
 594         /* behavior setting parameters */
 595         int               trans_method; /* transfer method flag            */
 596         int               resettime;    /* Reset time                      */
 597         int               clock;        /* clock dividing flag             */
 598         nsp32_sync_table *synct;        /* sync_table determined by clock  */
 599         int               syncnum;      /* the max number of synct element */
 600
 601         /* message buffer */
 602         unsigned char msgoutbuf[MSGOUTBUF_MAX]; /* msgout buffer    */
 603         char          msgout_len;               /* msgoutbuf length */
 604         unsigned char msginbuf [MSGINBUF_MAX];  /* megin buffer     */
 605         char          msgin_len;                /* msginbuf length  */
 606
 607 #ifdef CONFIG_PM
 608         u32           PciState[16];     /* save PCI state to this area */
 609 #endif
 610 } nsp32_hw_data;
 611
 612 /*
 613  * TIME definition
 614  */
 615 #define RESET_HOLD_TIME         10000   /* reset time in us (SCSI-2 says the
 616                                            minimum is 25us) */
 617 #define SEL_TIMEOUT_TIME        10000   /* 250ms defined in SCSI specification
 618                                            (25.6us/1unit) */
 619 #define ARBIT_TIMEOUT_TIME      100     /* 100us */
 620 #define REQSACK_TIMEOUT_TIME    10000   /* max wait time for REQ/SACK assertion
 621                                            or negation, 10000us == 10ms */
 622
 623 /**************************************************************************
 624  * Compatibility functions
 625  */
 626
 627 /* for Kernel 2.4 */
 628 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0))
 629 # define scsi_register_host(template)   scsi_register_module(MODULE_SCSI_HA, template)
 630 # define scsi_unregister_host(template) scsi_unregister_module(MODULE_SCSI_HA, template)
 631 # define scsi_host_put(host)            scsi_unregister(host)
 632 # define pci_name(pci_dev)              ((pci_dev)->slot_name)
 633
 634 typedef void irqreturn_t;
 635 # define IRQ_NONE      /* */
 636 # define IRQ_HANDLED   /* */
 637 # define IRQ_RETVAL(x) /* */
 638
 639 /* This is ad-hoc version of scsi_host_get_next() */
 640 static inline struct Scsi_Host *scsi_host_get_next(struct Scsi_Host *host)
 641 {
 642         if (host == NULL) {
 643                 return scsi_hostlist;
 644         } else {
 645                 return host->next;
 646         }
 647 }
 648
 649 /* This is ad-hoc version of scsi_host_hn_get() */
 650 static inline struct Scsi_Host *scsi_host_hn_get(unsigned short hostno)
 651 {
 652         struct Scsi_Host *host;
 653
 654         for (host = scsi_host_get_next(NULL); host != NULL;
 655              host = scsi_host_get_next(host)) {
 656                 if (host->host_no == hostno) {
 657                         break;
 658                 }
 659         }
 660
 661         return host;
 662 }
 663 #endif
 664
 665 #endif /* _NSP32_H */
 666 /* end */