[linux-block.git] / drivers / scsi / lpfc / lpfc_scsi.h

/*******************************************************************
 * This file is part of the Emulex Linux Device Driver for         *
 * Fibre Channel Host Bus Adapters.                                *
 * Copyright (C) 2017-2018 Broadcom. All Rights Reserved. The term *
 * “Broadcom” refers to Broadcom Inc and/or its subsidiaries.  *
 * Copyright (C) 2004-2016 Emulex.  All rights reserved.           *
 * EMULEX and SLI are trademarks of Emulex.                        *
 * www.broadcom.com                                                *
 *                                                                 *
 * This program is free software; you can redistribute it and/or   *
 * modify it under the terms of version 2 of the GNU General       *
 * Public License as published by the Free Software Foundation.    *
 * This program is distributed in the hope that it will be useful. *
 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
 * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
 * more details, a copy of which can be found in the file COPYING  *
 * included with this package.                                     *
 *******************************************************************/

#include <asm/byteorder.h>

struct lpfc_hba;
#define LPFC_FCP_CDB_LEN 16

#define list_remove_head(list, entry, type, member)		\
	do {							\
	entry = NULL;						\
	if (!list_empty(list)) {				\
		entry = list_entry((list)->next, type, member);	\
		list_del_init(&entry->member);			\
	}							\
	} while(0)

#define list_get_first(list, type, member)			\
	(list_empty(list)) ? NULL :				\
	list_entry((list)->next, type, member)

/* per-port data that is allocated in the FC transport for us */
struct lpfc_rport_data {
	struct lpfc_nodelist *pnode;	/* Pointer to the node structure. */
};

struct lpfc_device_id {
	struct lpfc_name vport_wwpn;
	struct lpfc_name target_wwpn;
	uint64_t lun;
};

struct lpfc_device_data {
	struct list_head listentry;
	struct lpfc_rport_data *rport_data;
	struct lpfc_device_id device_id;
	uint8_t priority;
	bool oas_enabled;
	bool available;
};

struct fcp_rsp {
	uint32_t rspRsvd1;	/* FC Word 0, byte 0:3 */
	uint32_t rspRsvd2;	/* FC Word 1, byte 0:3 */

	uint8_t rspStatus0;	/* FCP_STATUS byte 0 (reserved) */
	uint8_t rspStatus1;	/* FCP_STATUS byte 1 (reserved) */
	uint8_t rspStatus2;	/* FCP_STATUS byte 2 field validity */
#define RSP_LEN_VALID  0x01	/* bit 0 */
#define SNS_LEN_VALID  0x02	/* bit 1 */
#define RESID_OVER     0x04	/* bit 2 */
#define RESID_UNDER    0x08	/* bit 3 */
	uint8_t rspStatus3;	/* FCP_STATUS byte 3 SCSI status byte */

	uint32_t rspResId;	/* Residual xfer if residual count field set in
				   fcpStatus2 */
	/* Received in Big Endian format */
	uint32_t rspSnsLen;	/* Length of sense data in fcpSnsInfo */
	/* Received in Big Endian format */
	uint32_t rspRspLen;	/* Length of FCP response data in fcpRspInfo */
	/* Received in Big Endian format */

	uint8_t rspInfo0;	/* FCP_RSP_INFO byte 0 (reserved) */
	uint8_t rspInfo1;	/* FCP_RSP_INFO byte 1 (reserved) */
	uint8_t rspInfo2;	/* FCP_RSP_INFO byte 2 (reserved) */
	uint8_t rspInfo3;	/* FCP_RSP_INFO RSP_CODE byte 3 */

#define RSP_NO_FAILURE       0x00
#define RSP_DATA_BURST_ERR   0x01
#define RSP_CMD_FIELD_ERR    0x02
#define RSP_RO_MISMATCH_ERR  0x03
#define RSP_TM_NOT_SUPPORTED 0x04	/* Task mgmt function not supported */
#define RSP_TM_NOT_COMPLETED 0x05	/* Task mgmt function not performed */
#define RSP_TM_INVALID_LU    0x09	/* Task mgmt function to invalid LU */

