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_DIR_UNKNOWN
52 * When this option is set, the SCRIPTS used by the driver
53 * are able to handle SCSI transfers with direction not
55 * (set for Linux-2.0.X)
57 * SYM_OPT_HANDLE_DEVICE_QUEUEING
58 * When this option is set, the driver will use a queue per
59 * device and handle QUEUE FULL status requeuing internally.
61 * SYM_OPT_LIMIT_COMMAND_REORDERING
62 * When this option is set, the driver tries to limit tagged
63 * command reordering to some reasonnable value.
67 #define SYM_OPT_HANDLE_DIR_UNKNOWN
68 #define SYM_OPT_HANDLE_DEVICE_QUEUEING
69 #define SYM_OPT_LIMIT_COMMAND_REORDERING
73 * Active debugging tags and verbosity.
74 * Both DEBUG_FLAGS and sym_verbose can be redefined
75 * by the platform specific code to something else.
77 #define DEBUG_ALLOC (0x0001)
78 #define DEBUG_PHASE (0x0002)
79 #define DEBUG_POLL (0x0004)
80 #define DEBUG_QUEUE (0x0008)
81 #define DEBUG_RESULT (0x0010)
82 #define DEBUG_SCATTER (0x0020)
83 #define DEBUG_SCRIPT (0x0040)
84 #define DEBUG_TINY (0x0080)
85 #define DEBUG_TIMING (0x0100)
86 #define DEBUG_NEGO (0x0200)
87 #define DEBUG_TAGS (0x0400)
88 #define DEBUG_POINTER (0x0800)
91 #define DEBUG_FLAGS (0x0000)
95 #define sym_verbose (np->verbose)
99 * These ones should have been already defined.
102 #define assert(expression) { \
103 if (!(expression)) { \
105 "assertion \"%s\" failed: file \"%s\", line %d\n", \
107 __FILE__, __LINE__); \
113 * Number of tasks per device we want to handle.
115 #if SYM_CONF_MAX_TAG_ORDER > 8
116 #error "more than 256 tags per logical unit not allowed."
118 #define SYM_CONF_MAX_TASK (1<<SYM_CONF_MAX_TAG_ORDER)
121 * Donnot use more tasks that we can handle.
123 #ifndef SYM_CONF_MAX_TAG
124 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
126 #if SYM_CONF_MAX_TAG > SYM_CONF_MAX_TASK
127 #undef SYM_CONF_MAX_TAG
128 #define SYM_CONF_MAX_TAG SYM_CONF_MAX_TASK
132 * This one means 'NO TAG for this job'
137 * Number of SCSI targets.
139 #if SYM_CONF_MAX_TARGET > 16
140 #error "more than 16 targets not allowed."
144 * Number of logical units per target.
146 #if SYM_CONF_MAX_LUN > 64
147 #error "more than 64 logical units per target not allowed."
151 * Asynchronous pre-scaler (ns). Shall be 40 for
152 * the SCSI timings to be compliant.
154 #define SYM_CONF_MIN_ASYNC (40)
161 #define SYM_MEM_WARN 1 /* Warn on failed operations */
163 #define SYM_MEM_PAGE_ORDER 0 /* 1 PAGE maximum */
164 #define SYM_MEM_CLUSTER_SHIFT (PAGE_SHIFT+SYM_MEM_PAGE_ORDER)
165 #define SYM_MEM_FREE_UNUSED /* Free unused pages immediately */
167 * Shortest memory chunk is (1<<SYM_MEM_SHIFT), currently 16.
168 * Actual allocations happen as SYM_MEM_CLUSTER_SIZE sized.
169 * (1 PAGE at a time is just fine).
171 #define SYM_MEM_SHIFT 4
172 #define SYM_MEM_CLUSTER_SIZE (1UL << SYM_MEM_CLUSTER_SHIFT)
173 #define SYM_MEM_CLUSTER_MASK (SYM_MEM_CLUSTER_SIZE-1)
176 * Number of entries in the START and DONE queues.
178 * We limit to 1 PAGE in order to succeed allocation of
179 * these queues. Each entry is 8 bytes long (2 DWORDS).
181 #ifdef SYM_CONF_MAX_START
182 #define SYM_CONF_MAX_QUEUE (SYM_CONF_MAX_START+2)
184 #define SYM_CONF_MAX_QUEUE (7*SYM_CONF_MAX_TASK+2)
185 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
188 #if SYM_CONF_MAX_QUEUE > SYM_MEM_CLUSTER_SIZE/8
189 #undef SYM_CONF_MAX_QUEUE
190 #define SYM_CONF_MAX_QUEUE (SYM_MEM_CLUSTER_SIZE/8)
191 #undef SYM_CONF_MAX_START
192 #define SYM_CONF_MAX_START (SYM_CONF_MAX_QUEUE-2)
196 * For this one, we want a short name :-)
198 #define MAX_QUEUE SYM_CONF_MAX_QUEUE
201 * Common definitions for both bus space based and legacy IO methods.
204 #define INB_OFF(np, o) ioread8(np->s.ioaddr + (o))
205 #define INW_OFF(np, o) ioread16(np->s.ioaddr + (o))
206 #define INL_OFF(np, o) ioread32(np->s.ioaddr + (o))
208 #define OUTB_OFF(np, o, val) iowrite8((val), np->s.ioaddr + (o))
209 #define OUTW_OFF(np, o, val) iowrite16((val), np->s.ioaddr + (o))
210 #define OUTL_OFF(np, o, val) iowrite32((val), np->s.ioaddr + (o))
212 #define INB(np, r) INB_OFF(np, offsetof(struct sym_reg, r))
213 #define INW(np, r) INW_OFF(np, offsetof(struct sym_reg, r))
214 #define INL(np, r) INL_OFF(np, offsetof(struct sym_reg, r))
216 #define OUTB(np, r, v) OUTB_OFF(np, offsetof(struct sym_reg, r), (v))
217 #define OUTW(np, r, v) OUTW_OFF(np, offsetof(struct sym_reg, r), (v))
218 #define OUTL(np, r, v) OUTL_OFF(np, offsetof(struct sym_reg, r), (v))
220 #define OUTONB(np, r, m) OUTB(np, r, INB(np, r) | (m))
221 #define OUTOFFB(np, r, m) OUTB(np, r, INB(np, r) & ~(m))
222 #define OUTONW(np, r, m) OUTW(np, r, INW(np, r) | (m))
223 #define OUTOFFW(np, r, m) OUTW(np, r, INW(np, r) & ~(m))
224 #define OUTONL(np, r, m) OUTL(np, r, INL(np, r) | (m))
225 #define OUTOFFL(np, r, m) OUTL(np, r, INL(np, r) & ~(m))
228 * We normally want the chip to have a consistent view
229 * of driver internal data structures when we restart it.
232 #define OUTL_DSP(np, v) \
234 MEMORY_WRITE_BARRIER(); \
235 OUTL(np, nc_dsp, (v)); \
238 #define OUTONB_STD() \
240 MEMORY_WRITE_BARRIER(); \
241 OUTONB(np, nc_dcntl, (STD|NOCOM)); \
245 * Command control block states.
249 #define HS_NEGOTIATE (2) /* sync/wide data transfer*/
250 #define HS_DISCONNECT (3) /* Disconnected by target */
251 #define HS_WAIT (4) /* waiting for resource */
253 #define HS_DONEMASK (0x80)
254 #define HS_COMPLETE (4|HS_DONEMASK)
255 #define HS_SEL_TIMEOUT (5|HS_DONEMASK) /* Selection timeout */
256 #define HS_UNEXPECTED (6|HS_DONEMASK) /* Unexpected disconnect */
257 #define HS_COMP_ERR (7|HS_DONEMASK) /* Completed with error */
260 * Software Interrupt Codes
262 #define SIR_BAD_SCSI_STATUS (1)
263 #define SIR_SEL_ATN_NO_MSG_OUT (2)
264 #define SIR_MSG_RECEIVED (3)
265 #define SIR_MSG_WEIRD (4)
266 #define SIR_NEGO_FAILED (5)
267 #define SIR_NEGO_PROTO (6)
268 #define SIR_SCRIPT_STOPPED (7)
269 #define SIR_REJECT_TO_SEND (8)
270 #define SIR_SWIDE_OVERRUN (9)
271 #define SIR_SODL_UNDERRUN (10)
272 #define SIR_RESEL_NO_MSG_IN (11)
273 #define SIR_RESEL_NO_IDENTIFY (12)
274 #define SIR_RESEL_BAD_LUN (13)
275 #define SIR_TARGET_SELECTED (14)
276 #define SIR_RESEL_BAD_I_T_L (15)
277 #define SIR_RESEL_BAD_I_T_L_Q (16)
278 #define SIR_ABORT_SENT (17)
279 #define SIR_RESEL_ABORTED (18)
280 #define SIR_MSG_OUT_DONE (19)
281 #define SIR_COMPLETE_ERROR (20)
282 #define SIR_DATA_OVERRUN (21)
283 #define SIR_BAD_PHASE (22)
284 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
285 #define SIR_DMAP_DIRTY (23)
292 * Extended error bit codes.
293 * xerr_status field of struct sym_ccb.
295 #define XE_EXTRA_DATA (1) /* unexpected data phase */
296 #define XE_BAD_PHASE (1<<1) /* illegal phase (4/5) */
297 #define XE_PARITY_ERR (1<<2) /* unrecovered SCSI parity error */
298 #define XE_SODL_UNRUN (1<<3) /* ODD transfer in DATA OUT phase */
299 #define XE_SWIDE_OVRUN (1<<4) /* ODD transfer in DATA IN phase */
302 * Negotiation status.
303 * nego_status field of struct sym_ccb.
310 * A CCB hashed table is used to retrieve CCB address
313 #define CCB_HASH_SHIFT 8
314 #define CCB_HASH_SIZE (1UL << CCB_HASH_SHIFT)
315 #define CCB_HASH_MASK (CCB_HASH_SIZE-1)
317 #define CCB_HASH_CODE(dsa) \
318 (((dsa) >> (_LGRU16_(sizeof(struct sym_ccb)))) & CCB_HASH_MASK)
320 #define CCB_HASH_CODE(dsa) (((dsa) >> 9) & CCB_HASH_MASK)
323 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
325 * We may want to use segment registers for 64 bit DMA.
326 * 16 segments registers -> up to 64 GB addressable.
328 #define SYM_DMAP_SHIFT (4)
329 #define SYM_DMAP_SIZE (1u<<SYM_DMAP_SHIFT)
330 #define SYM_DMAP_MASK (SYM_DMAP_SIZE-1)
336 #define SYM_DISC_ENABLED (1)
337 #define SYM_TAGS_ENABLED (1<<1)
338 #define SYM_SCAN_BOOT_DISABLED (1<<2)
339 #define SYM_SCAN_LUNS_DISABLED (1<<3)
342 * Host adapter miscellaneous flags.
344 #define SYM_AVOID_BUS_RESET (1)
349 #define SYM_SNOOP_TIMEOUT (10000000)
354 * Gather negotiable parameters value
359 unsigned int width:1;
363 unsigned int check_nego:1;
369 * Due to lack of indirect addressing on earlier NCR chips,
370 * this substructure is copied from the TCB to a global
371 * address after selection.
372 * For SYMBIOS chips that support LOAD/STORE this copy is
373 * not needed and thus not performed.
377 * Scripts bus addresses of LUN table accessed from scripts.
378 * LUN #0 is a special case, since multi-lun devices are rare,
379 * and we we want to speed-up the general case and not waste
382 u32 luntbl_sa; /* bus address of this table */
383 u32 lun0_sa; /* bus address of LCB #0 */
385 * Actual SYNC/WIDE IO registers value for this target.
386 * 'sval', 'wval' and 'uval' are read from SCRIPTS and
387 * so have alignment constraints.
389 /*0*/ u_char uval; /* -> SCNTL4 register */
390 /*1*/ u_char sval; /* -> SXFER io register */
391 /*2*/ u_char filler1;
392 /*3*/ u_char wval; /* -> SCNTL3 io register */
396 * Target Control Block
401 * Assumed at offset 0.
403 /*0*/ struct sym_tcbh head;
406 * LUN table used by the SCRIPTS processor.
407 * An array of bus addresses is used on reselection.
409 u32 *luntbl; /* LCBs bus address table */
412 * LUN table used by the C code.
414 struct sym_lcb *lun0p; /* LCB of LUN #0 (usual case) */
415 #if SYM_CONF_MAX_LUN > 1
416 struct sym_lcb **lunmp; /* Other LCBs [1..MAX_LUN] */
421 * O/S specific data structure.
427 struct sym_trans tgoal;
430 * Keep track of the CCB used for the negotiation in order
431 * to ensure that only 1 negotiation is queued at a time.
433 struct sym_ccb * nego_cp; /* CCB used for the nego */
436 * Set when we want to reset the device.
441 * Other user settable limits and options.
442 * These limits are read from the NVRAM if present.
446 struct scsi_target *starget;
452 * Due to lack of indirect addressing on earlier NCR chips,
453 * this substructure is copied from the LCB to a global
454 * address after selection.
455 * For SYMBIOS chips that support LOAD/STORE this copy is
456 * not needed and thus not performed.
460 * SCRIPTS address jumped by SCRIPTS on reselection.
461 * For not probed logical units, this address points to
462 * SCRIPTS that deal with bad LU handling (must be at
463 * offset zero of the LCB for that reason).
468 * Task (bus address of a CCB) read from SCRIPTS that points
469 * to the unique ITL nexus allowed to be disconnected.
474 * Task table bus address (read from SCRIPTS).
480 * Logical Unit Control Block
485 * Assumed at offset 0.
487 /*0*/ struct sym_lcbh head;
490 * Task table read from SCRIPTS that contains pointers to
491 * ITLQ nexuses. The bus address read from SCRIPTS is
494 u32 *itlq_tbl; /* Kernel virtual address */
497 * Busy CCBs management.
499 u_short busy_itlq; /* Number of busy tagged CCBs */
500 u_short busy_itl; /* Number of busy untagged CCBs */
503 * Circular tag allocation buffer.
505 u_short ia_tag; /* Tag allocation index */
506 u_short if_tag; /* Tag release index */
507 u_char *cb_tags; /* Circular tags buffer */
510 * O/S specific data structure.
516 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
518 * Optionnaly the driver can handle device queueing,
519 * and requeues internally command to redo.
521 SYM_QUEHEAD waiting_ccbq;
522 SYM_QUEHEAD started_ccbq;
524 u_short started_tags;
525 u_short started_no_tag;
527 u_short started_limit;
530 #ifdef SYM_OPT_LIMIT_COMMAND_REORDERING
532 * Optionally the driver can try to prevent SCSI
533 * IOs from being reordered too much.
535 u_char tags_si; /* Current index to tags sum */
536 u_short tags_sum[2]; /* Tags sum counters */
537 u_short tags_since; /* # of tags since last switch */
541 * Set when we want to clear all tasks.
553 * Action from SCRIPTS on a task.
554 * Is part of the CCB, but is also used separately to plug
555 * error handling action to perform from SCRIPTS.
558 u32 start; /* Jumped by SCRIPTS after selection */
559 u32 restart; /* Jumped by SCRIPTS on relection */
563 * Phase mismatch context.
565 * It is part of the CCB and is used as parameters for the
566 * DATA pointer. We need two contexts to handle correctly the
567 * SAVED DATA POINTER.
570 struct sym_tblmove sg; /* Updated interrupted SG block */
571 u32 ret; /* SCRIPT return address */
575 * LUN control block lookup.
576 * We use a direct pointer for LUN #0, and a table of
577 * pointers which is only allocated for devices that support
580 #if SYM_CONF_MAX_LUN <= 1
581 #define sym_lp(tp, lun) (!lun) ? (tp)->lun0p : NULL
583 #define sym_lp(tp, lun) \
584 (!lun) ? (tp)->lun0p : (tp)->lunmp ? (tp)->lunmp[(lun)] : NULL
588 * Status are used by the host and the script processor.
590 * The last four bytes (status[4]) are copied to the
591 * scratchb register (declared as scr0..scr3) just after the
592 * select/reselect, and copied back just after disconnecting.
593 * Inside the script the XX_REG are used.
597 * Last four bytes (script)
600 #define HX_PRT nc_scr0
602 #define HS_PRT nc_scr1
604 #define SS_PRT nc_scr2
606 #define HF_PRT nc_scr3
609 * Last four bytes (host)
611 #define host_xflags phys.head.status[0]
612 #define host_status phys.head.status[1]
613 #define ssss_status phys.head.status[2]
614 #define host_flags phys.head.status[3]
620 #define HF_IN_PM1 (1u<<1)
621 #define HF_ACT_PM (1u<<2)
622 #define HF_DP_SAVED (1u<<3)
623 #define HF_SENSE (1u<<4)
624 #define HF_EXT_ERR (1u<<5)
625 #define HF_DATA_IN (1u<<6)
626 #ifdef SYM_CONF_IARB_SUPPORT
627 #define HF_HINT_IARB (1u<<7)
633 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
634 #define HX_DMAP_DIRTY (1u<<7)
640 * Due to lack of indirect addressing on earlier NCR chips,
641 * this substructure is copied from the ccb to a global
642 * address after selection (or reselection) and copied back
644 * For SYMBIOS chips that support LOAD/STORE this copy is
645 * not needed and thus not performed.
650 * Start and restart SCRIPTS addresses (must be at 0).
652 /*0*/ struct sym_actscr go;
655 * SCRIPTS jump address that deal with data pointers.
656 * 'savep' points to the position in the script responsible
657 * for the actual transfer of data.
658 * It's written on reception of a SAVE_DATA_POINTER message.
660 u32 savep; /* Jump address to saved data pointer */
661 u32 lastp; /* SCRIPTS address at end of data */
662 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
673 * GET/SET the value of the data pointer used by SCRIPTS.
675 * We must distinguish between the LOAD/STORE-based SCRIPTS
676 * that use directly the header in the CCB, and the NCR-GENERIC
677 * SCRIPTS that use the copy of the header in the HCB.
679 #if SYM_CONF_GENERIC_SUPPORT
680 #define sym_set_script_dp(np, cp, dp) \
682 if (np->features & FE_LDSTR) \
683 cp->phys.head.lastp = cpu_to_scr(dp); \
685 np->ccb_head.lastp = cpu_to_scr(dp); \
687 #define sym_get_script_dp(np, cp) \
688 scr_to_cpu((np->features & FE_LDSTR) ? \
689 cp->phys.head.lastp : np->ccb_head.lastp)
691 #define sym_set_script_dp(np, cp, dp) \
693 cp->phys.head.lastp = cpu_to_scr(dp); \
696 #define sym_get_script_dp(np, cp) (cp->phys.head.lastp)
700 * Data Structure Block
702 * During execution of a ccb by the script processor, the
703 * DSA (data structure address) register points to this
704 * substructure of the ccb.
709 * Also assumed at offset 0 of the sym_ccb structure.
711 /*0*/ struct sym_ccbh head;
714 * Phase mismatch contexts.
715 * We need two to handle correctly the SAVED DATA POINTER.
716 * MUST BOTH BE AT OFFSET < 256, due to using 8 bit arithmetic
717 * for address calculation from SCRIPTS.
723 * Table data for Script
725 struct sym_tblsel select;
726 struct sym_tblmove smsg;
727 struct sym_tblmove smsg_ext;
728 struct sym_tblmove cmd;
729 struct sym_tblmove sense;
730 struct sym_tblmove wresid;
731 struct sym_tblmove data [SYM_CONF_MAX_SG];
735 * Our Command Control Block
739 * This is the data structure which is pointed by the DSA
740 * register when it is executed by the script processor.
741 * It must be the first entry.
746 * Pointer to CAM ccb and related stuff.
748 struct scsi_cmnd *cmd; /* CAM scsiio ccb */
749 u8 cdb_buf[16]; /* Copy of CDB */
750 #define SYM_SNS_BBUF_LEN 32
751 u8 sns_bbuf[SYM_SNS_BBUF_LEN]; /* Bounce buffer for sense data */
752 int data_len; /* Total data length */
753 int segments; /* Number of SG segments */
755 u8 order; /* Tag type (if tagged command) */
756 unsigned char odd_byte_adjustment; /* odd-sized req on wide bus */
758 u_char nego_status; /* Negotiation status */
759 u_char xerr_status; /* Extended error flags */
760 u32 extra_bytes; /* Extraneous bytes transferred */
764 * We prepare a message to be sent after selection.
765 * We may use a second one if the command is rescheduled
766 * due to CHECK_CONDITION or COMMAND TERMINATED.
767 * Contents are IDENTIFY and SIMPLE_TAG.
768 * While negotiating sync or wide transfer,
769 * a SDTR or WDTR message is appended.
771 u_char scsi_smsg [12];
772 u_char scsi_smsg2[12];
775 * Auto request sense related fields.
777 u_char sensecmd[6]; /* Request Sense command */
778 u_char sv_scsi_status; /* Saved SCSI status */
779 u_char sv_xerr_status; /* Saved extended status */
780 int sv_resid; /* Saved residual */
785 u32 ccb_ba; /* BUS address of this CCB */
786 u_short tag; /* Tag for this transfer */
787 /* NO_TAG means no tag */
790 struct sym_ccb *link_ccbh; /* Host adapter CCB hash chain */
791 SYM_QUEHEAD link_ccbq; /* Link to free/busy CCB queue */
792 u32 startp; /* Initial data pointer */
793 u32 goalp; /* Expected last data pointer */
794 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
797 int ext_sg; /* Extreme data pointer, used */
798 int ext_ofs; /* to calculate the residual. */
799 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
800 SYM_QUEHEAD link2_ccbq; /* Link for device queueing */
801 u_char started; /* CCB queued to the squeue */
803 u_char to_abort; /* Want this IO to be aborted */
804 #ifdef SYM_OPT_LIMIT_COMMAND_REORDERING
805 u_char tags_si; /* Lun tags sum index (0,1) */
809 #define CCB_BA(cp,lbl) cpu_to_scr(cp->ccb_ba + offsetof(struct sym_ccb, lbl))
811 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
812 #define sym_goalp(cp) ((cp->host_flags & HF_DATA_IN) ? cp->goalp : cp->wgoalp)
814 #define sym_goalp(cp) (cp->goalp)
817 typedef struct device *m_pool_ident_t;
825 * Due to poorness of addressing capabilities, earlier
826 * chips (810, 815, 825) copy part of the data structures
827 * (CCB, TCB and LCB) in fixed areas.
829 #if SYM_CONF_GENERIC_SUPPORT
830 struct sym_ccbh ccb_head;
831 struct sym_tcbh tcb_head;
832 struct sym_lcbh lcb_head;
835 * Idle task and invalid task actions and
836 * their bus addresses.
838 struct sym_actscr idletask, notask, bad_itl, bad_itlq;
839 u32 idletask_ba, notask_ba, bad_itl_ba, bad_itlq_ba;
842 * Dummy lun table to protect us against target
843 * returning bad lun number on reselection.
845 u32 *badluntbl; /* Table physical address */
846 u32 badlun_sa; /* SCRIPT handler BUS address */
849 * Bus address of this host control block.
854 * Bit 32-63 of the on-chip RAM bus address in LE format.
855 * The START_RAM64 script loads the MMRS and MMWS from this
861 * Initial value of some IO register bits.
862 * These values are assumed to have been set by BIOS, and may
863 * be used to probe adapter implementation differences.
865 u_char sv_scntl0, sv_scntl3, sv_dmode, sv_dcntl, sv_ctest3, sv_ctest4,
866 sv_ctest5, sv_gpcntl, sv_stest2, sv_stest4, sv_scntl4,
870 * Actual initial value of IO register bits used by the
871 * driver. They are loaded at initialisation according to
872 * features that are to be enabled/disabled.
874 u_char rv_scntl0, rv_scntl3, rv_dmode, rv_dcntl, rv_ctest3, rv_ctest4,
875 rv_ctest5, rv_stest2, rv_ccntl0, rv_ccntl1, rv_scntl4;
880 struct sym_tcb target[SYM_CONF_MAX_TARGET];
883 * Target control block bus address array used by the SCRIPT
890 * DMA pool handle for this HBA.
892 m_pool_ident_t bus_dmat;
895 * O/S specific data structure
900 * Physical bus addresses of the chip.
902 u32 mmio_ba; /* MMIO 32 bit BUS address */
903 int mmio_ws; /* MMIO Window size */
905 u32 ram_ba; /* RAM 32 bit BUS address */
906 int ram_ws; /* RAM window size */
909 * SCRIPTS virtual and physical bus addresses.
910 * 'script' is loaded in the on-chip RAM if present.
911 * 'scripth' stays in main memory for all chips except the
912 * 53C895A, 53C896 and 53C1010 that provide 8K on-chip RAM.
914 u_char *scripta0; /* Copy of scripts A, B, Z */
917 u32 scripta_ba; /* Actual scripts A, B, Z */
918 u32 scriptb_ba; /* 32 bit bus addresses. */
920 u_short scripta_sz; /* Actual size of script A, B, Z*/
925 * Bus addresses, setup and patch methods for
926 * the selected firmware.
928 struct sym_fwa_ba fwa_bas; /* Useful SCRIPTA bus addresses */
929 struct sym_fwb_ba fwb_bas; /* Useful SCRIPTB bus addresses */
930 struct sym_fwz_ba fwz_bas; /* Useful SCRIPTZ bus addresses */
931 void (*fw_setup)(struct sym_hcb *np, struct sym_fw *fw);
932 void (*fw_patch)(struct sym_hcb *np);
936 * General controller parameters and configuration.
938 u_short device_id; /* PCI device id */
939 u_char revision_id; /* PCI device revision id */
940 u_int features; /* Chip features map */
941 u_char myaddr; /* SCSI id of the adapter */
942 u_char maxburst; /* log base 2 of dwords burst */
943 u_char maxwide; /* Maximum transfer width */
944 u_char minsync; /* Min sync period factor (ST) */
945 u_char maxsync; /* Max sync period factor (ST) */
946 u_char maxoffs; /* Max scsi offset (ST) */
947 u_char minsync_dt; /* Min sync period factor (DT) */
948 u_char maxsync_dt; /* Max sync period factor (DT) */
949 u_char maxoffs_dt; /* Max scsi offset (DT) */
950 u_char multiplier; /* Clock multiplier (1,2,4) */
951 u_char clock_divn; /* Number of clock divisors */
952 u32 clock_khz; /* SCSI clock frequency in KHz */
953 u32 pciclk_khz; /* Estimated PCI clock in KHz */
955 * Start queue management.
956 * It is filled up by the host processor and accessed by the
957 * SCRIPTS processor in order to start SCSI commands.
959 volatile /* Prevent code optimizations */
960 u32 *squeue; /* Start queue virtual address */
961 u32 squeue_ba; /* Start queue BUS address */
962 u_short squeueput; /* Next free slot of the queue */
963 u_short actccbs; /* Number of allocated CCBs */
966 * Command completion queue.
967 * It is the same size as the start queue to avoid overflow.
969 u_short dqueueget; /* Next position to scan */
970 volatile /* Prevent code optimizations */
971 u32 *dqueue; /* Completion (done) queue */
972 u32 dqueue_ba; /* Done queue BUS address */
975 * Miscellaneous buffers accessed by the scripts-processor.
976 * They shall be DWORD aligned, because they may be read or
977 * written with a script command.
979 u_char msgout[8]; /* Buffer for MESSAGE OUT */
980 u_char msgin [8]; /* Buffer for MESSAGE IN */
981 u32 lastmsg; /* Last SCSI message sent */
982 u32 scratch; /* Scratch for SCSI receive */
983 /* Also used for cache test */
985 * Miscellaneous configuration and status parameters.
987 u_char usrflags; /* Miscellaneous user flags */
988 u_char scsi_mode; /* Current SCSI BUS mode */
989 u_char verbose; /* Verbosity for this controller*/
992 * CCB lists and queue.
994 struct sym_ccb **ccbh; /* CCBs hashed by DSA value */
995 /* CCB_HASH_SIZE lists of CCBs */
996 SYM_QUEHEAD free_ccbq; /* Queue of available CCBs */
997 SYM_QUEHEAD busy_ccbq; /* Queue of busy CCBs */
1000 * During error handling and/or recovery,
1001 * active CCBs that are to be completed with
1002 * error or requeued are moved from the busy_ccbq
1003 * to the comp_ccbq prior to completion.
1005 SYM_QUEHEAD comp_ccbq;
1007 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
1008 SYM_QUEHEAD dummy_ccbq;
1012 * IMMEDIATE ARBITRATION (IARB) control.
1014 * We keep track in 'last_cp' of the last CCB that has been
1015 * queued to the SCRIPTS processor and clear 'last_cp' when
1016 * this CCB completes. If last_cp is not zero at the moment
1017 * we queue a new CCB, we set a flag in 'last_cp' that is
1018 * used by the SCRIPTS as a hint for setting IARB.
1019 * We donnot set more than 'iarb_max' consecutive hints for
1020 * IARB in order to leave devices a chance to reselect.
1021 * By the way, any non zero value of 'iarb_max' is unfair. :)
1023 #ifdef SYM_CONF_IARB_SUPPORT
1024 u_short iarb_max; /* Max. # consecutive IARB hints*/
1025 u_short iarb_count; /* Actual # of these hints */
1026 struct sym_ccb * last_cp;
1030 * Command abort handling.
1031 * We need to synchronize tightly with the SCRIPTS
1032 * processor in order to handle things correctly.
1034 u_char abrt_msg[4]; /* Message to send buffer */
1035 struct sym_tblmove abrt_tbl; /* Table for the MOV of it */
1036 struct sym_tblsel abrt_sel; /* Sync params for selection */
1037 u_char istat_sem; /* Tells the chip to stop (SEM) */
1040 * 64 bit DMA handling.
1042 #if SYM_CONF_DMA_ADDRESSING_MODE != 0
1043 u_char use_dac; /* Use PCI DAC cycles */
1044 #if SYM_CONF_DMA_ADDRESSING_MODE == 2
1045 u_char dmap_dirty; /* Dma segments registers dirty */
1046 u32 dmap_bah[SYM_DMAP_SIZE];/* Segment registers map */
1051 #define HCB_BA(np, lbl) (np->hcb_ba + offsetof(struct sym_hcb, lbl))
1055 * FIRMWARES (sym_fw.c)
1057 struct sym_fw * sym_find_firmware(struct sym_chip *chip);
1058 void sym_fw_bind_script(struct sym_hcb *np, u32 *start, int len);
1061 * Driver methods called from O/S specific code.
1063 char *sym_driver_name(void);
1064 void sym_print_xerr(struct scsi_cmnd *cmd, int x_status);
1065 int sym_reset_scsi_bus(struct sym_hcb *np, int enab_int);
1066 struct sym_chip *sym_lookup_chip_table(u_short device_id, u_char revision);
1067 #ifdef SYM_OPT_HANDLE_DEVICE_QUEUEING
1068 void sym_start_next_ccbs(struct sym_hcb *np, struct sym_lcb *lp, int maxn);
1070 void sym_start_up(struct sym_hcb *np, int reason);
1071 void sym_interrupt(struct sym_hcb *np);
1072 int sym_clear_tasks(struct sym_hcb *np, int cam_status, int target, int lun, int task);
1073 struct sym_ccb *sym_get_ccb(struct sym_hcb *np, struct scsi_cmnd *cmd, u_char tag_order);
1074 void sym_free_ccb(struct sym_hcb *np, struct sym_ccb *cp);
1075 struct sym_lcb *sym_alloc_lcb(struct sym_hcb *np, u_char tn, u_char ln);
1076 int sym_queue_scsiio(struct sym_hcb *np, struct scsi_cmnd *csio, struct sym_ccb *cp);
1077 int sym_abort_scsiio(struct sym_hcb *np, struct scsi_cmnd *ccb, int timed_out);
1078 int sym_reset_scsi_target(struct sym_hcb *np, int target);
1079 void sym_hcb_free(struct sym_hcb *np);
1080 int sym_hcb_attach(struct Scsi_Host *shost, struct sym_fw *fw, struct sym_nvram *nvram);
1083 * Build a scatter/gather entry.
1085 * For 64 bit systems, we use the 8 upper bits of the size field
1086 * to provide bus address bits 32-39 to the SCRIPTS processor.
1087 * This allows the 895A, 896, 1010 to address up to 1 TB of memory.
1090 #if SYM_CONF_DMA_ADDRESSING_MODE == 0
1091 #define sym_build_sge(np, data, badd, len) \
1093 (data)->addr = cpu_to_scr(badd); \
1094 (data)->size = cpu_to_scr(len); \
1096 #elif SYM_CONF_DMA_ADDRESSING_MODE == 1
1097 #define sym_build_sge(np, data, badd, len) \
1099 (data)->addr = cpu_to_scr(badd); \
1100 (data)->size = cpu_to_scr((((badd) >> 8) & 0xff000000) + len); \
1102 #elif SYM_CONF_DMA_ADDRESSING_MODE == 2
1103 int sym_lookup_dmap(struct sym_hcb *np, u32 h, int s);
1104 static __inline void
1105 sym_build_sge(struct sym_hcb *np, struct sym_tblmove *data, u64 badd, int len)
1108 int s = (h&SYM_DMAP_MASK);
1110 if (h != np->dmap_bah[s])
1113 (data)->addr = cpu_to_scr(badd);
1114 (data)->size = cpu_to_scr((s<<24) + len);
1117 s = sym_lookup_dmap(np, h, s);
1121 #error "Unsupported DMA addressing mode"
1125 * Set up data pointers used by SCRIPTS.
1126 * Called from O/S specific code.
1128 static inline void sym_setup_data_pointers(struct sym_hcb *np,
1129 struct sym_ccb *cp, int dir)
1134 * No segments means no data.
1140 * Set the data pointer.
1143 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1144 case DMA_BIDIRECTIONAL:
1147 goalp = SCRIPTA_BA(np, data_out2) + 8;
1148 lastp = goalp - 8 - (cp->segments * (2*4));
1149 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1150 cp->wgoalp = cpu_to_scr(goalp);
1151 if (dir != DMA_BIDIRECTIONAL)
1153 cp->phys.head.wlastp = cpu_to_scr(lastp);
1158 case DMA_FROM_DEVICE:
1159 cp->host_flags |= HF_DATA_IN;
1160 goalp = SCRIPTA_BA(np, data_in2) + 8;
1161 lastp = goalp - 8 - (cp->segments * (2*4));
1165 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1166 cp->host_flags |= HF_DATA_IN;
1168 lastp = goalp = SCRIPTB_BA(np, no_data);
1173 * Set all pointers values needed by SCRIPTS.
1175 cp->phys.head.lastp = cpu_to_scr(lastp);
1176 cp->phys.head.savep = cpu_to_scr(lastp);
1177 cp->startp = cp->phys.head.savep;
1178 cp->goalp = cpu_to_scr(goalp);
1180 #ifdef SYM_OPT_HANDLE_DIR_UNKNOWN
1182 * If direction is unknown, start at data_io.
1184 if (dir == DMA_BIDIRECTIONAL)
1185 cp->phys.head.savep = cpu_to_scr(SCRIPTB_BA(np, data_io));
1193 #define sym_get_mem_cluster() \
1194 (void *) __get_free_pages(GFP_ATOMIC, SYM_MEM_PAGE_ORDER)
1195 #define sym_free_mem_cluster(p) \
1196 free_pages((unsigned long)p, SYM_MEM_PAGE_ORDER)
1199 * Link between free memory chunks of a given size.
1201 typedef struct sym_m_link {
1202 struct sym_m_link *next;
1206 * Virtual to bus physical translation for a given cluster.
1207 * Such a structure is only useful with DMA abstraction.
1209 typedef struct sym_m_vtob { /* Virtual to Bus address translation */
1210 struct sym_m_vtob *next;
1211 void *vaddr; /* Virtual address */
1212 dma_addr_t baddr; /* Bus physical address */
1215 /* Hash this stuff a bit to speed up translations */
1216 #define VTOB_HASH_SHIFT 5
1217 #define VTOB_HASH_SIZE (1UL << VTOB_HASH_SHIFT)
1218 #define VTOB_HASH_MASK (VTOB_HASH_SIZE-1)
1219 #define VTOB_HASH_CODE(m) \
1220 ((((unsigned long)(m)) >> SYM_MEM_CLUSTER_SHIFT) & VTOB_HASH_MASK)
1223 * Memory pool of a given kind.
1224 * Ideally, we want to use:
1225 * 1) 1 pool for memory we donnot need to involve in DMA.
1226 * 2) The same pool for controllers that require same DMA
1227 * constraints and features.
1228 * The OS specific m_pool_id_t thing and the sym_m_pool_match()
1229 * method are expected to tell the driver about.
1231 typedef struct sym_m_pool {
1232 m_pool_ident_t dev_dmat; /* Identifies the pool (see above) */
1233 void * (*get_mem_cluster)(struct sym_m_pool *);
1234 #ifdef SYM_MEM_FREE_UNUSED
1235 void (*free_mem_cluster)(struct sym_m_pool *, void *);
1237 #define M_GET_MEM_CLUSTER() mp->get_mem_cluster(mp)
1238 #define M_FREE_MEM_CLUSTER(p) mp->free_mem_cluster(mp, p)
1240 m_vtob_p vtob[VTOB_HASH_SIZE];
1241 struct sym_m_pool *next;
1242 struct sym_m_link h[SYM_MEM_CLUSTER_SHIFT - SYM_MEM_SHIFT + 1];
1246 * Alloc, free and translate addresses to bus physical
1247 * for DMAable memory.
1249 void *__sym_calloc_dma(m_pool_ident_t dev_dmat, int size, char *name);
1250 void __sym_mfree_dma(m_pool_ident_t dev_dmat, void *m, int size, char *name);
1251 dma_addr_t __vtobus(m_pool_ident_t dev_dmat, void *m);
1254 * Verbs used by the driver code for DMAable memory handling.
1255 * The _uvptv_ macro avoids a nasty warning about pointer to volatile
1258 #define _uvptv_(p) ((void *)((u_long)(p)))
1260 #define _sym_calloc_dma(np, l, n) __sym_calloc_dma(np->bus_dmat, l, n)
1261 #define _sym_mfree_dma(np, p, l, n) \
1262 __sym_mfree_dma(np->bus_dmat, _uvptv_(p), l, n)
1263 #define sym_calloc_dma(l, n) _sym_calloc_dma(np, l, n)
1264 #define sym_mfree_dma(p, l, n) _sym_mfree_dma(np, p, l, n)
1265 #define vtobus(p) __vtobus(np->bus_dmat, _uvptv_(p))
1268 * We have to provide the driver memory allocator with methods for
1269 * it to maintain virtual to bus physical address translations.
1272 #define sym_m_pool_match(mp_id1, mp_id2) (mp_id1 == mp_id2)
1274 static __inline void *sym_m_get_dma_mem_cluster(m_pool_p mp, m_vtob_p vbp)
1277 dma_addr_t baddr = 0;
1279 vaddr = dma_alloc_coherent(mp->dev_dmat, SYM_MEM_CLUSTER_SIZE, &baddr,
1288 static __inline void sym_m_free_dma_mem_cluster(m_pool_p mp, m_vtob_p vbp)
1290 dma_free_coherent(mp->dev_dmat, SYM_MEM_CLUSTER_SIZE, vbp->vaddr,
1294 #endif /* SYM_HIPD_H */