scsi/fnic/fcpio.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
13  * communication by the host driver to the fcp firmware.
17  * Exchange and sequence id space allocated to the host driver
25  * Command entry type
105  * The header command tag.  All host requests will use the "tag" field
107  * a host request, it will copy the tag field into the response.
110  * of the tag field will be the target command and target task management
111  * requests.  These two requests do not have corresponding host requests
127 	tag->u.req_id = id;  in fcpio_tag_id_enc()
133 	*id = tag->u.req_id;  in fcpio_tag_id_dec()
139 	tag->u.ex_id.rx_id = rx_id;  in fcpio_tag_exid_enc()
140 	tag->u.ex_id.ox_id = ox_id;  in fcpio_tag_exid_enc()
146 	*rx_id = tag->u.ex_id.rx_id;  in fcpio_tag_exid_dec()
147 	*ox_id = tag->u.ex_id.ox_id;  in fcpio_tag_exid_dec()
152  * host driver
166 	hdr->type = type;  in fcpio_header_enc()
167 	hdr->status = status;  in fcpio_header_enc()
168 	hdr->_resvd = 0;  in fcpio_header_enc()
169 	hdr->tag = tag;  in fcpio_header_enc()
177 	*type = hdr->type;  in fcpio_header_dec()
178 	*status = hdr->status;  in fcpio_header_dec()
179 	*tag = hdr->tag;  in fcpio_header_dec()
187  * fcpio_icmnd_16: host -> firmware request
189  * used for sending out an initiator SCSI 16-byte command
195 	u32	  sgl_cnt;		/* scatter-gather list count */
197 	u64	  sgl_addr;		/* scatter-gather list addr */
199 	u8	  crn;			/* SCSI Command Reference No. */
202 	u8	  flags;		/* command flags */
229  * Command flags
235  * fcpio_icmnd_32: host -> firmware request
237  * used for sending out an initiator SCSI 32-byte command
243 	u32   sgl_cnt;                /* scatter-gather list count */
245 	u64   sgl_addr;               /* scatter-gather list addr */
247 	u8    crn;                    /* SCSI Command Reference No. */
250 	u8    flags;                  /* command flags */
263  * fcpio_itmf: host -> firmware request
295  * fcpio_tdata: host -> firmware request
298  * target command
301 	u16   rx_id;                  /* FC rx_id of target command */
302 	u16   flags;                  /* command flags */
304 	u32   sgl_cnt;                /* scatter-gather list count */
306 	u64   sgl_addr;               /* scatter-gather list address */
310  * Command flags
315  * fcpio_txrdy: host -> firmware request
318  * target command
321 	u16   rx_id;                  /* FC rx_id of target command */
324 	u32   sgl_cnt;                /* scatter-gather list count */
326 	u64   sgl_addr;               /* scatter-gather list address */
330  * fcpio_trsp: host -> firmware request
333  * command
336 	u16   rx_id;                  /* FC rx_id of target command */
353  * fcpio_ttmf_ack: host -> firmware response
355  * used by the host to indicate to the firmware it has received and processed
359 	u16   rx_id;                  /* FC rx_id of target command */
365  * fcpio_tabort: host -> firmware request
367  * used by the host to request the firmware to abort a target request that was
375  * fcpio_reset: host -> firmware request
377  * used by the host to signal a reset of the driver to the firmware
390  * fcpio_flogi_reg: host -> firmware request
393  * used by the host to notify the firmware of the lif's s_id
406  * fcpio_echo: host -> firmware request
415  * fcpio_lunmap_req: host -> firmware request
426  * fcpio_flogi_fip_reg: host -> firmware request
429  * used by the host to notify the firmware of the lif's s_id
439 	u8    ha_mac[ETH_ALEN];       /* Host adapter source mac */
444  * Basic structure for all fcpio structures that are sent from the host to the
447 #define FCPIO_HOST_REQ_LEN      128     /* expected length of host requests */
456 		u8 buf[FCPIO_HOST_REQ_LEN - sizeof(struct fcpio_header)];
459 		 * Initiator host requests
466 		 * Target host requests
486  * fcpio_icmnd_cmpl: firmware -> host response
488  * used for sending the host a response to an initiator command
505  * fcpio_itmf_cmpl: firmware -> host response
507  * used for sending the host a response for a itmf request
514  * fcpio_tcmnd_16: firmware -> host request
516  * used by the firmware to notify the host of an incoming target SCSI 16-Byte
521 	u8    crn;                    /* SCSI Command Reference No. */
524 	u8    flags;                  /* command flags */
541  * Command flags
547  * fcpio_tcmnd_32: firmware -> host request
549  * used by the firmware to notify the host of an incoming target SCSI 32-Byte
554 	u8    crn;                    /* SCSI Command Reference No. */
557 	u8    flags;                  /* command flags */
565  * fcpio_tdrsp_cmpl: firmware -> host response
567  * used by the firmware to notify the host of a response to a host target
568  * command
576  * fcpio_ttmf: firmware -> host request
578  * used by the firmware to notify the host of an incoming task management
585 	u8    crn;                    /* SCSI Command Reference No. */
600  * fcpio_tabort_cmpl: firmware -> host response
602  * used by the firmware to respond to a host's tabort request
610  * fcpio_ack: firmware -> host response
612  * used by firmware to notify the host of the last work request received
615 	u16  request_out;             /* last host entry received */
620  * fcpio_reset_cmpl: firmware -> host response
622  * use by firmware to respond to the host's reset request
629  * fcpio_flogi_reg_cmpl: firmware -> host response
639  * fcpio_echo_cmpl: firmware -> host response
648  * fcpio_lunmap_chng: firmware -> host notification
651  * notifies the host that the lunmap tables have changed
658  * fcpio_lunmap_req_cmpl: firmware -> host response
661  * response for lunmap table request from the host
669  * the host.  They are 64 bytes per structure.
679 		u8 buf[FCPIO_FW_REQ_LEN - sizeof(struct fcpio_header)];
722 	u8 *c = ((u8 *) fw_req) + sizeof(struct fcpio_fw_req) - 1;  in fcpio_color_enc()
732 	u8 *c = ((u8 *) fw_req) + sizeof(struct fcpio_fw_req) - 1;  in fcpio_color_dec()