1 /* QLogic qed NIC Driver
2  * Copyright (c) 2015-2017  QLogic Corporation
3  *
4  * This software is available to you under a choice of one of two
5  * licenses.  You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, available from the file
7  * COPYING in the main directory of this source tree, or the
8  * OpenIB.org BSD license below:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
18  *      - Redistributions in binary form must reproduce the above
19  *        copyright notice, this list of conditions and the following
20  *        disclaimer in the documentation and /or other materials
21  *        provided with the distribution.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30  * SOFTWARE.
31  */
32 
33 #ifndef __STORAGE_COMMON__
34 #define __STORAGE_COMMON__
35 
36 #define NUM_OF_CMDQS_CQS (NUM_OF_GLOBAL_QUEUES / 2)
37 #define BDQ_NUM_RESOURCES (4)
38 
39 #define BDQ_ID_RQ                        (0)
40 #define BDQ_ID_IMM_DATA          (1)
41 #define BDQ_NUM_IDS          (2)
42 
43 #define BDQ_MAX_EXTERNAL_RING_SIZE (1 << 15)
44 
45 struct scsi_bd {
46 	struct regpair address;
47 	struct regpair opaque;
48 };
49 
50 struct scsi_bdq_ram_drv_data {
51 	__le16 external_producer;
52 	__le16 reserved0[3];
53 };
54 
55 struct scsi_drv_cmdq {
56 	__le16 cmdq_cons;
57 	__le16 reserved0;
58 	__le32 reserved1;
59 };
60 
61 struct scsi_init_func_params {
62 	__le16 num_tasks;
63 	u8 log_page_size;
64 	u8 debug_mode;
65 	u8 reserved2[12];
66 };
67 
68 struct scsi_init_func_queues {
69 	struct regpair glbl_q_params_addr;
70 	__le16 rq_buffer_size;
71 	__le16 cq_num_entries;
72 	__le16 cmdq_num_entries;
73 	u8 bdq_resource_id;
74 	u8 q_validity;
75 #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_MASK        0x1
76 #define SCSI_INIT_FUNC_QUEUES_RQ_VALID_SHIFT       0
77 #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_MASK  0x1
78 #define SCSI_INIT_FUNC_QUEUES_IMM_DATA_VALID_SHIFT 1
79 #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_MASK       0x1
80 #define SCSI_INIT_FUNC_QUEUES_CMD_VALID_SHIFT      2
81 #define SCSI_INIT_FUNC_QUEUES_RESERVED_VALID_MASK  0x1F
82 #define SCSI_INIT_FUNC_QUEUES_RESERVED_VALID_SHIFT 3
83 	u8 num_queues;
84 	u8 queue_relative_offset;
85 	u8 cq_sb_pi;
86 	u8 cmdq_sb_pi;
87 	__le16 cq_cmdq_sb_num_arr[NUM_OF_CMDQS_CQS];
88 	__le16 reserved0;
89 	u8 bdq_pbl_num_entries[BDQ_NUM_IDS];
90 	struct regpair bdq_pbl_base_address[BDQ_NUM_IDS];
91 	__le16 bdq_xoff_threshold[BDQ_NUM_IDS];
92 	__le16 bdq_xon_threshold[BDQ_NUM_IDS];
93 	__le16 cmdq_xoff_threshold;
94 	__le16 cmdq_xon_threshold;
95 	__le32 reserved1;
96 };
97 
98 struct scsi_ram_per_bdq_resource_drv_data {
99 	struct scsi_bdq_ram_drv_data drv_data_per_bdq_id[BDQ_NUM_IDS];
100 };
101 
102 struct scsi_sge {
103 	struct regpair sge_addr;
104 	__le16 sge_len;
105 	__le16 reserved0;
106 	__le32 reserved1;
107 };
108 
109 struct scsi_terminate_extra_params {
110 	__le16 unsolicited_cq_count;
111 	__le16 cmdq_count;
112 	u8 reserved[4];
113 };
114 
115 #endif /* __STORAGE_COMMON__ */
116