	uint32_t rspInfoRsvd;	/* FCP_RSP_INFO bytes 4-7 (reserved) */

	uint8_t rspSnsInfo[128];
#define SNS_ILLEGAL_REQ 0x05	/* sense key is byte 3 ([2]) */
#define SNSCOD_BADCMD 0x20	/* sense code is byte 13 ([12]) */
};

struct fcp_cmnd {
	struct scsi_lun  fcp_lun;

	uint8_t fcpCntl0;	/* FCP_CNTL byte 0 (reserved) */
	uint8_t fcpCntl1;	/* FCP_CNTL byte 1 task codes */
#define  SIMPLE_Q        0x00
#define  HEAD_OF_Q       0x01
#define  ORDERED_Q       0x02
#define  ACA_Q           0x04
#define  UNTAGGED        0x05
	uint8_t fcpCntl2;	/* FCP_CTL byte 2 task management codes */
#define  FCP_ABORT_TASK_SET  0x02	/* Bit 1 */
#define  FCP_CLEAR_TASK_SET  0x04	/* bit 2 */
#define  FCP_BUS_RESET       0x08	/* bit 3 */
#define  FCP_LUN_RESET       0x10	/* bit 4 */
#define  FCP_TARGET_RESET    0x20	/* bit 5 */
#define  FCP_CLEAR_ACA       0x40	/* bit 6 */
#define  FCP_TERMINATE_TASK  0x80	/* bit 7 */
	uint8_t fcpCntl3;
#define  WRITE_DATA      0x01	/* Bit 0 */
#define  READ_DATA       0x02	/* Bit 1 */

	uint8_t fcpCdb[LPFC_FCP_CDB_LEN]; /* SRB cdb field is copied here */
	uint32_t fcpDl;		/* Total transfer length */

};

struct lpfc_scsicmd_bkt {
	uint32_t cmd_count;
};

struct lpfc_scsi_buf {
	/* Common fields */
	struct list_head list;
	void *data;
	dma_addr_t dma_handle;
	dma_addr_t dma_phys_sgl;
	struct ulp_bde64 *dma_sgl;
	struct lpfc_iocbq cur_iocbq;
	struct lpfc_sli4_hdw_queue *hdwq;
	uint16_t hdwq_no;
	uint16_t cpu;

	/* SCSI specific fields */
	struct scsi_cmnd *pCmd;
	struct lpfc_rport_data *rdata;
	struct lpfc_nodelist *ndlp;

	uint32_t timeout;

	uint16_t flags;  /* TBD convert exch_busy to flags */
#define LPFC_SBUF_XBUSY		0x1	/* SLI4 hba reported XB on WCQE cmpl */
#define LPFC_SBUF_BUMP_QDEPTH	0x2	/* bumped queue depth counter */
	uint16_t exch_busy;     /* SLI4 hba reported XB on complete WCQE */
	uint16_t status;	/* From IOCB Word 7- ulpStatus */
	uint32_t result;	/* From IOCB Word 4. */

	uint32_t   seg_cnt;	/* Number of scatter-gather segments returned by
				 * dma_map_sg.  The driver needs this for calls
				 * to dma_unmap_sg. */
	uint32_t prot_seg_cnt;  /* seg_cnt's counterpart for protection data */

	/*
	 * data and dma_handle are the kernel virtual and bus address of the
	 * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
	 * gather bde list that supports the sg_tablesize value.
	 */
	struct fcp_cmnd *fcp_cmnd;
	struct fcp_rsp *fcp_rsp;

	wait_queue_head_t *waitq;
	unsigned long start_time;

#ifdef CONFIG_SCSI_LPFC_DEBUG_FS
	/* Used to restore any changes to protection data for error injection */
	void *prot_data_segment;
	uint32_t prot_data;
	uint32_t prot_data_type;
#define	LPFC_INJERR_REFTAG	1
#define	LPFC_INJERR_APPTAG	2
#define	LPFC_INJERR_GUARD	3
#endif
};

