xref: /illumos-gate/usr/src/uts/common/io/aac/aac.h (revision 72888e72b624f86b06ea05b1de2287dcf9f40d23)
17c478bd9Sstevel@tonic-gate /*
2*72888e72Speng liu - Sun Microsystems - Beijing China  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
37c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
47c478bd9Sstevel@tonic-gate  */
5830d82f7Spl 
67c478bd9Sstevel@tonic-gate /*
7830d82f7Spl  * Copyright 2005-06 Adaptec, Inc.
8830d82f7Spl  * Copyright (c) 2005-06 Adaptec Inc., Achim Leubner
97c478bd9Sstevel@tonic-gate  * Copyright (c) 2000 Michael Smith
107c478bd9Sstevel@tonic-gate  * Copyright (c) 2001 Scott Long
117c478bd9Sstevel@tonic-gate  * Copyright (c) 2000 BSDi
127c478bd9Sstevel@tonic-gate  * All rights reserved.
137c478bd9Sstevel@tonic-gate  *
147c478bd9Sstevel@tonic-gate  * Redistribution and use in source and binary forms, with or without
157c478bd9Sstevel@tonic-gate  * modification, are permitted provided that the following conditions
167c478bd9Sstevel@tonic-gate  * are met:
177c478bd9Sstevel@tonic-gate  * 1. Redistributions of source code must retain the above copyright
187c478bd9Sstevel@tonic-gate  *    notice, this list of conditions and the following disclaimer.
197c478bd9Sstevel@tonic-gate  * 2. Redistributions in binary form must reproduce the above copyright
207c478bd9Sstevel@tonic-gate  *    notice, this list of conditions and the following disclaimer in the
217c478bd9Sstevel@tonic-gate  *    documentation and/or other materials provided with the distribution.
227c478bd9Sstevel@tonic-gate  *
237c478bd9Sstevel@tonic-gate  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
247c478bd9Sstevel@tonic-gate  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
257c478bd9Sstevel@tonic-gate  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
267c478bd9Sstevel@tonic-gate  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
277c478bd9Sstevel@tonic-gate  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
287c478bd9Sstevel@tonic-gate  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
297c478bd9Sstevel@tonic-gate  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
307c478bd9Sstevel@tonic-gate  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
317c478bd9Sstevel@tonic-gate  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
327c478bd9Sstevel@tonic-gate  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
337c478bd9Sstevel@tonic-gate  * SUCH DAMAGE.
347c478bd9Sstevel@tonic-gate  *
35830d82f7Spl  *    $FreeBSD: src/sys/dev/aac/aacvar.h,v 1.47 2005/10/08 15:55:09 scottl Exp $
367c478bd9Sstevel@tonic-gate  */
377c478bd9Sstevel@tonic-gate 
387c478bd9Sstevel@tonic-gate #ifndef	_AAC_H_
397c478bd9Sstevel@tonic-gate #define	_AAC_H_
407c478bd9Sstevel@tonic-gate 
417c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
427c478bd9Sstevel@tonic-gate extern "C" {
437c478bd9Sstevel@tonic-gate #endif
447c478bd9Sstevel@tonic-gate 
45830d82f7Spl #define	AAC_ROUNDUP(x, y)		(((x) + (y) - 1) / (y) * (y))
46830d82f7Spl 
47830d82f7Spl #define	AAC_TYPE_DEVO			1
48830d82f7Spl #define	AAC_TYPE_ALPHA			2
49830d82f7Spl #define	AAC_TYPE_BETA			3
50830d82f7Spl #define	AAC_TYPE_RELEASE		4
51830d82f7Spl 
52830d82f7Spl #ifndef	AAC_DRIVER_BUILD
53830d82f7Spl #define	AAC_DRIVER_BUILD		1
54830d82f7Spl #endif
55830d82f7Spl 
56830d82f7Spl #define	AAC_DRIVER_MAJOR_VERSION	2
57942c5e3cSpl #define	AAC_DRIVER_MINOR_VERSION	2
58*72888e72Speng liu - Sun Microsystems - Beijing China #define	AAC_DRIVER_BUGFIX_LEVEL		6
59830d82f7Spl #define	AAC_DRIVER_TYPE			AAC_TYPE_RELEASE
607c478bd9Sstevel@tonic-gate 
61832e0b5aSpl #define	STR(s)				# s
62832e0b5aSpl #define	AAC_VERSION(a, b, c)		STR(a.b.c)
63832e0b5aSpl #define	AAC_DRIVER_VERSION		AAC_VERSION(AAC_DRIVER_MAJOR_VERSION, \
64832e0b5aSpl 					AAC_DRIVER_MINOR_VERSION, \
65832e0b5aSpl 					AAC_DRIVER_BUGFIX_LEVEL)
66832e0b5aSpl 
67830d82f7Spl #define	AACOK				0
68830d82f7Spl #define	AACERR				-1
69830d82f7Spl 
70830d82f7Spl #define	AAC_MAX_ADAPTERS		64
71830d82f7Spl 
72830d82f7Spl /* Definitions for mode sense */
737c478bd9Sstevel@tonic-gate #ifndef	SD_MODE_SENSE_PAGE3_CODE
74830d82f7Spl #define	SD_MODE_SENSE_PAGE3_CODE	0x03
757c478bd9Sstevel@tonic-gate #endif
767c478bd9Sstevel@tonic-gate 
777c478bd9Sstevel@tonic-gate #ifndef	SD_MODE_SENSE_PAGE4_CODE
78830d82f7Spl #define	SD_MODE_SENSE_PAGE4_CODE	0x04
797c478bd9Sstevel@tonic-gate #endif
807c478bd9Sstevel@tonic-gate 
817c478bd9Sstevel@tonic-gate #ifndef	SCMD_SYNCHRONIZE_CACHE
82830d82f7Spl #define	SCMD_SYNCHRONIZE_CACHE		0x35
837c478bd9Sstevel@tonic-gate #endif
847c478bd9Sstevel@tonic-gate 
85830d82f7Spl /*
86830d82f7Spl  * The controller reports status events in AIFs. We hang on to a number of
87830d82f7Spl  * these in order to pass them out to user-space management tools.
88830d82f7Spl  */
89830d82f7Spl #define	AAC_AIFQ_LENGTH			64
90830d82f7Spl 
91942c5e3cSpl #ifdef __x86
92830d82f7Spl #define	AAC_IMMEDIATE_TIMEOUT		30	/* seconds */
93942c5e3cSpl #else
94942c5e3cSpl #define	AAC_IMMEDIATE_TIMEOUT		60	/* seconds */
95942c5e3cSpl #endif
96830d82f7Spl #define	AAC_FWUP_TIMEOUT		180	/* wait up to 3 minutes */
9758bc78c7SXin Chen #define	AAC_IOCTL_TIMEOUT		900	/* wait up to 15 minutes */
987c478bd9Sstevel@tonic-gate 
99830d82f7Spl /* Adapter hardware interface types */
100830d82f7Spl #define	AAC_HWIF_UNKNOWN		0
101830d82f7Spl #define	AAC_HWIF_I960RX			1
102830d82f7Spl #define	AAC_HWIF_RKT			2
103830d82f7Spl 
104830d82f7Spl #define	AAC_TYPE_UNKNOWN		0
105830d82f7Spl #define	AAC_TYPE_SCSI			1
106830d82f7Spl #define	AAC_TYPE_SATA			2
107830d82f7Spl #define	AAC_TYPE_SAS			3
108fd4ae32fSyf 
109942c5e3cSpl #define	AAC_LS32(d)			((uint32_t)((d) & 0xffffffffull))
110942c5e3cSpl #define	AAC_MS32(d)			((uint32_t)((d) >> 32))
111942c5e3cSpl #define	AAC_LO32(p64)			((uint32_t *)(p64))
112942c5e3cSpl #define	AAC_HI32(p64)			((uint32_t *)(p64) + 1)
113942c5e3cSpl 
114382c8bcaSpl /*
115382c8bcaSpl  * AAC_CMDQ_SYNC should be 0 and AAC_CMDQ_ASYNC be 1 for Sync FIB io
116382c8bcaSpl  * to be served before async FIB io, see aac_start_waiting_io().
117382c8bcaSpl  * So that io requests sent by interactive userland commands get
118382c8bcaSpl  * responded asap.
119382c8bcaSpl  */
120382c8bcaSpl enum aac_cmdq {
121382c8bcaSpl 	AAC_CMDQ_SYNC,	/* sync FIB queue */
122382c8bcaSpl 	AAC_CMDQ_ASYNC,	/* async FIB queue */
123382c8bcaSpl 	AAC_CMDQ_NUM
124382c8bcaSpl };
125382c8bcaSpl 
126382c8bcaSpl /*
127382c8bcaSpl  * IO command flags
128382c8bcaSpl  */
129382c8bcaSpl #define	AAC_IOCMD_SYNC		(1 << AAC_CMDQ_SYNC)
130382c8bcaSpl #define	AAC_IOCMD_ASYNC		(1 << AAC_CMDQ_ASYNC)
131382c8bcaSpl #define	AAC_IOCMD_OUTSTANDING	(1 << AAC_CMDQ_NUM)
132382c8bcaSpl #define	AAC_IOCMD_ALL		(AAC_IOCMD_SYNC | AAC_IOCMD_ASYNC | \
133382c8bcaSpl 				AAC_IOCMD_OUTSTANDING)
134382c8bcaSpl 
135382c8bcaSpl struct aac_cmd_queue {
136382c8bcaSpl 	struct aac_cmd *q_head; /* also as the header of aac_cmd */
137382c8bcaSpl 	struct aac_cmd *q_tail;
138382c8bcaSpl };
139382c8bcaSpl 
1407c478bd9Sstevel@tonic-gate struct aac_card_type {
141830d82f7Spl 	uint16_t vendor;	/* PCI Vendor ID */
142830d82f7Spl 	uint16_t device;	/* PCI Device ID */
143830d82f7Spl 	uint16_t subvendor;	/* PCI Subsystem Vendor ID */
144830d82f7Spl 	uint16_t subsys;	/* PCI Subsystem ID */
145830d82f7Spl 	uint16_t hwif;		/* card chip type: i960 or Rocket */
146830d82f7Spl 	uint16_t quirks;	/* card odd limits */
147830d82f7Spl 	uint16_t type;		/* hard drive type */
148830d82f7Spl 	char *vid;		/* ASCII data for INQUIRY command vendor id */
149830d82f7Spl 	char *desc;		/* ASCII data for INQUIRY command product id */
1507c478bd9Sstevel@tonic-gate };
1517c478bd9Sstevel@tonic-gate 
15258bc78c7SXin Chen /* Device types */
15358bc78c7SXin Chen #define	AAC_DEV_LD		0	/* logical device */
15458bc78c7SXin Chen #define	AAC_DEV_PD		1	/* physical device */
15558bc78c7SXin Chen 
15658bc78c7SXin Chen /* DR events */
15758bc78c7SXin Chen #define	AAC_EVT_NONE		0
15858bc78c7SXin Chen #define	AAC_EVT_ONLINE		1
15958bc78c7SXin Chen #define	AAC_EVT_OFFLINE		2
16058bc78c7SXin Chen 
16158bc78c7SXin Chen /* Device flags */
16258bc78c7SXin Chen #define	AAC_DFLAG_VALID		(1 << 0)
16358bc78c7SXin Chen #define	AAC_DFLAG_CONFIGURING	(1 << 1)
16458bc78c7SXin Chen 
16558bc78c7SXin Chen #define	AAC_DEV_IS_VALID(dvp)	((dvp)->flags & AAC_DFLAG_VALID)
16658bc78c7SXin Chen 
16758bc78c7SXin Chen struct aac_device {
16858bc78c7SXin Chen 	int flags;
16958bc78c7SXin Chen 
17058bc78c7SXin Chen 	uint8_t type;
17158bc78c7SXin Chen 	dev_info_t *dip;
17258bc78c7SXin Chen 	int ncmds[AAC_CMDQ_NUM];	/* outstanding cmds of the device */
17358bc78c7SXin Chen 	int throttle[AAC_CMDQ_NUM];	/* hold IO cmds for the device */
17458bc78c7SXin Chen };
17558bc78c7SXin Chen 
176d937e6ebSpl /* Array description */
1777c478bd9Sstevel@tonic-gate struct aac_container {
17858bc78c7SXin Chen 	struct aac_device dev;
17958bc78c7SXin Chen 
180830d82f7Spl 	uint32_t cid;		/* container id */
181830d82f7Spl 	uint32_t uid;		/* container uid */
182382c8bcaSpl 	uint64_t size;		/* in block */
183382c8bcaSpl 	uint8_t locked;
184382c8bcaSpl 	uint8_t deleted;
18558bc78c7SXin Chen 	uint8_t reset;		/* container is being reseted */
18658bc78c7SXin Chen };
18758bc78c7SXin Chen 
18858bc78c7SXin Chen /* Non-DASD phys. device descrption, eg. CDROM or tape */
18958bc78c7SXin Chen struct aac_nondasd {
19058bc78c7SXin Chen 	struct aac_device dev;
19158bc78c7SXin Chen 
19258bc78c7SXin Chen 	uint32_t bus;
19358bc78c7SXin Chen 	uint32_t tid;
1947c478bd9Sstevel@tonic-gate };
1957c478bd9Sstevel@tonic-gate 
196830d82f7Spl /*
197830d82f7Spl  * The firmware can support a lot of outstanding commands. Each aac_slot
198830d82f7Spl  * is corresponding to one of such commands. It records the command and
199830d82f7Spl  * associated DMA resource for FIB command.
200830d82f7Spl  */
2017c478bd9Sstevel@tonic-gate struct aac_slot {
202382c8bcaSpl 	struct aac_slot *next;	/* next slot in the free slot list */
203382c8bcaSpl 	int index;		/* index of this slot */
2047c478bd9Sstevel@tonic-gate 	ddi_acc_handle_t fib_acc_handle;
2057c478bd9Sstevel@tonic-gate 	ddi_dma_handle_t fib_dma_handle;
206830d82f7Spl 	uint64_t fib_phyaddr;	/* physical address of FIB memory */
207830d82f7Spl 	struct aac_cmd *acp;	/* command using this slot */
208830d82f7Spl 	struct aac_fib *fibp;	/* virtual address of FIB memory */
2097c478bd9Sstevel@tonic-gate };
2107c478bd9Sstevel@tonic-gate 
211382c8bcaSpl /* Flags for attach tracking */
212830d82f7Spl #define	AAC_ATTACH_SOFTSTATE_ALLOCED	(1 << 0)
213830d82f7Spl #define	AAC_ATTACH_CARD_DETECTED	(1 << 1)
214830d82f7Spl #define	AAC_ATTACH_PCI_MEM_MAPPED	(1 << 2)
215830d82f7Spl #define	AAC_ATTACH_KMUTEX_INITED	(1 << 3)
216830d82f7Spl #define	AAC_ATTACH_HARD_INTR_SETUP	(1 << 4)
217830d82f7Spl #define	AAC_ATTACH_SOFT_INTR_SETUP	(1 << 5)
218830d82f7Spl #define	AAC_ATTACH_SCSI_TRAN_SETUP	(1 << 6)
219830d82f7Spl #define	AAC_ATTACH_COMM_SPACE_SETUP	(1 << 7)
220830d82f7Spl #define	AAC_ATTACH_CREATE_DEVCTL	(1 << 8)
221830d82f7Spl #define	AAC_ATTACH_CREATE_SCSI		(1 << 9)
222830d82f7Spl 
223382c8bcaSpl /* Driver running states */
224382c8bcaSpl #define	AAC_STATE_STOPPED	0
225382c8bcaSpl #define	AAC_STATE_RUN		(1 << 0)
226382c8bcaSpl #define	AAC_STATE_RESET		(1 << 1)
227382c8bcaSpl #define	AAC_STATE_QUIESCED	(1 << 2)
228382c8bcaSpl #define	AAC_STATE_DEAD		(1 << 3)
229830d82f7Spl 
230382c8bcaSpl /*
231382c8bcaSpl  * Flags for aac firmware
232382c8bcaSpl  * Note: Quirks are only valid for the older cards. These cards only supported
233382c8bcaSpl  * old comm. Thus they are not valid for any cards that support new comm.
234382c8bcaSpl  */
235830d82f7Spl #define	AAC_FLAGS_SG_64BIT	(1 << 0) /* Use 64-bit S/G addresses */
236830d82f7Spl #define	AAC_FLAGS_4GB_WINDOW	(1 << 1) /* Can access host mem 2-4GB range */
237382c8bcaSpl #define	AAC_FLAGS_NO4GB	(1 << 2)	/* quirk: FIB addresses must reside */
238382c8bcaSpl 					/*	  between 0x2000 & 0x7FFFFFFF */
239382c8bcaSpl #define	AAC_FLAGS_256FIBS	(1 << 3) /* quirk: Can only do 256 commands */
240830d82f7Spl #define	AAC_FLAGS_NEW_COMM	(1 << 4) /* New comm. interface supported */
241830d82f7Spl #define	AAC_FLAGS_RAW_IO	(1 << 5) /* Raw I/O interface */
242830d82f7Spl #define	AAC_FLAGS_ARRAY_64BIT	(1 << 6) /* 64-bit array size */
243830d82f7Spl #define	AAC_FLAGS_LBA_64BIT	(1 << 7) /* 64-bit LBA supported */
244382c8bcaSpl #define	AAC_FLAGS_17SG		(1 << 8) /* quirk: 17 scatter gather maximum */
245382c8bcaSpl #define	AAC_FLAGS_34SG		(1 << 9) /* quirk: 34 scatter gather maximum */
24658bc78c7SXin Chen #define	AAC_FLAGS_NONDASD	(1 << 10) /* non-DASD device supported */
247*72888e72Speng liu - Sun Microsystems - Beijing China #define	AAC_FLAGS_BRKUP		(1 << 11) /* pkt breakup support */
248830d82f7Spl 
249830d82f7Spl struct aac_softstate;
250830d82f7Spl struct aac_interface {
251830d82f7Spl 	int (*aif_get_fwstatus)(struct aac_softstate *);
252d937e6ebSpl 	int (*aif_get_mailbox)(struct aac_softstate *, int);
253d937e6ebSpl 	void (*aif_set_mailbox)(struct aac_softstate *, uint32_t,
254c9487164Spl 	    uint32_t, uint32_t, uint32_t, uint32_t);
255830d82f7Spl };
256830d82f7Spl 
257830d82f7Spl struct aac_fib_context {
258830d82f7Spl 	uint32_t unique;
259830d82f7Spl 	int ctx_idx;
260c4219f59Sxc 	int ctx_filled;		/* aifq is full for this fib context */
261830d82f7Spl 	struct aac_fib_context *next, *prev;
262830d82f7Spl };
2637c478bd9Sstevel@tonic-gate 
264942c5e3cSpl typedef void (*aac_cmd_fib_t)(struct aac_softstate *, struct aac_cmd *);
265d7c5bf88Spl 
266d937e6ebSpl #define	AAC_VENDOR_LEN		8
267d937e6ebSpl #define	AAC_PRODUCT_LEN		16
268d937e6ebSpl 
2697c478bd9Sstevel@tonic-gate struct aac_softstate {
270830d82f7Spl 	int card;		/* index to aac_cards */
271d937e6ebSpl 	uint16_t hwif;		/* card chip type: i960 or Rocket */
2721cea6be9Sxc 	uint16_t vendid;	/* vendor id */
2731cea6be9Sxc 	uint16_t subvendid;	/* sub vendor id */
2741cea6be9Sxc 	uint16_t devid;		/* device id */
2751cea6be9Sxc 	uint16_t subsysid;	/* sub system id */
276d937e6ebSpl 	char vendor_name[AAC_VENDOR_LEN + 1];
277d937e6ebSpl 	char product_name[AAC_PRODUCT_LEN + 1];
278830d82f7Spl 	uint32_t support_opt;	/* firmware features */
279830d82f7Spl 	uint32_t atu_size;	/* actual size of PCI mem space */
280830d82f7Spl 	uint32_t map_size;	/* mapped PCI mem space size */
281830d82f7Spl 	uint32_t map_size_min;	/* minimum size of PCI mem that must be */
282830d82f7Spl 				/* mapped to address the card */
283c9487164Spl 	int flags;		/* firmware features enabled */
2841dd0a2dbSpl 	int instance;
2857c478bd9Sstevel@tonic-gate 	dev_info_t *devinfo_p;
28658bc78c7SXin Chen 	scsi_hba_tran_t *hba_tran;
287d7c5bf88Spl 	int slen;
28858bc78c7SXin Chen 	int legacy;		/* legacy device naming */
289*72888e72Speng liu - Sun Microsystems - Beijing China 	uint32_t dma_max;	/* for buf breakup */
290830d82f7Spl 
291c9487164Spl 	/* DMA attributes */
292830d82f7Spl 	ddi_dma_attr_t buf_dma_attr;
293830d82f7Spl 	ddi_dma_attr_t addr_dma_attr;
2947c478bd9Sstevel@tonic-gate 
295c9487164Spl 	/* PCI spaces */
29658bc78c7SXin Chen 	ddi_device_acc_attr_t acc_attr;
2977c478bd9Sstevel@tonic-gate 	ddi_acc_handle_t pci_mem_handle;
298a74f7440Spl 	uint8_t *pci_mem_base_vaddr;
2991dd0a2dbSpl 	uint32_t pci_mem_base_paddr;
3007c478bd9Sstevel@tonic-gate 
301c9487164Spl 	struct aac_interface aac_if;	/* adapter hardware interface */
3027c478bd9Sstevel@tonic-gate 
303942c5e3cSpl 	struct aac_slot sync_slot;	/* sync FIB */
3047c478bd9Sstevel@tonic-gate 
305c9487164Spl 	/* Communication space */
3067c478bd9Sstevel@tonic-gate 	struct aac_comm_space *comm_space;
3077c478bd9Sstevel@tonic-gate 	ddi_acc_handle_t comm_space_acc_handle;
3087c478bd9Sstevel@tonic-gate 	ddi_dma_handle_t comm_space_dma_handle;
309830d82f7Spl 	uint32_t comm_space_phyaddr;
3107c478bd9Sstevel@tonic-gate 
311c9487164Spl 	/* Old Comm. interface: message queues */
3127c478bd9Sstevel@tonic-gate 	struct aac_queue_table *qtablep;
3137c478bd9Sstevel@tonic-gate 	struct aac_queue_entry *qentries[AAC_QUEUE_COUNT];
3147c478bd9Sstevel@tonic-gate 
315c9487164Spl 	/* New Comm. interface */
316c9487164Spl 	uint32_t aac_max_fibs;		/* max. FIB count */
317c9487164Spl 	uint32_t aac_max_fib_size;	/* max. FIB size */
318c9487164Spl 	uint32_t aac_sg_tablesize;	/* max. sg count from host */
319c9487164Spl 	uint32_t aac_max_sectors;	/* max. I/O size from host (blocks) */
320c9487164Spl 
321d7c5bf88Spl 	aac_cmd_fib_t aac_cmd_fib;	/* IO cmd FIB construct function */
322942c5e3cSpl 	aac_cmd_fib_t aac_cmd_fib_scsi;	/* SRB construct function */
323d7c5bf88Spl 
324c9487164Spl 	ddi_softintr_t softint_id;	/* soft intr */
325c9487164Spl 
326382c8bcaSpl 	kmutex_t io_lock;
327c9487164Spl 	int state;			/* driver state */
328c9487164Spl 
329942c5e3cSpl 	struct aac_container containers[AAC_MAX_LD];
330c9487164Spl 	int container_count;		/* max container id + 1 */
33158bc78c7SXin Chen 	struct aac_nondasd *nondasds;
33258bc78c7SXin Chen 	uint32_t bus_max;		/* max FW buses exposed */
33358bc78c7SXin Chen 	uint32_t tgt_max;		/* max FW target per bus */
3347c478bd9Sstevel@tonic-gate 
335830d82f7Spl 	/*
336830d82f7Spl 	 * Command queues
337830d82f7Spl 	 * Each aac command flows through wait(or wait_sync) queue,
338382c8bcaSpl 	 * busy queue, and complete queue sequentially.
339830d82f7Spl 	 */
340382c8bcaSpl 	struct aac_cmd_queue q_wait[AAC_CMDQ_NUM];
341382c8bcaSpl 	struct aac_cmd_queue q_busy;	/* outstanding cmd queue */
342382c8bcaSpl 	kmutex_t q_comp_mutex;
343c9487164Spl 	struct aac_cmd_queue q_comp;	/* completed io requests */
344830d82f7Spl 
345d937e6ebSpl 	/* I/O slots and FIBs */
346830d82f7Spl 	int total_slots;		/* total slots allocated */
347830d82f7Spl 	int total_fibs;			/* total FIBs allocated */
348830d82f7Spl 	struct aac_slot *io_slot;	/* static list for allocated slots */
349382c8bcaSpl 	struct aac_slot *free_io_slot_head;
3507c478bd9Sstevel@tonic-gate 
351382c8bcaSpl 	timeout_id_t timeout_id;	/* for timeout daemon */
352830d82f7Spl 
353382c8bcaSpl 	kcondvar_t event;		/* for ioctl_send_fib() and sync IO */
354382c8bcaSpl 
355382c8bcaSpl 	int bus_ncmds[AAC_CMDQ_NUM];	/* total outstanding async cmds */
356382c8bcaSpl 	int bus_throttle[AAC_CMDQ_NUM];	/* hold IO cmds for the bus */
357382c8bcaSpl 	int ndrains;			/* number of draining threads */
358382c8bcaSpl 	timeout_id_t drain_timeid;	/* for outstanding cmd drain */
359382c8bcaSpl 	kcondvar_t drain_cv;		/* for quiesce drain */
360830d82f7Spl 
361830d82f7Spl 	/* AIF */
362830d82f7Spl 	kmutex_t aifq_mutex;		/* for AIF queue aifq */
363830d82f7Spl 	kcondvar_t aifv;
364942c5e3cSpl 	union aac_fib_align aifq[AAC_AIFQ_LENGTH];
365c4219f59Sxc 	int aifq_idx;			/* slot for next new AIF */
366c4219f59Sxc 	int aifq_wrap;			/* AIF queue has ever been wrapped */
367830d82f7Spl 	struct aac_fib_context *fibctx;
368830d82f7Spl 	int devcfg_wait_on;		/* AIF event waited for rescan */
3691dd0a2dbSpl 
3707675db54Syw 	int fm_capabilities;
37158bc78c7SXin Chen 	ddi_taskq_t *taskq;
3727675db54Syw 
373b6094a86Sjd 	/* MSI specific fields */
374b6094a86Sjd 	ddi_intr_handle_t *htable;	/* For array of interrupts */
375b6094a86Sjd 	int intr_type;			/* What type of interrupt */
376b6094a86Sjd 	int intr_cnt;			/* # of intrs count returned */
377b6094a86Sjd 	uint_t intr_pri;		/* Interrupt priority   */
378b6094a86Sjd 	int intr_cap;			/* Interrupt capabilities */
379b6094a86Sjd 
3801dd0a2dbSpl #ifdef DEBUG
3811dd0a2dbSpl 	/* UART trace printf variables */
3821dd0a2dbSpl 	uint32_t debug_flags;		/* debug print flags bitmap */
38358bc78c7SXin Chen 	uint32_t debug_fib_flags;	/* debug FIB print flags bitmap */
3841dd0a2dbSpl 	uint32_t debug_fw_flags;	/* FW debug flags */
3851dd0a2dbSpl 	uint32_t debug_buf_offset;	/* offset from DPMEM start */
3861dd0a2dbSpl 	uint32_t debug_buf_size;	/* FW debug buffer size in bytes */
3871dd0a2dbSpl 	uint32_t debug_header_size;	/* size of debug header */
3881dd0a2dbSpl #endif
3897c478bd9Sstevel@tonic-gate };
3907c478bd9Sstevel@tonic-gate 
391942c5e3cSpl /*
392942c5e3cSpl  * The following data are kept stable because they are only written at driver
393942c5e3cSpl  * initialization, and we do not allow them changed otherwise even at driver
394942c5e3cSpl  * re-initialization.
395942c5e3cSpl  */
396382c8bcaSpl _NOTE(SCHEME_PROTECTS_DATA("stable data", aac_softstate::{flags slen \
397942c5e3cSpl     buf_dma_attr pci_mem_handle pci_mem_base_vaddr \
398382c8bcaSpl     comm_space_acc_handle comm_space_dma_handle aac_max_fib_size \
39958bc78c7SXin Chen     aac_sg_tablesize aac_cmd_fib aac_cmd_fib_scsi debug_flags bus_max tgt_max}))
400942c5e3cSpl 
401942c5e3cSpl /*
402942c5e3cSpl  * Scatter-gather list structure defined by HBA hardware
403942c5e3cSpl  */
404942c5e3cSpl struct aac_sge {
405942c5e3cSpl 	uint32_t bcount;	/* byte count */
406942c5e3cSpl 	union {
407942c5e3cSpl 		uint32_t ad32;	/* 32 bit address */
408942c5e3cSpl 		struct {
409942c5e3cSpl 			uint32_t lo;
410942c5e3cSpl 			uint32_t hi;
411942c5e3cSpl 		} ad64;		/* 64 bit address */
412942c5e3cSpl 	} addr;
413942c5e3cSpl };
414382c8bcaSpl 
415830d82f7Spl /* aac_cmd flags */
416830d82f7Spl #define	AAC_CMD_CONSISTENT		(1 << 0)
417830d82f7Spl #define	AAC_CMD_DMA_PARTIAL		(1 << 1)
418d7c5bf88Spl #define	AAC_CMD_DMA_VALID		(1 << 2)
419d7c5bf88Spl #define	AAC_CMD_BUF_READ		(1 << 3)
420d7c5bf88Spl #define	AAC_CMD_BUF_WRITE		(1 << 4)
421d7c5bf88Spl #define	AAC_CMD_SYNC			(1 << 5) /* use sync FIB */
422382c8bcaSpl #define	AAC_CMD_NO_INTR			(1 << 6) /* poll IO, no intr */
423382c8bcaSpl #define	AAC_CMD_NO_CB			(1 << 7) /* sync IO, no callback */
424382c8bcaSpl #define	AAC_CMD_NTAG			(1 << 8)
425382c8bcaSpl #define	AAC_CMD_CMPLT			(1 << 9) /* cmd exec'ed by driver/fw */
426382c8bcaSpl #define	AAC_CMD_ABORT			(1 << 10)
427382c8bcaSpl #define	AAC_CMD_TIMEOUT			(1 << 11)
428382c8bcaSpl #define	AAC_CMD_ERR			(1 << 12)
429830d82f7Spl 
4307c478bd9Sstevel@tonic-gate struct aac_cmd {
431382c8bcaSpl 	/*
432382c8bcaSpl 	 * Note: should be the first member for aac_cmd_queue to work
433382c8bcaSpl 	 * correctly.
434382c8bcaSpl 	 */
4357c478bd9Sstevel@tonic-gate 	struct aac_cmd *next;
436382c8bcaSpl 	struct aac_cmd *prev;
437382c8bcaSpl 
4387c478bd9Sstevel@tonic-gate 	struct scsi_pkt *pkt;
4397c478bd9Sstevel@tonic-gate 	int cmdlen;
4407c478bd9Sstevel@tonic-gate 	int flags;
441382c8bcaSpl 	uint32_t timeout; /* time when the cmd should have completed */
4427c478bd9Sstevel@tonic-gate 	struct buf *bp;
4437c478bd9Sstevel@tonic-gate 	ddi_dma_handle_t buf_dma_handle;
444830d82f7Spl 
445830d82f7Spl 	/* For non-aligned buffer and SRB */
446830d82f7Spl 	caddr_t abp;
447830d82f7Spl 	ddi_acc_handle_t abh;
448830d82f7Spl 
449c9487164Spl 	/* Data transfer state */
4507c478bd9Sstevel@tonic-gate 	ddi_dma_cookie_t cookie;
4517c478bd9Sstevel@tonic-gate 	uint_t left_cookien;
4527c478bd9Sstevel@tonic-gate 	uint_t cur_win;
4537c478bd9Sstevel@tonic-gate 	uint_t total_nwin;
4547c478bd9Sstevel@tonic-gate 	size_t total_xfer;
455d7c5bf88Spl 	uint64_t blkno;
456d7c5bf88Spl 	uint32_t bcount;	/* buffer size in byte */
457942c5e3cSpl 	struct aac_sge *sgt;	/* sg table */
458d7c5bf88Spl 
459942c5e3cSpl 	/* FIB construct function */
460942c5e3cSpl 	aac_cmd_fib_t aac_cmd_fib;
461d7c5bf88Spl 	/* Call back function for completed command */
462d7c5bf88Spl 	void (*ac_comp)(struct aac_softstate *, struct aac_cmd *);
463d7c5bf88Spl 
464830d82f7Spl 	struct aac_slot *slotp;	/* slot used by this command */
46558bc78c7SXin Chen 	struct aac_device *dvp;	/* target device */
4667c478bd9Sstevel@tonic-gate 
467d7c5bf88Spl 	/* FIB for this IO command */
468d7c5bf88Spl 	int fib_size; /* size of the FIB xferred to/from the card */
469d7c5bf88Spl 	struct aac_fib *fibp;
47058bc78c7SXin Chen 
47158bc78c7SXin Chen #ifdef DEBUG
47258bc78c7SXin Chen 	uint32_t fib_flags;
47358bc78c7SXin Chen #endif
4747c478bd9Sstevel@tonic-gate };
4757c478bd9Sstevel@tonic-gate 
4761dd0a2dbSpl #ifdef DEBUG
4771dd0a2dbSpl 
4781dd0a2dbSpl #define	AACDB_FLAGS_MASK		0x0000ffff
4791dd0a2dbSpl #define	AACDB_FLAGS_KERNEL_PRINT	0x00000001
4801dd0a2dbSpl #define	AACDB_FLAGS_FW_PRINT		0x00000002
481942c5e3cSpl #define	AACDB_FLAGS_NO_HEADERS		0x00000004
482942c5e3cSpl 
483942c5e3cSpl #define	AACDB_FLAGS_MISC		0x00000010
484942c5e3cSpl #define	AACDB_FLAGS_FUNC1		0x00000020
485942c5e3cSpl #define	AACDB_FLAGS_FUNC2		0x00000040
486942c5e3cSpl #define	AACDB_FLAGS_SCMD		0x00000080
487942c5e3cSpl #define	AACDB_FLAGS_AIF			0x00000100
488942c5e3cSpl #define	AACDB_FLAGS_FIB			0x00000200
489942c5e3cSpl #define	AACDB_FLAGS_IOCTL		0x00000400
4901dd0a2dbSpl 
49158bc78c7SXin Chen /*
49258bc78c7SXin Chen  * Flags for FIB print
49358bc78c7SXin Chen  */
49458bc78c7SXin Chen /* FIB sources */
49558bc78c7SXin Chen #define	AACDB_FLAGS_FIB_SCMD		0x00000001
49658bc78c7SXin Chen #define	AACDB_FLAGS_FIB_IOCTL		0x00000002
49758bc78c7SXin Chen #define	AACDB_FLAGS_FIB_SRB		0x00000004
49858bc78c7SXin Chen #define	AACDB_FLAGS_FIB_SYNC		0x00000008
49958bc78c7SXin Chen /* FIB components */
50058bc78c7SXin Chen #define	AACDB_FLAGS_FIB_HEADER		0x00000010
50158bc78c7SXin Chen /* FIB states */
50258bc78c7SXin Chen #define	AACDB_FLAGS_FIB_TIMEOUT		0x00000100
50358bc78c7SXin Chen 
5041dd0a2dbSpl extern uint32_t aac_debug_flags;
5051dd0a2dbSpl extern int aac_dbflag_on(struct aac_softstate *, int);
5061dd0a2dbSpl extern void aac_printf(struct aac_softstate *, uint_t, const char *, ...);
50758bc78c7SXin Chen extern void aac_print_fib(struct aac_softstate *, struct aac_slot *);
5081dd0a2dbSpl 
5091dd0a2dbSpl #define	AACDB_PRINT(s, lev, ...) { \
5101dd0a2dbSpl 	if (aac_dbflag_on((s), AACDB_FLAGS_MISC)) \
5111dd0a2dbSpl 		aac_printf((s), (lev), __VA_ARGS__); }
5121dd0a2dbSpl 
5131dd0a2dbSpl #define	AACDB_PRINT_IOCTL(s, ...) { \
5141dd0a2dbSpl 	if (aac_dbflag_on((s), AACDB_FLAGS_IOCTL)) \
5151dd0a2dbSpl 		aac_printf((s), CE_NOTE, __VA_ARGS__); }
5161dd0a2dbSpl 
5171dd0a2dbSpl #define	AACDB_PRINT_TRAN(s, ...) { \
5181dd0a2dbSpl 	if (aac_dbflag_on((s), AACDB_FLAGS_SCMD)) \
5191dd0a2dbSpl 		aac_printf((s), CE_NOTE, __VA_ARGS__); }
5201dd0a2dbSpl 
5211dd0a2dbSpl #define	DBCALLED(s, n) { \
5221dd0a2dbSpl 	if (aac_dbflag_on((s), AACDB_FLAGS_FUNC ## n)) \
5231dd0a2dbSpl 		aac_printf((s), CE_NOTE, "--- %s() called ---", __func__); }
5241dd0a2dbSpl 
5251dd0a2dbSpl #define	AACDB_PRINT_SCMD(s, x) { \
5261dd0a2dbSpl 	if (aac_dbflag_on((s), AACDB_FLAGS_SCMD)) aac_print_scmd((s), (x)); }
5271dd0a2dbSpl 
5281dd0a2dbSpl #define	AACDB_PRINT_AIF(s, x) { \
5291dd0a2dbSpl 	if (aac_dbflag_on((s), AACDB_FLAGS_AIF)) aac_print_aif((s), (x)); }
5301dd0a2dbSpl 
5311dd0a2dbSpl #define	AACDB_PRINT_FIB(s, x) { \
5321dd0a2dbSpl 	if (aac_dbflag_on((s), AACDB_FLAGS_FIB)) aac_print_fib((s), (x)); }
5331dd0a2dbSpl 
5341dd0a2dbSpl #else /* DEBUG */
5351dd0a2dbSpl 
5361dd0a2dbSpl #define	AACDB_PRINT(s, lev, ...)
5371dd0a2dbSpl #define	AACDB_PRINT_IOCTL(s, ...)
5381dd0a2dbSpl #define	AACDB_PRINT_TRAN(s, ...)
5391dd0a2dbSpl #define	AACDB_PRINT_FIB(s, x)
5401dd0a2dbSpl #define	AACDB_PRINT_SCMD(s, x)
5411dd0a2dbSpl #define	AACDB_PRINT_AIF(s, x)
5421dd0a2dbSpl #define	DBCALLED(s, n)
5431dd0a2dbSpl 
5441dd0a2dbSpl #endif /* DEBUG */
5451dd0a2dbSpl 
5467c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
5477c478bd9Sstevel@tonic-gate }
5487c478bd9Sstevel@tonic-gate #endif
5497c478bd9Sstevel@tonic-gate 
5507c478bd9Sstevel@tonic-gate #endif /* _AAC_H_ */
551