2 * Device driver for the SYMBIOS/LSILOGIC 53C8XX and 53C1010 family
3 * of PCI-SCSI IO processors.
5 * Copyright (C) 1999-2001 Gerard Roudier <groudier@free.fr>
7 * This driver is derived from the Linux sym53c8xx driver.
8 * Copyright (C) 1998-2000 Gerard Roudier
10 * The sym53c8xx driver is derived from the ncr53c8xx driver that had been
11 * a port of the FreeBSD ncr driver to Linux-1.2.13.
13 * The original ncr driver has been written for 386bsd and FreeBSD by
14 * Wolfgang Stanglmeier <wolf@cologne.de>
15 * Stefan Esser <se@mi.Uni-Koeln.de>
16 * Copyright (C) 1994 Wolfgang Stanglmeier
18 * Other major contributions:
20 * NVRAM detection and reading.
21 * Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
23 *-----------------------------------------------------------------------------
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
40 #include <linux/gfp.h>
46 * Generic driver options.
48 * They may be defined in platform specific headers, if they
51 * SYM_OPT_HANDLE_DEVICE_QUEUEING
52 * When this option is set, the driver will use a queue per
53 * device and handle QUEUE FULL status requeuing internally.
55 * SYM_OPT_LIMIT_COMMAND_REORDERING
56 * When this option is set, the driver tries to limit tagged
57 * command reordering to some reasonnable value.
61 #define SYM_OPT_HANDLE_DEVICE_QUEUEING
62 #define SYM_OPT_LIMIT_COMMAND_REORDERING
66 * Active debugging tags and verbosity.
67 * Both DEBUG_FLAGS and sym_verbose can be redefined
68 * by the platform specific code to something else.
70 #define DEBUG_ALLOC (0x0001)
71 #define DEBUG_PHASE (0x0002)
72 #define DEBUG_POLL (0x0004)
73 #define DEBUG_QUEUE (0x0008)
74 #define DEBUG_RESULT (0x0010)
75 #define DEBUG_SCATTER (0x0020)
76 #define DEBUG_SCRIPT (0x0040)
77 #define DEBUG_TINY (0x0080)
78 #define DEBUG_TIMING (0x0100)
79 #define DEBUG_NEGO (0x0200)
80 #define DEBUG_TAGS (0x0400)
81 #define DEBUG_POINTER (0x0800)
84 #define DEBUG_FLAGS (0x0000)
88 #define sym_verbose (np->verbose)
92 * These ones should have been already defined.
95 #define assert(expression) { \
96 if (!(expression)) { \
98 "assertion \"%s\" failed: file \"%s\", line %d\n", \
100 __FILE__, __LINE__); \
106 * Number of tasks per device we want to handle.
108 #if SYM_CONF_MAX_TAG_ORDER > 8
109 #error "more than 256 tags per logical unit not allowed."
111 #define SYM_CONF_MAX_TASK (1<<SYM_CONF_MAX_TAG_ORDER)
114 * Donnot use more tasks that we can handle.
116 #ifndef SYM_CONF_MAX_TAG
117 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
119 #if SYM_CONF_MAX_TAG > SYM_CONF_MAX_TASK
120 #undef SYM_CONF_MAX_TAG
121 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
125 * This one means 'NO TAG for this job'
130 * Number of SCSI targets.
132 #if SYM_CONF_MAX_TARGET > 16
133 #error "more than 16 targets not allowed."
137 * Number of logical units per target.
139 #if SYM_CONF_MAX_LUN > 64
140 #error "more than 64 logical units per target not allowed."
144 * Asynchronous pre-scaler (ns). Shall be 40 for
145 * the SCSI timings to be compliant.
147 #define SYM_CONF_MIN_ASYNC (40)
154 #define SYM_MEM_WARN 1 /* Warn on failed operations */
156 #define SYM_MEM_PAGE_ORDER 0 /* 1 PAGE maximum */
157 #define SYM_MEM_CLUSTER_SHIFT (PAGE_SHIFT+SYM_MEM_PAGE_ORDER)
158 #define SYM_MEM_FREE_UNUSED /* Free unused pages immediately */
160 * Shortest memory chunk is (1<<SYM_MEM_SHIFT), currently 16.
161 * Actual allocations happen as SYM_MEM_CLUSTER_SIZE sized.
162 * (1 PAGE at a time is just fine).
164 #define SYM_MEM_SHIFT 4
165 #define SYM_MEM_CLUSTER_SIZE (1UL << SYM_MEM_CLUSTER_SHIFT)
166 #define SYM_MEM_CLUSTER_MASK (SYM_MEM_CLUSTER_SIZE-1)
169 * Number of entries in the START and DONE queues.
171 * We limit to 1 PAGE in order to succeed allocation of
172 * these queues. Each entry is 8 bytes long (2 DWORDS).
174 #ifdef SYM_CONF_MAX_START
175 #define SYM_CONF_MAX_QUEUE (SYM_CONF_MAX_START+2)
177 #define SYM_CONF_MAX_QUEUE (7*SYM_CONF_MAX_TASK+2)
178 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
181 #if SYM_CONF_MAX_QUEUE > SYM_MEM_CLUSTER_SIZE/8
182 #undef SYM_CONF_MAX_QUEUE
183 #define SYM_CONF_MAX_QUEUE (SYM_MEM_CLUSTER_SIZE/8)
184 #undef SYM_CONF_MAX_START
185 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
189 * For this one, we want a short name :-)
191 #define MAX_QUEUE SYM_CONF_MAX_QUEUE
194 * Common definitions for both bus space based and legacy IO methods.
197 #define INB_OFF(np, o) ioread8(np->s.ioaddr + (o))
198 #define INW_OFF(np, o) ioread16(np->s.ioaddr + (o))
199 #define INL_OFF(np, o) ioread32(np->s.ioaddr + (o))
201 #define OUTB_OFF(np, o, val) iowrite8((val), np->s.ioaddr + (o))
202 #define OUTW_OFF(np, o, val) iowrite16((val), np->s.ioaddr + (o))
203 #define OUTL_OFF(np, o, val) iowrite32((val), np->s.ioaddr + (o))
205 #define INB(np, r) INB_OFF(np, offsetof(struct sym_reg, r))
206 #define INW(np, r) INW_OFF(np, offsetof(struct sym_reg, r))
207 #define INL(np, r) INL_OFF(np, offsetof(struct sym_reg, r))
209 #define OUTB(np, r, v) OUTB_OFF(np, offsetof(struct sym_reg, r), (v))
210 #define OUTW(np, r, v) OUTW_OFF(np, offsetof(struct sym_reg, r), (v))
211 #define OUTL(np, r, v) OUTL_OFF(np, offsetof(struct sym_reg, r), (v))
213 #define OUTONB(np, r, m) OUTB(np, r, INB(np, r) | (m))
214 #define OUTOFFB(np, r, m) OUTB(np, r, INB(np, r) & ~(m))
215 #define OUTONW(np, r, m) OUTW(np, r, INW(np, r) | (m))
216 #define OUTOFFW(np, r, m) OUTW(np, r, INW(np, r) & ~(m))
217 #define OUTONL(np, r, m) OUTL(np, r, INL(np, r) | (m))
218 #define OUTOFFL(np, r, m) OUTL(np, r, INL(np, r) & ~(m))
221 * We normally want the chip to have a consistent view
222 * of driver internal data structures when we restart it.
225 #define OUTL_DSP(np, v) \
227 MEMORY_WRITE_BARRIER(); \
228 OUTL(np, nc_dsp, (v)); \
231 #define OUTONB_STD() \
233 MEMORY_WRITE_BARRIER(); \
234 OUTONB(np, nc_dcntl, (STD|NOCOM)); \
238 * Command control block states.
242 #define HS_NEGOTIATE (2) /* sync/wide data transfer*/
243 #define HS_DISCONNECT (3) /* Disconnected by target */
244 #define HS_WAIT (4) /* waiting for resource */
246 #define HS_DONEMASK (0x80)
247 #define HS_COMPLETE (4|HS_DONEMASK)
248 #define HS_SEL_TIMEOUT (5|HS_DONEMASK) /* Selection timeout */
249 #define HS_UNEXPECTED (6|HS_DONEMASK) /* Unexpected disconnect */
250 #define HS_COMP_ERR (7|HS_DONEMASK) /* Completed with error */
253 * Software Interrupt Codes
255 #define SIR_BAD_SCSI_STATUS (1)
256 #define SIR_SEL_ATN_NO_MSG_OUT (2)
257 #define SIR_MSG_RECEIVED (3)
258 #define SIR_MSG_WEIRD (4)
259 #define SIR_NEGO_FAILED (5)
260 #define SIR_NEGO_PROTO (6)
261 #define SIR_SCRIPT_STOPPED (7)
262 #define SIR_REJECT_TO_SEND (8)
263 #define SIR_SWIDE_OVERRUN (9)
264 #define SIR_SODL_UNDERRUN (10)
265 #define SIR_RESEL_NO_MSG_IN (11)
266 #define SIR_RESEL_NO_IDENTIFY (12)
267 #define SIR_RESEL_BAD_LUN (13)
268 #define SIR_TARGET_SELECTED (14)
269 #define SIR_RESEL_BAD_I_T_L (15)
270 #define SIR_RESEL_BAD_I_T_L_Q (16)
271 #define SIR_ABORT_SENT (17)
272 #define SIR_RESEL_ABORTED (18)
273 #define SIR_MSG_OUT_DONE (19)
274 #define SIR_COMPLETE_ERROR (20)
275 #define SIR_DATA_OVERRUN (21)
276 #define SIR_BAD_PHASE (22)
277 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
278 #define SIR_DMAP_DIRTY (23)
285 * Extended error bit codes.
286 * xerr_status field of struct sym_ccb.
288 #define XE_EXTRA_DATA (1) /* unexpected data phase */
289 #define XE_BAD_PHASE (1<<1) /* illegal phase (4/5) */
290 #define XE_PARITY_ERR (1<<2) /* unrecovered SCSI parity error */
291 #define XE_SODL_UNRUN (1<<3) /* ODD transfer in DATA OUT phase */
292 #define XE_SWIDE_OVRUN (1<<4) /* ODD transfer in DATA IN phase */
295 * Negotiation status.
296 * nego_status field of struct sym_ccb.
303 * A CCB hashed table is used to retrieve CCB address
306 #define CCB_HASH_SHIFT 8
307 #define CCB_HASH_SIZE (1UL << CCB_HASH_SHIFT)
308 #define CCB_HASH_MASK (CCB_HASH_SIZE-1)
310 #define CCB_HASH_CODE(dsa) \
311 (((dsa) >> (_LGRU16_(sizeof(struct sym_ccb)))) & CCB_HASH_MASK)
313 #define CCB_HASH_CODE(dsa) (((dsa) >> 9) & CCB_HASH_MASK)
316 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
318 * We may want to use segment registers for 64 bit DMA.
319 * 16 segments registers -> up to 64 GB addressable.
321 #define SYM_DMAP_SHIFT (4)
322 #define SYM_DMAP_SIZE (1u<<SYM_DMAP_SHIFT)
323 #define SYM_DMAP_MASK (SYM_DMAP_SIZE-1)
329 #define SYM_DISC_ENABLED (1)
330 #define SYM_TAGS_ENABLED (1<<1)
331 #define SYM_SCAN_BOOT_DISABLED (1<<2)
332 #define SYM_SCAN_LUNS_DISABLED (1<<3)
335 * Host adapter miscellaneous flags.
337 #define SYM_AVOID_BUS_RESET (1)
342 #define SYM_SNOOP_TIMEOUT (10000000)
347 * Gather negotiable parameters value
352 unsigned int width:1;
356 unsigned int check_nego:1;
362 * Due to lack of indirect addressing on earlier NCR chips,
363 * this substructure is copied from the TCB to a global
364 * address after selection.
365 * For SYMBIOS chips that support LOAD/STORE this copy is
366 * not needed and thus not performed.
370 * Scripts bus addresses of LUN table accessed from scripts.
371 * LUN #0 is a special case, since multi-lun devices are rare,
372 * and we we want to speed-up the general case and not waste
375 u32 luntbl_sa; /* bus address of this table */
376 u32 lun0_sa; /* bus address of LCB #0 */
378 * Actual SYNC/WIDE IO registers value for this target.
379 * 'sval', 'wval' and 'uval' are read from SCRIPTS and
380 * so have alignment constraints.
382 /*0*/ u_char uval; /* -> SCNTL4 register */
383 /*1*/ u_char sval; /* -> SXFER io register */
384 /*2*/ u_char filler1;
385 /*3*/ u_char wval; /* -> SCNTL3 io register */
389 * Target Control Block
394 * Assumed at offset 0.
396 /*0*/ struct sym_tcbh head;
399 * LUN table used by the SCRIPTS processor.
400 * An array of bus addresses is used on reselection.
402 u32 *luntbl; /* LCBs bus address table */
405 * LUN table used by the C code.
407 struct sym_lcb *lun0p; /* LCB of LUN #0 (usual case) */
408 #if SYM_CONF_MAX_LUN > 1
409 struct sym_lcb **lunmp; /* Other LCBs [1..MAX_LUN] */
414 * O/S specific data structure.
420 struct sym_trans tgoal;
423 * Keep track of the CCB used for the negotiation in order
424 * to ensure that only 1 negotiation is queued at a time.
426 struct sym_ccb * nego_cp; /* CCB used for the nego */
429 * Set when we want to reset the device.
434 * Other user settable limits and options.
435 * These limits are read from the NVRAM if present.
439 struct scsi_target *starget;
445 * Due to lack of indirect addressing on earlier NCR chips,
446 * this substructure is copied from the LCB to a global
447 * address after selection.
448 * For SYMBIOS chips that support LOAD/STORE this copy is
449 * not needed and thus not performed.
453 * SCRIPTS address jumped by SCRIPTS on reselection.
454 * For not probed logical units, this address points to
455 * SCRIPTS that deal with bad LU handling (must be at
456 * offset zero of the LCB for that reason).
461 * Task (bus address of a CCB) read from SCRIPTS that points
462 * to the unique ITL nexus allowed to be disconnected.
467 * Task table bus address (read from SCRIPTS).
473 * Logical Unit Control Block
478 * Assumed at offset 0.
480 /*0*/ struct sym_lcbh head;
483 * Task table read from SCRIPTS that contains pointers to
484 * ITLQ nexuses. The bus address read from SCRIPTS is
487 u32 *itlq_tbl; /* Kernel virtual address */
490 * Busy CCBs management.
492 u_short busy_itlq; /* Number of busy tagged CCBs */
493 u_short busy_itl; /* Number of busy untagged CCBs */
496 * Circular tag allocation buffer.
498 u_short ia_tag; /* Tag allocation index */
499 u_short if_tag; /* Tag release index */
500 u_char *cb_tags; /* Circular tags buffer */
503 * O/S specific data structure.
509 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
511 * Optionnaly the driver can handle device queueing,
512 * and requeues internally command to redo.
514 SYM_QUEHEAD waiting_ccbq;
515 SYM_QUEHEAD started_ccbq;
517 u_short started_tags;
518 u_short started_no_tag;
520 u_short started_limit;
523 #ifdef SYM_OPT_LIMIT_COMMAND_REORDERING
525 * Optionally the driver can try to prevent SCSI
526 * IOs from being reordered too much.
528 u_char tags_si; /* Current index to tags sum */
529 u_short tags_sum[2]; /* Tags sum counters */
530 u_short tags_since; /* # of tags since last switch */
534 * Set when we want to clear all tasks.
546 * Action from SCRIPTS on a task.
547 * Is part of the CCB, but is also used separately to plug
548 * error handling action to perform from SCRIPTS.
551 u32 start; /* Jumped by SCRIPTS after selection */
552 u32 restart; /* Jumped by SCRIPTS on relection */
556 * Phase mismatch context.
558 * It is part of the CCB and is used as parameters for the
559 * DATA pointer. We need two contexts to handle correctly the
560 * SAVED DATA POINTER.
563 struct sym_tblmove sg; /* Updated interrupted SG block */
564 u32 ret; /* SCRIPT return address */
568 * LUN control block lookup.
569 * We use a direct pointer for LUN #0, and a table of
570 * pointers which is only allocated for devices that support
573 #if SYM_CONF_MAX_LUN <= 1
574 #define sym_lp(tp, lun) (!lun) ? (tp)->lun0p : NULL
576 #define sym_lp(tp, lun) \
577 (!lun) ? (tp)->lun0p : (tp)->lunmp ? (tp)->lunmp[(lun)] : NULL
581 * Status are used by the host and the script processor.
583 * The last four bytes (status[4]) are copied to the
584 * scratchb register (declared as scr0..scr3) just after the
585 * select/reselect, and copied back just after disconnecting.
586 * Inside the script the XX_REG are used.
590 * Last four bytes (script)
593 #define HX_PRT nc_scr0
595 #define HS_PRT nc_scr1
597 #define SS_PRT nc_scr2
599 #define HF_PRT nc_scr3
602 * Last four bytes (host)
604 #define host_xflags phys.head.status[0]
605 #define host_status phys.head.status[1]
606 #define ssss_status phys.head.status[2]
607 #define host_flags phys.head.status[3]
613 #define HF_IN_PM1 (1u<<1)
614 #define HF_ACT_PM (1u<<2)
615 #define HF_DP_SAVED (1u<<3)
616 #define HF_SENSE (1u<<4)
617 #define HF_EXT_ERR (1u<<5)
618 #define HF_DATA_IN (1u<<6)
619 #ifdef SYM_CONF_IARB_SUPPORT
620 #define HF_HINT_IARB (1u<<7)
626 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
627 #define HX_DMAP_DIRTY (1u<<7)
633 * Due to lack of indirect addressing on earlier NCR chips,
634 * this substructure is copied from the ccb to a global
635 * address after selection (or reselection) and copied back
637 * For SYMBIOS chips that support LOAD/STORE this copy is
638 * not needed and thus not performed.
643 * Start and restart SCRIPTS addresses (must be at 0).
645 /*0*/ struct sym_actscr go;
648 * SCRIPTS jump address that deal with data pointers.
649 * 'savep' points to the position in the script responsible
650 * for the actual transfer of data.
651 * It's written on reception of a SAVE_DATA_POINTER message.
653 u32 savep; /* Jump address to saved data pointer */
654 u32 lastp; /* SCRIPTS address at end of data */
663 * GET/SET the value of the data pointer used by SCRIPTS.
665 * We must distinguish between the LOAD/STORE-based SCRIPTS
666 * that use directly the header in the CCB, and the NCR-GENERIC
667 * SCRIPTS that use the copy of the header in the HCB.
669 #if SYM_CONF_GENERIC_SUPPORT
670 #define sym_set_script_dp(np, cp, dp) \
672 if (np->features & FE_LDSTR) \
673 cp->phys.head.lastp = cpu_to_scr(dp); \
675 np->ccb_head.lastp = cpu_to_scr(dp); \
677 #define sym_get_script_dp(np, cp) \
678 scr_to_cpu((np->features & FE_LDSTR) ? \
679 cp->phys.head.lastp : np->ccb_head.lastp)
681 #define sym_set_script_dp(np, cp, dp) \
683 cp->phys.head.lastp = cpu_to_scr(dp); \
686 #define sym_get_script_dp(np, cp) (cp->phys.head.lastp)
690 * Data Structure Block
692 * During execution of a ccb by the script processor, the
693 * DSA (data structure address) register points to this
694 * substructure of the ccb.
699 * Also assumed at offset 0 of the sym_ccb structure.
701 /*0*/ struct sym_ccbh head;
704 * Phase mismatch contexts.
705 * We need two to handle correctly the SAVED DATA POINTER.
706 * MUST BOTH BE AT OFFSET < 256, due to using 8 bit arithmetic
707 * for address calculation from SCRIPTS.
713 * Table data for Script
715 struct sym_tblsel select;
716 struct sym_tblmove smsg;
717 struct sym_tblmove smsg_ext;
718 struct sym_tblmove cmd;
719 struct sym_tblmove sense;
720 struct sym_tblmove wresid;
721 struct sym_tblmove data [SYM_CONF_MAX_SG];
725 * Our Command Control Block
729 * This is the data structure which is pointed by the DSA
730 * register when it is executed by the script processor.
731 * It must be the first entry.
736 * Pointer to CAM ccb and related stuff.
738 struct scsi_cmnd *cmd; /* CAM scsiio ccb */
739 u8 cdb_buf[16]; /* Copy of CDB */
740 #define SYM_SNS_BBUF_LEN 32
741 u8 sns_bbuf[SYM_SNS_BBUF_LEN]; /* Bounce buffer for sense data */
742 int data_len; /* Total data length */
743 int segments; /* Number of SG segments */
745 u8 order; /* Tag type (if tagged command) */
746 unsigned char odd_byte_adjustment; /* odd-sized req on wide bus */
748 u_char nego_status; /* Negotiation status */
749 u_char xerr_status; /* Extended error flags */
750 u32 extra_bytes; /* Extraneous bytes transferred */
754 * We prepare a message to be sent after selection.
755 * We may use a second one if the command is rescheduled
756 * due to CHECK_CONDITION or COMMAND TERMINATED.
757 * Contents are IDENTIFY and SIMPLE_TAG.
758 * While negotiating sync or wide transfer,
759 * a SDTR or WDTR message is appended.
761 u_char scsi_smsg [12];
762 u_char scsi_smsg2[12];
765 * Auto request sense related fields.
767 u_char sensecmd[6]; /* Request Sense command */
768 u_char sv_scsi_status; /* Saved SCSI status */
769 u_char sv_xerr_status; /* Saved extended status */
770 int sv_resid; /* Saved residual */
775 u32 ccb_ba; /* BUS address of this CCB */
776 u_short tag; /* Tag for this transfer */
777 /* NO_TAG means no tag */
780 struct sym_ccb *link_ccbh; /* Host adapter CCB hash chain */
781 SYM_QUEHEAD link_ccbq; /* Link to free/busy CCB queue */
782 u32 startp; /* Initial data pointer */
783 u32 goalp; /* Expected last data pointer */
784 int ext_sg; /* Extreme data pointer, used */
785 int ext_ofs; /* to calculate the residual. */
786 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
787 SYM_QUEHEAD link2_ccbq; /* Link for device queueing */
788 u_char started; /* CCB queued to the squeue */
790 u_char to_abort; /* Want this IO to be aborted */
791 #ifdef SYM_OPT_LIMIT_COMMAND_REORDERING
792 u_char tags_si; /* Lun tags sum index (0,1) */
796 #define CCB_BA(cp,lbl) cpu_to_scr(cp->ccb_ba + offsetof(struct sym_ccb, lbl))
798 typedef struct device *m_pool_ident_t;
806 * Due to poorness of addressing capabilities, earlier
807 * chips (810, 815, 825) copy part of the data structures
808 * (CCB, TCB and LCB) in fixed areas.
810 #if SYM_CONF_GENERIC_SUPPORT
811 struct sym_ccbh ccb_head;
812 struct sym_tcbh tcb_head;
813 struct sym_lcbh lcb_head;
816 * Idle task and invalid task actions and
817 * their bus addresses.
819 struct sym_actscr idletask, notask, bad_itl, bad_itlq;
820 u32 idletask_ba, notask_ba, bad_itl_ba, bad_itlq_ba;
823 * Dummy lun table to protect us against target
824 * returning bad lun number on reselection.
826 u32 *badluntbl; /* Table physical address */
827 u32 badlun_sa; /* SCRIPT handler BUS address */
830 * Bus address of this host control block.
835 * Bit 32-63 of the on-chip RAM bus address in LE format.
836 * The START_RAM64 script loads the MMRS and MMWS from this
842 * Initial value of some IO register bits.
843 * These values are assumed to have been set by BIOS, and may
844 * be used to probe adapter implementation differences.
846 u_char sv_scntl0, sv_scntl3, sv_dmode, sv_dcntl, sv_ctest3, sv_ctest4,
847 sv_ctest5, sv_gpcntl, sv_stest2, sv_stest4, sv_scntl4,
851 * Actual initial value of IO register bits used by the
852 * driver. They are loaded at initialisation according to
853 * features that are to be enabled/disabled.
855 u_char rv_scntl0, rv_scntl3, rv_dmode, rv_dcntl, rv_ctest3, rv_ctest4,
856 rv_ctest5, rv_stest2, rv_ccntl0, rv_ccntl1, rv_scntl4;
861 struct sym_tcb target[SYM_CONF_MAX_TARGET];
864 * Target control block bus address array used by the SCRIPT
871 * DMA pool handle for this HBA.
873 m_pool_ident_t bus_dmat;
876 * O/S specific data structure
881 * Physical bus addresses of the chip.
883 u32 mmio_ba; /* MMIO 32 bit BUS address */
884 int mmio_ws; /* MMIO Window size */
886 u32 ram_ba; /* RAM 32 bit BUS address */
887 int ram_ws; /* RAM window size */
890 * SCRIPTS virtual and physical bus addresses.
891 * 'script' is loaded in the on-chip RAM if present.
892 * 'scripth' stays in main memory for all chips except the
893 * 53C895A, 53C896 and 53C1010 that provide 8K on-chip RAM.
895 u_char *scripta0; /* Copy of scripts A, B, Z */
898 u32 scripta_ba; /* Actual scripts A, B, Z */
899 u32 scriptb_ba; /* 32 bit bus addresses. */
901 u_short scripta_sz; /* Actual size of script A, B, Z*/
906 * Bus addresses, setup and patch methods for
907 * the selected firmware.
909 struct sym_fwa_ba fwa_bas; /* Useful SCRIPTA bus addresses */
910 struct sym_fwb_ba fwb_bas; /* Useful SCRIPTB bus addresses */
911 struct sym_fwz_ba fwz_bas; /* Useful SCRIPTZ bus addresses */
912 void (*fw_setup)(struct sym_hcb *np, struct sym_fw *fw);
913 void (*fw_patch)(struct sym_hcb *np);
917 * General controller parameters and configuration.
919 u_short device_id; /* PCI device id */
920 u_char revision_id; /* PCI device revision id */
921 u_int features; /* Chip features map */
922 u_char myaddr; /* SCSI id of the adapter */
923 u_char maxburst; /* log base 2 of dwords burst */
924 u_char maxwide; /* Maximum transfer width */
925 u_char minsync; /* Min sync period factor (ST) */
926 u_char maxsync; /* Max sync period factor (ST) */
927 u_char maxoffs; /* Max scsi offset (ST) */
928 u_char minsync_dt; /* Min sync period factor (DT) */
929 u_char maxsync_dt; /* Max sync period factor (DT) */
930 u_char maxoffs_dt; /* Max scsi offset (DT) */
931 u_char multiplier; /* Clock multiplier (1,2,4) */
932 u_char clock_divn; /* Number of clock divisors */
933 u32 clock_khz; /* SCSI clock frequency in KHz */
934 u32 pciclk_khz; /* Estimated PCI clock in KHz */
936 * Start queue management.
937 * It is filled up by the host processor and accessed by the
938 * SCRIPTS processor in order to start SCSI commands.
940 volatile /* Prevent code optimizations */
941 u32 *squeue; /* Start queue virtual address */
942 u32 squeue_ba; /* Start queue BUS address */
943 u_short squeueput; /* Next free slot of the queue */
944 u_short actccbs; /* Number of allocated CCBs */
947 * Command completion queue.
948 * It is the same size as the start queue to avoid overflow.
950 u_short dqueueget; /* Next position to scan */
951 volatile /* Prevent code optimizations */
952 u32 *dqueue; /* Completion (done) queue */
953 u32 dqueue_ba; /* Done queue BUS address */
956 * Miscellaneous buffers accessed by the scripts-processor.
957 * They shall be DWORD aligned, because they may be read or
958 * written with a script command.
960 u_char msgout[8]; /* Buffer for MESSAGE OUT */
961 u_char msgin [8]; /* Buffer for MESSAGE IN */
962 u32 lastmsg; /* Last SCSI message sent */
963 u32 scratch; /* Scratch for SCSI receive */
964 /* Also used for cache test */
966 * Miscellaneous configuration and status parameters.
968 u_char usrflags; /* Miscellaneous user flags */
969 u_char scsi_mode; /* Current SCSI BUS mode */
970 u_char verbose; /* Verbosity for this controller*/
973 * CCB lists and queue.
975 struct sym_ccb **ccbh; /* CCBs hashed by DSA value */
976 /* CCB_HASH_SIZE lists of CCBs */
977 SYM_QUEHEAD free_ccbq; /* Queue of available CCBs */
978 SYM_QUEHEAD busy_ccbq; /* Queue of busy CCBs */
981 * During error handling and/or recovery,
982 * active CCBs that are to be completed with
983 * error or requeued are moved from the busy_ccbq
984 * to the comp_ccbq prior to completion.
986 SYM_QUEHEAD comp_ccbq;
988 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
989 SYM_QUEHEAD dummy_ccbq;
993 * IMMEDIATE ARBITRATION (IARB) control.
995 * We keep track in 'last_cp' of the last CCB that has been
996 * queued to the SCRIPTS processor and clear 'last_cp' when
997 * this CCB completes. If last_cp is not zero at the moment
998 * we queue a new CCB, we set a flag in 'last_cp' that is
999 * used by the SCRIPTS as a hint for setting IARB.
1000 * We donnot set more than 'iarb_max' consecutive hints for
1001 * IARB in order to leave devices a chance to reselect.
1002 * By the way, any non zero value of 'iarb_max' is unfair. :)
1004 #ifdef SYM_CONF_IARB_SUPPORT
1005 u_short iarb_max; /* Max. # consecutive IARB hints*/
1006 u_short iarb_count; /* Actual # of these hints */
1007 struct sym_ccb * last_cp;
1011 * Command abort handling.
1012 * We need to synchronize tightly with the SCRIPTS
1013 * processor in order to handle things correctly.
1015 u_char abrt_msg[4]; /* Message to send buffer */
1016 struct sym_tblmove abrt_tbl; /* Table for the MOV of it */
1017 struct sym_tblsel abrt_sel; /* Sync params for selection */
1018 u_char istat_sem; /* Tells the chip to stop (SEM) */
1021 * 64 bit DMA handling.
1023 #if SYM_CONF_DMA_ADDRESSING_MODE != 0
1024 u_char use_dac; /* Use PCI DAC cycles */
1025 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
1026 u_char dmap_dirty; /* Dma segments registers dirty */
1027 u32 dmap_bah[SYM_DMAP_SIZE];/* Segment registers map */
1032 #define HCB_BA(np, lbl) (np->hcb_ba + offsetof(struct sym_hcb, lbl))
1036 * FIRMWARES (sym_fw.c)
1038 struct sym_fw * sym_find_firmware(struct sym_chip *chip);
1039 void sym_fw_bind_script(struct sym_hcb *np, u32 *start, int len);
1042 * Driver methods called from O/S specific code.
1044 char *sym_driver_name(void);
1045 void sym_print_xerr(struct scsi_cmnd *cmd, int x_status);
1046 int sym_reset_scsi_bus(struct sym_hcb *np, int enab_int);
1047 struct sym_chip *sym_lookup_chip_table(u_short device_id, u_char revision);
1048 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
1049 void sym_start_next_ccbs(struct sym_hcb *np, struct sym_lcb *lp, int maxn);
1051 void sym_start_up(struct sym_hcb *np, int reason);
1052 void sym_interrupt(struct sym_hcb *np);
1053 int sym_clear_tasks(struct sym_hcb *np, int cam_status, int target, int lun, int task);
1054 struct sym_ccb *sym_get_ccb(struct sym_hcb *np, struct scsi_cmnd *cmd, u_char tag_order);
1055 void sym_free_ccb(struct sym_hcb *np, struct sym_ccb *cp);
1056 struct sym_lcb *sym_alloc_lcb(struct sym_hcb *np, u_char tn, u_char ln);
1057 int sym_queue_scsiio(struct sym_hcb *np, struct scsi_cmnd *csio, struct sym_ccb *cp);
1058 int sym_abort_scsiio(struct sym_hcb *np, struct scsi_cmnd *ccb, int timed_out);
1059 int sym_reset_scsi_target(struct sym_hcb *np, int target);
1060 void sym_hcb_free(struct sym_hcb *np);
1061 int sym_hcb_attach(struct Scsi_Host *shost, struct sym_fw *fw, struct sym_nvram *nvram);
1064 * Build a scatter/gather entry.
1066 * For 64 bit systems, we use the 8 upper bits of the size field
1067 * to provide bus address bits 32-39 to the SCRIPTS processor.
1068 * This allows the 895A, 896, 1010 to address up to 1 TB of memory.
1071 #if SYM_CONF_DMA_ADDRESSING_MODE == 0
1072 #define sym_build_sge(np, data, badd, len) \
1074 (data)->addr = cpu_to_scr(badd); \
1075 (data)->size = cpu_to_scr(len); \
1077 #elif SYM_CONF_DMA_ADDRESSING_MODE == 1
1078 #define sym_build_sge(np, data, badd, len) \
1080 (data)->addr = cpu_to_scr(badd); \
1081 (data)->size = cpu_to_scr((((badd) >> 8) & 0xff000000) + len); \
1083 #elif SYM_CONF_DMA_ADDRESSING_MODE == 2
1084 int sym_lookup_dmap(struct sym_hcb *np, u32 h, int s);
1085 static __inline void
1086 sym_build_sge(struct sym_hcb *np, struct sym_tblmove *data, u64 badd, int len)
1089 int s = (h&SYM_DMAP_MASK);
1091 if (h != np->dmap_bah[s])
1094 (data)->addr = cpu_to_scr(badd);
1095 (data)->size = cpu_to_scr((s<<24) + len);
1098 s = sym_lookup_dmap(np, h, s);
1102 #error "Unsupported DMA addressing mode"
1109 #define sym_get_mem_cluster() \
1110 (void *) __get_free_pages(GFP_ATOMIC, SYM_MEM_PAGE_ORDER)
1111 #define sym_free_mem_cluster(p) \
1112 free_pages((unsigned long)p, SYM_MEM_PAGE_ORDER)
1115 * Link between free memory chunks of a given size.
1117 typedef struct sym_m_link {
1118 struct sym_m_link *next;
1122 * Virtual to bus physical translation for a given cluster.
1123 * Such a structure is only useful with DMA abstraction.
1125 typedef struct sym_m_vtob { /* Virtual to Bus address translation */
1126 struct sym_m_vtob *next;
1127 void *vaddr; /* Virtual address */
1128 dma_addr_t baddr; /* Bus physical address */
1131 /* Hash this stuff a bit to speed up translations */
1132 #define VTOB_HASH_SHIFT 5
1133 #define VTOB_HASH_SIZE (1UL << VTOB_HASH_SHIFT)
1134 #define VTOB_HASH_MASK (VTOB_HASH_SIZE-1)
1135 #define VTOB_HASH_CODE(m) \
1136 ((((unsigned long)(m)) >> SYM_MEM_CLUSTER_SHIFT) & VTOB_HASH_MASK)
1139 * Memory pool of a given kind.
1140 * Ideally, we want to use:
1141 * 1) 1 pool for memory we donnot need to involve in DMA.
1142 * 2) The same pool for controllers that require same DMA
1143 * constraints and features.
1144 * The OS specific m_pool_id_t thing and the sym_m_pool_match()
1145 * method are expected to tell the driver about.
1147 typedef struct sym_m_pool {
1148 m_pool_ident_t dev_dmat; /* Identifies the pool (see above) */
1149 void * (*get_mem_cluster)(struct sym_m_pool *);
1150 #ifdef SYM_MEM_FREE_UNUSED
1151 void (*free_mem_cluster)(struct sym_m_pool *, void *);
1153 #define M_GET_MEM_CLUSTER() mp->get_mem_cluster(mp)
1154 #define M_FREE_MEM_CLUSTER(p) mp->free_mem_cluster(mp, p)
1156 m_vtob_p vtob[VTOB_HASH_SIZE];
1157 struct sym_m_pool *next;
1158 struct sym_m_link h[SYM_MEM_CLUSTER_SHIFT - SYM_MEM_SHIFT + 1];
1162 * Alloc, free and translate addresses to bus physical
1163 * for DMAable memory.
1165 void *__sym_calloc_dma(m_pool_ident_t dev_dmat, int size, char *name);
1166 void __sym_mfree_dma(m_pool_ident_t dev_dmat, void *m, int size, char *name);
1167 dma_addr_t __vtobus(m_pool_ident_t dev_dmat, void *m);
1170 * Verbs used by the driver code for DMAable memory handling.
1171 * The _uvptv_ macro avoids a nasty warning about pointer to volatile
1174 #define _uvptv_(p) ((void *)((u_long)(p)))
1176 #define _sym_calloc_dma(np, l, n) __sym_calloc_dma(np->bus_dmat, l, n)
1177 #define _sym_mfree_dma(np, p, l, n) \
1178 __sym_mfree_dma(np->bus_dmat, _uvptv_(p), l, n)
1179 #define sym_calloc_dma(l, n) _sym_calloc_dma(np, l, n)
1180 #define sym_mfree_dma(p, l, n) _sym_mfree_dma(np, p, l, n)
1181 #define vtobus(p) __vtobus(np->bus_dmat, _uvptv_(p))
1184 * We have to provide the driver memory allocator with methods for
1185 * it to maintain virtual to bus physical address translations.
1188 #define sym_m_pool_match(mp_id1, mp_id2) (mp_id1 == mp_id2)
1190 static __inline void *sym_m_get_dma_mem_cluster(m_pool_p mp, m_vtob_p vbp)
1193 dma_addr_t baddr = 0;
1195 vaddr = dma_alloc_coherent(mp->dev_dmat, SYM_MEM_CLUSTER_SIZE, &baddr,
1204 static __inline void sym_m_free_dma_mem_cluster(m_pool_p mp, m_vtob_p vbp)
1206 dma_free_coherent(mp->dev_dmat, SYM_MEM_CLUSTER_SIZE, vbp->vaddr,
1210 #endif /* SYM_HIPD_H */