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
31struct mpr_fw_event_work;
32
33struct 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
40struct 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
87struct 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_QUEUE_FROZEN	(1 << 3)
93#define	MPRSAS_TOREMOVE		(1 << 5)
94	u_int			maxtargets;
95	struct mprsas_target	*targets;
96	struct cam_devq		*devq;
97	struct cam_sim		*sim;
98	struct cam_path		*path;
99	struct intr_config_hook	sas_ich;
100	struct mpr_event_handle	*mprsas_eh;
101
102	u_int                   startup_refcount;
103	struct proc             *sysctl_proc;
104
105	struct taskqueue	*ev_tq;
106	struct task		ev_task;
107	TAILQ_HEAD(, mpr_fw_event_work)	ev_queue;
108};
109
110MALLOC_DECLARE(M_MPRSAS);
111
112/*
113 * Abstracted so that the driver can be backwards and forwards compatible
114 * with future versions of CAM that will provide this functionality.
115 */
116#define MPR_SET_LUN(lun, ccblun)	\
117	mprsas_set_lun(lun, ccblun)
118
119static __inline int
120mprsas_set_lun(uint8_t *lun, u_int ccblun)
121{
122	uint64_t *newlun;
123
124	newlun = (uint64_t *)lun;
125	*newlun = 0;
126	if (ccblun <= 0xff) {
127		/* Peripheral device address method, LUN is 0 to 255 */
128		lun[1] = ccblun;
129	} else if (ccblun <= 0x3fff) {
130		/* Flat space address method, LUN is <= 16383 */
131		scsi_ulto2b(ccblun, lun);
132		lun[0] |= 0x40;
133	} else if (ccblun <= 0xffffff) {
134		/* Extended flat space address method, LUN is <= 16777215 */
135		scsi_ulto3b(ccblun, &lun[1]);
136		/* Extended Flat space address method */
137		lun[0] = 0xc0;
138		/* Length = 1, i.e. LUN is 3 bytes long */
139		lun[0] |= 0x10;
140		/* Extended Address Method */
141		lun[0] |= 0x02;
142	} else {
143		return (EINVAL);
144	}
145
146	return (0);
147}
148
149static __inline void
150mprsas_set_ccbstatus(union ccb *ccb, int status)
151{
152	ccb->ccb_h.status &= ~CAM_STATUS_MASK;
153	ccb->ccb_h.status |= status;
154}
155
156static __inline int
157mprsas_get_ccbstatus(union ccb *ccb)
158{
159	return (ccb->ccb_h.status & CAM_STATUS_MASK);
160}
161
162#define MPR_SET_SINGLE_LUN(req, lun)	\
163do {					\
164	bzero((req)->LUN, 8);		\
165	(req)->LUN[1] = lun;		\
166} while(0)
167
168void mprsas_rescan_target(struct mpr_softc *sc, struct mprsas_target *targ);
169void mprsas_discovery_end(struct mprsas_softc *sassc);
170void mprsas_prepare_for_tm(struct mpr_softc *sc, struct mpr_command *tm,
171    struct mprsas_target *target, lun_id_t lun_id);
172void mprsas_startup_increment(struct mprsas_softc *sassc);
173void mprsas_startup_decrement(struct mprsas_softc *sassc);
174
175void mprsas_firmware_event_work(void *arg, int pending);
176int mprsas_check_id(struct mprsas_softc *sassc, int id);
177