1/*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for         *
3 * Fibre Channel Host Bus Adapters.                                *
4 * Copyright (C) 2017-2022 Broadcom. All Rights Reserved. The term *
5 * “Broadcom” refers to Broadcom Inc and/or its subsidiaries.  *
6 * Copyright (C) 2004-2016 Emulex.  All rights reserved.           *
7 * EMULEX and SLI are trademarks of Emulex.                        *
8 * www.broadcom.com                                                *
9 *                                                                 *
10 * This program is free software; you can redistribute it and/or   *
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.                                     *
21 *******************************************************************/
22
23#include <asm/byteorder.h>
24
25struct lpfc_hba;
26#define LPFC_FCP_CDB_LEN 16
27
28#define list_remove_head(list, entry, type, member)		\
29	do {							\
30	entry = NULL;						\
31	if (!list_empty(list)) {				\
32		entry = list_entry((list)->next, type, member);	\
33		list_del_init(&entry->member);			\
34	}							\
35	} while(0)
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 */
42struct lpfc_rport_data {
43	struct lpfc_nodelist *pnode;	/* Pointer to the node structure. */
44};
45
46struct lpfc_device_id {
47	struct lpfc_name vport_wwpn;
48	struct lpfc_name target_wwpn;
49	uint64_t lun;
50};
51
52struct lpfc_device_data {
53	struct list_head listentry;
54	struct lpfc_rport_data *rport_data;
55	struct lpfc_device_id device_id;
56	uint8_t priority;
57	bool oas_enabled;
58	bool available;
59};
60
61struct 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 */
93#define RSP_TM_INVALID_LU    0x09	/* Task mgmt function to invalid LU */
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
102struct fcp_cmnd {
103	struct scsi_lun  fcp_lun;
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
124	uint8_t fcpCdb[LPFC_FCP_CDB_LEN]; /* SRB cdb field is copied here */
125	uint32_t fcpDl;		/* Total transfer length */
126
127};
128
129#define LPFC_SCSI_DMA_EXT_SIZE	264
130#define LPFC_BPL_SIZE		1024
131#define MDAC_DIRECT_CMD		0x22
132
133#define FIND_FIRST_OAS_LUN	0
134#define NO_MORE_OAS_LUN		-1
135#define NOT_OAS_ENABLED_LUN	NO_MORE_OAS_LUN
136
137#ifndef FC_PORTSPEED_128GBIT
138#define FC_PORTSPEED_128GBIT	0x2000
139#endif
140
141#ifndef FC_PORTSPEED_256GBIT
142#define FC_PORTSPEED_256GBIT	0x4000
143#endif
144
145#define TXRDY_PAYLOAD_LEN	12
146
147/* For sysfs/debugfs tmp string max len */
148#define LPFC_MAX_SCSI_INFO_TMP_LEN	79
149
150