mpt.h revision 171842
1/* $FreeBSD: head/sys/dev/mpt/mpt.h 171842 2007-08-14 19:17:35Z scottl $ */
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/**************************** Kernel Thread Support ***************************/
274#if __FreeBSD_version > 500005
275#define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
276	kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
277#else
278#define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
279	kthread_create(func, farg, proc_ptr, fmtstr, arg)
280#endif
281
282/****************************** Timer Facilities ******************************/
283#if __FreeBSD_version > 500000
284#define mpt_callout_init(c)	callout_init(c, /*mpsafe*/1);
285#else
286#define mpt_callout_init(c)	callout_init(c);
287#endif
288
289/********************************** Endianess *********************************/
290#define	MPT_2_HOST64(ptr, tag)	ptr->tag = le64toh(ptr->tag)
291#define	MPT_2_HOST32(ptr, tag)	ptr->tag = le32toh(ptr->tag)
292#define	MPT_2_HOST16(ptr, tag)	ptr->tag = le16toh(ptr->tag)
293
294#define	HOST_2_MPT64(ptr, tag)	ptr->tag = htole64(ptr->tag)
295#define	HOST_2_MPT32(ptr, tag)	ptr->tag = htole32(ptr->tag)
296#define	HOST_2_MPT16(ptr, tag)	ptr->tag = htole16(ptr->tag)
297
298#if	_BYTE_ORDER == _BIG_ENDIAN
299void mpt2host_sge_simple_union(SGE_SIMPLE_UNION *);
300void mpt2host_iocfacts_reply(MSG_IOC_FACTS_REPLY *);
301void mpt2host_portfacts_reply(MSG_PORT_FACTS_REPLY *);
302void mpt2host_config_page_ioc2(CONFIG_PAGE_IOC_2 *);
303void mpt2host_config_page_raid_vol_0(CONFIG_PAGE_RAID_VOL_0 *);
304void mpt2host_mpi_raid_vol_indicator(MPI_RAID_VOL_INDICATOR *);
305#else
306#define	mpt2host_sge_simple_union(x)		do { ; } while (0)
307#define	mpt2host_iocfacts_reply(x)		do { ; } while (0)
308#define	mpt2host_portfacts_reply(x)		do { ; } while (0)
309#define	mpt2host_config_page_ioc2(x)		do { ; } while (0)
310#define	mpt2host_config_page_raid_vol_0(x)	do { ; } while (0)
311#define	mpt2host_mpi_raid_vol_indicator(x)	do { ; } while (0)
312#endif
313
314/**************************** MPI Transaction State ***************************/
315typedef enum {
316	REQ_STATE_NIL		= 0x00,
317	REQ_STATE_FREE		= 0x01,
318	REQ_STATE_ALLOCATED	= 0x02,
319	REQ_STATE_QUEUED	= 0x04,
320	REQ_STATE_DONE		= 0x08,
321	REQ_STATE_TIMEDOUT	= 0x10,
322	REQ_STATE_NEED_WAKEUP	= 0x20,
323	REQ_STATE_LOCKED	= 0x80,	/* can't be freed */
324	REQ_STATE_MASK		= 0xFF
325} mpt_req_state_t;
326
327struct req_entry {
328	TAILQ_ENTRY(req_entry) links;	/* Pointer to next in list */
329	mpt_req_state_t	state;		/* Request State Information */
330	uint16_t	index;		/* Index of this entry */
331	uint16_t	IOCStatus;	/* Completion status */
332	uint16_t	ResponseCode;	/* TMF Reponse Code */
333	uint16_t	serno;		/* serial number */
334	union ccb      *ccb;		/* CAM request */
335	void	       *req_vbuf;	/* Virtual Address of Entry */
336	void	       *sense_vbuf;	/* Virtual Address of sense data */
337	bus_addr_t	req_pbuf;	/* Physical Address of Entry */
338	bus_addr_t	sense_pbuf;	/* Physical Address of sense data */
339	bus_dmamap_t	dmap;		/* DMA map for data buffers */
340	struct req_entry *chain;	/* for SGE overallocations */
341	struct callout  callout;	/* Timeout for the request */
342};
343
344typedef struct mpt_config_params {
345	u_int		Action;
346	u_int		PageVersion;
347	u_int		PageLength;
348	u_int		PageNumber;
349	u_int		PageType;
350	u_int		PageAddress;
351	u_int		ExtPageLength;
352	u_int		ExtPageType;
353} cfgparms_t;
354
355/**************************** MPI Target State Info ***************************/
356
357typedef struct {
358	uint32_t reply_desc;	/* current reply descriptor */
359	uint32_t resid;		/* current data residual */
360	uint32_t bytes_xfered;	/* current relative offset */
361	union ccb *ccb;		/* pointer to currently active ccb */
362	request_t *req;		/* pointer to currently active assist request */
363	uint32_t
364		is_local : 1,
365		nxfers	 : 31;
366	uint32_t tag_id;
367	enum {
368		TGT_STATE_NIL,
369		TGT_STATE_LOADING,
370		TGT_STATE_LOADED,
371		TGT_STATE_IN_CAM,
372                TGT_STATE_SETTING_UP_FOR_DATA,
373                TGT_STATE_MOVING_DATA,
374                TGT_STATE_MOVING_DATA_AND_STATUS,
375                TGT_STATE_SENDING_STATUS
376	} state;
377} mpt_tgt_state_t;
378
379/*
380 * When we get an incoming command it has its own tag which is called the
381 * IoIndex. This is the value we gave that particular command buffer when
382 * we originally assigned it. It's just a number, really. The FC card uses
383 * it as an RX_ID. We can use it to index into mpt->tgt_cmd_ptrs, which
384 * contains pointers the request_t structures related to that IoIndex.
385 *
386 * What *we* do is construct a tag out of the index for the target command
387 * which owns the incoming ATIO plus a rolling sequence number.
388 */
389#define	MPT_MAKE_TAGID(mpt, req, ioindex)	\
390 ((ioindex << 18) | (((mpt->sequence++) & 0x3f) << 12) | (req->index & 0xfff))
391
392#ifdef	INVARIANTS
393#define	MPT_TAG_2_REQ(a, b)		mpt_tag_2_req(a, (uint32_t) b)
394#else
395#define	MPT_TAG_2_REQ(mpt, tag)		mpt->tgt_cmd_ptrs[tag >> 18]
396#endif
397
398#define	MPT_TGT_STATE(mpt, req) ((mpt_tgt_state_t *) \
399    (&((uint8_t *)req->req_vbuf)[MPT_RQSL(mpt) - sizeof (mpt_tgt_state_t)]))
400
401STAILQ_HEAD(mpt_hdr_stailq, ccb_hdr);
402#define	MPT_MAX_LUNS	256
403typedef struct {
404	struct mpt_hdr_stailq	atios;
405	struct mpt_hdr_stailq	inots;
406	int enabled;
407} tgt_resource_t;
408#define	MPT_MAX_ELS	64
409
410/**************************** Handler Registration ****************************/
411/*
412 * Global table of registered reply handlers.  The
413 * handler is indicated by byte 3 of the request
414 * index submitted to the IOC.  This allows the
415 * driver core to perform generic processing without
416 * any knowledge of per-personality behavior.
417 *
418 * MPT_NUM_REPLY_HANDLERS must be a power of 2
419 * to allow the easy generation of a mask.
420 *
421 * The handler offsets used by the core are hard coded
422 * allowing faster code generation when assigning a handler
423 * to a request.  All "personalities" must use the
424 * the handler registration mechanism.
425 *
426 * The IOC handlers that are rarely executed are placed
427 * at the tail of the table to make it more likely that
428 * all commonly executed handlers fit in a single cache
429 * line.
430 */
431#define MPT_NUM_REPLY_HANDLERS		(32)
432#define MPT_REPLY_HANDLER_EVENTS	MPT_CBI_TO_HID(0)
433#define MPT_REPLY_HANDLER_CONFIG	MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-1)
434#define MPT_REPLY_HANDLER_HANDSHAKE	MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-2)
435typedef int mpt_reply_handler_t(struct mpt_softc *mpt, request_t *request,
436    uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame);
437typedef union {
438	mpt_reply_handler_t	*reply_handler;
439} mpt_handler_t;
440
441typedef enum {
442	MPT_HANDLER_REPLY,
443	MPT_HANDLER_EVENT,
444	MPT_HANDLER_RESET,
445	MPT_HANDLER_SHUTDOWN
446} mpt_handler_type;
447
448struct mpt_handler_record
449{
450	LIST_ENTRY(mpt_handler_record)	links;
451	mpt_handler_t			handler;
452};
453
454LIST_HEAD(mpt_handler_list, mpt_handler_record);
455
456/*
457 * The handler_id is currently unused but would contain the
458 * handler ID used in the MsgContext field to allow direction
459 * of replies to the handler.  Registrations that don't require
460 * a handler id can pass in NULL for the handler_id.
461 *
462 * Deregistrations for handlers without a handler id should
463 * pass in MPT_HANDLER_ID_NONE.
464 */
465#define MPT_HANDLER_ID_NONE		(0xFFFFFFFF)
466int mpt_register_handler(struct mpt_softc *, mpt_handler_type,
467			 mpt_handler_t, uint32_t *);
468int mpt_deregister_handler(struct mpt_softc *, mpt_handler_type,
469			   mpt_handler_t, uint32_t);
470
471/******************* Per-Controller Instance Data Structures ******************/
472TAILQ_HEAD(req_queue, req_entry);
473
474/* Structure for saving proper values for modifyable PCI config registers */
475struct mpt_pci_cfg {
476	uint16_t Command;
477	uint16_t LatencyTimer_LineSize;
478	uint32_t IO_BAR;
479	uint32_t Mem0_BAR[2];
480	uint32_t Mem1_BAR[2];
481	uint32_t ROM_BAR;
482	uint8_t  IntLine;
483	uint32_t PMCSR;
484};
485
486typedef enum {
487	MPT_RVF_NONE		= 0x0,
488	MPT_RVF_ACTIVE		= 0x1,
489	MPT_RVF_ANNOUNCED	= 0x2,
490	MPT_RVF_UP2DATE		= 0x4,
491	MPT_RVF_REFERENCED	= 0x8,
492	MPT_RVF_WCE_CHANGED	= 0x10
493} mpt_raid_volume_flags;
494
495struct mpt_raid_volume {
496	CONFIG_PAGE_RAID_VOL_0	       *config_page;
497	MPI_RAID_VOL_INDICATOR		sync_progress;
498	mpt_raid_volume_flags		flags;
499	u_int				quiesced_disks;
500};
501
502typedef enum {
503	MPT_RDF_NONE		= 0x00,
504	MPT_RDF_ACTIVE		= 0x01,
505	MPT_RDF_ANNOUNCED	= 0x02,
506	MPT_RDF_UP2DATE		= 0x04,
507	MPT_RDF_REFERENCED	= 0x08,
508	MPT_RDF_QUIESCING	= 0x10,
509	MPT_RDF_QUIESCED	= 0x20
510} mpt_raid_disk_flags;
511
512struct mpt_raid_disk {
513	CONFIG_PAGE_RAID_PHYS_DISK_0	config_page;
514	struct mpt_raid_volume	       *volume;
515	u_int				member_number;
516	u_int				pass_thru_active;
517	mpt_raid_disk_flags		flags;
518};
519
520struct mpt_evtf_record {
521	MSG_EVENT_NOTIFY_REPLY		reply;
522	uint32_t			context;
523	LIST_ENTRY(mpt_evtf_record)	links;
524};
525
526LIST_HEAD(mpt_evtf_list, mpt_evtf_record);
527
528struct mptsas_devinfo {
529	uint16_t	dev_handle;
530	uint16_t	parent_dev_handle;
531	uint16_t	enclosure_handle;
532	uint16_t	slot;
533	uint8_t		phy_num;
534	uint8_t		physical_port;
535	uint8_t		target_id;
536	uint8_t		bus;
537	uint64_t	sas_address;
538	uint32_t	device_info;
539};
540
541struct mptsas_phyinfo {
542	uint16_t	handle;
543	uint8_t		phy_num;
544	uint8_t		port_id;
545	uint8_t		negotiated_link_rate;
546	uint8_t		hw_link_rate;
547	uint8_t		programmed_link_rate;
548	uint8_t		sas_port_add_phy;
549	struct mptsas_devinfo identify;
550	struct mptsas_devinfo attached;
551};
552
553struct mptsas_portinfo {
554	uint16_t			num_phys;
555	struct mptsas_phyinfo		*phy_info;
556};
557
558struct mpt_softc {
559	device_t		dev;
560#if __FreeBSD_version < 500000
561	uint32_t		mpt_islocked;
562	int			mpt_splsaved;
563#else
564	struct mtx		mpt_lock;
565	int			mpt_locksetup;
566#endif
567	uint32_t		mpt_pers_mask;
568	uint32_t
569				: 8,
570		unit		: 8,
571		ready		: 1,
572		fw_uploaded	: 1,
573		msi_enable	: 1,
574		twildcard	: 1,
575		tenabled	: 1,
576		do_cfg_role	: 1,
577		raid_enabled	: 1,
578		raid_mwce_set	: 1,
579		getreqwaiter	: 1,
580		shutdwn_raid    : 1,
581		shutdwn_recovery: 1,
582		outofbeer	: 1,
583		disabled	: 1,
584		is_spi		: 1,
585		is_sas		: 1,
586		is_fc		: 1;
587
588	u_int			cfg_role;
589	u_int			role;	/* role: none, ini, target, both */
590
591	u_int			verbose;
592#ifdef	MPT_TEST_MULTIPATH
593	int			failure_id;
594#endif
595
596	/*
597	 * IOC Facts
598	 */
599	MSG_IOC_FACTS_REPLY	ioc_facts;
600
601	/*
602	 * Port Facts
603	 */
604	MSG_PORT_FACTS_REPLY *	port_facts;
605#define	mpt_ini_id	port_facts[0].PortSCSIID
606#define	mpt_max_tgtcmds	port_facts[0].MaxPostedCmdBuffers
607
608	/*
609	 * Device Configuration Information
610	 */
611	union {
612		struct mpt_spi_cfg {
613			CONFIG_PAGE_SCSI_PORT_0		_port_page0;
614			CONFIG_PAGE_SCSI_PORT_1		_port_page1;
615			CONFIG_PAGE_SCSI_PORT_2		_port_page2;
616			CONFIG_PAGE_SCSI_DEVICE_0	_dev_page0[16];
617			CONFIG_PAGE_SCSI_DEVICE_1	_dev_page1[16];
618			uint16_t			_tag_enable;
619			uint16_t			_disc_enable;
620		} spi;
621#define	mpt_port_page0		cfg.spi._port_page0
622#define	mpt_port_page1		cfg.spi._port_page1
623#define	mpt_port_page2		cfg.spi._port_page2
624#define	mpt_dev_page0		cfg.spi._dev_page0
625#define	mpt_dev_page1		cfg.spi._dev_page1
626#define	mpt_tag_enable		cfg.spi._tag_enable
627#define	mpt_disc_enable		cfg.spi._disc_enable
628		struct mpi_fc_cfg {
629			CONFIG_PAGE_FC_PORT_0 _port_page0;
630			uint32_t _port_speed;
631#define	mpt_fcport_page0	cfg.fc._port_page0
632#define	mpt_fcport_speed	cfg.fc._port_speed
633		} fc;
634	} cfg;
635#if __FreeBSD_version >= 500000
636	/*
637	 * Device config information stored up for sysctl to access
638	 */
639	union {
640		struct {
641			unsigned int initiator_id;
642		} spi;
643		struct {
644			char wwnn[19];
645			char wwpn[19];
646		} fc;
647	} scinfo;
648#endif
649
650	/* Controller Info for RAID information */
651	CONFIG_PAGE_IOC_2 *	ioc_page2;
652	CONFIG_PAGE_IOC_3 *	ioc_page3;
653
654	/* Raid Data */
655	struct mpt_raid_volume* raid_volumes;
656	struct mpt_raid_disk*	raid_disks;
657	u_int			raid_max_volumes;
658	u_int			raid_max_disks;
659	u_int			raid_page0_len;
660	u_int			raid_wakeup;
661	u_int			raid_rescan;
662	u_int			raid_resync_rate;
663	u_int			raid_mwce_setting;
664	u_int			raid_queue_depth;
665	u_int			raid_nonopt_volumes;
666	struct proc	       *raid_thread;
667	struct callout		raid_timer;
668
669	/*
670	 * PCI Hardware info
671	 */
672	int			pci_msi_count;
673	struct resource *	pci_irq;	/* Interrupt map for chip */
674	void *			ih;		/* Interupt handle */
675	struct mpt_pci_cfg	pci_cfg;	/* saved PCI conf registers */
676
677	/*
678	 * DMA Mapping Stuff
679	 */
680	struct resource *	pci_reg;	/* Register map for chip */
681	int			pci_mem_rid;	/* Resource ID */
682	bus_space_tag_t		pci_st;		/* Bus tag for registers */
683	bus_space_handle_t	pci_sh;		/* Bus handle for registers */
684	/* PIO versions of above. */
685	int			pci_pio_rid;
686	struct resource *	pci_pio_reg;
687	bus_space_tag_t		pci_pio_st;
688	bus_space_handle_t	pci_pio_sh;
689
690	bus_dma_tag_t		parent_dmat;	/* DMA tag for parent PCI bus */
691	bus_dma_tag_t		reply_dmat;	/* DMA tag for reply memory */
692	bus_dmamap_t		reply_dmap;	/* DMA map for reply memory */
693	uint8_t		       *reply;		/* KVA of reply memory */
694	bus_addr_t		reply_phys;	/* BusAddr of reply memory */
695
696	bus_dma_tag_t		buffer_dmat;	/* DMA tag for buffers */
697	bus_dma_tag_t		request_dmat;	/* DMA tag for request memroy */
698	bus_dmamap_t		request_dmap;	/* DMA map for request memroy */
699	uint8_t		       *request;	/* KVA of Request memory */
700	bus_addr_t		request_phys;	/* BusAddr of request memory */
701
702	uint32_t		max_seg_cnt;	/* calculated after IOC facts */
703
704	/*
705	 * Hardware management
706	 */
707	u_int			reset_cnt;
708
709	/*
710	 * CAM && Software Management
711	 */
712	request_t	       *request_pool;
713	struct req_queue	request_free_list;
714	struct req_queue	request_pending_list;
715	struct req_queue	request_timeout_list;
716
717
718	struct cam_sim	       *sim;
719	struct cam_path	       *path;
720
721	struct cam_sim	       *phydisk_sim;
722	struct cam_path	       *phydisk_path;
723
724	struct proc	       *recovery_thread;
725	request_t	       *tmf_req;
726
727	/*
728	 * Deferred frame acks due to resource shortage.
729	 */
730	struct mpt_evtf_list	ack_frames;
731
732	/*
733	 * Target Mode Support
734	 */
735	uint32_t		scsi_tgt_handler_id;
736	request_t **		tgt_cmd_ptrs;
737	request_t **		els_cmd_ptrs;	/* FC only */
738
739	/*
740	 * *snork*- this is chosen to be here *just in case* somebody
741	 * forgets to point to it exactly and we index off of trt with
742	 * CAM_LUN_WILDCARD.
743	 */
744	tgt_resource_t		trt_wildcard;		/* wildcard luns */
745	tgt_resource_t		trt[MPT_MAX_LUNS];
746	uint16_t		tgt_cmds_allocated;
747	uint16_t		els_cmds_allocated;	/* FC only */
748
749	uint16_t		timeouts;	/* timeout count */
750	uint16_t		success;	/* successes afer timeout */
751	uint16_t		sequence;	/* Sequence Number */
752	uint16_t		pad3;
753
754
755	/* Paired port in some dual adapters configurations */
756	struct mpt_softc *	mpt2;
757
758	/* FW Image management */
759	uint32_t		fw_image_size;
760	uint8_t		       *fw_image;
761	bus_dma_tag_t		fw_dmat;	/* DMA tag for firmware image */
762	bus_dmamap_t		fw_dmap;	/* DMA map for firmware image */
763	bus_addr_t		fw_phys;	/* BusAddr of firmware image */
764
765	/* SAS Topology */
766	struct mptsas_portinfo	*sas_portinfo;
767
768	/* Shutdown Event Handler. */
769	eventhandler_tag         eh;
770
771	TAILQ_ENTRY(mpt_softc)	links;
772};
773
774static __inline void mpt_assign_serno(struct mpt_softc *, request_t *);
775
776static __inline void
777mpt_assign_serno(struct mpt_softc *mpt, request_t *req)
778{
779	if ((req->serno = mpt->sequence++) == 0) {
780		req->serno = mpt->sequence++;
781	}
782}
783
784/***************************** Locking Primitives *****************************/
785#if __FreeBSD_version < 500000
786#define	MPT_IFLAGS		INTR_TYPE_CAM
787#define	MPT_LOCK(mpt)		mpt_lockspl(mpt)
788#define	MPT_UNLOCK(mpt)		mpt_unlockspl(mpt)
789#define	MPT_OWNED(mpt)		mpt->mpt_islocked
790#define	MPT_LOCK_ASSERT(mpt)
791#define	MPTLOCK_2_CAMLOCK	MPT_UNLOCK
792#define	CAMLOCK_2_MPTLOCK	MPT_LOCK
793#define	MPT_LOCK_SETUP(mpt)
794#define	MPT_LOCK_DESTROY(mpt)
795
796static __inline void mpt_lockspl(struct mpt_softc *mpt);
797static __inline void mpt_unlockspl(struct mpt_softc *mpt);
798
799static __inline void
800mpt_lockspl(struct mpt_softc *mpt)
801{
802       int s;
803
804       s = splcam();
805       if (mpt->mpt_islocked++ == 0) {
806               mpt->mpt_splsaved = s;
807       } else {
808               splx(s);
809	       panic("Recursed lock with mask: 0x%x\n", s);
810       }
811}
812
813static __inline void
814mpt_unlockspl(struct mpt_softc *mpt)
815{
816       if (mpt->mpt_islocked) {
817               if (--mpt->mpt_islocked == 0) {
818                       splx(mpt->mpt_splsaved);
819               }
820       } else
821	       panic("Negative lock count\n");
822}
823
824static __inline int
825mpt_sleep(struct mpt_softc *mpt, void *ident, int priority,
826	   const char *wmesg, int timo)
827{
828	int saved_cnt;
829	int saved_spl;
830	int error;
831
832	KASSERT(mpt->mpt_islocked <= 1, ("Invalid lock count on tsleep"));
833	saved_cnt = mpt->mpt_islocked;
834	saved_spl = mpt->mpt_splsaved;
835	mpt->mpt_islocked = 0;
836	error = tsleep(ident, priority, wmesg, timo);
837	KASSERT(mpt->mpt_islocked == 0, ("Invalid lock count on wakeup"));
838	mpt->mpt_islocked = saved_cnt;
839	mpt->mpt_splsaved = saved_spl;
840	return (error);
841}
842
843#define mpt_req_timeout(req, ticks, func, arg) \
844	callout_reset(&(req)->callout, (ticks), (func), (arg));
845#define mpt_req_untimeout(req, func, arg) \
846	callout_stop(&(req)->callout)
847
848#else
849#if 1
850#define	MPT_IFLAGS		INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
851#define	MPT_LOCK_SETUP(mpt)						\
852		mtx_init(&mpt->mpt_lock, "mpt", NULL, MTX_DEF);		\
853		mpt->mpt_locksetup = 1
854#define	MPT_LOCK_DESTROY(mpt)						\
855	if (mpt->mpt_locksetup) {					\
856		mtx_destroy(&mpt->mpt_lock);				\
857		mpt->mpt_locksetup = 0;					\
858	}
859
860#define	MPT_LOCK(mpt)		mtx_lock(&(mpt)->mpt_lock)
861#define	MPT_UNLOCK(mpt)		mtx_unlock(&(mpt)->mpt_lock)
862#define	MPT_OWNED(mpt)		mtx_owned(&(mpt)->mpt_lock)
863#define	MPT_LOCK_ASSERT(mpt)	mtx_assert(&(mpt)->mpt_lock, MA_OWNED)
864#define	MPTLOCK_2_CAMLOCK(mpt)
865#define	CAMLOCK_2_MPTLOCK(mpt)
866#define mpt_sleep(mpt, ident, priority, wmesg, timo) \
867	msleep(ident, &(mpt)->mpt_lock, priority, wmesg, timo)
868#define mpt_req_timeout(req, ticks, func, arg) \
869	callout_reset(&(req)->callout, (ticks), (func), (arg));
870#define mpt_req_untimeout(req, func, arg) \
871	callout_stop(&(req)->callout)
872
873#else
874
875#define	MPT_IFLAGS		INTR_TYPE_CAM | INTR_ENTROPY
876#define	MPT_LOCK_SETUP(mpt)	do { } while (0)
877#define	MPT_LOCK_DESTROY(mpt)	do { } while (0)
878#define	MPT_LOCK_ASSERT(mpt)	mtx_assert(&Giant, MA_OWNED)
879#define	MPT_LOCK(mpt)		mtx_lock(&Giant)
880#define	MPT_UNLOCK(mpt)		mtx_unlock(&Giant)
881#define	MPTLOCK_2_CAMLOCK(mpt)
882#define	CAMLOCK_2_MPTLOCK(mpt)
883
884static __inline int
885mpt_sleep(struct mpt_softc *, void *, int, const char *, int);
886
887#define mpt_ccb_timeout(ccb, ticks, func, arg) \
888	do {	\
889		(ccb)->ccb_h.timeout_ch = timeout((func), (arg), (ticks)); \
890	} while (0)
891#define mpt_ccb_untimeout(ccb, func, arg) \
892	untimeout((func), (arg), (ccb)->ccb_h.timeout_ch)
893#define mpt_ccb_timeout_init(ccb) \
894	callout_handle_init(&(ccb)->ccb_h.timeout_ch)
895
896static __inline int
897mpt_sleep(struct mpt_softc *mpt, void *i, int p, const char *w, int t)
898{
899	int r;
900	r = tsleep(i, p, w, t);
901	return (r);
902}
903#endif
904#endif
905
906/******************************* Register Access ******************************/
907static __inline void mpt_write(struct mpt_softc *, size_t, uint32_t);
908static __inline uint32_t mpt_read(struct mpt_softc *, int);
909static __inline void mpt_pio_write(struct mpt_softc *, size_t, uint32_t);
910static __inline uint32_t mpt_pio_read(struct mpt_softc *, int);
911
912static __inline void
913mpt_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
914{
915	bus_space_write_4(mpt->pci_st, mpt->pci_sh, offset, val);
916}
917
918static __inline uint32_t
919mpt_read(struct mpt_softc *mpt, int offset)
920{
921	return (bus_space_read_4(mpt->pci_st, mpt->pci_sh, offset));
922}
923
924/*
925 * Some operations (e.g. diagnostic register writes while the ARM proccessor
926 * is disabled), must be performed using "PCI pio" operations.  On non-PCI
927 * busses, these operations likely map to normal register accesses.
928 */
929static __inline void
930mpt_pio_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
931{
932	bus_space_write_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset, val);
933}
934
935static __inline uint32_t
936mpt_pio_read(struct mpt_softc *mpt, int offset)
937{
938	return (bus_space_read_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset));
939}
940/*********************** Reply Frame/Request Management ***********************/
941/* Max MPT Reply we are willing to accept (must be power of 2) */
942#define MPT_REPLY_SIZE   	256
943
944/*
945 * Must be less than 16384 in order for target mode to work
946 */
947#define MPT_MAX_REQUESTS(mpt)	512
948#define MPT_REQUEST_AREA	512
949#define MPT_SENSE_SIZE		32	/* included in MPT_REQUEST_AREA */
950#define MPT_REQ_MEM_SIZE(mpt)	(MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
951
952#define MPT_CONTEXT_CB_SHIFT	(16)
953#define MPT_CBI(handle)		(handle >> MPT_CONTEXT_CB_SHIFT)
954#define MPT_CBI_TO_HID(cbi)	((cbi) << MPT_CONTEXT_CB_SHIFT)
955#define MPT_CONTEXT_TO_CBI(x)	\
956    (((x) >> MPT_CONTEXT_CB_SHIFT) & (MPT_NUM_REPLY_HANDLERS - 1))
957#define MPT_CONTEXT_REQI_MASK	0xFFFF
958#define MPT_CONTEXT_TO_REQI(x)	((x) & MPT_CONTEXT_REQI_MASK)
959
960/*
961 * Convert a 32bit physical address returned from IOC to an
962 * offset into our reply frame memory or the kvm address needed
963 * to access the data.  The returned address is only the low
964 * 32 bits, so mask our base physical address accordingly.
965 */
966#define MPT_REPLY_BADDR(x)		\
967	(x << 1)
968#define MPT_REPLY_OTOV(m, i) 		\
969	((void *)(&m->reply[i]))
970
971#define	MPT_DUMP_REPLY_FRAME(mpt, reply_frame)		\
972do {							\
973	if (mpt->verbose > MPT_PRT_DEBUG)		\
974		mpt_dump_reply_frame(mpt, reply_frame);	\
975} while(0)
976
977static __inline uint32_t mpt_pop_reply_queue(struct mpt_softc *mpt);
978static __inline void mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr);
979
980/*
981 * Give the reply buffer back to the IOC after we have
982 * finished processing it.
983 */
984static __inline void
985mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr)
986{
987     mpt_write(mpt, MPT_OFFSET_REPLY_Q, ptr);
988}
989
990/* Get a reply from the IOC */
991static __inline uint32_t
992mpt_pop_reply_queue(struct mpt_softc *mpt)
993{
994     return mpt_read(mpt, MPT_OFFSET_REPLY_Q);
995}
996
997void
998mpt_complete_request_chain(struct mpt_softc *, struct req_queue *, u_int);
999
1000/************************** Scatter Gather Managment **************************/
1001/* MPT_RQSL- size of request frame, in bytes */
1002#define	MPT_RQSL(mpt)		(mpt->ioc_facts.RequestFrameSize << 2)
1003
1004/* MPT_NSGL- how many SG entries can fit in a request frame size */
1005#define	MPT_NSGL(mpt)		(MPT_RQSL(mpt) / sizeof (SGE_IO_UNION))
1006
1007/* MPT_NRFM- how many request frames can fit in each request alloc we make */
1008#define	MPT_NRFM(mpt)		(MPT_REQUEST_AREA / MPT_RQSL(mpt))
1009
1010/*
1011 * MPT_NSGL_FIRST- # of SG elements that can fit after
1012 * an I/O request but still within the request frame.
1013 * Do this safely based upon SGE_IO_UNION.
1014 *
1015 * Note that the first element is *within* the SCSI request.
1016 */
1017#define	MPT_NSGL_FIRST(mpt)	\
1018    ((MPT_RQSL(mpt) - sizeof (MSG_SCSI_IO_REQUEST) + sizeof (SGE_IO_UNION)) / \
1019    sizeof (SGE_IO_UNION))
1020
1021/***************************** IOC Initialization *****************************/
1022int mpt_reset(struct mpt_softc *, int /*reinit*/);
1023
1024/****************************** Debugging ************************************/
1025typedef struct mpt_decode_entry {
1026	char    *name;
1027	u_int	 value;
1028	u_int	 mask;
1029} mpt_decode_entry_t;
1030
1031int mpt_decode_value(mpt_decode_entry_t *table, u_int num_entries,
1032		     const char *name, u_int value, u_int *cur_column,
1033		     u_int wrap_point);
1034
1035void mpt_dump_data(struct mpt_softc *, const char *, void *, int);
1036void mpt_dump_request(struct mpt_softc *, request_t *);
1037
1038enum {
1039	MPT_PRT_ALWAYS,
1040	MPT_PRT_FATAL,
1041	MPT_PRT_ERROR,
1042	MPT_PRT_WARN,
1043	MPT_PRT_INFO,
1044	MPT_PRT_NEGOTIATION,
1045	MPT_PRT_DEBUG,
1046	MPT_PRT_DEBUG1,
1047	MPT_PRT_DEBUG2,
1048	MPT_PRT_DEBUG3,
1049	MPT_PRT_TRACE,
1050	MPT_PRT_NONE=100
1051};
1052
1053#if __FreeBSD_version > 500000
1054#define mpt_lprt(mpt, level, ...)		\
1055do {						\
1056	if (level <= (mpt)->verbose)		\
1057		mpt_prt(mpt, __VA_ARGS__);	\
1058} while (0)
1059
1060#define mpt_lprtc(mpt, level, ...)		 \
1061do {						 \
1062	if (level <= (mpt)->debug_level)	 \
1063		mpt_prtc(mpt, __VA_ARGS__);	 \
1064} while (0)
1065#else
1066void mpt_lprt(struct mpt_softc *, int, const char *, ...)
1067	__printflike(3, 4);
1068void mpt_lprtc(struct mpt_softc *, int, const char *, ...)
1069	__printflike(3, 4);
1070#endif
1071void mpt_prt(struct mpt_softc *, const char *, ...)
1072	__printflike(2, 3);
1073void mpt_prtc(struct mpt_softc *, const char *, ...)
1074	__printflike(2, 3);
1075
1076/**************************** Target Mode Related ***************************/
1077static __inline int mpt_cdblen(uint8_t, int);
1078static __inline int
1079mpt_cdblen(uint8_t cdb0, int maxlen)
1080{
1081	int group = cdb0 >> 5;
1082	switch (group) {
1083	case 0:
1084		return (6);
1085	case 1:
1086		return (10);
1087	case 4:
1088	case 5:
1089		return (12);
1090	default:
1091		return (16);
1092	}
1093}
1094#ifdef	INVARIANTS
1095static __inline request_t * mpt_tag_2_req(struct mpt_softc *, uint32_t);
1096static __inline request_t *
1097mpt_tag_2_req(struct mpt_softc *mpt, uint32_t tag)
1098{
1099	uint16_t rtg = (tag >> 18);
1100	KASSERT(rtg < mpt->tgt_cmds_allocated, ("bad tag %d\n", tag));
1101	KASSERT(mpt->tgt_cmd_ptrs, ("no cmd backpointer array"));
1102	KASSERT(mpt->tgt_cmd_ptrs[rtg], ("no cmd backpointer"));
1103	return (mpt->tgt_cmd_ptrs[rtg]);
1104}
1105
1106
1107static __inline int
1108mpt_req_on_free_list(struct mpt_softc *, request_t *);
1109static __inline int
1110mpt_req_on_pending_list(struct mpt_softc *, request_t *);
1111
1112static __inline void
1113mpt_req_spcl(struct mpt_softc *, request_t *, const char *, int);
1114static __inline void
1115mpt_req_not_spcl(struct mpt_softc *, request_t *, const char *, int);
1116
1117
1118/*
1119 * Is request on freelist?
1120 */
1121static __inline int
1122mpt_req_on_free_list(struct mpt_softc *mpt, request_t *req)
1123{
1124	request_t *lrq;
1125
1126	TAILQ_FOREACH(lrq, &mpt->request_free_list, links) {
1127		if (lrq == req) {
1128			return (1);
1129		}
1130	}
1131	return (0);
1132}
1133
1134/*
1135 * Is request on pending list?
1136 */
1137static __inline int
1138mpt_req_on_pending_list(struct mpt_softc *mpt, request_t *req)
1139{
1140	request_t *lrq;
1141
1142	TAILQ_FOREACH(lrq, &mpt->request_pending_list, links) {
1143		if (lrq == req) {
1144			return (1);
1145		}
1146	}
1147	return (0);
1148}
1149
1150/*
1151 * Make sure that req *is* part of one of the special lists
1152 */
1153static __inline void
1154mpt_req_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1155{
1156	int i;
1157	for (i = 0; i < mpt->els_cmds_allocated; i++) {
1158		if (req == mpt->els_cmd_ptrs[i]) {
1159			return;
1160		}
1161	}
1162	for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1163		if (req == mpt->tgt_cmd_ptrs[i]) {
1164			return;
1165		}
1166	}
1167	panic("%s(%d): req %p:%u function %x not in els or tgt ptrs\n",
1168	    s, line, req, req->serno,
1169	    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function);
1170}
1171
1172/*
1173 * Make sure that req is *not* part of one of the special lists.
1174 */
1175static __inline void
1176mpt_req_not_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1177{
1178	int i;
1179	for (i = 0; i < mpt->els_cmds_allocated; i++) {
1180		KASSERT(req != mpt->els_cmd_ptrs[i],
1181		    ("%s(%d): req %p:%u func %x in els ptrs at ioindex %d\n",
1182		    s, line, req, req->serno,
1183		    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1184	}
1185	for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1186		KASSERT(req != mpt->tgt_cmd_ptrs[i],
1187		    ("%s(%d): req %p:%u func %x in tgt ptrs at ioindex %d\n",
1188		    s, line, req, req->serno,
1189		    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1190	}
1191}
1192#endif
1193
1194/*
1195 * Task Management Types, purely for internal consumption
1196 */
1197typedef enum {
1198	MPT_ABORT_TASK_SET=1234,
1199	MPT_CLEAR_TASK_SET,
1200	MPT_TARGET_RESET,
1201	MPT_CLEAR_ACA,
1202	MPT_TERMINATE_TASK,
1203	MPT_NIL_TMT_VALUE=5678
1204} mpt_task_mgmt_t;
1205
1206/**************************** Unclassified Routines ***************************/
1207void		mpt_send_cmd(struct mpt_softc *mpt, request_t *req);
1208int		mpt_recv_handshake_reply(struct mpt_softc *mpt,
1209					 size_t reply_len, void *reply);
1210int		mpt_wait_req(struct mpt_softc *mpt, request_t *req,
1211			     mpt_req_state_t state, mpt_req_state_t mask,
1212			     int sleep_ok, int time_ms);
1213void		mpt_enable_ints(struct mpt_softc *mpt);
1214void		mpt_disable_ints(struct mpt_softc *mpt);
1215int		mpt_attach(struct mpt_softc *mpt);
1216int		mpt_shutdown(struct mpt_softc *mpt);
1217int		mpt_detach(struct mpt_softc *mpt);
1218int		mpt_send_handshake_cmd(struct mpt_softc *mpt,
1219				       size_t len, void *cmd);
1220request_t *	mpt_get_request(struct mpt_softc *mpt, int sleep_ok);
1221void		mpt_free_request(struct mpt_softc *mpt, request_t *req);
1222void		mpt_intr(void *arg);
1223void		mpt_check_doorbell(struct mpt_softc *mpt);
1224void		mpt_dump_reply_frame(struct mpt_softc *mpt,
1225				     MSG_DEFAULT_REPLY *reply_frame);
1226
1227void		mpt_set_config_regs(struct mpt_softc *);
1228int		mpt_issue_cfg_req(struct mpt_softc */*mpt*/, request_t */*req*/,
1229				  cfgparms_t *params,
1230				  bus_addr_t /*addr*/, bus_size_t/*len*/,
1231				  int /*sleep_ok*/, int /*timeout_ms*/);
1232int		mpt_read_extcfg_header(struct mpt_softc *mpt, int PageVersion,
1233				       int PageNumber, uint32_t PageAddress,
1234				       int ExtPageType,
1235				       CONFIG_EXTENDED_PAGE_HEADER *rslt,
1236				       int sleep_ok, int timeout_ms);
1237int		mpt_read_extcfg_page(struct mpt_softc *mpt, int Action,
1238				     uint32_t PageAddress,
1239				     CONFIG_EXTENDED_PAGE_HEADER *hdr,
1240				     void *buf, size_t len, int sleep_ok,
1241				     int timeout_ms);
1242int		mpt_read_cfg_header(struct mpt_softc *, int /*PageType*/,
1243				    int /*PageNumber*/,
1244				    uint32_t /*PageAddress*/,
1245				    CONFIG_PAGE_HEADER *,
1246				    int /*sleep_ok*/, int /*timeout_ms*/);
1247int		mpt_read_cfg_page(struct mpt_softc *t, int /*Action*/,
1248				  uint32_t /*PageAddress*/,
1249				  CONFIG_PAGE_HEADER *, size_t /*len*/,
1250				  int /*sleep_ok*/, int /*timeout_ms*/);
1251int		mpt_write_cfg_page(struct mpt_softc *, int /*Action*/,
1252				   uint32_t /*PageAddress*/,
1253				   CONFIG_PAGE_HEADER *, size_t /*len*/,
1254				   int /*sleep_ok*/, int /*timeout_ms*/);
1255static __inline int
1256mpt_read_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1257		      CONFIG_PAGE_HEADER *hdr, size_t len,
1258		      int sleep_ok, int timeout_ms)
1259{
1260	return (mpt_read_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_READ_CURRENT,
1261				  PageAddress, hdr, len, sleep_ok, timeout_ms));
1262}
1263
1264static __inline int
1265mpt_write_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1266		       CONFIG_PAGE_HEADER *hdr, size_t len, int sleep_ok,
1267		       int timeout_ms)
1268{
1269	return (mpt_write_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_WRITE_CURRENT,
1270				   PageAddress, hdr, len, sleep_ok,
1271				   timeout_ms));
1272}
1273/* mpt_debug.c functions */
1274void mpt_print_reply(void *vmsg);
1275void mpt_print_db(uint32_t mb);
1276void mpt_print_config_reply(void *vmsg);
1277char *mpt_ioc_diag(uint32_t diag);
1278void mpt_req_state(mpt_req_state_t state);
1279void mpt_print_config_request(void *vmsg);
1280void mpt_print_request(void *vmsg);
1281void mpt_print_scsi_io_request(MSG_SCSI_IO_REQUEST *msg);
1282void mpt_dump_sgl(SGE_IO_UNION *se, int offset);
1283#endif /* _MPT_H_ */
1284