blob: 74db1dc10a7d60043a182333a5c815a3187a9000 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Uwe Zeisbergerf30c2262006-10-03 23:01:26 +02002 * linux/include/asm-s390/qdio.h
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Linux for S/390 QDIO base support, Hipersocket base support
5 * version 2
6 *
7 * Copyright 2000,2002 IBM Corporation
8 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
9 *
10 */
11#ifndef __QDIO_H__
12#define __QDIO_H__
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014/* note, that most of the typedef's are from ingo. */
15
16#include <linux/interrupt.h>
17#include <asm/cio.h>
18#include <asm/ccwdev.h>
19
20#define QDIO_NAME "qdio "
21
22#ifndef __s390x__
23#define QDIO_32_BIT
24#endif /* __s390x__ */
25
26/**** CONSTANTS, that are relied on without using these symbols *****/
27#define QDIO_MAX_QUEUES_PER_IRQ 32 /* used in width of unsigned int */
28/************************ END of CONSTANTS **************************/
29#define QDIO_MAX_BUFFERS_PER_Q 128 /* must be a power of 2 (%x=&(x-1)*/
30#define QDIO_BUF_ORDER 7 /* 2**this == number of pages used for sbals in 1 q */
31#define QDIO_MAX_ELEMENTS_PER_BUFFER 16
32#define SBAL_SIZE 256
33
34#define QDIO_QETH_QFMT 0
35#define QDIO_ZFCP_QFMT 1
36#define QDIO_IQDIO_QFMT 2
Ursula Braun028cf912006-12-15 17:18:14 +010037#define QDIO_IQDIO_QFMT_ASYNCH 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39struct qdio_buffer_element{
40 unsigned int flags;
41 unsigned int length;
42#ifdef QDIO_32_BIT
43 void *reserved;
44#endif /* QDIO_32_BIT */
45 void *addr;
46} __attribute__ ((packed,aligned(16)));
47
48struct qdio_buffer{
49 volatile struct qdio_buffer_element element[16];
50} __attribute__ ((packed,aligned(256)));
51
52
53/* params are: ccw_device, status, qdio_error, siga_error,
54 queue_number, first element processed, number of elements processed,
55 int_parm */
56typedef void qdio_handler_t(struct ccw_device *,unsigned int,unsigned int,
57 unsigned int,unsigned int,int,int,unsigned long);
58
59
60#define QDIO_STATUS_INBOUND_INT 0x01
61#define QDIO_STATUS_OUTBOUND_INT 0x02
62#define QDIO_STATUS_LOOK_FOR_ERROR 0x04
63#define QDIO_STATUS_MORE_THAN_ONE_QDIO_ERROR 0x08
64#define QDIO_STATUS_MORE_THAN_ONE_SIGA_ERROR 0x10
65#define QDIO_STATUS_ACTIVATE_CHECK_CONDITION 0x20
66
67#define QDIO_SIGA_ERROR_ACCESS_EXCEPTION 0x10
68#define QDIO_SIGA_ERROR_B_BIT_SET 0x20
69
70/* for qdio_initialize */
71#define QDIO_INBOUND_0COPY_SBALS 0x01
72#define QDIO_OUTBOUND_0COPY_SBALS 0x02
73#define QDIO_USE_OUTBOUND_PCIS 0x04
74
75/* for qdio_cleanup */
76#define QDIO_FLAG_CLEANUP_USING_CLEAR 0x01
77#define QDIO_FLAG_CLEANUP_USING_HALT 0x02
78
79struct qdio_initialize {
80 struct ccw_device *cdev;
81 unsigned char q_format;
82 unsigned char adapter_name[8];
83 unsigned int qib_param_field_format; /*adapter dependent*/
84 /* pointer to 128 bytes or NULL, if no param field */
85 unsigned char *qib_param_field; /* adapter dependent */
86 /* pointer to no_queues*128 words of data or NULL */
87 unsigned long *input_slib_elements;
88 unsigned long *output_slib_elements;
89 unsigned int min_input_threshold;
90 unsigned int max_input_threshold;
91 unsigned int min_output_threshold;
92 unsigned int max_output_threshold;
93 unsigned int no_input_qs;
94 unsigned int no_output_qs;
95 qdio_handler_t *input_handler;
96 qdio_handler_t *output_handler;
97 unsigned long int_parm;
98 unsigned long flags;
99 void **input_sbal_addr_array; /* addr of n*128 void ptrs */
100 void **output_sbal_addr_array; /* addr of n*128 void ptrs */
101};
102
103extern int qdio_initialize(struct qdio_initialize *init_data);
104extern int qdio_allocate(struct qdio_initialize *init_data);
105extern int qdio_establish(struct qdio_initialize *init_data);
106
107extern int qdio_activate(struct ccw_device *,int flags);
108
109#define QDIO_STATE_MUST_USE_OUTB_PCI 0x00000001
110#define QDIO_STATE_INACTIVE 0x00000002 /* after qdio_cleanup */
111#define QDIO_STATE_ESTABLISHED 0x00000004 /* after qdio_initialize */
112#define QDIO_STATE_ACTIVE 0x00000008 /* after qdio_activate */
113#define QDIO_STATE_STOPPED 0x00000010 /* after queues went down */
114extern unsigned long qdio_get_status(int irq);
115
116
117#define QDIO_FLAG_SYNC_INPUT 0x01
118#define QDIO_FLAG_SYNC_OUTPUT 0x02
119#define QDIO_FLAG_UNDER_INTERRUPT 0x04
120#define QDIO_FLAG_NO_INPUT_INTERRUPT_CONTEXT 0x08 /* no effect on
121 adapter interrupts */
122#define QDIO_FLAG_DONT_SIGA 0x10
Ursula Braun1f8bdae2007-05-02 15:18:07 +0200123#define QDIO_FLAG_PCI_OUT 0x20
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125extern int do_QDIO(struct ccw_device*, unsigned int flags,
126 unsigned int queue_number,
127 unsigned int qidx,unsigned int count,
128 struct qdio_buffer *buffers);
129
130extern int qdio_synchronize(struct ccw_device*, unsigned int flags,
131 unsigned int queue_number);
132
133extern int qdio_cleanup(struct ccw_device*, int how);
134extern int qdio_shutdown(struct ccw_device*, int how);
135extern int qdio_free(struct ccw_device*);
136
137unsigned char qdio_get_slsb_state(struct ccw_device*, unsigned int flag,
138 unsigned int queue_number,
139 unsigned int qidx);
140
141extern void qdio_init_scrubber(void);
142
143struct qdesfmt0 {
144#ifdef QDIO_32_BIT
145 unsigned long res1; /* reserved */
146#endif /* QDIO_32_BIT */
147 unsigned long sliba; /* storage-list-information-block
148 address */
149#ifdef QDIO_32_BIT
150 unsigned long res2; /* reserved */
151#endif /* QDIO_32_BIT */
152 unsigned long sla; /* storage-list address */
153#ifdef QDIO_32_BIT
154 unsigned long res3; /* reserved */
155#endif /* QDIO_32_BIT */
156 unsigned long slsba; /* storage-list-state-block address */
157 unsigned int res4; /* reserved */
158 unsigned int akey : 4; /* access key for DLIB */
159 unsigned int bkey : 4; /* access key for SL */
160 unsigned int ckey : 4; /* access key for SBALs */
161 unsigned int dkey : 4; /* access key for SLSB */
162 unsigned int res5 : 16; /* reserved */
163} __attribute__ ((packed));
164
165/*
166 * Queue-Description record (QDR)
167 */
168struct qdr {
169 unsigned int qfmt : 8; /* queue format */
170 unsigned int pfmt : 8; /* impl. dep. parameter format */
171 unsigned int res1 : 8; /* reserved */
172 unsigned int ac : 8; /* adapter characteristics */
173 unsigned int res2 : 8; /* reserved */
174 unsigned int iqdcnt : 8; /* input-queue-descriptor count */
175 unsigned int res3 : 8; /* reserved */
176 unsigned int oqdcnt : 8; /* output-queue-descriptor count */
177 unsigned int res4 : 8; /* reserved */
178 unsigned int iqdsz : 8; /* input-queue-descriptor size */
179 unsigned int res5 : 8; /* reserved */
180 unsigned int oqdsz : 8; /* output-queue-descriptor size */
181 unsigned int res6[9]; /* reserved */
182#ifdef QDIO_32_BIT
183 unsigned long res7; /* reserved */
184#endif /* QDIO_32_BIT */
185 unsigned long qiba; /* queue-information-block address */
186 unsigned int res8; /* reserved */
187 unsigned int qkey : 4; /* queue-informatio-block key */
188 unsigned int res9 : 28; /* reserved */
189/* union _qd {*/ /* why this? */
190 struct qdesfmt0 qdf0[126];
191/* } qd;*/
192} __attribute__ ((packed,aligned(4096)));
193
194
195/*
196 * queue information block (QIB)
197 */
Frank Pavlic8129ee12006-01-06 00:19:20 -0800198#define QIB_AC_INBOUND_PCI_SUPPORTED 0x80
199#define QIB_AC_OUTBOUND_PCI_SUPPORTED 0x40
200#define QIB_RFLAGS_ENABLE_QEBSM 0x80
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202struct qib {
203 unsigned int qfmt : 8; /* queue format */
204 unsigned int pfmt : 8; /* impl. dep. parameter format */
Frank Pavlic8129ee12006-01-06 00:19:20 -0800205 unsigned int rflags : 8; /* QEBSM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 unsigned int ac : 8; /* adapter characteristics */
207 unsigned int res2; /* reserved */
208#ifdef QDIO_32_BIT
209 unsigned long res3; /* reserved */
210#endif /* QDIO_32_BIT */
211 unsigned long isliba; /* absolute address of 1st
212 input SLIB */
213#ifdef QDIO_32_BIT
214 unsigned long res4; /* reserved */
215#endif /* QDIO_32_BIT */
216 unsigned long osliba; /* absolute address of 1st
217 output SLIB */
218 unsigned int res5; /* reserved */
219 unsigned int res6; /* reserved */
220 unsigned char ebcnam[8]; /* adapter identifier in EBCDIC */
221 unsigned char res7[88]; /* reserved */
222 unsigned char parm[QDIO_MAX_BUFFERS_PER_Q];
223 /* implementation dependent
224 parameters */
225} __attribute__ ((packed,aligned(256)));
226
227
228/*
229 * storage-list-information block element (SLIBE)
230 */
231struct slibe {
232#ifdef QDIO_32_BIT
233 unsigned long res; /* reserved */
234#endif /* QDIO_32_BIT */
235 unsigned long parms; /* implementation dependent
236 parameters */
237};
238
239/*
240 * storage-list-information block (SLIB)
241 */
242struct slib {
243#ifdef QDIO_32_BIT
244 unsigned long res1; /* reserved */
245#endif /* QDIO_32_BIT */
246 unsigned long nsliba; /* next SLIB address (if any) */
247#ifdef QDIO_32_BIT
248 unsigned long res2; /* reserved */
249#endif /* QDIO_32_BIT */
250 unsigned long sla; /* SL address */
251#ifdef QDIO_32_BIT
252 unsigned long res3; /* reserved */
253#endif /* QDIO_32_BIT */
254 unsigned long slsba; /* SLSB address */
255 unsigned char res4[1000]; /* reserved */
256 struct slibe slibe[QDIO_MAX_BUFFERS_PER_Q]; /* SLIB elements */
257} __attribute__ ((packed,aligned(2048)));
258
259struct sbal_flags {
260 unsigned char res1 : 1; /* reserved */
261 unsigned char last : 1; /* last entry */
262 unsigned char cont : 1; /* contiguous storage */
263 unsigned char res2 : 1; /* reserved */
264 unsigned char frag : 2; /* fragmentation (s.below) */
265 unsigned char res3 : 2; /* reserved */
266} __attribute__ ((packed));
267
268#define SBAL_FLAGS_FIRST_FRAG 0x04000000UL
269#define SBAL_FLAGS_MIDDLE_FRAG 0x08000000UL
270#define SBAL_FLAGS_LAST_FRAG 0x0c000000UL
271#define SBAL_FLAGS_LAST_ENTRY 0x40000000UL
272#define SBAL_FLAGS_CONTIGUOUS 0x20000000UL
273
274#define SBAL_FLAGS0_DATA_CONTINUATION 0x20UL
275
276/* Awesome OpenFCP extensions */
277#define SBAL_FLAGS0_TYPE_STATUS 0x00UL
278#define SBAL_FLAGS0_TYPE_WRITE 0x08UL
279#define SBAL_FLAGS0_TYPE_READ 0x10UL
280#define SBAL_FLAGS0_TYPE_WRITE_READ 0x18UL
281#define SBAL_FLAGS0_MORE_SBALS 0x04UL
282#define SBAL_FLAGS0_COMMAND 0x02UL
283#define SBAL_FLAGS0_LAST_SBAL 0x00UL
284#define SBAL_FLAGS0_ONLY_SBAL SBAL_FLAGS0_COMMAND
285#define SBAL_FLAGS0_MIDDLE_SBAL SBAL_FLAGS0_MORE_SBALS
286#define SBAL_FLAGS0_FIRST_SBAL SBAL_FLAGS0_MORE_SBALS | SBAL_FLAGS0_COMMAND
287/* Naught of interest beyond this point */
288
289#define SBAL_FLAGS0_PCI 0x40
290struct sbal_sbalf_0 {
291 unsigned char res1 : 1; /* reserved */
292 unsigned char pci : 1; /* PCI indicator */
293 unsigned char cont : 1; /* data continuation */
294 unsigned char sbtype: 2; /* storage-block type (OpenFCP) */
295 unsigned char res2 : 3; /* reserved */
296} __attribute__ ((packed));
297
298struct sbal_sbalf_1 {
299 unsigned char res1 : 4; /* reserved */
300 unsigned char key : 4; /* storage key */
301} __attribute__ ((packed));
302
303struct sbal_sbalf_14 {
304 unsigned char res1 : 4; /* reserved */
305 unsigned char erridx : 4; /* error index */
306} __attribute__ ((packed));
307
308struct sbal_sbalf_15 {
309 unsigned char reason; /* reserved */
310} __attribute__ ((packed));
311
312union sbal_sbalf {
313 struct sbal_sbalf_0 i0;
314 struct sbal_sbalf_1 i1;
315 struct sbal_sbalf_14 i14;
316 struct sbal_sbalf_15 i15;
317 unsigned char value;
318};
319
320struct sbal_element {
321 union {
322 struct sbal_flags bits; /* flags */
323 unsigned char value;
324 } flags;
325 unsigned int res1 : 16; /* reserved */
326 union sbal_sbalf sbalf; /* SBAL flags */
327 unsigned int res2 : 16; /* reserved */
328 unsigned int count : 16; /* data count */
329#ifdef QDIO_32_BIT
330 unsigned long res3; /* reserved */
331#endif /* QDIO_32_BIT */
332 unsigned long addr; /* absolute data address */
333} __attribute__ ((packed,aligned(16)));
334
335/*
336 * strorage-block access-list (SBAL)
337 */
338struct sbal {
339 struct sbal_element element[QDIO_MAX_ELEMENTS_PER_BUFFER];
340} __attribute__ ((packed,aligned(256)));
341
342/*
343 * storage-list (SL)
344 */
345struct sl_element {
346#ifdef QDIO_32_BIT
347 unsigned long res; /* reserved */
348#endif /* QDIO_32_BIT */
349 unsigned long sbal; /* absolute SBAL address */
350} __attribute__ ((packed));
351
352struct sl {
353 struct sl_element element[QDIO_MAX_BUFFERS_PER_Q];
354} __attribute__ ((packed,aligned(1024)));
355
356/*
357 * storage-list-state block (SLSB)
358 */
359struct slsb_flags {
360 unsigned char owner : 2; /* SBAL owner */
361 unsigned char type : 1; /* buffer type */
362 unsigned char state : 5; /* processing state */
363} __attribute__ ((packed));
364
365
366struct slsb {
367 union {
368 unsigned char val[QDIO_MAX_BUFFERS_PER_Q];
369 struct slsb_flags flags[QDIO_MAX_BUFFERS_PER_Q];
370 } acc;
371} __attribute__ ((packed,aligned(256)));
372
373/*
374 * SLSB values
375 */
376#define SLSB_OWNER_PROG 1
377#define SLSB_OWNER_CU 2
378
379#define SLSB_TYPE_INPUT 0
380#define SLSB_TYPE_OUTPUT 1
381
382#define SLSB_STATE_NOT_INIT 0
383#define SLSB_STATE_EMPTY 1
384#define SLSB_STATE_PRIMED 2
385#define SLSB_STATE_HALTED 0xe
386#define SLSB_STATE_ERROR 0xf
387
388#define SLSB_P_INPUT_NOT_INIT 0x80
389#define SLSB_P_INPUT_PROCESSING 0x81
390#define SLSB_CU_INPUT_EMPTY 0x41
391#define SLSB_P_INPUT_PRIMED 0x82
392#define SLSB_P_INPUT_HALTED 0x8E
393#define SLSB_P_INPUT_ERROR 0x8F
394
395#define SLSB_P_OUTPUT_NOT_INIT 0xA0
396#define SLSB_P_OUTPUT_EMPTY 0xA1
397#define SLSB_CU_OUTPUT_PRIMED 0x62
398#define SLSB_P_OUTPUT_HALTED 0xAE
399#define SLSB_P_OUTPUT_ERROR 0xAF
400
401#define SLSB_ERROR_DURING_LOOKUP 0xFF
402
403#endif /* __QDIO_H__ */