#define LPFC_SCSI_DMA_EXT_SIZE	264
#define LPFC_BPL_SIZE		1024
#define MDAC_DIRECT_CMD		0x22

#define FIND_FIRST_OAS_LUN	0
#define NO_MORE_OAS_LUN		-1
#define NOT_OAS_ENABLED_LUN	NO_MORE_OAS_LUN

#ifndef FC_PORTSPEED_128GBIT
#define FC_PORTSPEED_128GBIT	0x2000
#endif

#define TXRDY_PAYLOAD_LEN	12

/* For sysfs/debugfs tmp string max len */
#define LPFC_MAX_SCSI_INFO_TMP_LEN	79
Commit	Line	Data
dea3101e	1	/*******************************************************************
dea3101e	2	* This file is part of the Emulex Linux Device Driver for *
c44ce173	3	* Fibre Channel Host Bus Adapters. *
217c55cd	4	* Copyright (C) 2017-2018 Broadcom. All Rights Reserved. The term *
3e21d1cb	5	* “Broadcom” refers to Broadcom Inc and/or its subsidiaries. *
51f4ca3c	6	* Copyright (C) 2004-2016 Emulex. All rights reserved. *
c44ce173	7	* EMULEX and SLI are trademarks of Emulex. *
d080abe0	8	* www.broadcom.com *
dea3101e	9	* *
dea3101e	10	* This program is free software; you can redistribute it and/or *
c44ce173 JSEC	11	* modify it under the terms of version 2 of the GNU General *
	12	* Public License as published by the Free Software Foundation. *
	13	* This program is distributed in the hope that it will be useful. *
	14	* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND *
	15	* WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, *
	16	* FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE *
	17	* DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
	18	* TO BE LEGALLY INVALID. See the GNU General Public License for *
	19	* more details, a copy of which can be found in the file COPYING *
	20	* included with this package. *
dea3101e	21	*******************************************************************/
dea3101e	22
44456d37 OH	23	#include <asm/byteorder.h>
44456d37 OH	24
dea3101e	25	struct lpfc_hba;
df9e1b59	26	#define LPFC_FCP_CDB_LEN 16
dea3101e	27
dea3101e	28	#define list_remove_head(list, entry, type, member) \
286fc8f8 JB	29	do { \
286fc8f8 JB	30	entry = NULL; \
dea3101e	31	if (!list_empty(list)) { \
	32	entry = list_entry((list)->next, type, member); \
	33	list_del_init(&entry->member); \
286fc8f8 JB	34	} \
286fc8f8 JB	35	} while(0)
dea3101e	36
	37	#define list_get_first(list, type, member) \
	38	(list_empty(list)) ? NULL : \
	39	list_entry((list)->next, type, member)
	40
	41	/* per-port data that is allocated in the FC transport for us */
	42	struct lpfc_rport_data {
	43	struct lpfc_nodelist pnode; / Pointer to the node structure. */
	44	};
	45
1ba981fd JS	46	struct lpfc_device_id {
	47	struct lpfc_name vport_wwpn;
	48	struct lpfc_name target_wwpn;
	49	uint64_t lun;
	50	};
	51
	52	struct lpfc_device_data {
	53	struct list_head listentry;
	54	struct lpfc_rport_data *rport_data;
	55	struct lpfc_device_id device_id;
c92c841c	56	uint8_t priority;
1ba981fd JS	57	bool oas_enabled;
	58	bool available;
	59	};
	60
