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