xref: /OK3568_Linux_fs/kernel/include/linux/qed/storage_common.h (revision 4882a59341e53eb6f0b4789bf948001014eff981) 
1*4882a593Smuzhiyun /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
2*4882a593Smuzhiyun /* QLogic qed NIC Driver
3*4882a593Smuzhiyun  * Copyright (c) 2015-2017  QLogic Corporation
4*4882a593Smuzhiyun  * Copyright (c) 2019-2020 Marvell International Ltd.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef __STORAGE_COMMON__
8*4882a593Smuzhiyun #define __STORAGE_COMMON__
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun /*********************/
11*4882a593Smuzhiyun /* SCSI CONSTANTS */
12*4882a593Smuzhiyun /*********************/
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #define SCSI_MAX_NUM_OF_CMDQS		(NUM_OF_GLOBAL_QUEUES / 2)
15*4882a593Smuzhiyun #define BDQ_NUM_RESOURCES		(4)
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #define BDQ_ID_RQ			(0)
18*4882a593Smuzhiyun #define BDQ_ID_IMM_DATA			(1)
19*4882a593Smuzhiyun #define BDQ_ID_TQ			(2)
20*4882a593Smuzhiyun #define BDQ_NUM_IDS			(3)
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define SCSI_NUM_SGES_SLOW_SGL_THR	8
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun #define BDQ_MAX_EXTERNAL_RING_SIZE	BIT(15)
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun /* SCSI op codes */
27*4882a593Smuzhiyun #define SCSI_OPCODE_COMPARE_AND_WRITE	(0x89)
28*4882a593Smuzhiyun #define SCSI_OPCODE_READ_10		(0x28)
29*4882a593Smuzhiyun #define SCSI_OPCODE_WRITE_6		(0x0A)
30*4882a593Smuzhiyun #define SCSI_OPCODE_WRITE_10		(0x2A)
31*4882a593Smuzhiyun #define SCSI_OPCODE_WRITE_12		(0xAA)
32*4882a593Smuzhiyun #define SCSI_OPCODE_WRITE_16		(0x8A)
33*4882a593Smuzhiyun #define SCSI_OPCODE_WRITE_AND_VERIFY_10	(0x2E)
34*4882a593Smuzhiyun #define SCSI_OPCODE_WRITE_AND_VERIFY_12	(0xAE)
35*4882a593Smuzhiyun #define SCSI_OPCODE_WRITE_AND_VERIFY_16	(0x8E)
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /* iSCSI Drv opaque */
38*4882a593Smuzhiyun struct iscsi_drv_opaque {
39*4882a593Smuzhiyun 	__le16 reserved_zero[3];
40*4882a593Smuzhiyun 	__le16 opaque;
41*4882a593Smuzhiyun };
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun /* Scsi 2B/8B opaque union */
44*4882a593Smuzhiyun union scsi_opaque {
45*4882a593Smuzhiyun 	struct regpair fcoe_opaque;
46*4882a593Smuzhiyun 	struct iscsi_drv_opaque iscsi_opaque;
47*4882a593Smuzhiyun };
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun /* SCSI buffer descriptor */
50*4882a593Smuzhiyun struct scsi_bd {
51*4882a593Smuzhiyun 	struct regpair address;
52*4882a593Smuzhiyun 	union scsi_opaque opaque;
53*4882a593Smuzhiyun };
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun /* Scsi Drv BDQ struct */
56*4882a593Smuzhiyun struct scsi_bdq_ram_drv_data {
57*4882a593Smuzhiyun 	__le16 external_producer;
58*4882a593Smuzhiyun 	__le16 reserved0[3];
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun /* SCSI SGE entry */
62*4882a593Smuzhiyun struct scsi_sge {
63*4882a593Smuzhiyun 	struct regpair sge_addr;
64*4882a593Smuzhiyun 	__le32 sge_len;
65*4882a593Smuzhiyun 	__le32 reserved;
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun /* Cached SGEs section */
69*4882a593Smuzhiyun struct scsi_cached_sges {
70*4882a593Smuzhiyun 	struct scsi_sge sge[4];
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun /* Scsi Drv CMDQ struct */
74*4882a593Smuzhiyun struct scsi_drv_cmdq {
75*4882a593Smuzhiyun 	__le16 cmdq_cons;
76*4882a593Smuzhiyun 	__le16 reserved0;
77*4882a593Smuzhiyun 	__le32 reserved1;
78*4882a593Smuzhiyun };
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun /* Common SCSI init params passed by driver to FW in function init ramrod */
81*4882a593Smuzhiyun struct scsi_init_func_params {
82*4882a593Smuzhiyun 	__le16 num_tasks;
83*4882a593Smuzhiyun 	u8 log_page_size;
84*4882a593Smuzhiyun 	u8 log_page_size_conn;
85*4882a593Smuzhiyun 	u8 debug_mode;
86*4882a593Smuzhiyun 	u8 reserved2[11];
87*4882a593Smuzhiyun };
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun /* SCSI RQ/CQ/CMDQ firmware function init parameters */
90*4882a593Smuzhiyun struct scsi_init_func_queues {
91*4882a593Smuzhiyun 	struct regpair glbl_q_params_addr;
92*4882a593Smuzhiyun 	__le16 rq_buffer_size;
93*4882a593Smuzhiyun 	__le16 cq_num_entries;
94*4882a593Smuzhiyun 	__le16 cmdq_num_entries;
95*4882a593Smuzhiyun 	u8 bdq_resource_id;
96*4882a593Smuzhiyun 	u8 q_validity;
97*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_MASK			0x1
98*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_SHIFT			0
99*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_MASK		0x1
100*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_SHIFT		1
101*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_MASK			0x1
102*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_SHIFT			2
103*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_TQ_VALID_MASK			0x1
104*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_TQ_VALID_SHIFT			3
105*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_SOC_EN_MASK			0x1
106*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_SOC_EN_SHIFT			4
107*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_SOC_NUM_OF_BLOCKS_LOG_MASK	0x7
108*4882a593Smuzhiyun #define SCSI_INIT_FUNC_QUEUES_SOC_NUM_OF_BLOCKS_LOG_SHIFT	5
109*4882a593Smuzhiyun 	__le16 cq_cmdq_sb_num_arr[SCSI_MAX_NUM_OF_CMDQS];
110*4882a593Smuzhiyun 	u8 num_queues;
111*4882a593Smuzhiyun 	u8 queue_relative_offset;
112*4882a593Smuzhiyun 	u8 cq_sb_pi;
113*4882a593Smuzhiyun 	u8 cmdq_sb_pi;
114*4882a593Smuzhiyun 	u8 bdq_pbl_num_entries[BDQ_NUM_IDS];
115*4882a593Smuzhiyun 	u8 reserved1;
116*4882a593Smuzhiyun 	struct regpair bdq_pbl_base_address[BDQ_NUM_IDS];
117*4882a593Smuzhiyun 	__le16 bdq_xoff_threshold[BDQ_NUM_IDS];
118*4882a593Smuzhiyun 	__le16 cmdq_xoff_threshold;
119*4882a593Smuzhiyun 	__le16 bdq_xon_threshold[BDQ_NUM_IDS];
120*4882a593Smuzhiyun 	__le16 cmdq_xon_threshold;
121*4882a593Smuzhiyun };
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun /* Scsi Drv BDQ Data struct (2 BDQ IDs: 0 - RQ, 1 - Immediate Data) */
124*4882a593Smuzhiyun struct scsi_ram_per_bdq_resource_drv_data {
125*4882a593Smuzhiyun 	struct scsi_bdq_ram_drv_data drv_data_per_bdq_id[BDQ_NUM_IDS];
126*4882a593Smuzhiyun };
127*4882a593Smuzhiyun 
128*4882a593Smuzhiyun /* SCSI SGL types */
129*4882a593Smuzhiyun enum scsi_sgl_mode {
130*4882a593Smuzhiyun 	SCSI_TX_SLOW_SGL,
131*4882a593Smuzhiyun 	SCSI_FAST_SGL,
132*4882a593Smuzhiyun 	MAX_SCSI_SGL_MODE
133*4882a593Smuzhiyun };
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun /* SCSI SGL parameters */
136*4882a593Smuzhiyun struct scsi_sgl_params {
137*4882a593Smuzhiyun 	struct regpair sgl_addr;
138*4882a593Smuzhiyun 	__le32 sgl_total_length;
139*4882a593Smuzhiyun 	__le32 sge_offset;
140*4882a593Smuzhiyun 	__le16 sgl_num_sges;
141*4882a593Smuzhiyun 	u8 sgl_index;
142*4882a593Smuzhiyun 	u8 reserved;
143*4882a593Smuzhiyun };
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun /* SCSI terminate connection params */
146*4882a593Smuzhiyun struct scsi_terminate_extra_params {
147*4882a593Smuzhiyun 	__le16 unsolicited_cq_count;
148*4882a593Smuzhiyun 	__le16 cmdq_count;
149*4882a593Smuzhiyun 	u8 reserved[4];
150*4882a593Smuzhiyun };
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun /* SCSI Task Queue Element */
153*4882a593Smuzhiyun struct scsi_tqe {
154*4882a593Smuzhiyun 	__le16 itid;
155*4882a593Smuzhiyun };
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun #endif /* __STORAGE_COMMON__ */
158