Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
a53c8fab | 2 | * Copyright IBM Corp. 2000, 2008 |
1da177e4 | 3 | * Author(s): Utz Bacher <utz.bacher@de.ibm.com> |
779e6e1c | 4 | * Jan Glauber <jang@linux.vnet.ibm.com> |
1da177e4 LT |
5 | * |
6 | */ | |
7 | #ifndef __QDIO_H__ | |
8 | #define __QDIO_H__ | |
9 | ||
1da177e4 LT |
10 | #include <linux/interrupt.h> |
11 | #include <asm/cio.h> | |
12 | #include <asm/ccwdev.h> | |
13 | ||
432ac5e0 JG |
14 | /* only use 4 queues to save some cachelines */ |
15 | #define QDIO_MAX_QUEUES_PER_IRQ 4 | |
779e6e1c JG |
16 | #define QDIO_MAX_BUFFERS_PER_Q 128 |
17 | #define QDIO_MAX_BUFFERS_MASK (QDIO_MAX_BUFFERS_PER_Q - 1) | |
18 | #define QDIO_MAX_ELEMENTS_PER_BUFFER 16 | |
19 | #define QDIO_SBAL_SIZE 256 | |
20 | ||
21 | #define QDIO_QETH_QFMT 0 | |
22 | #define QDIO_ZFCP_QFMT 1 | |
23 | #define QDIO_IQDIO_QFMT 2 | |
24 | ||
25 | /** | |
26 | * struct qdesfmt0 - queue descriptor, format 0 | |
27 | * @sliba: storage list information block address | |
28 | * @sla: storage list address | |
29 | * @slsba: storage list state block address | |
30 | * @akey: access key for DLIB | |
31 | * @bkey: access key for SL | |
32 | * @ckey: access key for SBALs | |
33 | * @dkey: access key for SLSB | |
34 | */ | |
1da177e4 | 35 | struct qdesfmt0 { |
779e6e1c JG |
36 | u64 sliba; |
37 | u64 sla; | |
38 | u64 slsba; | |
39 | u32 : 32; | |
40 | u32 akey : 4; | |
41 | u32 bkey : 4; | |
42 | u32 ckey : 4; | |
43 | u32 dkey : 4; | |
44 | u32 : 16; | |
1da177e4 LT |
45 | } __attribute__ ((packed)); |
46 | ||
dfe5bb50 SS |
47 | #define QDR_AC_MULTI_BUFFER_ENABLE 0x01 |
48 | ||
779e6e1c JG |
49 | /** |
50 | * struct qdr - queue description record (QDR) | |
51 | * @qfmt: queue format | |
52 | * @pfmt: implementation dependent parameter format | |
53 | * @ac: adapter characteristics | |
54 | * @iqdcnt: input queue descriptor count | |
55 | * @oqdcnt: output queue descriptor count | |
56 | * @iqdsz: inpout queue descriptor size | |
57 | * @oqdsz: output queue descriptor size | |
58 | * @qiba: queue information block address | |
59 | * @qkey: queue information block key | |
60 | * @qdf0: queue descriptions | |
1da177e4 LT |
61 | */ |
62 | struct qdr { | |
779e6e1c JG |
63 | u32 qfmt : 8; |
64 | u32 pfmt : 8; | |
65 | u32 : 8; | |
66 | u32 ac : 8; | |
67 | u32 : 8; | |
68 | u32 iqdcnt : 8; | |
69 | u32 : 8; | |
70 | u32 oqdcnt : 8; | |
71 | u32 : 8; | |
72 | u32 iqdsz : 8; | |
73 | u32 : 8; | |
74 | u32 oqdsz : 8; | |
75 | /* private: */ | |
76 | u32 res[9]; | |
77 | /* public: */ | |
78 | u64 qiba; | |
79 | u32 : 32; | |
80 | u32 qkey : 4; | |
81 | u32 : 28; | |
82 | struct qdesfmt0 qdf0[126]; | |
f1c1174f | 83 | } __packed __aligned(PAGE_SIZE); |
779e6e1c JG |
84 | |
85 | #define QIB_AC_OUTBOUND_PCI_SUPPORTED 0x40 | |
8129ee16 | 86 | #define QIB_RFLAGS_ENABLE_QEBSM 0x80 |
dcc18f48 | 87 | #define QIB_RFLAGS_ENABLE_DATA_DIV 0x02 |
8129ee16 | 88 | |
779e6e1c JG |
89 | /** |
90 | * struct qib - queue information block (QIB) | |
91 | * @qfmt: queue format | |
92 | * @pfmt: implementation dependent parameter format | |
93 | * @rflags: QEBSM | |
94 | * @ac: adapter characteristics | |
95 | * @isliba: absolute address of first input SLIB | |
96 | * @osliba: absolute address of first output SLIB | |
97 | * @ebcnam: adapter identifier in EBCDIC | |
98 | * @parm: implementation dependent parameters | |
99 | */ | |
1da177e4 | 100 | struct qib { |
779e6e1c JG |
101 | u32 qfmt : 8; |
102 | u32 pfmt : 8; | |
103 | u32 rflags : 8; | |
104 | u32 ac : 8; | |
105 | u32 : 32; | |
106 | u64 isliba; | |
107 | u64 osliba; | |
108 | u32 : 32; | |
109 | u32 : 32; | |
110 | u8 ebcnam[8]; | |
111 | /* private: */ | |
112 | u8 res[88]; | |
113 | /* public: */ | |
114 | u8 parm[QDIO_MAX_BUFFERS_PER_Q]; | |
115 | } __attribute__ ((packed, aligned(256))); | |
116 | ||
117 | /** | |
118 | * struct slibe - storage list information block element (SLIBE) | |
119 | * @parms: implementation dependent parameters | |
1da177e4 LT |
120 | */ |
121 | struct slibe { | |
779e6e1c | 122 | u64 parms; |
1da177e4 LT |
123 | }; |
124 | ||
104ea556 | 125 | /** |
126 | * struct qaob - queue asynchronous operation block | |
127 | * @res0: reserved parameters | |
128 | * @res1: reserved parameter | |
129 | * @res2: reserved parameter | |
130 | * @res3: reserved parameter | |
131 | * @aorc: asynchronous operation return code | |
132 | * @flags: internal flags | |
133 | * @cbtbs: control block type | |
134 | * @sb_count: number of storage blocks | |
135 | * @sba: storage block element addresses | |
136 | * @dcount: size of storage block elements | |
137 | * @user0: user defineable value | |
138 | * @res4: reserved paramater | |
139 | * @user1: user defineable value | |
140 | * @user2: user defineable value | |
141 | */ | |
142 | struct qaob { | |
143 | u64 res0[6]; | |
144 | u8 res1; | |
145 | u8 res2; | |
146 | u8 res3; | |
147 | u8 aorc; | |
148 | u8 flags; | |
149 | u16 cbtbs; | |
150 | u8 sb_count; | |
151 | u64 sba[QDIO_MAX_ELEMENTS_PER_BUFFER]; | |
152 | u16 dcount[QDIO_MAX_ELEMENTS_PER_BUFFER]; | |
153 | u64 user0; | |
154 | u64 res4[2]; | |
155 | u64 user1; | |
156 | u64 user2; | |
157 | } __attribute__ ((packed, aligned(256))); | |
158 | ||
779e6e1c JG |
159 | /** |
160 | * struct slib - storage list information block (SLIB) | |
161 | * @nsliba: next SLIB address (if any) | |
162 | * @sla: SL address | |
163 | * @slsba: SLSB address | |
164 | * @slibe: SLIB elements | |
1da177e4 LT |
165 | */ |
166 | struct slib { | |
779e6e1c JG |
167 | u64 nsliba; |
168 | u64 sla; | |
169 | u64 slsba; | |
170 | /* private: */ | |
171 | u8 res[1000]; | |
172 | /* public: */ | |
173 | struct slibe slibe[QDIO_MAX_BUFFERS_PER_Q]; | |
174 | } __attribute__ ((packed, aligned(2048))); | |
175 | ||
3ec90878 JG |
176 | #define SBAL_EFLAGS_LAST_ENTRY 0x40 |
177 | #define SBAL_EFLAGS_CONTIGUOUS 0x20 | |
178 | #define SBAL_EFLAGS_FIRST_FRAG 0x04 | |
179 | #define SBAL_EFLAGS_MIDDLE_FRAG 0x08 | |
180 | #define SBAL_EFLAGS_LAST_FRAG 0x0c | |
181 | #define SBAL_EFLAGS_MASK 0x6f | |
1da177e4 | 182 | |
3ec90878 JG |
183 | #define SBAL_SFLAGS0_PCI_REQ 0x40 |
184 | #define SBAL_SFLAGS0_DATA_CONTINUATION 0x20 | |
1da177e4 LT |
185 | |
186 | /* Awesome OpenFCP extensions */ | |
3ec90878 JG |
187 | #define SBAL_SFLAGS0_TYPE_STATUS 0x00 |
188 | #define SBAL_SFLAGS0_TYPE_WRITE 0x08 | |
189 | #define SBAL_SFLAGS0_TYPE_READ 0x10 | |
190 | #define SBAL_SFLAGS0_TYPE_WRITE_READ 0x18 | |
191 | #define SBAL_SFLAGS0_MORE_SBALS 0x04 | |
192 | #define SBAL_SFLAGS0_COMMAND 0x02 | |
193 | #define SBAL_SFLAGS0_LAST_SBAL 0x00 | |
194 | #define SBAL_SFLAGS0_ONLY_SBAL SBAL_SFLAGS0_COMMAND | |
195 | #define SBAL_SFLAGS0_MIDDLE_SBAL SBAL_SFLAGS0_MORE_SBALS | |
196 | #define SBAL_SFLAGS0_FIRST_SBAL (SBAL_SFLAGS0_MORE_SBALS | SBAL_SFLAGS0_COMMAND) | |
1da177e4 | 197 | |
779e6e1c JG |
198 | /** |
199 | * struct qdio_buffer_element - SBAL entry | |
3ec90878 JG |
200 | * @eflags: SBAL entry flags |
201 | * @scount: SBAL count | |
202 | * @sflags: whole SBAL flags | |
779e6e1c JG |
203 | * @length: length |
204 | * @addr: address | |
205 | */ | |
206 | struct qdio_buffer_element { | |
3ec90878 JG |
207 | u8 eflags; |
208 | /* private: */ | |
209 | u8 res1; | |
210 | /* public: */ | |
211 | u8 scount; | |
212 | u8 sflags; | |
779e6e1c | 213 | u32 length; |
779e6e1c JG |
214 | void *addr; |
215 | } __attribute__ ((packed, aligned(16))); | |
1da177e4 | 216 | |
779e6e1c JG |
217 | /** |
218 | * struct qdio_buffer - storage block address list (SBAL) | |
219 | * @element: SBAL entries | |
1da177e4 | 220 | */ |
779e6e1c JG |
221 | struct qdio_buffer { |
222 | struct qdio_buffer_element element[QDIO_MAX_ELEMENTS_PER_BUFFER]; | |
223 | } __attribute__ ((packed, aligned(256))); | |
1da177e4 | 224 | |
779e6e1c JG |
225 | /** |
226 | * struct sl_element - storage list entry | |
227 | * @sbal: absolute SBAL address | |
1da177e4 LT |
228 | */ |
229 | struct sl_element { | |
779e6e1c | 230 | unsigned long sbal; |
1da177e4 LT |
231 | } __attribute__ ((packed)); |
232 | ||
779e6e1c JG |
233 | /** |
234 | * struct sl - storage list (SL) | |
235 | * @element: SL entries | |
236 | */ | |
1da177e4 LT |
237 | struct sl { |
238 | struct sl_element element[QDIO_MAX_BUFFERS_PER_Q]; | |
779e6e1c | 239 | } __attribute__ ((packed, aligned(1024))); |
1da177e4 | 240 | |
779e6e1c JG |
241 | /** |
242 | * struct slsb - storage list state block (SLSB) | |
243 | * @val: state per buffer | |
1da177e4 | 244 | */ |
779e6e1c JG |
245 | struct slsb { |
246 | u8 val[QDIO_MAX_BUFFERS_PER_Q]; | |
247 | } __attribute__ ((packed, aligned(256))); | |
248 | ||
104ea556 | 249 | /** |
250 | * struct qdio_outbuf_state - SBAL related asynchronous operation information | |
251 | * (for communication with upper layer programs) | |
252 | * (only required for use with completion queues) | |
253 | * @flags: flags indicating state of buffer | |
254 | * @aob: pointer to QAOB used for the particular SBAL | |
255 | * @user: pointer to upper layer program's state information related to SBAL | |
256 | * (stored in user1 data of QAOB) | |
257 | */ | |
258 | struct qdio_outbuf_state { | |
259 | u8 flags; | |
260 | struct qaob *aob; | |
261 | void *user; | |
262 | }; | |
263 | ||
264 | #define QDIO_OUTBUF_STATE_FLAG_NONE 0x00 | |
265 | #define QDIO_OUTBUF_STATE_FLAG_PENDING 0x01 | |
266 | ||
267 | #define CHSC_AC1_INITIATE_INPUTQ 0x80 | |
268 | ||
9cb7284f | 269 | |
270 | /* qdio adapter-characteristics-1 flag */ | |
271 | #define AC1_SIGA_INPUT_NEEDED 0x40 /* process input queues */ | |
272 | #define AC1_SIGA_OUTPUT_NEEDED 0x20 /* process output queues */ | |
273 | #define AC1_SIGA_SYNC_NEEDED 0x10 /* ask hypervisor to sync */ | |
274 | #define AC1_AUTOMATIC_SYNC_ON_THININT 0x08 /* set by hypervisor */ | |
275 | #define AC1_AUTOMATIC_SYNC_ON_OUT_PCI 0x04 /* set by hypervisor */ | |
276 | #define AC1_SC_QEBSM_AVAILABLE 0x02 /* available for subchannel */ | |
277 | #define AC1_SC_QEBSM_ENABLED 0x01 /* enabled for subchannel */ | |
278 | ||
050276ab SM |
279 | #define CHSC_AC2_MULTI_BUFFER_AVAILABLE 0x0080 |
280 | #define CHSC_AC2_MULTI_BUFFER_ENABLED 0x0040 | |
104ea556 | 281 | #define CHSC_AC2_DATA_DIV_AVAILABLE 0x0010 |
282 | #define CHSC_AC2_DATA_DIV_ENABLED 0x0002 | |
283 | ||
284 | #define CHSC_AC3_FORMAT2_CQ_AVAILABLE 0x8000 | |
285 | ||
779e6e1c JG |
286 | struct qdio_ssqd_desc { |
287 | u8 flags; | |
288 | u8:8; | |
289 | u16 sch; | |
290 | u8 qfmt; | |
291 | u8 parm; | |
292 | u8 qdioac1; | |
293 | u8 sch_class; | |
294 | u8 pcnt; | |
295 | u8 icnt; | |
296 | u8:8; | |
297 | u8 ocnt; | |
298 | u8:8; | |
299 | u8 mbccnt; | |
300 | u16 qdioac2; | |
301 | u64 sch_token; | |
7a0f4755 KDW |
302 | u8 mro; |
303 | u8 mri; | |
104ea556 | 304 | u16 qdioac3; |
7a0f4755 KDW |
305 | u16:16; |
306 | u8:8; | |
307 | u8 mmwc; | |
1da177e4 LT |
308 | } __attribute__ ((packed)); |
309 | ||
779e6e1c JG |
310 | /* params are: ccw_device, qdio_error, queue_number, |
311 | first element processed, number of elements processed, int_parm */ | |
312 | typedef void qdio_handler_t(struct ccw_device *, unsigned int, int, | |
313 | int, int, unsigned long); | |
1da177e4 | 314 | |
779e6e1c | 315 | /* qdio errors reported to the upper-layer program */ |
1549d13f JG |
316 | #define QDIO_ERROR_ACTIVATE 0x0001 |
317 | #define QDIO_ERROR_GET_BUF_STATE 0x0002 | |
318 | #define QDIO_ERROR_SET_BUF_STATE 0x0004 | |
319 | #define QDIO_ERROR_SLSB_STATE 0x0100 | |
320 | ||
321 | #define QDIO_ERROR_FATAL 0x00ff | |
322 | #define QDIO_ERROR_TEMPORARY 0xff00 | |
1da177e4 | 323 | |
779e6e1c JG |
324 | /* for qdio_cleanup */ |
325 | #define QDIO_FLAG_CLEANUP_USING_CLEAR 0x01 | |
326 | #define QDIO_FLAG_CLEANUP_USING_HALT 0x02 | |
327 | ||
328 | /** | |
b4a96015 | 329 | * struct qdio_initialize - qdio initialization data |
779e6e1c JG |
330 | * @cdev: associated ccw device |
331 | * @q_format: queue format | |
332 | * @adapter_name: name for the adapter | |
333 | * @qib_param_field_format: format for qib_parm_field | |
334 | * @qib_param_field: pointer to 128 bytes or NULL, if no param field | |
dcc18f48 | 335 | * @qib_rflags: rflags to set |
779e6e1c JG |
336 | * @input_slib_elements: pointer to no_input_qs * 128 words of data or NULL |
337 | * @output_slib_elements: pointer to no_output_qs * 128 words of data or NULL | |
338 | * @no_input_qs: number of input queues | |
339 | * @no_output_qs: number of output queues | |
340 | * @input_handler: handler to be called for input queues | |
341 | * @output_handler: handler to be called for output queues | |
e58b0d90 | 342 | * @queue_start_poll_array: polling handlers (one per input queue or NULL) |
779e6e1c | 343 | * @int_parm: interruption parameter |
779e6e1c JG |
344 | * @input_sbal_addr_array: address of no_input_qs * 128 pointers |
345 | * @output_sbal_addr_array: address of no_output_qs * 128 pointers | |
104ea556 | 346 | * @output_sbal_state_array: no_output_qs * 128 state info (for CQ or NULL) |
1da177e4 | 347 | */ |
779e6e1c JG |
348 | struct qdio_initialize { |
349 | struct ccw_device *cdev; | |
350 | unsigned char q_format; | |
dfe5bb50 | 351 | unsigned char qdr_ac; |
779e6e1c JG |
352 | unsigned char adapter_name[8]; |
353 | unsigned int qib_param_field_format; | |
354 | unsigned char *qib_param_field; | |
dcc18f48 | 355 | unsigned char qib_rflags; |
779e6e1c JG |
356 | unsigned long *input_slib_elements; |
357 | unsigned long *output_slib_elements; | |
358 | unsigned int no_input_qs; | |
359 | unsigned int no_output_qs; | |
360 | qdio_handler_t *input_handler; | |
361 | qdio_handler_t *output_handler; | |
e58b0d90 SM |
362 | void (**queue_start_poll_array) (struct ccw_device *, int, |
363 | unsigned long); | |
3d6c76ff | 364 | int scan_threshold; |
779e6e1c | 365 | unsigned long int_parm; |
779e6e1c JG |
366 | void **input_sbal_addr_array; |
367 | void **output_sbal_addr_array; | |
104ea556 | 368 | struct qdio_outbuf_state *output_sbal_state_array; |
779e6e1c JG |
369 | }; |
370 | ||
1c59a861 EC |
371 | /** |
372 | * enum qdio_brinfo_entry_type - type of address entry for qdio_brinfo_desc() | |
373 | * @l3_ipv6_addr: entry contains IPv6 address | |
374 | * @l3_ipv4_addr: entry contains IPv4 address | |
375 | * @l2_addr_lnid: entry contains MAC address and VLAN ID | |
376 | */ | |
377 | enum qdio_brinfo_entry_type {l3_ipv6_addr, l3_ipv4_addr, l2_addr_lnid}; | |
378 | ||
379 | /** | |
380 | * struct qdio_brinfo_entry_XXX - Address entry for qdio_brinfo_desc() | |
381 | * @nit: Network interface token | |
382 | * @addr: Address of one of the three types | |
383 | * | |
384 | * The struct is passed to the callback function by qdio_brinfo_desc() | |
385 | */ | |
386 | struct qdio_brinfo_entry_l3_ipv6 { | |
387 | u64 nit; | |
388 | struct { unsigned char _s6_addr[16]; } addr; | |
389 | } __packed; | |
390 | struct qdio_brinfo_entry_l3_ipv4 { | |
391 | u64 nit; | |
392 | struct { uint32_t _s_addr; } addr; | |
393 | } __packed; | |
394 | struct qdio_brinfo_entry_l2 { | |
395 | u64 nit; | |
396 | struct { u8 mac[6]; u16 lnid; } addr_lnid; | |
397 | } __packed; | |
398 | ||
779e6e1c JG |
399 | #define QDIO_STATE_INACTIVE 0x00000002 /* after qdio_cleanup */ |
400 | #define QDIO_STATE_ESTABLISHED 0x00000004 /* after qdio_establish */ | |
401 | #define QDIO_STATE_ACTIVE 0x00000008 /* after qdio_activate */ | |
402 | #define QDIO_STATE_STOPPED 0x00000010 /* after queues went down */ | |
403 | ||
404 | #define QDIO_FLAG_SYNC_INPUT 0x01 | |
405 | #define QDIO_FLAG_SYNC_OUTPUT 0x02 | |
406 | #define QDIO_FLAG_PCI_OUT 0x10 | |
407 | ||
5245c924 SO |
408 | int qdio_alloc_buffers(struct qdio_buffer **buf, unsigned int count); |
409 | void qdio_free_buffers(struct qdio_buffer **buf, unsigned int count); | |
410 | void qdio_reset_buffers(struct qdio_buffer **buf, unsigned int count); | |
411 | ||
bbd50e17 JG |
412 | extern int qdio_allocate(struct qdio_initialize *); |
413 | extern int qdio_establish(struct qdio_initialize *); | |
779e6e1c | 414 | extern int qdio_activate(struct ccw_device *); |
104ea556 | 415 | extern void qdio_release_aob(struct qaob *); |
d36deae7 JG |
416 | extern int do_QDIO(struct ccw_device *, unsigned int, int, unsigned int, |
417 | unsigned int); | |
418 | extern int qdio_start_irq(struct ccw_device *, int); | |
419 | extern int qdio_stop_irq(struct ccw_device *, int); | |
420 | extern int qdio_get_next_buffers(struct ccw_device *, int, int *, int *); | |
421 | extern int qdio_shutdown(struct ccw_device *, int); | |
779e6e1c | 422 | extern int qdio_free(struct ccw_device *); |
d36deae7 | 423 | extern int qdio_get_ssqd_desc(struct ccw_device *, struct qdio_ssqd_desc *); |
1c59a861 EC |
424 | extern int qdio_pnso_brinfo(struct subchannel_id schid, |
425 | int cnc, u16 *response, | |
426 | void (*cb)(void *priv, enum qdio_brinfo_entry_type type, | |
427 | void *entry), | |
428 | void *priv); | |
1da177e4 LT |
429 | |
430 | #endif /* __QDIO_H__ */ |