xref: /dflybsd-src/sys/dev/raid/mfi/mfivar.h (revision 805c8e8e4093ceca2e27510ad3a66d4de8060a55)
1249d29c8SSascha Wildner /*-
2249d29c8SSascha Wildner  * Copyright (c) 2006 IronPort Systems
3249d29c8SSascha Wildner  * All rights reserved.
4249d29c8SSascha Wildner  *
5249d29c8SSascha Wildner  * Redistribution and use in source and binary forms, with or without
6249d29c8SSascha Wildner  * modification, are permitted provided that the following conditions
7249d29c8SSascha Wildner  * are met:
8249d29c8SSascha Wildner  * 1. Redistributions of source code must retain the above copyright
9249d29c8SSascha Wildner  *    notice, this list of conditions and the following disclaimer.
10249d29c8SSascha Wildner  * 2. Redistributions in binary form must reproduce the above copyright
11249d29c8SSascha Wildner  *    notice, this list of conditions and the following disclaimer in the
12249d29c8SSascha Wildner  *    documentation and/or other materials provided with the distribution.
13249d29c8SSascha Wildner  *
14249d29c8SSascha Wildner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15249d29c8SSascha Wildner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16249d29c8SSascha Wildner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17249d29c8SSascha Wildner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18249d29c8SSascha Wildner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19249d29c8SSascha Wildner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20249d29c8SSascha Wildner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21249d29c8SSascha Wildner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22249d29c8SSascha Wildner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23249d29c8SSascha Wildner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24249d29c8SSascha Wildner  * SUCH DAMAGE.
25249d29c8SSascha Wildner  */
26249d29c8SSascha Wildner /*-
27249d29c8SSascha Wildner  * Copyright (c) 2007 LSI Corp.
28249d29c8SSascha Wildner  * Copyright (c) 2007 Rajesh Prabhakaran.
29249d29c8SSascha Wildner  * All rights reserved.
30249d29c8SSascha Wildner  *
31249d29c8SSascha Wildner  * Redistribution and use in source and binary forms, with or without
32249d29c8SSascha Wildner  * modification, are permitted provided that the following conditions
33249d29c8SSascha Wildner  * are met:
34249d29c8SSascha Wildner  * 1. Redistributions of source code must retain the above copyright
35249d29c8SSascha Wildner  *    notice, this list of conditions and the following disclaimer.
36249d29c8SSascha Wildner  * 2. Redistributions in binary form must reproduce the above copyright
37249d29c8SSascha Wildner  *    notice, this list of conditions and the following disclaimer in the
38249d29c8SSascha Wildner  *    documentation and/or other materials provided with the distribution.
39249d29c8SSascha Wildner  *
40249d29c8SSascha Wildner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
41249d29c8SSascha Wildner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42249d29c8SSascha Wildner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43249d29c8SSascha Wildner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44249d29c8SSascha Wildner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45249d29c8SSascha Wildner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46249d29c8SSascha Wildner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47249d29c8SSascha Wildner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48249d29c8SSascha Wildner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49249d29c8SSascha Wildner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50249d29c8SSascha Wildner  * SUCH DAMAGE.
51249d29c8SSascha Wildner  *
52f0d8b1f2SSascha Wildner  * $FreeBSD: src/sys/dev/mfi/mfivar.h,v 1.14 2011/09/29 08:37:53 mav Exp $
53590ba11dSSascha Wildner  * FreeBSD projects/head_mfi/ r232949
54249d29c8SSascha Wildner  */
55249d29c8SSascha Wildner 
56249d29c8SSascha Wildner #ifndef _MFIVAR_H
57249d29c8SSascha Wildner #define _MFIVAR_H
58249d29c8SSascha Wildner 
5991c61028SSascha Wildner #include <sys/devicestat.h>
60249d29c8SSascha Wildner #include <sys/disk.h>
61249d29c8SSascha Wildner #include <sys/eventhandler.h>
62249d29c8SSascha Wildner #include <sys/lock.h>
63249d29c8SSascha Wildner #include <sys/sysctl.h>
64590ba11dSSascha Wildner #include <sys/taskqueue.h>
65249d29c8SSascha Wildner 
66249d29c8SSascha Wildner /*
67249d29c8SSascha Wildner  * SCSI structures and definitions are used from here, but no linking
68249d29c8SSascha Wildner  * requirements are made to CAM.
69249d29c8SSascha Wildner  */
70249d29c8SSascha Wildner #include <bus/cam/scsi/scsi_all.h>
71249d29c8SSascha Wildner 
72249d29c8SSascha Wildner struct mfi_hwcomms {
73249d29c8SSascha Wildner 	uint32_t		hw_pi;
74249d29c8SSascha Wildner 	uint32_t		hw_ci;
75249d29c8SSascha Wildner 	uint32_t		hw_reply_q[1];
76249d29c8SSascha Wildner };
77249d29c8SSascha Wildner 
78590ba11dSSascha Wildner #define	MEGASAS_MAX_NAME	32
79590ba11dSSascha Wildner #define	MEGASAS_VERSION		"4.23"
80590ba11dSSascha Wildner 
81249d29c8SSascha Wildner struct mfi_softc;
82249d29c8SSascha Wildner struct disk;
83249d29c8SSascha Wildner struct ccb_hdr;
84249d29c8SSascha Wildner 
85249d29c8SSascha Wildner struct mfi_command {
86249d29c8SSascha Wildner 	TAILQ_ENTRY(mfi_command) cm_link;
87249d29c8SSascha Wildner 	time_t			cm_timestamp;
88249d29c8SSascha Wildner 	struct mfi_softc	*cm_sc;
89249d29c8SSascha Wildner 	union mfi_frame		*cm_frame;
90590ba11dSSascha Wildner 	bus_addr_t		cm_frame_busaddr;
91249d29c8SSascha Wildner 	struct mfi_sense	*cm_sense;
92590ba11dSSascha Wildner 	bus_addr_t		cm_sense_busaddr;
93249d29c8SSascha Wildner 	bus_dmamap_t		cm_dmamap;
94249d29c8SSascha Wildner 	union mfi_sgl		*cm_sg;
95249d29c8SSascha Wildner 	void			*cm_data;
96249d29c8SSascha Wildner 	int			cm_len;
97f0d8b1f2SSascha Wildner 	int			cm_stp_len;
98249d29c8SSascha Wildner 	int			cm_total_frame_size;
99249d29c8SSascha Wildner 	int			cm_extra_frames;
100249d29c8SSascha Wildner 	int			cm_flags;
101249d29c8SSascha Wildner #define MFI_CMD_MAPPED		(1<<0)
102249d29c8SSascha Wildner #define MFI_CMD_DATAIN		(1<<1)
103249d29c8SSascha Wildner #define MFI_CMD_DATAOUT		(1<<2)
104249d29c8SSascha Wildner #define MFI_CMD_COMPLETED	(1<<3)
105249d29c8SSascha Wildner #define MFI_CMD_POLLED		(1<<4)
106249d29c8SSascha Wildner #define MFI_ON_MFIQ_FREE	(1<<5)
107249d29c8SSascha Wildner #define MFI_ON_MFIQ_READY	(1<<6)
108249d29c8SSascha Wildner #define MFI_ON_MFIQ_BUSY	(1<<7)
109249d29c8SSascha Wildner #define MFI_ON_MFIQ_MASK	((1<<5)|(1<<6)|(1<<7))
110249d29c8SSascha Wildner 	int			cm_aen_abort;
111590ba11dSSascha Wildner 	uint8_t			retry_for_fw_reset;
112249d29c8SSascha Wildner 	void			(* cm_complete)(struct mfi_command *cm);
113249d29c8SSascha Wildner 	void			*cm_private;
114249d29c8SSascha Wildner 	int			cm_index;
115249d29c8SSascha Wildner 	int			cm_error;
116249d29c8SSascha Wildner };
117249d29c8SSascha Wildner 
11817566092SSascha Wildner /*
11917566092SSascha Wildner  * XXX swildner
12017566092SSascha Wildner  *
12117566092SSascha Wildner  * At the moment we rely on mfi_disk and mfi_system_pd having the same size.
12217566092SSascha Wildner  * A future cleanup should merge them.
12317566092SSascha Wildner  */
124249d29c8SSascha Wildner struct mfi_disk {
125249d29c8SSascha Wildner 	TAILQ_ENTRY(mfi_disk)	ld_link;
126249d29c8SSascha Wildner 	device_t	ld_dev;
1279049decfSSascha Wildner 	cdev_t		ld_dev_t;
128249d29c8SSascha Wildner 	int		ld_id;
129249d29c8SSascha Wildner 	int		ld_unit;
130249d29c8SSascha Wildner 	struct mfi_softc *ld_controller;
131249d29c8SSascha Wildner 	struct mfi_ld_info	*ld_info;
132249d29c8SSascha Wildner 	struct disk	ld_disk;
13391c61028SSascha Wildner 	struct devstat	ld_devstat;
134249d29c8SSascha Wildner 	int		ld_flags;
135249d29c8SSascha Wildner #define MFI_DISK_FLAGS_OPEN	0x01
136249d29c8SSascha Wildner #define	MFI_DISK_FLAGS_DISABLED	0x02
13717566092SSascha Wildner #define	MFI_DISK_FLAGS_SYSPD	0x04
13817566092SSascha Wildner };
13917566092SSascha Wildner 
14017566092SSascha Wildner struct mfi_system_pd {
14117566092SSascha Wildner 	TAILQ_ENTRY(mfi_system_pd)	pd_link;
14217566092SSascha Wildner 	device_t	pd_dev;
1439049decfSSascha Wildner 	cdev_t		pd_dev_t;
14417566092SSascha Wildner 	int		pd_id;
14517566092SSascha Wildner 	int		pd_unit;
14617566092SSascha Wildner 	struct mfi_softc *pd_controller;
14717566092SSascha Wildner 	struct mfi_pd_info	*pd_info;
14817566092SSascha Wildner 	struct disk	pd_disk;
14917566092SSascha Wildner 	struct devstat	pd_devstat;
15017566092SSascha Wildner 	int		pd_flags;
151249d29c8SSascha Wildner };
152249d29c8SSascha Wildner 
153590ba11dSSascha Wildner struct mfi_evt_queue_elm {
154590ba11dSSascha Wildner 	TAILQ_ENTRY(mfi_evt_queue_elm)	link;
155590ba11dSSascha Wildner 	struct mfi_evt_detail		detail;
156590ba11dSSascha Wildner };
157590ba11dSSascha Wildner 
158249d29c8SSascha Wildner struct mfi_aen {
159249d29c8SSascha Wildner 	TAILQ_ENTRY(mfi_aen) aen_link;
160249d29c8SSascha Wildner 	struct proc			*p;
161249d29c8SSascha Wildner };
162249d29c8SSascha Wildner 
163590ba11dSSascha Wildner struct mfi_skinny_dma_info {
164590ba11dSSascha Wildner 	bus_dma_tag_t	dmat[514];
165590ba11dSSascha Wildner 	bus_dmamap_t	dmamap[514];
166590ba11dSSascha Wildner 	uint32_t	mem[514];
167590ba11dSSascha Wildner 	int		noofmaps;
168590ba11dSSascha Wildner };
169590ba11dSSascha Wildner 
170590ba11dSSascha Wildner struct mfi_cmd_tbolt;
171590ba11dSSascha Wildner typedef struct {
172590ba11dSSascha Wildner 	volatile unsigned int val;
173590ba11dSSascha Wildner } atomic_t;
174590ba11dSSascha Wildner 
175590ba11dSSascha Wildner #define	atomic_read(v)	((v)->val)
176590ba11dSSascha Wildner #define	atomic_set(v,i)	((v)->val - (i))
177590ba11dSSascha Wildner 
178249d29c8SSascha Wildner struct mfi_softc {
179249d29c8SSascha Wildner 	device_t			mfi_dev;
180249d29c8SSascha Wildner 	int				mfi_flags;
181249d29c8SSascha Wildner #define MFI_FLAGS_SG64		(1<<0)
182249d29c8SSascha Wildner #define MFI_FLAGS_QFRZN		(1<<1)
183249d29c8SSascha Wildner #define MFI_FLAGS_OPEN		(1<<2)
184249d29c8SSascha Wildner #define MFI_FLAGS_STOP		(1<<3)
185249d29c8SSascha Wildner #define MFI_FLAGS_1064R		(1<<4)
186249d29c8SSascha Wildner #define MFI_FLAGS_1078		(1<<5)
187249d29c8SSascha Wildner #define MFI_FLAGS_GEN2		(1<<6)
18817566092SSascha Wildner #define MFI_FLAGS_SKINNY	(1<<7)
189590ba11dSSascha Wildner #define MFI_FLAGS_TBOLT		(1<<8)
190590ba11dSSascha Wildner 	// Start: LSIP200113393
191590ba11dSSascha Wildner 	bus_dma_tag_t			verbuf_h_dmat;
192590ba11dSSascha Wildner 	bus_dmamap_t			verbuf_h_dmamap;
193590ba11dSSascha Wildner 	uint32_t			verbuf_h_busaddr;
194590ba11dSSascha Wildner 	uint32_t			*verbuf;
195590ba11dSSascha Wildner 	void				*kbuff_arr[MAX_IOCTL_SGE];
196590ba11dSSascha Wildner 	bus_dma_tag_t			mfi_kbuff_arr_dmat[2];
197590ba11dSSascha Wildner 	bus_dmamap_t			mfi_kbuff_arr_dmamap[2];
198590ba11dSSascha Wildner 	bus_addr_t			mfi_kbuff_arr_busaddr[2];
199249d29c8SSascha Wildner 
200249d29c8SSascha Wildner 	struct mfi_hwcomms		*mfi_comms;
201249d29c8SSascha Wildner 	TAILQ_HEAD(,mfi_command)	mfi_free;
202249d29c8SSascha Wildner 	TAILQ_HEAD(,mfi_command)	mfi_ready;
203590ba11dSSascha Wildner 	TAILQ_HEAD(BUSYQ,mfi_command)	mfi_busy;
204249d29c8SSascha Wildner 	struct bio_queue_head		mfi_bioq;
205249d29c8SSascha Wildner 	struct mfi_qstat		mfi_qstat[MFIQ_COUNT];
206249d29c8SSascha Wildner 
207249d29c8SSascha Wildner 	struct resource			*mfi_regs_resource;
208249d29c8SSascha Wildner 	bus_space_handle_t		mfi_bhandle;
209249d29c8SSascha Wildner 	bus_space_tag_t			mfi_btag;
210249d29c8SSascha Wildner 	int				mfi_regs_rid;
211249d29c8SSascha Wildner 
212249d29c8SSascha Wildner 	bus_dma_tag_t			mfi_parent_dmat;
213249d29c8SSascha Wildner 	bus_dma_tag_t			mfi_buffer_dmat;
214249d29c8SSascha Wildner 
215249d29c8SSascha Wildner 	bus_dma_tag_t			mfi_comms_dmat;
216249d29c8SSascha Wildner 	bus_dmamap_t			mfi_comms_dmamap;
217590ba11dSSascha Wildner 	bus_addr_t			mfi_comms_busaddr;
218249d29c8SSascha Wildner 
219249d29c8SSascha Wildner 	bus_dma_tag_t			mfi_frames_dmat;
220249d29c8SSascha Wildner 	bus_dmamap_t			mfi_frames_dmamap;
221590ba11dSSascha Wildner 	bus_addr_t			mfi_frames_busaddr;
222249d29c8SSascha Wildner 	union mfi_frame			*mfi_frames;
223249d29c8SSascha Wildner 
224590ba11dSSascha Wildner 	bus_dma_tag_t			mfi_tb_init_dmat;
225590ba11dSSascha Wildner 	bus_dmamap_t			mfi_tb_init_dmamap;
226590ba11dSSascha Wildner 	bus_addr_t			mfi_tb_init_busaddr;
227590ba11dSSascha Wildner 	bus_addr_t			mfi_tb_ioc_init_busaddr;
228590ba11dSSascha Wildner 	union mfi_frame			*mfi_tb_init;
229590ba11dSSascha Wildner 
230590ba11dSSascha Wildner 	TAILQ_HEAD(,mfi_evt_queue_elm)	mfi_evt_queue;
231590ba11dSSascha Wildner 	struct task			mfi_evt_task;
232249d29c8SSascha Wildner 	TAILQ_HEAD(,mfi_aen)		mfi_aen_pids;
233249d29c8SSascha Wildner 	struct mfi_command		*mfi_aen_cm;
23417566092SSascha Wildner 	struct mfi_command		*mfi_skinny_cm;
235249d29c8SSascha Wildner 	uint32_t			mfi_aen_triggered;
236249d29c8SSascha Wildner 	uint32_t			mfi_poll_waiting;
237249d29c8SSascha Wildner 	struct kqinfo			mfi_kq;
238590ba11dSSascha Wildner 	uint32_t			mfi_boot_seq_num;
239249d29c8SSascha Wildner 	int				mfi_delete_busy_volumes;
240249d29c8SSascha Wildner 	int				mfi_keep_deleted_volumes;
241249d29c8SSascha Wildner 	int				mfi_detaching;
242249d29c8SSascha Wildner 
243249d29c8SSascha Wildner 	bus_dma_tag_t			mfi_sense_dmat;
244249d29c8SSascha Wildner 	bus_dmamap_t			mfi_sense_dmamap;
245249d29c8SSascha Wildner 	uint32_t			mfi_sense_busaddr;
246249d29c8SSascha Wildner 	struct mfi_sense		*mfi_sense;
247249d29c8SSascha Wildner 
248249d29c8SSascha Wildner 	struct resource			*mfi_irq;
249249d29c8SSascha Wildner 	void				*mfi_intr;
250249d29c8SSascha Wildner 	int				mfi_irq_rid;
25151d4c641SSascha Wildner 	int				mfi_irq_type;
252249d29c8SSascha Wildner 
253249d29c8SSascha Wildner 	struct intr_config_hook		mfi_ich;
254249d29c8SSascha Wildner 	eventhandler_tag		eh;
255590ba11dSSascha Wildner 	/* OCR flags */
256590ba11dSSascha Wildner 	atomic_t fw_reset_no_pci_access;
257590ba11dSSascha Wildner 	uint8_t adpreset;
258590ba11dSSascha Wildner 	uint8_t issuepend_done;
259590ba11dSSascha Wildner 	uint8_t disableOnlineCtrlReset;
260590ba11dSSascha Wildner 	uint32_t mfiStatus;
261590ba11dSSascha Wildner 	uint32_t last_seq_num;
262590ba11dSSascha Wildner 	uint32_t volatile hw_crit_error;
263249d29c8SSascha Wildner 
264249d29c8SSascha Wildner 	/*
265249d29c8SSascha Wildner 	 * Allocation for the command array.  Used as an indexable array to
266249d29c8SSascha Wildner 	 * recover completed commands.
267249d29c8SSascha Wildner 	 */
268249d29c8SSascha Wildner 	struct mfi_command		*mfi_commands;
269249d29c8SSascha Wildner 	/*
270249d29c8SSascha Wildner 	 * How many commands were actually allocated
271249d29c8SSascha Wildner 	 */
272249d29c8SSascha Wildner 	int				mfi_total_cmds;
273249d29c8SSascha Wildner 	/*
274249d29c8SSascha Wildner 	 * How many commands the firmware can handle.  Also how big the reply
275249d29c8SSascha Wildner 	 * queue is, minus 1.
276249d29c8SSascha Wildner 	 */
277249d29c8SSascha Wildner 	int				mfi_max_fw_cmds;
278249d29c8SSascha Wildner 	/*
279249d29c8SSascha Wildner 	 * How many S/G elements we'll ever actually use
280249d29c8SSascha Wildner 	 */
281249d29c8SSascha Wildner 	int				mfi_max_sge;
282249d29c8SSascha Wildner 	/*
283249d29c8SSascha Wildner 	 * How many bytes a compound frame is, including all of the extra frames
284249d29c8SSascha Wildner 	 * that are used for S/G elements.
285249d29c8SSascha Wildner 	 */
286249d29c8SSascha Wildner 	int				mfi_cmd_size;
287249d29c8SSascha Wildner 	/*
288249d29c8SSascha Wildner 	 * How large an S/G element is.  Used to calculate the number of single
289249d29c8SSascha Wildner 	 * frames in a command.
290249d29c8SSascha Wildner 	 */
291249d29c8SSascha Wildner 	int				mfi_sge_size;
292249d29c8SSascha Wildner 	/*
293249d29c8SSascha Wildner 	 * Max number of sectors that the firmware allows
294249d29c8SSascha Wildner 	 */
295249d29c8SSascha Wildner 	uint32_t			mfi_max_io;
296249d29c8SSascha Wildner 
297249d29c8SSascha Wildner 	TAILQ_HEAD(,mfi_disk)		mfi_ld_tqh;
29817566092SSascha Wildner 	TAILQ_HEAD(,mfi_system_pd)	mfi_syspd_tqh;
299249d29c8SSascha Wildner 	eventhandler_tag		mfi_eh;
300249d29c8SSascha Wildner 	struct cdev			*mfi_cdev;
301249d29c8SSascha Wildner 
302249d29c8SSascha Wildner 	TAILQ_HEAD(, ccb_hdr)		mfi_cam_ccbq;
303249d29c8SSascha Wildner 	struct mfi_command *		(* mfi_cam_start)(void *);
304249d29c8SSascha Wildner 	struct callout			mfi_watchdog_callout;
305249d29c8SSascha Wildner 	struct lock			mfi_io_lock;
306249d29c8SSascha Wildner 	struct lock			mfi_config_lock;
307249d29c8SSascha Wildner 
308249d29c8SSascha Wildner 	/* Controller type specific interfaces */
309249d29c8SSascha Wildner 	void	(*mfi_enable_intr)(struct mfi_softc *sc);
310590ba11dSSascha Wildner 	void	(*mfi_disable_intr)(struct mfi_softc *sc);
311249d29c8SSascha Wildner 	int32_t	(*mfi_read_fw_status)(struct mfi_softc *sc);
312249d29c8SSascha Wildner 	int	(*mfi_check_clear_intr)(struct mfi_softc *sc);
313590ba11dSSascha Wildner 	void	(*mfi_issue_cmd)(struct mfi_softc *sc, bus_addr_t bus_add,
314590ba11dSSascha Wildner 		    uint32_t frame_cnt);
315590ba11dSSascha Wildner 	int	(*mfi_adp_reset)(struct mfi_softc *sc);
316590ba11dSSascha Wildner 	int	(*mfi_adp_check_reset)(struct mfi_softc *sc);
317590ba11dSSascha Wildner 
318590ba11dSSascha Wildner 	/* ThunderBolt */
319590ba11dSSascha Wildner 	uint32_t			mfi_tbolt;
320590ba11dSSascha Wildner 	uint32_t			MFA_enabled;
321590ba11dSSascha Wildner 	uint64_t			map_id;
322590ba11dSSascha Wildner 	struct mfi_command 		*map_update_cmd;
323590ba11dSSascha Wildner 	/* Single Reply structure size */
324590ba11dSSascha Wildner 	uint16_t			reply_size;
325590ba11dSSascha Wildner 	/* Singler message size. */
326590ba11dSSascha Wildner 	uint16_t			raid_io_msg_size;
327590ba11dSSascha Wildner 	TAILQ_HEAD(TB, mfi_cmd_tbolt)	mfi_cmd_tbolt_tqh;
328590ba11dSSascha Wildner 	/* ThunderBolt base contiguous memory mapping. */
329590ba11dSSascha Wildner 	bus_dma_tag_t			mfi_tb_dmat;
330590ba11dSSascha Wildner 	bus_dmamap_t			mfi_tb_dmamap;
331590ba11dSSascha Wildner 	bus_addr_t			mfi_tb_busaddr;
332590ba11dSSascha Wildner 	/* ThunderBolt Contiguous DMA memory Mapping */
333590ba11dSSascha Wildner 	uint8_t	*			request_message_pool;
334590ba11dSSascha Wildner 	uint8_t *			request_message_pool_align;
335590ba11dSSascha Wildner 	uint8_t *			request_desc_pool;
336590ba11dSSascha Wildner 	//uint32_t			request_desc_busaddr;
337590ba11dSSascha Wildner 	bus_addr_t			request_msg_busaddr;
338590ba11dSSascha Wildner 	bus_addr_t			reply_frame_busaddr;
339590ba11dSSascha Wildner 	bus_addr_t			sg_frame_busaddr;
340590ba11dSSascha Wildner 	/* ThunderBolt IOC Init Descriptor */
341590ba11dSSascha Wildner 	bus_dma_tag_t			mfi_tb_ioc_init_dmat;
342590ba11dSSascha Wildner 	bus_dmamap_t			mfi_tb_ioc_init_dmamap;
343590ba11dSSascha Wildner 	uint8_t *			mfi_tb_ioc_init_desc;
344590ba11dSSascha Wildner 	struct mfi_cmd_tbolt		**mfi_cmd_pool_tbolt;
345590ba11dSSascha Wildner 	/* Virtual address of reply Frame Pool */
346590ba11dSSascha Wildner 	struct mfi_mpi2_reply_header*	reply_frame_pool;
347590ba11dSSascha Wildner 	struct mfi_mpi2_reply_header*	reply_frame_pool_align;
348590ba11dSSascha Wildner 
349590ba11dSSascha Wildner 	/* Last reply frame address */
350590ba11dSSascha Wildner 	uint8_t *			reply_pool_limit;
351590ba11dSSascha Wildner 	uint16_t			last_reply_idx;
352590ba11dSSascha Wildner 	uint8_t				max_SGEs_in_chain_message;
353590ba11dSSascha Wildner 	uint8_t				max_SGEs_in_main_message;
354590ba11dSSascha Wildner 	uint8_t				chain_offset_value_for_main_message;
355590ba11dSSascha Wildner 	uint8_t				chain_offset_value_for_mpt_ptmsg;
356590ba11dSSascha Wildner };
357590ba11dSSascha Wildner 
358590ba11dSSascha Wildner union desc_value {
359590ba11dSSascha Wildner 	uint64_t	word;
360590ba11dSSascha Wildner 	struct {
361590ba11dSSascha Wildner 		uint32_t	low;
362590ba11dSSascha Wildner 		uint32_t	high;
363590ba11dSSascha Wildner 	}u;
364590ba11dSSascha Wildner };
365590ba11dSSascha Wildner 
366590ba11dSSascha Wildner // TODO find the right definition
367590ba11dSSascha Wildner #define XXX_MFI_CMD_OP_INIT2                    0x9
368590ba11dSSascha Wildner /*
369590ba11dSSascha Wildner  * Request descriptor types
370590ba11dSSascha Wildner  */
371590ba11dSSascha Wildner #define MFI_REQ_DESCRIPT_FLAGS_LD_IO           0x7
372590ba11dSSascha Wildner #define MFI_REQ_DESCRIPT_FLAGS_MFA             0x1
373590ba11dSSascha Wildner #define MFI_REQ_DESCRIPT_FLAGS_TYPE_SHIFT	0x1
374590ba11dSSascha Wildner #define MFI_FUSION_FP_DEFAULT_TIMEOUT		0x14
375590ba11dSSascha Wildner #define MFI_LOAD_BALANCE_FLAG			0x1
376590ba11dSSascha Wildner #define MFI_DCMD_MBOX_PEND_FLAG			0x1
377590ba11dSSascha Wildner 
378590ba11dSSascha Wildner //#define MR_PROT_INFO_TYPE_CONTROLLER	0x08
379590ba11dSSascha Wildner #define	MEGASAS_SCSI_VARIABLE_LENGTH_CMD	0x7f
380590ba11dSSascha Wildner #define MEGASAS_SCSI_SERVICE_ACTION_READ32	0x9
381590ba11dSSascha Wildner #define MEGASAS_SCSI_SERVICE_ACTION_WRITE32	0xB
382590ba11dSSascha Wildner #define	MEGASAS_SCSI_ADDL_CDB_LEN   		0x18
383590ba11dSSascha Wildner #define MEGASAS_RD_WR_PROTECT_CHECK_ALL		0x20
384590ba11dSSascha Wildner #define MEGASAS_RD_WR_PROTECT_CHECK_NONE	0x60
385590ba11dSSascha Wildner #define MEGASAS_EEDPBLOCKSIZE			512
386590ba11dSSascha Wildner struct mfi_cmd_tbolt {
387590ba11dSSascha Wildner 	union mfi_mpi2_request_descriptor *request_desc;
388590ba11dSSascha Wildner 	struct mfi_mpi2_request_raid_scsi_io *io_request;
389590ba11dSSascha Wildner 	bus_addr_t		io_request_phys_addr;
390590ba11dSSascha Wildner 	bus_addr_t		sg_frame_phys_addr;
391590ba11dSSascha Wildner 	bus_addr_t 		sense_phys_addr;
392590ba11dSSascha Wildner 	MPI2_SGE_IO_UNION	*sg_frame;
393590ba11dSSascha Wildner 	uint8_t			*sense;
394590ba11dSSascha Wildner 	TAILQ_ENTRY(mfi_cmd_tbolt) next;
395590ba11dSSascha Wildner 	/*
396590ba11dSSascha Wildner 	 * Context for a MFI frame.
397590ba11dSSascha Wildner 	 * Used to get the mfi cmd from list when a MFI cmd is completed
398590ba11dSSascha Wildner 	 */
399590ba11dSSascha Wildner 	uint32_t		sync_cmd_idx;
400590ba11dSSascha Wildner 	uint16_t		index;
401590ba11dSSascha Wildner 	uint8_t			status;
402249d29c8SSascha Wildner };
403249d29c8SSascha Wildner 
404249d29c8SSascha Wildner extern int mfi_attach(struct mfi_softc *);
405249d29c8SSascha Wildner extern void mfi_free(struct mfi_softc *);
406249d29c8SSascha Wildner extern int mfi_shutdown(struct mfi_softc *);
407249d29c8SSascha Wildner extern void mfi_startio(struct mfi_softc *);
408249d29c8SSascha Wildner extern void mfi_disk_complete(struct bio *);
409249d29c8SSascha Wildner extern int mfi_disk_disable(struct mfi_disk *);
410249d29c8SSascha Wildner extern void mfi_disk_enable(struct mfi_disk *);
411249d29c8SSascha Wildner extern int mfi_dump_blocks(struct mfi_softc *, int id, uint64_t, void *, int);
41217566092SSascha Wildner extern int mfi_syspd_disable(struct mfi_system_pd *);
41317566092SSascha Wildner extern void mfi_syspd_enable(struct mfi_system_pd *);
414590ba11dSSascha Wildner extern int mfi_dump_syspd_blocks(struct mfi_softc *, int id, uint64_t, void *,
415590ba11dSSascha Wildner     int);
416590ba11dSSascha Wildner extern int mfi_transition_firmware(struct mfi_softc *sc);
417590ba11dSSascha Wildner extern int mfi_aen_setup(struct mfi_softc *sc, uint32_t seq_start);
418590ba11dSSascha Wildner extern void mfi_complete(struct mfi_softc *sc, struct mfi_command *cm);
419590ba11dSSascha Wildner extern int mfi_mapcmd(struct mfi_softc *sc,struct mfi_command *cm);
420590ba11dSSascha Wildner extern int mfi_wait_command(struct mfi_softc *sc, struct mfi_command *cm);
421590ba11dSSascha Wildner extern void mfi_tbolt_enable_intr_ppc(struct mfi_softc *);
422590ba11dSSascha Wildner extern void mfi_tbolt_disable_intr_ppc(struct mfi_softc *);
423590ba11dSSascha Wildner extern int32_t mfi_tbolt_read_fw_status_ppc(struct mfi_softc *);
424590ba11dSSascha Wildner extern int32_t mfi_tbolt_check_clear_intr_ppc(struct mfi_softc *);
425590ba11dSSascha Wildner extern void mfi_tbolt_issue_cmd_ppc(struct mfi_softc *, bus_addr_t, uint32_t);
426590ba11dSSascha Wildner extern void mfi_tbolt_init_globals(struct mfi_softc*);
427590ba11dSSascha Wildner extern uint32_t mfi_tbolt_get_memory_requirement(struct mfi_softc *);
428590ba11dSSascha Wildner extern int mfi_tbolt_init_desc_pool(struct mfi_softc *, uint8_t *, uint32_t);
429590ba11dSSascha Wildner extern int mfi_tbolt_init_MFI_queue(struct mfi_softc *);
430590ba11dSSascha Wildner extern void mfi_intr_tbolt(void *arg);
431590ba11dSSascha Wildner extern int mfi_tbolt_alloc_cmd(struct mfi_softc *sc);
432590ba11dSSascha Wildner extern int mfi_tbolt_send_frame(struct mfi_softc *sc, struct mfi_command *cm);
433590ba11dSSascha Wildner extern int mfi_tbolt_adp_reset(struct mfi_softc *sc);
434590ba11dSSascha Wildner extern int mfi_tbolt_reset(struct mfi_softc *sc);
435590ba11dSSascha Wildner extern int mfi_tbolt_sync_map_info(struct mfi_softc *sc);
436249d29c8SSascha Wildner 
437249d29c8SSascha Wildner #define MFIQ_ADD(sc, qname)					\
438249d29c8SSascha Wildner 	do {							\
439249d29c8SSascha Wildner 		struct mfi_qstat *qs;				\
440249d29c8SSascha Wildner 								\
441249d29c8SSascha Wildner 		qs = &(sc)->mfi_qstat[qname];			\
442249d29c8SSascha Wildner 		qs->q_length++;					\
443249d29c8SSascha Wildner 		if (qs->q_length > qs->q_max)			\
444249d29c8SSascha Wildner 			qs->q_max = qs->q_length;		\
445249d29c8SSascha Wildner 	} while (0)
446249d29c8SSascha Wildner 
447249d29c8SSascha Wildner #define MFIQ_REMOVE(sc, qname)	(sc)->mfi_qstat[qname].q_length--
448249d29c8SSascha Wildner 
449249d29c8SSascha Wildner #define MFIQ_INIT(sc, qname)					\
450249d29c8SSascha Wildner 	do {							\
451249d29c8SSascha Wildner 		sc->mfi_qstat[qname].q_length = 0;		\
452249d29c8SSascha Wildner 		sc->mfi_qstat[qname].q_max = 0;			\
453249d29c8SSascha Wildner 	} while (0)
454249d29c8SSascha Wildner 
455249d29c8SSascha Wildner #define MFIQ_COMMAND_QUEUE(name, index)					\
456249d29c8SSascha Wildner 	static __inline void						\
457249d29c8SSascha Wildner 	mfi_initq_ ## name (struct mfi_softc *sc)			\
458249d29c8SSascha Wildner 	{								\
459249d29c8SSascha Wildner 		TAILQ_INIT(&sc->mfi_ ## name);				\
460249d29c8SSascha Wildner 		MFIQ_INIT(sc, index);					\
461249d29c8SSascha Wildner 	}								\
462249d29c8SSascha Wildner 	static __inline void						\
463249d29c8SSascha Wildner 	mfi_enqueue_ ## name (struct mfi_command *cm)			\
464249d29c8SSascha Wildner 	{								\
465249d29c8SSascha Wildner 		if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {		\
466249d29c8SSascha Wildner 			kprintf("command %p is on another queue, "	\
467249d29c8SSascha Wildner 			    "flags = %#x\n", cm, cm->cm_flags);		\
468249d29c8SSascha Wildner 			panic("command is on another queue");		\
469249d29c8SSascha Wildner 		}							\
470249d29c8SSascha Wildner 		TAILQ_INSERT_TAIL(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
471249d29c8SSascha Wildner 		cm->cm_flags |= MFI_ON_ ## index;			\
472249d29c8SSascha Wildner 		MFIQ_ADD(cm->cm_sc, index);				\
473249d29c8SSascha Wildner 	}								\
474249d29c8SSascha Wildner 	static __inline void						\
475249d29c8SSascha Wildner 	mfi_requeue_ ## name (struct mfi_command *cm)			\
476249d29c8SSascha Wildner 	{								\
477249d29c8SSascha Wildner 		if ((cm->cm_flags & MFI_ON_MFIQ_MASK) != 0) {		\
478249d29c8SSascha Wildner 			kprintf("command %p is on another queue, "	\
479249d29c8SSascha Wildner 			    "flags = %#x\n", cm, cm->cm_flags);		\
480249d29c8SSascha Wildner 			panic("command is on another queue");		\
481249d29c8SSascha Wildner 		}							\
482249d29c8SSascha Wildner 		TAILQ_INSERT_HEAD(&cm->cm_sc->mfi_ ## name, cm, cm_link); \
483249d29c8SSascha Wildner 		cm->cm_flags |= MFI_ON_ ## index;			\
484249d29c8SSascha Wildner 		MFIQ_ADD(cm->cm_sc, index);				\
485249d29c8SSascha Wildner 	}								\
486249d29c8SSascha Wildner 	static __inline struct mfi_command *				\
487249d29c8SSascha Wildner 	mfi_dequeue_ ## name (struct mfi_softc *sc)			\
488249d29c8SSascha Wildner 	{								\
489249d29c8SSascha Wildner 		struct mfi_command *cm;					\
490249d29c8SSascha Wildner 									\
491249d29c8SSascha Wildner 		if ((cm = TAILQ_FIRST(&sc->mfi_ ## name)) != NULL) {	\
492249d29c8SSascha Wildner 			if ((cm->cm_flags & MFI_ON_ ## index) == 0) {	\
493249d29c8SSascha Wildner 				kprintf("command %p not in queue, "	\
494249d29c8SSascha Wildner 				    "flags = %#x, bit = %#x\n", cm,	\
495249d29c8SSascha Wildner 				    cm->cm_flags, MFI_ON_ ## index);	\
496249d29c8SSascha Wildner 				panic("command not in queue");		\
497249d29c8SSascha Wildner 			}						\
498249d29c8SSascha Wildner 			TAILQ_REMOVE(&sc->mfi_ ## name, cm, cm_link);	\
499249d29c8SSascha Wildner 			cm->cm_flags &= ~MFI_ON_ ## index;		\
500249d29c8SSascha Wildner 			MFIQ_REMOVE(sc, index);				\
501249d29c8SSascha Wildner 		}							\
502249d29c8SSascha Wildner 		return (cm);						\
503249d29c8SSascha Wildner 	}								\
504249d29c8SSascha Wildner 	static __inline void						\
505249d29c8SSascha Wildner 	mfi_remove_ ## name (struct mfi_command *cm)			\
506249d29c8SSascha Wildner 	{								\
507249d29c8SSascha Wildner 		if ((cm->cm_flags & MFI_ON_ ## index) == 0) {		\
508249d29c8SSascha Wildner 			kprintf("command %p not in queue, flags = %#x, " \
509249d29c8SSascha Wildner 			    "bit = %#x\n", cm, cm->cm_flags,		\
510249d29c8SSascha Wildner 			    MFI_ON_ ## index);				\
511249d29c8SSascha Wildner 			panic("command not in queue");			\
512249d29c8SSascha Wildner 		}							\
513249d29c8SSascha Wildner 		TAILQ_REMOVE(&cm->cm_sc->mfi_ ## name, cm, cm_link);	\
514249d29c8SSascha Wildner 		cm->cm_flags &= ~MFI_ON_ ## index;			\
515249d29c8SSascha Wildner 		MFIQ_REMOVE(cm->cm_sc, index);				\
516249d29c8SSascha Wildner 	}								\
517249d29c8SSascha Wildner struct hack
518249d29c8SSascha Wildner 
519249d29c8SSascha Wildner MFIQ_COMMAND_QUEUE(free, MFIQ_FREE);
520249d29c8SSascha Wildner MFIQ_COMMAND_QUEUE(ready, MFIQ_READY);
521249d29c8SSascha Wildner MFIQ_COMMAND_QUEUE(busy, MFIQ_BUSY);
522249d29c8SSascha Wildner 
523249d29c8SSascha Wildner static __inline void
mfi_initq_bio(struct mfi_softc * sc)524249d29c8SSascha Wildner mfi_initq_bio(struct mfi_softc *sc)
525249d29c8SSascha Wildner {
526249d29c8SSascha Wildner 	bioq_init(&sc->mfi_bioq);
527249d29c8SSascha Wildner 	MFIQ_INIT(sc, MFIQ_BIO);
528249d29c8SSascha Wildner }
529249d29c8SSascha Wildner 
530249d29c8SSascha Wildner static __inline void
mfi_enqueue_bio(struct mfi_softc * sc,struct bio * bp)531249d29c8SSascha Wildner mfi_enqueue_bio(struct mfi_softc *sc, struct bio *bp)
532249d29c8SSascha Wildner {
533249d29c8SSascha Wildner 	bioq_insert_tail(&sc->mfi_bioq, bp);
534249d29c8SSascha Wildner 	MFIQ_ADD(sc, MFIQ_BIO);
535249d29c8SSascha Wildner }
536249d29c8SSascha Wildner 
537249d29c8SSascha Wildner static __inline struct bio *
mfi_dequeue_bio(struct mfi_softc * sc)538249d29c8SSascha Wildner mfi_dequeue_bio(struct mfi_softc *sc)
539249d29c8SSascha Wildner {
540249d29c8SSascha Wildner 	struct bio *bp;
541249d29c8SSascha Wildner 
542249d29c8SSascha Wildner 	if ((bp = bioq_first(&sc->mfi_bioq)) != NULL) {
543249d29c8SSascha Wildner 		bioq_remove(&sc->mfi_bioq, bp);
544249d29c8SSascha Wildner 		MFIQ_REMOVE(sc, MFIQ_BIO);
545249d29c8SSascha Wildner 	}
546249d29c8SSascha Wildner 	return (bp);
547249d29c8SSascha Wildner }
548249d29c8SSascha Wildner 
549249d29c8SSascha Wildner static __inline void
mfi_print_sense(struct mfi_softc * sc,void * sense)550249d29c8SSascha Wildner mfi_print_sense(struct mfi_softc *sc, void *sense)
551249d29c8SSascha Wildner {
552249d29c8SSascha Wildner 	int error, key, asc, ascq;
553249d29c8SSascha Wildner 
554249d29c8SSascha Wildner 	scsi_extract_sense((struct scsi_sense_data *)sense,
555249d29c8SSascha Wildner 	    &error, &key, &asc, &ascq);
556249d29c8SSascha Wildner 	device_printf(sc->mfi_dev, "sense error %d, sense_key %d, "
557249d29c8SSascha Wildner 	    "asc %d, ascq %d\n", error, key, asc, ascq);
558249d29c8SSascha Wildner }
559249d29c8SSascha Wildner 
560148e9c0bSSascha Wildner /* XXX
561148e9c0bSSascha Wildner  *
562148e9c0bSSascha Wildner  * Mimics FreeBSD's mtx_assert() behavior.
563148e9c0bSSascha Wildner  * We might want a global lockassert() function in the future.
564148e9c0bSSascha Wildner  */
565148e9c0bSSascha Wildner static __inline void
mfi_lockassert(struct lock * lockp)566148e9c0bSSascha Wildner mfi_lockassert(struct lock *lockp)
567148e9c0bSSascha Wildner {
568148e9c0bSSascha Wildner 	if (panicstr == NULL && !dumping)
569148e9c0bSSascha Wildner 		KKASSERT(lockstatus(lockp, curthread) != 0);
570148e9c0bSSascha Wildner }
571249d29c8SSascha Wildner 
572249d29c8SSascha Wildner #define MFI_WRITE4(sc, reg, val)	bus_space_write_4((sc)->mfi_btag, \
573249d29c8SSascha Wildner 	sc->mfi_bhandle, (reg), (val))
574249d29c8SSascha Wildner #define MFI_READ4(sc, reg)		bus_space_read_4((sc)->mfi_btag, \
575249d29c8SSascha Wildner 	(sc)->mfi_bhandle, (reg))
576249d29c8SSascha Wildner #define MFI_WRITE2(sc, reg, val)	bus_space_write_2((sc)->mfi_btag, \
577249d29c8SSascha Wildner 	sc->mfi_bhandle, (reg), (val))
578249d29c8SSascha Wildner #define MFI_READ2(sc, reg)		bus_space_read_2((sc)->mfi_btag, \
579249d29c8SSascha Wildner 	(sc)->mfi_bhandle, (reg))
580249d29c8SSascha Wildner #define MFI_WRITE1(sc, reg, val)	bus_space_write_1((sc)->mfi_btag, \
581249d29c8SSascha Wildner 	sc->mfi_bhandle, (reg), (val))
582249d29c8SSascha Wildner #define MFI_READ1(sc, reg)		bus_space_read_1((sc)->mfi_btag, \
583249d29c8SSascha Wildner 	(sc)->mfi_bhandle, (reg))
584249d29c8SSascha Wildner 
585*805c8e8eSzrj #ifdef MALLOC_DECLARE
586249d29c8SSascha Wildner MALLOC_DECLARE(M_MFIBUF);
587*805c8e8eSzrj #endif
588249d29c8SSascha Wildner 
589590ba11dSSascha Wildner #define MFI_RESET_WAIT_TIME 180
590249d29c8SSascha Wildner #define MFI_CMD_TIMEOUT 30
59117566092SSascha Wildner #define SKINNY_MEMORY 0x02000000
592590ba11dSSascha Wildner #define MFI_MAXPHYS (128 * 1024)
593249d29c8SSascha Wildner 
594249d29c8SSascha Wildner #ifdef MFI_DEBUG
595249d29c8SSascha Wildner extern void mfi_print_cmd(struct mfi_command *cm);
596249d29c8SSascha Wildner extern void mfi_dump_cmds(struct mfi_softc *sc);
597249d29c8SSascha Wildner extern void mfi_validate_sg(struct mfi_softc *, struct mfi_command *, const char *, int );
598249d29c8SSascha Wildner #define MFI_PRINT_CMD(cm)	mfi_print_cmd(cm)
599249d29c8SSascha Wildner #define MFI_DUMP_CMDS(sc)	mfi_dump_cmds(sc)
6007fd4e1a1SSascha Wildner #define MFI_VALIDATE_CMD(sc, cm) mfi_validate_sg(sc, cm, __func__, __LINE__)
601249d29c8SSascha Wildner #else
602249d29c8SSascha Wildner #define MFI_PRINT_CMD(cm)
603249d29c8SSascha Wildner #define MFI_DUMP_CMDS(sc)
604249d29c8SSascha Wildner #define MFI_VALIDATE_CMD(sc, cm)
605249d29c8SSascha Wildner #endif
606249d29c8SSascha Wildner 
607249d29c8SSascha Wildner extern void mfi_release_command(struct mfi_command *cm);
608249d29c8SSascha Wildner 
609249d29c8SSascha Wildner #endif /* _MFIVAR_H */
610