mpt.h revision 178814
1/* $FreeBSD: head/sys/dev/mpt/mpt.h 178814 2008-05-06 20:49:53Z jhb $ */
2/*-
3 * Generic defines for LSI '909 FC  adapters.
4 * FreeBSD Version.
5 *
6 * Copyright (c)  2000, 2001 by Greg Ansley
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice immediately at the beginning of the file, without modification,
13 *    this list of conditions, and the following disclaimer.
14 * 2. The name of the author may not be used to endorse or promote products
15 *    derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29/*-
30 * Copyright (c) 2002, 2006 by Matthew Jacob
31 * All rights reserved.
32 *
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions are
35 * met:
36 * 1. Redistributions of source code must retain the above copyright
37 *    notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
39 *    substantially similar to the "NO WARRANTY" disclaimer below
40 *    ("Disclaimer") and any redistribution must be conditioned upon including
41 *    a substantially similar Disclaimer requirement for further binary
42 *    redistribution.
43 * 3. Neither the names of the above listed copyright holders nor the names
44 *    of any contributors may be used to endorse or promote products derived
45 *    from this software without specific prior written permission.
46 *
47 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
48 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
51 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
52 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
53 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
54 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
55 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
56 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
57 * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58 *
59 * Support from Chris Ellsworth in order to make SAS adapters work
60 * is gratefully acknowledged.
61 *
62 *
63 * Support from LSI-Logic has also gone a great deal toward making this a
64 * workable subsystem and is gratefully acknowledged.
65 */
66/*
67 * Copyright (c) 2004, Avid Technology, Inc. and its contributors.
68 * Copyright (c) 2004, 2005 Justin T. Gibbs
69 * Copyright (c) 2005, WHEEL Sp. z o.o.
70 * All rights reserved.
71 *
72 * Redistribution and use in source and binary forms, with or without
73 * modification, are permitted provided that the following conditions are
74 * met:
75 * 1. Redistributions of source code must retain the above copyright
76 *    notice, this list of conditions and the following disclaimer.
77 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
78 *    substantially similar to the "NO WARRANTY" disclaimer below
79 *    ("Disclaimer") and any redistribution must be conditioned upon including
80 *    a substantially similar Disclaimer requirement for further binary
81 *    redistribution.
82 * 3. Neither the names of the above listed copyright holders nor the names
83 *    of any contributors may be used to endorse or promote products derived
84 *    from this software without specific prior written permission.
85 *
86 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
87 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
88 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
89 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
90 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
91 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
92 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
93 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
94 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
95 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
96 * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
97 */
98
99#ifndef _MPT_H_
100#define _MPT_H_
101
102/********************************* OS Includes ********************************/
103#include <sys/types.h>
104#include <sys/param.h>
105#include <sys/systm.h>
106#include <sys/endian.h>
107#include <sys/eventhandler.h>
108#if __FreeBSD_version < 500000
109#include <sys/kernel.h>
110#include <sys/queue.h>
111#include <sys/malloc.h>
112#include <sys/devicestat.h>
113#else
114#include <sys/lock.h>
115#include <sys/kernel.h>
116#include <sys/queue.h>
117#include <sys/malloc.h>
118#include <sys/mutex.h>
119#include <sys/condvar.h>
120#endif
121#include <sys/proc.h>
122#include <sys/bus.h>
123#include <sys/module.h>
124
125#include <machine/cpu.h>
126#include <machine/resource.h>
127
128#if __FreeBSD_version < 500000
129#include <machine/bus.h>
130#include <machine/clock.h>
131#endif
132
133#include <sys/rman.h>
134
135#if __FreeBSD_version < 500000
136#include <pci/pcireg.h>
137#include <pci/pcivar.h>
138#else
139#include <dev/pci/pcireg.h>
140#include <dev/pci/pcivar.h>
141#endif
142
143#include <machine/bus.h>
144#include "opt_ddb.h"
145
146/**************************** Register Definitions ****************************/
147#include <dev/mpt/mpt_reg.h>
148
149/******************************* MPI Definitions ******************************/
150#include <dev/mpt/mpilib/mpi_type.h>
151#include <dev/mpt/mpilib/mpi.h>
152#include <dev/mpt/mpilib/mpi_cnfg.h>
153#include <dev/mpt/mpilib/mpi_ioc.h>
154#include <dev/mpt/mpilib/mpi_raid.h>
155
156/* XXX For mpt_debug.c */
157#include <dev/mpt/mpilib/mpi_init.h>
158
159#define	MPT_S64_2_SCALAR(y)	((((int64_t)y.High) << 32) | (y.Low))
160#define	MPT_U64_2_SCALAR(y)	((((uint64_t)y.High) << 32) | (y.Low))
161
162/****************************** Misc Definitions ******************************/
163/* #define MPT_TEST_MULTIPATH	1 */
164#define MPT_OK (0)
165#define MPT_FAIL (0x10000)
166
167#define NUM_ELEMENTS(array) (sizeof(array) / sizeof(*array))
168
169#define	MPT_ROLE_NONE		0
170#define	MPT_ROLE_INITIATOR	1
171#define	MPT_ROLE_TARGET		2
172#define	MPT_ROLE_BOTH		3
173#define	MPT_ROLE_DEFAULT	MPT_ROLE_INITIATOR
174
175/**************************** Forward Declarations ****************************/
176struct mpt_softc;
177struct mpt_personality;
178typedef struct req_entry request_t;
179
180/************************* Personality Module Support *************************/
181typedef int mpt_load_handler_t(struct mpt_personality *);
182typedef int mpt_probe_handler_t(struct mpt_softc *);
183typedef int mpt_attach_handler_t(struct mpt_softc *);
184typedef int mpt_enable_handler_t(struct mpt_softc *);
185typedef void mpt_ready_handler_t(struct mpt_softc *);
186typedef int mpt_event_handler_t(struct mpt_softc *, request_t *,
187				MSG_EVENT_NOTIFY_REPLY *);
188typedef void mpt_reset_handler_t(struct mpt_softc *, int /*type*/);
189/* XXX Add return value and use for veto? */
190typedef void mpt_shutdown_handler_t(struct mpt_softc *);
191typedef void mpt_detach_handler_t(struct mpt_softc *);
192typedef int mpt_unload_handler_t(struct mpt_personality *);
193
194struct mpt_personality
195{
196	const char		*name;
197	uint32_t		 id;		/* Assigned identifier. */
198	u_int			 use_count;	/* Instances using personality*/
199	mpt_load_handler_t	*load;		/* configure personailty */
200#define MPT_PERS_FIRST_HANDLER(pers) (&(pers)->load)
201	mpt_probe_handler_t	*probe;		/* configure personailty */
202	mpt_attach_handler_t	*attach;	/* initialize device instance */
203	mpt_enable_handler_t	*enable;	/* enable device */
204	mpt_ready_handler_t	*ready;		/* final open for business */
205	mpt_event_handler_t	*event;		/* Handle MPI event. */
206	mpt_reset_handler_t	*reset;		/* Re-init after reset. */
207	mpt_shutdown_handler_t	*shutdown;	/* Shutdown instance. */
208	mpt_detach_handler_t	*detach;	/* release device instance */
209	mpt_unload_handler_t	*unload;	/* Shutdown personality */
210#define MPT_PERS_LAST_HANDLER(pers) (&(pers)->unload)
211};
212
213int mpt_modevent(module_t, int, void *);
214
215/* Maximum supported number of personalities. */
216#define MPT_MAX_PERSONALITIES	(15)
217
218#define MPT_PERSONALITY_DEPEND(name, dep, vmin, vpref, vmax) \
219	MODULE_DEPEND(name, dep, vmin, vpref, vmax)
220
221#define DECLARE_MPT_PERSONALITY(name, order)				  \
222	static moduledata_t name##_mod = {				  \
223		#name, mpt_modevent, &name##_personality		  \
224	};								  \
225	DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, order);	  \
226	MODULE_VERSION(name, 1);					  \
227	MPT_PERSONALITY_DEPEND(name, mpt_core, 1, 1, 1)
228
229/******************************* Bus DMA Support ******************************/
230/* XXX Need to update bus_dmamap_sync to take a range argument. */
231#define bus_dmamap_sync_range(dma_tag, dmamap, offset, len, op)	\
232	bus_dmamap_sync(dma_tag, dmamap, op)
233
234#if __FreeBSD_version < 600000
235#define	bus_get_dma_tag(x)	NULL
236#endif
237#if __FreeBSD_version >= 501102
238#define mpt_dma_tag_create(mpt, parent_tag, alignment, boundary,	\
239			   lowaddr, highaddr, filter, filterarg,	\
240			   maxsize, nsegments, maxsegsz, flags,		\
241			   dma_tagp)					\
242	bus_dma_tag_create(parent_tag, alignment, boundary,		\
243			   lowaddr, highaddr, filter, filterarg,	\
244			   maxsize, nsegments, maxsegsz, flags,		\
245			   busdma_lock_mutex, &(mpt)->mpt_lock,		\
246			   dma_tagp)
247#else
248#define mpt_dma_tag_create(mpt, parent_tag, alignment, boundary,	\
249			   lowaddr, highaddr, filter, filterarg,	\
250			   maxsize, nsegments, maxsegsz, flags,		\
251			   dma_tagp)					\
252	bus_dma_tag_create(parent_tag, alignment, boundary,		\
253			   lowaddr, highaddr, filter, filterarg,	\
254			   maxsize, nsegments, maxsegsz, flags,		\
255			   dma_tagp)
256#endif
257
258struct mpt_map_info {
259	struct mpt_softc *mpt;
260	int		  error;
261	uint32_t	  phys;
262};
263
264void mpt_map_rquest(void *, bus_dma_segment_t *, int, int);
265/* **************************** NewBUS interrupt Crock ************************/
266#if __FreeBSD_version < 700031
267#define	mpt_setup_intr(d, i, f, U, if, ifa, hp)	\
268	bus_setup_intr(d, i, f, if, ifa, hp)
269#else
270#define	mpt_setup_intr	bus_setup_intr
271#endif
272
273/* **************************** NewBUS CAM Support ****************************/
274#if __FreeBSD_version < 700049
275#define mpt_xpt_bus_register(sim, parent, bus)	\
276	xpt_bus_register(sim, bus)
277#else
278#define mpt_xpt_bus_register	xpt_bus_register
279#endif
280
281/**************************** Kernel Thread Support ***************************/
282#if __FreeBSD_version > 800001
283#define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
284	kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
285#define	mpt_kthread_exit(status)	\
286	kproc_exit(status)
287#elif __FreeBSD_version > 500005
288#define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
289	kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
290#define	mpt_kthread_exit(status)	\
291	kthread_exit(status)
292#else
293#define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
294	kthread_create(func, farg, proc_ptr, fmtstr, arg)
295#define	mpt_kthread_exit(status)	\
296	kthread_exit(status)
297#endif
298
299/****************************** Timer Facilities ******************************/
300#if __FreeBSD_version > 500000
301#define mpt_callout_init(c)	callout_init(c, /*mpsafe*/1);
302#else
303#define mpt_callout_init(c)	callout_init(c);
304#endif
305
306/********************************** Endianess *********************************/
307#define	MPT_2_HOST64(ptr, tag)	ptr->tag = le64toh(ptr->tag)
308#define	MPT_2_HOST32(ptr, tag)	ptr->tag = le32toh(ptr->tag)
309#define	MPT_2_HOST16(ptr, tag)	ptr->tag = le16toh(ptr->tag)
310
311#define	HOST_2_MPT64(ptr, tag)	ptr->tag = htole64(ptr->tag)
312#define	HOST_2_MPT32(ptr, tag)	ptr->tag = htole32(ptr->tag)
313#define	HOST_2_MPT16(ptr, tag)	ptr->tag = htole16(ptr->tag)
314
315#if	_BYTE_ORDER == _BIG_ENDIAN
316void mpt2host_sge_simple_union(SGE_SIMPLE_UNION *);
317void mpt2host_iocfacts_reply(MSG_IOC_FACTS_REPLY *);
318void mpt2host_portfacts_reply(MSG_PORT_FACTS_REPLY *);
319void mpt2host_config_page_ioc2(CONFIG_PAGE_IOC_2 *);
320void mpt2host_config_page_raid_vol_0(CONFIG_PAGE_RAID_VOL_0 *);
321void mpt2host_mpi_raid_vol_indicator(MPI_RAID_VOL_INDICATOR *);
322#else
323#define	mpt2host_sge_simple_union(x)		do { ; } while (0)
324#define	mpt2host_iocfacts_reply(x)		do { ; } while (0)
325#define	mpt2host_portfacts_reply(x)		do { ; } while (0)
326#define	mpt2host_config_page_ioc2(x)		do { ; } while (0)
327#define	mpt2host_config_page_raid_vol_0(x)	do { ; } while (0)
328#define	mpt2host_mpi_raid_vol_indicator(x)	do { ; } while (0)
329#endif
330
331/**************************** MPI Transaction State ***************************/
332typedef enum {
333	REQ_STATE_NIL		= 0x00,
334	REQ_STATE_FREE		= 0x01,
335	REQ_STATE_ALLOCATED	= 0x02,
336	REQ_STATE_QUEUED	= 0x04,
337	REQ_STATE_DONE		= 0x08,
338	REQ_STATE_TIMEDOUT	= 0x10,
339	REQ_STATE_NEED_WAKEUP	= 0x20,
340	REQ_STATE_LOCKED	= 0x80,	/* can't be freed */
341	REQ_STATE_MASK		= 0xFF
342} mpt_req_state_t;
343
344struct req_entry {
345	TAILQ_ENTRY(req_entry) links;	/* Pointer to next in list */
346	mpt_req_state_t	state;		/* Request State Information */
347	uint16_t	index;		/* Index of this entry */
348	uint16_t	IOCStatus;	/* Completion status */
349	uint16_t	ResponseCode;	/* TMF Reponse Code */
350	uint16_t	serno;		/* serial number */
351	union ccb      *ccb;		/* CAM request */
352	void	       *req_vbuf;	/* Virtual Address of Entry */
353	void	       *sense_vbuf;	/* Virtual Address of sense data */
354	bus_addr_t	req_pbuf;	/* Physical Address of Entry */
355	bus_addr_t	sense_pbuf;	/* Physical Address of sense data */
356	bus_dmamap_t	dmap;		/* DMA map for data buffers */
357	struct req_entry *chain;	/* for SGE overallocations */
358	struct callout  callout;	/* Timeout for the request */
359};
360
361typedef struct mpt_config_params {
362	u_int		Action;
363	u_int		PageVersion;
364	u_int		PageLength;
365	u_int		PageNumber;
366	u_int		PageType;
367	u_int		PageAddress;
368	u_int		ExtPageLength;
369	u_int		ExtPageType;
370} cfgparms_t;
371
372/**************************** MPI Target State Info ***************************/
373
374typedef struct {
375	uint32_t reply_desc;	/* current reply descriptor */
376	uint32_t resid;		/* current data residual */
377	uint32_t bytes_xfered;	/* current relative offset */
378	union ccb *ccb;		/* pointer to currently active ccb */
379	request_t *req;		/* pointer to currently active assist request */
380	uint32_t
381		is_local : 1,
382		nxfers	 : 31;
383	uint32_t tag_id;
384	enum {
385		TGT_STATE_NIL,
386		TGT_STATE_LOADING,
387		TGT_STATE_LOADED,
388		TGT_STATE_IN_CAM,
389                TGT_STATE_SETTING_UP_FOR_DATA,
390                TGT_STATE_MOVING_DATA,
391                TGT_STATE_MOVING_DATA_AND_STATUS,
392                TGT_STATE_SENDING_STATUS
393	} state;
394} mpt_tgt_state_t;
395
396/*
397 * When we get an incoming command it has its own tag which is called the
398 * IoIndex. This is the value we gave that particular command buffer when
399 * we originally assigned it. It's just a number, really. The FC card uses
400 * it as an RX_ID. We can use it to index into mpt->tgt_cmd_ptrs, which
401 * contains pointers the request_t structures related to that IoIndex.
402 *
403 * What *we* do is construct a tag out of the index for the target command
404 * which owns the incoming ATIO plus a rolling sequence number.
405 */
406#define	MPT_MAKE_TAGID(mpt, req, ioindex)	\
407 ((ioindex << 18) | (((mpt->sequence++) & 0x3f) << 12) | (req->index & 0xfff))
408
409#ifdef	INVARIANTS
410#define	MPT_TAG_2_REQ(a, b)		mpt_tag_2_req(a, (uint32_t) b)
411#else
412#define	MPT_TAG_2_REQ(mpt, tag)		mpt->tgt_cmd_ptrs[tag >> 18]
413#endif
414
415#define	MPT_TGT_STATE(mpt, req) ((mpt_tgt_state_t *) \
416    (&((uint8_t *)req->req_vbuf)[MPT_RQSL(mpt) - sizeof (mpt_tgt_state_t)]))
417
418STAILQ_HEAD(mpt_hdr_stailq, ccb_hdr);
419#define	MPT_MAX_LUNS	256
420typedef struct {
421	struct mpt_hdr_stailq	atios;
422	struct mpt_hdr_stailq	inots;
423	int enabled;
424} tgt_resource_t;
425#define	MPT_MAX_ELS	64
426
427/**************************** Handler Registration ****************************/
428/*
429 * Global table of registered reply handlers.  The
430 * handler is indicated by byte 3 of the request
431 * index submitted to the IOC.  This allows the
432 * driver core to perform generic processing without
433 * any knowledge of per-personality behavior.
434 *
435 * MPT_NUM_REPLY_HANDLERS must be a power of 2
436 * to allow the easy generation of a mask.
437 *
438 * The handler offsets used by the core are hard coded
439 * allowing faster code generation when assigning a handler
440 * to a request.  All "personalities" must use the
441 * the handler registration mechanism.
442 *
443 * The IOC handlers that are rarely executed are placed
444 * at the tail of the table to make it more likely that
445 * all commonly executed handlers fit in a single cache
446 * line.
447 */
448#define MPT_NUM_REPLY_HANDLERS		(32)
449#define MPT_REPLY_HANDLER_EVENTS	MPT_CBI_TO_HID(0)
450#define MPT_REPLY_HANDLER_CONFIG	MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-1)
451#define MPT_REPLY_HANDLER_HANDSHAKE	MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-2)
452typedef int mpt_reply_handler_t(struct mpt_softc *mpt, request_t *request,
453    uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame);
454typedef union {
455	mpt_reply_handler_t	*reply_handler;
456} mpt_handler_t;
457
458typedef enum {
459	MPT_HANDLER_REPLY,
460	MPT_HANDLER_EVENT,
461	MPT_HANDLER_RESET,
462	MPT_HANDLER_SHUTDOWN
463} mpt_handler_type;
464
465struct mpt_handler_record
466{
467	LIST_ENTRY(mpt_handler_record)	links;
468	mpt_handler_t			handler;
469};
470
471LIST_HEAD(mpt_handler_list, mpt_handler_record);
472
473/*
474 * The handler_id is currently unused but would contain the
475 * handler ID used in the MsgContext field to allow direction
476 * of replies to the handler.  Registrations that don't require
477 * a handler id can pass in NULL for the handler_id.
478 *
479 * Deregistrations for handlers without a handler id should
480 * pass in MPT_HANDLER_ID_NONE.
481 */
482#define MPT_HANDLER_ID_NONE		(0xFFFFFFFF)
483int mpt_register_handler(struct mpt_softc *, mpt_handler_type,
484			 mpt_handler_t, uint32_t *);
485int mpt_deregister_handler(struct mpt_softc *, mpt_handler_type,
486			   mpt_handler_t, uint32_t);
487
488/******************* Per-Controller Instance Data Structures ******************/
489TAILQ_HEAD(req_queue, req_entry);
490
491/* Structure for saving proper values for modifyable PCI config registers */
492struct mpt_pci_cfg {
493	uint16_t Command;
494	uint16_t LatencyTimer_LineSize;
495	uint32_t IO_BAR;
496	uint32_t Mem0_BAR[2];
497	uint32_t Mem1_BAR[2];
498	uint32_t ROM_BAR;
499	uint8_t  IntLine;
500	uint32_t PMCSR;
501};
502
503typedef enum {
504	MPT_RVF_NONE		= 0x0,
505	MPT_RVF_ACTIVE		= 0x1,
506	MPT_RVF_ANNOUNCED	= 0x2,
507	MPT_RVF_UP2DATE		= 0x4,
508	MPT_RVF_REFERENCED	= 0x8,
509	MPT_RVF_WCE_CHANGED	= 0x10
510} mpt_raid_volume_flags;
511
512struct mpt_raid_volume {
513	CONFIG_PAGE_RAID_VOL_0	       *config_page;
514	MPI_RAID_VOL_INDICATOR		sync_progress;
515	mpt_raid_volume_flags		flags;
516	u_int				quiesced_disks;
517};
518
519typedef enum {
520	MPT_RDF_NONE		= 0x00,
521	MPT_RDF_ACTIVE		= 0x01,
522	MPT_RDF_ANNOUNCED	= 0x02,
523	MPT_RDF_UP2DATE		= 0x04,
524	MPT_RDF_REFERENCED	= 0x08,
525	MPT_RDF_QUIESCING	= 0x10,
526	MPT_RDF_QUIESCED	= 0x20
527} mpt_raid_disk_flags;
528
529struct mpt_raid_disk {
530	CONFIG_PAGE_RAID_PHYS_DISK_0	config_page;
531	struct mpt_raid_volume	       *volume;
532	u_int				member_number;
533	u_int				pass_thru_active;
534	mpt_raid_disk_flags		flags;
535};
536
537struct mpt_evtf_record {
538	MSG_EVENT_NOTIFY_REPLY		reply;
539	uint32_t			context;
540	LIST_ENTRY(mpt_evtf_record)	links;
541};
542
543LIST_HEAD(mpt_evtf_list, mpt_evtf_record);
544
545struct mptsas_devinfo {
546	uint16_t	dev_handle;
547	uint16_t	parent_dev_handle;
548	uint16_t	enclosure_handle;
549	uint16_t	slot;
550	uint8_t		phy_num;
551	uint8_t		physical_port;
552	uint8_t		target_id;
553	uint8_t		bus;
554	uint64_t	sas_address;
555	uint32_t	device_info;
556};
557
558struct mptsas_phyinfo {
559	uint16_t	handle;
560	uint8_t		phy_num;
561	uint8_t		port_id;
562	uint8_t		negotiated_link_rate;
563	uint8_t		hw_link_rate;
564	uint8_t		programmed_link_rate;
565	uint8_t		sas_port_add_phy;
566	struct mptsas_devinfo identify;
567	struct mptsas_devinfo attached;
568};
569
570struct mptsas_portinfo {
571	uint16_t			num_phys;
572	struct mptsas_phyinfo		*phy_info;
573};
574
575struct mpt_softc {
576	device_t		dev;
577#if __FreeBSD_version < 500000
578	uint32_t		mpt_islocked;
579	int			mpt_splsaved;
580#else
581	struct mtx		mpt_lock;
582	int			mpt_locksetup;
583#endif
584	uint32_t		mpt_pers_mask;
585	uint32_t
586				: 8,
587		unit		: 8,
588		ready		: 1,
589		fw_uploaded	: 1,
590		msi_enable	: 1,
591		twildcard	: 1,
592		tenabled	: 1,
593		do_cfg_role	: 1,
594		raid_enabled	: 1,
595		raid_mwce_set	: 1,
596		getreqwaiter	: 1,
597		shutdwn_raid    : 1,
598		shutdwn_recovery: 1,
599		outofbeer	: 1,
600		disabled	: 1,
601		is_spi		: 1,
602		is_sas		: 1,
603		is_fc		: 1;
604
605	u_int			cfg_role;
606	u_int			role;	/* role: none, ini, target, both */
607
608	u_int			verbose;
609#ifdef	MPT_TEST_MULTIPATH
610	int			failure_id;
611#endif
612
613	/*
614	 * IOC Facts
615	 */
616	MSG_IOC_FACTS_REPLY	ioc_facts;
617
618	/*
619	 * Port Facts
620	 */
621	MSG_PORT_FACTS_REPLY *	port_facts;
622#define	mpt_ini_id	port_facts[0].PortSCSIID
623#define	mpt_max_tgtcmds	port_facts[0].MaxPostedCmdBuffers
624
625	/*
626	 * Device Configuration Information
627	 */
628	union {
629		struct mpt_spi_cfg {
630			CONFIG_PAGE_SCSI_PORT_0		_port_page0;
631			CONFIG_PAGE_SCSI_PORT_1		_port_page1;
632			CONFIG_PAGE_SCSI_PORT_2		_port_page2;
633			CONFIG_PAGE_SCSI_DEVICE_0	_dev_page0[16];
634			CONFIG_PAGE_SCSI_DEVICE_1	_dev_page1[16];
635			uint16_t			_tag_enable;
636			uint16_t			_disc_enable;
637		} spi;
638#define	mpt_port_page0		cfg.spi._port_page0
639#define	mpt_port_page1		cfg.spi._port_page1
640#define	mpt_port_page2		cfg.spi._port_page2
641#define	mpt_dev_page0		cfg.spi._dev_page0
642#define	mpt_dev_page1		cfg.spi._dev_page1
643#define	mpt_tag_enable		cfg.spi._tag_enable
644#define	mpt_disc_enable		cfg.spi._disc_enable
645		struct mpi_fc_cfg {
646			CONFIG_PAGE_FC_PORT_0 _port_page0;
647			uint32_t _port_speed;
648#define	mpt_fcport_page0	cfg.fc._port_page0
649#define	mpt_fcport_speed	cfg.fc._port_speed
650		} fc;
651	} cfg;
652#if __FreeBSD_version >= 500000
653	/*
654	 * Device config information stored up for sysctl to access
655	 */
656	union {
657		struct {
658			unsigned int initiator_id;
659		} spi;
660		struct {
661			char wwnn[19];
662			char wwpn[19];
663		} fc;
664	} scinfo;
665#endif
666
667	/* Controller Info for RAID information */
668	CONFIG_PAGE_IOC_2 *	ioc_page2;
669	CONFIG_PAGE_IOC_3 *	ioc_page3;
670
671	/* Raid Data */
672	struct mpt_raid_volume* raid_volumes;
673	struct mpt_raid_disk*	raid_disks;
674	u_int			raid_max_volumes;
675	u_int			raid_max_disks;
676	u_int			raid_page0_len;
677	u_int			raid_wakeup;
678	u_int			raid_rescan;
679	u_int			raid_resync_rate;
680	u_int			raid_mwce_setting;
681	u_int			raid_queue_depth;
682	u_int			raid_nonopt_volumes;
683	struct proc	       *raid_thread;
684	struct callout		raid_timer;
685
686	/*
687	 * PCI Hardware info
688	 */
689	int			pci_msi_count;
690	struct resource *	pci_irq;	/* Interrupt map for chip */
691	void *			ih;		/* Interupt handle */
692	struct mpt_pci_cfg	pci_cfg;	/* saved PCI conf registers */
693
694	/*
695	 * DMA Mapping Stuff
696	 */
697	struct resource *	pci_reg;	/* Register map for chip */
698	int			pci_mem_rid;	/* Resource ID */
699	bus_space_tag_t		pci_st;		/* Bus tag for registers */
700	bus_space_handle_t	pci_sh;		/* Bus handle for registers */
701	/* PIO versions of above. */
702	int			pci_pio_rid;
703	struct resource *	pci_pio_reg;
704	bus_space_tag_t		pci_pio_st;
705	bus_space_handle_t	pci_pio_sh;
706
707	bus_dma_tag_t		parent_dmat;	/* DMA tag for parent PCI bus */
708	bus_dma_tag_t		reply_dmat;	/* DMA tag for reply memory */
709	bus_dmamap_t		reply_dmap;	/* DMA map for reply memory */
710	uint8_t		       *reply;		/* KVA of reply memory */
711	bus_addr_t		reply_phys;	/* BusAddr of reply memory */
712
713	bus_dma_tag_t		buffer_dmat;	/* DMA tag for buffers */
714	bus_dma_tag_t		request_dmat;	/* DMA tag for request memroy */
715	bus_dmamap_t		request_dmap;	/* DMA map for request memroy */
716	uint8_t		       *request;	/* KVA of Request memory */
717	bus_addr_t		request_phys;	/* BusAddr of request memory */
718
719	uint32_t		max_seg_cnt;	/* calculated after IOC facts */
720
721	/*
722	 * Hardware management
723	 */
724	u_int			reset_cnt;
725
726	/*
727	 * CAM && Software Management
728	 */
729	request_t	       *request_pool;
730	struct req_queue	request_free_list;
731	struct req_queue	request_pending_list;
732	struct req_queue	request_timeout_list;
733
734
735	struct cam_sim	       *sim;
736	struct cam_path	       *path;
737
738	struct cam_sim	       *phydisk_sim;
739	struct cam_path	       *phydisk_path;
740
741	struct proc	       *recovery_thread;
742	request_t	       *tmf_req;
743
744	/*
745	 * Deferred frame acks due to resource shortage.
746	 */
747	struct mpt_evtf_list	ack_frames;
748
749	/*
750	 * Target Mode Support
751	 */
752	uint32_t		scsi_tgt_handler_id;
753	request_t **		tgt_cmd_ptrs;
754	request_t **		els_cmd_ptrs;	/* FC only */
755
756	/*
757	 * *snork*- this is chosen to be here *just in case* somebody
758	 * forgets to point to it exactly and we index off of trt with
759	 * CAM_LUN_WILDCARD.
760	 */
761	tgt_resource_t		trt_wildcard;		/* wildcard luns */
762	tgt_resource_t		trt[MPT_MAX_LUNS];
763	uint16_t		tgt_cmds_allocated;
764	uint16_t		els_cmds_allocated;	/* FC only */
765
766	uint16_t		timeouts;	/* timeout count */
767	uint16_t		success;	/* successes afer timeout */
768	uint16_t		sequence;	/* Sequence Number */
769	uint16_t		pad3;
770
771
772	/* Paired port in some dual adapters configurations */
773	struct mpt_softc *	mpt2;
774
775	/* FW Image management */
776	uint32_t		fw_image_size;
777	uint8_t		       *fw_image;
778	bus_dma_tag_t		fw_dmat;	/* DMA tag for firmware image */
779	bus_dmamap_t		fw_dmap;	/* DMA map for firmware image */
780	bus_addr_t		fw_phys;	/* BusAddr of firmware image */
781
782	/* SAS Topology */
783	struct mptsas_portinfo	*sas_portinfo;
784
785	/* Shutdown Event Handler. */
786	eventhandler_tag         eh;
787
788	/* Userland management interface. */
789	struct cdev		*cdev;
790
791	TAILQ_ENTRY(mpt_softc)	links;
792};
793
794static __inline void mpt_assign_serno(struct mpt_softc *, request_t *);
795
796static __inline void
797mpt_assign_serno(struct mpt_softc *mpt, request_t *req)
798{
799	if ((req->serno = mpt->sequence++) == 0) {
800		req->serno = mpt->sequence++;
801	}
802}
803
804/***************************** Locking Primitives *****************************/
805#if __FreeBSD_version < 500000
806#define	MPT_IFLAGS		INTR_TYPE_CAM
807#define	MPT_LOCK(mpt)		mpt_lockspl(mpt)
808#define	MPT_UNLOCK(mpt)		mpt_unlockspl(mpt)
809#define	MPT_OWNED(mpt)		mpt->mpt_islocked
810#define	MPT_LOCK_ASSERT(mpt)
811#define	MPTLOCK_2_CAMLOCK	MPT_UNLOCK
812#define	CAMLOCK_2_MPTLOCK	MPT_LOCK
813#define	MPT_LOCK_SETUP(mpt)
814#define	MPT_LOCK_DESTROY(mpt)
815
816static __inline void mpt_lockspl(struct mpt_softc *mpt);
817static __inline void mpt_unlockspl(struct mpt_softc *mpt);
818
819static __inline void
820mpt_lockspl(struct mpt_softc *mpt)
821{
822       int s;
823
824       s = splcam();
825       if (mpt->mpt_islocked++ == 0) {
826               mpt->mpt_splsaved = s;
827       } else {
828               splx(s);
829	       panic("Recursed lock with mask: 0x%x\n", s);
830       }
831}
832
833static __inline void
834mpt_unlockspl(struct mpt_softc *mpt)
835{
836       if (mpt->mpt_islocked) {
837               if (--mpt->mpt_islocked == 0) {
838                       splx(mpt->mpt_splsaved);
839               }
840       } else
841	       panic("Negative lock count\n");
842}
843
844static __inline int
845mpt_sleep(struct mpt_softc *mpt, void *ident, int priority,
846	   const char *wmesg, int timo)
847{
848	int saved_cnt;
849	int saved_spl;
850	int error;
851
852	KASSERT(mpt->mpt_islocked <= 1, ("Invalid lock count on tsleep"));
853	saved_cnt = mpt->mpt_islocked;
854	saved_spl = mpt->mpt_splsaved;
855	mpt->mpt_islocked = 0;
856	error = tsleep(ident, priority, wmesg, timo);
857	KASSERT(mpt->mpt_islocked == 0, ("Invalid lock count on wakeup"));
858	mpt->mpt_islocked = saved_cnt;
859	mpt->mpt_splsaved = saved_spl;
860	return (error);
861}
862
863#define mpt_req_timeout(req, ticks, func, arg) \
864	callout_reset(&(req)->callout, (ticks), (func), (arg));
865#define mpt_req_untimeout(req, func, arg) \
866	callout_stop(&(req)->callout)
867
868#else
869#if 1
870#define	MPT_IFLAGS		INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
871#define	MPT_LOCK_SETUP(mpt)						\
872		mtx_init(&mpt->mpt_lock, "mpt", NULL, MTX_DEF);		\
873		mpt->mpt_locksetup = 1
874#define	MPT_LOCK_DESTROY(mpt)						\
875	if (mpt->mpt_locksetup) {					\
876		mtx_destroy(&mpt->mpt_lock);				\
877		mpt->mpt_locksetup = 0;					\
878	}
879
880#define	MPT_LOCK(mpt)		mtx_lock(&(mpt)->mpt_lock)
881#define	MPT_UNLOCK(mpt)		mtx_unlock(&(mpt)->mpt_lock)
882#define	MPT_OWNED(mpt)		mtx_owned(&(mpt)->mpt_lock)
883#define	MPT_LOCK_ASSERT(mpt)	mtx_assert(&(mpt)->mpt_lock, MA_OWNED)
884#define	MPTLOCK_2_CAMLOCK(mpt)
885#define	CAMLOCK_2_MPTLOCK(mpt)
886#define mpt_sleep(mpt, ident, priority, wmesg, timo) \
887	msleep(ident, &(mpt)->mpt_lock, priority, wmesg, timo)
888#define mpt_req_timeout(req, ticks, func, arg) \
889	callout_reset(&(req)->callout, (ticks), (func), (arg));
890#define mpt_req_untimeout(req, func, arg) \
891	callout_stop(&(req)->callout)
892
893#else
894
895#define	MPT_IFLAGS		INTR_TYPE_CAM | INTR_ENTROPY
896#define	MPT_LOCK_SETUP(mpt)	do { } while (0)
897#define	MPT_LOCK_DESTROY(mpt)	do { } while (0)
898#define	MPT_LOCK_ASSERT(mpt)	mtx_assert(&Giant, MA_OWNED)
899#define	MPT_LOCK(mpt)		mtx_lock(&Giant)
900#define	MPT_UNLOCK(mpt)		mtx_unlock(&Giant)
901#define	MPTLOCK_2_CAMLOCK(mpt)
902#define	CAMLOCK_2_MPTLOCK(mpt)
903
904static __inline int
905mpt_sleep(struct mpt_softc *, void *, int, const char *, int);
906
907#define mpt_ccb_timeout(ccb, ticks, func, arg) \
908	do {	\
909		(ccb)->ccb_h.timeout_ch = timeout((func), (arg), (ticks)); \
910	} while (0)
911#define mpt_ccb_untimeout(ccb, func, arg) \
912	untimeout((func), (arg), (ccb)->ccb_h.timeout_ch)
913#define mpt_ccb_timeout_init(ccb) \
914	callout_handle_init(&(ccb)->ccb_h.timeout_ch)
915
916static __inline int
917mpt_sleep(struct mpt_softc *mpt, void *i, int p, const char *w, int t)
918{
919	int r;
920	r = tsleep(i, p, w, t);
921	return (r);
922}
923#endif
924#endif
925
926/******************************* Register Access ******************************/
927static __inline void mpt_write(struct mpt_softc *, size_t, uint32_t);
928static __inline uint32_t mpt_read(struct mpt_softc *, int);
929static __inline void mpt_pio_write(struct mpt_softc *, size_t, uint32_t);
930static __inline uint32_t mpt_pio_read(struct mpt_softc *, int);
931
932static __inline void
933mpt_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
934{
935	bus_space_write_4(mpt->pci_st, mpt->pci_sh, offset, val);
936}
937
938static __inline uint32_t
939mpt_read(struct mpt_softc *mpt, int offset)
940{
941	return (bus_space_read_4(mpt->pci_st, mpt->pci_sh, offset));
942}
943
944/*
945 * Some operations (e.g. diagnostic register writes while the ARM proccessor
946 * is disabled), must be performed using "PCI pio" operations.  On non-PCI
947 * busses, these operations likely map to normal register accesses.
948 */
949static __inline void
950mpt_pio_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
951{
952	bus_space_write_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset, val);
953}
954
955static __inline uint32_t
956mpt_pio_read(struct mpt_softc *mpt, int offset)
957{
958	return (bus_space_read_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset));
959}
960/*********************** Reply Frame/Request Management ***********************/
961/* Max MPT Reply we are willing to accept (must be power of 2) */
962#define MPT_REPLY_SIZE   	256
963
964/*
965 * Must be less than 16384 in order for target mode to work
966 */
967#define MPT_MAX_REQUESTS(mpt)	512
968#define MPT_REQUEST_AREA	512
969#define MPT_SENSE_SIZE		32	/* included in MPT_REQUEST_AREA */
970#define MPT_REQ_MEM_SIZE(mpt)	(MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
971
972#define MPT_CONTEXT_CB_SHIFT	(16)
973#define MPT_CBI(handle)		(handle >> MPT_CONTEXT_CB_SHIFT)
974#define MPT_CBI_TO_HID(cbi)	((cbi) << MPT_CONTEXT_CB_SHIFT)
975#define MPT_CONTEXT_TO_CBI(x)	\
976    (((x) >> MPT_CONTEXT_CB_SHIFT) & (MPT_NUM_REPLY_HANDLERS - 1))
977#define MPT_CONTEXT_REQI_MASK	0xFFFF
978#define MPT_CONTEXT_TO_REQI(x)	((x) & MPT_CONTEXT_REQI_MASK)
979
980/*
981 * Convert a 32bit physical address returned from IOC to an
982 * offset into our reply frame memory or the kvm address needed
983 * to access the data.  The returned address is only the low
984 * 32 bits, so mask our base physical address accordingly.
985 */
986#define MPT_REPLY_BADDR(x)		\
987	(x << 1)
988#define MPT_REPLY_OTOV(m, i) 		\
989	((void *)(&m->reply[i]))
990
991#define	MPT_DUMP_REPLY_FRAME(mpt, reply_frame)		\
992do {							\
993	if (mpt->verbose > MPT_PRT_DEBUG)		\
994		mpt_dump_reply_frame(mpt, reply_frame);	\
995} while(0)
996
997static __inline uint32_t mpt_pop_reply_queue(struct mpt_softc *mpt);
998static __inline void mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr);
999
1000/*
1001 * Give the reply buffer back to the IOC after we have
1002 * finished processing it.
1003 */
1004static __inline void
1005mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr)
1006{
1007     mpt_write(mpt, MPT_OFFSET_REPLY_Q, ptr);
1008}
1009
1010/* Get a reply from the IOC */
1011static __inline uint32_t
1012mpt_pop_reply_queue(struct mpt_softc *mpt)
1013{
1014     return mpt_read(mpt, MPT_OFFSET_REPLY_Q);
1015}
1016
1017void
1018mpt_complete_request_chain(struct mpt_softc *, struct req_queue *, u_int);
1019
1020/************************** Scatter Gather Managment **************************/
1021/* MPT_RQSL- size of request frame, in bytes */
1022#define	MPT_RQSL(mpt)		(mpt->ioc_facts.RequestFrameSize << 2)
1023
1024/* MPT_NSGL- how many SG entries can fit in a request frame size */
1025#define	MPT_NSGL(mpt)		(MPT_RQSL(mpt) / sizeof (SGE_IO_UNION))
1026
1027/* MPT_NRFM- how many request frames can fit in each request alloc we make */
1028#define	MPT_NRFM(mpt)		(MPT_REQUEST_AREA / MPT_RQSL(mpt))
1029
1030/*
1031 * MPT_NSGL_FIRST- # of SG elements that can fit after
1032 * an I/O request but still within the request frame.
1033 * Do this safely based upon SGE_IO_UNION.
1034 *
1035 * Note that the first element is *within* the SCSI request.
1036 */
1037#define	MPT_NSGL_FIRST(mpt)	\
1038    ((MPT_RQSL(mpt) - sizeof (MSG_SCSI_IO_REQUEST) + sizeof (SGE_IO_UNION)) / \
1039    sizeof (SGE_IO_UNION))
1040
1041/***************************** IOC Initialization *****************************/
1042int mpt_reset(struct mpt_softc *, int /*reinit*/);
1043
1044/****************************** Debugging ************************************/
1045typedef struct mpt_decode_entry {
1046	char    *name;
1047	u_int	 value;
1048	u_int	 mask;
1049} mpt_decode_entry_t;
1050
1051int mpt_decode_value(mpt_decode_entry_t *table, u_int num_entries,
1052		     const char *name, u_int value, u_int *cur_column,
1053		     u_int wrap_point);
1054
1055void mpt_dump_data(struct mpt_softc *, const char *, void *, int);
1056void mpt_dump_request(struct mpt_softc *, request_t *);
1057
1058enum {
1059	MPT_PRT_ALWAYS,
1060	MPT_PRT_FATAL,
1061	MPT_PRT_ERROR,
1062	MPT_PRT_WARN,
1063	MPT_PRT_INFO,
1064	MPT_PRT_NEGOTIATION,
1065	MPT_PRT_DEBUG,
1066	MPT_PRT_DEBUG1,
1067	MPT_PRT_DEBUG2,
1068	MPT_PRT_DEBUG3,
1069	MPT_PRT_TRACE,
1070	MPT_PRT_NONE=100
1071};
1072
1073#if __FreeBSD_version > 500000
1074#define mpt_lprt(mpt, level, ...)		\
1075do {						\
1076	if (level <= (mpt)->verbose)		\
1077		mpt_prt(mpt, __VA_ARGS__);	\
1078} while (0)
1079
1080#define mpt_lprtc(mpt, level, ...)		 \
1081do {						 \
1082	if (level <= (mpt)->debug_level)	 \
1083		mpt_prtc(mpt, __VA_ARGS__);	 \
1084} while (0)
1085#else
1086void mpt_lprt(struct mpt_softc *, int, const char *, ...)
1087	__printflike(3, 4);
1088void mpt_lprtc(struct mpt_softc *, int, const char *, ...)
1089	__printflike(3, 4);
1090#endif
1091void mpt_prt(struct mpt_softc *, const char *, ...)
1092	__printflike(2, 3);
1093void mpt_prtc(struct mpt_softc *, const char *, ...)
1094	__printflike(2, 3);
1095
1096/**************************** Target Mode Related ***************************/
1097static __inline int mpt_cdblen(uint8_t, int);
1098static __inline int
1099mpt_cdblen(uint8_t cdb0, int maxlen)
1100{
1101	int group = cdb0 >> 5;
1102	switch (group) {
1103	case 0:
1104		return (6);
1105	case 1:
1106		return (10);
1107	case 4:
1108	case 5:
1109		return (12);
1110	default:
1111		return (16);
1112	}
1113}
1114#ifdef	INVARIANTS
1115static __inline request_t * mpt_tag_2_req(struct mpt_softc *, uint32_t);
1116static __inline request_t *
1117mpt_tag_2_req(struct mpt_softc *mpt, uint32_t tag)
1118{
1119	uint16_t rtg = (tag >> 18);
1120	KASSERT(rtg < mpt->tgt_cmds_allocated, ("bad tag %d\n", tag));
1121	KASSERT(mpt->tgt_cmd_ptrs, ("no cmd backpointer array"));
1122	KASSERT(mpt->tgt_cmd_ptrs[rtg], ("no cmd backpointer"));
1123	return (mpt->tgt_cmd_ptrs[rtg]);
1124}
1125
1126
1127static __inline int
1128mpt_req_on_free_list(struct mpt_softc *, request_t *);
1129static __inline int
1130mpt_req_on_pending_list(struct mpt_softc *, request_t *);
1131
1132static __inline void
1133mpt_req_spcl(struct mpt_softc *, request_t *, const char *, int);
1134static __inline void
1135mpt_req_not_spcl(struct mpt_softc *, request_t *, const char *, int);
1136
1137
1138/*
1139 * Is request on freelist?
1140 */
1141static __inline int
1142mpt_req_on_free_list(struct mpt_softc *mpt, request_t *req)
1143{
1144	request_t *lrq;
1145
1146	TAILQ_FOREACH(lrq, &mpt->request_free_list, links) {
1147		if (lrq == req) {
1148			return (1);
1149		}
1150	}
1151	return (0);
1152}
1153
1154/*
1155 * Is request on pending list?
1156 */
1157static __inline int
1158mpt_req_on_pending_list(struct mpt_softc *mpt, request_t *req)
1159{
1160	request_t *lrq;
1161
1162	TAILQ_FOREACH(lrq, &mpt->request_pending_list, links) {
1163		if (lrq == req) {
1164			return (1);
1165		}
1166	}
1167	return (0);
1168}
1169
1170/*
1171 * Make sure that req *is* part of one of the special lists
1172 */
1173static __inline void
1174mpt_req_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1175{
1176	int i;
1177	for (i = 0; i < mpt->els_cmds_allocated; i++) {
1178		if (req == mpt->els_cmd_ptrs[i]) {
1179			return;
1180		}
1181	}
1182	for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1183		if (req == mpt->tgt_cmd_ptrs[i]) {
1184			return;
1185		}
1186	}
1187	panic("%s(%d): req %p:%u function %x not in els or tgt ptrs\n",
1188	    s, line, req, req->serno,
1189	    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function);
1190}
1191
1192/*
1193 * Make sure that req is *not* part of one of the special lists.
1194 */
1195static __inline void
1196mpt_req_not_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1197{
1198	int i;
1199	for (i = 0; i < mpt->els_cmds_allocated; i++) {
1200		KASSERT(req != mpt->els_cmd_ptrs[i],
1201		    ("%s(%d): req %p:%u func %x in els ptrs at ioindex %d\n",
1202		    s, line, req, req->serno,
1203		    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1204	}
1205	for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1206		KASSERT(req != mpt->tgt_cmd_ptrs[i],
1207		    ("%s(%d): req %p:%u func %x in tgt ptrs at ioindex %d\n",
1208		    s, line, req, req->serno,
1209		    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1210	}
1211}
1212#endif
1213
1214/*
1215 * Task Management Types, purely for internal consumption
1216 */
1217typedef enum {
1218	MPT_ABORT_TASK_SET=1234,
1219	MPT_CLEAR_TASK_SET,
1220	MPT_TARGET_RESET,
1221	MPT_CLEAR_ACA,
1222	MPT_TERMINATE_TASK,
1223	MPT_NIL_TMT_VALUE=5678
1224} mpt_task_mgmt_t;
1225
1226/**************************** Unclassified Routines ***************************/
1227void		mpt_send_cmd(struct mpt_softc *mpt, request_t *req);
1228int		mpt_recv_handshake_reply(struct mpt_softc *mpt,
1229					 size_t reply_len, void *reply);
1230int		mpt_wait_req(struct mpt_softc *mpt, request_t *req,
1231			     mpt_req_state_t state, mpt_req_state_t mask,
1232			     int sleep_ok, int time_ms);
1233void		mpt_enable_ints(struct mpt_softc *mpt);
1234void		mpt_disable_ints(struct mpt_softc *mpt);
1235int		mpt_attach(struct mpt_softc *mpt);
1236int		mpt_shutdown(struct mpt_softc *mpt);
1237int		mpt_detach(struct mpt_softc *mpt);
1238int		mpt_send_handshake_cmd(struct mpt_softc *mpt,
1239				       size_t len, void *cmd);
1240request_t *	mpt_get_request(struct mpt_softc *mpt, int sleep_ok);
1241void		mpt_free_request(struct mpt_softc *mpt, request_t *req);
1242void		mpt_intr(void *arg);
1243void		mpt_check_doorbell(struct mpt_softc *mpt);
1244void		mpt_dump_reply_frame(struct mpt_softc *mpt,
1245				     MSG_DEFAULT_REPLY *reply_frame);
1246
1247void		mpt_set_config_regs(struct mpt_softc *);
1248int		mpt_issue_cfg_req(struct mpt_softc */*mpt*/, request_t */*req*/,
1249				  cfgparms_t *params,
1250				  bus_addr_t /*addr*/, bus_size_t/*len*/,
1251				  int /*sleep_ok*/, int /*timeout_ms*/);
1252int		mpt_read_extcfg_header(struct mpt_softc *mpt, int PageVersion,
1253				       int PageNumber, uint32_t PageAddress,
1254				       int ExtPageType,
1255				       CONFIG_EXTENDED_PAGE_HEADER *rslt,
1256				       int sleep_ok, int timeout_ms);
1257int		mpt_read_extcfg_page(struct mpt_softc *mpt, int Action,
1258				     uint32_t PageAddress,
1259				     CONFIG_EXTENDED_PAGE_HEADER *hdr,
1260				     void *buf, size_t len, int sleep_ok,
1261				     int timeout_ms);
1262int		mpt_read_cfg_header(struct mpt_softc *, int /*PageType*/,
1263				    int /*PageNumber*/,
1264				    uint32_t /*PageAddress*/,
1265				    CONFIG_PAGE_HEADER *,
1266				    int /*sleep_ok*/, int /*timeout_ms*/);
1267int		mpt_read_cfg_page(struct mpt_softc *t, int /*Action*/,
1268				  uint32_t /*PageAddress*/,
1269				  CONFIG_PAGE_HEADER *, size_t /*len*/,
1270				  int /*sleep_ok*/, int /*timeout_ms*/);
1271int		mpt_write_cfg_page(struct mpt_softc *, int /*Action*/,
1272				   uint32_t /*PageAddress*/,
1273				   CONFIG_PAGE_HEADER *, size_t /*len*/,
1274				   int /*sleep_ok*/, int /*timeout_ms*/);
1275static __inline int
1276mpt_read_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1277		      CONFIG_PAGE_HEADER *hdr, size_t len,
1278		      int sleep_ok, int timeout_ms)
1279{
1280	return (mpt_read_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_READ_CURRENT,
1281				  PageAddress, hdr, len, sleep_ok, timeout_ms));
1282}
1283
1284static __inline int
1285mpt_write_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1286		       CONFIG_PAGE_HEADER *hdr, size_t len, int sleep_ok,
1287		       int timeout_ms)
1288{
1289	return (mpt_write_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_WRITE_CURRENT,
1290				   PageAddress, hdr, len, sleep_ok,
1291				   timeout_ms));
1292}
1293/* mpt_debug.c functions */
1294void mpt_print_reply(void *vmsg);
1295void mpt_print_db(uint32_t mb);
1296void mpt_print_config_reply(void *vmsg);
1297char *mpt_ioc_diag(uint32_t diag);
1298void mpt_req_state(mpt_req_state_t state);
1299void mpt_print_config_request(void *vmsg);
1300void mpt_print_request(void *vmsg);
1301void mpt_print_scsi_io_request(MSG_SCSI_IO_REQUEST *msg);
1302void mpt_dump_sgl(SGE_IO_UNION *se, int offset);
1303#endif /* _MPT_H_ */
1304