49  * @pmb: pointer to the driver internal queue element for mailbox command.
52  * The dump mailbox command provides a method for the device driver to obtain
55  * This routine prepares the mailbox command for dumping list of static
108  * @pmb: pointer to the driver internal queue element for mailbox command.
110  * This routine prepares a mailbox command to bring down HBA link.
123  * lpfc_dump_mem - Prepare a mailbox command for reading a region.
125  * @pmb: pointer to the driver internal queue element for mailbox command.
129  * The dump mailbox command provides a method for the device driver to obtain
132  * This routine prepares the mailbox command for dumping HBA's config region.
160  * lpfc_dump_wakeup_param - Prepare mailbox command for retrieving wakeup params
162  * @pmb: pointer to the driver internal queue element for mailbox command.
164  * This function create a dump memory mailbox command to dump wake up
194  * lpfc_read_nv - Prepare a mailbox command for reading HBA's NVRAM param
196  * @pmb: pointer to the driver internal queue element for mailbox command.
198  * The read NVRAM mailbox command returns the HBA's non-volatile parameters
201  * This routine prepares the mailbox command for reading information stored
217  * lpfc_config_async - Prepare a mailbox command for enabling HBA async event
219  * @pmb: pointer to the driver internal queue element for mailbox command.
222  * The asynchronous event enable mailbox command is used to enable the
226  * This routine prepares the mailbox command for enabling HBA asynchronous
244  * lpfc_heart_beat - Prepare a mailbox command for heart beat
246  * @pmb: pointer to the driver internal queue element for mailbox command.
248  * The heart beat mailbox command is used to detect an unresponsive HBA, which
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.
269  * lpfc_read_topology - Prepare a mailbox command for reading HBA topology
271  * @pmb: pointer to the driver internal queue element for mailbox command.
274  * The read topology mailbox command is issued to read the link topology
281  * This routine prepares the mailbox command for reading HBA link topology
284  * memory as part of the execution of the mailbox command.
313  * lpfc_clear_la - Prepare a mailbox command for clearing HBA link attention
315  * @pmb: pointer to the driver internal queue element for mailbox command.
317  * The clear link attention mailbox command is issued to clear the link event
322  * command.
324  * This routine prepares the mailbox command for clearing HBA link attention
342  * lpfc_config_link - Prepare a mailbox command for configuring link on a HBA
344  * @pmb: pointer to the driver internal queue element for mailbox command.
346  * The configure link mailbox command is used before the initialize link
347  * mailbox command to override default value and to configure link-oriented
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.
353  * This routine prepares the mailbox command for configuring link on a HBA.
395  * lpfc_config_msi - Prepare a mailbox command for configuring msi-x
397  * @pmb: pointer to the driver internal queue element for mailbox command.
399  * The configure MSI-X mailbox command is used to configure the HBA's SLI-3
428 	/* Clear mailbox command fields */  in lpfc_config_msi()
465 	/* Set command and owner bit */  in lpfc_config_msi()
473  * lpfc_init_link - Prepare a mailbox command for initialize link on a HBA
475  * @pmb: pointer to the driver internal queue element for mailbox command.
479  * The initialize link mailbox command is used to initialize the Fibre
480  * Channel link. This command must follow a configure port command that
483  * This routine prepares the mailbox command for initializing link on a HBA
584  * lpfc_read_sparam - Prepare a mailbox command for reading HBA parameters
586  * @pmb: pointer to the driver internal queue element for mailbox command.
589  * The read service parameter mailbox command is used to read the HBA port
591  * specified directly by a BDE in the mailbox command. These service
595  * This routine prepares the mailbox command for reading HBA port service
597  * are populated into the mailbox command for the HBA to DMA the service
643  * lpfc_unreg_did - Prepare a mailbox command for unregistering DID
647  * @pmb: pointer to the driver internal queue element for mailbox command.
649  * The unregister DID mailbox command is used to unregister an N_Port/F_Port
651  * command frees an RPI context in the HBA port. This has the effect of
654  * This routine prepares the mailbox command for unregistering a remote
678  * lpfc_read_config - Prepare a mailbox command for reading HBA configuration
680  * @pmb: pointer to the driver internal queue element for mailbox command.
682  * The read configuration mailbox command is used to read the HBA port
683  * configuration parameters. This mailbox command provides a method for
687  * This routine prepares the mailbox command for reading out HBA configuration
704  * lpfc_read_lnk_stat - Prepare a mailbox command for reading HBA link stats
706  * @pmb: pointer to the driver internal queue element for mailbox command.
708  * The read link status mailbox command is used to read the link status from
713  * This routine prepares the mailbox command for reading out HBA link status.
729  * lpfc_reg_rpi - Prepare a mailbox command for registering remote login
734  * @pmb: pointer to the driver internal queue element for mailbox command.
737  * The registration login mailbox command is used to register an N_Port or
744  * This routine prepares the mailbox command for registering remote port login.
746  * HBA with the mailbox command.
800  * lpfc_unreg_login - Prepare a mailbox command for unregistering remote login
804  * @pmb: pointer to the driver internal queue element for mailbox command.
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
810  * This routine prepares the mailbox command for unregistering remote port
840  * This routine sends mailbox command to unregister all active RPIs for
872  * lpfc_reg_vpi - Prepare a mailbox command for registering vport identifier
874  * @pmb: pointer to the driver internal queue element for mailbox command.
876  * The registration vport identifier mailbox command is used to activate a
882  * This routine prepares the mailbox command for registering a virtual N_Port.
916  * lpfc_unreg_vpi - Prepare a mailbox command for unregistering vport id
919  * @pmb: pointer to the driver internal queue element for mailbox command.
921  * The unregistration vport identifier mailbox command is used to inactivate
928  * This routine prepares the mailbox command for unregistering a virtual
991 		/* Command ring setup for ring */  in lpfc_config_pcb_setup()
1016  * lpfc_read_rev - Prepare a mailbox command for reading HBA revision
1018  * @pmb: pointer to the driver internal queue element for mailbox command.
1020  * The read revision mailbox command is used to read the revision levels of
1026  * This routine prepares the mailbox command for reading HBA revision
1063  * @hbqmb: pointer to the HBQ configuration data structure in mailbox command.
1082  * @hbqmb: pointer to the HBQ configuration data structure in mailbox command.
1104  * @hbqmb: pointer to the HBQ configuration data structure in mailbox command.
1126  * lpfc_config_hbq - Prepare a mailbox command for configuring an HBQ
1131  * @pmb: pointer to the driver internal queue element for mailbox command.
1133  * The configure HBQ (Host Buffer Queue) mailbox command is used to configure
1137  * This routine prepares the mailbox command for configuring an HBQ.
1200  * lpfc_config_ring - Prepare a mailbox command for configuring an IOCB ring
1203  * @pmb: pointer to the driver internal queue element for mailbox command.
1205  * The configure ring mailbox command is used to configure an IOCB ring. This
1211  * configure ring command more than once with the same ring number. The HBA
1214  * This routine prepares the mailbox command for configuring IOCB ring.
1258  * lpfc_config_port - Prepare a mailbox command for configuring port
1260  * @pmb: pointer to the driver internal queue element for mailbox command.
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
1269  * This routine prepares the mailbox command for configuring port.
1303 		mb->un.varCfgPort.ccrp = 1; /* Command Ring Polling */  in lpfc_config_port()
1445  * lpfc_kill_board - Prepare a mailbox command for killing board
1447  * @pmb: pointer to the driver internal queue element for mailbox command.
1449  * The kill board mailbox command is used to tell firmware to perform a
1451  * When the kill board mailbox command is received, the ER3 bit is set to 1
1454  * command.
1456  * This routine prepares the mailbox command for killing the board in
1473  * @mbq: pointer to the driver internal queue element for mailbox command.
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.
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.
1506  *    pointer to the driver internal queue element for mailbox command.
1524  * @mbq: pointer to the driver internal queue element for mailbox command.
1526  * This routine put the completed mailbox command into the mailbox command
1538  * lpfc_mbox_cmpl_put - Put mailbox command into mailbox command complete list
1540  * @mbq: pointer to the driver internal queue element for mailbox command.
1542  * This routine put the completed mailbox command into the mailbox command
1560  * lpfc_mbox_cmd_check - Check the validality of a mailbox command
1562  * @mboxq: pointer to the driver internal queue element for mailbox command.
1564  * This routine is to check whether a mailbox command is valid to be issued.
1566  * is to issue a mailbox command to the mailbox transport.
1573 	/* Mailbox command that have a completion handler must also have a  in lpfc_mbox_cmd_check()
1590  * lpfc_mbox_dev_check - Check the device state for issuing a mailbox command
1594  * mailbox command. It is used by the mailbox transport API at the time the
1595  * to post a mailbox command to the device.
1614  * lpfc_mbox_tmo_val - Retrieve mailbox command timeout value
1616  * @mboxq: pointer to the driver internal queue element for mailbox command.
1619  * command code.
1622  *    Timeout value to be used for the given mailbox command
1677  * lpfc_sli4_mbx_sge_set - Set a sge entry in non-embedded mailbox command
1678  * @mbox: pointer to lpfc mbox command.
1683  * This routine sets up an entry in the non-embedded mailbox command at the sge
1700  * lpfc_sli4_mbx_sge_get - Get a sge entry from non-embedded mailbox command
1701  * @mbox: pointer to lpfc mbox command.
1705  * This routine gets an entry from the non-embedded mailbox command at the sge
1722  * lpfc_sli4_mbox_cmd_free - Free a sli4 mailbox command
1724  * @mbox: pointer to lpfc mbox command.
1726  * This routine frees SLI4 specific mailbox command for sending IOCTL command.
1738 	/* For embedded mbox command, just free the mbox command */  in lpfc_sli4_mbox_cmd_free()
1744 	/* For non-embedded mbox command, we need to free the pages first */  in lpfc_sli4_mbox_cmd_free()
1760 	/* Finally, free the mailbox command itself */  in lpfc_sli4_mbox_cmd_free()
1765  * lpfc_sli4_config - Initialize the  SLI4 Config Mailbox command
1767  * @mbox: pointer to lpfc mbox command.
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.
1773  * This routine sets up the header fields of SLI4 specific mailbox command
1774  * for sending IOCTL command.
1776  * Return: the actual length of the mbox command allocated (mostly useful
1777  *         for none embedded mailbox command).
1791 	/* Set up SLI4 mailbox command header fields */  in lpfc_sli4_config()
1795 	/* Set up SLI4 ioctl command header fields */  in lpfc_sli4_config()
1798 	/* Setup for the embedded mbox command */  in lpfc_sli4_config()
1813 	/* Setup for the non-embedded mbox command */  in lpfc_sli4_config()
1854 	/* Set up main header fields in mailbox command */  in lpfc_sli4_config()
1885  * Return: the actual length of the mbox command allocated.
1895 	/* Set up SLI4 ioctl command header fields */  in lpfc_sli4_mbox_rsrc_extent()
1951  * @mbox: pointer to lpfc mbox command queue entry.
1954  * command. If the mailbox command is not MBX_SLI4_CONFIG (0x9B) or if the
1968 	/* For embedded mbox command, get opcode from embedded sub-header*/  in lpfc_sli_config_mbox_subsys_get()
1974 	/* For non-embedded mbox command, get opcode from first dma page */  in lpfc_sli_config_mbox_subsys_get()
1984  * @mbox: pointer to lpfc mbox command queue entry.
1987  * command. If the mailbox command is not MBX_SLI4_CONFIG (0x9B) or if
2001 	/* For embedded mbox command, get opcode from embedded sub-header*/  in lpfc_sli_config_mbox_opcode_get()
2007 	/* For non-embedded mbox command, get opcode from first dma page */  in lpfc_sli_config_mbox_opcode_get()
2017  * @mboxq: pointer to lpfc mbox command.
2020  * This routine routine allocates and constructs non-embedded mailbox command
2023  * Return: pointer to the mailbox command constructed if successful, otherwise
2043 	/* Set up READ_FCF SLI4_CONFIG mailbox-ioctl command */  in lpfc_sli4_mbx_read_fcf_rec()
2063 	/* Set up command fields */  in lpfc_sli4_mbx_read_fcf_rec()
2075  * @mboxq: pointer to lpfc mbox command.
2078  * mailbox command.
2083 	/* Set up SLI4 mailbox command header fields */  in lpfc_request_features()
2115  * lpfc_init_vfi - Initialize the INIT_VFI mailbox command
2116  * @mbox: pointer to lpfc mbox command to initialize.
2121  * in the context of an FCF. The driver issues this command to setup a VFI
2146  * lpfc_reg_vfi - Initialize the REG_VFI mailbox command
2147  * @mbox: pointer to lpfc mbox command to initialize.
2225  * lpfc_init_vpi - Initialize the INIT_VPI mailbox command
2227  * @mbox: pointer to lpfc mbox command to initialize.
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
2248  * lpfc_unreg_vfi - Initialize the UNREG_VFI mailbox command
2249  * @mbox: pointer to lpfc mbox command to initialize.
2252  * The UNREG_VFI mailbox command causes the SLI Host to put a virtual fabric
2270  * @mbox: pointer to lpfc mbox command to initialize.
2272  * This function create a SLI4 dump mailbox command to dump configure
2422  * @mbox: pointer to lpfc mbox command to initialize.
2424  * This function create a SLI4 dump mailbox command to dump configure
2466  * lpfc_reg_fcfi - Initialize the REG_FCFI mailbox command
2468  * @mbox: pointer to lpfc mbox command to initialize.
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
2533  * lpfc_reg_fcfi_mrq - Initialize the REG_FCFI_MRQ mailbox command
2535  * @mbox: pointer to lpfc mbox command to initialize.
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
2597  * lpfc_unreg_fcfi - Initialize the UNREG_FCFI mailbox command
2598  * @mbox: pointer to lpfc mbox command to initialize.
2601  * The UNREG_FCFI mailbox command supports Fibre Channel Forwarders (FCFs).
2602  * The SLI Host uses the command to inactivate an FCFI.
2613  * lpfc_resume_rpi - Initialize the RESUME_RPI mailbox command
2614  * @mbox: pointer to lpfc mbox command to initialize.
2617  * The RESUME_RPI mailbox command is used to restart I/O to an RPI after a