3 * Generic defines for LSI '909 FC adapters.
6 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD AND BSD-3-Clause
8 * Copyright (c) 2000, 2001 by Greg Ansley
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice immediately at the beginning of the file, without modification,
15 * this list of conditions, and the following disclaimer.
16 * 2. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * Copyright (c) 2002, 2006 by Matthew Jacob
33 * All rights reserved.
35 * Redistribution and use in source and binary forms, with or without
36 * modification, are permitted provided that the following conditions are
38 * 1. Redistributions of source code must retain the above copyright
39 * notice, this list of conditions and the following disclaimer.
40 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
41 * substantially similar to the "NO WARRANTY" disclaimer below
42 * ("Disclaimer") and any redistribution must be conditioned upon including
43 * a substantially similar Disclaimer requirement for further binary
45 * 3. Neither the names of the above listed copyright holders nor the names
46 * of any contributors may be used to endorse or promote products derived
47 * from this software without specific prior written permission.
49 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
50 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
53 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
54 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
55 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
56 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
57 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
58 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
59 * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 * Support from Chris Ellsworth in order to make SAS adapters work
62 * is gratefully acknowledged.
65 * Support from LSI-Logic has also gone a great deal toward making this a
66 * workable subsystem and is gratefully acknowledged.
69 * Copyright (c) 2004, Avid Technology, Inc. and its contributors.
70 * Copyright (c) 2004, 2005 Justin T. Gibbs
71 * Copyright (c) 2005, WHEEL Sp. z o.o.
72 * All rights reserved.
74 * Redistribution and use in source and binary forms, with or without
75 * modification, are permitted provided that the following conditions are
77 * 1. Redistributions of source code must retain the above copyright
78 * notice, this list of conditions and the following disclaimer.
79 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
80 * substantially similar to the "NO WARRANTY" disclaimer below
81 * ("Disclaimer") and any redistribution must be conditioned upon including
82 * a substantially similar Disclaimer requirement for further binary
84 * 3. Neither the names of the above listed copyright holders nor the names
85 * of any contributors may be used to endorse or promote products derived
86 * from this software without specific prior written permission.
88 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
89 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
90 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
91 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
92 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
93 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
94 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
95 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
96 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
97 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
98 * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
104 /********************************* OS Includes ********************************/
105 #include <sys/param.h>
106 #include <sys/systm.h>
108 #include <sys/condvar.h>
109 #include <sys/endian.h>
110 #include <sys/eventhandler.h>
111 #include <sys/kernel.h>
112 #include <sys/lock.h>
113 #include <sys/malloc.h>
114 #include <sys/module.h>
115 #include <sys/mutex.h>
116 #include <sys/proc.h>
117 #include <sys/queue.h>
118 #include <sys/rman.h>
119 #include <sys/types.h>
121 #include <machine/bus.h>
122 #include <machine/cpu.h>
123 #include <machine/resource.h>
125 #include <dev/pci/pcireg.h>
126 #include <dev/pci/pcivar.h>
130 /**************************** Register Definitions ****************************/
131 #include <dev/mpt/mpt_reg.h>
133 /******************************* MPI Definitions ******************************/
134 #include <dev/mpt/mpilib/mpi_type.h>
135 #include <dev/mpt/mpilib/mpi.h>
136 #include <dev/mpt/mpilib/mpi_cnfg.h>
137 #include <dev/mpt/mpilib/mpi_ioc.h>
138 #include <dev/mpt/mpilib/mpi_raid.h>
140 /* XXX For mpt_debug.c */
141 #include <dev/mpt/mpilib/mpi_init.h>
143 #define MPT_S64_2_SCALAR(y) ((((int64_t)y.High) << 32) | (y.Low))
144 #define MPT_U64_2_SCALAR(y) ((((uint64_t)y.High) << 32) | (y.Low))
146 /****************************** Misc Definitions ******************************/
147 /* #define MPT_TEST_MULTIPATH 1 */
149 #define MPT_FAIL (0x10000)
151 #define NUM_ELEMENTS(array) (sizeof(array) / sizeof(*array))
153 #define MPT_ROLE_NONE 0
154 #define MPT_ROLE_INITIATOR 1
155 #define MPT_ROLE_TARGET 2
156 #define MPT_ROLE_BOTH 3
157 #define MPT_ROLE_DEFAULT MPT_ROLE_INITIATOR
159 #define MPT_INI_ID_NONE -1
161 /**************************** Forward Declarations ****************************/
163 struct mpt_personality;
164 typedef struct req_entry request_t;
166 /************************* Personality Module Support *************************/
167 typedef int mpt_load_handler_t(struct mpt_personality *);
168 typedef int mpt_probe_handler_t(struct mpt_softc *);
169 typedef int mpt_attach_handler_t(struct mpt_softc *);
170 typedef int mpt_enable_handler_t(struct mpt_softc *);
171 typedef void mpt_ready_handler_t(struct mpt_softc *);
172 typedef int mpt_event_handler_t(struct mpt_softc *, request_t *,
173 MSG_EVENT_NOTIFY_REPLY *);
174 typedef void mpt_reset_handler_t(struct mpt_softc *, int /*type*/);
175 /* XXX Add return value and use for veto? */
176 typedef void mpt_shutdown_handler_t(struct mpt_softc *);
177 typedef void mpt_detach_handler_t(struct mpt_softc *);
178 typedef int mpt_unload_handler_t(struct mpt_personality *);
180 struct mpt_personality
183 uint32_t id; /* Assigned identifier. */
184 u_int use_count; /* Instances using personality*/
185 mpt_load_handler_t *load; /* configure personailty */
186 #define MPT_PERS_FIRST_HANDLER(pers) (&(pers)->load)
187 mpt_probe_handler_t *probe; /* configure personailty */
188 mpt_attach_handler_t *attach; /* initialize device instance */
189 mpt_enable_handler_t *enable; /* enable device */
190 mpt_ready_handler_t *ready; /* final open for business */
191 mpt_event_handler_t *event; /* Handle MPI event. */
192 mpt_reset_handler_t *reset; /* Re-init after reset. */
193 mpt_shutdown_handler_t *shutdown; /* Shutdown instance. */
194 mpt_detach_handler_t *detach; /* release device instance */
195 mpt_unload_handler_t *unload; /* Shutdown personality */
196 #define MPT_PERS_LAST_HANDLER(pers) (&(pers)->unload)
199 int mpt_modevent(module_t, int, void *);
201 /* Maximum supported number of personalities. */
202 #define MPT_MAX_PERSONALITIES (15)
204 #define MPT_PERSONALITY_DEPEND(name, dep, vmin, vpref, vmax) \
205 MODULE_DEPEND(name, dep, vmin, vpref, vmax)
207 #define DECLARE_MPT_PERSONALITY(name, order) \
208 static moduledata_t name##_mod = { \
209 #name, mpt_modevent, &name##_personality \
211 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, order); \
212 MODULE_VERSION(name, 1); \
213 MPT_PERSONALITY_DEPEND(name, mpt_core, 1, 1, 1)
215 /******************************* Bus DMA Support ******************************/
216 /* XXX Need to update bus_dmamap_sync to take a range argument. */
217 #define bus_dmamap_sync_range(dma_tag, dmamap, offset, len, op) \
218 bus_dmamap_sync(dma_tag, dmamap, op)
220 #define mpt_dma_tag_create(mpt, parent_tag, alignment, boundary, \
221 lowaddr, highaddr, filter, filterarg, \
222 maxsize, nsegments, maxsegsz, flags, \
224 bus_dma_tag_create(parent_tag, alignment, boundary, \
225 lowaddr, highaddr, filter, filterarg, \
226 maxsize, nsegments, maxsegsz, flags, \
227 busdma_lock_mutex, &(mpt)->mpt_lock, \
229 struct mpt_map_info {
230 struct mpt_softc *mpt;
235 void mpt_map_rquest(void *, bus_dma_segment_t *, int, int);
237 /********************************* Endianness *********************************/
238 #define MPT_2_HOST64(ptr, tag) ptr->tag = le64toh(ptr->tag)
239 #define MPT_2_HOST32(ptr, tag) ptr->tag = le32toh(ptr->tag)
240 #define MPT_2_HOST16(ptr, tag) ptr->tag = le16toh(ptr->tag)
242 #define HOST_2_MPT64(ptr, tag) ptr->tag = htole64(ptr->tag)
243 #define HOST_2_MPT32(ptr, tag) ptr->tag = htole32(ptr->tag)
244 #define HOST_2_MPT16(ptr, tag) ptr->tag = htole16(ptr->tag)
246 #if _BYTE_ORDER == _BIG_ENDIAN
247 void mpt2host_sge_simple_union(SGE_SIMPLE_UNION *);
248 void mpt2host_iocfacts_reply(MSG_IOC_FACTS_REPLY *);
249 void mpt2host_portfacts_reply(MSG_PORT_FACTS_REPLY *);
250 void mpt2host_config_page_ioc2(CONFIG_PAGE_IOC_2 *);
251 void mpt2host_config_page_ioc3(CONFIG_PAGE_IOC_3 *);
252 void mpt2host_config_page_scsi_port_0(CONFIG_PAGE_SCSI_PORT_0 *);
253 void mpt2host_config_page_scsi_port_1(CONFIG_PAGE_SCSI_PORT_1 *);
254 void host2mpt_config_page_scsi_port_1(CONFIG_PAGE_SCSI_PORT_1 *);
255 void mpt2host_config_page_scsi_port_2(CONFIG_PAGE_SCSI_PORT_2 *);
256 void mpt2host_config_page_scsi_device_0(CONFIG_PAGE_SCSI_DEVICE_0 *);
257 void mpt2host_config_page_scsi_device_1(CONFIG_PAGE_SCSI_DEVICE_1 *);
258 void host2mpt_config_page_scsi_device_1(CONFIG_PAGE_SCSI_DEVICE_1 *);
259 void mpt2host_config_page_fc_port_0(CONFIG_PAGE_FC_PORT_0 *);
260 void mpt2host_config_page_fc_port_1(CONFIG_PAGE_FC_PORT_1 *);
261 void host2mpt_config_page_fc_port_1(CONFIG_PAGE_FC_PORT_1 *);
262 void mpt2host_config_page_raid_vol_0(CONFIG_PAGE_RAID_VOL_0 *);
263 void mpt2host_config_page_raid_phys_disk_0(CONFIG_PAGE_RAID_PHYS_DISK_0 *);
264 void mpt2host_mpi_raid_vol_indicator(MPI_RAID_VOL_INDICATOR *);
266 #define mpt2host_sge_simple_union(x) do { ; } while (0)
267 #define mpt2host_iocfacts_reply(x) do { ; } while (0)
268 #define mpt2host_portfacts_reply(x) do { ; } while (0)
269 #define mpt2host_config_page_ioc2(x) do { ; } while (0)
270 #define mpt2host_config_page_ioc3(x) do { ; } while (0)
271 #define mpt2host_config_page_scsi_port_0(x) do { ; } while (0)
272 #define mpt2host_config_page_scsi_port_1(x) do { ; } while (0)
273 #define host2mpt_config_page_scsi_port_1(x) do { ; } while (0)
274 #define mpt2host_config_page_scsi_port_2(x) do { ; } while (0)
275 #define mpt2host_config_page_scsi_device_0(x) do { ; } while (0)
276 #define mpt2host_config_page_scsi_device_1(x) do { ; } while (0)
277 #define host2mpt_config_page_scsi_device_1(x) do { ; } while (0)
278 #define mpt2host_config_page_fc_port_0(x) do { ; } while (0)
279 #define mpt2host_config_page_fc_port_1(x) do { ; } while (0)
280 #define host2mpt_config_page_fc_port_1(x) do { ; } while (0)
281 #define mpt2host_config_page_raid_vol_0(x) do { ; } while (0)
282 #define mpt2host_config_page_raid_phys_disk_0(x) \
284 #define mpt2host_mpi_raid_vol_indicator(x) do { ; } while (0)
287 /**************************** MPI Transaction State ***************************/
289 REQ_STATE_NIL = 0x00,
290 REQ_STATE_FREE = 0x01,
291 REQ_STATE_ALLOCATED = 0x02,
292 REQ_STATE_QUEUED = 0x04,
293 REQ_STATE_DONE = 0x08,
294 REQ_STATE_TIMEDOUT = 0x10,
295 REQ_STATE_NEED_WAKEUP = 0x20,
296 REQ_STATE_LOCKED = 0x80, /* can't be freed */
297 REQ_STATE_MASK = 0xFF
301 TAILQ_ENTRY(req_entry) links; /* Pointer to next in list */
302 mpt_req_state_t state; /* Request State Information */
303 uint16_t index; /* Index of this entry */
304 uint16_t IOCStatus; /* Completion status */
305 uint16_t ResponseCode; /* TMF Response Code */
306 uint16_t serno; /* serial number */
307 union ccb *ccb; /* CAM request */
308 void *req_vbuf; /* Virtual Address of Entry */
309 void *sense_vbuf; /* Virtual Address of sense data */
310 bus_addr_t req_pbuf; /* Physical Address of Entry */
311 bus_addr_t sense_pbuf; /* Physical Address of sense data */
312 bus_dmamap_t dmap; /* DMA map for data buffers */
313 struct req_entry *chain; /* for SGE overallocations */
314 struct callout callout; /* Timeout for the request */
317 typedef struct mpt_config_params {
328 /**************************** MPI Target State Info ***************************/
330 uint32_t reply_desc; /* current reply descriptor */
331 uint32_t bytes_xfered; /* current relative offset */
332 int resid; /* current data residual */
333 union ccb *ccb; /* pointer to currently active ccb */
334 request_t *req; /* pointer to currently active assist request */
338 uint32_t tag_id; /* Our local tag. */
339 uint16_t itag; /* Initiator tag. */
345 TGT_STATE_SETTING_UP_FOR_DATA,
346 TGT_STATE_MOVING_DATA,
347 TGT_STATE_MOVING_DATA_AND_STATUS,
348 TGT_STATE_SENDING_STATUS
353 * When we get an incoming command it has its own tag which is called the
354 * IoIndex. This is the value we gave that particular command buffer when
355 * we originally assigned it. It's just a number, really. The FC card uses
356 * it as an RX_ID. We can use it to index into mpt->tgt_cmd_ptrs, which
357 * contains pointers the request_t structures related to that IoIndex.
359 * What *we* do is construct a tag out of the index for the target command
360 * which owns the incoming ATIO plus a rolling sequence number.
362 #define MPT_MAKE_TAGID(mpt, req, ioindex) \
363 ((ioindex << 18) | (((mpt->sequence++) & 0x3f) << 12) | (req->index & 0xfff))
366 #define MPT_TAG_2_REQ(a, b) mpt_tag_2_req(a, (uint32_t) b)
368 #define MPT_TAG_2_REQ(mpt, tag) mpt->tgt_cmd_ptrs[tag >> 18]
371 #define MPT_TGT_STATE(mpt, req) ((mpt_tgt_state_t *) \
372 (&((uint8_t *)req->req_vbuf)[MPT_RQSL(mpt) - sizeof (mpt_tgt_state_t)]))
374 STAILQ_HEAD(mpt_hdr_stailq, ccb_hdr);
375 #define MPT_MAX_LUNS 256
377 struct mpt_hdr_stailq atios;
378 struct mpt_hdr_stailq inots;
381 #define MPT_MAX_ELS 64
383 /**************************** Handler Registration ****************************/
385 * Global table of registered reply handlers. The
386 * handler is indicated by byte 3 of the request
387 * index submitted to the IOC. This allows the
388 * driver core to perform generic processing without
389 * any knowledge of per-personality behavior.
391 * MPT_NUM_REPLY_HANDLERS must be a power of 2
392 * to allow the easy generation of a mask.
394 * The handler offsets used by the core are hard coded
395 * allowing faster code generation when assigning a handler
396 * to a request. All "personalities" must use the
397 * the handler registration mechanism.
399 * The IOC handlers that are rarely executed are placed
400 * at the tail of the table to make it more likely that
401 * all commonly executed handlers fit in a single cache
404 #define MPT_NUM_REPLY_HANDLERS (32)
405 #define MPT_REPLY_HANDLER_EVENTS MPT_CBI_TO_HID(0)
406 #define MPT_REPLY_HANDLER_CONFIG MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-1)
407 #define MPT_REPLY_HANDLER_HANDSHAKE MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-2)
408 typedef int mpt_reply_handler_t(struct mpt_softc *mpt, request_t *request,
409 uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame);
411 mpt_reply_handler_t *reply_handler;
421 struct mpt_handler_record
423 LIST_ENTRY(mpt_handler_record) links;
424 mpt_handler_t handler;
427 LIST_HEAD(mpt_handler_list, mpt_handler_record);
430 * The handler_id is currently unused but would contain the
431 * handler ID used in the MsgContext field to allow direction
432 * of replies to the handler. Registrations that don't require
433 * a handler id can pass in NULL for the handler_id.
435 * Deregistrations for handlers without a handler id should
436 * pass in MPT_HANDLER_ID_NONE.
438 #define MPT_HANDLER_ID_NONE (0xFFFFFFFF)
439 int mpt_register_handler(struct mpt_softc *, mpt_handler_type,
440 mpt_handler_t, uint32_t *);
441 int mpt_deregister_handler(struct mpt_softc *, mpt_handler_type,
442 mpt_handler_t, uint32_t);
444 /******************* Per-Controller Instance Data Structures ******************/
445 TAILQ_HEAD(req_queue, req_entry);
447 /* Structure for saving proper values for modifyable PCI config registers */
450 uint16_t LatencyTimer_LineSize;
452 uint32_t Mem0_BAR[2];
453 uint32_t Mem1_BAR[2];
461 MPT_RVF_ACTIVE = 0x1,
462 MPT_RVF_ANNOUNCED = 0x2,
463 MPT_RVF_UP2DATE = 0x4,
464 MPT_RVF_REFERENCED = 0x8,
465 MPT_RVF_WCE_CHANGED = 0x10
466 } mpt_raid_volume_flags;
468 struct mpt_raid_volume {
469 CONFIG_PAGE_RAID_VOL_0 *config_page;
470 MPI_RAID_VOL_INDICATOR sync_progress;
471 mpt_raid_volume_flags flags;
472 u_int quiesced_disks;
477 MPT_RDF_ACTIVE = 0x01,
478 MPT_RDF_ANNOUNCED = 0x02,
479 MPT_RDF_UP2DATE = 0x04,
480 MPT_RDF_REFERENCED = 0x08,
481 MPT_RDF_QUIESCING = 0x10,
482 MPT_RDF_QUIESCED = 0x20
483 } mpt_raid_disk_flags;
485 struct mpt_raid_disk {
486 CONFIG_PAGE_RAID_PHYS_DISK_0 config_page;
487 struct mpt_raid_volume *volume;
489 u_int pass_thru_active;
490 mpt_raid_disk_flags flags;
493 struct mpt_evtf_record {
494 MSG_EVENT_NOTIFY_REPLY reply;
496 LIST_ENTRY(mpt_evtf_record) links;
499 LIST_HEAD(mpt_evtf_list, mpt_evtf_record);
501 struct mptsas_devinfo {
503 uint16_t parent_dev_handle;
504 uint16_t enclosure_handle;
507 uint8_t physical_port;
510 uint64_t sas_address;
511 uint32_t device_info;
514 struct mptsas_phyinfo {
518 uint8_t negotiated_link_rate;
519 uint8_t hw_link_rate;
520 uint8_t programmed_link_rate;
521 uint8_t sas_port_add_phy;
522 struct mptsas_devinfo identify;
523 struct mptsas_devinfo attached;
526 struct mptsas_portinfo {
528 struct mptsas_phyinfo *phy_info;
535 uint32_t mpt_pers_mask;
558 u_int role; /* role: none, ini, target, both */
561 #ifdef MPT_TEST_MULTIPATH
568 MSG_IOC_FACTS_REPLY ioc_facts;
573 MSG_PORT_FACTS_REPLY * port_facts;
574 #define mpt_max_tgtcmds port_facts[0].MaxPostedCmdBuffers
577 * Device Configuration Information
581 CONFIG_PAGE_SCSI_PORT_0 _port_page0;
582 CONFIG_PAGE_SCSI_PORT_1 _port_page1;
583 CONFIG_PAGE_SCSI_PORT_2 _port_page2;
584 CONFIG_PAGE_SCSI_DEVICE_0 _dev_page0[16];
585 CONFIG_PAGE_SCSI_DEVICE_1 _dev_page1[16];
587 uint16_t _tag_enable;
588 uint16_t _disc_enable;
590 #define mpt_port_page0 cfg.spi._port_page0
591 #define mpt_port_page1 cfg.spi._port_page1
592 #define mpt_port_page2 cfg.spi._port_page2
593 #define mpt_dev_page0 cfg.spi._dev_page0
594 #define mpt_dev_page1 cfg.spi._dev_page1
595 #define mpt_ini_id cfg.spi._ini_id
596 #define mpt_tag_enable cfg.spi._tag_enable
597 #define mpt_disc_enable cfg.spi._disc_enable
599 CONFIG_PAGE_FC_PORT_0 _port_page0;
600 uint32_t _port_speed;
601 #define mpt_fcport_page0 cfg.fc._port_page0
602 #define mpt_fcport_speed cfg.fc._port_speed
606 * Device config information stored up for sysctl to access
610 unsigned int initiator_id;
619 /* Controller Info for RAID information */
620 CONFIG_PAGE_IOC_2 * ioc_page2;
621 CONFIG_PAGE_IOC_3 * ioc_page3;
624 struct mpt_raid_volume* raid_volumes;
625 struct mpt_raid_disk* raid_disks;
626 u_int raid_max_volumes;
627 u_int raid_max_disks;
628 u_int raid_page0_len;
631 u_int raid_resync_rate;
632 u_int raid_mwce_setting;
633 u_int raid_queue_depth;
634 u_int raid_nonopt_volumes;
635 struct proc *raid_thread;
636 struct callout raid_timer;
641 struct resource * pci_irq; /* Interrupt map for chip */
642 void * ih; /* Interrupt handle */
644 struct mpt_pci_cfg pci_cfg; /* saved PCI conf registers */
650 struct resource * pci_reg; /* Register map for chip */
651 bus_space_tag_t pci_st; /* Bus tag for registers */
652 bus_space_handle_t pci_sh; /* Bus handle for registers */
653 /* PIO versions of above. */
654 struct resource * pci_pio_reg;
655 bus_space_tag_t pci_pio_st;
656 bus_space_handle_t pci_pio_sh;
658 bus_dma_tag_t parent_dmat; /* DMA tag for parent PCI bus */
659 bus_dma_tag_t reply_dmat; /* DMA tag for reply memory */
660 bus_dmamap_t reply_dmap; /* DMA map for reply memory */
661 uint8_t *reply; /* KVA of reply memory */
662 bus_addr_t reply_phys; /* BusAddr of reply memory */
664 bus_dma_tag_t buffer_dmat; /* DMA tag for buffers */
665 bus_dma_tag_t request_dmat; /* DMA tag for request memory */
666 bus_dmamap_t request_dmap; /* DMA map for request memory */
667 uint8_t *request; /* KVA of Request memory */
668 bus_addr_t request_phys; /* BusAddr of request memory */
670 uint32_t max_seg_cnt; /* calculated after IOC facts */
671 uint32_t max_cam_seg_cnt;/* calculated from maxphys */
674 * Hardware management
679 * CAM && Software Management
681 request_t *request_pool;
682 struct req_queue request_free_list;
683 struct req_queue request_pending_list;
684 struct req_queue request_timeout_list;
687 struct cam_path *path;
689 struct cam_sim *phydisk_sim;
690 struct cam_path *phydisk_path;
692 struct proc *recovery_thread;
696 * Deferred frame acks due to resource shortage.
698 struct mpt_evtf_list ack_frames;
701 * Target Mode Support
703 uint32_t scsi_tgt_handler_id;
704 request_t ** tgt_cmd_ptrs;
705 request_t ** els_cmd_ptrs; /* FC only */
708 * *snork*- this is chosen to be here *just in case* somebody
709 * forgets to point to it exactly and we index off of trt with
712 tgt_resource_t trt_wildcard; /* wildcard luns */
713 tgt_resource_t trt[MPT_MAX_LUNS];
714 uint16_t tgt_cmds_allocated;
715 uint16_t els_cmds_allocated; /* FC only */
717 uint16_t timeouts; /* timeout count */
718 uint16_t success; /* successes afer timeout */
719 uint16_t sequence; /* Sequence Number */
723 /* Paired port in some dual adapters configurations */
724 struct mpt_softc * mpt2;
727 /* FW Image management */
728 uint32_t fw_image_size;
730 bus_dma_tag_t fw_dmat; /* DMA tag for firmware image */
731 bus_dmamap_t fw_dmap; /* DMA map for firmware image */
732 bus_addr_t fw_phys; /* BusAddr of firmware image */
735 struct mptsas_portinfo *sas_portinfo;
737 /* Shutdown Event Handler. */
740 /* Userland management interface. */
743 TAILQ_ENTRY(mpt_softc) links;
746 static __inline void mpt_assign_serno(struct mpt_softc *, request_t *);
749 mpt_assign_serno(struct mpt_softc *mpt, request_t *req)
751 if ((req->serno = mpt->sequence++) == 0) {
752 req->serno = mpt->sequence++;
756 /***************************** Locking Primitives *****************************/
757 #define MPT_IFLAGS INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
758 #define MPT_LOCK_SETUP(mpt) \
759 mtx_init(&mpt->mpt_lock, "mpt", NULL, MTX_DEF); \
760 mpt->mpt_locksetup = 1
761 #define MPT_LOCK_DESTROY(mpt) \
762 if (mpt->mpt_locksetup) { \
763 mtx_destroy(&mpt->mpt_lock); \
764 mpt->mpt_locksetup = 0; \
767 #define MPT_LOCK(mpt) mtx_lock(&(mpt)->mpt_lock)
768 #define MPT_UNLOCK(mpt) mtx_unlock(&(mpt)->mpt_lock)
769 #define MPT_OWNED(mpt) mtx_owned(&(mpt)->mpt_lock)
770 #define MPT_LOCK_ASSERT(mpt) mtx_assert(&(mpt)->mpt_lock, MA_OWNED)
771 #define mpt_sleep(mpt, ident, priority, wmesg, sbt) \
772 msleep_sbt(ident, &(mpt)->mpt_lock, priority, wmesg, sbt, 0, 0)
773 #define mpt_req_timeout(req, sbt, func, arg) \
774 callout_reset_sbt(&(req)->callout, (sbt), 0, (func), (arg), 0)
775 #define mpt_req_untimeout(req, func, arg) \
776 callout_stop(&(req)->callout)
777 #define mpt_callout_init(mpt, c) \
778 callout_init_mtx(c, &(mpt)->mpt_lock, 0)
779 #define mpt_callout_drain(mpt, c) \
782 /******************************* Register Access ******************************/
783 static __inline void mpt_write(struct mpt_softc *, size_t, uint32_t);
784 static __inline void mpt_write_stream(struct mpt_softc *, size_t, uint32_t);
785 static __inline uint32_t mpt_read(struct mpt_softc *, int);
786 static __inline void mpt_pio_write(struct mpt_softc *, size_t, uint32_t);
787 static __inline uint32_t mpt_pio_read(struct mpt_softc *, int);
790 mpt_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
792 bus_space_write_4(mpt->pci_st, mpt->pci_sh, offset, val);
796 mpt_write_stream(struct mpt_softc *mpt, size_t offset, uint32_t val)
798 bus_space_write_stream_4(mpt->pci_st, mpt->pci_sh, offset, val);
801 static __inline uint32_t
802 mpt_read(struct mpt_softc *mpt, int offset)
804 return (bus_space_read_4(mpt->pci_st, mpt->pci_sh, offset));
808 * Some operations (e.g. diagnostic register writes while the ARM proccessor
809 * is disabled), must be performed using "PCI pio" operations. On non-PCI
810 * buses, these operations likely map to normal register accesses.
813 mpt_pio_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
815 KASSERT(mpt->pci_pio_reg != NULL, ("no PIO resource"));
816 bus_space_write_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset, val);
819 static __inline uint32_t
820 mpt_pio_read(struct mpt_softc *mpt, int offset)
822 KASSERT(mpt->pci_pio_reg != NULL, ("no PIO resource"));
823 return (bus_space_read_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset));
826 /*********************** Reply Frame/Request Management ***********************/
827 /* Max MPT Reply we are willing to accept (must be power of 2) */
828 #define MPT_REPLY_SIZE 256
831 * Must be less than 16384 in order for target mode to work
833 #define MPT_MAX_REQUESTS(mpt) 512
834 #define MPT_REQUEST_AREA 512
835 #define MPT_SENSE_SIZE 32 /* included in MPT_REQUEST_AREA */
836 #define MPT_REQ_MEM_SIZE(mpt) (MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
838 #define MPT_CONTEXT_CB_SHIFT (16)
839 #define MPT_CBI(handle) (handle >> MPT_CONTEXT_CB_SHIFT)
840 #define MPT_CBI_TO_HID(cbi) ((cbi) << MPT_CONTEXT_CB_SHIFT)
841 #define MPT_CONTEXT_TO_CBI(x) \
842 (((x) >> MPT_CONTEXT_CB_SHIFT) & (MPT_NUM_REPLY_HANDLERS - 1))
843 #define MPT_CONTEXT_REQI_MASK 0xFFFF
844 #define MPT_CONTEXT_TO_REQI(x) ((x) & MPT_CONTEXT_REQI_MASK)
847 * Convert a 32bit physical address returned from IOC to an
848 * offset into our reply frame memory or the kvm address needed
849 * to access the data. The returned address is only the low
850 * 32 bits, so mask our base physical address accordingly.
852 #define MPT_REPLY_BADDR(x) \
854 #define MPT_REPLY_OTOV(m, i) \
855 ((void *)(&m->reply[i]))
857 #define MPT_DUMP_REPLY_FRAME(mpt, reply_frame) \
859 if (mpt->verbose > MPT_PRT_DEBUG) \
860 mpt_dump_reply_frame(mpt, reply_frame); \
863 static __inline uint32_t mpt_pop_reply_queue(struct mpt_softc *mpt);
864 static __inline void mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr);
867 * Give the reply buffer back to the IOC after we have
868 * finished processing it.
871 mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr)
873 mpt_write(mpt, MPT_OFFSET_REPLY_Q, ptr);
876 /* Get a reply from the IOC */
877 static __inline uint32_t
878 mpt_pop_reply_queue(struct mpt_softc *mpt)
880 return mpt_read(mpt, MPT_OFFSET_REPLY_Q);
884 mpt_complete_request_chain(struct mpt_softc *, struct req_queue *, u_int);
886 /************************** Scatter Gather Management **************************/
887 /* MPT_RQSL- size of request frame, in bytes */
888 #define MPT_RQSL(mpt) (mpt->ioc_facts.RequestFrameSize << 2)
890 /* MPT_NSGL- how many SG entries can fit in a request frame size */
891 #define MPT_NSGL(mpt) (MPT_RQSL(mpt) / sizeof (SGE_IO_UNION))
893 /* MPT_NRFM- how many request frames can fit in each request alloc we make */
894 #define MPT_NRFM(mpt) (MPT_REQUEST_AREA / MPT_RQSL(mpt))
897 * MPT_NSGL_FIRST- # of SG elements that can fit after
898 * an I/O request but still within the request frame.
899 * Do this safely based upon SGE_IO_UNION.
901 * Note that the first element is *within* the SCSI request.
903 #define MPT_NSGL_FIRST(mpt) \
904 ((MPT_RQSL(mpt) - sizeof (MSG_SCSI_IO_REQUEST) + sizeof (SGE_IO_UNION)) / \
905 sizeof (SGE_IO_UNION))
907 /***************************** IOC Initialization *****************************/
908 int mpt_reset(struct mpt_softc *, int /*reinit*/);
910 /****************************** Debugging ************************************/
911 void mpt_dump_data(struct mpt_softc *, const char *, void *, int);
912 void mpt_dump_request(struct mpt_softc *, request_t *);
929 #define mpt_lprt(mpt, level, ...) \
931 if ((level) <= (mpt)->verbose) \
932 mpt_prt(mpt, __VA_ARGS__); \
936 #define mpt_lprtc(mpt, level, ...) \
938 if ((level) <= (mpt)->verbose) \
939 mpt_prtc(mpt, __VA_ARGS__); \
943 void mpt_prt(struct mpt_softc *, const char *, ...)
945 void mpt_prtc(struct mpt_softc *, const char *, ...)
948 /**************************** Target Mode Related ***************************/
950 static __inline request_t * mpt_tag_2_req(struct mpt_softc *, uint32_t);
951 static __inline request_t *
952 mpt_tag_2_req(struct mpt_softc *mpt, uint32_t tag)
954 uint16_t rtg = (tag >> 18);
955 KASSERT(rtg < mpt->tgt_cmds_allocated, ("bad tag %d", tag));
956 KASSERT(mpt->tgt_cmd_ptrs, ("no cmd backpointer array"));
957 KASSERT(mpt->tgt_cmd_ptrs[rtg], ("no cmd backpointer"));
958 return (mpt->tgt_cmd_ptrs[rtg]);
963 mpt_req_on_free_list(struct mpt_softc *, request_t *);
965 mpt_req_on_pending_list(struct mpt_softc *, request_t *);
968 * Is request on freelist?
971 mpt_req_on_free_list(struct mpt_softc *mpt, request_t *req)
975 TAILQ_FOREACH(lrq, &mpt->request_free_list, links) {
984 * Is request on pending list?
987 mpt_req_on_pending_list(struct mpt_softc *mpt, request_t *req)
991 TAILQ_FOREACH(lrq, &mpt->request_pending_list, links) {
1000 static __inline void
1001 mpt_req_spcl(struct mpt_softc *, request_t *, const char *, int);
1002 static __inline void
1003 mpt_req_not_spcl(struct mpt_softc *, request_t *, const char *, int);
1006 * Make sure that req *is* part of one of the special lists
1008 static __inline void
1009 mpt_req_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1012 for (i = 0; i < mpt->els_cmds_allocated; i++) {
1013 if (req == mpt->els_cmd_ptrs[i]) {
1017 for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1018 if (req == mpt->tgt_cmd_ptrs[i]) {
1022 panic("%s(%d): req %p:%u function %x not in els or tgt ptrs",
1023 s, line, req, req->serno,
1024 ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function);
1028 * Make sure that req is *not* part of one of the special lists.
1030 static __inline void
1031 mpt_req_not_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1034 for (i = 0; i < mpt->els_cmds_allocated; i++) {
1035 KASSERT(req != mpt->els_cmd_ptrs[i],
1036 ("%s(%d): req %p:%u func %x in els ptrs at ioindex %d",
1037 s, line, req, req->serno,
1038 ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1040 for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1041 KASSERT(req != mpt->tgt_cmd_ptrs[i],
1042 ("%s(%d): req %p:%u func %x in tgt ptrs at ioindex %d",
1043 s, line, req, req->serno,
1044 ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1050 * Task Management Types, purely for internal consumption
1053 MPT_QUERY_TASK_SET=1234,
1056 MPT_QUERY_ASYNC_EVENT,
1057 MPT_LOGICAL_UNIT_RESET,
1060 MPT_NIL_TMT_VALUE=5678
1063 /**************************** Unclassified Routines ***************************/
1064 void mpt_send_cmd(struct mpt_softc *mpt, request_t *req);
1065 int mpt_recv_handshake_reply(struct mpt_softc *mpt,
1066 size_t reply_len, void *reply);
1067 int mpt_wait_req(struct mpt_softc *mpt, request_t *req,
1068 mpt_req_state_t state, mpt_req_state_t mask,
1069 int sleep_ok, int time_ms);
1070 void mpt_enable_ints(struct mpt_softc *mpt);
1071 void mpt_disable_ints(struct mpt_softc *mpt);
1072 int mpt_attach(struct mpt_softc *mpt);
1073 int mpt_shutdown(struct mpt_softc *mpt);
1074 int mpt_detach(struct mpt_softc *mpt);
1075 int mpt_send_handshake_cmd(struct mpt_softc *mpt,
1076 size_t len, void *cmd);
1077 request_t * mpt_get_request(struct mpt_softc *mpt, int sleep_ok);
1078 void mpt_free_request(struct mpt_softc *mpt, request_t *req);
1079 void mpt_intr(void *arg);
1080 void mpt_check_doorbell(struct mpt_softc *mpt);
1081 void mpt_dump_reply_frame(struct mpt_softc *mpt,
1082 MSG_DEFAULT_REPLY *reply_frame);
1084 int mpt_issue_cfg_req(struct mpt_softc */*mpt*/, request_t */*req*/,
1086 bus_addr_t /*addr*/, bus_size_t/*len*/,
1087 int /*sleep_ok*/, int /*timeout_ms*/);
1088 int mpt_read_extcfg_header(struct mpt_softc *mpt, int PageVersion,
1089 int PageNumber, uint32_t PageAddress,
1091 CONFIG_EXTENDED_PAGE_HEADER *rslt,
1092 int sleep_ok, int timeout_ms);
1093 int mpt_read_extcfg_page(struct mpt_softc *mpt, int Action,
1094 uint32_t PageAddress,
1095 CONFIG_EXTENDED_PAGE_HEADER *hdr,
1096 void *buf, size_t len, int sleep_ok,
1098 int mpt_read_cfg_header(struct mpt_softc *, int /*PageType*/,
1100 uint32_t /*PageAddress*/,
1101 CONFIG_PAGE_HEADER *,
1102 int /*sleep_ok*/, int /*timeout_ms*/);
1103 int mpt_read_cfg_page(struct mpt_softc *t, int /*Action*/,
1104 uint32_t /*PageAddress*/,
1105 CONFIG_PAGE_HEADER *, size_t /*len*/,
1106 int /*sleep_ok*/, int /*timeout_ms*/);
1107 int mpt_write_cfg_page(struct mpt_softc *, int /*Action*/,
1108 uint32_t /*PageAddress*/,
1109 CONFIG_PAGE_HEADER *, size_t /*len*/,
1110 int /*sleep_ok*/, int /*timeout_ms*/);
1112 mpt_read_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1113 CONFIG_PAGE_HEADER *hdr, size_t len,
1114 int sleep_ok, int timeout_ms)
1116 return (mpt_read_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_READ_CURRENT,
1117 PageAddress, hdr, len, sleep_ok, timeout_ms));
1121 mpt_write_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1122 CONFIG_PAGE_HEADER *hdr, size_t len, int sleep_ok,
1125 return (mpt_write_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_WRITE_CURRENT,
1126 PageAddress, hdr, len, sleep_ok,
1130 /* mpt_debug.c functions */
1131 void mpt_print_reply(void *vmsg);
1132 void mpt_print_db(uint32_t mb);
1133 void mpt_print_config_reply(void *vmsg);
1134 char *mpt_ioc_diag(uint32_t diag);
1135 void mpt_req_state(mpt_req_state_t state);
1136 void mpt_print_config_request(void *vmsg);
1137 void mpt_print_request(void *vmsg);
1138 void mpt_dump_sgl(SGE_IO_UNION *se, int offset);
1140 #endif /* _MPT_H_ */