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