xref: /freebsd/sys/dev/mps/mps_sas.h (revision 9268022b74279434ed6300244e3f977e56a8ceb5)
1 /*-
2  * Copyright (c) 2011, 2012 LSI Corp.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  *
26  * LSI MPT-Fusion Host Adapter FreeBSD
27  *
28  * $FreeBSD$
29  */
30 
31 struct mps_fw_event_work;
32 
33 struct mpssas_lun {
34 	SLIST_ENTRY(mpssas_lun) lun_link;
35 	lun_id_t	lun_id;
36 	uint8_t		eedp_formatted;
37 	uint32_t	eedp_block_size;
38 	uint8_t		stop_at_shutdown;
39 };
40 
41 struct mpssas_target {
42 	uint16_t	handle;
43 	uint8_t		linkrate;
44 	uint64_t	devname;
45 	uint32_t	devinfo;
46 	uint16_t	encl_handle;
47 	uint16_t	encl_slot;
48 	uint8_t		flags;
49 #define MPSSAS_TARGET_INABORT	(1 << 0)
50 #define MPSSAS_TARGET_INRESET	(1 << 1)
51 #define MPSSAS_TARGET_INDIAGRESET (1 << 2)
52 #define MPSSAS_TARGET_INREMOVAL	(1 << 3)
53 #define MPS_TARGET_FLAGS_RAID_COMPONENT (1 << 4)
54 #define MPS_TARGET_FLAGS_VOLUME         (1 << 5)
55 #define MPSSAS_TARGET_INRECOVERY (MPSSAS_TARGET_INABORT | \
56     MPSSAS_TARGET_INRESET | MPSSAS_TARGET_INCHIPRESET)
57 
58 #define MPSSAS_TARGET_ADD       (1 << 29)
59 #define MPSSAS_TARGET_REMOVE    (1 << 30)
60 	uint16_t	tid;
61 	SLIST_HEAD(, mpssas_lun) luns;
62 	TAILQ_HEAD(, mps_command) commands;
63 	struct mps_command *tm;
64 	TAILQ_HEAD(, mps_command) timedout_commands;
65 	uint16_t        exp_dev_handle;
66 	uint16_t        phy_num;
67 	uint64_t	sasaddr;
68 	uint16_t	parent_handle;
69 	uint64_t	parent_sasaddr;
70 	uint32_t	parent_devinfo;
71 	struct sysctl_ctx_list sysctl_ctx;
72 	struct sysctl_oid *sysctl_tree;
73 	TAILQ_ENTRY(mpssas_target) sysctl_link;
74 	uint64_t        issued;
75 	uint64_t        completed;
76 	unsigned int    outstanding;
77 	unsigned int    timeouts;
78 	unsigned int    aborts;
79 	unsigned int    logical_unit_resets;
80 	unsigned int    target_resets;
81 };
82 
83 struct mpssas_softc {
84 	struct mps_softc	*sc;
85 	u_int			flags;
86 #define MPSSAS_IN_DISCOVERY	(1 << 0)
87 #define MPSSAS_IN_STARTUP	(1 << 1)
88 #define MPSSAS_DISCOVERY_TIMEOUT_PENDING	(1 << 2)
89 #define MPSSAS_QUEUE_FROZEN	(1 << 3)
90 #define	MPSSAS_SHUTDOWN		(1 << 4)
91 	u_int			maxtargets;
92 	struct mpssas_target	*targets;
93 	struct cam_devq		*devq;
94 	struct cam_sim		*sim;
95 	struct cam_path		*path;
96 	struct intr_config_hook	sas_ich;
97 	struct callout		discovery_callout;
98 	u_int			discovery_timeouts;
99 	struct mps_event_handle	*mpssas_eh;
100 
101 	u_int                   startup_refcount;
102 	u_int                   tm_count;
103 	struct proc             *sysctl_proc;
104 
105 	struct taskqueue	*ev_tq;
106 	struct task		ev_task;
107 	TAILQ_HEAD(, mps_fw_event_work)	ev_queue;
108 };
109 
110 MALLOC_DECLARE(M_MPSSAS);
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 MPS_SET_LUN(lun, ccblun)	\
117 	mpssas_set_lun(lun, ccblun)
118 
119 static __inline int
120 mpssas_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 
149 static __inline void
150 mpssas_set_ccbstatus(union ccb *ccb, int status)
151 {
152 	ccb->ccb_h.status &= ~CAM_STATUS_MASK;
153 	ccb->ccb_h.status |= status;
154 }
155 
156 static __inline int
157 mpssas_get_ccbstatus(union ccb *ccb)
158 {
159 	return (ccb->ccb_h.status & CAM_STATUS_MASK);
160 }
161 
162 #define MPS_SET_SINGLE_LUN(req, lun)	\
163 do {					\
164 	bzero((req)->LUN, 8);		\
165 	(req)->LUN[1] = lun;		\
166 } while(0)
167 
168 void mpssas_rescan_target(struct mps_softc *sc, struct mpssas_target *targ);
169 void mpssas_discovery_end(struct mpssas_softc *sassc);
170 void mpssas_startup_increment(struct mpssas_softc *sassc);
171 void mpssas_startup_decrement(struct mpssas_softc *sassc);
172 
173 void mpssas_firmware_event_work(void *arg, int pending);
174 int mpssas_check_id(struct mpssas_softc *sassc, int id);
175