Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * Workbit NinjaSCSI-32Bi/UDE PCI/CardBus SCSI Host Bus Adapter driver
0004  * Basic data header
0005 */
0006 
0007 #ifndef _NSP32_H
0008 #define _NSP32_H
0009 
0010 //#define NSP32_DEBUG 9
0011 
0012 /*
0013  * VENDOR/DEVICE ID
0014  */
0015 #define PCI_VENDOR_ID_IODATA  0x10fc
0016 #define PCI_VENDOR_ID_WORKBIT 0x1145
0017 
0018 #define PCI_DEVICE_ID_NINJASCSI_32BI_CBSC_II   0x0005
0019 #define PCI_DEVICE_ID_NINJASCSI_32BI_KME       0xf007
0020 #define PCI_DEVICE_ID_NINJASCSI_32BI_WBT       0x8007
0021 #define PCI_DEVICE_ID_WORKBIT_STANDARD         0xf010
0022 #define PCI_DEVICE_ID_WORKBIT_DUALEDGE         0xf011
0023 #define PCI_DEVICE_ID_NINJASCSI_32BI_LOGITEC   0xf012
0024 #define PCI_DEVICE_ID_NINJASCSI_32BIB_LOGITEC  0xf013
0025 #define PCI_DEVICE_ID_NINJASCSI_32UDE_MELCO    0xf015
0026 #define PCI_DEVICE_ID_NINJASCSI_32UDE_MELCO_II 0x8009
0027 
0028 /*
0029  * MODEL
0030  */
0031 enum {
0032     MODEL_IODATA        = 0,
0033     MODEL_KME           = 1,
0034     MODEL_WORKBIT       = 2,
0035     MODEL_LOGITEC       = 3,
0036     MODEL_PCI_WORKBIT   = 4,
0037     MODEL_PCI_LOGITEC   = 5,
0038     MODEL_PCI_MELCO     = 6,
0039 };
0040 
0041 static char * nsp32_model[] = {
0042     "I-O DATA CBSC-II CardBus card",
0043     "KME SCSI CardBus card",
0044     "Workbit duo SCSI CardBus card",
0045     "Logitec CardBus card with external ROM",
0046     "Workbit / I-O DATA PCI card",
0047     "Logitec PCI card with external ROM",
0048     "Melco CardBus/PCI card with external ROM",
0049 };
0050 
0051 
0052 /*
0053  * SCSI Generic Definitions
0054  */
0055 #define EXTENDED_SDTR_LEN   0x03
0056 
0057 /* Little Endian */
0058 typedef u32 u32_le;
0059 typedef u16 u16_le;
0060 
0061 /*
0062  * BASIC Definitions
0063  */
0064 #ifndef TRUE
0065 # define TRUE  1
0066 #endif
0067 #ifndef FALSE
0068 # define FALSE 0
0069 #endif
0070 #define ASSERT 1
0071 #define NEGATE 0
0072 
0073 
0074 /*******************/
0075 /* normal register */
0076 /*******************/
0077 /*
0078  * Don't access below register with Double Word:
0079  * +00, +04, +08, +0c, +64, +80, +84, +88, +90, +c4, +c8, +cc, +d0.
0080  */
0081 #define IRQ_CONTROL 0x00    /* BASE+00, W, W */
0082 #define IRQ_STATUS  0x00    /* BASE+00, W, R */
0083 # define IRQSTATUS_LATCHED_MSG      BIT(0)
0084 # define IRQSTATUS_LATCHED_IO       BIT(1)
0085 # define IRQSTATUS_LATCHED_CD       BIT(2)
0086 # define IRQSTATUS_LATCHED_BUS_FREE BIT(3)
0087 # define IRQSTATUS_RESELECT_OCCUER  BIT(4)
0088 # define IRQSTATUS_PHASE_CHANGE_IRQ BIT(5)
0089 # define IRQSTATUS_SCSIRESET_IRQ    BIT(6)
0090 # define IRQSTATUS_TIMER_IRQ        BIT(7)
0091 # define IRQSTATUS_FIFO_SHLD_IRQ    BIT(8)
0092 # define IRQSTATUS_PCI_IRQ      BIT(9)
0093 # define IRQSTATUS_BMCNTERR_IRQ     BIT(10)
0094 # define IRQSTATUS_AUTOSCSI_IRQ     BIT(11)
0095 # define PCI_IRQ_MASK               BIT(12)
0096 # define TIMER_IRQ_MASK             BIT(13)
0097 # define FIFO_IRQ_MASK              BIT(14)
0098 # define SCSI_IRQ_MASK              BIT(15)
0099 # define IRQ_CONTROL_ALL_IRQ_MASK   (PCI_IRQ_MASK   | \
0100                                      TIMER_IRQ_MASK | \
0101                                      FIFO_IRQ_MASK  | \
0102                                      SCSI_IRQ_MASK  )
0103 # define IRQSTATUS_ANY_IRQ          (IRQSTATUS_RESELECT_OCCUER  | \
0104                      IRQSTATUS_PHASE_CHANGE_IRQ | \
0105                      IRQSTATUS_SCSIRESET_IRQ    | \
0106                      IRQSTATUS_TIMER_IRQ    | \
0107                      IRQSTATUS_FIFO_SHLD_IRQ    | \
0108                      IRQSTATUS_PCI_IRQ      | \
0109                      IRQSTATUS_BMCNTERR_IRQ | \
0110                      IRQSTATUS_AUTOSCSI_IRQ )
0111 
0112 #define TRANSFER_CONTROL    0x02    /* BASE+02, W, W */
0113 #define TRANSFER_STATUS     0x02    /* BASE+02, W, R */
0114 # define CB_MMIO_MODE        BIT(0)
0115 # define CB_IO_MODE          BIT(1)
0116 # define BM_TEST             BIT(2)
0117 # define BM_TEST_DIR         BIT(3)
0118 # define DUAL_EDGE_ENABLE    BIT(4)
0119 # define NO_TRANSFER_TO_HOST BIT(5)
0120 # define TRANSFER_GO         BIT(7)
0121 # define BLIEND_MODE         BIT(8)
0122 # define BM_START            BIT(9)
0123 # define ADVANCED_BM_WRITE   BIT(10)
0124 # define BM_SINGLE_MODE      BIT(11)
0125 # define FIFO_TRUE_FULL      BIT(12)
0126 # define FIFO_TRUE_EMPTY     BIT(13)
0127 # define ALL_COUNTER_CLR     BIT(14)
0128 # define FIFOTEST            BIT(15)
0129 
0130 #define INDEX_REG       0x04    /* BASE+04, Byte(R/W), Word(R) */
0131 
0132 #define TIMER_SET       0x06    /* BASE+06, W, R/W */
0133 # define TIMER_CNT_MASK (0xff)
0134 # define TIMER_STOP     BIT(8)
0135 
0136 #define DATA_REG_LOW        0x08    /* BASE+08, LowW, R/W */
0137 #define DATA_REG_HI     0x0a    /* BASE+0a, Hi-W, R/W */
0138 
0139 #define FIFO_REST_CNT       0x0c    /* BASE+0c, W, R/W */
0140 # define FIFO_REST_MASK       0x1ff
0141 # define FIFO_EMPTY_SHLD_FLAG BIT(14)
0142 # define FIFO_FULL_SHLD_FLAG  BIT(15)
0143 
0144 #define SREQ_SMPL_RATE      0x0f    /* BASE+0f, B, R/W */
0145 # define SREQSMPLRATE_RATE0 BIT(0)
0146 # define SREQSMPLRATE_RATE1 BIT(1)
0147 # define SAMPLING_ENABLE    BIT(2)
0148 #  define SMPL_40M (0)                   /* 40MHz:   0-100ns/period */
0149 #  define SMPL_20M (SREQSMPLRATE_RATE0)  /* 20MHz: 100-200ns/period */
0150 #  define SMPL_10M (SREQSMPLRATE_RATE1)  /* 10Mhz: 200-   ns/period */
0151 
0152 #define SCSI_BUS_CONTROL    0x10    /* BASE+10, B, R/W */
0153 # define BUSCTL_SEL         BIT(0)
0154 # define BUSCTL_RST         BIT(1)
0155 # define BUSCTL_DATAOUT_ENB BIT(2)
0156 # define BUSCTL_ATN         BIT(3)
0157 # define BUSCTL_ACK         BIT(4)
0158 # define BUSCTL_BSY         BIT(5)
0159 # define AUTODIRECTION      BIT(6)
0160 # define ACKENB             BIT(7)
0161 
0162 #define CLR_COUNTER     0x12    /* BASE+12, B, W */
0163 # define ACK_COUNTER_CLR       BIT(0)
0164 # define SREQ_COUNTER_CLR      BIT(1)
0165 # define FIFO_HOST_POINTER_CLR BIT(2)
0166 # define FIFO_REST_COUNT_CLR   BIT(3)
0167 # define BM_COUNTER_CLR        BIT(4)
0168 # define SAVED_ACK_CLR         BIT(5)
0169 # define CLRCOUNTER_ALLMASK    (ACK_COUNTER_CLR       | \
0170                                 SREQ_COUNTER_CLR      | \
0171                                 FIFO_HOST_POINTER_CLR | \
0172                                 FIFO_REST_COUNT_CLR   | \
0173                                 BM_COUNTER_CLR        | \
0174                                 SAVED_ACK_CLR         )
0175 
0176 #define SCSI_BUS_MONITOR    0x12    /* BASE+12, B, R */
0177 # define BUSMON_MSG BIT(0)
0178 # define BUSMON_IO  BIT(1)
0179 # define BUSMON_CD  BIT(2)
0180 # define BUSMON_BSY BIT(3)
0181 # define BUSMON_ACK BIT(4)
0182 # define BUSMON_REQ BIT(5)
0183 # define BUSMON_SEL BIT(6)
0184 # define BUSMON_ATN BIT(7)
0185 
0186 #define COMMAND_DATA        0x14    /* BASE+14, B, R/W */
0187 
0188 #define PARITY_CONTROL      0x16    /* BASE+16, B, W */
0189 # define PARITY_CHECK_ENABLE BIT(0)
0190 # define PARITY_ERROR_CLEAR  BIT(1)
0191 #define PARITY_STATUS       0x16    /* BASE+16, B, R */
0192 //# define PARITY_CHECK_ENABLE BIT(0)
0193 # define PARITY_ERROR_NORMAL BIT(1)
0194 # define PARITY_ERROR_LSB    BIT(1)
0195 # define PARITY_ERROR_MSB    BIT(2)
0196 
0197 #define RESELECT_ID     0x18    /* BASE+18, B, R */
0198 
0199 #define COMMAND_CONTROL     0x18    /* BASE+18, W, W */
0200 # define CLEAR_CDB_FIFO_POINTER BIT(0)
0201 # define AUTO_COMMAND_PHASE     BIT(1)
0202 # define AUTOSCSI_START         BIT(2)
0203 # define AUTOSCSI_RESTART       BIT(3)
0204 # define AUTO_PARAMETER         BIT(4)
0205 # define AUTO_ATN               BIT(5)
0206 # define AUTO_MSGIN_00_OR_04    BIT(6)
0207 # define AUTO_MSGIN_02          BIT(7)
0208 # define AUTO_MSGIN_03          BIT(8)
0209 
0210 #define SET_ARBIT       0x1a    /* BASE+1a, B, W */
0211 # define ARBIT_GO    BIT(0)
0212 # define ARBIT_CLEAR BIT(1)
0213 
0214 #define ARBIT_STATUS        0x1a    /* BASE+1a, B, R */
0215 //# define ARBIT_GO             BIT(0)
0216 # define ARBIT_WIN            BIT(1)
0217 # define ARBIT_FAIL           BIT(2)
0218 # define AUTO_PARAMETER_VALID BIT(3)
0219 # define SGT_VALID            BIT(4)
0220 
0221 #define SYNC_REG        0x1c    /* BASE+1c, B, R/W */
0222 
0223 #define ACK_WIDTH       0x1d    /* BASE+1d, B, R/W */
0224 
0225 #define SCSI_DATA_WITH_ACK  0x20    /* BASE+20, B, R/W */
0226 #define SCSI_OUT_LATCH_TARGET_ID 0x22   /* BASE+22, B, W */
0227 #define SCSI_DATA_IN        0x22    /* BASE+22, B, R */
0228 
0229 #define SCAM_CONTROL        0x24    /* BASE+24, B, W */
0230 #define SCAM_STATUS     0x24    /* BASE+24, B, R */
0231 # define SCAM_MSG    BIT(0)
0232 # define SCAM_IO     BIT(1)
0233 # define SCAM_CD     BIT(2)
0234 # define SCAM_BSY    BIT(3)
0235 # define SCAM_SEL    BIT(4)
0236 # define SCAM_XFEROK BIT(5)
0237 
0238 #define SCAM_DATA       0x26    /* BASE+26, B, R/W */
0239 # define SD0    BIT(0)
0240 # define SD1    BIT(1)
0241 # define SD2    BIT(2)
0242 # define SD3    BIT(3)
0243 # define SD4    BIT(4)
0244 # define SD5    BIT(5)
0245 # define SD6    BIT(6)
0246 # define SD7    BIT(7)
0247 
0248 #define SACK_CNT        0x28    /* BASE+28, DW, R/W */
0249 #define SREQ_CNT        0x2c    /* BASE+2c, DW, R/W */
0250 
0251 #define FIFO_DATA_LOW       0x30    /* BASE+30, B/W/DW, R/W */
0252 #define FIFO_DATA_HIGH      0x32    /* BASE+32, B/W, R/W */
0253 #define BM_START_ADR        0x34    /* BASE+34, DW, R/W */
0254 
0255 #define BM_CNT          0x38    /* BASE+38, DW, R/W */
0256 # define BM_COUNT_MASK 0x0001ffffUL
0257 # define SGTEND        BIT(31)      /* Last SGT marker */
0258 
0259 #define SGT_ADR         0x3c    /* BASE+3c, DW, R/W */
0260 #define WAIT_REG        0x40    /* Bi only */
0261 
0262 #define SCSI_EXECUTE_PHASE  0x40    /* BASE+40, W, R */
0263 # define COMMAND_PHASE     BIT(0)
0264 # define DATA_IN_PHASE     BIT(1)
0265 # define DATA_OUT_PHASE    BIT(2)
0266 # define MSGOUT_PHASE      BIT(3)
0267 # define STATUS_PHASE      BIT(4)
0268 # define ILLEGAL_PHASE     BIT(5)
0269 # define BUS_FREE_OCCUER   BIT(6)
0270 # define MSG_IN_OCCUER     BIT(7)
0271 # define MSG_OUT_OCCUER    BIT(8)
0272 # define SELECTION_TIMEOUT BIT(9)
0273 # define MSGIN_00_VALID    BIT(10)
0274 # define MSGIN_02_VALID    BIT(11)
0275 # define MSGIN_03_VALID    BIT(12)
0276 # define MSGIN_04_VALID    BIT(13)
0277 # define AUTOSCSI_BUSY     BIT(15)
0278 
0279 #define SCSI_CSB_IN     0x42    /* BASE+42, B, R */
0280 
0281 #define SCSI_MSG_OUT        0x44    /* BASE+44, DW, R/W */
0282 # define MSGOUT_COUNT_MASK (BIT(0)|BIT(1))
0283 # define MV_VALID       BIT(7)
0284 
0285 #define SEL_TIME_OUT        0x48    /* BASE+48, W, R/W */
0286 #define SAVED_SACK_CNT      0x4c    /* BASE+4c, DW, R */
0287 
0288 #define HTOSDATADELAY       0x50    /* BASE+50, B, R/W */
0289 #define STOHDATADELAY       0x54    /* BASE+54, B, R/W */
0290 #define ACKSUMCHECKRD       0x58    /* BASE+58, W, R */
0291 #define REQSUMCHECKRD       0x5c    /* BASE+5c, W, R */
0292 
0293 
0294 /********************/
0295 /* indexed register */
0296 /********************/
0297 
0298 #define CLOCK_DIV       0x00    /* BASE+08, IDX+00, B, R/W */
0299 # define CLOCK_2  BIT(0)    /* MCLK/2 */
0300 # define CLOCK_4  BIT(1)    /* MCLK/4 */
0301 # define PCICLK   BIT(7)    /* PCICLK (33MHz) */
0302 
0303 #define TERM_PWR_CONTROL    0x01    /* BASE+08, IDX+01, B, R/W */
0304 # define BPWR  BIT(0)
0305 # define SENSE BIT(1)   /* Read Only */
0306 
0307 #define EXT_PORT_DDR        0x02    /* BASE+08, IDX+02, B, R/W */
0308 #define EXT_PORT        0x03    /* BASE+08, IDX+03, B, R/W */
0309 # define LED_ON  (0)
0310 # define LED_OFF BIT(0)
0311 
0312 #define IRQ_SELECT      0x04    /* BASE+08, IDX+04, W, R/W */
0313 # define IRQSELECT_RESELECT_IRQ      BIT(0)
0314 # define IRQSELECT_PHASE_CHANGE_IRQ  BIT(1)
0315 # define IRQSELECT_SCSIRESET_IRQ     BIT(2)
0316 # define IRQSELECT_TIMER_IRQ         BIT(3)
0317 # define IRQSELECT_FIFO_SHLD_IRQ     BIT(4)
0318 # define IRQSELECT_TARGET_ABORT_IRQ  BIT(5)
0319 # define IRQSELECT_MASTER_ABORT_IRQ  BIT(6)
0320 # define IRQSELECT_SERR_IRQ          BIT(7)
0321 # define IRQSELECT_PERR_IRQ          BIT(8)
0322 # define IRQSELECT_BMCNTERR_IRQ      BIT(9)
0323 # define IRQSELECT_AUTO_SCSI_SEQ_IRQ BIT(10)
0324 
0325 #define OLD_SCSI_PHASE      0x05    /* BASE+08, IDX+05, B, R */
0326 # define OLD_MSG  BIT(0)
0327 # define OLD_IO   BIT(1)
0328 # define OLD_CD   BIT(2)
0329 # define OLD_BUSY BIT(3)
0330 
0331 #define FIFO_FULL_SHLD_COUNT    0x06    /* BASE+08, IDX+06, B, R/W */
0332 #define FIFO_EMPTY_SHLD_COUNT   0x07    /* BASE+08, IDX+07, B, R/W */
0333 
0334 #define EXP_ROM_CONTROL     0x08    /* BASE+08, IDX+08, B, R/W */ /* external ROM control */
0335 # define ROM_WRITE_ENB BIT(0)
0336 # define IO_ACCESS_ENB BIT(1)
0337 # define ROM_ADR_CLEAR BIT(2)
0338 
0339 #define EXP_ROM_ADR     0x09    /* BASE+08, IDX+09, W, R/W */
0340 
0341 #define EXP_ROM_DATA        0x0a    /* BASE+08, IDX+0a, B, R/W */
0342 
0343 #define CHIP_MODE       0x0b    /* BASE+08, IDX+0b, B, R   */ /* NinjaSCSI-32Bi only */
0344 # define OEM0 BIT(1)  /* OEM select */ /* 00=I-O DATA, 01=KME, 10=Workbit, 11=Ext ROM */
0345 # define OEM1 BIT(2)  /* OEM select */
0346 # define OPTB BIT(3)  /* KME mode select */
0347 # define OPTC BIT(4)  /* KME mode select */
0348 # define OPTD BIT(5)  /* KME mode select */
0349 # define OPTE BIT(6)  /* KME mode select */
0350 # define OPTF BIT(7)  /* Power management */
0351 
0352 #define MISC_WR         0x0c    /* BASE+08, IDX+0c, W, R/W */
0353 #define MISC_RD         0x0c
0354 # define SCSI_DIRECTION_DETECTOR_SELECT BIT(0)
0355 # define SCSI2_HOST_DIRECTION_VALID BIT(1)  /* Read only */
0356 # define HOST2_SCSI_DIRECTION_VALID BIT(2)  /* Read only */
0357 # define DELAYED_BMSTART                BIT(3)
0358 # define MASTER_TERMINATION_SELECT      BIT(4)
0359 # define BMREQ_NEGATE_TIMING_SEL        BIT(5)
0360 # define AUTOSEL_TIMING_SEL             BIT(6)
0361 # define MISC_MABORT_MASK       BIT(7)
0362 # define BMSTOP_CHANGE2_NONDATA_PHASE   BIT(8)
0363 
0364 #define BM_CYCLE        0x0d    /* BASE+08, IDX+0d, B, R/W */
0365 # define BM_CYCLE0       BIT(0)
0366 # define BM_CYCLE1       BIT(1)
0367 # define BM_FRAME_ASSERT_TIMING  BIT(2)
0368 # define BM_IRDY_ASSERT_TIMING   BIT(3)
0369 # define BM_SINGLE_BUS_MASTER    BIT(4)
0370 # define MEMRD_CMD0              BIT(5)
0371 # define SGT_AUTO_PARA_MEMED_CMD BIT(6)
0372 # define MEMRD_CMD1              BIT(7)
0373 
0374 
0375 #define SREQ_EDGH       0x0e    /* BASE+08, IDX+0e, B, W */
0376 # define SREQ_EDGH_SELECT BIT(0)
0377 
0378 #define UP_CNT          0x0f    /* BASE+08, IDX+0f, B, W */
0379 # define REQCNT_UP  BIT(0)
0380 # define ACKCNT_UP  BIT(1)
0381 # define BMADR_UP   BIT(4)
0382 # define BMCNT_UP   BIT(5)
0383 # define SGT_CNT_UP BIT(7)
0384 
0385 #define CFG_CMD_STR     0x10    /* BASE+08, IDX+10, W, R */
0386 #define CFG_LATE_CACHE      0x11    /* BASE+08, IDX+11, W, R/W */
0387 #define CFG_BASE_ADR_1      0x12    /* BASE+08, IDX+12, W, R */
0388 #define CFG_BASE_ADR_2      0x13    /* BASE+08, IDX+13, W, R */
0389 #define CFG_INLINE      0x14    /* BASE+08, IDX+14, W, R */
0390 
0391 #define SERIAL_ROM_CTL      0x15    /* BASE+08, IDX+15, B, R */
0392 # define SCL BIT(0)
0393 # define ENA BIT(1)
0394 # define SDA BIT(2)
0395 
0396 #define FIFO_HST_POINTER    0x16    /* BASE+08, IDX+16, B, R/W */
0397 #define SREQ_DELAY      0x17    /* BASE+08, IDX+17, B, R/W */
0398 #define SACK_DELAY      0x18    /* BASE+08, IDX+18, B, R/W */
0399 #define SREQ_NOISE_CANCEL   0x19    /* BASE+08, IDX+19, B, R/W */
0400 #define SDP_NOISE_CANCEL    0x1a    /* BASE+08, IDX+1a, B, R/W */
0401 #define DELAY_TEST      0x1b    /* BASE+08, IDX+1b, B, R/W */
0402 #define SD0_NOISE_CANCEL    0x20    /* BASE+08, IDX+20, B, R/W */
0403 #define SD1_NOISE_CANCEL    0x21    /* BASE+08, IDX+21, B, R/W */
0404 #define SD2_NOISE_CANCEL    0x22    /* BASE+08, IDX+22, B, R/W */
0405 #define SD3_NOISE_CANCEL    0x23    /* BASE+08, IDX+23, B, R/W */
0406 #define SD4_NOISE_CANCEL    0x24    /* BASE+08, IDX+24, B, R/W */
0407 #define SD5_NOISE_CANCEL    0x25    /* BASE+08, IDX+25, B, R/W */
0408 #define SD6_NOISE_CANCEL    0x26    /* BASE+08, IDX+26, B, R/W */
0409 #define SD7_NOISE_CANCEL    0x27    /* BASE+08, IDX+27, B, R/W */
0410 
0411 
0412 /*
0413  * Useful Bus Monitor status combinations.
0414  */
0415 #define BUSMON_BUS_FREE    0
0416 #define BUSMON_COMMAND     ( BUSMON_BSY |                          BUSMON_CD | BUSMON_REQ )
0417 #define BUSMON_MESSAGE_IN  ( BUSMON_BSY | BUSMON_MSG | BUSMON_IO | BUSMON_CD | BUSMON_REQ )
0418 #define BUSMON_MESSAGE_OUT ( BUSMON_BSY | BUSMON_MSG |             BUSMON_CD | BUSMON_REQ )
0419 #define BUSMON_DATA_IN     ( BUSMON_BSY |              BUSMON_IO |             BUSMON_REQ )
0420 #define BUSMON_DATA_OUT    ( BUSMON_BSY |                                      BUSMON_REQ )
0421 #define BUSMON_STATUS      ( BUSMON_BSY |              BUSMON_IO | BUSMON_CD | BUSMON_REQ )
0422 #define BUSMON_RESELECT    (                           BUSMON_IO                          | BUSMON_SEL)
0423 #define BUSMON_PHASE_MASK  (              BUSMON_MSG | BUSMON_IO | BUSMON_CD              | BUSMON_SEL)
0424 
0425 #define BUSPHASE_COMMAND     ( BUSMON_COMMAND     & BUSMON_PHASE_MASK )
0426 #define BUSPHASE_MESSAGE_IN  ( BUSMON_MESSAGE_IN  & BUSMON_PHASE_MASK )
0427 #define BUSPHASE_MESSAGE_OUT ( BUSMON_MESSAGE_OUT & BUSMON_PHASE_MASK )
0428 #define BUSPHASE_DATA_IN     ( BUSMON_DATA_IN     & BUSMON_PHASE_MASK )
0429 #define BUSPHASE_DATA_OUT    ( BUSMON_DATA_OUT    & BUSMON_PHASE_MASK )
0430 #define BUSPHASE_STATUS      ( BUSMON_STATUS      & BUSMON_PHASE_MASK )
0431 #define BUSPHASE_SELECT      ( BUSMON_SEL | BUSMON_IO )
0432 
0433 
0434 /************************************************************************
0435  * structure for DMA/Scatter Gather list
0436  */
0437 #define NSP32_SG_SIZE       SG_ALL
0438 
0439 typedef struct _nsp32_sgtable {
0440     /* values must be little endian */
0441     u32_le addr; /* transfer address */
0442     u32_le len;  /* transfer length. BIT(31) is for SGT_END mark */
0443 } __attribute__ ((packed)) nsp32_sgtable;
0444 
0445 typedef struct _nsp32_sglun {
0446     nsp32_sgtable sgt[NSP32_SG_SIZE+1]; /* SG table */
0447 } __attribute__ ((packed)) nsp32_sglun;
0448 #define NSP32_SG_TABLE_SIZE (sizeof(nsp32_sgtable) * NSP32_SG_SIZE * MAX_TARGET * MAX_LUN)
0449 
0450 /* Auto parameter mode memory map.   */
0451 /* All values must be little endian. */
0452 typedef struct _nsp32_autoparam {
0453     u8     cdb[4 * 0x10];    /* SCSI Command                      */
0454     u32_le msgout;           /* outgoing messages                 */
0455     u8     syncreg;          /* sync register value               */
0456     u8     ackwidth;         /* ack width register value          */
0457     u8     target_id;        /* target/host device id             */
0458     u8     sample_reg;       /* hazard killer sampling rate       */
0459     u16_le command_control;  /* command control register          */
0460     u16_le transfer_control; /* transfer control register         */
0461     u32_le sgt_pointer;      /* SG table physical address for DMA */
0462     u32_le dummy[2];
0463 } __attribute__ ((packed)) nsp32_autoparam;  /* must be packed struct */
0464 
0465 /*
0466  * host data structure
0467  */
0468 /* message in/out buffer */
0469 #define MSGOUTBUF_MAX       20
0470 #define MSGINBUF_MAX        20
0471 
0472 /* flag for trans_method */
0473 #define NSP32_TRANSFER_BUSMASTER    BIT(0)
0474 #define NSP32_TRANSFER_MMIO     BIT(1)  /* Not supported yet */
0475 #define NSP32_TRANSFER_PIO      BIT(2)  /* Not supported yet */
0476 
0477 
0478 /*
0479  * structure for connected LUN dynamic data
0480  *
0481  * Note: Currently tagged queuing is disabled, each nsp32_lunt holds
0482  *       one SCSI command and one state.
0483  */
0484 #define DISCPRIV_OK     BIT(0)      /* DISCPRIV Enable mode */
0485 #define MSGIN03         BIT(1)      /* Auto Msg In 03 Flag  */
0486 
0487 typedef struct _nsp32_lunt {
0488     struct scsi_cmnd    *SCpnt;     /* Current Handling struct scsi_cmnd */
0489     unsigned long    save_datp;  /* Save Data Pointer - saved position from initial address */
0490     int      msgin03;   /* auto msg in 03 flag     */
0491     unsigned int     sg_num;    /* Total number of SG entries */
0492     int      cur_entry; /* Current SG entry number */
0493     nsp32_sglun     *sglun;     /* sg table per lun        */
0494     dma_addr_t       sglun_paddr;   /* sglun physical address  */
0495 } nsp32_lunt;
0496 
0497 
0498 /*
0499  * SCSI TARGET/LUN definition
0500  */
0501 #define NSP32_HOST_SCSIID    7  /* SCSI initiator is every time defined as 7 */
0502 #define MAX_TARGET       8
0503 #define MAX_LUN          8  /* XXX: In SPI3, max number of LUN is 64. */
0504 
0505 
0506 typedef struct _nsp32_sync_table {
0507     unsigned char   period_num; /* period number                  */
0508     unsigned char   ackwidth;   /* ack width designated by period */
0509     unsigned char   start_period;   /* search range - start period    */
0510     unsigned char   end_period; /* search range - end period      */
0511     unsigned char   sample_rate;    /* hazard killer parameter        */
0512 } nsp32_sync_table;
0513 
0514 
0515 /*
0516  * structure for target device static data
0517  */
0518 /* flag for nsp32_target.sync_flag */
0519 #define SDTR_INITIATOR    BIT(0)    /* sending SDTR from initiator        */
0520 #define SDTR_TARGET   BIT(1)    /* sending SDTR from target           */
0521 #define SDTR_DONE     BIT(2)    /* exchanging SDTR has been processed */
0522 
0523 /* syncronous period value for nsp32_target.config_max */
0524 #define FAST5M          0x32
0525 #define FAST10M         0x19
0526 #define ULTRA20M        0x0c
0527 
0528 /* flag for nsp32_target.{sync_offset}, period */
0529 #define ASYNC_OFFSET        0   /* asynchronous transfer           */
0530 #define SYNC_OFFSET     0xf /* synchronous transfer max offset */
0531 
0532 /* syncreg:
0533   bit:07 06 05 04 03 02 01 00
0534       ---PERIOD-- ---OFFSET--   */
0535 #define TO_SYNCREG(period, offset) (((period) & 0x0f) << 4 | ((offset) & 0x0f))
0536 
0537 struct nsp32_cmd_priv {
0538     enum sam_status status;
0539 };
0540 
0541 static inline struct nsp32_cmd_priv *nsp32_priv(struct scsi_cmnd *cmd)
0542 {
0543     return scsi_cmd_priv(cmd);
0544 }
0545 
0546 typedef struct _nsp32_target {
0547     unsigned char   syncreg;    /* value for SYNCREG   */
0548     unsigned char   ackwidth;   /* value for ACKWIDTH  */
0549     unsigned char   period;         /* sync period (0-255) */
0550     unsigned char   offset;     /* sync offset (0-15)  */
0551     int     sync_flag;  /* SDTR_*, 0           */
0552     int     limit_entry;    /* max speed limit entry designated
0553                        by EEPROM configuration */
0554     unsigned char   sample_reg;     /* SREQ hazard killer register */
0555 } nsp32_target;
0556 
0557 typedef struct _nsp32_hw_data {
0558     int           IrqNumber;
0559     int           BaseAddress;
0560     int           NumAddress;
0561     void __iomem *MmioAddress;
0562 #define NSP32_MMIO_OFFSET 0x0800
0563     unsigned long MmioLength;
0564 
0565     struct scsi_cmnd *CurrentSC;
0566 
0567     struct pci_dev             *Pci;
0568     const struct pci_device_id *pci_devid;
0569     struct Scsi_Host           *Host;
0570     spinlock_t                  Lock;
0571 
0572     char info_str[100];
0573 
0574     /* allocated memory region */
0575     nsp32_sglun      *sg_list;  /* sglist virtuxal address         */
0576     dma_addr_t    sg_paddr;     /* physical address of hw_sg_table */
0577     nsp32_autoparam  *autoparam;    /* auto parameter transfer region  */
0578     dma_addr_t    auto_paddr;   /* physical address of autoparam   */
0579     int           cur_entry;    /* current sgt entry               */
0580 
0581     /* target/LUN */
0582     nsp32_lunt       *cur_lunt; /* Current connected LUN table */
0583     nsp32_lunt        lunt[MAX_TARGET][MAX_LUN];  /* All LUN table */
0584 
0585     nsp32_target     *cur_target;   /* Current connected SCSI ID    */
0586     nsp32_target      target[MAX_TARGET];        /* SCSI ID */
0587     int       cur_id;   /* Current connected target ID  */
0588     int       cur_lun;  /* Current connected target LUN */
0589 
0590     /* behavior setting parameters */
0591     int       trans_method; /* transfer method flag            */
0592     int       resettime;    /* Reset time                      */
0593     int           clock;        /* clock dividing flag             */
0594     nsp32_sync_table *synct;    /* sync_table determined by clock  */
0595     int       syncnum;  /* the max number of synct element */
0596 
0597     /* message buffer */
0598     unsigned char msgoutbuf[MSGOUTBUF_MAX]; /* msgout buffer    */
0599     char          msgout_len;       /* msgoutbuf length */
0600     unsigned char msginbuf [MSGINBUF_MAX];  /* megin buffer     */
0601     char          msgin_len;        /* msginbuf length  */
0602 
0603 } nsp32_hw_data;
0604 
0605 /*
0606  * TIME definition
0607  */
0608 #define RESET_HOLD_TIME     10000   /* reset time in us (SCSI-2 says the
0609                        minimum is 25us) */
0610 #define SEL_TIMEOUT_TIME    10000   /* 250ms defined in SCSI specification
0611                        (25.6us/1unit) */
0612 #define ARBIT_TIMEOUT_TIME  100 /* 100us */
0613 #define REQSACK_TIMEOUT_TIME    10000   /* max wait time for REQ/SACK assertion
0614                        or negation, 10000us == 10ms */
0615 
0616 #endif /* _NSP32_H */
0617 /* end */