1 /*-
2 * Copyright (c) 2011-2015 LSI Corp.
3 * Copyright (c) 2013-2016 Avago Technologies
4 * Copyright 2000-2020 Broadcom Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * Broadcom Inc. (LSI) MPT-Fusion Host Adapter FreeBSD
29 */
30
31 struct mpr_fw_event_work;
32
33 struct mprsas_lun {
34 SLIST_ENTRY(mprsas_lun) lun_link;
35 lun_id_t lun_id;
36 uint8_t eedp_formatted;
37 uint32_t eedp_block_size;
38 };
39
40 struct mprsas_target {
41 uint16_t handle;
42 uint8_t linkrate;
43 uint8_t encl_level_valid;
44 uint8_t encl_level;
45 char connector_name[4];
46 uint64_t devname;
47 uint32_t devinfo;
48 uint16_t encl_handle;
49 uint16_t encl_slot;
50 uint8_t flags;
51 #define MPRSAS_TARGET_INABORT (1 << 0)
52 #define MPRSAS_TARGET_INRESET (1 << 1)
53 #define MPRSAS_TARGET_INDIAGRESET (1 << 2)
54 #define MPRSAS_TARGET_INREMOVAL (1 << 3)
55 #define MPR_TARGET_FLAGS_RAID_COMPONENT (1 << 4)
56 #define MPR_TARGET_FLAGS_VOLUME (1 << 5)
57 #define MPR_TARGET_IS_SATA_SSD (1 << 6)
58 #define MPRSAS_TARGET_TOREMOVE (1 << 7)
59
60 uint16_t tid;
61 SLIST_HEAD(, mprsas_lun) luns;
62 TAILQ_HEAD(, mpr_command) commands;
63 struct mpr_command *tm;
64 struct mpr_command *pending_remove_tm;
65 TAILQ_HEAD(, mpr_command) timedout_commands;
66 uint16_t exp_dev_handle;
67 uint16_t phy_num;
68 uint64_t sasaddr;
69 uint16_t parent_handle;
70 uint64_t parent_sasaddr;
71 uint32_t parent_devinfo;
72 uint64_t issued;
73 uint64_t completed;
74 unsigned int outstanding;
75 unsigned int timeouts;
76 unsigned int aborts;
77 unsigned int logical_unit_resets;
78 unsigned int target_resets;
79 uint8_t scsi_req_desc_type;
80 uint8_t stop_at_shutdown;
81 uint8_t supports_SSU;
82 uint8_t is_nvme;
83 uint32_t MDTS;
84 uint8_t controller_reset_timeout;
85 };
86
87 struct mprsas_softc {
88 struct mpr_softc *sc;
89 u_int flags;
90 #define MPRSAS_IN_DISCOVERY (1 << 0)
91 #define MPRSAS_IN_STARTUP (1 << 1)
92 #define MPRSAS_DISCOVERY_TIMEOUT_PENDING (1 << 2)
93 #define MPRSAS_QUEUE_FROZEN (1 << 3)
94 #define MPRSAS_SHUTDOWN (1 << 4)
95 #define MPRSAS_TOREMOVE (1 << 5)
96 u_int maxtargets;
97 struct mprsas_target *targets;
98 struct cam_devq *devq;
99 struct cam_sim *sim;
100 struct cam_path *path;
101 struct intr_config_hook sas_ich;
102 struct callout discovery_callout;
103 struct mpr_event_handle *mprsas_eh;
104
105 u_int startup_refcount;
106 struct proc *sysctl_proc;
107
108 struct taskqueue *ev_tq;
109 struct task ev_task;
110 TAILQ_HEAD(, mpr_fw_event_work) ev_queue;
111 };
112
113 MALLOC_DECLARE(M_MPRSAS);
114
115 /*
116 * Abstracted so that the driver can be backwards and forwards compatible
117 * with future versions of CAM that will provide this functionality.
118 */
119 #define MPR_SET_LUN(lun, ccblun) \
120 mprsas_set_lun(lun, ccblun)
121
122 static __inline int
mprsas_set_lun(uint8_t * lun,u_int ccblun)123 mprsas_set_lun(uint8_t *lun, u_int ccblun)
124 {
125 uint64_t *newlun;
126
127 newlun = (uint64_t *)lun;
128 *newlun = 0;
129 if (ccblun <= 0xff) {
130 /* Peripheral device address method, LUN is 0 to 255 */
131 lun[1] = ccblun;
132 } else if (ccblun <= 0x3fff) {
133 /* Flat space address method, LUN is <= 16383 */
134 scsi_ulto2b(ccblun, lun);
135 lun[0] |= 0x40;
136 } else if (ccblun <= 0xffffff) {
137 /* Extended flat space address method, LUN is <= 16777215 */
138 scsi_ulto3b(ccblun, &lun[1]);
139 /* Extended Flat space address method */
140 lun[0] = 0xc0;
141 /* Length = 1, i.e. LUN is 3 bytes long */
142 lun[0] |= 0x10;
143 /* Extended Address Method */
144 lun[0] |= 0x02;
145 } else {
146 return (EINVAL);
147 }
148
149 return (0);
150 }
151
152 static __inline void
mprsas_set_ccbstatus(union ccb * ccb,int status)153 mprsas_set_ccbstatus(union ccb *ccb, int status)
154 {
155 ccb->ccb_h.status &= ~CAM_STATUS_MASK;
156 ccb->ccb_h.status |= status;
157 }
158
159 static __inline int
mprsas_get_ccbstatus(union ccb * ccb)160 mprsas_get_ccbstatus(union ccb *ccb)
161 {
162 return (ccb->ccb_h.status & CAM_STATUS_MASK);
163 }
164
165 #define MPR_SET_SINGLE_LUN(req, lun) \
166 do { \
167 bzero((req)->LUN, 8); \
168 (req)->LUN[1] = lun; \
169 } while(0)
170
171 void mprsas_rescan_target(struct mpr_softc *sc, struct mprsas_target *targ);
172 void mprsas_discovery_end(struct mprsas_softc *sassc);
173 void mprsas_prepare_for_tm(struct mpr_softc *sc, struct mpr_command *tm,
174 struct mprsas_target *target, lun_id_t lun_id);
175 void mprsas_startup_increment(struct mprsas_softc *sassc);
176 void mprsas_startup_decrement(struct mprsas_softc *sassc);
177
178 void mprsas_firmware_event_work(void *arg, int pending);
179 int mprsas_check_id(struct mprsas_softc *sassc, int id);
180