• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2017-2019 Broadcom. All Rights Reserved. The term *
5  * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.     *
6  * Copyright (C) 2010-2015 Emulex.  All rights reserved.           *
7  * EMULEX and SLI are trademarks of Emulex.                        *
8  * www.broadcom.com                                                *
9  *                                                                 *
10  * This program is free software; you can redistribute it and/or   *
11  * modify it under the terms of version 2 of the GNU General       *
12  * Public License as published by the Free Software Foundation.    *
13  * This program is distributed in the hope that it will be useful. *
14  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
15  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
16  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
17  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
18  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
19  * more details, a copy of which can be found in the file COPYING  *
20  * included with this package.                                     *
21  *******************************************************************/
22 /* bsg definitions
23  * No pointers to user data are allowed, all application buffers and sizes will
24  * derived through the bsg interface.
25  *
26  * These are the vendor unique structures passed in using the bsg
27  * FC_BSG_HST_VENDOR message code type.
28  */
29 #define LPFC_BSG_VENDOR_SET_CT_EVENT		1
30 #define LPFC_BSG_VENDOR_GET_CT_EVENT		2
31 #define LPFC_BSG_VENDOR_SEND_MGMT_RESP		3
32 #define LPFC_BSG_VENDOR_DIAG_MODE		4
33 #define LPFC_BSG_VENDOR_DIAG_RUN_LOOPBACK	5
34 #define LPFC_BSG_VENDOR_GET_MGMT_REV		6
35 #define LPFC_BSG_VENDOR_MBOX			7
36 #define LPFC_BSG_VENDOR_MENLO_CMD		8
37 #define LPFC_BSG_VENDOR_MENLO_DATA		9
38 #define LPFC_BSG_VENDOR_DIAG_MODE_END		10
39 #define LPFC_BSG_VENDOR_LINK_DIAG_TEST		11
40 #define LPFC_BSG_VENDOR_FORCED_LINK_SPEED	14
41 #define LPFC_BSG_VENDOR_RAS_GET_LWPD		16
42 #define LPFC_BSG_VENDOR_RAS_GET_FWLOG		17
43 #define LPFC_BSG_VENDOR_RAS_GET_CONFIG		18
44 #define LPFC_BSG_VENDOR_RAS_SET_CONFIG		19
45 #define LPFC_BSG_VENDOR_GET_TRUNK_INFO		20
46 
47 struct set_ct_event {
48 	uint32_t command;
49 	uint32_t type_mask;
50 	uint32_t ev_req_id;
51 	uint32_t ev_reg_id;
52 };
53 
54 struct get_ct_event {
55 	uint32_t command;
56 	uint32_t ev_reg_id;
57 	uint32_t ev_req_id;
58 };
59 
60 struct get_ct_event_reply {
61 	uint32_t immed_data;
62 	uint32_t type;
63 };
64 
65 struct send_mgmt_resp {
66 	uint32_t command;
67 	uint32_t tag;
68 };
69 
70 
71 #define DISABLE_LOOP_BACK  0x0 /* disables loop back */
72 #define INTERNAL_LOOP_BACK 0x1 /* adapter short cuts the loop internally */
73 #define EXTERNAL_LOOP_BACK 0x2 /* requires an external loopback plug */
74 
75 struct diag_mode_set {
76 	uint32_t command;
77 	uint32_t type;
78 	uint32_t timeout;
79 	uint32_t physical_link;
80 };
81 
82 struct sli4_link_diag {
83 	uint32_t command;
84 	uint32_t timeout;
85 	uint32_t test_id;
86 	uint32_t loops;
87 	uint32_t test_version;
88 	uint32_t error_action;
89 };
90 
91 struct diag_mode_test {
92 	uint32_t command;
93 };
94 
95 struct diag_status {
96 	uint32_t mbox_status;
97 	uint32_t shdr_status;
98 	uint32_t shdr_add_status;
99 };
100 
101 #define LPFC_WWNN_TYPE		0
102 #define LPFC_WWPN_TYPE		1
103 
104 struct get_mgmt_rev {
105 	uint32_t command;
106 };
107 
108 #define MANAGEMENT_MAJOR_REV   1
109 #define MANAGEMENT_MINOR_REV   1
110 
111 /* the MgmtRevInfo structure */
112 struct MgmtRevInfo {
113 	uint32_t a_Major;
114 	uint32_t a_Minor;
115 };
116 
117 struct get_mgmt_rev_reply {
118 	struct MgmtRevInfo info;
119 };
120 
121 #define BSG_MBOX_SIZE 4096 /* mailbox command plus extended data */
122 
123 /* BSG mailbox request header */
124 struct dfc_mbox_req {
125 	uint32_t command;
126 	uint32_t mbOffset;
127 	uint32_t inExtWLen;
128 	uint32_t outExtWLen;
129 	uint32_t extMboxTag;
130 	uint32_t extSeqNum;
131 };
132 
133 /* Used for menlo command or menlo data. The xri is only used for menlo data */
134 struct menlo_command {
135 	uint32_t cmd;
136 	uint32_t xri;
137 };
138 
139 struct menlo_response {
140 	uint32_t xri; /* return the xri of the iocb exchange */
141 };
142 
143 /*
144  * macros and data structures for handling sli-config mailbox command
145  * pass-through support, this header file is shared between user and
146  * kernel spaces, note the set of macros are duplicates from lpfc_hw4.h,
147  * with macro names prefixed with bsg_, as the macros defined in
148  * lpfc_hw4.h are not accessible from user space.
149  */
150 
151 /* Macros to deal with bit fields. Each bit field must have 3 #defines
152  * associated with it (_SHIFT, _MASK, and _WORD).
153  * EG. For a bit field that is in the 7th bit of the "field4" field of a
154  * structure and is 2 bits in size the following #defines must exist:
155  *      struct temp {
156  *              uint32_t        field1;
157  *              uint32_t        field2;
158  *              uint32_t        field3;
159  *              uint32_t        field4;
160  *      #define example_bit_field_SHIFT         7
161  *      #define example_bit_field_MASK          0x03
162  *      #define example_bit_field_WORD          field4
163  *              uint32_t        field5;
164  *      };
165  * Then the macros below may be used to get or set the value of that field.
166  * EG. To get the value of the bit field from the above example:
167  *      struct temp t1;
168  *      value = bsg_bf_get(example_bit_field, &t1);
169  * And then to set that bit field:
170  *      bsg_bf_set(example_bit_field, &t1, 2);
171  * Or clear that bit field:
172  *      bsg_bf_set(example_bit_field, &t1, 0);
173  */
174 #define bsg_bf_get_le32(name, ptr) \
175 	((le32_to_cpu((ptr)->name##_WORD) >> name##_SHIFT) & name##_MASK)
176 #define bsg_bf_get(name, ptr) \
177 	(((ptr)->name##_WORD >> name##_SHIFT) & name##_MASK)
178 #define bsg_bf_set_le32(name, ptr, value) \
179 	((ptr)->name##_WORD = cpu_to_le32(((((value) & \
180 	name##_MASK) << name##_SHIFT) | (le32_to_cpu((ptr)->name##_WORD) & \
181 	~(name##_MASK << name##_SHIFT)))))
182 #define bsg_bf_set(name, ptr, value) \
183 	((ptr)->name##_WORD = ((((value) & name##_MASK) << name##_SHIFT) | \
184 	((ptr)->name##_WORD & ~(name##_MASK << name##_SHIFT))))
185 
186 /*
187  * The sli_config structure specified here is based on the following
188  * restriction:
189  *
190  * -- SLI_CONFIG EMB=0, carrying MSEs, will carry subcommands without
191  *    carrying HBD.
192  * -- SLI_CONFIG EMB=1, not carrying MSE, will carry subcommands with or
193  *    without carrying HBDs.
194  */
195 
196 struct lpfc_sli_config_mse {
197 	uint32_t pa_lo;
198 	uint32_t pa_hi;
199 	uint32_t buf_len;
200 #define lpfc_mbox_sli_config_mse_len_SHIFT	0
201 #define lpfc_mbox_sli_config_mse_len_MASK	0xffffff
202 #define lpfc_mbox_sli_config_mse_len_WORD	buf_len
203 };
204 
205 struct lpfc_sli_config_hbd {
206 	uint32_t buf_len;
207 #define lpfc_mbox_sli_config_ecmn_hbd_len_SHIFT	0
208 #define lpfc_mbox_sli_config_ecmn_hbd_len_MASK	0xffffff
209 #define lpfc_mbox_sli_config_ecmn_hbd_len_WORD	buf_len
210 	uint32_t pa_lo;
211 	uint32_t pa_hi;
212 };
213 
214 struct lpfc_sli_config_hdr {
215 	uint32_t word1;
216 #define lpfc_mbox_hdr_emb_SHIFT		0
217 #define lpfc_mbox_hdr_emb_MASK		0x00000001
218 #define lpfc_mbox_hdr_emb_WORD		word1
219 #define lpfc_mbox_hdr_mse_cnt_SHIFT	3
220 #define lpfc_mbox_hdr_mse_cnt_MASK	0x0000001f
221 #define lpfc_mbox_hdr_mse_cnt_WORD	word1
222 	uint32_t payload_length;
223 	uint32_t tag_lo;
224 	uint32_t tag_hi;
225 	uint32_t reserved5;
226 };
227 
228 #define LPFC_CSF_BOOT_DEV		0x1D
229 #define LPFC_CSF_QUERY			0
230 #define LPFC_CSF_SAVE			1
231 
232 struct lpfc_sli_config_emb0_subsys {
233 	struct lpfc_sli_config_hdr	sli_config_hdr;
234 #define LPFC_MBX_SLI_CONFIG_MAX_MSE     19
235 	struct lpfc_sli_config_mse	mse[LPFC_MBX_SLI_CONFIG_MAX_MSE];
236 	uint32_t padding;
237 	uint32_t word64;
238 #define lpfc_emb0_subcmnd_opcode_SHIFT	0
239 #define lpfc_emb0_subcmnd_opcode_MASK	0xff
240 #define lpfc_emb0_subcmnd_opcode_WORD	word64
241 #define lpfc_emb0_subcmnd_subsys_SHIFT	8
242 #define lpfc_emb0_subcmnd_subsys_MASK	0xff
243 #define lpfc_emb0_subcmnd_subsys_WORD	word64
244 /* Subsystem FCOE (0x0C) OpCodes */
245 #define SLI_CONFIG_SUBSYS_FCOE		0x0C
246 #define FCOE_OPCODE_READ_FCF		0x08
247 #define FCOE_OPCODE_ADD_FCF		0x09
248 #define FCOE_OPCODE_SET_DPORT_MODE	0x27
249 #define FCOE_OPCODE_GET_DPORT_RESULTS	0x28
250 	uint32_t timeout;		/* comn_set_feature timeout */
251 	uint32_t request_length;	/* comn_set_feature request len */
252 	uint32_t version;		/* comn_set_feature version */
253 	uint32_t csf_feature;		/* comn_set_feature feature */
254 	uint32_t word69;		/* comn_set_feature parameter len */
255 	uint32_t word70;		/* comn_set_feature parameter val0 */
256 #define lpfc_emb0_subcmnd_csf_p0_SHIFT	0
257 #define lpfc_emb0_subcmnd_csf_p0_MASK	0x3
258 #define lpfc_emb0_subcmnd_csf_p0_WORD	word70
259 };
260 
261 struct lpfc_sli_config_emb1_subsys {
262 	struct lpfc_sli_config_hdr	sli_config_hdr;
263 	uint32_t word6;
264 #define lpfc_emb1_subcmnd_opcode_SHIFT	0
265 #define lpfc_emb1_subcmnd_opcode_MASK	0xff
266 #define lpfc_emb1_subcmnd_opcode_WORD	word6
267 #define lpfc_emb1_subcmnd_subsys_SHIFT	8
268 #define lpfc_emb1_subcmnd_subsys_MASK	0xff
269 #define lpfc_emb1_subcmnd_subsys_WORD	word6
270 /* Subsystem COMN (0x01) OpCodes */
271 #define SLI_CONFIG_SUBSYS_COMN		0x01
272 #define COMN_OPCODE_GET_PROFILE_CONFIG	0xA4
273 #define COMN_OPCODE_READ_OBJECT		0xAB
274 #define COMN_OPCODE_WRITE_OBJECT	0xAC
275 #define COMN_OPCODE_READ_OBJECT_LIST	0xAD
276 #define COMN_OPCODE_DELETE_OBJECT	0xAE
277 #define COMN_OPCODE_SET_FEATURES	0xBF
278 #define COMN_OPCODE_GET_CNTL_ADDL_ATTRIBUTES	0x79
279 #define COMN_OPCODE_GET_CNTL_ATTRIBUTES	0x20
280 	uint32_t timeout;
281 	uint32_t request_length;
282 	uint32_t word9;
283 #define lpfc_subcmnd_version_SHIFT	0
284 #define lpfc_subcmnd_version_MASK	0xff
285 #define lpfc_subcmnd_version_WORD	word9
286 	uint32_t word10;
287 #define lpfc_subcmnd_ask_rd_len_SHIFT	0
288 #define lpfc_subcmnd_ask_rd_len_MASK	0xffffff
289 #define lpfc_subcmnd_ask_rd_len_WORD	word10
290 	uint32_t rd_offset;
291 	uint32_t obj_name[26];
292 	uint32_t hbd_count;
293 #define LPFC_MBX_SLI_CONFIG_MAX_HBD	8
294 	struct lpfc_sli_config_hbd	hbd[LPFC_MBX_SLI_CONFIG_MAX_HBD];
295 };
296 
297 struct lpfc_sli_config_mbox {
298 	uint32_t word0;
299 #define lpfc_mqe_status_SHIFT		16
300 #define lpfc_mqe_status_MASK		0x0000FFFF
301 #define lpfc_mqe_status_WORD		word0
302 #define lpfc_mqe_command_SHIFT		8
303 #define lpfc_mqe_command_MASK		0x000000FF
304 #define lpfc_mqe_command_WORD		word0
305 	union {
306 		struct lpfc_sli_config_emb0_subsys sli_config_emb0_subsys;
307 		struct lpfc_sli_config_emb1_subsys sli_config_emb1_subsys;
308 	} un;
309 };
310 
311 #define LPFC_FORCED_LINK_SPEED_NOT_SUPPORTED	0
312 #define LPFC_FORCED_LINK_SPEED_SUPPORTED	1
313 struct get_forced_link_speed_support {
314 	uint32_t command;
315 };
316 struct forced_link_speed_support_reply {
317 	uint8_t supported;
318 };
319 
320 struct lpfc_bsg_ras_req {
321 	uint32_t command;
322 };
323 
324 struct lpfc_bsg_get_fwlog_req {
325 	uint32_t command;
326 	uint32_t read_size;
327 	uint32_t read_offset;
328 };
329 
330 struct lpfc_bsg_get_ras_lwpd {
331 	uint32_t offset;
332 	uint32_t wrap_count;
333 };
334 
335 struct lpfc_bsg_set_ras_config_req {
336 	uint32_t command;
337 	uint8_t action;
338 #define LPFC_RASACTION_STOP_LOGGING     0x00
339 #define LPFC_RASACTION_START_LOGGING    0x01
340 	uint8_t log_level;
341 };
342 
343 struct lpfc_bsg_get_ras_config_reply {
344 	uint8_t state;
345 #define LPFC_RASLOG_STATE_STOPPED 0x00
346 #define LPFC_RASLOG_STATE_RUNNING 0x01
347 	uint8_t log_level;
348 	uint32_t log_buff_sz;
349 };
350 
351 struct lpfc_trunk_info {
352 	uint32_t word0;
353 #define lpfc_trunk_info_link_status_SHIFT      0
354 #define lpfc_trunk_info_link_status_MASK       1
355 #define lpfc_trunk_info_link_status_WORD       word0
356 #define lpfc_trunk_info_trunk_active0_SHIFT    8
357 #define lpfc_trunk_info_trunk_active0_MASK     1
358 #define lpfc_trunk_info_trunk_active0_WORD     word0
359 #define lpfc_trunk_info_trunk_active1_SHIFT    9
360 #define lpfc_trunk_info_trunk_active1_MASK     1
361 #define lpfc_trunk_info_trunk_active1_WORD     word0
362 #define lpfc_trunk_info_trunk_active2_SHIFT    10
363 #define lpfc_trunk_info_trunk_active2_MASK     1
364 #define lpfc_trunk_info_trunk_active2_WORD     word0
365 #define lpfc_trunk_info_trunk_active3_SHIFT    11
366 #define lpfc_trunk_info_trunk_active3_MASK     1
367 #define lpfc_trunk_info_trunk_active3_WORD     word0
368 #define lpfc_trunk_info_trunk_config0_SHIFT    12
369 #define lpfc_trunk_info_trunk_config0_MASK     1
370 #define lpfc_trunk_info_trunk_config0_WORD     word0
371 #define lpfc_trunk_info_trunk_config1_SHIFT    13
372 #define lpfc_trunk_info_trunk_config1_MASK     1
373 #define lpfc_trunk_info_trunk_config1_WORD     word0
374 #define lpfc_trunk_info_trunk_config2_SHIFT    14
375 #define lpfc_trunk_info_trunk_config2_MASK     1
376 #define lpfc_trunk_info_trunk_config2_WORD     word0
377 #define lpfc_trunk_info_trunk_config3_SHIFT    15
378 #define lpfc_trunk_info_trunk_config3_MASK     1
379 #define lpfc_trunk_info_trunk_config3_WORD     word0
380 	uint16_t    port_speed;
381 	uint16_t    logical_speed;
382 	uint32_t    reserved3;
383 };
384 
385 struct get_trunk_info_req {
386 	uint32_t command;
387 };
388 
389 /* driver only */
390 #define SLI_CONFIG_NOT_HANDLED		0
391 #define SLI_CONFIG_HANDLED		1
392