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 _QED_OOO_H
34 #define _QED_OOO_H
35 #include <linux/types.h>
36 #include <linux/list.h>
37 #include <linux/slab.h>
38 #include "qed.h"
39 
40 #define QED_MAX_NUM_ISLES	256
41 #define QED_MAX_NUM_OOO_HISTORY_ENTRIES	512
42 
43 #define QED_OOO_LEFT_BUF	0
44 #define QED_OOO_RIGHT_BUF	1
45 
46 struct qed_ooo_buffer {
47 	struct list_head list_entry;
48 	void *rx_buffer_virt_addr;
49 	dma_addr_t rx_buffer_phys_addr;
50 	u32 rx_buffer_size;
51 	u16 packet_length;
52 	u16 parse_flags;
53 	u16 vlan;
54 	u8 placement_offset;
55 };
56 
57 struct qed_ooo_isle {
58 	struct list_head list_entry;
59 	struct list_head buffers_list;
60 };
61 
62 struct qed_ooo_archipelago {
63 	struct list_head isles_list;
64 };
65 
66 struct qed_ooo_history {
67 	struct ooo_opaque *p_cqes;
68 	u32 head_idx;
69 	u32 num_of_cqes;
70 };
71 
72 struct qed_ooo_info {
73 	struct list_head free_buffers_list;
74 	struct list_head ready_buffers_list;
75 	struct list_head free_isles_list;
76 	struct qed_ooo_archipelago *p_archipelagos_mem;
77 	struct qed_ooo_isle *p_isles_mem;
78 	struct qed_ooo_history ooo_history;
79 	u32 cur_isles_number;
80 	u32 max_isles_number;
81 	u32 gen_isles_number;
82 	u16 max_num_archipelagos;
83 	u16 cid_base;
84 };
85 
86 #if IS_ENABLED(CONFIG_QED_ISCSI)
87 void qed_ooo_save_history_entry(struct qed_hwfn *p_hwfn,
88 				struct qed_ooo_info *p_ooo_info,
89 				struct ooo_opaque *p_cqe);
90 
91 struct qed_ooo_info *qed_ooo_alloc(struct qed_hwfn *p_hwfn);
92 
93 void qed_ooo_release_connection_isles(struct qed_hwfn *p_hwfn,
94 				      struct qed_ooo_info *p_ooo_info,
95 				      u32 cid);
96 
97 void qed_ooo_release_all_isles(struct qed_hwfn *p_hwfn,
98 			       struct qed_ooo_info *p_ooo_info);
99 
100 void qed_ooo_setup(struct qed_hwfn *p_hwfn, struct qed_ooo_info *p_ooo_info);
101 
102 void qed_ooo_free(struct qed_hwfn *p_hwfn, struct qed_ooo_info *p_ooo_info);
103 
104 void qed_ooo_put_free_buffer(struct qed_hwfn *p_hwfn,
105 			     struct qed_ooo_info *p_ooo_info,
106 			     struct qed_ooo_buffer *p_buffer);
107 
108 struct qed_ooo_buffer *
109 qed_ooo_get_free_buffer(struct qed_hwfn *p_hwfn,
110 			struct qed_ooo_info *p_ooo_info);
111 
112 void qed_ooo_put_ready_buffer(struct qed_hwfn *p_hwfn,
113 			      struct qed_ooo_info *p_ooo_info,
114 			      struct qed_ooo_buffer *p_buffer, u8 on_tail);
115 
116 struct qed_ooo_buffer *
117 qed_ooo_get_ready_buffer(struct qed_hwfn *p_hwfn,
118 			 struct qed_ooo_info *p_ooo_info);
119 
120 void qed_ooo_delete_isles(struct qed_hwfn *p_hwfn,
121 			  struct qed_ooo_info *p_ooo_info,
122 			  u32 cid, u8 drop_isle, u8 drop_size);
123 
124 void qed_ooo_add_new_isle(struct qed_hwfn *p_hwfn,
125 			  struct qed_ooo_info *p_ooo_info,
126 			  u32 cid,
127 			  u8 ooo_isle, struct qed_ooo_buffer *p_buffer);
128 
129 void qed_ooo_add_new_buffer(struct qed_hwfn *p_hwfn,
130 			    struct qed_ooo_info *p_ooo_info,
131 			    u32 cid,
132 			    u8 ooo_isle,
133 			    struct qed_ooo_buffer *p_buffer, u8 buffer_side);
134 
135 void qed_ooo_join_isles(struct qed_hwfn *p_hwfn,
136 			struct qed_ooo_info *p_ooo_info, u32 cid,
137 			u8 left_isle);
138 #else /* IS_ENABLED(CONFIG_QED_ISCSI) */
139 static inline void qed_ooo_save_history_entry(struct qed_hwfn *p_hwfn,
140 					      struct qed_ooo_info *p_ooo_info,
141 					      struct ooo_opaque *p_cqe) {}
142 
143 static inline struct qed_ooo_info *qed_ooo_alloc(
144 				struct qed_hwfn *p_hwfn) { return NULL; }
145 
146 static inline void
147 qed_ooo_release_connection_isles(struct qed_hwfn *p_hwfn,
148 				 struct qed_ooo_info *p_ooo_info,
149 				 u32 cid) {}
150 
151 static inline void qed_ooo_release_all_isles(struct qed_hwfn *p_hwfn,
152 					     struct qed_ooo_info *p_ooo_info)
153 					     {}
154 
155 static inline void qed_ooo_setup(struct qed_hwfn *p_hwfn,
156 				 struct qed_ooo_info *p_ooo_info) {}
157 
158 static inline void qed_ooo_free(struct qed_hwfn *p_hwfn,
159 				struct qed_ooo_info *p_ooo_info) {}
160 
161 static inline void qed_ooo_put_free_buffer(struct qed_hwfn *p_hwfn,
162 					   struct qed_ooo_info *p_ooo_info,
163 					   struct qed_ooo_buffer *p_buffer) {}
164 
165 static inline struct qed_ooo_buffer *
166 qed_ooo_get_free_buffer(struct qed_hwfn *p_hwfn,
167 			struct qed_ooo_info *p_ooo_info) { return NULL; }
168 
169 static inline void qed_ooo_put_ready_buffer(struct qed_hwfn *p_hwfn,
170 					    struct qed_ooo_info *p_ooo_info,
171 					    struct qed_ooo_buffer *p_buffer,
172 					    u8 on_tail) {}
173 
174 static inline struct qed_ooo_buffer *
175 qed_ooo_get_ready_buffer(struct qed_hwfn *p_hwfn,
176 			 struct qed_ooo_info *p_ooo_info) { return NULL; }
177 
178 static inline void qed_ooo_delete_isles(struct qed_hwfn *p_hwfn,
179 					struct qed_ooo_info *p_ooo_info,
180 					u32 cid, u8 drop_isle, u8 drop_size) {}
181 
182 static inline void qed_ooo_add_new_isle(struct qed_hwfn *p_hwfn,
183 					struct qed_ooo_info *p_ooo_info,
184 					u32 cid, u8 ooo_isle,
185 					struct qed_ooo_buffer *p_buffer) {}
186 
187 static inline void qed_ooo_add_new_buffer(struct qed_hwfn *p_hwfn,
188 					  struct qed_ooo_info *p_ooo_info,
189 					  u32 cid, u8 ooo_isle,
190 					  struct qed_ooo_buffer *p_buffer,
191 					  u8 buffer_side) {}
192 
193 static inline void qed_ooo_join_isles(struct qed_hwfn *p_hwfn,
194 				      struct qed_ooo_info *p_ooo_info, u32 cid,
195 				      u8 left_isle) {}
196 #endif /* IS_ENABLED(CONFIG_QED_ISCSI) */
197 
198 #endif
199