mpt.h revision 159178
1/* $FreeBSD: head/sys/dev/mpt/mpt.h 159178 2006-06-02 18:50:39Z mjacob $ */
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#else
113#include <sys/lock.h>
114#include <sys/kernel.h>
115#include <sys/queue.h>
116#include <sys/malloc.h>
117#include <sys/mutex.h>
118#include <sys/condvar.h>
119#endif
120#include <sys/proc.h>
121#include <sys/bus.h>
122#include <sys/module.h>
123
124#include <machine/cpu.h>
125#include <machine/resource.h>
126
127#if __FreeBSD_version < 500000
128#include <machine/bus.h>
129#endif
130
131#include <sys/rman.h>
132
133#if __FreeBSD_version < 500000
134#include <pci/pcireg.h>
135#include <pci/pcivar.h>
136#else
137#include <dev/pci/pcireg.h>
138#include <dev/pci/pcivar.h>
139#endif
140
141#include <machine/bus.h>
142#include "opt_ddb.h"
143
144/**************************** Register Definitions ****************************/
145#include <dev/mpt/mpt_reg.h>
146
147/******************************* MPI Definitions ******************************/
148#include <dev/mpt/mpilib/mpi_type.h>
149#include <dev/mpt/mpilib/mpi.h>
150#include <dev/mpt/mpilib/mpi_cnfg.h>
151#include <dev/mpt/mpilib/mpi_ioc.h>
152#include <dev/mpt/mpilib/mpi_raid.h>
153
154/* XXX For mpt_debug.c */
155#include <dev/mpt/mpilib/mpi_init.h>
156
157/****************************** Misc Definitions ******************************/
158#define MPT_OK (0)
159#define MPT_FAIL (0x10000)
160
161#define NUM_ELEMENTS(array) (sizeof(array) / sizeof(*array))
162
163#define	MPT_ROLE_NONE		0
164#define	MPT_ROLE_INITIATOR	1
165#define	MPT_ROLE_TARGET		2
166#define	MPT_ROLE_BOTH		3
167#define	MPT_ROLE_DEFAULT	MPT_ROLE_INITIATOR
168
169/**************************** Forward Declarations ****************************/
170struct mpt_softc;
171struct mpt_personality;
172typedef struct req_entry request_t;
173
174/************************* Personality Module Support *************************/
175typedef int mpt_load_handler_t(struct mpt_personality *);
176typedef int mpt_probe_handler_t(struct mpt_softc *);
177typedef int mpt_attach_handler_t(struct mpt_softc *);
178typedef int mpt_enable_handler_t(struct mpt_softc *);
179typedef int mpt_event_handler_t(struct mpt_softc *, request_t *,
180				MSG_EVENT_NOTIFY_REPLY *);
181typedef void mpt_reset_handler_t(struct mpt_softc *, int /*type*/);
182/* XXX Add return value and use for veto? */
183typedef void mpt_shutdown_handler_t(struct mpt_softc *);
184typedef void mpt_detach_handler_t(struct mpt_softc *);
185typedef int mpt_unload_handler_t(struct mpt_personality *);
186
187struct mpt_personality
188{
189	const char		*name;
190	uint32_t		 id;		/* Assigned identifier. */
191	u_int			 use_count;	/* Instances using personality*/
192	mpt_load_handler_t	*load;		/* configure personailty */
193#define MPT_PERS_FIRST_HANDLER(pers) (&(pers)->load)
194	mpt_probe_handler_t	*probe;		/* configure personailty */
195	mpt_attach_handler_t	*attach;	/* initialize device instance */
196	mpt_enable_handler_t	*enable;	/* enable device */
197	mpt_event_handler_t	*event;		/* Handle MPI event. */
198	mpt_reset_handler_t	*reset;		/* Re-init after reset. */
199	mpt_shutdown_handler_t	*shutdown;	/* Shutdown instance. */
200	mpt_detach_handler_t	*detach;	/* release device instance */
201	mpt_unload_handler_t	*unload;	/* Shutdown personality */
202#define MPT_PERS_LAST_HANDLER(pers) (&(pers)->unload)
203};
204
205int mpt_modevent(module_t, int, void *);
206
207/* Maximum supported number of personalities. */
208#define MPT_MAX_PERSONALITIES	(15)
209
210#define MPT_PERSONALITY_DEPEND(name, dep, vmin, vpref, vmax) \
211	MODULE_DEPEND(name, dep, vmin, vpref, vmax)
212
213#define DECLARE_MPT_PERSONALITY(name, order)				  \
214	static moduledata_t name##_mod = {				  \
215		#name, mpt_modevent, &name##_personality		  \
216	};								  \
217	DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, order);	  \
218	MODULE_VERSION(name, 1);					  \
219	MPT_PERSONALITY_DEPEND(name, mpt_core, 1, 1, 1)
220
221/******************************* Bus DMA Support ******************************/
222/* XXX Need to update bus_dmamap_sync to take a range argument. */
223#define bus_dmamap_sync_range(dma_tag, dmamap, offset, len, op)	\
224	bus_dmamap_sync(dma_tag, dmamap, op)
225
226#if __FreeBSD_version >= 501102
227#define mpt_dma_tag_create(mpt, parent_tag, alignment, boundary,	\
228			   lowaddr, highaddr, filter, filterarg,	\
229			   maxsize, nsegments, maxsegsz, flags,		\
230			   dma_tagp)					\
231	bus_dma_tag_create(parent_tag, alignment, boundary,		\
232			   lowaddr, highaddr, filter, filterarg,	\
233			   maxsize, nsegments, maxsegsz, flags,		\
234			   busdma_lock_mutex, &Giant,			\
235			   dma_tagp)
236#else
237#define mpt_dma_tag_create(mpt, parent_tag, alignment, boundary,	\
238			   lowaddr, highaddr, filter, filterarg,	\
239			   maxsize, nsegments, maxsegsz, flags,		\
240			   dma_tagp)					\
241	bus_dma_tag_create(parent_tag, alignment, boundary,		\
242			   lowaddr, highaddr, filter, filterarg,	\
243			   maxsize, nsegments, maxsegsz, flags,		\
244			   dma_tagp)
245#endif
246
247struct mpt_map_info {
248	struct mpt_softc *mpt;
249	int		  error;
250	uint32_t	  phys;
251};
252
253void mpt_map_rquest(void *, bus_dma_segment_t *, int, int);
254
255/**************************** Kernel Thread Support ***************************/
256#if __FreeBSD_version > 500005
257#define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
258	kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
259#else
260#define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
261	kthread_create(func, farg, proc_ptr, fmtstr, arg)
262#endif
263
264/****************************** Timer Facilities ******************************/
265#if __FreeBSD_version > 500000
266#define mpt_callout_init(c)	callout_init(c, /*mpsafe*/0);
267#else
268#define mpt_callout_init(c)	callout_init(c);
269#endif
270
271/********************************** Endianess *********************************/
272static __inline uint64_t
273u64toh(U64 s)
274{
275	uint64_t result;
276
277	result = le32toh(s.Low);
278	result |= ((uint64_t)le32toh(s.High)) << 32;
279	return (result);
280}
281
282/**************************** MPI Transaction State ***************************/
283typedef enum {
284	REQ_STATE_NIL		= 0x00,
285	REQ_STATE_FREE		= 0x01,
286	REQ_STATE_ALLOCATED	= 0x02,
287	REQ_STATE_QUEUED	= 0x04,
288	REQ_STATE_DONE		= 0x08,
289	REQ_STATE_TIMEDOUT	= 0x10,
290	REQ_STATE_NEED_WAKEUP	= 0x20,
291	REQ_STATE_LOCKED	= 0x80,	/* can't be freed */
292	REQ_STATE_MASK		= 0xFF
293} mpt_req_state_t;
294
295struct req_entry {
296	TAILQ_ENTRY(req_entry) links;	/* Pointer to next in list */
297	mpt_req_state_t	state;		/* Request State Information */
298	uint16_t	index;		/* Index of this entry */
299	uint16_t	IOCStatus;	/* Completion status */
300	uint16_t	ResponseCode;	/* TMF Reponse Code */
301	uint16_t	serno;		/* serial number */
302	union ccb      *ccb;		/* CAM request */
303	void	       *req_vbuf;	/* Virtual Address of Entry */
304	void	       *sense_vbuf;	/* Virtual Address of sense data */
305	bus_addr_t	req_pbuf;	/* Physical Address of Entry */
306	bus_addr_t	sense_pbuf;	/* Physical Address of sense data */
307	bus_dmamap_t	dmap;		/* DMA map for data buffer */
308	struct req_entry *chain;	/* for SGE overallocations */
309};
310
311/**************************** MPI Target State Info ***************************/
312
313typedef struct {
314	uint32_t reply_desc;	/* current reply descriptor */
315	uint32_t resid;		/* current data residual */
316	uint32_t bytes_xfered;	/* current relative offset */
317	union ccb *ccb;		/* pointer to currently active ccb */
318	request_t *req;		/* pointer to currently active assist request */
319	int	nxfers;
320	uint32_t tag_id;
321	enum {
322		TGT_STATE_NIL,
323		TGT_STATE_LOADING,
324		TGT_STATE_LOADED,
325		TGT_STATE_IN_CAM,
326                TGT_STATE_SETTING_UP_FOR_DATA,
327                TGT_STATE_MOVING_DATA,
328                TGT_STATE_MOVING_DATA_AND_STATUS,
329                TGT_STATE_SENDING_STATUS
330	} state;
331} mpt_tgt_state_t;
332
333/*
334 * When we get an incoming command it has its own tag which is called the
335 * IoIndex. This is the value we gave that particular command buffer when
336 * we originally assigned it. It's just a number, really. The FC card uses
337 * it as an RX_ID. We can use it to index into mpt->tgt_cmd_ptrs, which
338 * contains pointers the request_t structures related to that IoIndex.
339 *
340 * What *we* do is construct a tag out of the index for the target command
341 * which owns the incoming ATIO plus a rolling sequence number.
342 */
343#define	MPT_MAKE_TAGID(mpt, req, ioindex)	\
344 ((ioindex << 18) | (((mpt->sequence++) & 0x3f) << 12) | (req->index & 0xfff))
345
346#ifdef	INVARIANTS
347#define	MPT_TAG_2_REQ(a, b)		mpt_tag_2_req(a, (uint32_t) b)
348#else
349#define	MPT_TAG_2_REQ(mpt, tag)		mpt->tgt_cmd_ptrs[tag >> 18]
350#endif
351
352#define	MPT_TGT_STATE(mpt, req) ((mpt_tgt_state_t *) \
353    (&((uint8_t *)req->req_vbuf)[MPT_RQSL(mpt) - sizeof (mpt_tgt_state_t)]))
354
355STAILQ_HEAD(mpt_hdr_stailq, ccb_hdr);
356#define	MPT_MAX_LUNS	256
357typedef struct {
358	struct mpt_hdr_stailq	atios;
359	struct mpt_hdr_stailq	inots;
360	int enabled;
361} tgt_resource_t;
362#define	MPT_MAX_ELS	64
363
364/**************************** Handler Registration ****************************/
365/*
366 * Global table of registered reply handlers.  The
367 * handler is indicated by byte 3 of the request
368 * index submitted to the IOC.  This allows the
369 * driver core to perform generic processing without
370 * any knowledge of per-personality behavior.
371 *
372 * MPT_NUM_REPLY_HANDLERS must be a power of 2
373 * to allow the easy generation of a mask.
374 *
375 * The handler offsets used by the core are hard coded
376 * allowing faster code generation when assigning a handler
377 * to a request.  All "personalities" must use the
378 * the handler registration mechanism.
379 *
380 * The IOC handlers that are rarely executed are placed
381 * at the tail of the table to make it more likely that
382 * all commonly executed handlers fit in a single cache
383 * line.
384 */
385#define MPT_NUM_REPLY_HANDLERS		(32)
386#define MPT_REPLY_HANDLER_EVENTS	MPT_CBI_TO_HID(0)
387#define MPT_REPLY_HANDLER_CONFIG	MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-1)
388#define MPT_REPLY_HANDLER_HANDSHAKE	MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-2)
389typedef int mpt_reply_handler_t(struct mpt_softc *mpt, request_t *request,
390    uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame);
391typedef union {
392	mpt_reply_handler_t	*reply_handler;
393} mpt_handler_t;
394
395typedef enum {
396	MPT_HANDLER_REPLY,
397	MPT_HANDLER_EVENT,
398	MPT_HANDLER_RESET,
399	MPT_HANDLER_SHUTDOWN
400} mpt_handler_type;
401
402struct mpt_handler_record
403{
404	LIST_ENTRY(mpt_handler_record)	links;
405	mpt_handler_t			handler;
406};
407
408LIST_HEAD(mpt_handler_list, mpt_handler_record);
409
410/*
411 * The handler_id is currently unused but would contain the
412 * handler ID used in the MsgContext field to allow direction
413 * of replies to the handler.  Registrations that don't require
414 * a handler id can pass in NULL for the handler_id.
415 *
416 * Deregistrations for handlers without a handler id should
417 * pass in MPT_HANDLER_ID_NONE.
418 */
419#define MPT_HANDLER_ID_NONE		(0xFFFFFFFF)
420int mpt_register_handler(struct mpt_softc *, mpt_handler_type,
421			 mpt_handler_t, uint32_t *);
422int mpt_deregister_handler(struct mpt_softc *, mpt_handler_type,
423			   mpt_handler_t, uint32_t);
424
425/******************* Per-Controller Instance Data Structures ******************/
426TAILQ_HEAD(req_queue, req_entry);
427
428/* Structure for saving proper values for modifyable PCI config registers */
429struct mpt_pci_cfg {
430	uint16_t Command;
431	uint16_t LatencyTimer_LineSize;
432	uint32_t IO_BAR;
433	uint32_t Mem0_BAR[2];
434	uint32_t Mem1_BAR[2];
435	uint32_t ROM_BAR;
436	uint8_t  IntLine;
437	uint32_t PMCSR;
438};
439
440typedef enum {
441	MPT_RVF_NONE		= 0x0,
442	MPT_RVF_ACTIVE		= 0x1,
443	MPT_RVF_ANNOUNCED	= 0x2,
444	MPT_RVF_UP2DATE		= 0x4,
445	MPT_RVF_REFERENCED	= 0x8,
446	MPT_RVF_WCE_CHANGED	= 0x10
447} mpt_raid_volume_flags;
448
449struct mpt_raid_volume {
450	CONFIG_PAGE_RAID_VOL_0	       *config_page;
451	MPI_RAID_VOL_INDICATOR		sync_progress;
452	mpt_raid_volume_flags		flags;
453	u_int				quiesced_disks;
454};
455
456typedef enum {
457	MPT_RDF_NONE		= 0x00,
458	MPT_RDF_ACTIVE		= 0x01,
459	MPT_RDF_ANNOUNCED	= 0x02,
460	MPT_RDF_UP2DATE		= 0x04,
461	MPT_RDF_REFERENCED	= 0x08,
462	MPT_RDF_QUIESCING	= 0x10,
463	MPT_RDF_QUIESCED	= 0x20
464} mpt_raid_disk_flags;
465
466struct mpt_raid_disk {
467	CONFIG_PAGE_RAID_PHYS_DISK_0	config_page;
468	struct mpt_raid_volume	       *volume;
469	u_int				member_number;
470	u_int				pass_thru_active;
471	mpt_raid_disk_flags		flags;
472};
473
474struct mpt_evtf_record {
475	MSG_EVENT_NOTIFY_REPLY		reply;
476	uint32_t			context;
477	LIST_ENTRY(mpt_evtf_record)	links;
478};
479
480LIST_HEAD(mpt_evtf_list, mpt_evtf_record);
481
482struct mpt_softc {
483	device_t		dev;
484#if __FreeBSD_version < 500000
485	uint32_t		mpt_islocked;
486	int			mpt_splsaved;
487#else
488	struct mtx		mpt_lock;
489	int			mpt_locksetup;
490#endif
491	uint32_t		mpt_pers_mask;
492	uint32_t		: 8,
493		unit		: 8,
494				: 1,
495		twildcard	: 1,
496		tenabled	: 1,
497		role		: 2,	/* none, ini, target, both */
498				: 1,
499		raid_enabled	: 1,
500		raid_mwce_set	: 1,
501		getreqwaiter	: 1,
502		shutdwn_raid    : 1,
503		shutdwn_recovery: 1,
504		outofbeer	: 1,
505		disabled	: 1,
506		is_spi		: 1,
507		is_sas		: 1,
508		is_fc		: 1;
509
510	u_int			verbose;
511
512	/*
513	 * IOC Facts
514	 */
515	uint16_t	mpt_global_credits;
516	uint16_t	request_frame_size;
517	uint8_t		mpt_max_devices;
518	uint8_t		mpt_max_buses;
519	uint8_t		ioc_facts_flags;
520	uint8_t		padding0;
521
522	/*
523	 * Port Facts
524	 * XXX - Add multi-port support!.
525	 */
526	uint16_t	mpt_ini_id;
527	uint16_t	mpt_port_type;
528	uint16_t	mpt_proto_flags;
529	uint16_t	mpt_max_tgtcmds;
530
531	/*
532	 * Device Configuration Information
533	 */
534	union {
535		struct mpt_spi_cfg {
536			CONFIG_PAGE_SCSI_PORT_0		_port_page0;
537			CONFIG_PAGE_SCSI_PORT_1		_port_page1;
538			CONFIG_PAGE_SCSI_PORT_2		_port_page2;
539			CONFIG_PAGE_SCSI_DEVICE_0	_dev_page0[16];
540			CONFIG_PAGE_SCSI_DEVICE_1	_dev_page1[16];
541			uint16_t			_tag_enable;
542			uint16_t			_disc_enable;
543			struct {
544				uint8_t inqdata[39];
545				uint8_t	state;
546			} _dv[16];
547		} spi;
548#define	mpt_port_page0		cfg.spi._port_page0
549#define	mpt_port_page1		cfg.spi._port_page1
550#define	mpt_port_page2		cfg.spi._port_page2
551#define	mpt_dev_page0		cfg.spi._dev_page0
552#define	mpt_dev_page1		cfg.spi._dev_page1
553#define	mpt_tag_enable		cfg.spi._tag_enable
554#define	mpt_disc_enable		cfg.spi._disc_enable
555#define	mpt_dv			cfg.spi._dv
556# define	DV_STATE_0	0
557# define	DV_STATE_1	1
558# define	DV_STATE_DONE	0xff
559		struct mpi_fc_cfg {
560			CONFIG_PAGE_FC_PORT_0 _port_page0;
561#define	mpt_fcport_page0	cfg.fc._port_page0
562		} fc;
563	} cfg;
564
565	/* Controller Info for RAID information */
566	CONFIG_PAGE_IOC_2 *	ioc_page2;
567	CONFIG_PAGE_IOC_3 *	ioc_page3;
568
569	/* Raid Data */
570	struct mpt_raid_volume* raid_volumes;
571	struct mpt_raid_disk*	raid_disks;
572	u_int			raid_max_volumes;
573	u_int			raid_max_disks;
574	u_int			raid_page0_len;
575	u_int			raid_wakeup;
576	u_int			raid_rescan;
577	u_int			raid_resync_rate;
578	u_int			raid_mwce_setting;
579	u_int			raid_queue_depth;
580	u_int			raid_nonopt_volumes;
581	struct proc	       *raid_thread;
582	struct callout		raid_timer;
583
584	/*
585	 * PCI Hardware info
586	 */
587	struct resource *	pci_irq;	/* Interrupt map for chip */
588	void *			ih;		/* Interupt handle */
589	struct mpt_pci_cfg	pci_cfg;	/* saved PCI conf registers */
590
591	/*
592	 * DMA Mapping Stuff
593	 */
594	struct resource *	pci_reg;	/* Register map for chip */
595	int			pci_mem_rid;	/* Resource ID */
596	bus_space_tag_t		pci_st;		/* Bus tag for registers */
597	bus_space_handle_t	pci_sh;		/* Bus handle for registers */
598	/* PIO versions of above. */
599	int			pci_pio_rid;
600	struct resource *	pci_pio_reg;
601	bus_space_tag_t		pci_pio_st;
602	bus_space_handle_t	pci_pio_sh;
603
604	bus_dma_tag_t		parent_dmat;	/* DMA tag for parent PCI bus */
605	bus_dma_tag_t		reply_dmat;	/* DMA tag for reply memory */
606	bus_dmamap_t		reply_dmap;	/* DMA map for reply memory */
607	uint8_t		       *reply;		/* KVA of reply memory */
608	bus_addr_t		reply_phys;	/* BusAddr of reply memory */
609
610	bus_dma_tag_t		buffer_dmat;	/* DMA tag for buffers */
611	bus_dma_tag_t		request_dmat;	/* DMA tag for request memroy */
612	bus_dmamap_t		request_dmap;	/* DMA map for request memroy */
613	uint8_t		       *request;	/* KVA of Request memory */
614	bus_addr_t		request_phys;	/* BusAddr of request memory */
615
616	uint32_t		max_seg_cnt;	/* calculated after IOC facts */
617
618	/*
619	 * Hardware management
620	 */
621	u_int			reset_cnt;
622
623	/*
624	 * CAM && Software Management
625	 */
626	request_t	       *request_pool;
627	struct req_queue	request_free_list;
628	struct req_queue	request_pending_list;
629	struct req_queue	request_timeout_list;
630
631
632	struct cam_sim	       *sim;
633	struct cam_path	       *path;
634
635	struct cam_sim	       *phydisk_sim;
636	struct cam_path	       *phydisk_path;
637
638	struct proc	       *recovery_thread;
639	request_t	       *tmf_req;
640
641	/*
642	 * Deferred frame acks due to resource shortage.
643	 */
644	struct mpt_evtf_list	ack_frames;
645	/*
646	 * Target Mode Support
647	 */
648	uint32_t		scsi_tgt_handler_id;
649	request_t **		tgt_cmd_ptrs;
650	request_t **		els_cmd_ptrs;	/* FC only */
651
652	/*
653	 * *snork*- this is chosen to be here *just in case* somebody
654	 * forgets to point to it exactly and we index off of trt with
655	 * CAM_LUN_WILDCARD.
656	 */
657	tgt_resource_t		trt_wildcard;	/* wildcard luns */
658	tgt_resource_t		trt[MPT_MAX_LUNS];
659	uint16_t		tgt_cmds_allocated;
660	uint16_t		els_cmds_allocated;	/* FC only */
661
662	uint16_t		timeouts;	/* timeout count */
663	uint16_t		success;	/* successes afer timeout */
664	uint16_t		sequence;	/* Sequence Number */
665	uint16_t		pad3;
666
667
668	/* Opposing port in a 929 or 1030, or NULL */
669	struct mpt_softc *	mpt2;
670
671	/* FW Image management */
672	uint32_t		fw_image_size;
673	uint8_t		       *fw_image;
674	bus_dma_tag_t		fw_dmat;	/* DMA tag for firmware image */
675	bus_dmamap_t		fw_dmap;	/* DMA map for firmware image */
676	bus_addr_t		fw_phys;	/* BusAddr of firmware image */
677
678	/* Shutdown Event Handler. */
679	eventhandler_tag         eh;
680
681	TAILQ_ENTRY(mpt_softc)	links;
682};
683
684static __inline void mpt_assign_serno(struct mpt_softc *, request_t *);
685
686static __inline void
687mpt_assign_serno(struct mpt_softc *mpt, request_t *req)
688{
689	if ((req->serno = mpt->sequence++) == 0) {
690		req->serno = mpt->sequence++;
691	}
692}
693
694/***************************** Locking Primitives *****************************/
695#if __FreeBSD_version < 500000
696#define	MPT_IFLAGS		INTR_TYPE_CAM
697#define	MPT_LOCK(mpt)		mpt_lockspl(mpt)
698#define	MPT_UNLOCK(mpt)		mpt_unlockspl(mpt)
699#define	MPT_OWNED(mpt)		mpt->mpt_islocked
700#define	MPTLOCK_2_CAMLOCK	MPT_UNLOCK
701#define	CAMLOCK_2_MPTLOCK	MPT_LOCK
702#define	MPT_LOCK_SETUP(mpt)
703#define	MPT_LOCK_DESTROY(mpt)
704
705static __inline void mpt_lockspl(struct mpt_softc *mpt);
706static __inline void mpt_unlockspl(struct mpt_softc *mpt);
707
708static __inline void
709mpt_lockspl(struct mpt_softc *mpt)
710{
711       int s;
712
713       s = splcam();
714       if (mpt->mpt_islocked++ == 0) {
715               mpt->mpt_splsaved = s;
716       } else {
717               splx(s);
718	       panic("Recursed lock with mask: 0x%x\n", s);
719       }
720}
721
722static __inline void
723mpt_unlockspl(struct mpt_softc *mpt)
724{
725       if (mpt->mpt_islocked) {
726               if (--mpt->mpt_islocked == 0) {
727                       splx(mpt->mpt_splsaved);
728               }
729       } else
730	       panic("Negative lock count\n");
731}
732
733static __inline int
734mpt_sleep(struct mpt_softc *mpt, void *ident, int priority,
735	   const char *wmesg, int timo)
736{
737	int saved_cnt;
738	int saved_spl;
739	int error;
740
741	KASSERT(mpt->mpt_islocked <= 1, ("Invalid lock count on tsleep"));
742	saved_cnt = mpt->mpt_islocked;
743	saved_spl = mpt->mpt_splsaved;
744	mpt->mpt_islocked = 0;
745	error = tsleep(ident, priority, wmesg, timo);
746	KASSERT(mpt->mpt_islocked == 0, ("Invalid lock count on wakeup"));
747	mpt->mpt_islocked = saved_cnt;
748	mpt->mpt_splsaved = saved_spl;
749	return (error);
750}
751
752#else
753#ifdef	LOCKING_WORKED_AS_IT_SHOULD
754#error "Shouldn't Be Here!"
755#define	MPT_IFLAGS		INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
756#define	MPT_LOCK_SETUP(mpt)						\
757		mtx_init(&mpt->mpt_lock, "mpt", NULL, MTX_DEF);		\
758		mpt->mpt_locksetup = 1
759#define	MPT_LOCK_DESTROY(mpt)						\
760	if (mpt->mpt_locksetup) {					\
761		mtx_destroy(&mpt->mpt_lock);				\
762		mpt->mpt_locksetup = 0;					\
763	}
764
765#define	MPT_LOCK(mpt)		mtx_lock(&(mpt)->mpt_lock)
766#define	MPT_UNLOCK(mpt)		mtx_unlock(&(mpt)->mpt_lock)
767#define	MPT_OWNED(mpt)		mtx_owned(&(mpt)->mpt_lock)
768#define	MPTLOCK_2_CAMLOCK(mpt)	\
769	mtx_unlock(&(mpt)->mpt_lock); mtx_lock(&Giant)
770#define	CAMLOCK_2_MPTLOCK(mpt)	\
771	mtx_unlock(&Giant); mtx_lock(&(mpt)->mpt_lock)
772#define mpt_sleep(mpt, ident, priority, wmesg, timo) \
773	msleep(ident, &(mpt)->mpt_lock, priority, wmesg, timo)
774
775#else
776
777#define	MPT_IFLAGS		INTR_TYPE_CAM | INTR_ENTROPY
778#define	MPT_LOCK_SETUP(mpt)	do { } while (0)
779#define	MPT_LOCK_DESTROY(mpt)	do { } while (0)
780#if	0
781#define	MPT_LOCK(mpt)		\
782	device_printf(mpt->dev, "LOCK %s:%d\n", __FILE__, __LINE__); 	\
783	KASSERT(mpt->mpt_locksetup == 0,				\
784	    ("recursive lock acquire at %s:%d", __FILE__, __LINE__));	\
785	mpt->mpt_locksetup = 1
786#define	MPT_UNLOCK(mpt)		\
787	device_printf(mpt->dev, "UNLK %s:%d\n", __FILE__, __LINE__); 	\
788	KASSERT(mpt->mpt_locksetup == 1,				\
789	    ("release unowned lock at %s:%d", __FILE__, __LINE__));	\
790	mpt->mpt_locksetup = 0
791#else
792#define	MPT_LOCK(mpt)							\
793	KASSERT(mpt->mpt_locksetup == 0,				\
794	    ("recursive lock acquire at %s:%d", __FILE__, __LINE__));	\
795	mpt->mpt_locksetup = 1
796#define	MPT_UNLOCK(mpt)							\
797	KASSERT(mpt->mpt_locksetup == 1,				\
798	    ("release unowned lock at %s:%d", __FILE__, __LINE__));	\
799	mpt->mpt_locksetup = 0
800#endif
801#define	MPT_OWNED(mpt)		mpt->mpt_locksetup
802#define	MPTLOCK_2_CAMLOCK(mpt)	MPT_UNLOCK(mpt)
803#define	CAMLOCK_2_MPTLOCK(mpt)	MPT_LOCK(mpt)
804
805static __inline int
806mpt_sleep(struct mpt_softc *, void *, int, const char *, int);
807
808static __inline int
809mpt_sleep(struct mpt_softc *mpt, void *i, int p, const char *w, int t)
810{
811	int r;
812	MPT_UNLOCK(mpt);
813	r = tsleep(i, p, w, t);
814	MPT_LOCK(mpt);
815	return (r);
816}
817#endif
818#endif
819
820/******************************* Register Access ******************************/
821static __inline void mpt_write(struct mpt_softc *, size_t, uint32_t);
822static __inline uint32_t mpt_read(struct mpt_softc *, int);
823static __inline void mpt_pio_write(struct mpt_softc *, size_t, uint32_t);
824static __inline uint32_t mpt_pio_read(struct mpt_softc *, int);
825
826static __inline void
827mpt_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
828{
829	bus_space_write_4(mpt->pci_st, mpt->pci_sh, offset, val);
830}
831
832static __inline uint32_t
833mpt_read(struct mpt_softc *mpt, int offset)
834{
835	return (bus_space_read_4(mpt->pci_st, mpt->pci_sh, offset));
836}
837
838/*
839 * Some operations (e.g. diagnostic register writes while the ARM proccessor
840 * is disabled), must be performed using "PCI pio" operations.  On non-PCI
841 * busses, these operations likely map to normal register accesses.
842 */
843static __inline void
844mpt_pio_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
845{
846	bus_space_write_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset, val);
847}
848
849static __inline uint32_t
850mpt_pio_read(struct mpt_softc *mpt, int offset)
851{
852	return (bus_space_read_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset));
853}
854/*********************** Reply Frame/Request Management ***********************/
855/* Max MPT Reply we are willing to accept (must be power of 2) */
856#define MPT_REPLY_SIZE   	256
857
858/*
859 * Must be less than 16384 in order for target mode to work
860 */
861#define MPT_MAX_REQUESTS(mpt)	512
862#define MPT_REQUEST_AREA	512
863#define MPT_SENSE_SIZE		32	/* included in MPT_REQUEST_AREA */
864#define MPT_REQ_MEM_SIZE(mpt)	(MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
865
866#define MPT_CONTEXT_CB_SHIFT	(16)
867#define MPT_CBI(handle)		(handle >> MPT_CONTEXT_CB_SHIFT)
868#define MPT_CBI_TO_HID(cbi)	((cbi) << MPT_CONTEXT_CB_SHIFT)
869#define MPT_CONTEXT_TO_CBI(x)	\
870    (((x) >> MPT_CONTEXT_CB_SHIFT) & (MPT_NUM_REPLY_HANDLERS - 1))
871#define MPT_CONTEXT_REQI_MASK	0xFFFF
872#define MPT_CONTEXT_TO_REQI(x)	((x) & MPT_CONTEXT_REQI_MASK)
873
874/*
875 * Convert a 32bit physical address returned from IOC to an
876 * offset into our reply frame memory or the kvm address needed
877 * to access the data.  The returned address is only the low
878 * 32 bits, so mask our base physical address accordingly.
879 */
880#define MPT_REPLY_BADDR(x)		\
881	(x << 1)
882#define MPT_REPLY_OTOV(m, i) 		\
883	((void *)(&m->reply[i]))
884
885#define	MPT_DUMP_REPLY_FRAME(mpt, reply_frame)		\
886do {							\
887	if (mpt->verbose > MPT_PRT_DEBUG)		\
888		mpt_dump_reply_frame(mpt, reply_frame);	\
889} while(0)
890
891static __inline uint32_t mpt_pop_reply_queue(struct mpt_softc *mpt);
892static __inline void mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr);
893
894/*
895 * Give the reply buffer back to the IOC after we have
896 * finished processing it.
897 */
898static __inline void
899mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr)
900{
901     mpt_write(mpt, MPT_OFFSET_REPLY_Q, ptr);
902}
903
904/* Get a reply from the IOC */
905static __inline uint32_t
906mpt_pop_reply_queue(struct mpt_softc *mpt)
907{
908     return mpt_read(mpt, MPT_OFFSET_REPLY_Q);
909}
910
911void
912mpt_complete_request_chain(struct mpt_softc *, struct req_queue *, u_int);
913
914/************************** Scatter Gather Managment **************************/
915/* MPT_RQSL- size of request frame, in bytes */
916#define	MPT_RQSL(mpt)		(mpt->request_frame_size << 2)
917
918/* MPT_NSGL- how many SG entries can fit in a request frame size */
919#define	MPT_NSGL(mpt)		(MPT_RQSL(mpt) / sizeof (SGE_IO_UNION))
920
921/* MPT_NRFM- how many request frames can fit in each request alloc we make */
922#define	MPT_NRFM(mpt)		(MPT_REQUEST_AREA / MPT_RQSL(mpt))
923
924/*
925 * MPT_NSGL_FIRST- # of SG elements that can fit after
926 * an I/O request but still within the request frame.
927 * Do this safely based upon SGE_IO_UNION.
928 *
929 * Note that the first element is *within* the SCSI request.
930 */
931#define	MPT_NSGL_FIRST(mpt)	\
932    ((MPT_RQSL(mpt) - sizeof (MSG_SCSI_IO_REQUEST) + sizeof (SGE_IO_UNION)) / \
933    sizeof (SGE_IO_UNION))
934
935/***************************** IOC Initialization *****************************/
936int mpt_reset(struct mpt_softc *, int /*reinit*/);
937
938/****************************** Debugging ************************************/
939typedef struct mpt_decode_entry {
940	char    *name;
941	u_int	 value;
942	u_int	 mask;
943} mpt_decode_entry_t;
944
945int mpt_decode_value(mpt_decode_entry_t *table, u_int num_entries,
946		     const char *name, u_int value, u_int *cur_column,
947		     u_int wrap_point);
948
949void mpt_dump_request(struct mpt_softc *, request_t *);
950
951enum {
952	MPT_PRT_ALWAYS,
953	MPT_PRT_FATAL,
954	MPT_PRT_ERROR,
955	MPT_PRT_WARN,
956	MPT_PRT_INFO,
957	MPT_PRT_NEGOTIATION,
958	MPT_PRT_DEBUG,
959	MPT_PRT_DEBUG1,
960	MPT_PRT_DEBUG2,
961	MPT_PRT_DEBUG3,
962	MPT_PRT_TRACE,
963	MPT_PRT_NONE=100
964};
965
966#if __FreeBSD_version > 500000
967#define mpt_lprt(mpt, level, ...)		\
968do {						\
969	if (level <= (mpt)->verbose)		\
970		mpt_prt(mpt, __VA_ARGS__);	\
971} while (0)
972
973#define mpt_lprtc(mpt, level, ...)		 \
974do {						 \
975	if (level <= (mpt)->debug_level)	 \
976		mpt_prtc(mpt, __VA_ARGS__);	 \
977} while (0)
978#else
979void mpt_lprt(struct mpt_softc *, int, const char *, ...)
980	__printflike(3, 4);
981void mpt_lprtc(struct mpt_softc *, int, const char *, ...)
982	__printflike(3, 4);
983#endif
984void mpt_prt(struct mpt_softc *, const char *, ...)
985	__printflike(2, 3);
986void mpt_prtc(struct mpt_softc *, const char *, ...)
987	__printflike(2, 3);
988
989/**************************** Target Mode Related ***************************/
990static __inline int mpt_cdblen(uint8_t, int);
991static __inline int
992mpt_cdblen(uint8_t cdb0, int maxlen)
993{
994	int group = cdb0 >> 5;
995	switch (group) {
996	case 0:
997		return (6);
998	case 1:
999		return (10);
1000	case 4:
1001	case 5:
1002		return (12);
1003	default:
1004		return (16);
1005	}
1006}
1007#ifdef	INVARIANTS
1008static __inline request_t * mpt_tag_2_req(struct mpt_softc *, uint32_t);
1009static __inline request_t *
1010mpt_tag_2_req(struct mpt_softc *mpt, uint32_t tag)
1011{
1012	uint16_t rtg = (tag >> 18);
1013	KASSERT(rtg < mpt->tgt_cmds_allocated, ("bad tag %d\n", tag));
1014	KASSERT(mpt->tgt_cmd_ptrs, ("no cmd backpointer array"));
1015	KASSERT(mpt->tgt_cmd_ptrs[rtg], ("no cmd backpointer"));
1016	return (mpt->tgt_cmd_ptrs[rtg]);
1017}
1018
1019
1020static __inline int
1021mpt_req_on_free_list(struct mpt_softc *, request_t *);
1022static __inline int
1023mpt_req_on_pending_list(struct mpt_softc *, request_t *);
1024
1025static __inline void
1026mpt_req_spcl(struct mpt_softc *, request_t *, const char *, int);
1027static __inline void
1028mpt_req_not_spcl(struct mpt_softc *, request_t *, const char *, int);
1029
1030
1031/*
1032 * Is request on freelist?
1033 */
1034static __inline int
1035mpt_req_on_free_list(struct mpt_softc *mpt, request_t *req)
1036{
1037	request_t *lrq;
1038
1039	TAILQ_FOREACH(lrq, &mpt->request_free_list, links) {
1040		if (lrq == req) {
1041			return (1);
1042		}
1043	}
1044	return (0);
1045}
1046
1047/*
1048 * Is request on pending list?
1049 */
1050static __inline int
1051mpt_req_on_pending_list(struct mpt_softc *mpt, request_t *req)
1052{
1053	request_t *lrq;
1054
1055	TAILQ_FOREACH(lrq, &mpt->request_pending_list, links) {
1056		if (lrq == req) {
1057			return (1);
1058		}
1059	}
1060	return (0);
1061}
1062
1063/*
1064 * Make sure that req *is* part of one of the special lists
1065 */
1066static __inline void
1067mpt_req_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1068{
1069	int i;
1070	for (i = 0; i < mpt->els_cmds_allocated; i++) {
1071		if (req == mpt->els_cmd_ptrs[i]) {
1072			return;
1073		}
1074	}
1075	for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1076		if (req == mpt->tgt_cmd_ptrs[i]) {
1077			return;
1078		}
1079	}
1080	panic("%s(%d): req %p:%u function %x not in els or tgt ptrs\n",
1081	    s, line, req, req->serno,
1082	    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function);
1083}
1084
1085/*
1086 * Make sure that req is *not* part of one of the special lists.
1087 */
1088static __inline void
1089mpt_req_not_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1090{
1091	int i;
1092	for (i = 0; i < mpt->els_cmds_allocated; i++) {
1093		KASSERT(req != mpt->els_cmd_ptrs[i],
1094		    ("%s(%d): req %p:%u func %x in els ptrs at ioindex %d\n",
1095		    s, line, req, req->serno,
1096		    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1097	}
1098	for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1099		KASSERT(req != mpt->tgt_cmd_ptrs[i],
1100		    ("%s(%d): req %p:%u func %x in tgt ptrs at ioindex %d\n",
1101		    s, line, req, req->serno,
1102		    ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1103	}
1104}
1105#endif
1106
1107typedef enum {
1108	MPT_ABORT_TASK_SET=1234,
1109	MPT_CLEAR_TASK_SET,
1110	MPT_TARGET_RESET,
1111	MPT_CLEAR_ACA,
1112	MPT_TERMINATE_TASK,
1113	MPT_NIL_TMT_VALUE=5678
1114} mpt_task_mgmt_t;
1115
1116/**************************** Unclassified Routines ***************************/
1117void		mpt_send_cmd(struct mpt_softc *mpt, request_t *req);
1118int		mpt_recv_handshake_reply(struct mpt_softc *mpt,
1119					 size_t reply_len, void *reply);
1120int		mpt_wait_req(struct mpt_softc *mpt, request_t *req,
1121			     mpt_req_state_t state, mpt_req_state_t mask,
1122			     int sleep_ok, int time_ms);
1123void		mpt_enable_ints(struct mpt_softc *mpt);
1124void		mpt_disable_ints(struct mpt_softc *mpt);
1125int		mpt_attach(struct mpt_softc *mpt);
1126int		mpt_shutdown(struct mpt_softc *mpt);
1127int		mpt_detach(struct mpt_softc *mpt);
1128int		mpt_send_handshake_cmd(struct mpt_softc *mpt,
1129				       size_t len, void *cmd);
1130request_t *	mpt_get_request(struct mpt_softc *mpt, int sleep_ok);
1131void		mpt_free_request(struct mpt_softc *mpt, request_t *req);
1132void		mpt_intr(void *arg);
1133void		mpt_check_doorbell(struct mpt_softc *mpt);
1134void		mpt_dump_reply_frame(struct mpt_softc *mpt,
1135				     MSG_DEFAULT_REPLY *reply_frame);
1136
1137void		mpt_set_config_regs(struct mpt_softc *);
1138int		mpt_issue_cfg_req(struct mpt_softc */*mpt*/, request_t */*req*/,
1139				  u_int /*Action*/, u_int /*PageVersion*/,
1140				  u_int /*PageLength*/, u_int /*PageNumber*/,
1141				  u_int /*PageType*/, uint32_t /*PageAddress*/,
1142				  bus_addr_t /*addr*/, bus_size_t/*len*/,
1143				  int /*sleep_ok*/, int /*timeout_ms*/);
1144int		mpt_read_cfg_header(struct mpt_softc *, int /*PageType*/,
1145				    int /*PageNumber*/,
1146				    uint32_t /*PageAddress*/,
1147				    CONFIG_PAGE_HEADER *,
1148				    int /*sleep_ok*/, int /*timeout_ms*/);
1149int		mpt_read_cfg_page(struct mpt_softc *t, int /*Action*/,
1150				  uint32_t /*PageAddress*/,
1151				  CONFIG_PAGE_HEADER *, size_t /*len*/,
1152				  int /*sleep_ok*/, int /*timeout_ms*/);
1153int		mpt_write_cfg_page(struct mpt_softc *, int /*Action*/,
1154				   uint32_t /*PageAddress*/,
1155				   CONFIG_PAGE_HEADER *, size_t /*len*/,
1156				   int /*sleep_ok*/, int /*timeout_ms*/);
1157static __inline int
1158mpt_read_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1159		      CONFIG_PAGE_HEADER *hdr, size_t len,
1160		      int sleep_ok, int timeout_ms)
1161{
1162	return (mpt_read_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_READ_CURRENT,
1163				  PageAddress, hdr, len, sleep_ok, timeout_ms));
1164}
1165
1166static __inline int
1167mpt_write_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1168		       CONFIG_PAGE_HEADER *hdr, size_t len, int sleep_ok,
1169		       int timeout_ms)
1170{
1171	return (mpt_write_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_WRITE_CURRENT,
1172				   PageAddress, hdr, len, sleep_ok,
1173				   timeout_ms));
1174}
1175
1176/* mpt_debug.c functions */
1177void mpt_print_reply(void *vmsg);
1178void mpt_print_db(uint32_t mb);
1179void mpt_print_config_reply(void *vmsg);
1180char *mpt_ioc_diag(uint32_t diag);
1181void mpt_req_state(mpt_req_state_t state);
1182void mpt_print_config_request(void *vmsg);
1183void mpt_print_request(void *vmsg);
1184void mpt_print_scsi_io_request(MSG_SCSI_IO_REQUEST *msg);
1185void mpt_dump_sgl(SGE_IO_UNION *se, int offset);
1186#endif /* _MPT_H_ */
1187