1 /* qlogicpti.h: Performance Technologies QlogicISP sbus card defines.
3 * Copyright (C) 1996 David S. Miller (davem@caipfs.rutgers.edu)
9 #include <linux/config.h>
11 /* Qlogic/SBUS controller registers. */
12 #define SBUS_CFG1 0x006UL
13 #define SBUS_CTRL 0x008UL
14 #define SBUS_STAT 0x00aUL
15 #define SBUS_SEMAPHORE 0x00cUL
16 #define CMD_DMA_CTRL 0x022UL
17 #define DATA_DMA_CTRL 0x042UL
24 #define CPU_CMD 0x214UL
25 #define CPU_ORIDE 0x224UL
26 #define CPU_PCTRL 0x272UL
27 #define CPU_PDIFF 0x276UL
28 #define RISC_PSR 0x420UL
29 #define RISC_MTREG 0x42EUL
30 #define HCCTRL 0x440UL
32 /* SCSI parameters for this driver. */
33 #define MAX_TARGETS 16
36 /* With the qlogic interface, every queue slot can hold a SCSI
37 * command with up to 4 scatter/gather entries. If we need more
38 * than 4 entries, continuation entries can be used that hold
39 * another 7 entries each. Unlike for other drivers, this means
40 * that the maximum number of scatter/gather entries we can
41 * support at any given time is a function of the number of queue
42 * slots available. That is, host->can_queue and host->sg_tablesize
43 * are dynamic and _not_ independent. This all works fine because
44 * requests are queued serially and the scatter/gather limit is
45 * determined for each queue request anew.
47 #define QLOGICPTI_REQ_QUEUE_LEN 255 /* must be power of two - 1 */
48 #define QLOGICPTI_MAX_SG(ql) (4 + ((ql) > 0) ? 7*((ql) - 1) : 0)
54 int qlogicpti_detect(Scsi_Host_Template *);
55 int qlogicpti_release(struct Scsi_Host *);
56 const char * qlogicpti_info(struct Scsi_Host *);
57 int qlogicpti_queuecommand(Scsi_Cmnd *, void (* done)(Scsi_Cmnd *));
58 int qlogicpti_queuecommand_slow(Scsi_Cmnd *, void (* done)(Scsi_Cmnd *));
59 int qlogicpti_abort(Scsi_Cmnd *);
60 int qlogicpti_reset(Scsi_Cmnd *, unsigned int);
62 /* mailbox command complete status codes */
63 #define MBOX_COMMAND_COMPLETE 0x4000
64 #define INVALID_COMMAND 0x4001
65 #define HOST_INTERFACE_ERROR 0x4002
66 #define TEST_FAILED 0x4003
67 #define COMMAND_ERROR 0x4005
68 #define COMMAND_PARAM_ERROR 0x4006
70 /* async event status codes */
71 #define ASYNC_SCSI_BUS_RESET 0x8001
72 #define SYSTEM_ERROR 0x8002
73 #define REQUEST_TRANSFER_ERROR 0x8003
74 #define RESPONSE_TRANSFER_ERROR 0x8004
75 #define REQUEST_QUEUE_WAKEUP 0x8005
76 #define EXECUTION_TIMEOUT_RESET 0x8006
78 /* Am I fucking pedantic or what? */
85 #else /* __LITTLE_ENDIAN */
93 /* entry header type commands */
94 #define ENTRY_COMMAND 1
95 #define ENTRY_CONTINUATION 2
96 #define ENTRY_STATUS 3
97 #define ENTRY_MARKER 4
98 #define ENTRY_EXTENDED_COMMAND 5
100 /* entry header flag definitions */
101 #define EFLAG_CONTINUATION 1
103 #define EFLAG_BAD_HEADER 4
104 #define EFLAG_BAD_PAYLOAD 8
111 struct Command_Entry {
112 struct Entry_header hdr;
117 #else /* __LITTLE_ENDIAN */
127 struct dataseg dataseg[4];
130 /* command entry control flag definitions */
131 #define CFLAG_NODISC 0x01
132 #define CFLAG_HEAD_TAG 0x02
133 #define CFLAG_ORDERED_TAG 0x04
134 #define CFLAG_SIMPLE_TAG 0x08
135 #define CFLAG_TAR_RTN 0x10
136 #define CFLAG_READ 0x20
137 #define CFLAG_WRITE 0x40
139 struct Ext_Command_Entry {
140 struct Entry_header hdr;
145 #else /* __LITTLE_ENDIAN */
157 struct Continuation_Entry {
158 struct Entry_header hdr;
160 struct dataseg dataseg[7];
163 struct Marker_Entry {
164 struct Entry_header hdr;
169 #else /* __LITTLE_ENDIAN */
176 #else /* __LITTLE_ENDIAN */
183 /* marker entry modifier definitions */
184 #define SYNC_DEVICE 0
185 #define SYNC_TARGET 1
188 struct Status_Entry {
189 struct Entry_header hdr;
192 u16 completion_status;
199 u8 req_sense_data[32];
202 /* status entry completion status definitions */
203 #define CS_COMPLETE 0x0000
204 #define CS_INCOMPLETE 0x0001
205 #define CS_DMA_ERROR 0x0002
206 #define CS_TRANSPORT_ERROR 0x0003
207 #define CS_RESET_OCCURRED 0x0004
208 #define CS_ABORTED 0x0005
209 #define CS_TIMEOUT 0x0006
210 #define CS_DATA_OVERRUN 0x0007
211 #define CS_COMMAND_OVERRUN 0x0008
212 #define CS_STATUS_OVERRUN 0x0009
213 #define CS_BAD_MESSAGE 0x000a
214 #define CS_NO_MESSAGE_OUT 0x000b
215 #define CS_EXT_ID_FAILED 0x000c
216 #define CS_IDE_MSG_FAILED 0x000d
217 #define CS_ABORT_MSG_FAILED 0x000e
218 #define CS_REJECT_MSG_FAILED 0x000f
219 #define CS_NOP_MSG_FAILED 0x0010
220 #define CS_PARITY_ERROR_MSG_FAILED 0x0011
221 #define CS_DEVICE_RESET_MSG_FAILED 0x0012
222 #define CS_ID_MSG_FAILED 0x0013
223 #define CS_UNEXP_BUS_FREE 0x0014
224 #define CS_DATA_UNDERRUN 0x0015
225 #define CS_BUS_RESET 0x001c
227 /* status entry state flag definitions */
228 #define SF_GOT_BUS 0x0100
229 #define SF_GOT_TARGET 0x0200
230 #define SF_SENT_CDB 0x0400
231 #define SF_TRANSFERRED_DATA 0x0800
232 #define SF_GOT_STATUS 0x1000
233 #define SF_GOT_SENSE 0x2000
235 /* status entry status flag definitions */
236 #define STF_DISCONNECT 0x0001
237 #define STF_SYNCHRONOUS 0x0002
238 #define STF_PARITY_ERROR 0x0004
239 #define STF_BUS_RESET 0x0008
240 #define STF_DEVICE_RESET 0x0010
241 #define STF_ABORTED 0x0020
242 #define STF_TIMEOUT 0x0040
243 #define STF_NEGOTIATION 0x0080
245 /* mailbox commands */
246 #define MBOX_NO_OP 0x0000
247 #define MBOX_LOAD_RAM 0x0001
248 #define MBOX_EXEC_FIRMWARE 0x0002
249 #define MBOX_DUMP_RAM 0x0003
250 #define MBOX_WRITE_RAM_WORD 0x0004
251 #define MBOX_READ_RAM_WORD 0x0005
252 #define MBOX_MAILBOX_REG_TEST 0x0006
253 #define MBOX_VERIFY_CHECKSUM 0x0007
254 #define MBOX_ABOUT_FIRMWARE 0x0008
255 #define MBOX_CHECK_FIRMWARE 0x000e
256 #define MBOX_INIT_REQ_QUEUE 0x0010
257 #define MBOX_INIT_RES_QUEUE 0x0011
258 #define MBOX_EXECUTE_IOCB 0x0012
259 #define MBOX_WAKE_UP 0x0013
260 #define MBOX_STOP_FIRMWARE 0x0014
261 #define MBOX_ABORT 0x0015
262 #define MBOX_ABORT_DEVICE 0x0016
263 #define MBOX_ABORT_TARGET 0x0017
264 #define MBOX_BUS_RESET 0x0018
265 #define MBOX_STOP_QUEUE 0x0019
266 #define MBOX_START_QUEUE 0x001a
267 #define MBOX_SINGLE_STEP_QUEUE 0x001b
268 #define MBOX_ABORT_QUEUE 0x001c
269 #define MBOX_GET_DEV_QUEUE_STATUS 0x001d
270 #define MBOX_GET_FIRMWARE_STATUS 0x001f
271 #define MBOX_GET_INIT_SCSI_ID 0x0020
272 #define MBOX_GET_SELECT_TIMEOUT 0x0021
273 #define MBOX_GET_RETRY_COUNT 0x0022
274 #define MBOX_GET_TAG_AGE_LIMIT 0x0023
275 #define MBOX_GET_CLOCK_RATE 0x0024
276 #define MBOX_GET_ACT_NEG_STATE 0x0025
277 #define MBOX_GET_ASYNC_DATA_SETUP_TIME 0x0026
278 #define MBOX_GET_SBUS_PARAMS 0x0027
279 #define MBOX_GET_TARGET_PARAMS 0x0028
280 #define MBOX_GET_DEV_QUEUE_PARAMS 0x0029
281 #define MBOX_SET_INIT_SCSI_ID 0x0030
282 #define MBOX_SET_SELECT_TIMEOUT 0x0031
283 #define MBOX_SET_RETRY_COUNT 0x0032
284 #define MBOX_SET_TAG_AGE_LIMIT 0x0033
285 #define MBOX_SET_CLOCK_RATE 0x0034
286 #define MBOX_SET_ACTIVE_NEG_STATE 0x0035
287 #define MBOX_SET_ASYNC_DATA_SETUP_TIME 0x0036
288 #define MBOX_SET_SBUS_CONTROL_PARAMS 0x0037
289 #define MBOX_SET_TARGET_PARAMS 0x0038
290 #define MBOX_SET_DEV_QUEUE_PARAMS 0x0039
293 u_short initiator_scsi_id;
294 u_short bus_reset_delay;
297 u_short async_data_setup_time;
298 u_short req_ack_active_negation;
299 u_short data_line_active_negation;
300 u_short data_dma_burst_enable;
301 u_short command_dma_burst_enable;
303 u_short selection_timeout;
304 u_short max_queue_depth;
312 * 7 Disconnect Privilege
314 * 5 Wide Data Transfers
315 * 4 Synchronous Data Transfers
317 * 2 Automatic Request Sense
318 * 1 Stop Queue on Check Condition
319 * 0 Renegotiate on Error
323 u_short device_flags;
324 u_short execution_throttle;
325 u_short synchronous_period;
326 u_short synchronous_offset;
327 u_short device_enable;
328 u_short reserved; /* pad */
332 * The result queue can be quite a bit smaller since continuation entries
333 * do not show up there:
335 #define RES_QUEUE_LEN 255 /* Must be power of two - 1 */
336 #define QUEUE_ENTRY_LEN 64
338 #define NEXT_REQ_PTR(wheee) (((wheee) + 1) & QLOGICPTI_REQ_QUEUE_LEN)
339 #define NEXT_RES_PTR(wheee) (((wheee) + 1) & RES_QUEUE_LEN)
340 #define PREV_REQ_PTR(wheee) (((wheee) - 1) & QLOGICPTI_REQ_QUEUE_LEN)
341 #define PREV_RES_PTR(wheee) (((wheee) - 1) & RES_QUEUE_LEN)
343 struct pti_queue_entry {
344 char __opaque[QUEUE_ENTRY_LEN];
347 /* Software state for the driver. */
349 /* These are the hot elements in the cache, so they come first. */
350 spinlock_t lock; /* Driver mutex */
351 unsigned long qregs; /* Adapter registers */
352 struct pti_queue_entry *res_cpu; /* Ptr to RESPONSE bufs (CPU) */
353 struct pti_queue_entry *req_cpu; /* Ptr to REQUEST bufs (CPU) */
355 u_int req_in_ptr; /* index of next request slot */
356 u_int res_out_ptr; /* index of next result slot */
357 long send_marker; /* must we send a marker? */
358 struct sbus_dev *sdev;
361 int cmd_count[MAX_TARGETS];
362 unsigned long tag_ages[MAX_TARGETS];
364 /* The cmd->handler is only 32-bits, so that things work even on monster
365 * Ex000 sparc64 machines with >4GB of ram we just keep track of the
366 * scsi command pointers here. This is essentially what Matt Jacob does. -DaveM
368 Scsi_Cmnd *cmd_slots[QLOGICPTI_REQ_QUEUE_LEN + 1];
370 /* The rest of the elements are unimportant for performance. */
371 struct qlogicpti *next;
372 __u32 res_dvma; /* Ptr to RESPONSE bufs (DVMA)*/
373 __u32 req_dvma; /* Ptr to REQUEST bufs (DVMA) */
374 u_char fware_majrev, fware_minrev, fware_micrev;
375 struct Scsi_Host *qhost;
381 char differential, ultra, clock;
382 unsigned char bursts;
383 struct host_param host_param;
384 struct dev_param dev_param[MAX_TARGETS];
387 #define SREG_TPOWER 0x80 /* State of termpwr */
388 #define SREG_FUSE 0x40 /* State of on board fuse */
389 #define SREG_PDISAB 0x20 /* Disable state for power on */
390 #define SREG_DSENSE 0x10 /* Sense for differential */
391 #define SREG_IMASK 0x0c /* Interrupt level */
392 #define SREG_SPMASK 0x03 /* Mask for switch pack */
393 unsigned char swsreg;
395 gotirq : 1, /* this instance got an irq */
396 is_pti : 1, /* Non-zero if this is a PTI board. */
397 sbits : 16; /* syncmode known bits */
400 /* How to twiddle them bits... */
402 /* SBUS config register one. */
403 #define SBUS_CFG1_EPAR 0x0100 /* Enable parity checking */
404 #define SBUS_CFG1_FMASK 0x00f0 /* Forth code cycle mask */
405 #define SBUS_CFG1_BENAB 0x0004 /* Burst dvma enable */
406 #define SBUS_CFG1_B64 0x0003 /* Enable 64byte bursts */
407 #define SBUS_CFG1_B32 0x0002 /* Enable 32byte bursts */
408 #define SBUS_CFG1_B16 0x0001 /* Enable 16byte bursts */
409 #define SBUS_CFG1_B8 0x0008 /* Enable 8byte bursts */
411 /* SBUS control register */
412 #define SBUS_CTRL_EDIRQ 0x0020 /* Enable Data DVMA Interrupts */
413 #define SBUS_CTRL_ECIRQ 0x0010 /* Enable Command DVMA Interrupts */
414 #define SBUS_CTRL_ESIRQ 0x0008 /* Enable SCSI Processor Interrupts */
415 #define SBUS_CTRL_ERIRQ 0x0004 /* Enable RISC Processor Interrupts */
416 #define SBUS_CTRL_GENAB 0x0002 /* Global Interrupt Enable */
417 #define SBUS_CTRL_RESET 0x0001 /* Soft Reset */
419 /* SBUS status register */
420 #define SBUS_STAT_DINT 0x0020 /* Data DVMA IRQ pending */
421 #define SBUS_STAT_CINT 0x0010 /* Command DVMA IRQ pending */
422 #define SBUS_STAT_SINT 0x0008 /* SCSI Processor IRQ pending */
423 #define SBUS_STAT_RINT 0x0004 /* RISC Processor IRQ pending */
424 #define SBUS_STAT_GINT 0x0002 /* Global IRQ pending */
426 /* SBUS semaphore register */
427 #define SBUS_SEMAPHORE_STAT 0x0002 /* Semaphore status bit */
428 #define SBUS_SEMAPHORE_LCK 0x0001 /* Semaphore lock bit */
430 /* DVMA control register */
431 #define DMA_CTRL_CSUSPEND 0x0010 /* DMA channel suspend */
432 #define DMA_CTRL_CCLEAR 0x0008 /* DMA channel clear and reset */
433 #define DMA_CTRL_FCLEAR 0x0004 /* DMA fifo clear */
434 #define DMA_CTRL_CIRQ 0x0002 /* DMA irq clear */
435 #define DMA_CTRL_DMASTART 0x0001 /* DMA transfer start */
437 /* SCSI processor override register */
438 #define CPU_ORIDE_ETRIG 0x8000 /* External trigger enable */
439 #define CPU_ORIDE_STEP 0x4000 /* Single step mode enable */
440 #define CPU_ORIDE_BKPT 0x2000 /* Breakpoint reg enable */
441 #define CPU_ORIDE_PWRITE 0x1000 /* SCSI pin write enable */
442 #define CPU_ORIDE_OFORCE 0x0800 /* Force outputs on */
443 #define CPU_ORIDE_LBACK 0x0400 /* SCSI loopback enable */
444 #define CPU_ORIDE_PTEST 0x0200 /* Parity test enable */
445 #define CPU_ORIDE_TENAB 0x0100 /* SCSI pins tristate enable */
446 #define CPU_ORIDE_TPINS 0x0080 /* SCSI pins enable */
447 #define CPU_ORIDE_FRESET 0x0008 /* FIFO reset */
448 #define CPU_ORIDE_CTERM 0x0004 /* Command terminate */
449 #define CPU_ORIDE_RREG 0x0002 /* Reset SCSI processor regs */
450 #define CPU_ORIDE_RMOD 0x0001 /* Reset SCSI processor module */
452 /* SCSI processor commands */
453 #define CPU_CMD_BRESET 0x300b /* Reset SCSI bus */
455 /* SCSI processor pin control register */
456 #define CPU_PCTRL_PVALID 0x8000 /* Phase bits are valid */
457 #define CPU_PCTRL_PHI 0x0400 /* Parity bit high */
458 #define CPU_PCTRL_PLO 0x0200 /* Parity bit low */
459 #define CPU_PCTRL_REQ 0x0100 /* REQ bus signal */
460 #define CPU_PCTRL_ACK 0x0080 /* ACK bus signal */
461 #define CPU_PCTRL_RST 0x0040 /* RST bus signal */
462 #define CPU_PCTRL_BSY 0x0020 /* BSY bus signal */
463 #define CPU_PCTRL_SEL 0x0010 /* SEL bus signal */
464 #define CPU_PCTRL_ATN 0x0008 /* ATN bus signal */
465 #define CPU_PCTRL_MSG 0x0004 /* MSG bus signal */
466 #define CPU_PCTRL_CD 0x0002 /* CD bus signal */
467 #define CPU_PCTRL_IO 0x0001 /* IO bus signal */
469 /* SCSI processor differential pins register */
470 #define CPU_PDIFF_SENSE 0x0200 /* Differential sense */
471 #define CPU_PDIFF_MODE 0x0100 /* Differential mode */
472 #define CPU_PDIFF_OENAB 0x0080 /* Outputs enable */
473 #define CPU_PDIFF_PMASK 0x007c /* Differential control pins */
474 #define CPU_PDIFF_TGT 0x0002 /* Target mode enable */
475 #define CPU_PDIFF_INIT 0x0001 /* Initiator mode enable */
477 /* RISC processor status register */
478 #define RISC_PSR_FTRUE 0x8000 /* Force true */
479 #define RISC_PSR_LCD 0x4000 /* Loop counter shows done status */
480 #define RISC_PSR_RIRQ 0x2000 /* RISC irq status */
481 #define RISC_PSR_TOFLOW 0x1000 /* Timer overflow (rollover) */
482 #define RISC_PSR_AOFLOW 0x0800 /* Arithmetic overflow */
483 #define RISC_PSR_AMSB 0x0400 /* Arithmetic big endian */
484 #define RISC_PSR_ACARRY 0x0200 /* Arithmetic carry */
485 #define RISC_PSR_AZERO 0x0100 /* Arithmetic zero */
486 #define RISC_PSR_ULTRA 0x0020 /* Ultra mode */
487 #define RISC_PSR_DIRQ 0x0010 /* DVMA interrupt */
488 #define RISC_PSR_SIRQ 0x0008 /* SCSI processor interrupt */
489 #define RISC_PSR_HIRQ 0x0004 /* Host interrupt */
490 #define RISC_PSR_IPEND 0x0002 /* Interrupt pending */
491 #define RISC_PSR_FFALSE 0x0001 /* Force false */
493 /* RISC processor memory timing register */
494 #define RISC_MTREG_P1DFLT 0x1200 /* Default read/write timing, pg1 */
495 #define RISC_MTREG_P0DFLT 0x0012 /* Default read/write timing, pg0 */
496 #define RISC_MTREG_P1ULTRA 0x2300 /* Ultra-mode rw timing, pg1 */
497 #define RISC_MTREG_P0ULTRA 0x0023 /* Ultra-mode rw timing, pg0 */
499 /* Host command/ctrl register */
500 #define HCCTRL_NOP 0x0000 /* CMD: No operation */
501 #define HCCTRL_RESET 0x1000 /* CMD: Reset RISC cpu */
502 #define HCCTRL_PAUSE 0x2000 /* CMD: Pause RISC cpu */
503 #define HCCTRL_REL 0x3000 /* CMD: Release paused RISC cpu */
504 #define HCCTRL_STEP 0x4000 /* CMD: Single step RISC cpu */
505 #define HCCTRL_SHIRQ 0x5000 /* CMD: Set host irq */
506 #define HCCTRL_CHIRQ 0x6000 /* CMD: Clear host irq */
507 #define HCCTRL_CRIRQ 0x7000 /* CMD: Clear RISC cpu irq */
508 #define HCCTRL_BKPT 0x8000 /* CMD: Breakpoint enables change */
509 #define HCCTRL_TMODE 0xf000 /* CMD: Enable test mode */
510 #define HCCTRL_HIRQ 0x0080 /* Host IRQ pending */
511 #define HCCTRL_RRIP 0x0040 /* RISC cpu reset in happening now */
512 #define HCCTRL_RPAUSED 0x0020 /* RISC cpu is paused now */
513 #define HCCTRL_EBENAB 0x0010 /* External breakpoint enable */
514 #define HCCTRL_B1ENAB 0x0008 /* Breakpoint 1 enable */
515 #define HCCTRL_B0ENAB 0x0004 /* Breakpoint 0 enable */
517 #ifdef CONFIG_SPARC64
518 #define QLOGICPTI { \
519 detect: qlogicpti_detect, \
520 release: qlogicpti_release, \
521 info: qlogicpti_info, \
522 queuecommand: qlogicpti_queuecommand_slow, \
523 abort: qlogicpti_abort, \
524 reset: qlogicpti_reset, \
525 can_queue: QLOGICPTI_REQ_QUEUE_LEN, \
527 sg_tablesize: QLOGICPTI_MAX_SG(QLOGICPTI_REQ_QUEUE_LEN), \
529 use_clustering: ENABLE_CLUSTERING, \
530 use_new_eh_code: 0, \
534 /* Sparc32's iommu code cannot handle highmem pages yet. */
535 #define QLOGICPTI { \
536 detect: qlogicpti_detect, \
537 release: qlogicpti_release, \
538 info: qlogicpti_info, \
539 queuecommand: qlogicpti_queuecommand_slow, \
540 abort: qlogicpti_abort, \
541 reset: qlogicpti_reset, \
542 can_queue: QLOGICPTI_REQ_QUEUE_LEN, \
544 sg_tablesize: QLOGICPTI_MAX_SG(QLOGICPTI_REQ_QUEUE_LEN), \
546 use_clustering: ENABLE_CLUSTERING, \
550 /* For our interrupt engine. */
551 #define for_each_qlogicpti(qp) \
552 for((qp) = qptichain; (qp); (qp) = (qp)->next)
554 #endif /* !(_QLOGICPTI_H) */