dea3101e	61	struct fcp_rsp {
	62	uint32_t rspRsvd1; /* FC Word 0, byte 0:3 */
	63	uint32_t rspRsvd2; /* FC Word 1, byte 0:3 */
	64
	65	uint8_t rspStatus0; /* FCP_STATUS byte 0 (reserved) */
	66	uint8_t rspStatus1; /* FCP_STATUS byte 1 (reserved) */
	67	uint8_t rspStatus2; /* FCP_STATUS byte 2 field validity */
	68	#define RSP_LEN_VALID 0x01 /* bit 0 */
	69	#define SNS_LEN_VALID 0x02 /* bit 1 */
	70	#define RESID_OVER 0x04 /* bit 2 */
	71	#define RESID_UNDER 0x08 /* bit 3 */
	72	uint8_t rspStatus3; /* FCP_STATUS byte 3 SCSI status byte */
	73
	74	uint32_t rspResId; /* Residual xfer if residual count field set in
	75	fcpStatus2 */
	76	/* Received in Big Endian format */
	77	uint32_t rspSnsLen; /* Length of sense data in fcpSnsInfo */
	78	/* Received in Big Endian format */
	79	uint32_t rspRspLen; /* Length of FCP response data in fcpRspInfo */
	80	/* Received in Big Endian format */
	81
	82	uint8_t rspInfo0; /* FCP_RSP_INFO byte 0 (reserved) */
	83	uint8_t rspInfo1; /* FCP_RSP_INFO byte 1 (reserved) */
	84	uint8_t rspInfo2; /* FCP_RSP_INFO byte 2 (reserved) */
	85	uint8_t rspInfo3; /* FCP_RSP_INFO RSP_CODE byte 3 */
	86
	87	#define RSP_NO_FAILURE 0x00
	88	#define RSP_DATA_BURST_ERR 0x01
	89	#define RSP_CMD_FIELD_ERR 0x02
	90	#define RSP_RO_MISMATCH_ERR 0x03
	91	#define RSP_TM_NOT_SUPPORTED 0x04 /* Task mgmt function not supported */
	92	#define RSP_TM_NOT_COMPLETED 0x05 /* Task mgmt function not performed */
53151bbb	93	#define RSP_TM_INVALID_LU 0x09 /* Task mgmt function to invalid LU */
dea3101e	94
	95	uint32_t rspInfoRsvd; /* FCP_RSP_INFO bytes 4-7 (reserved) */
	96
	97	uint8_t rspSnsInfo[128];
	98	#define SNS_ILLEGAL_REQ 0x05 /* sense key is byte 3 ([2]) */
	99	#define SNSCOD_BADCMD 0x20 /* sense code is byte 13 ([12]) */
	100	};
	101
	102	struct fcp_cmnd {
91886523	103	struct scsi_lun fcp_lun;
dea3101e	104
	105	uint8_t fcpCntl0; /* FCP_CNTL byte 0 (reserved) */
	106	uint8_t fcpCntl1; /* FCP_CNTL byte 1 task codes */
	107	#define SIMPLE_Q 0x00
	108	#define HEAD_OF_Q 0x01
	109	#define ORDERED_Q 0x02
	110	#define ACA_Q 0x04
	111	#define UNTAGGED 0x05
	112	uint8_t fcpCntl2; /* FCP_CTL byte 2 task management codes */
	113	#define FCP_ABORT_TASK_SET 0x02 /* Bit 1 */
	114	#define FCP_CLEAR_TASK_SET 0x04 /* bit 2 */
	115	#define FCP_BUS_RESET 0x08 /* bit 3 */
	116	#define FCP_LUN_RESET 0x10 /* bit 4 */
	117	#define FCP_TARGET_RESET 0x20 /* bit 5 */
	118	#define FCP_CLEAR_ACA 0x40 /* bit 6 */
	119	#define FCP_TERMINATE_TASK 0x80 /* bit 7 */
	120	uint8_t fcpCntl3;
	121	#define WRITE_DATA 0x01 /* Bit 0 */
	122	#define READ_DATA 0x02 /* Bit 1 */
	123
df9e1b59	124	uint8_t fcpCdb[LPFC_FCP_CDB_LEN]; /* SRB cdb field is copied here */
dea3101e	125	uint32_t fcpDl; /* Total transfer length */
	126
	127	};
	128
