2 * Copyright (c) 2006 IronPort Systems
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * Copyright (c) 2007 LSI Corp.
28 * Copyright (c) 2007 Rajesh Prabhakaran.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
34 * 1. Redistributions of source code must retain the above copyright
35 * notice, this list of conditions and the following disclaimer.
36 * 2. Redistributions in binary form must reproduce the above copyright
37 * notice, this list of conditions and the following disclaimer in the
38 * documentation and/or other materials provided with the distribution.
40 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56 #include <sys/cdefs.h>
57 __FBSDID("$FreeBSD$");
63 * SCSI structures and definitions are used from here, but no linking
64 * requirements are made to CAM.
66 #include <cam/scsi/scsi_all.h>
71 uint32_t hw_reply_q[1];
79 TAILQ_ENTRY(mfi_command) cm_link;
81 struct mfi_softc *cm_sc;
82 union mfi_frame *cm_frame;
83 uint32_t cm_frame_busaddr;
84 struct mfi_sense *cm_sense;
85 uint32_t cm_sense_busaddr;
86 bus_dmamap_t cm_dmamap;
90 int cm_total_frame_size;
93 #define MFI_CMD_MAPPED (1<<0)
94 #define MFI_CMD_DATAIN (1<<1)
95 #define MFI_CMD_DATAOUT (1<<2)
96 #define MFI_CMD_COMPLETED (1<<3)
97 #define MFI_CMD_POLLED (1<<4)
98 #define MFI_ON_MFIQ_FREE (1<<5)
99 #define MFI_ON_MFIQ_READY (1<<6)
100 #define MFI_ON_MFIQ_BUSY (1<<7)
101 #define MFI_ON_MFIQ_MASK ((1<<5)|(1<<6)|(1<<7))
103 void (* cm_complete)(struct mfi_command *cm);
110 TAILQ_ENTRY(mfi_disk) ld_link;
114 struct mfi_softc *ld_controller;
115 struct mfi_ld_info *ld_info;
116 struct disk *ld_disk;
118 #define MFI_DISK_FLAGS_OPEN 0x01
119 #define MFI_DISK_FLAGS_DISABLED 0x02
123 TAILQ_ENTRY(mfi_aen) aen_link;
130 #define MFI_FLAGS_SG64 (1<<0)
131 #define MFI_FLAGS_QFRZN (1<<1)
132 #define MFI_FLAGS_OPEN (1<<2)
133 #define MFI_FLAGS_STOP (1<<3)
134 #define MFI_FLAGS_1064R (1<<4)
135 #define MFI_FLAGS_1078 (1<<5)
136 #define MFI_FLAGS_GEN2 (1<<6)
138 struct mfi_hwcomms *mfi_comms;
139 TAILQ_HEAD(,mfi_command) mfi_free;
140 TAILQ_HEAD(,mfi_command) mfi_ready;
141 TAILQ_HEAD(,mfi_command) mfi_busy;
142 struct bio_queue_head mfi_bioq;
143 struct mfi_qstat mfi_qstat[MFIQ_COUNT];
145 struct resource *mfi_regs_resource;
146 bus_space_handle_t mfi_bhandle;
147 bus_space_tag_t mfi_btag;
150 bus_dma_tag_t mfi_parent_dmat;
151 bus_dma_tag_t mfi_buffer_dmat;
153 bus_dma_tag_t mfi_comms_dmat;
154 bus_dmamap_t mfi_comms_dmamap;
155 uint32_t mfi_comms_busaddr;
157 bus_dma_tag_t mfi_frames_dmat;
158 bus_dmamap_t mfi_frames_dmamap;
159 uint32_t mfi_frames_busaddr;
160 union mfi_frame *mfi_frames;
162 TAILQ_HEAD(,mfi_aen) mfi_aen_pids;
163 struct mfi_command *mfi_aen_cm;
164 uint32_t mfi_aen_triggered;
165 uint32_t mfi_poll_waiting;
166 struct selinfo mfi_select;
167 int mfi_delete_busy_volumes;
168 int mfi_keep_deleted_volumes;
171 bus_dma_tag_t mfi_sense_dmat;
172 bus_dmamap_t mfi_sense_dmamap;
173 uint32_t mfi_sense_busaddr;
174 struct mfi_sense *mfi_sense;
176 struct resource *mfi_irq;
180 struct intr_config_hook mfi_ich;
184 * Allocation for the command array. Used as an indexable array to
185 * recover completed commands.
187 struct mfi_command *mfi_commands;
189 * How many commands were actually allocated
193 * How many commands the firmware can handle. Also how big the reply
198 * How many S/G elements we'll ever actually use
202 * How many bytes a compound frame is, including all of the extra frames
203 * that are used for S/G elements.
207 * How large an S/G element is. Used to calculate the number of single
208 * frames in a command.
212 * Max number of sectors that the firmware allows
216 TAILQ_HEAD(,mfi_disk) mfi_ld_tqh;
217 eventhandler_tag mfi_eh;
218 struct cdev *mfi_cdev;
220 TAILQ_HEAD(, ccb_hdr) mfi_cam_ccbq;
221 struct mfi_command * (* mfi_cam_start)(void *);
222 struct callout mfi_watchdog_callout;
223 struct mtx mfi_io_lock;
224 struct sx mfi_config_lock;
226 /* Controller type specific interfaces */
227 void (*mfi_enable_intr)(struct mfi_softc *sc);
228 int32_t (*mfi_read_fw_status)(struct mfi_softc *sc);
229 int (*mfi_check_clear_intr)(struct mfi_softc *sc);
230 void (*mfi_issue_cmd)(struct mfi_softc *sc,uint32_t bus_add,uint32_t frame_cnt);
233 extern int mfi_attach(struct mfi_softc *);
234 extern void mfi_free(struct mfi_softc *);
235 extern int mfi_shutdown(struct mfi_softc *);
236 extern void mfi_startio(struct mfi_softc *);
237 extern void mfi_disk_complete(struct bio *);
238 extern int mfi_disk_disable(struct mfi_disk *);
239 extern void mfi_disk_enable(struct mfi_disk *);
240 extern int mfi_dump_blocks(struct mfi_softc *, int id, uint64_t, void *, int);
242 #define MFIQ_ADD(sc, qname) \
244 struct mfi_qstat *qs; \
246 qs = &(sc)->mfi_qstat[qname]; \
248 if (qs->q_length > qs->q_max) \
249 qs->q_max = qs->q_length; \
252 #define MFIQ_REMOVE(sc, qname) (sc)->mfi_qstat[qname].q_length--
254 #define MFIQ_INIT(sc, qname) \
256 sc->mfi_qstat[qname].q_length = 0; \
257 sc->mfi_qstat[qname].q_max = 0; \
260 #define MFIQ_COMMAND_QUEUE(name, index) \
261 static __inline void \
262 mfi_initq_ ## name (struct mfi_softc *sc) \
264 TAILQ_INIT(&sc->mfi_ ## name); \
265 MFIQ_INIT(sc, index); \
267 static __inline void \
268 mfi_enqueue_ ## name (struct mfi_command *cm) \
270 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) { \
271 printf("command %p is on another queue, " \
272 "flags = %#x\n", cm, cm->cm_flags); \
273 panic("command is on another queue"); \
275 TAILQ_INSERT_TAIL(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
276 cm->cm_flags |= MFI_ON_ ## index; \
277 MFIQ_ADD(cm->cm_sc, index); \
279 static __inline void \
280 mfi_requeue_ ## name (struct mfi_command *cm) \
282 if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) { \
283 printf("command %p is on another queue, " \
284 "flags = %#x\n", cm, cm->cm_flags); \
285 panic("command is on another queue"); \
287 TAILQ_INSERT_HEAD(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
288 cm->cm_flags |= MFI_ON_ ## index; \
289 MFIQ_ADD(cm->cm_sc, index); \
291 static __inline struct mfi_command * \
292 mfi_dequeue_ ## name (struct mfi_softc *sc) \
294 struct mfi_command *cm; \
296 if ((cm = TAILQ_FIRST(&sc->mfi_ ## name)) != NULL) { \
297 if ((cm->cm_flags & MFI_ON_ ## index) == 0) { \
298 printf("command %p not in queue, " \
299 "flags = %#x, bit = %#x\n", cm, \
300 cm->cm_flags, MFI_ON_ ## index); \
301 panic("command not in queue"); \
303 TAILQ_REMOVE(&sc->mfi_ ## name, cm, cm_link); \
304 cm->cm_flags &= ~MFI_ON_ ## index; \
305 MFIQ_REMOVE(sc, index); \
309 static __inline void \
310 mfi_remove_ ## name (struct mfi_command *cm) \
312 if ((cm->cm_flags & MFI_ON_ ## index) == 0) { \
313 printf("command %p not in queue, flags = %#x, " \
314 "bit = %#x\n", cm, cm->cm_flags, \
316 panic("command not in queue"); \
318 TAILQ_REMOVE(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
319 cm->cm_flags &= ~MFI_ON_ ## index; \
320 MFIQ_REMOVE(cm->cm_sc, index); \
324 MFIQ_COMMAND_QUEUE(free, MFIQ_FREE);
325 MFIQ_COMMAND_QUEUE(ready, MFIQ_READY);
326 MFIQ_COMMAND_QUEUE(busy, MFIQ_BUSY);
329 mfi_initq_bio(struct mfi_softc *sc)
331 bioq_init(&sc->mfi_bioq);
332 MFIQ_INIT(sc, MFIQ_BIO);
336 mfi_enqueue_bio(struct mfi_softc *sc, struct bio *bp)
338 bioq_insert_tail(&sc->mfi_bioq, bp);
339 MFIQ_ADD(sc, MFIQ_BIO);
342 static __inline struct bio *
343 mfi_dequeue_bio(struct mfi_softc *sc)
347 if ((bp = bioq_first(&sc->mfi_bioq)) != NULL) {
348 bioq_remove(&sc->mfi_bioq, bp);
349 MFIQ_REMOVE(sc, MFIQ_BIO);
355 mfi_print_sense(struct mfi_softc *sc, void *sense)
357 int error, key, asc, ascq;
359 scsi_extract_sense((struct scsi_sense_data *)sense,
360 &error, &key, &asc, &ascq);
361 device_printf(sc->mfi_dev, "sense error %d, sense_key %d, "
362 "asc %d, ascq %d\n", error, key, asc, ascq);
366 #define MFI_WRITE4(sc, reg, val) bus_space_write_4((sc)->mfi_btag, \
367 sc->mfi_bhandle, (reg), (val))
368 #define MFI_READ4(sc, reg) bus_space_read_4((sc)->mfi_btag, \
369 (sc)->mfi_bhandle, (reg))
370 #define MFI_WRITE2(sc, reg, val) bus_space_write_2((sc)->mfi_btag, \
371 sc->mfi_bhandle, (reg), (val))
372 #define MFI_READ2(sc, reg) bus_space_read_2((sc)->mfi_btag, \
373 (sc)->mfi_bhandle, (reg))
374 #define MFI_WRITE1(sc, reg, val) bus_space_write_1((sc)->mfi_btag, \
375 sc->mfi_bhandle, (reg), (val))
376 #define MFI_READ1(sc, reg) bus_space_read_1((sc)->mfi_btag, \
377 (sc)->mfi_bhandle, (reg))
379 MALLOC_DECLARE(M_MFIBUF);
381 #define MFI_CMD_TIMEOUT 30
382 #define MFI_MAXPHYS (128 * 1024)
385 extern void mfi_print_cmd(struct mfi_command *cm);
386 extern void mfi_dump_cmds(struct mfi_softc *sc);
387 extern void mfi_validate_sg(struct mfi_softc *, struct mfi_command *, const char *, int );
388 #define MFI_PRINT_CMD(cm) mfi_print_cmd(cm)
389 #define MFI_DUMP_CMDS(sc) mfi_dump_cmds(sc)
390 #define MFI_VALIDATE_CMD(sc, cm) mfi_validate_sg(sc, cm, __FUNCTION__, __LINE__)
392 #define MFI_PRINT_CMD(cm)
393 #define MFI_DUMP_CMDS(sc)
394 #define MFI_VALIDATE_CMD(sc, cm)
397 extern void mfi_release_command(struct mfi_command *cm);
399 #endif /* _MFIVAR_H */