1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2009 Yahoo! Inc.
5 * Copyright (c) 2011-2015 LSI Corp.
6 * Copyright (c) 2013-2015 Avago Technologies
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
31 *
32 * $FreeBSD$
33 */
34
35 #ifndef _MPSVAR_H
36 #define _MPSVAR_H
37
38 #define MPS_DRIVER_VERSION "21.02.00.00-fbsd"
39
40 #define MPS_DB_MAX_WAIT 2500
41
42 #define MPS_REQ_FRAMES 2048
43 #define MPS_PRI_REQ_FRAMES 128
44 #define MPS_EVT_REPLY_FRAMES 32
45 #define MPS_REPLY_FRAMES MPS_REQ_FRAMES
46 #define MPS_CHAIN_FRAMES 16384
47 #define MPS_MAXIO_PAGES (-1)
48 #define MPS_SENSE_LEN SSD_FULL_SIZE
49 #define MPS_MSI_MAX 1
50 #define MPS_MSIX_MAX 16
51 #define MPS_SGE64_SIZE 12
52 #define MPS_SGE32_SIZE 8
53 #define MPS_SGC_SIZE 8
54
55 #define CAN_SLEEP 1
56 #define NO_SLEEP 0
57
58 #define MPS_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */
59 #define MPS_ATA_ID_TIMEOUT 5 /* 5 second timeout for SATA ID cmd */
60 #define MPS_MISSING_CHECK_DELAY 10 /* 10 seconds between missing check */
61
62 #define MPS_SCSI_RI_INVALID_FRAME (0x00000002)
63
64 #define DEFAULT_SPINUP_WAIT 3 /* seconds to wait for spinup */
65
66 #include <sys/endian.h>
67
68 /*
69 * host mapping related macro definitions
70 */
71 #define MPS_MAPTABLE_BAD_IDX 0xFFFFFFFF
72 #define MPS_DPM_BAD_IDX 0xFFFF
73 #define MPS_ENCTABLE_BAD_IDX 0xFF
74 #define MPS_MAX_MISSING_COUNT 0x0F
75 #define MPS_DEV_RESERVED 0x20000000
76 #define MPS_MAP_IN_USE 0x10000000
77 #define MPS_MAP_BAD_ID 0xFFFFFFFF
78
79 /*
80 * WarpDrive controller
81 */
82 #define MPS_CHIP_WD_DEVICE_ID 0x007E
83 #define MPS_WD_LSI_OEM 0x80
84 #define MPS_WD_HIDE_EXPOSE_MASK 0x03
85 #define MPS_WD_HIDE_ALWAYS 0x00
86 #define MPS_WD_EXPOSE_ALWAYS 0x01
87 #define MPS_WD_HIDE_IF_VOLUME 0x02
88 #define MPS_WD_RETRY 0x01
89 #define MPS_MAN_PAGE10_SIZE 0x5C /* Hardcode for now */
90 #define MPS_MAX_DISKS_IN_VOL 10
91
92 /*
93 * WarpDrive Event Logging
94 */
95 #define MPI2_WD_LOG_ENTRY 0x8002
96 #define MPI2_WD_SSD_THROTTLING 0x0041
97 #define MPI2_WD_DRIVE_LIFE_WARN 0x0043
98 #define MPI2_WD_DRIVE_LIFE_DEAD 0x0044
99 #define MPI2_WD_RAIL_MON_FAIL 0x004D
100
101 typedef uint8_t u8;
102 typedef uint16_t u16;
103 typedef uint32_t u32;
104 typedef uint64_t u64;
105
106 /**
107 * struct dev_mapping_table - device mapping information
108 * @physical_id: SAS address for drives or WWID for RAID volumes
109 * @device_info: bitfield provides detailed info about the device
110 * @phy_bits: bitfields indicating controller phys
111 * @dpm_entry_num: index of this device in device persistent map table
112 * @dev_handle: device handle for the device pointed by this entry
113 * @id: target id
114 * @missing_count: number of times the device not detected by driver
115 * @hide_flag: Hide this physical disk/not (foreign configuration)
116 * @init_complete: Whether the start of the day checks completed or not
117 */
118 struct dev_mapping_table {
119 u64 physical_id;
120 u32 device_info;
121 u32 phy_bits;
122 u16 dpm_entry_num;
123 u16 dev_handle;
124 u16 reserved1;
125 u16 id;
126 u8 missing_count;
127 u8 init_complete;
128 u8 TLR_bits;
129 u8 reserved2;
130 };
131
132 /**
133 * struct enc_mapping_table - mapping information about an enclosure
134 * @enclosure_id: Logical ID of this enclosure
135 * @start_index: index to the entry in dev_mapping_table
136 * @phy_bits: bitfields indicating controller phys
137 * @dpm_entry_num: index of this enclosure in device persistent map table
138 * @enc_handle: device handle for the enclosure pointed by this entry
139 * @num_slots: number of slots in the enclosure
140 * @start_slot: Starting slot id
141 * @missing_count: number of times the device not detected by driver
142 * @removal_flag: used to mark the device for removal
143 * @skip_search: used as a flag to include/exclude enclosure for search
144 * @init_complete: Whether the start of the day checks completed or not
145 */
146 struct enc_mapping_table {
147 u64 enclosure_id;
148 u32 start_index;
149 u32 phy_bits;
150 u16 dpm_entry_num;
151 u16 enc_handle;
152 u16 num_slots;
153 u16 start_slot;
154 u8 missing_count;
155 u8 removal_flag;
156 u8 skip_search;
157 u8 init_complete;
158 };
159
160 /**
161 * struct map_removal_table - entries to be removed from mapping table
162 * @dpm_entry_num: index of this device in device persistent map table
163 * @dev_handle: device handle for the device pointed by this entry
164 */
165 struct map_removal_table{
166 u16 dpm_entry_num;
167 u16 dev_handle;
168 };
169
170 typedef struct mps_fw_diagnostic_buffer {
171 size_t size;
172 uint8_t extended_type;
173 uint8_t buffer_type;
174 uint8_t force_release;
175 uint32_t product_specific[23];
176 uint8_t immediate;
177 uint8_t enabled;
178 uint8_t valid_data;
179 uint8_t owned_by_firmware;
180 uint32_t unique_id;
181 } mps_fw_diagnostic_buffer_t;
182
183 struct mps_softc;
184 struct mps_command;
185 struct mpssas_softc;
186 union ccb;
187 struct mpssas_target;
188 struct mps_column_map;
189
190 MALLOC_DECLARE(M_MPT2);
191
192 typedef void mps_evt_callback_t(struct mps_softc *, uintptr_t,
193 MPI2_EVENT_NOTIFICATION_REPLY *reply);
194 typedef void mps_command_callback_t(struct mps_softc *, struct mps_command *cm);
195
196 struct mps_chain {
197 TAILQ_ENTRY(mps_chain) chain_link;
198 MPI2_SGE_IO_UNION *chain;
199 uint32_t chain_busaddr;
200 };
201
202 /*
203 * This needs to be at least 2 to support SMP passthrough.
204 */
205 #define MPS_IOVEC_COUNT 2
206
207 struct mps_command {
208 TAILQ_ENTRY(mps_command) cm_link;
209 TAILQ_ENTRY(mps_command) cm_recovery;
210 struct mps_softc *cm_sc;
211 union ccb *cm_ccb;
212 void *cm_data;
213 u_int cm_length;
214 u_int cm_out_len;
215 struct uio cm_uio;
216 struct iovec cm_iovec[MPS_IOVEC_COUNT];
217 u_int cm_max_segs;
218 u_int cm_sglsize;
219 MPI2_SGE_IO_UNION *cm_sge;
220 uint8_t *cm_req;
221 uint8_t *cm_reply;
222 uint32_t cm_reply_data;
223 mps_command_callback_t *cm_complete;
224 void *cm_complete_data;
225 struct mpssas_target *cm_targ;
226 MPI2_REQUEST_DESCRIPTOR_UNION cm_desc;
227 u_int cm_lun;
228 u_int cm_flags;
229 #define MPS_CM_FLAGS_POLLED (1 << 0)
230 #define MPS_CM_FLAGS_COMPLETE (1 << 1)
231 #define MPS_CM_FLAGS_SGE_SIMPLE (1 << 2)
232 #define MPS_CM_FLAGS_DATAOUT (1 << 3)
233 #define MPS_CM_FLAGS_DATAIN (1 << 4)
234 #define MPS_CM_FLAGS_WAKEUP (1 << 5)
235 #define MPS_CM_FLAGS_DD_IO (1 << 6)
236 #define MPS_CM_FLAGS_USE_UIO (1 << 7)
237 #define MPS_CM_FLAGS_SMP_PASS (1 << 8)
238 #define MPS_CM_FLAGS_CHAIN_FAILED (1 << 9)
239 #define MPS_CM_FLAGS_ERROR_MASK MPS_CM_FLAGS_CHAIN_FAILED
240 #define MPS_CM_FLAGS_USE_CCB (1 << 10)
241 #define MPS_CM_FLAGS_SATA_ID_TIMEOUT (1 << 11)
242 #define MPS_CM_FLAGS_ON_RECOVERY (1 << 12)
243 #define MPS_CM_FLAGS_TIMEDOUT (1 << 13)
244 u_int cm_state;
245 #define MPS_CM_STATE_FREE 0
246 #define MPS_CM_STATE_BUSY 1
247 #define MPS_CM_STATE_INQUEUE 2
248 bus_dmamap_t cm_dmamap;
249 struct scsi_sense_data *cm_sense;
250 TAILQ_HEAD(, mps_chain) cm_chain_list;
251 uint32_t cm_req_busaddr;
252 uint32_t cm_sense_busaddr;
253 struct callout cm_callout;
254 mps_command_callback_t *cm_timeout_handler;
255 };
256
257 struct mps_column_map {
258 uint16_t dev_handle;
259 uint8_t phys_disk_num;
260 };
261
262 struct mps_event_handle {
263 TAILQ_ENTRY(mps_event_handle) eh_list;
264 mps_evt_callback_t *callback;
265 void *data;
266 u32 mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
267 };
268
269 struct mps_busdma_context {
270 int completed;
271 int abandoned;
272 int error;
273 bus_addr_t *addr;
274 struct mps_softc *softc;
275 bus_dmamap_t buffer_dmamap;
276 bus_dma_tag_t buffer_dmat;
277 };
278
279 struct mps_queue {
280 struct mps_softc *sc;
281 int qnum;
282 MPI2_REPLY_DESCRIPTORS_UNION *post_queue;
283 int replypostindex;
284 #ifdef notyet
285 ck_ring_buffer_t *ringmem;
286 ck_ring_buffer_t *chainmem;
287 ck_ring_t req_ring;
288 ck_ring_t chain_ring;
289 #endif
290 bus_dma_tag_t buffer_dmat;
291 int io_cmds_highwater;
292 int chain_free_lowwater;
293 int chain_alloc_fail;
294 struct resource *irq;
295 void *intrhand;
296 int irq_rid;
297 };
298
299 struct mps_softc {
300 device_t mps_dev;
301 struct cdev *mps_cdev;
302 u_int mps_flags;
303 #define MPS_FLAGS_INTX (1 << 0)
304 #define MPS_FLAGS_MSI (1 << 1)
305 #define MPS_FLAGS_BUSY (1 << 2)
306 #define MPS_FLAGS_SHUTDOWN (1 << 3)
307 #define MPS_FLAGS_DIAGRESET (1 << 4)
308 #define MPS_FLAGS_ATTACH_DONE (1 << 5)
309 #define MPS_FLAGS_WD_AVAILABLE (1 << 6)
310 #define MPS_FLAGS_REALLOCATED (1 << 7)
311 u_int mps_debug;
312 u_int msi_msgs;
313 u_int reqframesz;
314 u_int replyframesz;
315 int tm_cmds_active;
316 int io_cmds_active;
317 int io_cmds_highwater;
318 int chain_free;
319 int max_chains;
320 int max_io_pages;
321 u_int maxio;
322 int chain_free_lowwater;
323 u_int enable_ssu;
324 int spinup_wait_time;
325 int use_phynum;
326 uint64_t chain_alloc_fail;
327 struct sysctl_ctx_list sysctl_ctx;
328 struct sysctl_oid *sysctl_tree;
329 char fw_version[16];
330 struct mps_command *commands;
331 struct mps_chain *chains;
332 struct callout periodic;
333 struct callout device_check_callout;
334 struct mps_queue *queues;
335
336 struct mpssas_softc *sassc;
337 TAILQ_HEAD(, mps_command) req_list;
338 TAILQ_HEAD(, mps_command) high_priority_req_list;
339 TAILQ_HEAD(, mps_chain) chain_list;
340 TAILQ_HEAD(, mps_command) tm_list;
341 int replypostindex;
342 int replyfreeindex;
343
344 struct resource *mps_regs_resource;
345 bus_space_handle_t mps_bhandle;
346 bus_space_tag_t mps_btag;
347 int mps_regs_rid;
348
349 bus_dma_tag_t mps_parent_dmat;
350 bus_dma_tag_t buffer_dmat;
351
352 MPI2_IOC_FACTS_REPLY *facts;
353 int num_reqs;
354 int num_prireqs;
355 int num_replies;
356 int num_chains;
357 int fqdepth; /* Free queue */
358 int pqdepth; /* Post queue */
359
360 u32 event_mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
361 TAILQ_HEAD(, mps_event_handle) event_list;
362 struct mps_event_handle *mps_log_eh;
363
364 struct mtx mps_mtx;
365 struct intr_config_hook mps_ich;
366
367 uint8_t *req_frames;
368 bus_addr_t req_busaddr;
369 bus_dma_tag_t req_dmat;
370 bus_dmamap_t req_map;
371
372 uint8_t *reply_frames;
373 bus_addr_t reply_busaddr;
374 bus_dma_tag_t reply_dmat;
375 bus_dmamap_t reply_map;
376
377 struct scsi_sense_data *sense_frames;
378 bus_addr_t sense_busaddr;
379 bus_dma_tag_t sense_dmat;
380 bus_dmamap_t sense_map;
381
382 uint8_t *chain_frames;
383 bus_dma_tag_t chain_dmat;
384 bus_dmamap_t chain_map;
385
386 MPI2_REPLY_DESCRIPTORS_UNION *post_queue;
387 bus_addr_t post_busaddr;
388 uint32_t *free_queue;
389 bus_addr_t free_busaddr;
390 bus_dma_tag_t queues_dmat;
391 bus_dmamap_t queues_map;
392
393 uint8_t *fw_diag_buffer;
394 bus_addr_t fw_diag_busaddr;
395 bus_dma_tag_t fw_diag_dmat;
396 bus_dmamap_t fw_diag_map;
397
398 uint8_t ir_firmware;
399
400 /* static config pages */
401 Mpi2IOCPage8_t ioc_pg8;
402
403 /* host mapping support */
404 struct dev_mapping_table *mapping_table;
405 struct enc_mapping_table *enclosure_table;
406 struct map_removal_table *removal_table;
407 uint8_t *dpm_entry_used;
408 uint8_t *dpm_flush_entry;
409 Mpi2DriverMappingPage0_t *dpm_pg0;
410 uint16_t max_devices;
411 uint16_t max_enclosures;
412 uint16_t max_expanders;
413 uint8_t max_volumes;
414 uint8_t num_enc_table_entries;
415 uint8_t num_rsvd_entries;
416 uint16_t max_dpm_entries;
417 uint8_t is_dpm_enable;
418 uint8_t track_mapping_events;
419 uint32_t pending_map_events;
420
421 /* FW diag Buffer List */
422 mps_fw_diagnostic_buffer_t
423 fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT];
424
425 /* Event Recording IOCTL support */
426 uint32_t events_to_record[4];
427 mps_event_entry_t recorded_events[MPS_EVENT_QUEUE_SIZE];
428 uint8_t event_index;
429 uint32_t event_number;
430
431 /* EEDP and TLR support */
432 uint8_t eedp_enabled;
433 uint8_t control_TLR;
434
435 /* Shutdown Event Handler */
436 eventhandler_tag shutdown_eh;
437
438 /* To track topo events during reset */
439 #define MPS_DIAG_RESET_TIMEOUT 300000
440 uint8_t wait_for_port_enable;
441 uint8_t port_enable_complete;
442 uint8_t msleep_fake_chan;
443
444 /* WD controller */
445 uint8_t WD_available;
446 uint8_t WD_valid_config;
447 uint8_t WD_hide_expose;
448
449 /* Direct Drive for WarpDrive */
450 uint8_t DD_num_phys_disks;
451 uint16_t DD_dev_handle;
452 uint32_t DD_stripe_size;
453 uint32_t DD_stripe_exponent;
454 uint32_t DD_block_size;
455 uint16_t DD_block_exponent;
456 uint64_t DD_max_lba;
457 struct mps_column_map DD_column_map[MPS_MAX_DISKS_IN_VOL];
458
459 /* StartStopUnit command handling at shutdown */
460 uint32_t SSU_refcount;
461 uint8_t SSU_started;
462
463 /* Configuration tunables */
464 u_int disable_msix;
465 u_int disable_msi;
466 u_int max_msix;
467 u_int max_reqframes;
468 u_int max_prireqframes;
469 u_int max_replyframes;
470 u_int max_evtframes;
471 char exclude_ids[80];
472
473 struct timeval lastfail;
474 };
475
476 struct mps_config_params {
477 MPI2_CONFIG_EXT_PAGE_HEADER_UNION hdr;
478 u_int action;
479 u_int page_address; /* Attributes, not a phys address */
480 u_int status;
481 void *buffer;
482 u_int length;
483 int timeout;
484 void (*callback)(struct mps_softc *, struct mps_config_params *);
485 void *cbdata;
486 };
487
488 struct scsi_read_capacity_eedp
489 {
490 uint8_t addr[8];
491 uint8_t length[4];
492 uint8_t protect;
493 };
494
495 static __inline uint32_t
mps_regread(struct mps_softc * sc,uint32_t offset)496 mps_regread(struct mps_softc *sc, uint32_t offset)
497 {
498 return (bus_space_read_4(sc->mps_btag, sc->mps_bhandle, offset));
499 }
500
501 static __inline void
mps_regwrite(struct mps_softc * sc,uint32_t offset,uint32_t val)502 mps_regwrite(struct mps_softc *sc, uint32_t offset, uint32_t val)
503 {
504 bus_space_write_4(sc->mps_btag, sc->mps_bhandle, offset, val);
505 }
506
507 /* free_queue must have Little Endian address
508 * TODO- cm_reply_data is unwanted. We can remove it.
509 * */
510 static __inline void
mps_free_reply(struct mps_softc * sc,uint32_t busaddr)511 mps_free_reply(struct mps_softc *sc, uint32_t busaddr)
512 {
513 if (++sc->replyfreeindex >= sc->fqdepth)
514 sc->replyfreeindex = 0;
515 sc->free_queue[sc->replyfreeindex] = htole32(busaddr);
516 mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex);
517 }
518
519 static __inline struct mps_chain *
mps_alloc_chain(struct mps_softc * sc)520 mps_alloc_chain(struct mps_softc *sc)
521 {
522 struct mps_chain *chain;
523
524 if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) {
525 TAILQ_REMOVE(&sc->chain_list, chain, chain_link);
526 sc->chain_free--;
527 if (sc->chain_free < sc->chain_free_lowwater)
528 sc->chain_free_lowwater = sc->chain_free;
529 } else
530 sc->chain_alloc_fail++;
531 return (chain);
532 }
533
534 static __inline void
mps_free_chain(struct mps_softc * sc,struct mps_chain * chain)535 mps_free_chain(struct mps_softc *sc, struct mps_chain *chain)
536 {
537 sc->chain_free++;
538 TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link);
539 }
540
541 static __inline void
mps_free_command(struct mps_softc * sc,struct mps_command * cm)542 mps_free_command(struct mps_softc *sc, struct mps_command *cm)
543 {
544 struct mps_chain *chain, *chain_temp;
545
546 KASSERT(cm->cm_state == MPS_CM_STATE_BUSY,
547 ("state not busy: %d\n", cm->cm_state));
548
549 if (cm->cm_reply != NULL)
550 mps_free_reply(sc, cm->cm_reply_data);
551 cm->cm_reply = NULL;
552 cm->cm_flags = 0;
553 cm->cm_complete = NULL;
554 cm->cm_complete_data = NULL;
555 cm->cm_ccb = NULL;
556 cm->cm_targ = NULL;
557 cm->cm_max_segs = 0;
558 cm->cm_lun = 0;
559 cm->cm_state = MPS_CM_STATE_FREE;
560 cm->cm_data = NULL;
561 cm->cm_length = 0;
562 cm->cm_out_len = 0;
563 cm->cm_sglsize = 0;
564 cm->cm_sge = NULL;
565
566 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
567 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
568 mps_free_chain(sc, chain);
569 }
570 TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link);
571 }
572
573 static __inline struct mps_command *
mps_alloc_command(struct mps_softc * sc)574 mps_alloc_command(struct mps_softc *sc)
575 {
576 struct mps_command *cm;
577
578 cm = TAILQ_FIRST(&sc->req_list);
579 if (cm == NULL)
580 return (NULL);
581
582 KASSERT(cm->cm_state == MPS_CM_STATE_FREE,
583 ("mps: Allocating busy command: %d\n", cm->cm_state));
584
585 TAILQ_REMOVE(&sc->req_list, cm, cm_link);
586 cm->cm_state = MPS_CM_STATE_BUSY;
587 cm->cm_timeout_handler = NULL;
588 return (cm);
589 }
590
591 static __inline void
mps_free_high_priority_command(struct mps_softc * sc,struct mps_command * cm)592 mps_free_high_priority_command(struct mps_softc *sc, struct mps_command *cm)
593 {
594 struct mps_chain *chain, *chain_temp;
595
596 KASSERT(cm->cm_state == MPS_CM_STATE_BUSY,
597 ("state not busy: %d\n", cm->cm_state));
598
599 if (cm->cm_reply != NULL)
600 mps_free_reply(sc, cm->cm_reply_data);
601 cm->cm_reply = NULL;
602 cm->cm_flags = 0;
603 cm->cm_complete = NULL;
604 cm->cm_complete_data = NULL;
605 cm->cm_ccb = NULL;
606 cm->cm_targ = NULL;
607 cm->cm_lun = 0;
608 cm->cm_state = MPS_CM_STATE_FREE;
609 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
610 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
611 mps_free_chain(sc, chain);
612 }
613 TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link);
614 }
615
616 static __inline struct mps_command *
mps_alloc_high_priority_command(struct mps_softc * sc)617 mps_alloc_high_priority_command(struct mps_softc *sc)
618 {
619 struct mps_command *cm;
620
621 cm = TAILQ_FIRST(&sc->high_priority_req_list);
622 if (cm == NULL)
623 return (NULL);
624
625 KASSERT(cm->cm_state == MPS_CM_STATE_FREE,
626 ("mps: Allocating high priority busy command: %d\n", cm->cm_state));
627
628 TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link);
629 cm->cm_state = MPS_CM_STATE_BUSY;
630 cm->cm_timeout_handler = NULL;
631 cm->cm_desc.HighPriority.RequestFlags =
632 MPI2_REQ_DESCRIPT_FLAGS_HIGH_PRIORITY;
633 return (cm);
634 }
635
636 static __inline void
mps_lock(struct mps_softc * sc)637 mps_lock(struct mps_softc *sc)
638 {
639 mtx_lock(&sc->mps_mtx);
640 }
641
642 static __inline void
mps_unlock(struct mps_softc * sc)643 mps_unlock(struct mps_softc *sc)
644 {
645 mtx_unlock(&sc->mps_mtx);
646 }
647
648 #define MPS_INFO (1 << 0) /* Basic info */
649 #define MPS_FAULT (1 << 1) /* Hardware faults */
650 #define MPS_EVENT (1 << 2) /* Event data from the controller */
651 #define MPS_LOG (1 << 3) /* Log data from the controller */
652 #define MPS_RECOVERY (1 << 4) /* Command error recovery tracing */
653 #define MPS_ERROR (1 << 5) /* Parameter errors, programming bugs */
654 #define MPS_INIT (1 << 6) /* Things related to system init */
655 #define MPS_XINFO (1 << 7) /* More detailed/noisy info */
656 #define MPS_USER (1 << 8) /* Trace user-generated commands */
657 #define MPS_MAPPING (1 << 9) /* Trace device mappings */
658 #define MPS_TRACE (1 << 10) /* Function-by-function trace */
659
660 #define MPS_SSU_DISABLE_SSD_DISABLE_HDD 0
661 #define MPS_SSU_ENABLE_SSD_DISABLE_HDD 1
662 #define MPS_SSU_DISABLE_SSD_ENABLE_HDD 2
663 #define MPS_SSU_ENABLE_SSD_ENABLE_HDD 3
664
665 #define mps_printf(sc, args...) \
666 device_printf((sc)->mps_dev, ##args)
667
668 #define mps_print_field(sc, msg, args...) \
669 printf("\t" msg, ##args)
670
671 #define mps_vprintf(sc, args...) \
672 do { \
673 if (bootverbose) \
674 mps_printf(sc, ##args); \
675 } while (0)
676
677 #define mps_dprint(sc, level, msg, args...) \
678 do { \
679 if ((sc)->mps_debug & (level)) \
680 device_printf((sc)->mps_dev, msg, ##args); \
681 } while (0)
682
683 #define MPS_PRINTFIELD_START(sc, tag...) \
684 mps_printf((sc), ##tag); \
685 mps_print_field((sc), ":\n")
686 #define MPS_PRINTFIELD_END(sc, tag) \
687 mps_printf((sc), tag "\n")
688 #define MPS_PRINTFIELD(sc, facts, attr, fmt) \
689 mps_print_field((sc), #attr ": " #fmt "\n", (facts)->attr)
690
691 #define MPS_FUNCTRACE(sc) \
692 mps_dprint((sc), MPS_TRACE, "%s\n", __func__)
693
694 #define CAN_SLEEP 1
695 #define NO_SLEEP 0
696
697 static __inline void
mps_from_u64(uint64_t data,U64 * mps)698 mps_from_u64(uint64_t data, U64 *mps)
699 {
700 (mps)->High = htole32((uint32_t)((data) >> 32));
701 (mps)->Low = htole32((uint32_t)((data) & 0xffffffff));
702 }
703
704 static __inline uint64_t
mps_to_u64(U64 * data)705 mps_to_u64(U64 *data)
706 {
707
708 return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low));
709 }
710
711 static __inline void
mps_mask_intr(struct mps_softc * sc)712 mps_mask_intr(struct mps_softc *sc)
713 {
714 uint32_t mask;
715
716 mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
717 mask |= MPI2_HIM_REPLY_INT_MASK;
718 mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
719 }
720
721 static __inline void
mps_unmask_intr(struct mps_softc * sc)722 mps_unmask_intr(struct mps_softc *sc)
723 {
724 uint32_t mask;
725
726 mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
727 mask &= ~MPI2_HIM_REPLY_INT_MASK;
728 mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
729 }
730
731 int mps_pci_setup_interrupts(struct mps_softc *sc);
732 void mps_pci_free_interrupts(struct mps_softc *sc);
733 int mps_pci_restore(struct mps_softc *sc);
734
735 void mps_get_tunables(struct mps_softc *sc);
736 int mps_attach(struct mps_softc *sc);
737 int mps_free(struct mps_softc *sc);
738 void mps_intr(void *);
739 void mps_intr_msi(void *);
740 void mps_intr_locked(void *);
741 int mps_register_events(struct mps_softc *, u32 *, mps_evt_callback_t *,
742 void *, struct mps_event_handle **);
743 int mps_restart(struct mps_softc *);
744 int mps_update_events(struct mps_softc *, struct mps_event_handle *, u32 *);
745 void mps_deregister_events(struct mps_softc *, struct mps_event_handle *);
746 int mps_push_sge(struct mps_command *, void *, size_t, int);
747 int mps_add_dmaseg(struct mps_command *, vm_paddr_t, size_t, u_int, int);
748 int mps_attach_sas(struct mps_softc *sc);
749 int mps_detach_sas(struct mps_softc *sc);
750 int mps_read_config_page(struct mps_softc *, struct mps_config_params *);
751 int mps_write_config_page(struct mps_softc *, struct mps_config_params *);
752 void mps_memaddr_cb(void *, bus_dma_segment_t *, int , int );
753 void mps_memaddr_wait_cb(void *, bus_dma_segment_t *, int , int );
754 void mpi_init_sge(struct mps_command *cm, void *req, void *sge);
755 int mps_attach_user(struct mps_softc *);
756 void mps_detach_user(struct mps_softc *);
757 void mpssas_record_event(struct mps_softc *sc,
758 MPI2_EVENT_NOTIFICATION_REPLY *event_reply);
759
760 int mps_map_command(struct mps_softc *sc, struct mps_command *cm);
761 int mps_wait_command(struct mps_softc *sc, struct mps_command **cm, int timeout,
762 int sleep_flag);
763
764 int mps_config_get_bios_pg3(struct mps_softc *sc, Mpi2ConfigReply_t
765 *mpi_reply, Mpi2BiosPage3_t *config_page);
766 int mps_config_get_raid_volume_pg0(struct mps_softc *sc, Mpi2ConfigReply_t
767 *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address);
768 int mps_config_get_ioc_pg8(struct mps_softc *sc, Mpi2ConfigReply_t *,
769 Mpi2IOCPage8_t *);
770 int mps_config_get_man_pg10(struct mps_softc *sc, Mpi2ConfigReply_t *mpi_reply);
771 int mps_config_get_sas_device_pg0(struct mps_softc *, Mpi2ConfigReply_t *,
772 Mpi2SasDevicePage0_t *, u32 , u16 );
773 int mps_config_get_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *,
774 Mpi2DriverMappingPage0_t *, u16 );
775 int mps_config_get_raid_volume_pg1(struct mps_softc *sc,
776 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
777 u16 handle);
778 int mps_config_get_volume_wwid(struct mps_softc *sc, u16 volume_handle,
779 u64 *wwid);
780 int mps_config_get_raid_pd_pg0(struct mps_softc *sc,
781 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
782 u32 page_address);
783 void mpssas_ir_shutdown(struct mps_softc *sc, int howto);
784
785 int mps_reinit(struct mps_softc *sc);
786 void mpssas_handle_reinit(struct mps_softc *sc);
787
788 void mps_base_static_config_pages(struct mps_softc *sc);
789 void mps_wd_config_pages(struct mps_softc *sc);
790
791 int mps_mapping_initialize(struct mps_softc *);
792 void mps_mapping_topology_change_event(struct mps_softc *,
793 Mpi2EventDataSasTopologyChangeList_t *);
794 void mps_mapping_free_memory(struct mps_softc *sc);
795 int mps_config_set_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *,
796 Mpi2DriverMappingPage0_t *, u16 );
797 void mps_mapping_exit(struct mps_softc *);
798 void mps_mapping_check_devices(void *);
799 int mps_mapping_allocate_memory(struct mps_softc *sc);
800 unsigned int mps_mapping_get_tid(struct mps_softc *, uint64_t , u16);
801 unsigned int mps_mapping_get_tid_from_handle(struct mps_softc *sc,
802 u16 handle);
803 unsigned int mps_mapping_get_raid_tid(struct mps_softc *sc, u64 wwid,
804 u16 volHandle);
805 unsigned int mps_mapping_get_raid_tid_from_handle(struct mps_softc *sc,
806 u16 volHandle);
807 void mps_mapping_enclosure_dev_status_change_event(struct mps_softc *,
808 Mpi2EventDataSasEnclDevStatusChange_t *event_data);
809 void mps_mapping_ir_config_change_event(struct mps_softc *sc,
810 Mpi2EventDataIrConfigChangeList_t *event_data);
811 int mps_mapping_dump(SYSCTL_HANDLER_ARGS);
812 int mps_mapping_encl_dump(SYSCTL_HANDLER_ARGS);
813
814 void mpssas_evt_handler(struct mps_softc *sc, uintptr_t data,
815 MPI2_EVENT_NOTIFICATION_REPLY *event);
816 void mpssas_prepare_remove(struct mpssas_softc *sassc, uint16_t handle);
817 void mpssas_prepare_volume_remove(struct mpssas_softc *sassc, uint16_t handle);
818 int mpssas_startup(struct mps_softc *sc);
819 struct mpssas_target * mpssas_find_target_by_handle(struct mpssas_softc *, int, uint16_t);
820 void mpssas_realloc_targets(struct mps_softc *sc, int maxtargets);
821 struct mps_command * mpssas_alloc_tm(struct mps_softc *sc);
822 void mpssas_free_tm(struct mps_softc *sc, struct mps_command *tm);
823 void mpssas_release_simq_reinit(struct mpssas_softc *sassc);
824 int mpssas_send_reset(struct mps_softc *sc, struct mps_command *tm,
825 uint8_t type);
826
827 SYSCTL_DECL(_hw_mps);
828
829 /* Compatibility shims for different OS versions */
830 #if __FreeBSD_version >= 800001
831 #define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
832 kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
833 #define mps_kproc_exit(arg) kproc_exit(arg)
834 #else
835 #define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
836 kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
837 #define mps_kproc_exit(arg) kthread_exit(arg)
838 #endif
839
840 #if defined(CAM_PRIORITY_XPT)
841 #define MPS_PRIORITY_XPT CAM_PRIORITY_XPT
842 #else
843 #define MPS_PRIORITY_XPT 5
844 #endif
845
846 #if __FreeBSD_version < 800107
847 // Prior to FreeBSD-8.0 scp3_flags was not defined.
848 #define spc3_flags reserved
849
850 #define SPC3_SID_PROTECT 0x01
851 #define SPC3_SID_3PC 0x08
852 #define SPC3_SID_TPGS_MASK 0x30
853 #define SPC3_SID_TPGS_IMPLICIT 0x10
854 #define SPC3_SID_TPGS_EXPLICIT 0x20
855 #define SPC3_SID_ACC 0x40
856 #define SPC3_SID_SCCS 0x80
857
858 #define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE
859 #endif
860
861 #endif
862
863