ea2151b4 JS	129	struct lpfc_scsicmd_bkt {
	130	uint32_t cmd_count;
	131	};
	132
dea3101e	133	struct lpfc_scsi_buf {
0794d601	134	/* Common fields */
dea3101e	135	struct list_head list;
0794d601 JS	136	void *data;
	137	dma_addr_t dma_handle;
	138	dma_addr_t dma_phys_sgl;
	139	struct ulp_bde64 *dma_sgl;
	140	struct lpfc_iocbq cur_iocbq;
1fbf9742 JS	141	struct lpfc_sli4_hdw_queue *hdwq;
1fbf9742 JS	142	uint16_t hdwq_no;
5e5b511d	143	uint16_t cpu;
0794d601 JS	144
0794d601 JS	145	/* SCSI specific fields */
dea3101e	146	struct scsi_cmnd *pCmd;
dea3101e	147	struct lpfc_rport_data *rdata;
2a5b7d62	148	struct lpfc_nodelist *ndlp;
dea3101e	149
	150	uint32_t timeout;
	151
895427bd	152	uint16_t flags; /* TBD convert exch_busy to flags */
0794d601 JS	153	#define LPFC_SBUF_XBUSY 0x1 /* SLI4 hba reported XB on WCQE cmpl */
0794d601 JS	154	#define LPFC_SBUF_BUMP_QDEPTH 0x2 /* bumped queue depth counter */
341af102	155	uint16_t exch_busy; /* SLI4 hba reported XB on complete WCQE */
dea3101e	156	uint16_t status; /* From IOCB Word 7- ulpStatus */
	157	uint32_t result; /* From IOCB Word 4. */
	158
	159	uint32_t seg_cnt; /* Number of scatter-gather segments returned by
	160	* dma_map_sg. The driver needs this for calls
	161	* to dma_unmap_sg. */
e2a0a9d6 JS	162	uint32_t prot_seg_cnt; /* seg_cnt's counterpart for protection data */
e2a0a9d6 JS	163
dea3101e	164	/*
25985edc	165	* data and dma_handle are the kernel virtual and bus address of the
dea3101e	166	* dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
	167	* gather bde list that supports the sg_tablesize value.
	168	*/
dea3101e	169	struct fcp_cmnd *fcp_cmnd;
dea3101e	170	struct fcp_rsp *fcp_rsp;
895427bd	171
fa61a54e	172	wait_queue_head_t *waitq;
977b5a0a	173	unsigned long start_time;
9a6b09c0 JS	174
	175	#ifdef CONFIG_SCSI_LPFC_DEBUG_FS
	176	/* Used to restore any changes to protection data for error injection */
	177	void *prot_data_segment;
	178	uint32_t prot_data;
	179	uint32_t prot_data_type;
	180	#define LPFC_INJERR_REFTAG 1
	181	#define LPFC_INJERR_APPTAG 2
	182	#define LPFC_INJERR_GUARD 3
	183	#endif
dea3101e	184	};
dea3101e	185
2ea259ee JS	186	#define LPFC_SCSI_DMA_EXT_SIZE 264
	187	#define LPFC_BPL_SIZE 1024
	188	#define MDAC_DIRECT_CMD 0x22
1ba981fd	189
2ea259ee JS	190	#define FIND_FIRST_OAS_LUN 0
	191	#define NO_MORE_OAS_LUN -1
	192	#define NOT_OAS_ENABLED_LUN NO_MORE_OAS_LUN
8b0dff14	193
1dc5ec24 JS	194	#ifndef FC_PORTSPEED_128GBIT
	195	#define FC_PORTSPEED_128GBIT 0x2000
	196	#endif
	197
895427bd JS	198	#define TXRDY_PAYLOAD_LEN 12
895427bd JS	199
4c47efc1 JS	200	/* For sysfs/debugfs tmp string max len */
	201	#define LPFC_MAX_SCSI_INFO_TMP_LEN 79
	202