1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright IBM Corp. 2000, 2008
4 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
5 * Jan Glauber <jang@linux.vnet.ibm.com>
11 #include <linux/interrupt.h>
13 #include <asm/ccwdev.h>
15 /* only use 4 queues to save some cachelines */
16 #define QDIO_MAX_QUEUES_PER_IRQ 4
17 #define QDIO_MAX_BUFFERS_PER_Q 128
18 #define QDIO_MAX_BUFFERS_MASK (QDIO_MAX_BUFFERS_PER_Q - 1)
19 #define QDIO_BUFNR(num) ((num) & QDIO_MAX_BUFFERS_MASK)
20 #define QDIO_MAX_ELEMENTS_PER_BUFFER 16
21 #define QDIO_SBAL_SIZE 256
23 #define QDIO_QETH_QFMT 0
24 #define QDIO_ZFCP_QFMT 1
25 #define QDIO_IQDIO_QFMT 2
28 * struct qdesfmt0 - queue descriptor, format 0
29 * @sliba: absolute address of storage list information block
30 * @sla: absolute address of storage list
31 * @slsba: absolute address of storage list state block
32 * @akey: access key for SLIB
33 * @bkey: access key for SL
34 * @ckey: access key for SBALs
35 * @dkey: access key for SLSB
47 } __attribute__ ((packed));
49 #define QDR_AC_MULTI_BUFFER_ENABLE 0x01
52 * struct qdr - queue description record (QDR)
54 * @ac: adapter characteristics
55 * @iqdcnt: input queue descriptor count
56 * @oqdcnt: output queue descriptor count
57 * @iqdsz: input queue descriptor size
58 * @oqdsz: output queue descriptor size
59 * @qiba: absolute address of queue information block
60 * @qkey: queue information block key
61 * @qdf0: queue descriptions
82 struct qdesfmt0 qdf0[126];
83 } __packed __aligned(PAGE_SIZE);
85 #define QIB_AC_OUTBOUND_PCI_SUPPORTED 0x40
86 #define QIB_RFLAGS_ENABLE_QEBSM 0x80
87 #define QIB_RFLAGS_ENABLE_DATA_DIV 0x02
90 * struct qib - queue information block (QIB)
92 * @pfmt: implementation dependent parameter format
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
115 } __attribute__ ((packed, aligned(256)));
118 * struct slibe - storage list information block element (SLIBE)
119 * @parms: implementation dependent parameters
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
150 u64 sba[QDIO_MAX_ELEMENTS_PER_BUFFER];
151 u16 dcount[QDIO_MAX_ELEMENTS_PER_BUFFER];
155 } __attribute__ ((packed, aligned(256)));
158 * struct slib - storage list information block (SLIB)
159 * @nsliba: next SLIB address (if any)
161 * @slsba: SLSB address
162 * @slibe: SLIB elements
171 struct slibe slibe[QDIO_MAX_BUFFERS_PER_Q];
172 } __attribute__ ((packed, aligned(2048)));
174 #define SBAL_EFLAGS_LAST_ENTRY 0x40
175 #define SBAL_EFLAGS_CONTIGUOUS 0x20
176 #define SBAL_EFLAGS_FIRST_FRAG 0x04
177 #define SBAL_EFLAGS_MIDDLE_FRAG 0x08
178 #define SBAL_EFLAGS_LAST_FRAG 0x0c
179 #define SBAL_EFLAGS_MASK 0x6f
181 #define SBAL_SFLAGS0_PCI_REQ 0x40
182 #define SBAL_SFLAGS0_DATA_CONTINUATION 0x20
184 /* Awesome OpenFCP extensions */
185 #define SBAL_SFLAGS0_TYPE_STATUS 0x00
186 #define SBAL_SFLAGS0_TYPE_WRITE 0x08
187 #define SBAL_SFLAGS0_TYPE_READ 0x10
188 #define SBAL_SFLAGS0_TYPE_WRITE_READ 0x18
189 #define SBAL_SFLAGS0_MORE_SBALS 0x04
190 #define SBAL_SFLAGS0_COMMAND 0x02
191 #define SBAL_SFLAGS0_LAST_SBAL 0x00
192 #define SBAL_SFLAGS0_ONLY_SBAL SBAL_SFLAGS0_COMMAND
193 #define SBAL_SFLAGS0_MIDDLE_SBAL SBAL_SFLAGS0_MORE_SBALS
194 #define SBAL_SFLAGS0_FIRST_SBAL (SBAL_SFLAGS0_MORE_SBALS | SBAL_SFLAGS0_COMMAND)
197 * struct qdio_buffer_element - SBAL entry
198 * @eflags: SBAL entry flags
199 * @scount: SBAL count
200 * @sflags: whole SBAL flags
202 * @addr: absolute data address
204 struct qdio_buffer_element {
213 } __attribute__ ((packed, aligned(16)));
216 * struct qdio_buffer - storage block address list (SBAL)
217 * @element: SBAL entries
220 struct qdio_buffer_element element[QDIO_MAX_ELEMENTS_PER_BUFFER];
221 } __attribute__ ((packed, aligned(256)));
224 * struct sl_element - storage list entry
225 * @sbal: absolute SBAL address
229 } __attribute__ ((packed));
232 * struct sl - storage list (SL)
233 * @element: SL entries
236 struct sl_element element[QDIO_MAX_BUFFERS_PER_Q];
237 } __attribute__ ((packed, aligned(1024)));
240 * struct slsb - storage list state block (SLSB)
241 * @val: state per buffer
244 u8 val[QDIO_MAX_BUFFERS_PER_Q];
245 } __attribute__ ((packed, aligned(256)));
247 /* qdio adapter-characteristics-1 flag */
248 #define CHSC_AC1_INITIATE_INPUTQ 0x80
249 #define AC1_SIGA_INPUT_NEEDED 0x40 /* process input queues */
250 #define AC1_SIGA_OUTPUT_NEEDED 0x20 /* process output queues */
251 #define AC1_SIGA_SYNC_NEEDED 0x10 /* ask hypervisor to sync */
252 #define AC1_AUTOMATIC_SYNC_ON_THININT 0x08 /* set by hypervisor */
253 #define AC1_AUTOMATIC_SYNC_ON_OUT_PCI 0x04 /* set by hypervisor */
254 #define AC1_SC_QEBSM_AVAILABLE 0x02 /* available for subchannel */
255 #define AC1_SC_QEBSM_ENABLED 0x01 /* enabled for subchannel */
257 #define CHSC_AC2_MULTI_BUFFER_AVAILABLE 0x0080
258 #define CHSC_AC2_MULTI_BUFFER_ENABLED 0x0040
259 #define CHSC_AC2_DATA_DIV_AVAILABLE 0x0010
260 #define CHSC_AC2_SNIFFER_AVAILABLE 0x0008
261 #define CHSC_AC2_DATA_DIV_ENABLED 0x0002
263 #define CHSC_AC3_FORMAT2_CQ_AVAILABLE 0x8000
265 struct qdio_ssqd_desc {
287 } __attribute__ ((packed));
289 /* params are: ccw_device, qdio_error, queue_number,
290 first element processed, number of elements processed, int_parm */
291 typedef void qdio_handler_t(struct ccw_device *, unsigned int, int,
292 int, int, unsigned long);
294 /* qdio errors reported through the queue handlers: */
295 #define QDIO_ERROR_ACTIVATE 0x0001
296 #define QDIO_ERROR_GET_BUF_STATE 0x0002
297 #define QDIO_ERROR_SET_BUF_STATE 0x0004
299 /* extra info for completed SBALs: */
300 #define QDIO_ERROR_SLSB_STATE 0x0100
301 #define QDIO_ERROR_SLSB_PENDING 0x0200
303 /* for qdio_cleanup */
304 #define QDIO_FLAG_CLEANUP_USING_CLEAR 0x01
305 #define QDIO_FLAG_CLEANUP_USING_HALT 0x02
308 * struct qdio_initialize - qdio initialization data
309 * @q_format: queue format
310 * @qdr_ac: feature flags to set
311 * @qib_param_field_format: format for qib_parm_field
312 * @qib_param_field: pointer to 128 bytes or NULL, if no param field
313 * @qib_rflags: rflags to set
314 * @input_slib_elements: pointer to no_input_qs * 128 words of data or NULL
315 * @output_slib_elements: pointer to no_output_qs * 128 words of data or NULL
316 * @no_input_qs: number of input queues
317 * @no_output_qs: number of output queues
318 * @input_handler: handler to be called for input queues
319 * @output_handler: handler to be called for output queues
320 * @irq_poll: Data IRQ polling handler
321 * @scan_threshold: # of in-use buffers that triggers scan on output queue
322 * @int_parm: interruption parameter
323 * @input_sbal_addr_array: per-queue array, each element points to 128 SBALs
324 * @output_sbal_addr_array: per-queue array, each element points to 128 SBALs
326 struct qdio_initialize {
327 unsigned char q_format;
328 unsigned char qdr_ac;
329 unsigned int qib_param_field_format;
330 unsigned char *qib_param_field;
331 unsigned char qib_rflags;
332 unsigned long *input_slib_elements;
333 unsigned long *output_slib_elements;
334 unsigned int no_input_qs;
335 unsigned int no_output_qs;
336 qdio_handler_t *input_handler;
337 qdio_handler_t *output_handler;
338 void (*irq_poll)(struct ccw_device *cdev, unsigned long data);
339 unsigned long int_parm;
340 struct qdio_buffer ***input_sbal_addr_array;
341 struct qdio_buffer ***output_sbal_addr_array;
344 #define QDIO_STATE_INACTIVE 0x00000002 /* after qdio_cleanup */
345 #define QDIO_STATE_ESTABLISHED 0x00000004 /* after qdio_establish */
346 #define QDIO_STATE_ACTIVE 0x00000008 /* after qdio_activate */
347 #define QDIO_STATE_STOPPED 0x00000010 /* after queues went down */
349 #define QDIO_FLAG_SYNC_INPUT 0x01
350 #define QDIO_FLAG_SYNC_OUTPUT 0x02
352 int qdio_alloc_buffers(struct qdio_buffer **buf, unsigned int count);
353 void qdio_free_buffers(struct qdio_buffer **buf, unsigned int count);
354 void qdio_reset_buffers(struct qdio_buffer **buf, unsigned int count);
356 extern int qdio_allocate(struct ccw_device *cdev, unsigned int no_input_qs,
357 unsigned int no_output_qs);
358 extern int qdio_establish(struct ccw_device *cdev,
359 struct qdio_initialize *init_data);
360 extern int qdio_activate(struct ccw_device *);
361 extern struct qaob *qdio_allocate_aob(void);
362 extern void qdio_release_aob(struct qaob *);
363 extern int do_QDIO(struct ccw_device *cdev, unsigned int callflags, int q_nr,
364 unsigned int bufnr, unsigned int count, struct qaob *aob);
365 extern int qdio_start_irq(struct ccw_device *cdev);
366 extern int qdio_stop_irq(struct ccw_device *cdev);
367 extern int qdio_inspect_queue(struct ccw_device *cdev, unsigned int nr,
368 bool is_input, unsigned int *bufnr,
369 unsigned int *error);
370 extern int qdio_shutdown(struct ccw_device *, int);
371 extern int qdio_free(struct ccw_device *);
372 extern int qdio_get_ssqd_desc(struct ccw_device *, struct qdio_ssqd_desc *);
374 #endif /* __QDIO_H__ */