1 /* qlogicpti.h: Performance Technologies QlogicISP sbus card defines.
 
   3  * Copyright (C) 1996 David S. Miller (davem@caipfs.rutgers.edu)
 
   9 /* Qlogic/SBUS controller registers. */
 
  10 #define SBUS_CFG1       0x006UL
 
  11 #define SBUS_CTRL       0x008UL
 
  12 #define SBUS_STAT       0x00aUL
 
  13 #define SBUS_SEMAPHORE  0x00cUL
 
  14 #define CMD_DMA_CTRL    0x022UL
 
  15 #define DATA_DMA_CTRL   0x042UL
 
  22 #define CPU_CMD         0x214UL
 
  23 #define CPU_ORIDE       0x224UL
 
  24 #define CPU_PCTRL       0x272UL
 
  25 #define CPU_PDIFF       0x276UL
 
  26 #define RISC_PSR        0x420UL
 
  27 #define RISC_MTREG      0x42EUL
 
  28 #define HCCTRL          0x440UL
 
  30 /* SCSI parameters for this driver. */
 
  31 #define MAX_TARGETS     16
 
  34 /* With the qlogic interface, every queue slot can hold a SCSI
 
  35  * command with up to 4 scatter/gather entries.  If we need more
 
  36  * than 4 entries, continuation entries can be used that hold
 
  37  * another 7 entries each.  Unlike for other drivers, this means
 
  38  * that the maximum number of scatter/gather entries we can
 
  39  * support at any given time is a function of the number of queue
 
  40  * slots available.  That is, host->can_queue and host->sg_tablesize
 
  41  * are dynamic and _not_ independent.  This all works fine because
 
  42  * requests are queued serially and the scatter/gather limit is
 
  43  * determined for each queue request anew.
 
  45 #define QLOGICPTI_REQ_QUEUE_LEN 255     /* must be power of two - 1 */
 
  46 #define QLOGICPTI_MAX_SG(ql)    (4 + ((ql) > 0) ? 7*((ql) - 1) : 0)
 
  48 /* mailbox command complete status codes */
 
  49 #define MBOX_COMMAND_COMPLETE           0x4000
 
  50 #define INVALID_COMMAND                 0x4001
 
  51 #define HOST_INTERFACE_ERROR            0x4002
 
  52 #define TEST_FAILED                     0x4003
 
  53 #define COMMAND_ERROR                   0x4005
 
  54 #define COMMAND_PARAM_ERROR             0x4006
 
  56 /* async event status codes */
 
  57 #define ASYNC_SCSI_BUS_RESET            0x8001
 
  58 #define SYSTEM_ERROR                    0x8002
 
  59 #define REQUEST_TRANSFER_ERROR          0x8003
 
  60 #define RESPONSE_TRANSFER_ERROR         0x8004
 
  61 #define REQUEST_QUEUE_WAKEUP            0x8005
 
  62 #define EXECUTION_TIMEOUT_RESET         0x8006
 
  64 /* Am I fucking pedantic or what? */
 
  71 #else /* __LITTLE_ENDIAN */
 
  79 /* entry header type commands */
 
  80 #define ENTRY_COMMAND           1
 
  81 #define ENTRY_CONTINUATION      2
 
  82 #define ENTRY_STATUS            3
 
  83 #define ENTRY_MARKER            4
 
  84 #define ENTRY_EXTENDED_COMMAND  5
 
  86 /* entry header flag definitions */
 
  87 #define EFLAG_CONTINUATION      1
 
  89 #define EFLAG_BAD_HEADER        4
 
  90 #define EFLAG_BAD_PAYLOAD       8
 
  97 struct Command_Entry {
 
  98         struct Entry_header     hdr;
 
 103 #else /* __LITTLE_ENDIAN */
 
 113         struct dataseg          dataseg[4];
 
 116 /* command entry control flag definitions */
 
 117 #define CFLAG_NODISC            0x01
 
 118 #define CFLAG_HEAD_TAG          0x02
 
 119 #define CFLAG_ORDERED_TAG       0x04
 
 120 #define CFLAG_SIMPLE_TAG        0x08
 
 121 #define CFLAG_TAR_RTN           0x10
 
 122 #define CFLAG_READ              0x20
 
 123 #define CFLAG_WRITE             0x40
 
 125 struct Ext_Command_Entry {
 
 126         struct Entry_header     hdr;
 
 131 #else /* __LITTLE_ENDIAN */
 
 143 struct Continuation_Entry {
 
 144         struct Entry_header     hdr;
 
 146         struct dataseg          dataseg[7];
 
 149 struct Marker_Entry {
 
 150         struct Entry_header     hdr;
 
 155 #else /* __LITTLE_ENDIAN */
 
 162 #else /* __LITTLE_ENDIAN */
 
 169 /* marker entry modifier definitions */
 
 170 #define SYNC_DEVICE     0
 
 171 #define SYNC_TARGET     1
 
 174 struct Status_Entry {
 
 175         struct Entry_header     hdr;
 
 178         u16                     completion_status;
 
 185         u8                      req_sense_data[32];
 
 188 /* status entry completion status definitions */
 
 189 #define CS_COMPLETE                     0x0000
 
 190 #define CS_INCOMPLETE                   0x0001
 
 191 #define CS_DMA_ERROR                    0x0002
 
 192 #define CS_TRANSPORT_ERROR              0x0003
 
 193 #define CS_RESET_OCCURRED               0x0004
 
 194 #define CS_ABORTED                      0x0005
 
 195 #define CS_TIMEOUT                      0x0006
 
 196 #define CS_DATA_OVERRUN                 0x0007
 
 197 #define CS_COMMAND_OVERRUN              0x0008
 
 198 #define CS_STATUS_OVERRUN               0x0009
 
 199 #define CS_BAD_MESSAGE                  0x000a
 
 200 #define CS_NO_MESSAGE_OUT               0x000b
 
 201 #define CS_EXT_ID_FAILED                0x000c
 
 202 #define CS_IDE_MSG_FAILED               0x000d
 
 203 #define CS_ABORT_MSG_FAILED             0x000e
 
 204 #define CS_REJECT_MSG_FAILED            0x000f
 
 205 #define CS_NOP_MSG_FAILED               0x0010
 
 206 #define CS_PARITY_ERROR_MSG_FAILED      0x0011
 
 207 #define CS_DEVICE_RESET_MSG_FAILED      0x0012
 
 208 #define CS_ID_MSG_FAILED                0x0013
 
 209 #define CS_UNEXP_BUS_FREE               0x0014
 
 210 #define CS_DATA_UNDERRUN                0x0015
 
 211 #define CS_BUS_RESET                    0x001c
 
 213 /* status entry state flag definitions */
 
 214 #define SF_GOT_BUS                      0x0100
 
 215 #define SF_GOT_TARGET                   0x0200
 
 216 #define SF_SENT_CDB                     0x0400
 
 217 #define SF_TRANSFERRED_DATA             0x0800
 
 218 #define SF_GOT_STATUS                   0x1000
 
 219 #define SF_GOT_SENSE                    0x2000
 
 221 /* status entry status flag definitions */
 
 222 #define STF_DISCONNECT                  0x0001
 
 223 #define STF_SYNCHRONOUS                 0x0002
 
 224 #define STF_PARITY_ERROR                0x0004
 
 225 #define STF_BUS_RESET                   0x0008
 
 226 #define STF_DEVICE_RESET                0x0010
 
 227 #define STF_ABORTED                     0x0020
 
 228 #define STF_TIMEOUT                     0x0040
 
 229 #define STF_NEGOTIATION                 0x0080
 
 231 /* mailbox commands */
 
 232 #define MBOX_NO_OP                      0x0000
 
 233 #define MBOX_LOAD_RAM                   0x0001
 
 234 #define MBOX_EXEC_FIRMWARE              0x0002
 
 235 #define MBOX_DUMP_RAM                   0x0003
 
 236 #define MBOX_WRITE_RAM_WORD             0x0004
 
 237 #define MBOX_READ_RAM_WORD              0x0005
 
 238 #define MBOX_MAILBOX_REG_TEST           0x0006
 
 239 #define MBOX_VERIFY_CHECKSUM            0x0007
 
 240 #define MBOX_ABOUT_FIRMWARE             0x0008
 
 241 #define MBOX_CHECK_FIRMWARE             0x000e
 
 242 #define MBOX_INIT_REQ_QUEUE             0x0010
 
 243 #define MBOX_INIT_RES_QUEUE             0x0011
 
 244 #define MBOX_EXECUTE_IOCB               0x0012
 
 245 #define MBOX_WAKE_UP                    0x0013
 
 246 #define MBOX_STOP_FIRMWARE              0x0014
 
 247 #define MBOX_ABORT                      0x0015
 
 248 #define MBOX_ABORT_DEVICE               0x0016
 
 249 #define MBOX_ABORT_TARGET               0x0017
 
 250 #define MBOX_BUS_RESET                  0x0018
 
 251 #define MBOX_STOP_QUEUE                 0x0019
 
 252 #define MBOX_START_QUEUE                0x001a
 
 253 #define MBOX_SINGLE_STEP_QUEUE          0x001b
 
 254 #define MBOX_ABORT_QUEUE                0x001c
 
 255 #define MBOX_GET_DEV_QUEUE_STATUS       0x001d
 
 256 #define MBOX_GET_FIRMWARE_STATUS        0x001f
 
 257 #define MBOX_GET_INIT_SCSI_ID           0x0020
 
 258 #define MBOX_GET_SELECT_TIMEOUT         0x0021
 
 259 #define MBOX_GET_RETRY_COUNT            0x0022
 
 260 #define MBOX_GET_TAG_AGE_LIMIT          0x0023
 
 261 #define MBOX_GET_CLOCK_RATE             0x0024
 
 262 #define MBOX_GET_ACT_NEG_STATE          0x0025
 
 263 #define MBOX_GET_ASYNC_DATA_SETUP_TIME  0x0026
 
 264 #define MBOX_GET_SBUS_PARAMS            0x0027
 
 265 #define MBOX_GET_TARGET_PARAMS          0x0028
 
 266 #define MBOX_GET_DEV_QUEUE_PARAMS       0x0029
 
 267 #define MBOX_SET_INIT_SCSI_ID           0x0030
 
 268 #define MBOX_SET_SELECT_TIMEOUT         0x0031
 
 269 #define MBOX_SET_RETRY_COUNT            0x0032
 
 270 #define MBOX_SET_TAG_AGE_LIMIT          0x0033
 
 271 #define MBOX_SET_CLOCK_RATE             0x0034
 
 272 #define MBOX_SET_ACTIVE_NEG_STATE       0x0035
 
 273 #define MBOX_SET_ASYNC_DATA_SETUP_TIME  0x0036
 
 274 #define MBOX_SET_SBUS_CONTROL_PARAMS    0x0037
 
 275 #define MBOX_SET_TARGET_PARAMS          0x0038
 
 276 #define MBOX_SET_DEV_QUEUE_PARAMS       0x0039
 
 279         u_short         initiator_scsi_id;
 
 280         u_short         bus_reset_delay;
 
 283         u_short         async_data_setup_time;
 
 284         u_short         req_ack_active_negation;
 
 285         u_short         data_line_active_negation;
 
 286         u_short         data_dma_burst_enable;
 
 287         u_short         command_dma_burst_enable;
 
 289         u_short         selection_timeout;
 
 290         u_short         max_queue_depth;
 
 298  *  7   Disconnect Privilege
 
 300  *  5   Wide Data Transfers
 
 301  *  4   Synchronous Data Transfers
 
 303  *  2   Automatic Request Sense
 
 304  *  1   Stop Queue on Check Condition
 
 305  *  0   Renegotiate on Error
 
 309         u_short         device_flags;
 
 310         u_short         execution_throttle;
 
 311         u_short         synchronous_period;
 
 312         u_short         synchronous_offset;
 
 313         u_short         device_enable;
 
 314         u_short         reserved; /* pad */
 
 318  * The result queue can be quite a bit smaller since continuation entries
 
 319  * do not show up there:
 
 321 #define RES_QUEUE_LEN           255     /* Must be power of two - 1 */
 
 322 #define QUEUE_ENTRY_LEN         64
 
 324 #define NEXT_REQ_PTR(wheee)   (((wheee) + 1) & QLOGICPTI_REQ_QUEUE_LEN)
 
 325 #define NEXT_RES_PTR(wheee)   (((wheee) + 1) & RES_QUEUE_LEN)
 
 326 #define PREV_REQ_PTR(wheee)   (((wheee) - 1) & QLOGICPTI_REQ_QUEUE_LEN)
 
 327 #define PREV_RES_PTR(wheee)   (((wheee) - 1) & RES_QUEUE_LEN)
 
 329 struct pti_queue_entry {
 
 330         char __opaque[QUEUE_ENTRY_LEN];
 
 335 /* Software state for the driver. */
 
 337         /* These are the hot elements in the cache, so they come first. */
 
 338         void __iomem             *qregs;                /* Adapter registers          */
 
 339         struct pti_queue_entry   *res_cpu;              /* Ptr to RESPONSE bufs (CPU) */
 
 340         struct pti_queue_entry   *req_cpu;              /* Ptr to REQUEST bufs (CPU)  */
 
 342         u_int                     req_in_ptr;           /* index of next request slot */
 
 343         u_int                     res_out_ptr;          /* index of next result slot  */
 
 344         long                      send_marker;          /* must we send a marker?     */
 
 345         struct of_device         *op;
 
 348         int                       cmd_count[MAX_TARGETS];
 
 349         unsigned long             tag_ages[MAX_TARGETS];
 
 351         /* The cmd->handler is only 32-bits, so that things work even on monster
 
 352          * Ex000 sparc64 machines with >4GB of ram we just keep track of the
 
 353          * scsi command pointers here.  This is essentially what Matt Jacob does. -DaveM
 
 355         struct scsi_cmnd         *cmd_slots[QLOGICPTI_REQ_QUEUE_LEN + 1];
 
 357         /* The rest of the elements are unimportant for performance. */
 
 358         struct qlogicpti         *next;
 
 359         __u32                     res_dvma;             /* Ptr to RESPONSE bufs (DVMA)*/
 
 360         __u32                     req_dvma;             /* Ptr to REQUEST bufs (DVMA) */
 
 361         u_char                    fware_majrev, fware_minrev, fware_micrev;
 
 362         struct Scsi_Host         *qhost;
 
 368         char                      differential, ultra, clock;
 
 369         unsigned char             bursts;
 
 370         struct  host_param        host_param;
 
 371         struct  dev_param         dev_param[MAX_TARGETS];
 
 374 #define SREG_TPOWER               0x80   /* State of termpwr           */
 
 375 #define SREG_FUSE                 0x40   /* State of on board fuse     */
 
 376 #define SREG_PDISAB               0x20   /* Disable state for power on */
 
 377 #define SREG_DSENSE               0x10   /* Sense for differential     */
 
 378 #define SREG_IMASK                0x0c   /* Interrupt level            */
 
 379 #define SREG_SPMASK               0x03   /* Mask for switch pack       */
 
 380         unsigned char             swsreg;
 
 382                 gotirq  :       1,      /* this instance got an irq */
 
 383                 is_pti  :       1;      /* Non-zero if this is a PTI board. */
 
 386 /* How to twiddle them bits... */
 
 388 /* SBUS config register one. */
 
 389 #define SBUS_CFG1_EPAR          0x0100      /* Enable parity checking           */
 
 390 #define SBUS_CFG1_FMASK         0x00f0      /* Forth code cycle mask            */
 
 391 #define SBUS_CFG1_BENAB         0x0004      /* Burst dvma enable                */
 
 392 #define SBUS_CFG1_B64           0x0003      /* Enable 64byte bursts             */
 
 393 #define SBUS_CFG1_B32           0x0002      /* Enable 32byte bursts             */
 
 394 #define SBUS_CFG1_B16           0x0001      /* Enable 16byte bursts             */
 
 395 #define SBUS_CFG1_B8            0x0008      /* Enable 8byte bursts              */
 
 397 /* SBUS control register */
 
 398 #define SBUS_CTRL_EDIRQ         0x0020      /* Enable Data DVMA Interrupts      */
 
 399 #define SBUS_CTRL_ECIRQ         0x0010      /* Enable Command DVMA Interrupts   */
 
 400 #define SBUS_CTRL_ESIRQ         0x0008      /* Enable SCSI Processor Interrupts */
 
 401 #define SBUS_CTRL_ERIRQ         0x0004      /* Enable RISC Processor Interrupts */
 
 402 #define SBUS_CTRL_GENAB         0x0002      /* Global Interrupt Enable          */
 
 403 #define SBUS_CTRL_RESET         0x0001      /* Soft Reset                       */
 
 405 /* SBUS status register */
 
 406 #define SBUS_STAT_DINT          0x0020      /* Data DVMA IRQ pending            */
 
 407 #define SBUS_STAT_CINT          0x0010      /* Command DVMA IRQ pending         */
 
 408 #define SBUS_STAT_SINT          0x0008      /* SCSI Processor IRQ pending       */
 
 409 #define SBUS_STAT_RINT          0x0004      /* RISC Processor IRQ pending       */
 
 410 #define SBUS_STAT_GINT          0x0002      /* Global IRQ pending               */
 
 412 /* SBUS semaphore register */
 
 413 #define SBUS_SEMAPHORE_STAT     0x0002      /* Semaphore status bit             */
 
 414 #define SBUS_SEMAPHORE_LCK      0x0001      /* Semaphore lock bit               */
 
 416 /* DVMA control register */
 
 417 #define DMA_CTRL_CSUSPEND       0x0010      /* DMA channel suspend              */
 
 418 #define DMA_CTRL_CCLEAR         0x0008      /* DMA channel clear and reset      */
 
 419 #define DMA_CTRL_FCLEAR         0x0004      /* DMA fifo clear                   */
 
 420 #define DMA_CTRL_CIRQ           0x0002      /* DMA irq clear                    */
 
 421 #define DMA_CTRL_DMASTART       0x0001      /* DMA transfer start               */
 
 423 /* SCSI processor override register */
 
 424 #define CPU_ORIDE_ETRIG         0x8000      /* External trigger enable          */
 
 425 #define CPU_ORIDE_STEP          0x4000      /* Single step mode enable          */
 
 426 #define CPU_ORIDE_BKPT          0x2000      /* Breakpoint reg enable            */
 
 427 #define CPU_ORIDE_PWRITE        0x1000      /* SCSI pin write enable            */
 
 428 #define CPU_ORIDE_OFORCE        0x0800      /* Force outputs on                 */
 
 429 #define CPU_ORIDE_LBACK         0x0400      /* SCSI loopback enable             */
 
 430 #define CPU_ORIDE_PTEST         0x0200      /* Parity test enable               */
 
 431 #define CPU_ORIDE_TENAB         0x0100      /* SCSI pins tristate enable        */
 
 432 #define CPU_ORIDE_TPINS         0x0080      /* SCSI pins enable                 */
 
 433 #define CPU_ORIDE_FRESET        0x0008      /* FIFO reset                       */
 
 434 #define CPU_ORIDE_CTERM         0x0004      /* Command terminate                */
 
 435 #define CPU_ORIDE_RREG          0x0002      /* Reset SCSI processor regs        */
 
 436 #define CPU_ORIDE_RMOD          0x0001      /* Reset SCSI processor module      */
 
 438 /* SCSI processor commands */
 
 439 #define CPU_CMD_BRESET          0x300b      /* Reset SCSI bus                   */
 
 441 /* SCSI processor pin control register */
 
 442 #define CPU_PCTRL_PVALID        0x8000      /* Phase bits are valid             */
 
 443 #define CPU_PCTRL_PHI           0x0400      /* Parity bit high                  */
 
 444 #define CPU_PCTRL_PLO           0x0200      /* Parity bit low                   */
 
 445 #define CPU_PCTRL_REQ           0x0100      /* REQ bus signal                   */
 
 446 #define CPU_PCTRL_ACK           0x0080      /* ACK bus signal                   */
 
 447 #define CPU_PCTRL_RST           0x0040      /* RST bus signal                   */
 
 448 #define CPU_PCTRL_BSY           0x0020      /* BSY bus signal                   */
 
 449 #define CPU_PCTRL_SEL           0x0010      /* SEL bus signal                   */
 
 450 #define CPU_PCTRL_ATN           0x0008      /* ATN bus signal                   */
 
 451 #define CPU_PCTRL_MSG           0x0004      /* MSG bus signal                   */
 
 452 #define CPU_PCTRL_CD            0x0002      /* CD bus signal                    */
 
 453 #define CPU_PCTRL_IO            0x0001      /* IO bus signal                    */
 
 455 /* SCSI processor differential pins register */
 
 456 #define CPU_PDIFF_SENSE         0x0200      /* Differential sense               */
 
 457 #define CPU_PDIFF_MODE          0x0100      /* Differential mode                */
 
 458 #define CPU_PDIFF_OENAB         0x0080      /* Outputs enable                   */
 
 459 #define CPU_PDIFF_PMASK         0x007c      /* Differential control pins        */
 
 460 #define CPU_PDIFF_TGT           0x0002      /* Target mode enable               */
 
 461 #define CPU_PDIFF_INIT          0x0001      /* Initiator mode enable            */
 
 463 /* RISC processor status register */
 
 464 #define RISC_PSR_FTRUE          0x8000      /* Force true                       */
 
 465 #define RISC_PSR_LCD            0x4000      /* Loop counter shows done status   */
 
 466 #define RISC_PSR_RIRQ           0x2000      /* RISC irq status                  */
 
 467 #define RISC_PSR_TOFLOW         0x1000      /* Timer overflow (rollover)        */
 
 468 #define RISC_PSR_AOFLOW         0x0800      /* Arithmetic overflow              */
 
 469 #define RISC_PSR_AMSB           0x0400      /* Arithmetic big endian            */
 
 470 #define RISC_PSR_ACARRY         0x0200      /* Arithmetic carry                 */
 
 471 #define RISC_PSR_AZERO          0x0100      /* Arithmetic zero                  */
 
 472 #define RISC_PSR_ULTRA          0x0020      /* Ultra mode                       */
 
 473 #define RISC_PSR_DIRQ           0x0010      /* DVMA interrupt                   */
 
 474 #define RISC_PSR_SIRQ           0x0008      /* SCSI processor interrupt         */
 
 475 #define RISC_PSR_HIRQ           0x0004      /* Host interrupt                   */
 
 476 #define RISC_PSR_IPEND          0x0002      /* Interrupt pending                */
 
 477 #define RISC_PSR_FFALSE         0x0001      /* Force false                      */
 
 479 /* RISC processor memory timing register */
 
 480 #define RISC_MTREG_P1DFLT       0x1200      /* Default read/write timing, pg1   */
 
 481 #define RISC_MTREG_P0DFLT       0x0012      /* Default read/write timing, pg0   */
 
 482 #define RISC_MTREG_P1ULTRA      0x2300      /* Ultra-mode rw timing, pg1        */
 
 483 #define RISC_MTREG_P0ULTRA      0x0023      /* Ultra-mode rw timing, pg0        */
 
 485 /* Host command/ctrl register */
 
 486 #define HCCTRL_NOP              0x0000      /* CMD: No operation                */
 
 487 #define HCCTRL_RESET            0x1000      /* CMD: Reset RISC cpu              */
 
 488 #define HCCTRL_PAUSE            0x2000      /* CMD: Pause RISC cpu              */
 
 489 #define HCCTRL_REL              0x3000      /* CMD: Release paused RISC cpu     */
 
 490 #define HCCTRL_STEP             0x4000      /* CMD: Single step RISC cpu        */
 
 491 #define HCCTRL_SHIRQ            0x5000      /* CMD: Set host irq                */
 
 492 #define HCCTRL_CHIRQ            0x6000      /* CMD: Clear host irq              */
 
 493 #define HCCTRL_CRIRQ            0x7000      /* CMD: Clear RISC cpu irq          */
 
 494 #define HCCTRL_BKPT             0x8000      /* CMD: Breakpoint enables change   */
 
 495 #define HCCTRL_TMODE            0xf000      /* CMD: Enable test mode            */
 
 496 #define HCCTRL_HIRQ             0x0080      /* Host IRQ pending                 */
 
 497 #define HCCTRL_RRIP             0x0040      /* RISC cpu reset in happening now  */
 
 498 #define HCCTRL_RPAUSED          0x0020      /* RISC cpu is paused now           */
 
 499 #define HCCTRL_EBENAB           0x0010      /* External breakpoint enable       */
 
 500 #define HCCTRL_B1ENAB           0x0008      /* Breakpoint 1 enable              */
 
 501 #define HCCTRL_B0ENAB           0x0004      /* Breakpoint 0 enable              */
 
 503 /* For our interrupt engine. */
 
 504 #define for_each_qlogicpti(qp) \
 
 505         for((qp) = qptichain; (qp); (qp) = (qp)->next)
 
 507 #endif /* !(_QLOGICPTI_H) */