xref: /linux/drivers/scsi/lpfc/lpfc_mbox.c (revision 164666fa66669d437bdcc8d5f1744a2aee73be41)
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2017-2021 Broadcom. All Rights Reserved. The term *
5  * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.     *
6  * Copyright (C) 2004-2016 Emulex.  All rights reserved.           *
7  * EMULEX and SLI are trademarks of Emulex.                        *
8  * www.broadcom.com                                                *
9  * Portions Copyright (C) 2004-2005 Christoph Hellwig              *
10  *                                                                 *
11  * This program is free software; you can redistribute it and/or   *
12  * modify it under the terms of version 2 of the GNU General       *
13  * Public License as published by the Free Software Foundation.    *
14  * This program is distributed in the hope that it will be useful. *
15  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
16  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
17  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
18  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
19  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
20  * more details, a copy of which can be found in the file COPYING  *
21  * included with this package.                                     *
22  *******************************************************************/
23 
24 #include <linux/blkdev.h>
25 #include <linux/pci.h>
26 #include <linux/slab.h>
27 #include <linux/interrupt.h>
28 
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_transport_fc.h>
31 #include <scsi/scsi.h>
32 #include <scsi/fc/fc_fs.h>
33 
34 #include "lpfc_hw4.h"
35 #include "lpfc_hw.h"
36 #include "lpfc_sli.h"
37 #include "lpfc_sli4.h"
38 #include "lpfc_nl.h"
39 #include "lpfc_disc.h"
40 #include "lpfc_scsi.h"
41 #include "lpfc.h"
42 #include "lpfc_logmsg.h"
43 #include "lpfc_crtn.h"
44 #include "lpfc_compat.h"
45 
46 /**
47  * lpfc_dump_static_vport - Dump HBA's static vport information.
48  * @phba: pointer to lpfc hba data structure.
49  * @pmb: pointer to the driver internal queue element for mailbox command.
50  * @offset: offset for dumping vport info.
51  *
52  * The dump mailbox command provides a method for the device driver to obtain
53  * various types of information from the HBA device.
54  *
55  * This routine prepares the mailbox command for dumping list of static
56  * vports to be created.
57  **/
58 int
59 lpfc_dump_static_vport(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb,
60 		uint16_t offset)
61 {
62 	MAILBOX_t *mb;
63 	struct lpfc_dmabuf *mp;
64 
65 	mb = &pmb->u.mb;
66 
67 	/* Setup to dump vport info region */
68 	memset(pmb, 0, sizeof(LPFC_MBOXQ_t));
69 	mb->mbxCommand = MBX_DUMP_MEMORY;
70 	mb->un.varDmp.type = DMP_NV_PARAMS;
71 	mb->un.varDmp.entry_index = offset;
72 	mb->un.varDmp.region_id = DMP_REGION_VPORT;
73 	mb->mbxOwner = OWN_HOST;
74 
75 	/* For SLI3 HBAs data is embedded in mailbox */
76 	if (phba->sli_rev != LPFC_SLI_REV4) {
77 		mb->un.varDmp.cv = 1;
78 		mb->un.varDmp.word_cnt = DMP_RSP_SIZE/sizeof(uint32_t);
79 		return 0;
80 	}
81 
82 	/* For SLI4 HBAs driver need to allocate memory */
83 	mp = kmalloc(sizeof(struct lpfc_dmabuf), GFP_KERNEL);
84 	if (mp)
85 		mp->virt = lpfc_mbuf_alloc(phba, 0, &mp->phys);
86 
87 	if (!mp || !mp->virt) {
88 		kfree(mp);
89 		lpfc_printf_log(phba, KERN_ERR, LOG_MBOX,
90 			"2605 lpfc_dump_static_vport: memory"
91 			" allocation failed\n");
92 		return 1;
93 	}
94 	memset(mp->virt, 0, LPFC_BPL_SIZE);
95 	INIT_LIST_HEAD(&mp->list);
96 	/* save address for completion */
97 	pmb->ctx_buf = (uint8_t *)mp;
98 	mb->un.varWords[3] = putPaddrLow(mp->phys);
99 	mb->un.varWords[4] = putPaddrHigh(mp->phys);
100 	mb->un.varDmp.sli4_length = sizeof(struct static_vport_info);
101 
102 	return 0;
103 }
104 
105 /**
106  * lpfc_down_link - Bring down HBAs link.
107  * @phba: pointer to lpfc hba data structure.
108  * @pmb: pointer to the driver internal queue element for mailbox command.
109  *
110  * This routine prepares a mailbox command to bring down HBA link.
111  **/
112 void
113 lpfc_down_link(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb)
114 {
115 	MAILBOX_t *mb;
116 	memset(pmb, 0, sizeof(LPFC_MBOXQ_t));
117 	mb = &pmb->u.mb;
118 	mb->mbxCommand = MBX_DOWN_LINK;
119 	mb->mbxOwner = OWN_HOST;
120 }
121 
122 /**
123  * lpfc_dump_mem - Prepare a mailbox command for reading a region.
124  * @phba: pointer to lpfc hba data structure.
125  * @pmb: pointer to the driver internal queue element for mailbox command.
126  * @offset: offset into the region.
127  * @region_id: config region id.
128  *
129  * The dump mailbox command provides a method for the device driver to obtain
130  * various types of information from the HBA device.
131  *
132  * This routine prepares the mailbox command for dumping HBA's config region.
133  **/
134 void
135 lpfc_dump_mem(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb, uint16_t offset,
136 		uint16_t region_id)
137 {
138 	MAILBOX_t *mb;
139 	void *ctx;
140 
141 	mb = &pmb->u.mb;
142 	ctx = pmb->ctx_buf;
143 
144 	/* Setup to dump VPD region */
145 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
146 	mb->mbxCommand = MBX_DUMP_MEMORY;
147 	mb->un.varDmp.cv = 1;
148 	mb->un.varDmp.type = DMP_NV_PARAMS;
149 	mb->un.varDmp.entry_index = offset;
150 	mb->un.varDmp.region_id = region_id;
151 	mb->un.varDmp.word_cnt = (DMP_RSP_SIZE / sizeof (uint32_t));
152 	mb->un.varDmp.co = 0;
153 	mb->un.varDmp.resp_offset = 0;
154 	pmb->ctx_buf = ctx;
155 	mb->mbxOwner = OWN_HOST;
156 	return;
157 }
158 
159 /**
160  * lpfc_dump_wakeup_param - Prepare mailbox command for retrieving wakeup params
161  * @phba: pointer to lpfc hba data structure.
162  * @pmb: pointer to the driver internal queue element for mailbox command.
163  *
164  * This function create a dump memory mailbox command to dump wake up
165  * parameters.
166  */
167 void
168 lpfc_dump_wakeup_param(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb)
169 {
170 	MAILBOX_t *mb;
171 	void *ctx;
172 
173 	mb = &pmb->u.mb;
174 	/* Save context so that we can restore after memset */
175 	ctx = pmb->ctx_buf;
176 
177 	/* Setup to dump VPD region */
178 	memset(pmb, 0, sizeof(LPFC_MBOXQ_t));
179 	mb->mbxCommand = MBX_DUMP_MEMORY;
180 	mb->mbxOwner = OWN_HOST;
181 	mb->un.varDmp.cv = 1;
182 	mb->un.varDmp.type = DMP_NV_PARAMS;
183 	if (phba->sli_rev < LPFC_SLI_REV4)
184 		mb->un.varDmp.entry_index = 0;
185 	mb->un.varDmp.region_id = WAKE_UP_PARMS_REGION_ID;
186 	mb->un.varDmp.word_cnt = WAKE_UP_PARMS_WORD_SIZE;
187 	mb->un.varDmp.co = 0;
188 	mb->un.varDmp.resp_offset = 0;
189 	pmb->ctx_buf = ctx;
190 	return;
191 }
192 
193 /**
194  * lpfc_read_nv - Prepare a mailbox command for reading HBA's NVRAM param
195  * @phba: pointer to lpfc hba data structure.
196  * @pmb: pointer to the driver internal queue element for mailbox command.
197  *
198  * The read NVRAM mailbox command returns the HBA's non-volatile parameters
199  * that are used as defaults when the Fibre Channel link is brought on-line.
200  *
201  * This routine prepares the mailbox command for reading information stored
202  * in the HBA's NVRAM. Specifically, the HBA's WWNN and WWPN.
203  **/
204 void
205 lpfc_read_nv(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
206 {
207 	MAILBOX_t *mb;
208 
209 	mb = &pmb->u.mb;
210 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
211 	mb->mbxCommand = MBX_READ_NV;
212 	mb->mbxOwner = OWN_HOST;
213 	return;
214 }
215 
216 /**
217  * lpfc_config_async - Prepare a mailbox command for enabling HBA async event
218  * @phba: pointer to lpfc hba data structure.
219  * @pmb: pointer to the driver internal queue element for mailbox command.
220  * @ring: ring number for the asynchronous event to be configured.
221  *
222  * The asynchronous event enable mailbox command is used to enable the
223  * asynchronous event posting via the ASYNC_STATUS_CN IOCB response and
224  * specifies the default ring to which events are posted.
225  *
226  * This routine prepares the mailbox command for enabling HBA asynchronous
227  * event support on a IOCB ring.
228  **/
229 void
230 lpfc_config_async(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb,
231 		uint32_t ring)
232 {
233 	MAILBOX_t *mb;
234 
235 	mb = &pmb->u.mb;
236 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
237 	mb->mbxCommand = MBX_ASYNCEVT_ENABLE;
238 	mb->un.varCfgAsyncEvent.ring = ring;
239 	mb->mbxOwner = OWN_HOST;
240 	return;
241 }
242 
243 /**
244  * lpfc_heart_beat - Prepare a mailbox command for heart beat
245  * @phba: pointer to lpfc hba data structure.
246  * @pmb: pointer to the driver internal queue element for mailbox command.
247  *
248  * The heart beat mailbox command is used to detect an unresponsive HBA, which
249  * is defined as any device where no error attention is sent and both mailbox
250  * and rings are not processed.
251  *
252  * This routine prepares the mailbox command for issuing a heart beat in the
253  * form of mailbox command to the HBA. The timely completion of the heart
254  * beat mailbox command indicates the health of the HBA.
255  **/
256 void
257 lpfc_heart_beat(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
258 {
259 	MAILBOX_t *mb;
260 
261 	mb = &pmb->u.mb;
262 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
263 	mb->mbxCommand = MBX_HEARTBEAT;
264 	mb->mbxOwner = OWN_HOST;
265 	return;
266 }
267 
268 /**
269  * lpfc_read_topology - Prepare a mailbox command for reading HBA topology
270  * @phba: pointer to lpfc hba data structure.
271  * @pmb: pointer to the driver internal queue element for mailbox command.
272  * @mp: DMA buffer memory for reading the link attention information into.
273  *
274  * The read topology mailbox command is issued to read the link topology
275  * information indicated by the HBA port when the Link Event bit of the Host
276  * Attention (HSTATT) register is set to 1 (For SLI-3) or when an FC Link
277  * Attention ACQE is received from the port (For SLI-4). A Link Event
278  * Attention occurs based on an exception detected at the Fibre Channel link
279  * interface.
280  *
281  * This routine prepares the mailbox command for reading HBA link topology
282  * information. A DMA memory has been set aside and address passed to the
283  * HBA through @mp for the HBA to DMA link attention information into the
284  * memory as part of the execution of the mailbox command.
285  *
286  * Return codes
287  *    0 - Success (currently always return 0)
288  **/
289 int
290 lpfc_read_topology(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb,
291 		   struct lpfc_dmabuf *mp)
292 {
293 	MAILBOX_t *mb;
294 
295 	mb = &pmb->u.mb;
296 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
297 
298 	INIT_LIST_HEAD(&mp->list);
299 	mb->mbxCommand = MBX_READ_TOPOLOGY;
300 	mb->un.varReadTop.lilpBde64.tus.f.bdeSize = LPFC_ALPA_MAP_SIZE;
301 	mb->un.varReadTop.lilpBde64.addrHigh = putPaddrHigh(mp->phys);
302 	mb->un.varReadTop.lilpBde64.addrLow = putPaddrLow(mp->phys);
303 
304 	/* Save address for later completion and set the owner to host so that
305 	 * the FW knows this mailbox is available for processing.
306 	 */
307 	pmb->ctx_buf = (uint8_t *)mp;
308 	mb->mbxOwner = OWN_HOST;
309 	return (0);
310 }
311 
312 /**
313  * lpfc_clear_la - Prepare a mailbox command for clearing HBA link attention
314  * @phba: pointer to lpfc hba data structure.
315  * @pmb: pointer to the driver internal queue element for mailbox command.
316  *
317  * The clear link attention mailbox command is issued to clear the link event
318  * attention condition indicated by the Link Event bit of the Host Attention
319  * (HSTATT) register. The link event attention condition is cleared only if
320  * the event tag specified matches that of the current link event counter.
321  * The current event tag is read using the read link attention event mailbox
322  * command.
323  *
324  * This routine prepares the mailbox command for clearing HBA link attention
325  * information.
326  **/
327 void
328 lpfc_clear_la(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
329 {
330 	MAILBOX_t *mb;
331 
332 	mb = &pmb->u.mb;
333 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
334 
335 	mb->un.varClearLA.eventTag = phba->fc_eventTag;
336 	mb->mbxCommand = MBX_CLEAR_LA;
337 	mb->mbxOwner = OWN_HOST;
338 	return;
339 }
340 
341 /**
342  * lpfc_config_link - Prepare a mailbox command for configuring link on a HBA
343  * @phba: pointer to lpfc hba data structure.
344  * @pmb: pointer to the driver internal queue element for mailbox command.
345  *
346  * The configure link mailbox command is used before the initialize link
347  * mailbox command to override default value and to configure link-oriented
348  * parameters such as DID address and various timers. Typically, this
349  * command would be used after an F_Port login to set the returned DID address
350  * and the fabric timeout values. This command is not valid before a configure
351  * port command has configured the HBA port.
352  *
353  * This routine prepares the mailbox command for configuring link on a HBA.
354  **/
355 void
356 lpfc_config_link(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
357 {
358 	struct lpfc_vport  *vport = phba->pport;
359 	MAILBOX_t *mb = &pmb->u.mb;
360 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
361 
362 	/* NEW_FEATURE
363 	 * SLI-2, Coalescing Response Feature.
364 	 */
365 	if (phba->cfg_cr_delay && (phba->sli_rev < LPFC_SLI_REV4)) {
366 		mb->un.varCfgLnk.cr = 1;
367 		mb->un.varCfgLnk.ci = 1;
368 		mb->un.varCfgLnk.cr_delay = phba->cfg_cr_delay;
369 		mb->un.varCfgLnk.cr_count = phba->cfg_cr_count;
370 	}
371 
372 	mb->un.varCfgLnk.myId = vport->fc_myDID;
373 	mb->un.varCfgLnk.edtov = phba->fc_edtov;
374 	mb->un.varCfgLnk.arbtov = phba->fc_arbtov;
375 	mb->un.varCfgLnk.ratov = phba->fc_ratov;
376 	mb->un.varCfgLnk.rttov = phba->fc_rttov;
377 	mb->un.varCfgLnk.altov = phba->fc_altov;
378 	mb->un.varCfgLnk.crtov = phba->fc_crtov;
379 	mb->un.varCfgLnk.cscn = 0;
380 	if (phba->bbcredit_support && phba->cfg_enable_bbcr) {
381 		mb->un.varCfgLnk.cscn = 1;
382 		mb->un.varCfgLnk.bbscn = bf_get(lpfc_bbscn_def,
383 						 &phba->sli4_hba.bbscn_params);
384 	}
385 
386 	if (phba->cfg_ack0 && (phba->sli_rev < LPFC_SLI_REV4))
387 		mb->un.varCfgLnk.ack0_enable = 1;
388 
389 	mb->mbxCommand = MBX_CONFIG_LINK;
390 	mb->mbxOwner = OWN_HOST;
391 	return;
392 }
393 
394 /**
395  * lpfc_config_msi - Prepare a mailbox command for configuring msi-x
396  * @phba: pointer to lpfc hba data structure.
397  * @pmb: pointer to the driver internal queue element for mailbox command.
398  *
399  * The configure MSI-X mailbox command is used to configure the HBA's SLI-3
400  * MSI-X multi-message interrupt vector association to interrupt attention
401  * conditions.
402  *
403  * Return codes
404  *    0 - Success
405  *    -EINVAL - Failure
406  **/
407 int
408 lpfc_config_msi(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb)
409 {
410 	MAILBOX_t *mb = &pmb->u.mb;
411 	uint32_t attentionConditions[2];
412 
413 	/* Sanity check */
414 	if (phba->cfg_use_msi != 2) {
415 		lpfc_printf_log(phba, KERN_ERR, LOG_INIT,
416 				"0475 Not configured for supporting MSI-X "
417 				"cfg_use_msi: 0x%x\n", phba->cfg_use_msi);
418 		return -EINVAL;
419 	}
420 
421 	if (phba->sli_rev < 3) {
422 		lpfc_printf_log(phba, KERN_ERR, LOG_INIT,
423 				"0476 HBA not supporting SLI-3 or later "
424 				"SLI Revision: 0x%x\n", phba->sli_rev);
425 		return -EINVAL;
426 	}
427 
428 	/* Clear mailbox command fields */
429 	memset(pmb, 0, sizeof(LPFC_MBOXQ_t));
430 
431 	/*
432 	 * SLI-3, Message Signaled Interrupt Fearure.
433 	 */
434 
435 	/* Multi-message attention configuration */
436 	attentionConditions[0] = (HA_R0ATT | HA_R1ATT | HA_R2ATT | HA_ERATT |
437 				  HA_LATT | HA_MBATT);
438 	attentionConditions[1] = 0;
439 
440 	mb->un.varCfgMSI.attentionConditions[0] = attentionConditions[0];
441 	mb->un.varCfgMSI.attentionConditions[1] = attentionConditions[1];
442 
443 	/*
444 	 * Set up message number to HA bit association
445 	 */
446 #ifdef __BIG_ENDIAN_BITFIELD
447 	/* RA0 (FCP Ring) */
448 	mb->un.varCfgMSI.messageNumberByHA[HA_R0_POS] = 1;
449 	/* RA1 (Other Protocol Extra Ring) */
450 	mb->un.varCfgMSI.messageNumberByHA[HA_R1_POS] = 1;
451 #else   /*  __LITTLE_ENDIAN_BITFIELD */
452 	/* RA0 (FCP Ring) */
453 	mb->un.varCfgMSI.messageNumberByHA[HA_R0_POS^3] = 1;
454 	/* RA1 (Other Protocol Extra Ring) */
455 	mb->un.varCfgMSI.messageNumberByHA[HA_R1_POS^3] = 1;
456 #endif
457 	/* Multi-message interrupt autoclear configuration*/
458 	mb->un.varCfgMSI.autoClearHA[0] = attentionConditions[0];
459 	mb->un.varCfgMSI.autoClearHA[1] = attentionConditions[1];
460 
461 	/* For now, HBA autoclear does not work reliably, disable it */
462 	mb->un.varCfgMSI.autoClearHA[0] = 0;
463 	mb->un.varCfgMSI.autoClearHA[1] = 0;
464 
465 	/* Set command and owner bit */
466 	mb->mbxCommand = MBX_CONFIG_MSI;
467 	mb->mbxOwner = OWN_HOST;
468 
469 	return 0;
470 }
471 
472 /**
473  * lpfc_init_link - Prepare a mailbox command for initialize link on a HBA
474  * @phba: pointer to lpfc hba data structure.
475  * @pmb: pointer to the driver internal queue element for mailbox command.
476  * @topology: the link topology for the link to be initialized to.
477  * @linkspeed: the link speed for the link to be initialized to.
478  *
479  * The initialize link mailbox command is used to initialize the Fibre
480  * Channel link. This command must follow a configure port command that
481  * establishes the mode of operation.
482  *
483  * This routine prepares the mailbox command for initializing link on a HBA
484  * with the specified link topology and speed.
485  **/
486 void
487 lpfc_init_link(struct lpfc_hba * phba,
488 	       LPFC_MBOXQ_t * pmb, uint32_t topology, uint32_t linkspeed)
489 {
490 	lpfc_vpd_t *vpd;
491 	MAILBOX_t *mb;
492 
493 	mb = &pmb->u.mb;
494 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
495 
496 	switch (topology) {
497 	case FLAGS_TOPOLOGY_MODE_LOOP_PT:
498 		mb->un.varInitLnk.link_flags = FLAGS_TOPOLOGY_MODE_LOOP;
499 		mb->un.varInitLnk.link_flags |= FLAGS_TOPOLOGY_FAILOVER;
500 		break;
501 	case FLAGS_TOPOLOGY_MODE_PT_PT:
502 		mb->un.varInitLnk.link_flags = FLAGS_TOPOLOGY_MODE_PT_PT;
503 		break;
504 	case FLAGS_TOPOLOGY_MODE_LOOP:
505 		mb->un.varInitLnk.link_flags = FLAGS_TOPOLOGY_MODE_LOOP;
506 		break;
507 	case FLAGS_TOPOLOGY_MODE_PT_LOOP:
508 		mb->un.varInitLnk.link_flags = FLAGS_TOPOLOGY_MODE_PT_PT;
509 		mb->un.varInitLnk.link_flags |= FLAGS_TOPOLOGY_FAILOVER;
510 		break;
511 	case FLAGS_LOCAL_LB:
512 		mb->un.varInitLnk.link_flags = FLAGS_LOCAL_LB;
513 		break;
514 	}
515 
516 	/* Topology handling for ASIC_GEN_NUM 0xC and later */
517 	if ((phba->sli4_hba.pc_sli4_params.sli_family == LPFC_SLI_INTF_FAMILY_G6 ||
518 	     phba->sli4_hba.pc_sli4_params.if_type == LPFC_SLI_INTF_IF_TYPE_6) &&
519 	    !(phba->sli4_hba.pc_sli4_params.pls) &&
520 	    mb->un.varInitLnk.link_flags & FLAGS_TOPOLOGY_MODE_LOOP) {
521 		mb->un.varInitLnk.link_flags = FLAGS_TOPOLOGY_MODE_PT_PT;
522 		phba->cfg_topology = FLAGS_TOPOLOGY_MODE_PT_PT;
523 	}
524 
525 	/* Enable asynchronous ABTS responses from firmware */
526 	if (phba->sli_rev == LPFC_SLI_REV3 && !phba->cfg_fcp_wait_abts_rsp)
527 		mb->un.varInitLnk.link_flags |= FLAGS_IMED_ABORT;
528 
529 	/* NEW_FEATURE
530 	 * Setting up the link speed
531 	 */
532 	vpd = &phba->vpd;
533 	if (vpd->rev.feaLevelHigh >= 0x02){
534 		switch(linkspeed){
535 		case LPFC_USER_LINK_SPEED_1G:
536 			mb->un.varInitLnk.link_flags |= FLAGS_LINK_SPEED;
537 			mb->un.varInitLnk.link_speed = LINK_SPEED_1G;
538 			break;
539 		case LPFC_USER_LINK_SPEED_2G:
540 			mb->un.varInitLnk.link_flags |=	FLAGS_LINK_SPEED;
541 			mb->un.varInitLnk.link_speed = LINK_SPEED_2G;
542 			break;
543 		case LPFC_USER_LINK_SPEED_4G:
544 			mb->un.varInitLnk.link_flags |=	FLAGS_LINK_SPEED;
545 			mb->un.varInitLnk.link_speed = LINK_SPEED_4G;
546 			break;
547 		case LPFC_USER_LINK_SPEED_8G:
548 			mb->un.varInitLnk.link_flags |=	FLAGS_LINK_SPEED;
549 			mb->un.varInitLnk.link_speed = LINK_SPEED_8G;
550 			break;
551 		case LPFC_USER_LINK_SPEED_10G:
552 			mb->un.varInitLnk.link_flags |=	FLAGS_LINK_SPEED;
553 			mb->un.varInitLnk.link_speed = LINK_SPEED_10G;
554 			break;
555 		case LPFC_USER_LINK_SPEED_16G:
556 			mb->un.varInitLnk.link_flags |=	FLAGS_LINK_SPEED;
557 			mb->un.varInitLnk.link_speed = LINK_SPEED_16G;
558 			break;
559 		case LPFC_USER_LINK_SPEED_32G:
560 			mb->un.varInitLnk.link_flags |= FLAGS_LINK_SPEED;
561 			mb->un.varInitLnk.link_speed = LINK_SPEED_32G;
562 			break;
563 		case LPFC_USER_LINK_SPEED_64G:
564 			mb->un.varInitLnk.link_flags |= FLAGS_LINK_SPEED;
565 			mb->un.varInitLnk.link_speed = LINK_SPEED_64G;
566 			break;
567 		case LPFC_USER_LINK_SPEED_AUTO:
568 		default:
569 			mb->un.varInitLnk.link_speed = LINK_SPEED_AUTO;
570 			break;
571 		}
572 
573 	}
574 	else
575 		mb->un.varInitLnk.link_speed = LINK_SPEED_AUTO;
576 
577 	mb->mbxCommand = (volatile uint8_t)MBX_INIT_LINK;
578 	mb->mbxOwner = OWN_HOST;
579 	mb->un.varInitLnk.fabric_AL_PA = phba->fc_pref_ALPA;
580 	return;
581 }
582 
583 /**
584  * lpfc_read_sparam - Prepare a mailbox command for reading HBA parameters
585  * @phba: pointer to lpfc hba data structure.
586  * @pmb: pointer to the driver internal queue element for mailbox command.
587  * @vpi: virtual N_Port identifier.
588  *
589  * The read service parameter mailbox command is used to read the HBA port
590  * service parameters. The service parameters are read into the buffer
591  * specified directly by a BDE in the mailbox command. These service
592  * parameters may then be used to build the payload of an N_Port/F_POrt
593  * login request and reply (LOGI/ACC).
594  *
595  * This routine prepares the mailbox command for reading HBA port service
596  * parameters. The DMA memory is allocated in this function and the addresses
597  * are populated into the mailbox command for the HBA to DMA the service
598  * parameters into.
599  *
600  * Return codes
601  *    0 - Success
602  *    1 - DMA memory allocation failed
603  **/
604 int
605 lpfc_read_sparam(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb, int vpi)
606 {
607 	struct lpfc_dmabuf *mp;
608 	MAILBOX_t *mb;
609 
610 	mb = &pmb->u.mb;
611 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
612 
613 	mb->mbxOwner = OWN_HOST;
614 
615 	/* Get a buffer to hold the HBAs Service Parameters */
616 
617 	mp = kmalloc(sizeof (struct lpfc_dmabuf), GFP_KERNEL);
618 	if (mp)
619 		mp->virt = lpfc_mbuf_alloc(phba, 0, &mp->phys);
620 	if (!mp || !mp->virt) {
621 		kfree(mp);
622 		mb->mbxCommand = MBX_READ_SPARM64;
623 		/* READ_SPARAM: no buffers */
624 		lpfc_printf_log(phba, KERN_WARNING, LOG_MBOX,
625 			        "0301 READ_SPARAM: no buffers\n");
626 		return (1);
627 	}
628 	INIT_LIST_HEAD(&mp->list);
629 	mb->mbxCommand = MBX_READ_SPARM64;
630 	mb->un.varRdSparm.un.sp64.tus.f.bdeSize = sizeof (struct serv_parm);
631 	mb->un.varRdSparm.un.sp64.addrHigh = putPaddrHigh(mp->phys);
632 	mb->un.varRdSparm.un.sp64.addrLow = putPaddrLow(mp->phys);
633 	if (phba->sli_rev >= LPFC_SLI_REV3)
634 		mb->un.varRdSparm.vpi = phba->vpi_ids[vpi];
635 
636 	/* save address for completion */
637 	pmb->ctx_buf = mp;
638 
639 	return (0);
640 }
641 
642 /**
643  * lpfc_unreg_did - Prepare a mailbox command for unregistering DID
644  * @phba: pointer to lpfc hba data structure.
645  * @vpi: virtual N_Port identifier.
646  * @did: remote port identifier.
647  * @pmb: pointer to the driver internal queue element for mailbox command.
648  *
649  * The unregister DID mailbox command is used to unregister an N_Port/F_Port
650  * login for an unknown RPI by specifying the DID of a remote port. This
651  * command frees an RPI context in the HBA port. This has the effect of
652  * performing an implicit N_Port/F_Port logout.
653  *
654  * This routine prepares the mailbox command for unregistering a remote
655  * N_Port/F_Port (DID) login.
656  **/
657 void
658 lpfc_unreg_did(struct lpfc_hba * phba, uint16_t vpi, uint32_t did,
659 	       LPFC_MBOXQ_t * pmb)
660 {
661 	MAILBOX_t *mb;
662 
663 	mb = &pmb->u.mb;
664 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
665 
666 	mb->un.varUnregDID.did = did;
667 	mb->un.varUnregDID.vpi = vpi;
668 	if ((vpi != 0xffff) &&
669 	    (phba->sli_rev == LPFC_SLI_REV4))
670 		mb->un.varUnregDID.vpi = phba->vpi_ids[vpi];
671 
672 	mb->mbxCommand = MBX_UNREG_D_ID;
673 	mb->mbxOwner = OWN_HOST;
674 	return;
675 }
676 
677 /**
678  * lpfc_read_config - Prepare a mailbox command for reading HBA configuration
679  * @phba: pointer to lpfc hba data structure.
680  * @pmb: pointer to the driver internal queue element for mailbox command.
681  *
682  * The read configuration mailbox command is used to read the HBA port
683  * configuration parameters. This mailbox command provides a method for
684  * seeing any parameters that may have changed via various configuration
685  * mailbox commands.
686  *
687  * This routine prepares the mailbox command for reading out HBA configuration
688  * parameters.
689  **/
690 void
691 lpfc_read_config(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
692 {
693 	MAILBOX_t *mb;
694 
695 	mb = &pmb->u.mb;
696 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
697 
698 	mb->mbxCommand = MBX_READ_CONFIG;
699 	mb->mbxOwner = OWN_HOST;
700 	return;
701 }
702 
703 /**
704  * lpfc_read_lnk_stat - Prepare a mailbox command for reading HBA link stats
705  * @phba: pointer to lpfc hba data structure.
706  * @pmb: pointer to the driver internal queue element for mailbox command.
707  *
708  * The read link status mailbox command is used to read the link status from
709  * the HBA. Link status includes all link-related error counters. These
710  * counters are maintained by the HBA and originated in the link hardware
711  * unit. Note that all of these counters wrap.
712  *
713  * This routine prepares the mailbox command for reading out HBA link status.
714  **/
715 void
716 lpfc_read_lnk_stat(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
717 {
718 	MAILBOX_t *mb;
719 
720 	mb = &pmb->u.mb;
721 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
722 
723 	mb->mbxCommand = MBX_READ_LNK_STAT;
724 	mb->mbxOwner = OWN_HOST;
725 	return;
726 }
727 
728 /**
729  * lpfc_reg_rpi - Prepare a mailbox command for registering remote login
730  * @phba: pointer to lpfc hba data structure.
731  * @vpi: virtual N_Port identifier.
732  * @did: remote port identifier.
733  * @param: pointer to memory holding the server parameters.
734  * @pmb: pointer to the driver internal queue element for mailbox command.
735  * @rpi: the rpi to use in the registration (usually only used for SLI4.
736  *
737  * The registration login mailbox command is used to register an N_Port or
738  * F_Port login. This registration allows the HBA to cache the remote N_Port
739  * service parameters internally and thereby make the appropriate FC-2
740  * decisions. The remote port service parameters are handed off by the driver
741  * to the HBA using a descriptor entry that directly identifies a buffer in
742  * host memory. In exchange, the HBA returns an RPI identifier.
743  *
744  * This routine prepares the mailbox command for registering remote port login.
745  * The function allocates DMA buffer for passing the service parameters to the
746  * HBA with the mailbox command.
747  *
748  * Return codes
749  *    0 - Success
750  *    1 - DMA memory allocation failed
751  **/
752 int
753 lpfc_reg_rpi(struct lpfc_hba *phba, uint16_t vpi, uint32_t did,
754 	     uint8_t *param, LPFC_MBOXQ_t *pmb, uint16_t rpi)
755 {
756 	MAILBOX_t *mb = &pmb->u.mb;
757 	uint8_t *sparam;
758 	struct lpfc_dmabuf *mp;
759 
760 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
761 
762 	mb->un.varRegLogin.rpi = 0;
763 	if (phba->sli_rev == LPFC_SLI_REV4)
764 		mb->un.varRegLogin.rpi = phba->sli4_hba.rpi_ids[rpi];
765 	if (phba->sli_rev >= LPFC_SLI_REV3)
766 		mb->un.varRegLogin.vpi = phba->vpi_ids[vpi];
767 	mb->un.varRegLogin.did = did;
768 	mb->mbxOwner = OWN_HOST;
769 	/* Get a buffer to hold NPorts Service Parameters */
770 	mp = kmalloc(sizeof (struct lpfc_dmabuf), GFP_KERNEL);
771 	if (mp)
772 		mp->virt = lpfc_mbuf_alloc(phba, 0, &mp->phys);
773 	if (!mp || !mp->virt) {
774 		kfree(mp);
775 		mb->mbxCommand = MBX_REG_LOGIN64;
776 		/* REG_LOGIN: no buffers */
777 		lpfc_printf_log(phba, KERN_WARNING, LOG_MBOX,
778 				"0302 REG_LOGIN: no buffers, VPI:%d DID:x%x, "
779 				"rpi x%x\n", vpi, did, rpi);
780 		return 1;
781 	}
782 	INIT_LIST_HEAD(&mp->list);
783 	sparam = mp->virt;
784 
785 	/* Copy param's into a new buffer */
786 	memcpy(sparam, param, sizeof (struct serv_parm));
787 
788 	/* save address for completion */
789 	pmb->ctx_buf = (uint8_t *)mp;
790 
791 	mb->mbxCommand = MBX_REG_LOGIN64;
792 	mb->un.varRegLogin.un.sp64.tus.f.bdeSize = sizeof (struct serv_parm);
793 	mb->un.varRegLogin.un.sp64.addrHigh = putPaddrHigh(mp->phys);
794 	mb->un.varRegLogin.un.sp64.addrLow = putPaddrLow(mp->phys);
795 
796 	return 0;
797 }
798 
799 /**
800  * lpfc_unreg_login - Prepare a mailbox command for unregistering remote login
801  * @phba: pointer to lpfc hba data structure.
802  * @vpi: virtual N_Port identifier.
803  * @rpi: remote port identifier
804  * @pmb: pointer to the driver internal queue element for mailbox command.
805  *
806  * The unregistration login mailbox command is used to unregister an N_Port
807  * or F_Port login. This command frees an RPI context in the HBA. It has the
808  * effect of performing an implicit N_Port/F_Port logout.
809  *
810  * This routine prepares the mailbox command for unregistering remote port
811  * login.
812  *
813  * For SLI4 ports, the rpi passed to this function must be the physical
814  * rpi value, not the logical index.
815  **/
816 void
817 lpfc_unreg_login(struct lpfc_hba *phba, uint16_t vpi, uint32_t rpi,
818 		 LPFC_MBOXQ_t * pmb)
819 {
820 	MAILBOX_t *mb;
821 
822 	mb = &pmb->u.mb;
823 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
824 
825 	mb->un.varUnregLogin.rpi = rpi;
826 	mb->un.varUnregLogin.rsvd1 = 0;
827 	if (phba->sli_rev >= LPFC_SLI_REV3)
828 		mb->un.varUnregLogin.vpi = phba->vpi_ids[vpi];
829 
830 	mb->mbxCommand = MBX_UNREG_LOGIN;
831 	mb->mbxOwner = OWN_HOST;
832 
833 	return;
834 }
835 
836 /**
837  * lpfc_sli4_unreg_all_rpis - unregister all RPIs for a vport on SLI4 HBA.
838  * @vport: pointer to a vport object.
839  *
840  * This routine sends mailbox command to unregister all active RPIs for
841  * a vport.
842  **/
843 void
844 lpfc_sli4_unreg_all_rpis(struct lpfc_vport *vport)
845 {
846 	struct lpfc_hba  *phba  = vport->phba;
847 	LPFC_MBOXQ_t     *mbox;
848 	int rc;
849 
850 	mbox = mempool_alloc(phba->mbox_mem_pool, GFP_KERNEL);
851 	if (mbox) {
852 		/*
853 		 * For SLI4 functions, the rpi field is overloaded for
854 		 * the vport context unreg all.  This routine passes
855 		 * 0 for the rpi field in lpfc_unreg_login for compatibility
856 		 * with SLI3 and then overrides the rpi field with the
857 		 * expected value for SLI4.
858 		 */
859 		lpfc_unreg_login(phba, vport->vpi, phba->vpi_ids[vport->vpi],
860 				 mbox);
861 		mbox->u.mb.un.varUnregLogin.rsvd1 = 0x4000;
862 		mbox->vport = vport;
863 		mbox->mbox_cmpl = lpfc_sli_def_mbox_cmpl;
864 		mbox->ctx_ndlp = NULL;
865 		rc = lpfc_sli_issue_mbox(phba, mbox, MBX_NOWAIT);
866 		if (rc == MBX_NOT_FINISHED)
867 			mempool_free(mbox, phba->mbox_mem_pool);
868 	}
869 }
870 
871 /**
872  * lpfc_reg_vpi - Prepare a mailbox command for registering vport identifier
873  * @vport: pointer to a vport object.
874  * @pmb: pointer to the driver internal queue element for mailbox command.
875  *
876  * The registration vport identifier mailbox command is used to activate a
877  * virtual N_Port after it has acquired an N_Port_ID. The HBA validates the
878  * N_Port_ID against the information in the selected virtual N_Port context
879  * block and marks it active to allow normal processing of IOCB commands and
880  * received unsolicited exchanges.
881  *
882  * This routine prepares the mailbox command for registering a virtual N_Port.
883  **/
884 void
885 lpfc_reg_vpi(struct lpfc_vport *vport, LPFC_MBOXQ_t *pmb)
886 {
887 	MAILBOX_t *mb = &pmb->u.mb;
888 	struct lpfc_hba *phba = vport->phba;
889 
890 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
891 	/*
892 	 * Set the re-reg VPI bit for f/w to update the MAC address.
893 	 */
894 	if ((phba->sli_rev == LPFC_SLI_REV4) &&
895 		!(vport->fc_flag & FC_VPORT_NEEDS_REG_VPI))
896 		mb->un.varRegVpi.upd = 1;
897 
898 	mb->un.varRegVpi.vpi = phba->vpi_ids[vport->vpi];
899 	mb->un.varRegVpi.sid = vport->fc_myDID;
900 	if (phba->sli_rev == LPFC_SLI_REV4)
901 		mb->un.varRegVpi.vfi = phba->sli4_hba.vfi_ids[vport->vfi];
902 	else
903 		mb->un.varRegVpi.vfi = vport->vfi + vport->phba->vfi_base;
904 	memcpy(mb->un.varRegVpi.wwn, &vport->fc_portname,
905 	       sizeof(struct lpfc_name));
906 	mb->un.varRegVpi.wwn[0] = cpu_to_le32(mb->un.varRegVpi.wwn[0]);
907 	mb->un.varRegVpi.wwn[1] = cpu_to_le32(mb->un.varRegVpi.wwn[1]);
908 
909 	mb->mbxCommand = MBX_REG_VPI;
910 	mb->mbxOwner = OWN_HOST;
911 	return;
912 
913 }
914 
915 /**
916  * lpfc_unreg_vpi - Prepare a mailbox command for unregistering vport id
917  * @phba: pointer to lpfc hba data structure.
918  * @vpi: virtual N_Port identifier.
919  * @pmb: pointer to the driver internal queue element for mailbox command.
920  *
921  * The unregistration vport identifier mailbox command is used to inactivate
922  * a virtual N_Port. The driver must have logged out and unregistered all
923  * remote N_Ports to abort any activity on the virtual N_Port. The HBA will
924  * unregisters any default RPIs associated with the specified vpi, aborting
925  * any active exchanges. The HBA will post the mailbox response after making
926  * the virtual N_Port inactive.
927  *
928  * This routine prepares the mailbox command for unregistering a virtual
929  * N_Port.
930  **/
931 void
932 lpfc_unreg_vpi(struct lpfc_hba *phba, uint16_t vpi, LPFC_MBOXQ_t *pmb)
933 {
934 	MAILBOX_t *mb = &pmb->u.mb;
935 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
936 
937 	if (phba->sli_rev == LPFC_SLI_REV3)
938 		mb->un.varUnregVpi.vpi = phba->vpi_ids[vpi];
939 	else if (phba->sli_rev >= LPFC_SLI_REV4)
940 		mb->un.varUnregVpi.sli4_vpi = phba->vpi_ids[vpi];
941 
942 	mb->mbxCommand = MBX_UNREG_VPI;
943 	mb->mbxOwner = OWN_HOST;
944 	return;
945 
946 }
947 
948 /**
949  * lpfc_config_pcb_setup - Set up IOCB rings in the Port Control Block (PCB)
950  * @phba: pointer to lpfc hba data structure.
951  *
952  * This routine sets up and initializes the IOCB rings in the Port Control
953  * Block (PCB).
954  **/
955 static void
956 lpfc_config_pcb_setup(struct lpfc_hba * phba)
957 {
958 	struct lpfc_sli *psli = &phba->sli;
959 	struct lpfc_sli_ring *pring;
960 	PCB_t *pcbp = phba->pcb;
961 	dma_addr_t pdma_addr;
962 	uint32_t offset;
963 	uint32_t iocbCnt = 0;
964 	int i;
965 
966 	pcbp->maxRing = (psli->num_rings - 1);
967 
968 	for (i = 0; i < psli->num_rings; i++) {
969 		pring = &psli->sli3_ring[i];
970 
971 		pring->sli.sli3.sizeCiocb =
972 			phba->sli_rev == 3 ? SLI3_IOCB_CMD_SIZE :
973 							SLI2_IOCB_CMD_SIZE;
974 		pring->sli.sli3.sizeRiocb =
975 			phba->sli_rev == 3 ? SLI3_IOCB_RSP_SIZE :
976 							SLI2_IOCB_RSP_SIZE;
977 		/* A ring MUST have both cmd and rsp entries defined to be
978 		   valid */
979 		if ((pring->sli.sli3.numCiocb == 0) ||
980 			(pring->sli.sli3.numRiocb == 0)) {
981 			pcbp->rdsc[i].cmdEntries = 0;
982 			pcbp->rdsc[i].rspEntries = 0;
983 			pcbp->rdsc[i].cmdAddrHigh = 0;
984 			pcbp->rdsc[i].rspAddrHigh = 0;
985 			pcbp->rdsc[i].cmdAddrLow = 0;
986 			pcbp->rdsc[i].rspAddrLow = 0;
987 			pring->sli.sli3.cmdringaddr = NULL;
988 			pring->sli.sli3.rspringaddr = NULL;
989 			continue;
990 		}
991 		/* Command ring setup for ring */
992 		pring->sli.sli3.cmdringaddr = (void *)&phba->IOCBs[iocbCnt];
993 		pcbp->rdsc[i].cmdEntries = pring->sli.sli3.numCiocb;
994 
995 		offset = (uint8_t *) &phba->IOCBs[iocbCnt] -
996 			 (uint8_t *) phba->slim2p.virt;
997 		pdma_addr = phba->slim2p.phys + offset;
998 		pcbp->rdsc[i].cmdAddrHigh = putPaddrHigh(pdma_addr);
999 		pcbp->rdsc[i].cmdAddrLow = putPaddrLow(pdma_addr);
1000 		iocbCnt += pring->sli.sli3.numCiocb;
1001 
1002 		/* Response ring setup for ring */
1003 		pring->sli.sli3.rspringaddr = (void *) &phba->IOCBs[iocbCnt];
1004 
1005 		pcbp->rdsc[i].rspEntries = pring->sli.sli3.numRiocb;
1006 		offset = (uint8_t *)&phba->IOCBs[iocbCnt] -
1007 			 (uint8_t *)phba->slim2p.virt;
1008 		pdma_addr = phba->slim2p.phys + offset;
1009 		pcbp->rdsc[i].rspAddrHigh = putPaddrHigh(pdma_addr);
1010 		pcbp->rdsc[i].rspAddrLow = putPaddrLow(pdma_addr);
1011 		iocbCnt += pring->sli.sli3.numRiocb;
1012 	}
1013 }
1014 
1015 /**
1016  * lpfc_read_rev - Prepare a mailbox command for reading HBA revision
1017  * @phba: pointer to lpfc hba data structure.
1018  * @pmb: pointer to the driver internal queue element for mailbox command.
1019  *
1020  * The read revision mailbox command is used to read the revision levels of
1021  * the HBA components. These components include hardware units, resident
1022  * firmware, and available firmware. HBAs that supports SLI-3 mode of
1023  * operation provide different response information depending on the version
1024  * requested by the driver.
1025  *
1026  * This routine prepares the mailbox command for reading HBA revision
1027  * information.
1028  **/
1029 void
1030 lpfc_read_rev(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
1031 {
1032 	MAILBOX_t *mb = &pmb->u.mb;
1033 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
1034 	mb->un.varRdRev.cv = 1;
1035 	mb->un.varRdRev.v3req = 1; /* Request SLI3 info */
1036 	mb->mbxCommand = MBX_READ_REV;
1037 	mb->mbxOwner = OWN_HOST;
1038 	return;
1039 }
1040 
1041 void
1042 lpfc_sli4_swap_str(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb)
1043 {
1044 	MAILBOX_t *mb = &pmb->u.mb;
1045 	struct lpfc_mqe *mqe;
1046 
1047 	switch (mb->mbxCommand) {
1048 	case  MBX_READ_REV:
1049 		 mqe = &pmb->u.mqe;
1050 		lpfc_sli_pcimem_bcopy(mqe->un.read_rev.fw_name,
1051 				 mqe->un.read_rev.fw_name, 16);
1052 		lpfc_sli_pcimem_bcopy(mqe->un.read_rev.ulp_fw_name,
1053 				 mqe->un.read_rev.ulp_fw_name, 16);
1054 		break;
1055 	default:
1056 		break;
1057 	}
1058 	return;
1059 }
1060 
1061 /**
1062  * lpfc_build_hbq_profile2 - Set up the HBQ Selection Profile 2
1063  * @hbqmb: pointer to the HBQ configuration data structure in mailbox command.
1064  * @hbq_desc: pointer to the HBQ selection profile descriptor.
1065  *
1066  * The Host Buffer Queue (HBQ) Selection Profile 2 specifies that the HBA
1067  * tests the incoming frames' R_CTL/TYPE fields with works 10:15 and performs
1068  * the Sequence Length Test using the fields in the Selection Profile 2
1069  * extension in words 20:31.
1070  **/
1071 static void
1072 lpfc_build_hbq_profile2(struct config_hbq_var *hbqmb,
1073 			struct lpfc_hbq_init  *hbq_desc)
1074 {
1075 	hbqmb->profiles.profile2.seqlenbcnt = hbq_desc->seqlenbcnt;
1076 	hbqmb->profiles.profile2.maxlen     = hbq_desc->maxlen;
1077 	hbqmb->profiles.profile2.seqlenoff  = hbq_desc->seqlenoff;
1078 }
1079 
1080 /**
1081  * lpfc_build_hbq_profile3 - Set up the HBQ Selection Profile 3
1082  * @hbqmb: pointer to the HBQ configuration data structure in mailbox command.
1083  * @hbq_desc: pointer to the HBQ selection profile descriptor.
1084  *
1085  * The Host Buffer Queue (HBQ) Selection Profile 3 specifies that the HBA
1086  * tests the incoming frame's R_CTL/TYPE fields with words 10:15 and performs
1087  * the Sequence Length Test and Byte Field Test using the fields in the
1088  * Selection Profile 3 extension in words 20:31.
1089  **/
1090 static void
1091 lpfc_build_hbq_profile3(struct config_hbq_var *hbqmb,
1092 			struct lpfc_hbq_init  *hbq_desc)
1093 {
1094 	hbqmb->profiles.profile3.seqlenbcnt = hbq_desc->seqlenbcnt;
1095 	hbqmb->profiles.profile3.maxlen     = hbq_desc->maxlen;
1096 	hbqmb->profiles.profile3.cmdcodeoff = hbq_desc->cmdcodeoff;
1097 	hbqmb->profiles.profile3.seqlenoff  = hbq_desc->seqlenoff;
1098 	memcpy(&hbqmb->profiles.profile3.cmdmatch, hbq_desc->cmdmatch,
1099 	       sizeof(hbqmb->profiles.profile3.cmdmatch));
1100 }
1101 
1102 /**
1103  * lpfc_build_hbq_profile5 - Set up the HBQ Selection Profile 5
1104  * @hbqmb: pointer to the HBQ configuration data structure in mailbox command.
1105  * @hbq_desc: pointer to the HBQ selection profile descriptor.
1106  *
1107  * The Host Buffer Queue (HBQ) Selection Profile 5 specifies a header HBQ. The
1108  * HBA tests the initial frame of an incoming sequence using the frame's
1109  * R_CTL/TYPE fields with words 10:15 and performs the Sequence Length Test
1110  * and Byte Field Test using the fields in the Selection Profile 5 extension
1111  * words 20:31.
1112  **/
1113 static void
1114 lpfc_build_hbq_profile5(struct config_hbq_var *hbqmb,
1115 			struct lpfc_hbq_init  *hbq_desc)
1116 {
1117 	hbqmb->profiles.profile5.seqlenbcnt = hbq_desc->seqlenbcnt;
1118 	hbqmb->profiles.profile5.maxlen     = hbq_desc->maxlen;
1119 	hbqmb->profiles.profile5.cmdcodeoff = hbq_desc->cmdcodeoff;
1120 	hbqmb->profiles.profile5.seqlenoff  = hbq_desc->seqlenoff;
1121 	memcpy(&hbqmb->profiles.profile5.cmdmatch, hbq_desc->cmdmatch,
1122 	       sizeof(hbqmb->profiles.profile5.cmdmatch));
1123 }
1124 
1125 /**
1126  * lpfc_config_hbq - Prepare a mailbox command for configuring an HBQ
1127  * @phba: pointer to lpfc hba data structure.
1128  * @id: HBQ identifier.
1129  * @hbq_desc: pointer to the HBA descriptor data structure.
1130  * @hbq_entry_index: index of the HBQ entry data structures.
1131  * @pmb: pointer to the driver internal queue element for mailbox command.
1132  *
1133  * The configure HBQ (Host Buffer Queue) mailbox command is used to configure
1134  * an HBQ. The configuration binds events that require buffers to a particular
1135  * ring and HBQ based on a selection profile.
1136  *
1137  * This routine prepares the mailbox command for configuring an HBQ.
1138  **/
1139 void
1140 lpfc_config_hbq(struct lpfc_hba *phba, uint32_t id,
1141 		 struct lpfc_hbq_init *hbq_desc,
1142 		uint32_t hbq_entry_index, LPFC_MBOXQ_t *pmb)
1143 {
1144 	int i;
1145 	MAILBOX_t *mb = &pmb->u.mb;
1146 	struct config_hbq_var *hbqmb = &mb->un.varCfgHbq;
1147 
1148 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
1149 	hbqmb->hbqId = id;
1150 	hbqmb->entry_count = hbq_desc->entry_count;   /* # entries in HBQ */
1151 	hbqmb->recvNotify = hbq_desc->rn;             /* Receive
1152 						       * Notification */
1153 	hbqmb->numMask    = hbq_desc->mask_count;     /* # R_CTL/TYPE masks
1154 						       * # in words 0-19 */
1155 	hbqmb->profile    = hbq_desc->profile;	      /* Selection profile:
1156 						       * 0 = all,
1157 						       * 7 = logentry */
1158 	hbqmb->ringMask   = hbq_desc->ring_mask;      /* Binds HBQ to a ring
1159 						       * e.g. Ring0=b0001,
1160 						       * ring2=b0100 */
1161 	hbqmb->headerLen  = hbq_desc->headerLen;      /* 0 if not profile 4
1162 						       * or 5 */
1163 	hbqmb->logEntry   = hbq_desc->logEntry;       /* Set to 1 if this
1164 						       * HBQ will be used
1165 						       * for LogEntry
1166 						       * buffers */
1167 	hbqmb->hbqaddrLow = putPaddrLow(phba->hbqslimp.phys) +
1168 		hbq_entry_index * sizeof(struct lpfc_hbq_entry);
1169 	hbqmb->hbqaddrHigh = putPaddrHigh(phba->hbqslimp.phys);
1170 
1171 	mb->mbxCommand = MBX_CONFIG_HBQ;
1172 	mb->mbxOwner = OWN_HOST;
1173 
1174 				/* Copy info for profiles 2,3,5. Other
1175 				 * profiles this area is reserved
1176 				 */
1177 	if (hbq_desc->profile == 2)
1178 		lpfc_build_hbq_profile2(hbqmb, hbq_desc);
1179 	else if (hbq_desc->profile == 3)
1180 		lpfc_build_hbq_profile3(hbqmb, hbq_desc);
1181 	else if (hbq_desc->profile == 5)
1182 		lpfc_build_hbq_profile5(hbqmb, hbq_desc);
1183 
1184 	/* Return if no rctl / type masks for this HBQ */
1185 	if (!hbq_desc->mask_count)
1186 		return;
1187 
1188 	/* Otherwise we setup specific rctl / type masks for this HBQ */
1189 	for (i = 0; i < hbq_desc->mask_count; i++) {
1190 		hbqmb->hbqMasks[i].tmatch = hbq_desc->hbqMasks[i].tmatch;
1191 		hbqmb->hbqMasks[i].tmask  = hbq_desc->hbqMasks[i].tmask;
1192 		hbqmb->hbqMasks[i].rctlmatch = hbq_desc->hbqMasks[i].rctlmatch;
1193 		hbqmb->hbqMasks[i].rctlmask  = hbq_desc->hbqMasks[i].rctlmask;
1194 	}
1195 
1196 	return;
1197 }
1198 
1199 /**
1200  * lpfc_config_ring - Prepare a mailbox command for configuring an IOCB ring
1201  * @phba: pointer to lpfc hba data structure.
1202  * @ring: ring number/index
1203  * @pmb: pointer to the driver internal queue element for mailbox command.
1204  *
1205  * The configure ring mailbox command is used to configure an IOCB ring. This
1206  * configuration binds from one to six of HBA RC_CTL/TYPE mask entries to the
1207  * ring. This is used to map incoming sequences to a particular ring whose
1208  * RC_CTL/TYPE mask entry matches that of the sequence. The driver should not
1209  * attempt to configure a ring whose number is greater than the number
1210  * specified in the Port Control Block (PCB). It is an error to issue the
1211  * configure ring command more than once with the same ring number. The HBA
1212  * returns an error if the driver attempts this.
1213  *
1214  * This routine prepares the mailbox command for configuring IOCB ring.
1215  **/
1216 void
1217 lpfc_config_ring(struct lpfc_hba * phba, int ring, LPFC_MBOXQ_t * pmb)
1218 {
1219 	int i;
1220 	MAILBOX_t *mb = &pmb->u.mb;
1221 	struct lpfc_sli *psli;
1222 	struct lpfc_sli_ring *pring;
1223 
1224 	memset(pmb, 0, sizeof (LPFC_MBOXQ_t));
1225 
1226 	mb->un.varCfgRing.ring = ring;
1227 	mb->un.varCfgRing.maxOrigXchg = 0;
1228 	mb->un.varCfgRing.maxRespXchg = 0;
1229 	mb->un.varCfgRing.recvNotify = 1;
1230 
1231 	psli = &phba->sli;
1232 	pring = &psli->sli3_ring[ring];
1233 	mb->un.varCfgRing.numMask = pring->num_mask;
1234 	mb->mbxCommand = MBX_CONFIG_RING;
1235 	mb->mbxOwner = OWN_HOST;
1236 
1237 	/* Is this ring configured for a specific profile */
1238 	if (pring->prt[0].profile) {
1239 		mb->un.varCfgRing.profile = pring->prt[0].profile;
1240 		return;
1241 	}
1242 
1243 	/* Otherwise we setup specific rctl / type masks for this ring */
1244 	for (i = 0; i < pring->num_mask; i++) {
1245 		mb->un.varCfgRing.rrRegs[i].rval = pring->prt[i].rctl;
1246 		if (mb->un.varCfgRing.rrRegs[i].rval != FC_RCTL_ELS_REQ)
1247 			mb->un.varCfgRing.rrRegs[i].rmask = 0xff;
1248 		else
1249 			mb->un.varCfgRing.rrRegs[i].rmask = 0xfe;
1250 		mb->un.varCfgRing.rrRegs[i].tval = pring->prt[i].type;
1251 		mb->un.varCfgRing.rrRegs[i].tmask = 0xff;
1252 	}
1253 
1254 	return;
1255 }
1256 
1257 /**
1258  * lpfc_config_port - Prepare a mailbox command for configuring port
1259  * @phba: pointer to lpfc hba data structure.
1260  * @pmb: pointer to the driver internal queue element for mailbox command.
1261  *
1262  * The configure port mailbox command is used to identify the Port Control
1263  * Block (PCB) in the driver memory. After this command is issued, the
1264  * driver must not access the mailbox in the HBA without first resetting
1265  * the HBA. The HBA may copy the PCB information to internal storage for
1266  * subsequent use; the driver can not change the PCB information unless it
1267  * resets the HBA.
1268  *
1269  * This routine prepares the mailbox command for configuring port.
1270  **/
1271 void
1272 lpfc_config_port(struct lpfc_hba *phba, LPFC_MBOXQ_t *pmb)
1273 {
1274 	MAILBOX_t __iomem *mb_slim = (MAILBOX_t __iomem *) phba->MBslimaddr;
1275 	MAILBOX_t *mb = &pmb->u.mb;
1276 	dma_addr_t pdma_addr;
1277 	uint32_t bar_low, bar_high;
1278 	size_t offset;
1279 	struct lpfc_hgp hgp;
1280 	int i;
1281 	uint32_t pgp_offset;
1282 
1283 	memset(pmb, 0, sizeof(LPFC_MBOXQ_t));
1284 	mb->mbxCommand = MBX_CONFIG_PORT;
1285 	mb->mbxOwner = OWN_HOST;
1286 
1287 	mb->un.varCfgPort.pcbLen = sizeof(PCB_t);
1288 
1289 	offset = (uint8_t *)phba->pcb - (uint8_t *)phba->slim2p.virt;
1290 	pdma_addr = phba->slim2p.phys + offset;
1291 	mb->un.varCfgPort.pcbLow = putPaddrLow(pdma_addr);
1292 	mb->un.varCfgPort.pcbHigh = putPaddrHigh(pdma_addr);
1293 
1294 	/* Always Host Group Pointer is in SLIM */
1295 	mb->un.varCfgPort.hps = 1;
1296 
1297 	/* If HBA supports SLI=3 ask for it */
1298 
1299 	if (phba->sli_rev == LPFC_SLI_REV3 && phba->vpd.sli3Feat.cerbm) {
1300 		if (phba->cfg_enable_bg)
1301 			mb->un.varCfgPort.cbg = 1; /* configure BlockGuard */
1302 		mb->un.varCfgPort.cerbm = 1; /* Request HBQs */
1303 		mb->un.varCfgPort.ccrp = 1; /* Command Ring Polling */
1304 		mb->un.varCfgPort.max_hbq = lpfc_sli_hbq_count();
1305 		if (phba->max_vpi && phba->cfg_enable_npiv &&
1306 		    phba->vpd.sli3Feat.cmv) {
1307 			mb->un.varCfgPort.max_vpi = LPFC_MAX_VPI;
1308 			mb->un.varCfgPort.cmv = 1;
1309 		} else
1310 			mb->un.varCfgPort.max_vpi = phba->max_vpi = 0;
1311 	} else
1312 		phba->sli_rev = LPFC_SLI_REV2;
1313 	mb->un.varCfgPort.sli_mode = phba->sli_rev;
1314 
1315 	/* If this is an SLI3 port, configure async status notification. */
1316 	if (phba->sli_rev == LPFC_SLI_REV3)
1317 		mb->un.varCfgPort.casabt = 1;
1318 
1319 	/* Now setup pcb */
1320 	phba->pcb->type = TYPE_NATIVE_SLI2;
1321 	phba->pcb->feature = FEATURE_INITIAL_SLI2;
1322 
1323 	/* Setup Mailbox pointers */
1324 	phba->pcb->mailBoxSize = sizeof(MAILBOX_t) + MAILBOX_EXT_SIZE;
1325 	offset = (uint8_t *)phba->mbox - (uint8_t *)phba->slim2p.virt;
1326 	pdma_addr = phba->slim2p.phys + offset;
1327 	phba->pcb->mbAddrHigh = putPaddrHigh(pdma_addr);
1328 	phba->pcb->mbAddrLow = putPaddrLow(pdma_addr);
1329 
1330 	/*
1331 	 * Setup Host Group ring pointer.
1332 	 *
1333 	 * For efficiency reasons, the ring get/put pointers can be
1334 	 * placed in adapter memory (SLIM) rather than in host memory.
1335 	 * This allows firmware to avoid PCI reads/writes when updating
1336 	 * and checking pointers.
1337 	 *
1338 	 * The firmware recognizes the use of SLIM memory by comparing
1339 	 * the address of the get/put pointers structure with that of
1340 	 * the SLIM BAR (BAR0).
1341 	 *
1342 	 * Caution: be sure to use the PCI config space value of BAR0/BAR1
1343 	 * (the hardware's view of the base address), not the OS's
1344 	 * value of pci_resource_start() as the OS value may be a cookie
1345 	 * for ioremap/iomap.
1346 	 */
1347 
1348 
1349 	pci_read_config_dword(phba->pcidev, PCI_BASE_ADDRESS_0, &bar_low);
1350 	pci_read_config_dword(phba->pcidev, PCI_BASE_ADDRESS_1, &bar_high);
1351 
1352 	/*
1353 	 * Set up HGP - Port Memory
1354 	 *
1355 	 * The port expects the host get/put pointers to reside in memory
1356 	 * following the "non-diagnostic" mode mailbox (32 words, 0x80 bytes)
1357 	 * area of SLIM.  In SLI-2 mode, there's an additional 16 reserved
1358 	 * words (0x40 bytes).  This area is not reserved if HBQs are
1359 	 * configured in SLI-3.
1360 	 *
1361 	 * CR0Put    - SLI2(no HBQs) = 0xc0, With HBQs = 0x80
1362 	 * RR0Get                      0xc4              0x84
1363 	 * CR1Put                      0xc8              0x88
1364 	 * RR1Get                      0xcc              0x8c
1365 	 * CR2Put                      0xd0              0x90
1366 	 * RR2Get                      0xd4              0x94
1367 	 * CR3Put                      0xd8              0x98
1368 	 * RR3Get                      0xdc              0x9c
1369 	 *
1370 	 * Reserved                    0xa0-0xbf
1371 	 *    If HBQs configured:
1372 	 *                         HBQ 0 Put ptr  0xc0
1373 	 *                         HBQ 1 Put ptr  0xc4
1374 	 *                         HBQ 2 Put ptr  0xc8
1375 	 *                         ......
1376 	 *                         HBQ(M-1)Put Pointer 0xc0+(M-1)*4
1377 	 *
1378 	 */
1379 
1380 	if (phba->cfg_hostmem_hgp && phba->sli_rev != 3) {
1381 		phba->host_gp = (struct lpfc_hgp __iomem *)
1382 				 &phba->mbox->us.s2.host[0];
1383 		phba->hbq_put = NULL;
1384 		offset = (uint8_t *)&phba->mbox->us.s2.host -
1385 			(uint8_t *)phba->slim2p.virt;
1386 		pdma_addr = phba->slim2p.phys + offset;
1387 		phba->pcb->hgpAddrHigh = putPaddrHigh(pdma_addr);
1388 		phba->pcb->hgpAddrLow = putPaddrLow(pdma_addr);
1389 	} else {
1390 		/* Always Host Group Pointer is in SLIM */
1391 		mb->un.varCfgPort.hps = 1;
1392 
1393 		if (phba->sli_rev == 3) {
1394 			phba->host_gp = &mb_slim->us.s3.host[0];
1395 			phba->hbq_put = &mb_slim->us.s3.hbq_put[0];
1396 		} else {
1397 			phba->host_gp = &mb_slim->us.s2.host[0];
1398 			phba->hbq_put = NULL;
1399 		}
1400 
1401 		/* mask off BAR0's flag bits 0 - 3 */
1402 		phba->pcb->hgpAddrLow = (bar_low & PCI_BASE_ADDRESS_MEM_MASK) +
1403 			(void __iomem *)phba->host_gp -
1404 			(void __iomem *)phba->MBslimaddr;
1405 		if (bar_low & PCI_BASE_ADDRESS_MEM_TYPE_64)
1406 			phba->pcb->hgpAddrHigh = bar_high;
1407 		else
1408 			phba->pcb->hgpAddrHigh = 0;
1409 		/* write HGP data to SLIM at the required longword offset */
1410 		memset(&hgp, 0, sizeof(struct lpfc_hgp));
1411 
1412 		for (i = 0; i < phba->sli.num_rings; i++) {
1413 			lpfc_memcpy_to_slim(phba->host_gp + i, &hgp,
1414 				    sizeof(*phba->host_gp));
1415 		}
1416 	}
1417 
1418 	/* Setup Port Group offset */
1419 	if (phba->sli_rev == 3)
1420 		pgp_offset = offsetof(struct lpfc_sli2_slim,
1421 				      mbx.us.s3_pgp.port);
1422 	else
1423 		pgp_offset = offsetof(struct lpfc_sli2_slim, mbx.us.s2.port);
1424 	pdma_addr = phba->slim2p.phys + pgp_offset;
1425 	phba->pcb->pgpAddrHigh = putPaddrHigh(pdma_addr);
1426 	phba->pcb->pgpAddrLow = putPaddrLow(pdma_addr);
1427 
1428 	/* Use callback routine to setp rings in the pcb */
1429 	lpfc_config_pcb_setup(phba);
1430 
1431 	/* special handling for LC HBAs */
1432 	if (lpfc_is_LC_HBA(phba->pcidev->device)) {
1433 		uint32_t hbainit[5];
1434 
1435 		lpfc_hba_init(phba, hbainit);
1436 
1437 		memcpy(&mb->un.varCfgPort.hbainit, hbainit, 20);
1438 	}
1439 
1440 	/* Swap PCB if needed */
1441 	lpfc_sli_pcimem_bcopy(phba->pcb, phba->pcb, sizeof(PCB_t));
1442 }
1443 
1444 /**
1445  * lpfc_kill_board - Prepare a mailbox command for killing board
1446  * @phba: pointer to lpfc hba data structure.
1447  * @pmb: pointer to the driver internal queue element for mailbox command.
1448  *
1449  * The kill board mailbox command is used to tell firmware to perform a
1450  * graceful shutdown of a channel on a specified board to prepare for reset.
1451  * When the kill board mailbox command is received, the ER3 bit is set to 1
1452  * in the Host Status register and the ER Attention bit is set to 1 in the
1453  * Host Attention register of the HBA function that received the kill board
1454  * command.
1455  *
1456  * This routine prepares the mailbox command for killing the board in
1457  * preparation for a graceful shutdown.
1458  **/
1459 void
1460 lpfc_kill_board(struct lpfc_hba * phba, LPFC_MBOXQ_t * pmb)
1461 {
1462 	MAILBOX_t *mb = &pmb->u.mb;
1463 
1464 	memset(pmb, 0, sizeof(LPFC_MBOXQ_t));
1465 	mb->mbxCommand = MBX_KILL_BOARD;
1466 	mb->mbxOwner = OWN_HOST;
1467 	return;
1468 }
1469 
1470 /**
1471  * lpfc_mbox_put - Put a mailbox cmd into the tail of driver's mailbox queue
1472  * @phba: pointer to lpfc hba data structure.
1473  * @mbq: pointer to the driver internal queue element for mailbox command.
1474  *
1475  * Driver maintains a internal mailbox command queue implemented as a linked
1476  * list. When a mailbox command is issued, it shall be put into the mailbox
1477  * command queue such that they shall be processed orderly as HBA can process
1478  * one mailbox command at a time.
1479  **/
1480 void
1481 lpfc_mbox_put(struct lpfc_hba * phba, LPFC_MBOXQ_t * mbq)
1482 {
1483 	struct lpfc_sli *psli;
1484 
1485 	psli = &phba->sli;
1486 
1487 	list_add_tail(&mbq->list, &psli->mboxq);
1488 
1489 	psli->mboxq_cnt++;
1490 
1491 	return;
1492 }
1493 
1494 /**
1495  * lpfc_mbox_get - Remove a mailbox cmd from the head of driver's mailbox queue
1496  * @phba: pointer to lpfc hba data structure.
1497  *
1498  * Driver maintains a internal mailbox command queue implemented as a linked
1499  * list. When a mailbox command is issued, it shall be put into the mailbox
1500  * command queue such that they shall be processed orderly as HBA can process
1501  * one mailbox command at a time. After HBA finished processing a mailbox
1502  * command, the driver will remove a pending mailbox command from the head of
1503  * the mailbox command queue and send to the HBA for processing.
1504  *
1505  * Return codes
1506  *    pointer to the driver internal queue element for mailbox command.
1507  **/
1508 LPFC_MBOXQ_t *
1509 lpfc_mbox_get(struct lpfc_hba * phba)
1510 {
1511 	LPFC_MBOXQ_t *mbq = NULL;
1512 	struct lpfc_sli *psli = &phba->sli;
1513 
1514 	list_remove_head((&psli->mboxq), mbq, LPFC_MBOXQ_t, list);
1515 	if (mbq)
1516 		psli->mboxq_cnt--;
1517 
1518 	return mbq;
1519 }
1520 
1521 /**
1522  * __lpfc_mbox_cmpl_put - Put mailbox cmd into mailbox cmd complete list
1523  * @phba: pointer to lpfc hba data structure.
1524  * @mbq: pointer to the driver internal queue element for mailbox command.
1525  *
1526  * This routine put the completed mailbox command into the mailbox command
1527  * complete list. This is the unlocked version of the routine. The mailbox
1528  * complete list is used by the driver worker thread to process mailbox
1529  * complete callback functions outside the driver interrupt handler.
1530  **/
1531 void
1532 __lpfc_mbox_cmpl_put(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbq)
1533 {
1534 	list_add_tail(&mbq->list, &phba->sli.mboxq_cmpl);
1535 }
1536 
1537 /**
1538  * lpfc_mbox_cmpl_put - Put mailbox command into mailbox command complete list
1539  * @phba: pointer to lpfc hba data structure.
1540  * @mbq: pointer to the driver internal queue element for mailbox command.
1541  *
1542  * This routine put the completed mailbox command into the mailbox command
1543  * complete list. This is the locked version of the routine. The mailbox
1544  * complete list is used by the driver worker thread to process mailbox
1545  * complete callback functions outside the driver interrupt handler.
1546  **/
1547 void
1548 lpfc_mbox_cmpl_put(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbq)
1549 {
1550 	unsigned long iflag;
1551 
1552 	/* This function expects to be called from interrupt context */
1553 	spin_lock_irqsave(&phba->hbalock, iflag);
1554 	__lpfc_mbox_cmpl_put(phba, mbq);
1555 	spin_unlock_irqrestore(&phba->hbalock, iflag);
1556 	return;
1557 }
1558 
1559 /**
1560  * lpfc_mbox_cmd_check - Check the validality of a mailbox command
1561  * @phba: pointer to lpfc hba data structure.
1562  * @mboxq: pointer to the driver internal queue element for mailbox command.
1563  *
1564  * This routine is to check whether a mailbox command is valid to be issued.
1565  * This check will be performed by both the mailbox issue API when a client
1566  * is to issue a mailbox command to the mailbox transport.
1567  *
1568  * Return 0 - pass the check, -ENODEV - fail the check
1569  **/
1570 int
1571 lpfc_mbox_cmd_check(struct lpfc_hba *phba, LPFC_MBOXQ_t *mboxq)
1572 {
1573 	/* Mailbox command that have a completion handler must also have a
1574 	 * vport specified.
1575 	 */
1576 	if (mboxq->mbox_cmpl && mboxq->mbox_cmpl != lpfc_sli_def_mbox_cmpl &&
1577 	    mboxq->mbox_cmpl != lpfc_sli_wake_mbox_wait) {
1578 		if (!mboxq->vport) {
1579 			lpfc_printf_log(phba, KERN_ERR, LOG_MBOX | LOG_VPORT,
1580 					"1814 Mbox x%x failed, no vport\n",
1581 					mboxq->u.mb.mbxCommand);
1582 			dump_stack();
1583 			return -ENODEV;
1584 		}
1585 	}
1586 	return 0;
1587 }
1588 
1589 /**
1590  * lpfc_mbox_dev_check - Check the device state for issuing a mailbox command
1591  * @phba: pointer to lpfc hba data structure.
1592  *
1593  * This routine is to check whether the HBA device is ready for posting a
1594  * mailbox command. It is used by the mailbox transport API at the time the
1595  * to post a mailbox command to the device.
1596  *
1597  * Return 0 - pass the check, -ENODEV - fail the check
1598  **/
1599 int
1600 lpfc_mbox_dev_check(struct lpfc_hba *phba)
1601 {
1602 	/* If the PCI channel is in offline state, do not issue mbox */
1603 	if (unlikely(pci_channel_offline(phba->pcidev)))
1604 		return -ENODEV;
1605 
1606 	/* If the HBA is in error state, do not issue mbox */
1607 	if (phba->link_state == LPFC_HBA_ERROR)
1608 		return -ENODEV;
1609 
1610 	return 0;
1611 }
1612 
1613 /**
1614  * lpfc_mbox_tmo_val - Retrieve mailbox command timeout value
1615  * @phba: pointer to lpfc hba data structure.
1616  * @mboxq: pointer to the driver internal queue element for mailbox command.
1617  *
1618  * This routine retrieves the proper timeout value according to the mailbox
1619  * command code.
1620  *
1621  * Return codes
1622  *    Timeout value to be used for the given mailbox command
1623  **/
1624 int
1625 lpfc_mbox_tmo_val(struct lpfc_hba *phba, LPFC_MBOXQ_t *mboxq)
1626 {
1627 	MAILBOX_t *mbox = &mboxq->u.mb;
1628 	uint8_t subsys, opcode;
1629 
1630 	switch (mbox->mbxCommand) {
1631 	case MBX_WRITE_NV:	/* 0x03 */
1632 	case MBX_DUMP_MEMORY:	/* 0x17 */
1633 	case MBX_UPDATE_CFG:	/* 0x1B */
1634 	case MBX_DOWN_LOAD:	/* 0x1C */
1635 	case MBX_DEL_LD_ENTRY:	/* 0x1D */
1636 	case MBX_WRITE_VPARMS:	/* 0x32 */
1637 	case MBX_LOAD_AREA:	/* 0x81 */
1638 	case MBX_WRITE_WWN:     /* 0x98 */
1639 	case MBX_LOAD_EXP_ROM:	/* 0x9C */
1640 	case MBX_ACCESS_VDATA:	/* 0xA5 */
1641 		return LPFC_MBOX_TMO_FLASH_CMD;
1642 	case MBX_SLI4_CONFIG:	/* 0x9b */
1643 		subsys = lpfc_sli_config_mbox_subsys_get(phba, mboxq);
1644 		opcode = lpfc_sli_config_mbox_opcode_get(phba, mboxq);
1645 		if (subsys == LPFC_MBOX_SUBSYSTEM_COMMON) {
1646 			switch (opcode) {
1647 			case LPFC_MBOX_OPCODE_READ_OBJECT:
1648 			case LPFC_MBOX_OPCODE_WRITE_OBJECT:
1649 			case LPFC_MBOX_OPCODE_READ_OBJECT_LIST:
1650 			case LPFC_MBOX_OPCODE_DELETE_OBJECT:
1651 			case LPFC_MBOX_OPCODE_GET_PROFILE_LIST:
1652 			case LPFC_MBOX_OPCODE_SET_ACT_PROFILE:
1653 			case LPFC_MBOX_OPCODE_GET_PROFILE_CONFIG:
1654 			case LPFC_MBOX_OPCODE_SET_PROFILE_CONFIG:
1655 			case LPFC_MBOX_OPCODE_GET_FACTORY_PROFILE_CONFIG:
1656 			case LPFC_MBOX_OPCODE_GET_PROFILE_CAPACITIES:
1657 			case LPFC_MBOX_OPCODE_SEND_ACTIVATION:
1658 			case LPFC_MBOX_OPCODE_RESET_LICENSES:
1659 			case LPFC_MBOX_OPCODE_SET_BOOT_CONFIG:
1660 			case LPFC_MBOX_OPCODE_GET_VPD_DATA:
1661 			case LPFC_MBOX_OPCODE_SET_PHYSICAL_LINK_CONFIG:
1662 				return LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO;
1663 			}
1664 		}
1665 		if (subsys == LPFC_MBOX_SUBSYSTEM_FCOE) {
1666 			switch (opcode) {
1667 			case LPFC_MBOX_OPCODE_FCOE_SET_FCLINK_SETTINGS:
1668 				return LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO;
1669 			}
1670 		}
1671 		return LPFC_MBOX_SLI4_CONFIG_TMO;
1672 	}
1673 	return LPFC_MBOX_TMO;
1674 }
1675 
1676 /**
1677  * lpfc_sli4_mbx_sge_set - Set a sge entry in non-embedded mailbox command
1678  * @mbox: pointer to lpfc mbox command.
1679  * @sgentry: sge entry index.
1680  * @phyaddr: physical address for the sge
1681  * @length: Length of the sge.
1682  *
1683  * This routine sets up an entry in the non-embedded mailbox command at the sge
1684  * index location.
1685  **/
1686 void
1687 lpfc_sli4_mbx_sge_set(struct lpfcMboxq *mbox, uint32_t sgentry,
1688 		      dma_addr_t phyaddr, uint32_t length)
1689 {
1690 	struct lpfc_mbx_nembed_cmd *nembed_sge;
1691 
1692 	nembed_sge = (struct lpfc_mbx_nembed_cmd *)
1693 				&mbox->u.mqe.un.nembed_cmd;
1694 	nembed_sge->sge[sgentry].pa_lo = putPaddrLow(phyaddr);
1695 	nembed_sge->sge[sgentry].pa_hi = putPaddrHigh(phyaddr);
1696 	nembed_sge->sge[sgentry].length = length;
1697 }
1698 
1699 /**
1700  * lpfc_sli4_mbx_sge_get - Get a sge entry from non-embedded mailbox command
1701  * @mbox: pointer to lpfc mbox command.
1702  * @sgentry: sge entry index.
1703  * @sge: pointer to lpfc mailbox sge to load into.
1704  *
1705  * This routine gets an entry from the non-embedded mailbox command at the sge
1706  * index location.
1707  **/
1708 void
1709 lpfc_sli4_mbx_sge_get(struct lpfcMboxq *mbox, uint32_t sgentry,
1710 		      struct lpfc_mbx_sge *sge)
1711 {
1712 	struct lpfc_mbx_nembed_cmd *nembed_sge;
1713 
1714 	nembed_sge = (struct lpfc_mbx_nembed_cmd *)
1715 				&mbox->u.mqe.un.nembed_cmd;
1716 	sge->pa_lo = nembed_sge->sge[sgentry].pa_lo;
1717 	sge->pa_hi = nembed_sge->sge[sgentry].pa_hi;
1718 	sge->length = nembed_sge->sge[sgentry].length;
1719 }
1720 
1721 /**
1722  * lpfc_sli4_mbox_cmd_free - Free a sli4 mailbox command
1723  * @phba: pointer to lpfc hba data structure.
1724  * @mbox: pointer to lpfc mbox command.
1725  *
1726  * This routine frees SLI4 specific mailbox command for sending IOCTL command.
1727  **/
1728 void
1729 lpfc_sli4_mbox_cmd_free(struct lpfc_hba *phba, struct lpfcMboxq *mbox)
1730 {
1731 	struct lpfc_mbx_sli4_config *sli4_cfg;
1732 	struct lpfc_mbx_sge sge;
1733 	dma_addr_t phyaddr;
1734 	uint32_t sgecount, sgentry;
1735 
1736 	sli4_cfg = &mbox->u.mqe.un.sli4_config;
1737 
1738 	/* For embedded mbox command, just free the mbox command */
1739 	if (bf_get(lpfc_mbox_hdr_emb, &sli4_cfg->header.cfg_mhdr)) {
1740 		mempool_free(mbox, phba->mbox_mem_pool);
1741 		return;
1742 	}
1743 
1744 	/* For non-embedded mbox command, we need to free the pages first */
1745 	sgecount = bf_get(lpfc_mbox_hdr_sge_cnt, &sli4_cfg->header.cfg_mhdr);
1746 	/* There is nothing we can do if there is no sge address array */
1747 	if (unlikely(!mbox->sge_array)) {
1748 		mempool_free(mbox, phba->mbox_mem_pool);
1749 		return;
1750 	}
1751 	/* Each non-embedded DMA memory was allocated in the length of a page */
1752 	for (sgentry = 0; sgentry < sgecount; sgentry++) {
1753 		lpfc_sli4_mbx_sge_get(mbox, sgentry, &sge);
1754 		phyaddr = getPaddr(sge.pa_hi, sge.pa_lo);
1755 		dma_free_coherent(&phba->pcidev->dev, SLI4_PAGE_SIZE,
1756 				  mbox->sge_array->addr[sgentry], phyaddr);
1757 	}
1758 	/* Free the sge address array memory */
1759 	kfree(mbox->sge_array);
1760 	/* Finally, free the mailbox command itself */
1761 	mempool_free(mbox, phba->mbox_mem_pool);
1762 }
1763 
1764 /**
1765  * lpfc_sli4_config - Initialize the  SLI4 Config Mailbox command
1766  * @phba: pointer to lpfc hba data structure.
1767  * @mbox: pointer to lpfc mbox command.
1768  * @subsystem: The sli4 config sub mailbox subsystem.
1769  * @opcode: The sli4 config sub mailbox command opcode.
1770  * @length: Length of the sli4 config mailbox command (including sub-header).
1771  * @emb: True if embedded mbox command should be setup.
1772  *
1773  * This routine sets up the header fields of SLI4 specific mailbox command
1774  * for sending IOCTL command.
1775  *
1776  * Return: the actual length of the mbox command allocated (mostly useful
1777  *         for none embedded mailbox command).
1778  **/
1779 int
1780 lpfc_sli4_config(struct lpfc_hba *phba, struct lpfcMboxq *mbox,
1781 		 uint8_t subsystem, uint8_t opcode, uint32_t length, bool emb)
1782 {
1783 	struct lpfc_mbx_sli4_config *sli4_config;
1784 	union lpfc_sli4_cfg_shdr *cfg_shdr = NULL;
1785 	uint32_t alloc_len;
1786 	uint32_t resid_len;
1787 	uint32_t pagen, pcount;
1788 	void *viraddr;
1789 	dma_addr_t phyaddr;
1790 
1791 	/* Set up SLI4 mailbox command header fields */
1792 	memset(mbox, 0, sizeof(*mbox));
1793 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_SLI4_CONFIG);
1794 
1795 	/* Set up SLI4 ioctl command header fields */
1796 	sli4_config = &mbox->u.mqe.un.sli4_config;
1797 
1798 	/* Setup for the embedded mbox command */
1799 	if (emb) {
1800 		/* Set up main header fields */
1801 		bf_set(lpfc_mbox_hdr_emb, &sli4_config->header.cfg_mhdr, 1);
1802 		sli4_config->header.cfg_mhdr.payload_length = length;
1803 		/* Set up sub-header fields following main header */
1804 		bf_set(lpfc_mbox_hdr_opcode,
1805 			&sli4_config->header.cfg_shdr.request, opcode);
1806 		bf_set(lpfc_mbox_hdr_subsystem,
1807 			&sli4_config->header.cfg_shdr.request, subsystem);
1808 		sli4_config->header.cfg_shdr.request.request_length =
1809 			length - LPFC_MBX_CMD_HDR_LENGTH;
1810 		return length;
1811 	}
1812 
1813 	/* Setup for the non-embedded mbox command */
1814 	pcount = (SLI4_PAGE_ALIGN(length))/SLI4_PAGE_SIZE;
1815 	pcount = (pcount > LPFC_SLI4_MBX_SGE_MAX_PAGES) ?
1816 				LPFC_SLI4_MBX_SGE_MAX_PAGES : pcount;
1817 	/* Allocate record for keeping SGE virtual addresses */
1818 	mbox->sge_array = kzalloc(sizeof(struct lpfc_mbx_nembed_sge_virt),
1819 				  GFP_KERNEL);
1820 	if (!mbox->sge_array) {
1821 		lpfc_printf_log(phba, KERN_ERR, LOG_MBOX,
1822 				"2527 Failed to allocate non-embedded SGE "
1823 				"array.\n");
1824 		return 0;
1825 	}
1826 	for (pagen = 0, alloc_len = 0; pagen < pcount; pagen++) {
1827 		/* The DMA memory is always allocated in the length of a
1828 		 * page even though the last SGE might not fill up to a
1829 		 * page, this is used as a priori size of SLI4_PAGE_SIZE for
1830 		 * the later DMA memory free.
1831 		 */
1832 		viraddr = dma_alloc_coherent(&phba->pcidev->dev,
1833 					     SLI4_PAGE_SIZE, &phyaddr,
1834 					     GFP_KERNEL);
1835 		/* In case of malloc fails, proceed with whatever we have */
1836 		if (!viraddr)
1837 			break;
1838 		mbox->sge_array->addr[pagen] = viraddr;
1839 		/* Keep the first page for later sub-header construction */
1840 		if (pagen == 0)
1841 			cfg_shdr = (union lpfc_sli4_cfg_shdr *)viraddr;
1842 		resid_len = length - alloc_len;
1843 		if (resid_len > SLI4_PAGE_SIZE) {
1844 			lpfc_sli4_mbx_sge_set(mbox, pagen, phyaddr,
1845 					      SLI4_PAGE_SIZE);
1846 			alloc_len += SLI4_PAGE_SIZE;
1847 		} else {
1848 			lpfc_sli4_mbx_sge_set(mbox, pagen, phyaddr,
1849 					      resid_len);
1850 			alloc_len = length;
1851 		}
1852 	}
1853 
1854 	/* Set up main header fields in mailbox command */
1855 	sli4_config->header.cfg_mhdr.payload_length = alloc_len;
1856 	bf_set(lpfc_mbox_hdr_sge_cnt, &sli4_config->header.cfg_mhdr, pagen);
1857 
1858 	/* Set up sub-header fields into the first page */
1859 	if (pagen > 0) {
1860 		bf_set(lpfc_mbox_hdr_opcode, &cfg_shdr->request, opcode);
1861 		bf_set(lpfc_mbox_hdr_subsystem, &cfg_shdr->request, subsystem);
1862 		cfg_shdr->request.request_length =
1863 				alloc_len - sizeof(union  lpfc_sli4_cfg_shdr);
1864 	}
1865 	/* The sub-header is in DMA memory, which needs endian converstion */
1866 	if (cfg_shdr)
1867 		lpfc_sli_pcimem_bcopy(cfg_shdr, cfg_shdr,
1868 				      sizeof(union  lpfc_sli4_cfg_shdr));
1869 	return alloc_len;
1870 }
1871 
1872 /**
1873  * lpfc_sli4_mbox_rsrc_extent - Initialize the opcode resource extent.
1874  * @phba: pointer to lpfc hba data structure.
1875  * @mbox: pointer to an allocated lpfc mbox resource.
1876  * @exts_count: the number of extents, if required, to allocate.
1877  * @rsrc_type: the resource extent type.
1878  * @emb: true if LPFC_SLI4_MBX_EMBED. false if LPFC_SLI4_MBX_NEMBED.
1879  *
1880  * This routine completes the subcommand header for SLI4 resource extent
1881  * mailbox commands.  It is called after lpfc_sli4_config.  The caller must
1882  * pass an allocated mailbox and the attributes required to initialize the
1883  * mailbox correctly.
1884  *
1885  * Return: the actual length of the mbox command allocated.
1886  **/
1887 int
1888 lpfc_sli4_mbox_rsrc_extent(struct lpfc_hba *phba, struct lpfcMboxq *mbox,
1889 			   uint16_t exts_count, uint16_t rsrc_type, bool emb)
1890 {
1891 	uint8_t opcode = 0;
1892 	struct lpfc_mbx_nembed_rsrc_extent *n_rsrc_extnt = NULL;
1893 	void *virtaddr = NULL;
1894 
1895 	/* Set up SLI4 ioctl command header fields */
1896 	if (emb == LPFC_SLI4_MBX_NEMBED) {
1897 		/* Get the first SGE entry from the non-embedded DMA memory */
1898 		virtaddr = mbox->sge_array->addr[0];
1899 		if (virtaddr == NULL)
1900 			return 1;
1901 		n_rsrc_extnt = (struct lpfc_mbx_nembed_rsrc_extent *) virtaddr;
1902 	}
1903 
1904 	/*
1905 	 * The resource type is common to all extent Opcodes and resides in the
1906 	 * same position.
1907 	 */
1908 	if (emb == LPFC_SLI4_MBX_EMBED)
1909 		bf_set(lpfc_mbx_alloc_rsrc_extents_type,
1910 		       &mbox->u.mqe.un.alloc_rsrc_extents.u.req,
1911 		       rsrc_type);
1912 	else {
1913 		/* This is DMA data.  Byteswap is required. */
1914 		bf_set(lpfc_mbx_alloc_rsrc_extents_type,
1915 		       n_rsrc_extnt, rsrc_type);
1916 		lpfc_sli_pcimem_bcopy(&n_rsrc_extnt->word4,
1917 				      &n_rsrc_extnt->word4,
1918 				      sizeof(uint32_t));
1919 	}
1920 
1921 	/* Complete the initialization for the particular Opcode. */
1922 	opcode = lpfc_sli_config_mbox_opcode_get(phba, mbox);
1923 	switch (opcode) {
1924 	case LPFC_MBOX_OPCODE_ALLOC_RSRC_EXTENT:
1925 		if (emb == LPFC_SLI4_MBX_EMBED)
1926 			bf_set(lpfc_mbx_alloc_rsrc_extents_cnt,
1927 			       &mbox->u.mqe.un.alloc_rsrc_extents.u.req,
1928 			       exts_count);
1929 		else
1930 			bf_set(lpfc_mbx_alloc_rsrc_extents_cnt,
1931 			       n_rsrc_extnt, exts_count);
1932 		break;
1933 	case LPFC_MBOX_OPCODE_GET_ALLOC_RSRC_EXTENT:
1934 	case LPFC_MBOX_OPCODE_GET_RSRC_EXTENT_INFO:
1935 	case LPFC_MBOX_OPCODE_DEALLOC_RSRC_EXTENT:
1936 		/* Initialization is complete.*/
1937 		break;
1938 	default:
1939 		lpfc_printf_log(phba, KERN_ERR, LOG_MBOX,
1940 				"2929 Resource Extent Opcode x%x is "
1941 				"unsupported\n", opcode);
1942 		return 1;
1943 	}
1944 
1945 	return 0;
1946 }
1947 
1948 /**
1949  * lpfc_sli_config_mbox_subsys_get - Get subsystem from a sli_config mbox cmd
1950  * @phba: pointer to lpfc hba data structure.
1951  * @mbox: pointer to lpfc mbox command queue entry.
1952  *
1953  * This routine gets the subsystem from a SLI4 specific SLI_CONFIG mailbox
1954  * command. If the mailbox command is not MBX_SLI4_CONFIG (0x9B) or if the
1955  * sub-header is not present, subsystem LPFC_MBOX_SUBSYSTEM_NA (0x0) shall
1956  * be returned.
1957  **/
1958 uint8_t
1959 lpfc_sli_config_mbox_subsys_get(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox)
1960 {
1961 	struct lpfc_mbx_sli4_config *sli4_cfg;
1962 	union lpfc_sli4_cfg_shdr *cfg_shdr;
1963 
1964 	if (mbox->u.mb.mbxCommand != MBX_SLI4_CONFIG)
1965 		return LPFC_MBOX_SUBSYSTEM_NA;
1966 	sli4_cfg = &mbox->u.mqe.un.sli4_config;
1967 
1968 	/* For embedded mbox command, get opcode from embedded sub-header*/
1969 	if (bf_get(lpfc_mbox_hdr_emb, &sli4_cfg->header.cfg_mhdr)) {
1970 		cfg_shdr = &mbox->u.mqe.un.sli4_config.header.cfg_shdr;
1971 		return bf_get(lpfc_mbox_hdr_subsystem, &cfg_shdr->request);
1972 	}
1973 
1974 	/* For non-embedded mbox command, get opcode from first dma page */
1975 	if (unlikely(!mbox->sge_array))
1976 		return LPFC_MBOX_SUBSYSTEM_NA;
1977 	cfg_shdr = (union lpfc_sli4_cfg_shdr *)mbox->sge_array->addr[0];
1978 	return bf_get(lpfc_mbox_hdr_subsystem, &cfg_shdr->request);
1979 }
1980 
1981 /**
1982  * lpfc_sli_config_mbox_opcode_get - Get opcode from a sli_config mbox cmd
1983  * @phba: pointer to lpfc hba data structure.
1984  * @mbox: pointer to lpfc mbox command queue entry.
1985  *
1986  * This routine gets the opcode from a SLI4 specific SLI_CONFIG mailbox
1987  * command. If the mailbox command is not MBX_SLI4_CONFIG (0x9B) or if
1988  * the sub-header is not present, opcode LPFC_MBOX_OPCODE_NA (0x0) be
1989  * returned.
1990  **/
1991 uint8_t
1992 lpfc_sli_config_mbox_opcode_get(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox)
1993 {
1994 	struct lpfc_mbx_sli4_config *sli4_cfg;
1995 	union lpfc_sli4_cfg_shdr *cfg_shdr;
1996 
1997 	if (mbox->u.mb.mbxCommand != MBX_SLI4_CONFIG)
1998 		return LPFC_MBOX_OPCODE_NA;
1999 	sli4_cfg = &mbox->u.mqe.un.sli4_config;
2000 
2001 	/* For embedded mbox command, get opcode from embedded sub-header*/
2002 	if (bf_get(lpfc_mbox_hdr_emb, &sli4_cfg->header.cfg_mhdr)) {
2003 		cfg_shdr = &mbox->u.mqe.un.sli4_config.header.cfg_shdr;
2004 		return bf_get(lpfc_mbox_hdr_opcode, &cfg_shdr->request);
2005 	}
2006 
2007 	/* For non-embedded mbox command, get opcode from first dma page */
2008 	if (unlikely(!mbox->sge_array))
2009 		return LPFC_MBOX_OPCODE_NA;
2010 	cfg_shdr = (union lpfc_sli4_cfg_shdr *)mbox->sge_array->addr[0];
2011 	return bf_get(lpfc_mbox_hdr_opcode, &cfg_shdr->request);
2012 }
2013 
2014 /**
2015  * lpfc_sli4_mbx_read_fcf_rec - Allocate and construct read fcf mbox cmd
2016  * @phba: pointer to lpfc hba data structure.
2017  * @mboxq: pointer to lpfc mbox command.
2018  * @fcf_index: index to fcf table.
2019  *
2020  * This routine routine allocates and constructs non-embedded mailbox command
2021  * for reading a FCF table entry referred by @fcf_index.
2022  *
2023  * Return: pointer to the mailbox command constructed if successful, otherwise
2024  * NULL.
2025  **/
2026 int
2027 lpfc_sli4_mbx_read_fcf_rec(struct lpfc_hba *phba,
2028 			   struct lpfcMboxq *mboxq,
2029 			   uint16_t fcf_index)
2030 {
2031 	void *virt_addr;
2032 	uint8_t *bytep;
2033 	struct lpfc_mbx_sge sge;
2034 	uint32_t alloc_len, req_len;
2035 	struct lpfc_mbx_read_fcf_tbl *read_fcf;
2036 
2037 	if (!mboxq)
2038 		return -ENOMEM;
2039 
2040 	req_len = sizeof(struct fcf_record) +
2041 		  sizeof(union lpfc_sli4_cfg_shdr) + 2 * sizeof(uint32_t);
2042 
2043 	/* Set up READ_FCF SLI4_CONFIG mailbox-ioctl command */
2044 	alloc_len = lpfc_sli4_config(phba, mboxq, LPFC_MBOX_SUBSYSTEM_FCOE,
2045 			LPFC_MBOX_OPCODE_FCOE_READ_FCF_TABLE, req_len,
2046 			LPFC_SLI4_MBX_NEMBED);
2047 
2048 	if (alloc_len < req_len) {
2049 		lpfc_printf_log(phba, KERN_ERR, LOG_MBOX,
2050 				"0291 Allocated DMA memory size (x%x) is "
2051 				"less than the requested DMA memory "
2052 				"size (x%x)\n", alloc_len, req_len);
2053 		return -ENOMEM;
2054 	}
2055 
2056 	/* Get the first SGE entry from the non-embedded DMA memory. This
2057 	 * routine only uses a single SGE.
2058 	 */
2059 	lpfc_sli4_mbx_sge_get(mboxq, 0, &sge);
2060 	virt_addr = mboxq->sge_array->addr[0];
2061 	read_fcf = (struct lpfc_mbx_read_fcf_tbl *)virt_addr;
2062 
2063 	/* Set up command fields */
2064 	bf_set(lpfc_mbx_read_fcf_tbl_indx, &read_fcf->u.request, fcf_index);
2065 	/* Perform necessary endian conversion */
2066 	bytep = virt_addr + sizeof(union lpfc_sli4_cfg_shdr);
2067 	lpfc_sli_pcimem_bcopy(bytep, bytep, sizeof(uint32_t));
2068 
2069 	return 0;
2070 }
2071 
2072 /**
2073  * lpfc_request_features: Configure SLI4 REQUEST_FEATURES mailbox
2074  * @phba: pointer to lpfc hba data structure.
2075  * @mboxq: pointer to lpfc mbox command.
2076  *
2077  * This routine sets up the mailbox for an SLI4 REQUEST_FEATURES
2078  * mailbox command.
2079  **/
2080 void
2081 lpfc_request_features(struct lpfc_hba *phba, struct lpfcMboxq *mboxq)
2082 {
2083 	/* Set up SLI4 mailbox command header fields */
2084 	memset(mboxq, 0, sizeof(LPFC_MBOXQ_t));
2085 	bf_set(lpfc_mqe_command, &mboxq->u.mqe, MBX_SLI4_REQ_FTRS);
2086 
2087 	/* Set up host requested features. */
2088 	bf_set(lpfc_mbx_rq_ftr_rq_fcpi, &mboxq->u.mqe.un.req_ftrs, 1);
2089 	bf_set(lpfc_mbx_rq_ftr_rq_perfh, &mboxq->u.mqe.un.req_ftrs, 1);
2090 
2091 	/* Enable DIF (block guard) only if configured to do so. */
2092 	if (phba->cfg_enable_bg)
2093 		bf_set(lpfc_mbx_rq_ftr_rq_dif, &mboxq->u.mqe.un.req_ftrs, 1);
2094 
2095 	/* Enable NPIV only if configured to do so. */
2096 	if (phba->max_vpi && phba->cfg_enable_npiv)
2097 		bf_set(lpfc_mbx_rq_ftr_rq_npiv, &mboxq->u.mqe.un.req_ftrs, 1);
2098 
2099 	if (phba->nvmet_support) {
2100 		bf_set(lpfc_mbx_rq_ftr_rq_mrqp, &mboxq->u.mqe.un.req_ftrs, 1);
2101 		/* iaab/iaar NOT set for now */
2102 		bf_set(lpfc_mbx_rq_ftr_rq_iaab, &mboxq->u.mqe.un.req_ftrs, 0);
2103 		bf_set(lpfc_mbx_rq_ftr_rq_iaar, &mboxq->u.mqe.un.req_ftrs, 0);
2104 	}
2105 
2106 	/* Enable Application Services Header for appheader VMID */
2107 	if (phba->cfg_vmid_app_header) {
2108 		bf_set(lpfc_mbx_rq_ftr_rq_ashdr, &mboxq->u.mqe.un.req_ftrs, 1);
2109 		bf_set(lpfc_ftr_ashdr, &phba->sli4_hba.sli4_flags, 1);
2110 	}
2111 	return;
2112 }
2113 
2114 /**
2115  * lpfc_init_vfi - Initialize the INIT_VFI mailbox command
2116  * @mbox: pointer to lpfc mbox command to initialize.
2117  * @vport: Vport associated with the VF.
2118  *
2119  * This routine initializes @mbox to all zeros and then fills in the mailbox
2120  * fields from @vport. INIT_VFI configures virtual fabrics identified by VFI
2121  * in the context of an FCF. The driver issues this command to setup a VFI
2122  * before issuing a FLOGI to login to the VSAN. The driver should also issue a
2123  * REG_VFI after a successful VSAN login.
2124  **/
2125 void
2126 lpfc_init_vfi(struct lpfcMboxq *mbox, struct lpfc_vport *vport)
2127 {
2128 	struct lpfc_mbx_init_vfi *init_vfi;
2129 
2130 	memset(mbox, 0, sizeof(*mbox));
2131 	mbox->vport = vport;
2132 	init_vfi = &mbox->u.mqe.un.init_vfi;
2133 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_INIT_VFI);
2134 	bf_set(lpfc_init_vfi_vr, init_vfi, 1);
2135 	bf_set(lpfc_init_vfi_vt, init_vfi, 1);
2136 	bf_set(lpfc_init_vfi_vp, init_vfi, 1);
2137 	bf_set(lpfc_init_vfi_vfi, init_vfi,
2138 	       vport->phba->sli4_hba.vfi_ids[vport->vfi]);
2139 	bf_set(lpfc_init_vfi_vpi, init_vfi,
2140 	       vport->phba->vpi_ids[vport->vpi]);
2141 	bf_set(lpfc_init_vfi_fcfi, init_vfi,
2142 	       vport->phba->fcf.fcfi);
2143 }
2144 
2145 /**
2146  * lpfc_reg_vfi - Initialize the REG_VFI mailbox command
2147  * @mbox: pointer to lpfc mbox command to initialize.
2148  * @vport: vport associated with the VF.
2149  * @phys: BDE DMA bus address used to send the service parameters to the HBA.
2150  *
2151  * This routine initializes @mbox to all zeros and then fills in the mailbox
2152  * fields from @vport, and uses @buf as a DMAable buffer to send the vport's
2153  * fc service parameters to the HBA for this VFI. REG_VFI configures virtual
2154  * fabrics identified by VFI in the context of an FCF.
2155  **/
2156 void
2157 lpfc_reg_vfi(struct lpfcMboxq *mbox, struct lpfc_vport *vport, dma_addr_t phys)
2158 {
2159 	struct lpfc_mbx_reg_vfi *reg_vfi;
2160 	struct lpfc_hba *phba = vport->phba;
2161 	uint8_t bbscn_fabric = 0, bbscn_max = 0, bbscn_def = 0;
2162 
2163 	memset(mbox, 0, sizeof(*mbox));
2164 	reg_vfi = &mbox->u.mqe.un.reg_vfi;
2165 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_REG_VFI);
2166 	bf_set(lpfc_reg_vfi_vp, reg_vfi, 1);
2167 	bf_set(lpfc_reg_vfi_vfi, reg_vfi,
2168 	       phba->sli4_hba.vfi_ids[vport->vfi]);
2169 	bf_set(lpfc_reg_vfi_fcfi, reg_vfi, phba->fcf.fcfi);
2170 	bf_set(lpfc_reg_vfi_vpi, reg_vfi, phba->vpi_ids[vport->vpi]);
2171 	memcpy(reg_vfi->wwn, &vport->fc_portname, sizeof(struct lpfc_name));
2172 	reg_vfi->wwn[0] = cpu_to_le32(reg_vfi->wwn[0]);
2173 	reg_vfi->wwn[1] = cpu_to_le32(reg_vfi->wwn[1]);
2174 	reg_vfi->e_d_tov = phba->fc_edtov;
2175 	reg_vfi->r_a_tov = phba->fc_ratov;
2176 	if (phys) {
2177 		reg_vfi->bde.addrHigh = putPaddrHigh(phys);
2178 		reg_vfi->bde.addrLow = putPaddrLow(phys);
2179 		reg_vfi->bde.tus.f.bdeSize = sizeof(vport->fc_sparam);
2180 		reg_vfi->bde.tus.f.bdeFlags = BUFF_TYPE_BDE_64;
2181 	}
2182 	bf_set(lpfc_reg_vfi_nport_id, reg_vfi, vport->fc_myDID);
2183 
2184 	/* Only FC supports upd bit */
2185 	if ((phba->sli4_hba.lnk_info.lnk_tp == LPFC_LNK_TYPE_FC) &&
2186 	    (vport->fc_flag & FC_VFI_REGISTERED) &&
2187 	    (!phba->fc_topology_changed))
2188 		bf_set(lpfc_reg_vfi_upd, reg_vfi, 1);
2189 
2190 	bf_set(lpfc_reg_vfi_bbcr, reg_vfi, 0);
2191 	bf_set(lpfc_reg_vfi_bbscn, reg_vfi, 0);
2192 	bbscn_fabric = (phba->fc_fabparam.cmn.bbRcvSizeMsb >> 4) & 0xF;
2193 
2194 	if (phba->bbcredit_support && phba->cfg_enable_bbcr  &&
2195 	    bbscn_fabric != 0) {
2196 		bbscn_max = bf_get(lpfc_bbscn_max,
2197 				   &phba->sli4_hba.bbscn_params);
2198 		if (bbscn_fabric <= bbscn_max) {
2199 			bbscn_def = bf_get(lpfc_bbscn_def,
2200 					   &phba->sli4_hba.bbscn_params);
2201 
2202 			if (bbscn_fabric > bbscn_def)
2203 				bf_set(lpfc_reg_vfi_bbscn, reg_vfi,
2204 				       bbscn_fabric);
2205 			else
2206 				bf_set(lpfc_reg_vfi_bbscn, reg_vfi, bbscn_def);
2207 
2208 			bf_set(lpfc_reg_vfi_bbcr, reg_vfi, 1);
2209 		}
2210 	}
2211 	lpfc_printf_vlog(vport, KERN_INFO, LOG_MBOX,
2212 			"3134 Register VFI, mydid:x%x, fcfi:%d, "
2213 			" vfi:%d, vpi:%d, fc_pname:%x%x fc_flag:x%x"
2214 			" port_state:x%x topology chg:%d bbscn_fabric :%d\n",
2215 			vport->fc_myDID,
2216 			phba->fcf.fcfi,
2217 			phba->sli4_hba.vfi_ids[vport->vfi],
2218 			phba->vpi_ids[vport->vpi],
2219 			reg_vfi->wwn[0], reg_vfi->wwn[1], vport->fc_flag,
2220 			vport->port_state, phba->fc_topology_changed,
2221 			bbscn_fabric);
2222 }
2223 
2224 /**
2225  * lpfc_init_vpi - Initialize the INIT_VPI mailbox command
2226  * @phba: pointer to the hba structure to init the VPI for.
2227  * @mbox: pointer to lpfc mbox command to initialize.
2228  * @vpi: VPI to be initialized.
2229  *
2230  * The INIT_VPI mailbox command supports virtual N_Ports. The driver uses the
2231  * command to activate a virtual N_Port. The HBA assigns a MAC address to use
2232  * with the virtual N Port.  The SLI Host issues this command before issuing a
2233  * FDISC to connect to the Fabric. The SLI Host should issue a REG_VPI after a
2234  * successful virtual NPort login.
2235  **/
2236 void
2237 lpfc_init_vpi(struct lpfc_hba *phba, struct lpfcMboxq *mbox, uint16_t vpi)
2238 {
2239 	memset(mbox, 0, sizeof(*mbox));
2240 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_INIT_VPI);
2241 	bf_set(lpfc_init_vpi_vpi, &mbox->u.mqe.un.init_vpi,
2242 	       phba->vpi_ids[vpi]);
2243 	bf_set(lpfc_init_vpi_vfi, &mbox->u.mqe.un.init_vpi,
2244 	       phba->sli4_hba.vfi_ids[phba->pport->vfi]);
2245 }
2246 
2247 /**
2248  * lpfc_unreg_vfi - Initialize the UNREG_VFI mailbox command
2249  * @mbox: pointer to lpfc mbox command to initialize.
2250  * @vport: vport associated with the VF.
2251  *
2252  * The UNREG_VFI mailbox command causes the SLI Host to put a virtual fabric
2253  * (logical NPort) into the inactive state. The SLI Host must have logged out
2254  * and unregistered all remote N_Ports to abort any activity on the virtual
2255  * fabric. The SLI Port posts the mailbox response after marking the virtual
2256  * fabric inactive.
2257  **/
2258 void
2259 lpfc_unreg_vfi(struct lpfcMboxq *mbox, struct lpfc_vport *vport)
2260 {
2261 	memset(mbox, 0, sizeof(*mbox));
2262 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_UNREG_VFI);
2263 	bf_set(lpfc_unreg_vfi_vfi, &mbox->u.mqe.un.unreg_vfi,
2264 	       vport->phba->sli4_hba.vfi_ids[vport->vfi]);
2265 }
2266 
2267 /**
2268  * lpfc_sli4_dump_cfg_rg23 - Dump sli4 port config region 23
2269  * @phba: pointer to the hba structure containing.
2270  * @mbox: pointer to lpfc mbox command to initialize.
2271  *
2272  * This function create a SLI4 dump mailbox command to dump configure
2273  * region 23.
2274  **/
2275 int
2276 lpfc_sli4_dump_cfg_rg23(struct lpfc_hba *phba, struct lpfcMboxq *mbox)
2277 {
2278 	struct lpfc_dmabuf *mp = NULL;
2279 	MAILBOX_t *mb;
2280 
2281 	memset(mbox, 0, sizeof(*mbox));
2282 	mb = &mbox->u.mb;
2283 
2284 	mp = kmalloc(sizeof(struct lpfc_dmabuf), GFP_KERNEL);
2285 	if (mp)
2286 		mp->virt = lpfc_mbuf_alloc(phba, 0, &mp->phys);
2287 
2288 	if (!mp || !mp->virt) {
2289 		kfree(mp);
2290 		/* dump config region 23 failed to allocate memory */
2291 		lpfc_printf_log(phba, KERN_WARNING, LOG_MBOX,
2292 			"2569 lpfc dump config region 23: memory"
2293 			" allocation failed\n");
2294 		return 1;
2295 	}
2296 
2297 	memset(mp->virt, 0, LPFC_BPL_SIZE);
2298 	INIT_LIST_HEAD(&mp->list);
2299 
2300 	/* save address for completion */
2301 	mbox->ctx_buf = (uint8_t *)mp;
2302 
2303 	mb->mbxCommand = MBX_DUMP_MEMORY;
2304 	mb->un.varDmp.type = DMP_NV_PARAMS;
2305 	mb->un.varDmp.region_id = DMP_REGION_23;
2306 	mb->un.varDmp.sli4_length = DMP_RGN23_SIZE;
2307 	mb->un.varWords[3] = putPaddrLow(mp->phys);
2308 	mb->un.varWords[4] = putPaddrHigh(mp->phys);
2309 	return 0;
2310 }
2311 
2312 static void
2313 lpfc_mbx_cmpl_rdp_link_stat(struct lpfc_hba *phba, LPFC_MBOXQ_t *mboxq)
2314 {
2315 	MAILBOX_t *mb;
2316 	int rc = FAILURE;
2317 	struct lpfc_rdp_context *rdp_context =
2318 			(struct lpfc_rdp_context *)(mboxq->ctx_ndlp);
2319 
2320 	mb = &mboxq->u.mb;
2321 	if (mb->mbxStatus)
2322 		goto mbx_failed;
2323 
2324 	memcpy(&rdp_context->link_stat, &mb->un.varRdLnk, sizeof(READ_LNK_VAR));
2325 
2326 	rc = SUCCESS;
2327 
2328 mbx_failed:
2329 	lpfc_sli4_mbox_cmd_free(phba, mboxq);
2330 	rdp_context->cmpl(phba, rdp_context, rc);
2331 }
2332 
2333 static void
2334 lpfc_mbx_cmpl_rdp_page_a2(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox)
2335 {
2336 	struct lpfc_dmabuf *mp = (struct lpfc_dmabuf *)mbox->ctx_buf;
2337 	struct lpfc_rdp_context *rdp_context =
2338 			(struct lpfc_rdp_context *)(mbox->ctx_ndlp);
2339 
2340 	if (bf_get(lpfc_mqe_status, &mbox->u.mqe))
2341 		goto error_mbuf_free;
2342 
2343 	lpfc_sli_bemem_bcopy(mp->virt, &rdp_context->page_a2,
2344 				DMP_SFF_PAGE_A2_SIZE);
2345 
2346 	/* We don't need dma buffer for link stat. */
2347 	lpfc_mbuf_free(phba, mp->virt, mp->phys);
2348 	kfree(mp);
2349 
2350 	memset(mbox, 0, sizeof(*mbox));
2351 	lpfc_read_lnk_stat(phba, mbox);
2352 	mbox->vport = rdp_context->ndlp->vport;
2353 	mbox->mbox_cmpl = lpfc_mbx_cmpl_rdp_link_stat;
2354 	mbox->ctx_ndlp = (struct lpfc_rdp_context *)rdp_context;
2355 	if (lpfc_sli_issue_mbox(phba, mbox, MBX_NOWAIT) == MBX_NOT_FINISHED)
2356 		goto error_cmd_free;
2357 
2358 	return;
2359 
2360 error_mbuf_free:
2361 	lpfc_mbuf_free(phba, mp->virt, mp->phys);
2362 	kfree(mp);
2363 error_cmd_free:
2364 	lpfc_sli4_mbox_cmd_free(phba, mbox);
2365 	rdp_context->cmpl(phba, rdp_context, FAILURE);
2366 }
2367 
2368 void
2369 lpfc_mbx_cmpl_rdp_page_a0(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox)
2370 {
2371 	int rc;
2372 	struct lpfc_dmabuf *mp = (struct lpfc_dmabuf *)(mbox->ctx_buf);
2373 	struct lpfc_rdp_context *rdp_context =
2374 			(struct lpfc_rdp_context *)(mbox->ctx_ndlp);
2375 
2376 	if (bf_get(lpfc_mqe_status, &mbox->u.mqe))
2377 		goto error;
2378 
2379 	lpfc_sli_bemem_bcopy(mp->virt, &rdp_context->page_a0,
2380 				DMP_SFF_PAGE_A0_SIZE);
2381 
2382 	memset(mbox, 0, sizeof(*mbox));
2383 
2384 	memset(mp->virt, 0, DMP_SFF_PAGE_A2_SIZE);
2385 	INIT_LIST_HEAD(&mp->list);
2386 
2387 	/* save address for completion */
2388 	mbox->ctx_buf = mp;
2389 	mbox->vport = rdp_context->ndlp->vport;
2390 
2391 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_DUMP_MEMORY);
2392 	bf_set(lpfc_mbx_memory_dump_type3_type,
2393 		&mbox->u.mqe.un.mem_dump_type3, DMP_LMSD);
2394 	bf_set(lpfc_mbx_memory_dump_type3_link,
2395 		&mbox->u.mqe.un.mem_dump_type3, phba->sli4_hba.physical_port);
2396 	bf_set(lpfc_mbx_memory_dump_type3_page_no,
2397 		&mbox->u.mqe.un.mem_dump_type3, DMP_PAGE_A2);
2398 	bf_set(lpfc_mbx_memory_dump_type3_length,
2399 		&mbox->u.mqe.un.mem_dump_type3, DMP_SFF_PAGE_A2_SIZE);
2400 	mbox->u.mqe.un.mem_dump_type3.addr_lo = putPaddrLow(mp->phys);
2401 	mbox->u.mqe.un.mem_dump_type3.addr_hi = putPaddrHigh(mp->phys);
2402 
2403 	mbox->mbox_cmpl = lpfc_mbx_cmpl_rdp_page_a2;
2404 	mbox->ctx_ndlp = (struct lpfc_rdp_context *)rdp_context;
2405 	rc = lpfc_sli_issue_mbox(phba, mbox, MBX_NOWAIT);
2406 	if (rc == MBX_NOT_FINISHED)
2407 		goto error;
2408 
2409 	return;
2410 
2411 error:
2412 	lpfc_mbuf_free(phba, mp->virt, mp->phys);
2413 	kfree(mp);
2414 	lpfc_sli4_mbox_cmd_free(phba, mbox);
2415 	rdp_context->cmpl(phba, rdp_context, FAILURE);
2416 }
2417 
2418 
2419 /*
2420  * lpfc_sli4_dump_page_a0 - Dump sli4 read SFP Diagnostic.
2421  * @phba: pointer to the hba structure containing.
2422  * @mbox: pointer to lpfc mbox command to initialize.
2423  *
2424  * This function create a SLI4 dump mailbox command to dump configure
2425  * type 3 page 0xA0.
2426  */
2427 int
2428 lpfc_sli4_dump_page_a0(struct lpfc_hba *phba, struct lpfcMboxq *mbox)
2429 {
2430 	struct lpfc_dmabuf *mp = NULL;
2431 
2432 	memset(mbox, 0, sizeof(*mbox));
2433 
2434 	mp = kmalloc(sizeof(struct lpfc_dmabuf), GFP_KERNEL);
2435 	if (mp)
2436 		mp->virt = lpfc_mbuf_alloc(phba, 0, &mp->phys);
2437 	if (!mp || !mp->virt) {
2438 		kfree(mp);
2439 		lpfc_printf_log(phba, KERN_WARNING, LOG_MBOX,
2440 			"3569 dump type 3 page 0xA0 allocation failed\n");
2441 		return 1;
2442 	}
2443 
2444 	memset(mp->virt, 0, LPFC_BPL_SIZE);
2445 	INIT_LIST_HEAD(&mp->list);
2446 
2447 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_DUMP_MEMORY);
2448 	/* save address for completion */
2449 	mbox->ctx_buf = mp;
2450 
2451 	bf_set(lpfc_mbx_memory_dump_type3_type,
2452 		&mbox->u.mqe.un.mem_dump_type3, DMP_LMSD);
2453 	bf_set(lpfc_mbx_memory_dump_type3_link,
2454 		&mbox->u.mqe.un.mem_dump_type3, phba->sli4_hba.physical_port);
2455 	bf_set(lpfc_mbx_memory_dump_type3_page_no,
2456 		&mbox->u.mqe.un.mem_dump_type3, DMP_PAGE_A0);
2457 	bf_set(lpfc_mbx_memory_dump_type3_length,
2458 		&mbox->u.mqe.un.mem_dump_type3, DMP_SFF_PAGE_A0_SIZE);
2459 	mbox->u.mqe.un.mem_dump_type3.addr_lo = putPaddrLow(mp->phys);
2460 	mbox->u.mqe.un.mem_dump_type3.addr_hi = putPaddrHigh(mp->phys);
2461 
2462 	return 0;
2463 }
2464 
2465 /**
2466  * lpfc_reg_fcfi - Initialize the REG_FCFI mailbox command
2467  * @phba: pointer to the hba structure containing the FCF index and RQ ID.
2468  * @mbox: pointer to lpfc mbox command to initialize.
2469  *
2470  * The REG_FCFI mailbox command supports Fibre Channel Forwarders (FCFs). The
2471  * SLI Host uses the command to activate an FCF after it has acquired FCF
2472  * information via a READ_FCF mailbox command. This mailbox command also is used
2473  * to indicate where received unsolicited frames from this FCF will be sent. By
2474  * default this routine will set up the FCF to forward all unsolicited frames
2475  * the the RQ ID passed in the @phba. This can be overridden by the caller for
2476  * more complicated setups.
2477  **/
2478 void
2479 lpfc_reg_fcfi(struct lpfc_hba *phba, struct lpfcMboxq *mbox)
2480 {
2481 	struct lpfc_mbx_reg_fcfi *reg_fcfi;
2482 
2483 	memset(mbox, 0, sizeof(*mbox));
2484 	reg_fcfi = &mbox->u.mqe.un.reg_fcfi;
2485 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_REG_FCFI);
2486 	if (phba->nvmet_support == 0) {
2487 		bf_set(lpfc_reg_fcfi_rq_id0, reg_fcfi,
2488 		       phba->sli4_hba.hdr_rq->queue_id);
2489 		/* Match everything - rq_id0 */
2490 		bf_set(lpfc_reg_fcfi_type_match0, reg_fcfi, 0);
2491 		bf_set(lpfc_reg_fcfi_type_mask0, reg_fcfi, 0);
2492 		bf_set(lpfc_reg_fcfi_rctl_match0, reg_fcfi, 0);
2493 		bf_set(lpfc_reg_fcfi_rctl_mask0, reg_fcfi, 0);
2494 
2495 		bf_set(lpfc_reg_fcfi_rq_id1, reg_fcfi, REG_FCF_INVALID_QID);
2496 
2497 		/* addr mode is bit wise inverted value of fcf addr_mode */
2498 		bf_set(lpfc_reg_fcfi_mam, reg_fcfi,
2499 		       (~phba->fcf.addr_mode) & 0x3);
2500 	} else {
2501 		/* This is ONLY for NVMET MRQ == 1 */
2502 		if (phba->cfg_nvmet_mrq != 1)
2503 			return;
2504 
2505 		bf_set(lpfc_reg_fcfi_rq_id0, reg_fcfi,
2506 		       phba->sli4_hba.nvmet_mrq_hdr[0]->queue_id);
2507 		/* Match type FCP - rq_id0 */
2508 		bf_set(lpfc_reg_fcfi_type_match0, reg_fcfi, FC_TYPE_FCP);
2509 		bf_set(lpfc_reg_fcfi_type_mask0, reg_fcfi, 0xff);
2510 		bf_set(lpfc_reg_fcfi_rctl_match0, reg_fcfi,
2511 		       FC_RCTL_DD_UNSOL_CMD);
2512 
2513 		bf_set(lpfc_reg_fcfi_rq_id1, reg_fcfi,
2514 		       phba->sli4_hba.hdr_rq->queue_id);
2515 		/* Match everything else - rq_id1 */
2516 		bf_set(lpfc_reg_fcfi_type_match1, reg_fcfi, 0);
2517 		bf_set(lpfc_reg_fcfi_type_mask1, reg_fcfi, 0);
2518 		bf_set(lpfc_reg_fcfi_rctl_match1, reg_fcfi, 0);
2519 		bf_set(lpfc_reg_fcfi_rctl_mask1, reg_fcfi, 0);
2520 	}
2521 	bf_set(lpfc_reg_fcfi_rq_id2, reg_fcfi, REG_FCF_INVALID_QID);
2522 	bf_set(lpfc_reg_fcfi_rq_id3, reg_fcfi, REG_FCF_INVALID_QID);
2523 	bf_set(lpfc_reg_fcfi_info_index, reg_fcfi,
2524 	       phba->fcf.current_rec.fcf_indx);
2525 	if (phba->fcf.current_rec.vlan_id != LPFC_FCOE_NULL_VID) {
2526 		bf_set(lpfc_reg_fcfi_vv, reg_fcfi, 1);
2527 		bf_set(lpfc_reg_fcfi_vlan_tag, reg_fcfi,
2528 		       phba->fcf.current_rec.vlan_id);
2529 	}
2530 }
2531 
2532 /**
2533  * lpfc_reg_fcfi_mrq - Initialize the REG_FCFI_MRQ mailbox command
2534  * @phba: pointer to the hba structure containing the FCF index and RQ ID.
2535  * @mbox: pointer to lpfc mbox command to initialize.
2536  * @mode: 0 to register FCFI, 1 to register MRQs
2537  *
2538  * The REG_FCFI_MRQ mailbox command supports Fibre Channel Forwarders (FCFs).
2539  * The SLI Host uses the command to activate an FCF after it has acquired FCF
2540  * information via a READ_FCF mailbox command. This mailbox command also is used
2541  * to indicate where received unsolicited frames from this FCF will be sent. By
2542  * default this routine will set up the FCF to forward all unsolicited frames
2543  * the the RQ ID passed in the @phba. This can be overridden by the caller for
2544  * more complicated setups.
2545  **/
2546 void
2547 lpfc_reg_fcfi_mrq(struct lpfc_hba *phba, struct lpfcMboxq *mbox, int mode)
2548 {
2549 	struct lpfc_mbx_reg_fcfi_mrq *reg_fcfi;
2550 
2551 	/* This is ONLY for MRQ */
2552 	if (phba->cfg_nvmet_mrq <= 1)
2553 		return;
2554 
2555 	memset(mbox, 0, sizeof(*mbox));
2556 	reg_fcfi = &mbox->u.mqe.un.reg_fcfi_mrq;
2557 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_REG_FCFI_MRQ);
2558 	if (mode == 0) {
2559 		bf_set(lpfc_reg_fcfi_mrq_info_index, reg_fcfi,
2560 		       phba->fcf.current_rec.fcf_indx);
2561 		if (phba->fcf.current_rec.vlan_id != LPFC_FCOE_NULL_VID) {
2562 			bf_set(lpfc_reg_fcfi_mrq_vv, reg_fcfi, 1);
2563 			bf_set(lpfc_reg_fcfi_mrq_vlan_tag, reg_fcfi,
2564 			       phba->fcf.current_rec.vlan_id);
2565 		}
2566 		return;
2567 	}
2568 
2569 	bf_set(lpfc_reg_fcfi_mrq_rq_id0, reg_fcfi,
2570 	       phba->sli4_hba.nvmet_mrq_hdr[0]->queue_id);
2571 	/* Match NVME frames of type FCP (protocol NVME) - rq_id0 */
2572 	bf_set(lpfc_reg_fcfi_mrq_type_match0, reg_fcfi, FC_TYPE_FCP);
2573 	bf_set(lpfc_reg_fcfi_mrq_type_mask0, reg_fcfi, 0xff);
2574 	bf_set(lpfc_reg_fcfi_mrq_rctl_match0, reg_fcfi, FC_RCTL_DD_UNSOL_CMD);
2575 	bf_set(lpfc_reg_fcfi_mrq_rctl_mask0, reg_fcfi, 0xff);
2576 	bf_set(lpfc_reg_fcfi_mrq_ptc0, reg_fcfi, 1);
2577 	bf_set(lpfc_reg_fcfi_mrq_pt0, reg_fcfi, 1);
2578 
2579 	bf_set(lpfc_reg_fcfi_mrq_policy, reg_fcfi, 3); /* NVME connection id */
2580 	bf_set(lpfc_reg_fcfi_mrq_mode, reg_fcfi, 1);
2581 	bf_set(lpfc_reg_fcfi_mrq_filter, reg_fcfi, 1); /* rq_id0 */
2582 	bf_set(lpfc_reg_fcfi_mrq_npairs, reg_fcfi, phba->cfg_nvmet_mrq);
2583 
2584 	bf_set(lpfc_reg_fcfi_mrq_rq_id1, reg_fcfi,
2585 	       phba->sli4_hba.hdr_rq->queue_id);
2586 	/* Match everything - rq_id1 */
2587 	bf_set(lpfc_reg_fcfi_mrq_type_match1, reg_fcfi, 0);
2588 	bf_set(lpfc_reg_fcfi_mrq_type_mask1, reg_fcfi, 0);
2589 	bf_set(lpfc_reg_fcfi_mrq_rctl_match1, reg_fcfi, 0);
2590 	bf_set(lpfc_reg_fcfi_mrq_rctl_mask1, reg_fcfi, 0);
2591 
2592 	bf_set(lpfc_reg_fcfi_mrq_rq_id2, reg_fcfi, REG_FCF_INVALID_QID);
2593 	bf_set(lpfc_reg_fcfi_mrq_rq_id3, reg_fcfi, REG_FCF_INVALID_QID);
2594 }
2595 
2596 /**
2597  * lpfc_unreg_fcfi - Initialize the UNREG_FCFI mailbox command
2598  * @mbox: pointer to lpfc mbox command to initialize.
2599  * @fcfi: FCFI to be unregistered.
2600  *
2601  * The UNREG_FCFI mailbox command supports Fibre Channel Forwarders (FCFs).
2602  * The SLI Host uses the command to inactivate an FCFI.
2603  **/
2604 void
2605 lpfc_unreg_fcfi(struct lpfcMboxq *mbox, uint16_t fcfi)
2606 {
2607 	memset(mbox, 0, sizeof(*mbox));
2608 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_UNREG_FCFI);
2609 	bf_set(lpfc_unreg_fcfi, &mbox->u.mqe.un.unreg_fcfi, fcfi);
2610 }
2611 
2612 /**
2613  * lpfc_resume_rpi - Initialize the RESUME_RPI mailbox command
2614  * @mbox: pointer to lpfc mbox command to initialize.
2615  * @ndlp: The nodelist structure that describes the RPI to resume.
2616  *
2617  * The RESUME_RPI mailbox command is used to restart I/O to an RPI after a
2618  * link event.
2619  **/
2620 void
2621 lpfc_resume_rpi(struct lpfcMboxq *mbox, struct lpfc_nodelist *ndlp)
2622 {
2623 	struct lpfc_hba *phba = ndlp->phba;
2624 	struct lpfc_mbx_resume_rpi *resume_rpi;
2625 
2626 	memset(mbox, 0, sizeof(*mbox));
2627 	resume_rpi = &mbox->u.mqe.un.resume_rpi;
2628 	bf_set(lpfc_mqe_command, &mbox->u.mqe, MBX_RESUME_RPI);
2629 	bf_set(lpfc_resume_rpi_index, resume_rpi,
2630 	       phba->sli4_hba.rpi_ids[ndlp->nlp_rpi]);
2631 	bf_set(lpfc_resume_rpi_ii, resume_rpi, RESUME_INDEX_RPI);
2632 	resume_rpi->event_tag = ndlp->phba->fc_eventTag;
2633 }
2634 
2635