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
44 * Generic driver options.
46 * They may be defined in platform specific headers, if they
49 * SYM_OPT_HANDLE_DIR_UNKNOWN
50 * When this option is set, the SCRIPTS used by the driver
51 * are able to handle SCSI transfers with direction not
53 * (set for Linux-2.0.X)
55 * SYM_OPT_HANDLE_DEVICE_QUEUEING
56 * When this option is set, the driver will use a queue per
57 * device and handle QUEUE FULL status requeuing internally.
59 * SYM_OPT_LIMIT_COMMAND_REORDERING
60 * When this option is set, the driver tries to limit tagged
61 * command reordering to some reasonnable value.
65 #define SYM_OPT_HANDLE_DIR_UNKNOWN
66 #define SYM_OPT_HANDLE_DEVICE_QUEUEING
67 #define SYM_OPT_LIMIT_COMMAND_REORDERING
71 * Active debugging tags and verbosity.
72 * Both DEBUG_FLAGS and sym_verbose can be redefined
73 * by the platform specific code to something else.
75 #define DEBUG_ALLOC (0x0001)
76 #define DEBUG_PHASE (0x0002)
77 #define DEBUG_POLL (0x0004)
78 #define DEBUG_QUEUE (0x0008)
79 #define DEBUG_RESULT (0x0010)
80 #define DEBUG_SCATTER (0x0020)
81 #define DEBUG_SCRIPT (0x0040)
82 #define DEBUG_TINY (0x0080)
83 #define DEBUG_TIMING (0x0100)
84 #define DEBUG_NEGO (0x0200)
85 #define DEBUG_TAGS (0x0400)
86 #define DEBUG_POINTER (0x0800)
89 #define DEBUG_FLAGS (0x0000)
93 #define sym_verbose (np->verbose)
97 * These ones should have been already defined.
100 #define assert(expression) { \
101 if (!(expression)) { \
103 "assertion \"%s\" failed: file \"%s\", line %d\n", \
105 __FILE__, __LINE__); \
111 * Number of tasks per device we want to handle.
113 #if SYM_CONF_MAX_TAG_ORDER > 8
114 #error "more than 256 tags per logical unit not allowed."
116 #define SYM_CONF_MAX_TASK (1<<SYM_CONF_MAX_TAG_ORDER)
119 * Donnot use more tasks that we can handle.
121 #ifndef SYM_CONF_MAX_TAG
122 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
124 #if SYM_CONF_MAX_TAG > SYM_CONF_MAX_TASK
125 #undef SYM_CONF_MAX_TAG
126 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
130 * This one means 'NO TAG for this job'
135 * Number of SCSI targets.
137 #if SYM_CONF_MAX_TARGET > 16
138 #error "more than 16 targets not allowed."
142 * Number of logical units per target.
144 #if SYM_CONF_MAX_LUN > 64
145 #error "more than 64 logical units per target not allowed."
149 * Asynchronous pre-scaler (ns). Shall be 40 for
150 * the SCSI timings to be compliant.
152 #define SYM_CONF_MIN_ASYNC (40)
155 * Shortest memory chunk is (1<<SYM_MEM_SHIFT), currently 16.
156 * Actual allocations happen as SYM_MEM_CLUSTER_SIZE sized.
157 * (1 PAGE at a time is just fine).
159 #define SYM_MEM_SHIFT 4
160 #define SYM_MEM_CLUSTER_SIZE (1UL << SYM_MEM_CLUSTER_SHIFT)
161 #define SYM_MEM_CLUSTER_MASK (SYM_MEM_CLUSTER_SIZE-1)
164 * Number of entries in the START and DONE queues.
166 * We limit to 1 PAGE in order to succeed allocation of
167 * these queues. Each entry is 8 bytes long (2 DWORDS).
169 #ifdef SYM_CONF_MAX_START
170 #define SYM_CONF_MAX_QUEUE (SYM_CONF_MAX_START+2)
172 #define SYM_CONF_MAX_QUEUE (7*SYM_CONF_MAX_TASK+2)
173 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
176 #if SYM_CONF_MAX_QUEUE > SYM_MEM_CLUSTER_SIZE/8
177 #undef SYM_CONF_MAX_QUEUE
178 #define SYM_CONF_MAX_QUEUE (SYM_MEM_CLUSTER_SIZE/8)
179 #undef SYM_CONF_MAX_START
180 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
184 * For this one, we want a short name :-)
186 #define MAX_QUEUE SYM_CONF_MAX_QUEUE
189 * Common definitions for both bus space based and legacy IO methods.
191 #define INB(r) INB_OFF(offsetof(struct sym_reg,r))
192 #define INW(r) INW_OFF(offsetof(struct sym_reg,r))
193 #define INL(r) INL_OFF(offsetof(struct sym_reg,r))
195 #define OUTB(r, v) OUTB_OFF(offsetof(struct sym_reg,r), (v))
196 #define OUTW(r, v) OUTW_OFF(offsetof(struct sym_reg,r), (v))
197 #define OUTL(r, v) OUTL_OFF(offsetof(struct sym_reg,r), (v))
199 #define OUTONB(r, m) OUTB(r, INB(r) | (m))
200 #define OUTOFFB(r, m) OUTB(r, INB(r) & ~(m))
201 #define OUTONW(r, m) OUTW(r, INW(r) | (m))
202 #define OUTOFFW(r, m) OUTW(r, INW(r) & ~(m))
203 #define OUTONL(r, m) OUTL(r, INL(r) | (m))
204 #define OUTOFFL(r, m) OUTL(r, INL(r) & ~(m))
207 * We normally want the chip to have a consistent view
208 * of driver internal data structures when we restart it.
211 #define OUTL_DSP(v) \
213 MEMORY_WRITE_BARRIER(); \
214 OUTL (nc_dsp, (v)); \
217 #define OUTONB_STD() \
219 MEMORY_WRITE_BARRIER(); \
220 OUTONB (nc_dcntl, (STD|NOCOM)); \
224 * Command control block states.
228 #define HS_NEGOTIATE (2) /* sync/wide data transfer*/
229 #define HS_DISCONNECT (3) /* Disconnected by target */
230 #define HS_WAIT (4) /* waiting for resource */
232 #define HS_DONEMASK (0x80)
233 #define HS_COMPLETE (4|HS_DONEMASK)
234 #define HS_SEL_TIMEOUT (5|HS_DONEMASK) /* Selection timeout */
235 #define HS_UNEXPECTED (6|HS_DONEMASK) /* Unexpected disconnect */
236 #define HS_COMP_ERR (7|HS_DONEMASK) /* Completed with error */
239 * Software Interrupt Codes
241 #define SIR_BAD_SCSI_STATUS (1)
242 #define SIR_SEL_ATN_NO_MSG_OUT (2)
243 #define SIR_MSG_RECEIVED (3)
244 #define SIR_MSG_WEIRD (4)
245 #define SIR_NEGO_FAILED (5)
246 #define SIR_NEGO_PROTO (6)
247 #define SIR_SCRIPT_STOPPED (7)
248 #define SIR_REJECT_TO_SEND (8)
249 #define SIR_SWIDE_OVERRUN (9)
250 #define SIR_SODL_UNDERRUN (10)
251 #define SIR_RESEL_NO_MSG_IN (11)
252 #define SIR_RESEL_NO_IDENTIFY (12)
253 #define SIR_RESEL_BAD_LUN (13)
254 #define SIR_TARGET_SELECTED (14)
255 #define SIR_RESEL_BAD_I_T_L (15)
256 #define SIR_RESEL_BAD_I_T_L_Q (16)
257 #define SIR_ABORT_SENT (17)
258 #define SIR_RESEL_ABORTED (18)
259 #define SIR_MSG_OUT_DONE (19)
260 #define SIR_COMPLETE_ERROR (20)
261 #define SIR_DATA_OVERRUN (21)
262 #define SIR_BAD_PHASE (22)
263 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
264 #define SIR_DMAP_DIRTY (23)
271 * Extended error bit codes.
272 * xerr_status field of struct sym_ccb.
274 #define XE_EXTRA_DATA (1) /* unexpected data phase */
275 #define XE_BAD_PHASE (1<<1) /* illegal phase (4/5) */
276 #define XE_PARITY_ERR (1<<2) /* unrecovered SCSI parity error */
277 #define XE_SODL_UNRUN (1<<3) /* ODD transfer in DATA OUT phase */
278 #define XE_SWIDE_OVRUN (1<<4) /* ODD transfer in DATA IN phase */
281 * Negotiation status.
282 * nego_status field of struct sym_ccb.
289 * A CCB hashed table is used to retrieve CCB address
292 #define CCB_HASH_SHIFT 8
293 #define CCB_HASH_SIZE (1UL << CCB_HASH_SHIFT)
294 #define CCB_HASH_MASK (CCB_HASH_SIZE-1)
296 #define CCB_HASH_CODE(dsa) \
297 (((dsa) >> (_LGRU16_(sizeof(struct sym_ccb)))) & CCB_HASH_MASK)
299 #define CCB_HASH_CODE(dsa) (((dsa) >> 9) & CCB_HASH_MASK)
302 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
304 * We may want to use segment registers for 64 bit DMA.
305 * 16 segments registers -> up to 64 GB addressable.
307 #define SYM_DMAP_SHIFT (4)
308 #define SYM_DMAP_SIZE (1u<<SYM_DMAP_SHIFT)
309 #define SYM_DMAP_MASK (SYM_DMAP_SIZE-1)
315 #define SYM_DISC_ENABLED (1)
316 #define SYM_TAGS_ENABLED (1<<1)
317 #define SYM_SCAN_BOOT_DISABLED (1<<2)
318 #define SYM_SCAN_LUNS_DISABLED (1<<3)
321 * Host adapter miscellaneous flags.
323 #define SYM_AVOID_BUS_RESET (1)
324 #define SYM_SCAN_TARGETS_HILO (1<<1)
329 #define SYM_SNOOP_TIMEOUT (10000000)
334 * Gather negotiable parameters value
342 u8 options; /* PPR options */
346 struct sym_trans curr;
347 struct sym_trans goal;
348 #ifdef SYM_OPT_ANNOUNCE_TRANSFER_RATE
349 struct sym_trans prev;
356 * Due to lack of indirect addressing on earlier NCR chips,
357 * this substructure is copied from the TCB to a global
358 * address after selection.
359 * For SYMBIOS chips that support LOAD/STORE this copy is
360 * not needed and thus not performed.
364 * Scripts bus addresses of LUN table accessed from scripts.
365 * LUN #0 is a special case, since multi-lun devices are rare,
366 * and we we want to speed-up the general case and not waste
369 u32 luntbl_sa; /* bus address of this table */
370 u32 lun0_sa; /* bus address of LCB #0 */
372 * Actual SYNC/WIDE IO registers value for this target.
373 * 'sval', 'wval' and 'uval' are read from SCRIPTS and
374 * so have alignment constraints.
376 /*0*/ u_char uval; /* -> SCNTL4 register */
377 /*1*/ u_char sval; /* -> SXFER io register */
378 /*2*/ u_char filler1;
379 /*3*/ u_char wval; /* -> SCNTL3 io register */
383 * Target Control Block
388 * Assumed at offset 0.
390 /*0*/ struct sym_tcbh head;
393 * LUN table used by the SCRIPTS processor.
394 * An array of bus addresses is used on reselection.
396 u32 *luntbl; /* LCBs bus address table */
399 * LUN table used by the C code.
401 lcb_p lun0p; /* LCB of LUN #0 (usual case) */
402 #if SYM_CONF_MAX_LUN > 1
403 lcb_p *lunmp; /* Other LCBs [1..MAX_LUN] */
407 * Bitmap that tells about LUNs that succeeded at least
408 * 1 IO and therefore assumed to be a real device.
409 * Avoid useless allocation of the LCB structure.
411 u32 lun_map[(SYM_CONF_MAX_LUN+31)/32];
414 * Bitmap that tells about LUNs that haven't yet an LCB
415 * allocated (not discovered or LCB allocation failed).
417 u32 busy0_map[(SYM_CONF_MAX_LUN+31)/32];
421 * O/S specific data structure.
427 * Transfer capabilities (SIP)
429 struct sym_tinfo tinfo;
432 * Keep track of the CCB used for the negotiation in order
433 * to ensure that only 1 negotiation is queued at a time.
435 ccb_p nego_cp; /* CCB used for the nego */
438 * Set when we want to reset the device.
443 * Other user settable limits and options.
444 * These limits are read from the NVRAM if present.
448 struct scsi_device *sdev;
454 * Due to lack of indirect addressing on earlier NCR chips,
455 * this substructure is copied from the LCB to a global
456 * address after selection.
457 * For SYMBIOS chips that support LOAD/STORE this copy is
458 * not needed and thus not performed.
462 * SCRIPTS address jumped by SCRIPTS on reselection.
463 * For not probed logical units, this address points to
464 * SCRIPTS that deal with bad LU handling (must be at
465 * offset zero of the LCB for that reason).
470 * Task (bus address of a CCB) read from SCRIPTS that points
471 * to the unique ITL nexus allowed to be disconnected.
476 * Task table bus address (read from SCRIPTS).
482 * Logical Unit Control Block
487 * Assumed at offset 0.
489 /*0*/ struct sym_lcbh head;
492 * Task table read from SCRIPTS that contains pointers to
493 * ITLQ nexuses. The bus address read from SCRIPTS is
496 u32 *itlq_tbl; /* Kernel virtual address */
499 * Busy CCBs management.
501 u_short busy_itlq; /* Number of busy tagged CCBs */
502 u_short busy_itl; /* Number of busy untagged CCBs */
505 * Circular tag allocation buffer.
507 u_short ia_tag; /* Tag allocation index */
508 u_short if_tag; /* Tag release index */
509 u_char *cb_tags; /* Circular tags buffer */
512 * O/S specific data structure.
518 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
520 * Optionnaly the driver can handle device queueing,
521 * and requeues internally command to redo.
528 u_short started_tags;
529 u_short started_no_tag;
531 u_short started_limit;
534 #ifdef SYM_OPT_LIMIT_COMMAND_REORDERING
536 * Optionnaly the driver can try to prevent SCSI
537 * IOs from being too much reordering.
539 u_char tags_si; /* Current index to tags sum */
540 u_short tags_sum[2]; /* Tags sum counters */
541 u_short tags_since; /* # of tags since last switch */
545 * Set when we want to clear all tasks.
557 * Action from SCRIPTS on a task.
558 * Is part of the CCB, but is also used separately to plug
559 * error handling action to perform from SCRIPTS.
562 u32 start; /* Jumped by SCRIPTS after selection */
563 u32 restart; /* Jumped by SCRIPTS on relection */
567 * Phase mismatch context.
569 * It is part of the CCB and is used as parameters for the
570 * DATA pointer. We need two contexts to handle correctly the
571 * SAVED DATA POINTER.
574 struct sym_tblmove sg; /* Updated interrupted SG block */
575 u32 ret; /* SCRIPT return address */
579 * LUN control block lookup.
580 * We use a direct pointer for LUN #0, and a table of
581 * pointers which is only allocated for devices that support
584 #if SYM_CONF_MAX_LUN <= 1
585 #define sym_lp(np, tp, lun) (!lun) ? (tp)->lun0p : NULL
587 #define sym_lp(np, tp, lun) \
588 (!lun) ? (tp)->lun0p : (tp)->lunmp ? (tp)->lunmp[(lun)] : NULL
592 * Status are used by the host and the script processor.
594 * The last four bytes (status[4]) are copied to the
595 * scratchb register (declared as scr0..scr3) just after the
596 * select/reselect, and copied back just after disconnecting.
597 * Inside the script the XX_REG are used.
601 * Last four bytes (script)
604 #define HX_PRT nc_scr0
606 #define HS_PRT nc_scr1
608 #define SS_PRT nc_scr2
610 #define HF_PRT nc_scr3
613 * Last four bytes (host)
615 #define host_xflags phys.head.status[0]
616 #define host_status phys.head.status[1]
617 #define ssss_status phys.head.status[2]
618 #define host_flags phys.head.status[3]
624 #define HF_IN_PM1 (1u<<1)
625 #define HF_ACT_PM (1u<<2)
626 #define HF_DP_SAVED (1u<<3)
627 #define HF_SENSE (1u<<4)
628 #define HF_EXT_ERR (1u<<5)
629 #define HF_DATA_IN (1u<<6)
630 #ifdef SYM_CONF_IARB_SUPPORT
631 #define HF_HINT_IARB (1u<<7)
637 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
638 #define HX_DMAP_DIRTY (1u<<7)
644 * Due to lack of indirect addressing on earlier NCR chips,
645 * this substructure is copied from the ccb to a global
646 * address after selection (or reselection) and copied back
648 * For SYMBIOS chips that support LOAD/STORE this copy is
649 * not needed and thus not performed.
654 * Start and restart SCRIPTS addresses (must be at 0).
656 /*0*/ struct sym_actscr go;
659 * SCRIPTS jump address that deal with data pointers.
660 * 'savep' points to the position in the script responsible
661 * for the actual transfer of data.
662 * It's written on reception of a SAVE_DATA_POINTER message.
664 u32 savep; /* Jump address to saved data pointer */
665 u32 lastp; /* SCRIPTS address at end of data */
666 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
677 * GET/SET the value of the data pointer used by SCRIPTS.
679 * We must distinguish between the LOAD/STORE-based SCRIPTS
680 * that use directly the header in the CCB, and the NCR-GENERIC
681 * SCRIPTS that use the copy of the header in the HCB.
683 #if SYM_CONF_GENERIC_SUPPORT
684 #define sym_set_script_dp(np, cp, dp) \
686 if (np->features & FE_LDSTR) \
687 cp->phys.head.lastp = cpu_to_scr(dp); \
689 np->ccb_head.lastp = cpu_to_scr(dp); \
691 #define sym_get_script_dp(np, cp) \
692 scr_to_cpu((np->features & FE_LDSTR) ? \
693 cp->phys.head.lastp : np->ccb_head.lastp)
695 #define sym_set_script_dp(np, cp, dp) \
697 cp->phys.head.lastp = cpu_to_scr(dp); \
700 #define sym_get_script_dp(np, cp) (cp->phys.head.lastp)
704 * Data Structure Block
706 * During execution of a ccb by the script processor, the
707 * DSA (data structure address) register points to this
708 * substructure of the ccb.
713 * Also assumed at offset 0 of the sym_ccb structure.
715 /*0*/ struct sym_ccbh head;
718 * Phase mismatch contexts.
719 * We need two to handle correctly the SAVED DATA POINTER.
720 * MUST BOTH BE AT OFFSET < 256, due to using 8 bit arithmetic
721 * for address calculation from SCRIPTS.
727 * Table data for Script
729 struct sym_tblsel select;
730 struct sym_tblmove smsg;
731 struct sym_tblmove smsg_ext;
732 struct sym_tblmove cmd;
733 struct sym_tblmove sense;
734 struct sym_tblmove wresid;
735 struct sym_tblmove data [SYM_CONF_MAX_SG];
739 * Our Command Control Block
743 * This is the data structure which is pointed by the DSA
744 * register when it is executed by the script processor.
745 * It must be the first entry.
750 * Pointer to CAM ccb and related stuff.
752 cam_ccb_p cam_ccb; /* CAM scsiio ccb */
753 u8 cdb_buf[16]; /* Copy of CDB */
754 u8 *sns_bbuf; /* Bounce buffer for sense data */
755 #ifndef SYM_SNS_BBUF_LEN
756 #define SYM_SNS_BBUF_LEN (32)
758 int data_len; /* Total data length */
759 int segments; /* Number of SG segments */
761 u8 order; /* Tag type (if tagged command) */
764 * Miscellaneous status'.
766 u_char nego_status; /* Negotiation status */
767 u_char xerr_status; /* Extended error flags */
768 u32 extra_bytes; /* Extraneous bytes transferred */
772 * We prepare a message to be sent after selection.
773 * We may use a second one if the command is rescheduled
774 * due to CHECK_CONDITION or COMMAND TERMINATED.
775 * Contents are IDENTIFY and SIMPLE_TAG.
776 * While negotiating sync or wide transfer,
777 * a SDTR or WDTR message is appended.
779 u_char scsi_smsg [12];
780 u_char scsi_smsg2[12];
783 * Auto request sense related fields.
785 u_char sensecmd[6]; /* Request Sense command */
786 u_char sv_scsi_status; /* Saved SCSI status */
787 u_char sv_xerr_status; /* Saved extended status */
788 int sv_resid; /* Saved residual */
791 * O/S specific data structure.
799 #ifdef SYM_OPT_HANDLE_IO_TIMEOUT
800 SYM_QUEHEAD tmo_linkq; /* Optional timeout handling */
801 u_int tmo_clock; /* (link and dealine value) */
803 u32 ccb_ba; /* BUS address of this CCB */
804 u_short tag; /* Tag for this transfer */
805 /* NO_TAG means no tag */
808 ccb_p link_ccbh; /* Host adapter CCB hash chain */
810 link_ccbq; /* Link to free/busy CCB queue */
811 u32 startp; /* Initial data pointer */
812 u32 goalp; /* Expected last data pointer */
813 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
816 int ext_sg; /* Extreme data pointer, used */
817 int ext_ofs; /* to calculate the residual. */
818 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
820 link2_ccbq; /* Link for device queueing */
821 u_char started; /* CCB queued to the squeue */
823 u_char to_abort; /* Want this IO to be aborted */
824 #ifdef SYM_OPT_LIMIT_COMMAND_REORDERING
825 u_char tags_si; /* Lun tags sum index (0,1) */
829 #define CCB_BA(cp,lbl) (cp->ccb_ba + offsetof(struct sym_ccb, lbl))
831 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
832 #define sym_goalp(cp) ((cp->host_flags & HF_DATA_IN) ? cp->goalp : cp->wgoalp)
834 #define sym_goalp(cp) (cp->goalp)
843 * Due to poorness of addressing capabilities, earlier
844 * chips (810, 815, 825) copy part of the data structures
845 * (CCB, TCB and LCB) in fixed areas.
847 #if SYM_CONF_GENERIC_SUPPORT
848 struct sym_ccbh ccb_head;
849 struct sym_tcbh tcb_head;
850 struct sym_lcbh lcb_head;
853 * Idle task and invalid task actions and
854 * their bus addresses.
856 struct sym_actscr idletask, notask, bad_itl, bad_itlq;
857 u32 idletask_ba, notask_ba, bad_itl_ba, bad_itlq_ba;
860 * Dummy lun table to protect us against target
861 * returning bad lun number on reselection.
863 u32 *badluntbl; /* Table physical address */
864 u32 badlun_sa; /* SCRIPT handler BUS address */
867 * Bus address of this host control block.
872 * Bit 32-63 of the on-chip RAM bus address in LE format.
873 * The START_RAM64 script loads the MMRS and MMWS from this
879 * Initial value of some IO register bits.
880 * These values are assumed to have been set by BIOS, and may
881 * be used to probe adapter implementation differences.
883 u_char sv_scntl0, sv_scntl3, sv_dmode, sv_dcntl, sv_ctest3, sv_ctest4,
884 sv_ctest5, sv_gpcntl, sv_stest2, sv_stest4, sv_scntl4,
888 * Actual initial value of IO register bits used by the
889 * driver. They are loaded at initialisation according to
890 * features that are to be enabled/disabled.
892 u_char rv_scntl0, rv_scntl3, rv_dmode, rv_dcntl, rv_ctest3, rv_ctest4,
893 rv_ctest5, rv_stest2, rv_ccntl0, rv_ccntl1, rv_scntl4;
898 struct sym_tcb target[SYM_CONF_MAX_TARGET];
901 * Target control block bus address array used by the SCRIPT
908 * DMA pool handle for this HBA.
910 m_pool_ident_t bus_dmat;
913 * O/S specific data structure
918 * Physical bus addresses of the chip.
920 u32 mmio_ba; /* MMIO 32 bit BUS address */
921 int mmio_ws; /* MMIO Window size */
923 u32 ram_ba; /* RAM 32 bit BUS address */
924 int ram_ws; /* RAM window size */
927 * SCRIPTS virtual and physical bus addresses.
928 * 'script' is loaded in the on-chip RAM if present.
929 * 'scripth' stays in main memory for all chips except the
930 * 53C895A, 53C896 and 53C1010 that provide 8K on-chip RAM.
932 u_char *scripta0; /* Copy of scripts A, B, Z */
935 u32 scripta_ba; /* Actual scripts A, B, Z */
936 u32 scriptb_ba; /* 32 bit bus addresses. */
938 u_short scripta_sz; /* Actual size of script A, B, Z*/
943 * Bus addresses, setup and patch methods for
944 * the selected firmware.
946 struct sym_fwa_ba fwa_bas; /* Useful SCRIPTA bus addresses */
947 struct sym_fwb_ba fwb_bas; /* Useful SCRIPTB bus addresses */
948 struct sym_fwz_ba fwz_bas; /* Useful SCRIPTZ bus addresses */
949 void (*fw_setup)(hcb_p np, struct sym_fw *fw);
950 void (*fw_patch)(hcb_p np);
954 * General controller parameters and configuration.
956 u_short device_id; /* PCI device id */
957 u_char revision_id; /* PCI device revision id */
958 u_int features; /* Chip features map */
959 u_char myaddr; /* SCSI id of the adapter */
960 u_char maxburst; /* log base 2 of dwords burst */
961 u_char maxwide; /* Maximum transfer width */
962 u_char minsync; /* Min sync period factor (ST) */
963 u_char maxsync; /* Max sync period factor (ST) */
964 u_char maxoffs; /* Max scsi offset (ST) */
965 u_char minsync_dt; /* Min sync period factor (DT) */
966 u_char maxsync_dt; /* Max sync period factor (DT) */
967 u_char maxoffs_dt; /* Max scsi offset (DT) */
968 u_char multiplier; /* Clock multiplier (1,2,4) */
969 u_char clock_divn; /* Number of clock divisors */
970 u32 clock_khz; /* SCSI clock frequency in KHz */
971 u32 pciclk_khz; /* Estimated PCI clock in KHz */
973 * Start queue management.
974 * It is filled up by the host processor and accessed by the
975 * SCRIPTS processor in order to start SCSI commands.
977 volatile /* Prevent code optimizations */
978 u32 *squeue; /* Start queue virtual address */
979 u32 squeue_ba; /* Start queue BUS address */
980 u_short squeueput; /* Next free slot of the queue */
981 u_short actccbs; /* Number of allocated CCBs */
984 * Command completion queue.
985 * It is the same size as the start queue to avoid overflow.
987 u_short dqueueget; /* Next position to scan */
988 volatile /* Prevent code optimizations */
989 u32 *dqueue; /* Completion (done) queue */
990 u32 dqueue_ba; /* Done queue BUS address */
993 * Miscellaneous buffers accessed by the scripts-processor.
994 * They shall be DWORD aligned, because they may be read or
995 * written with a script command.
997 u_char msgout[8]; /* Buffer for MESSAGE OUT */
998 u_char msgin [8]; /* Buffer for MESSAGE IN */
999 u32 lastmsg; /* Last SCSI message sent */
1000 u32 scratch; /* Scratch for SCSI receive */
1001 /* Also used for cache test */
1003 * Miscellaneous configuration and status parameters.
1005 u_char usrflags; /* Miscellaneous user flags */
1006 u_char scsi_mode; /* Current SCSI BUS mode */
1007 u_char verbose; /* Verbosity for this controller*/
1010 * CCB lists and queue.
1012 ccb_p *ccbh; /* CCBs hashed by DSA value */
1013 /* CCB_HASH_SIZE lists of CCBs */
1014 SYM_QUEHEAD free_ccbq; /* Queue of available CCBs */
1015 SYM_QUEHEAD busy_ccbq; /* Queue of busy CCBs */
1018 * During error handling and/or recovery,
1019 * active CCBs that are to be completed with
1020 * error or requeued are moved from the busy_ccbq
1021 * to the comp_ccbq prior to completion.
1023 SYM_QUEHEAD comp_ccbq;
1025 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
1026 SYM_QUEHEAD dummy_ccbq;
1029 * Optional handling of IO timeouts.
1031 #ifdef SYM_OPT_HANDLE_IO_TIMEOUT
1032 SYM_QUEHEAD tmo0_ccbq;
1033 SYM_QUEHEAD *tmo_ccbq; /* [2*SYM_TIMEOUT_ORDER_MAX] */
1039 * IMMEDIATE ARBITRATION (IARB) control.
1041 * We keep track in 'last_cp' of the last CCB that has been
1042 * queued to the SCRIPTS processor and clear 'last_cp' when
1043 * this CCB completes. If last_cp is not zero at the moment
1044 * we queue a new CCB, we set a flag in 'last_cp' that is
1045 * used by the SCRIPTS as a hint for setting IARB.
1046 * We donnot set more than 'iarb_max' consecutive hints for
1047 * IARB in order to leave devices a chance to reselect.
1048 * By the way, any non zero value of 'iarb_max' is unfair. :)
1050 #ifdef SYM_CONF_IARB_SUPPORT
1051 u_short iarb_max; /* Max. # consecutive IARB hints*/
1052 u_short iarb_count; /* Actual # of these hints */
1057 * Command abort handling.
1058 * We need to synchronize tightly with the SCRIPTS
1059 * processor in order to handle things correctly.
1061 u_char abrt_msg[4]; /* Message to send buffer */
1062 struct sym_tblmove abrt_tbl; /* Table for the MOV of it */
1063 struct sym_tblsel abrt_sel; /* Sync params for selection */
1064 u_char istat_sem; /* Tells the chip to stop (SEM) */
1067 * 64 bit DMA handling.
1069 #if SYM_CONF_DMA_ADDRESSING_MODE != 0
1070 u_char use_dac; /* Use PCI DAC cycles */
1071 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
1072 u_char dmap_dirty; /* Dma segments registers dirty */
1073 u32 dmap_bah[SYM_DMAP_SIZE];/* Segment registers map */
1078 #define HCB_BA(np, lbl) (np->hcb_ba + offsetof(struct sym_hcb, lbl))
1082 * FIRMWARES (sym_fw.c)
1084 struct sym_fw * sym_find_firmware(struct sym_pci_chip *chip);
1085 void sym_fw_bind_script (hcb_p np, u32 *start, int len);
1088 * Driver methods called from O/S specific code.
1090 char *sym_driver_name(void);
1091 void sym_print_xerr(ccb_p cp, int x_status);
1092 int sym_reset_scsi_bus(hcb_p np, int enab_int);
1093 struct sym_pci_chip *
1094 sym_lookup_pci_chip_table (u_short device_id, u_char revision);
1095 void sym_put_start_queue(hcb_p np, ccb_p cp);
1096 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
1097 void sym_start_next_ccbs(hcb_p np, lcb_p lp, int maxn);
1099 void sym_start_up (hcb_p np, int reason);
1100 void sym_interrupt (hcb_p np);
1101 void sym_flush_comp_queue(hcb_p np, int cam_status);
1102 int sym_clear_tasks(hcb_p np, int cam_status, int target, int lun, int task);
1103 ccb_p sym_get_ccb (hcb_p np, u_char tn, u_char ln, u_char tag_order);
1104 void sym_free_ccb (hcb_p np, ccb_p cp);
1105 lcb_p sym_alloc_lcb (hcb_p np, u_char tn, u_char ln);
1106 int sym_queue_scsiio(hcb_p np, cam_scsiio_p csio, ccb_p cp);
1107 int sym_abort_scsiio(hcb_p np, cam_ccb_p ccb, int timed_out);
1108 int sym_abort_ccb(hcb_p np, ccb_p cp, int timed_out);
1109 int sym_reset_scsi_target(hcb_p np, int target);
1110 void sym_hcb_free(hcb_p np);
1111 int sym_hcb_attach(hcb_p np, struct sym_fw *fw, struct sym_nvram *nvram);
1114 * Optionnaly, the driver may handle IO timeouts.
1116 #ifdef SYM_OPT_HANDLE_IO_TIMEOUT
1117 int sym_abort_ccb(hcb_p np, ccb_p cp, int timed_out);
1118 void sym_timeout_ccb(hcb_p np, ccb_p cp, u_int ticks);
1119 static void __inline sym_untimeout_ccb(hcb_p np, ccb_p cp)
1121 sym_remque(&cp->tmo_linkq);
1122 sym_insque_head(&cp->tmo_linkq, &np->tmo0_ccbq);
1124 void sym_clock(hcb_p np);
1125 #endif /* SYM_OPT_HANDLE_IO_TIMEOUT */
1128 * Optionnaly, the driver may provide a function
1129 * to announce transfer rate changes.
1131 #ifdef SYM_OPT_ANNOUNCE_TRANSFER_RATE
1132 void sym_announce_transfer_rate(hcb_p np, int target);
1136 * Build a scatter/gather entry.
1138 * For 64 bit systems, we use the 8 upper bits of the size field
1139 * to provide bus address bits 32-39 to the SCRIPTS processor.
1140 * This allows the 895A, 896, 1010 to address up to 1 TB of memory.
1143 #if SYM_CONF_DMA_ADDRESSING_MODE == 0
1144 #define sym_build_sge(np, data, badd, len) \
1146 (data)->addr = cpu_to_scr(badd); \
1147 (data)->size = cpu_to_scr(len); \
1149 #elif SYM_CONF_DMA_ADDRESSING_MODE == 1
1150 #define sym_build_sge(np, data, badd, len) \
1152 (data)->addr = cpu_to_scr(badd); \
1153 (data)->size = cpu_to_scr((((badd) >> 8) & 0xff000000) + len); \
1155 #elif SYM_CONF_DMA_ADDRESSING_MODE == 2
1156 int sym_lookup_dmap(hcb_p np, u32 h, int s);
1157 static __inline void
1158 sym_build_sge(hcb_p np, struct sym_tblmove *data, u64 badd, int len)
1161 int s = (h&SYM_DMAP_MASK);
1163 if (h != np->dmap_bah[s])
1166 (data)->addr = cpu_to_scr(badd);
1167 (data)->size = cpu_to_scr((s<<24) + len);
1170 s = sym_lookup_dmap(np, h, s);
1174 #error "Unsupported DMA addressing mode"
1178 * Set up data pointers used by SCRIPTS.
1179 * Called from O/S specific code.
1181 static inline void sym_setup_data_pointers(struct sym_hcb *np,
1182 struct sym_ccb *cp, int dir)
1187 * No segments means no data.
1193 * Set the data pointer.
1196 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1197 case CAM_DIR_UNKNOWN:
1200 goalp = SCRIPTA_BA (np, data_out2) + 8;
1201 lastp = goalp - 8 - (cp->segments * (2*4));
1202 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1203 cp->wgoalp = cpu_to_scr(goalp);
1204 if (dir != CAM_DIR_UNKNOWN)
1206 cp->phys.head.wlastp = cpu_to_scr(lastp);
1212 cp->host_flags |= HF_DATA_IN;
1213 goalp = SCRIPTA_BA (np, data_in2) + 8;
1214 lastp = goalp - 8 - (cp->segments * (2*4));
1218 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1219 cp->host_flags |= HF_DATA_IN;
1221 lastp = goalp = SCRIPTB_BA (np, no_data);
1226 * Set all pointers values needed by SCRIPTS.
1228 cp->phys.head.lastp = cpu_to_scr(lastp);
1229 cp->phys.head.savep = cpu_to_scr(lastp);
1230 cp->startp = cp->phys.head.savep;
1231 cp->goalp = cpu_to_scr(goalp);
1233 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1235 * If direction is unknown, start at data_io.
1237 if (dir == CAM_DIR_UNKNOWN)
1238 cp->phys.head.savep = cpu_to_scr(SCRIPTB_BA (np, data_io));
1247 * Link between free memory chunks of a given size.
1249 typedef struct sym_m_link {
1250 struct sym_m_link *next;
1254 * Virtual to bus physical translation for a given cluster.
1255 * Such a structure is only useful with DMA abstraction.
1257 typedef struct sym_m_vtob { /* Virtual to Bus address translation */
1258 struct sym_m_vtob *next;
1259 #ifdef SYM_HAVE_M_SVTOB
1260 struct sym_m_svtob s; /* OS specific data structure */
1262 m_addr_t vaddr; /* Virtual address */
1263 m_addr_t baddr; /* Bus physical address */
1266 /* Hash this stuff a bit to speed up translations */
1267 #define VTOB_HASH_SHIFT 5
1268 #define VTOB_HASH_SIZE (1UL << VTOB_HASH_SHIFT)
1269 #define VTOB_HASH_MASK (VTOB_HASH_SIZE-1)
1270 #define VTOB_HASH_CODE(m) \
1271 ((((m_addr_t) (m)) >> SYM_MEM_CLUSTER_SHIFT) & VTOB_HASH_MASK)
1274 * Memory pool of a given kind.
1275 * Ideally, we want to use:
1276 * 1) 1 pool for memory we donnot need to involve in DMA.
1277 * 2) The same pool for controllers that require same DMA
1278 * constraints and features.
1279 * The OS specific m_pool_id_t thing and the sym_m_pool_match()
1280 * method are expected to tell the driver about.
1282 typedef struct sym_m_pool {
1283 m_pool_ident_t dev_dmat; /* Identifies the pool (see above) */
1284 m_addr_t (*get_mem_cluster)(struct sym_m_pool *);
1285 #ifdef SYM_MEM_FREE_UNUSED
1286 void (*free_mem_cluster)(struct sym_m_pool *, m_addr_t);
1288 #define M_GET_MEM_CLUSTER() mp->get_mem_cluster(mp)
1289 #define M_FREE_MEM_CLUSTER(p) mp->free_mem_cluster(mp, p)
1290 #ifdef SYM_HAVE_M_SPOOL
1291 struct sym_m_spool s; /* OS specific data structure */
1294 m_vtob_p vtob[VTOB_HASH_SIZE];
1295 struct sym_m_pool *next;
1296 struct sym_m_link h[SYM_MEM_CLUSTER_SHIFT - SYM_MEM_SHIFT + 1];
1300 * Alloc and free non DMAable memory.
1302 void sym_mfree_unlocked(void *ptr, int size, char *name);
1303 void *sym_calloc_unlocked(int size, char *name);
1306 * Alloc, free and translate addresses to bus physical
1307 * for DMAable memory.
1309 void *__sym_calloc_dma_unlocked(m_pool_ident_t dev_dmat, int size, char *name);
1311 __sym_mfree_dma_unlocked(m_pool_ident_t dev_dmat, void *m,int size, char *name);
1312 u32 __vtobus_unlocked(m_pool_ident_t dev_dmat, void *m);
1315 * Verbs used by the driver code for DMAable memory handling.
1316 * The _uvptv_ macro avoids a nasty warning about pointer to volatile
1319 #define _uvptv_(p) ((void *)((u_long)(p)))
1321 #define _sym_calloc_dma(np, l, n) __sym_calloc_dma(np->bus_dmat, l, n)
1322 #define _sym_mfree_dma(np, p, l, n) \
1323 __sym_mfree_dma(np->bus_dmat, _uvptv_(p), l, n)
1324 #define sym_calloc_dma(l, n) _sym_calloc_dma(np, l, n)
1325 #define sym_mfree_dma(p, l, n) _sym_mfree_dma(np, p, l, n)
1326 #define _vtobus(np, p) __vtobus(np->bus_dmat, _uvptv_(p))
1327 #define vtobus(p) _vtobus(np, p)
1330 * Override some function names.
1332 #define PRINT_ADDR sym_print_addr
1333 #define PRINT_TARGET sym_print_target
1334 #define PRINT_LUN sym_print_lun
1335 #define UDELAY sym_udelay
1337 #endif /* SYM_HIPD_H */