projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge git://git.infradead.org/battery-2.6
[linux-block.git] / include / asm-s390 / qdio.h
CommitLineData
1da177e4 1/*
f30c2269 2 * linux/include/asm-s390/qdio.h
1da177e4
LT		 3 *
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
1da177e4
LT		 14/* 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
028cf917 37#define QDIO_IQDIO_QFMT_ASYNCH 3
1da177e4
LT		 38
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
1f8bdae9 123#define QDIO_FLAG_PCI_OUT 0x20
1da177e4
LT		 124
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
a74b08c7 130extern int qdio_get_ssqd_pct(struct ccw_device*);
1da177e4
LT		 131extern int qdio_synchronize(struct ccw_device*, unsigned int flags,
132 unsigned int queue_number);
133
134extern int qdio_cleanup(struct ccw_device*, int how);
135extern int qdio_shutdown(struct ccw_device*, int how);
136extern int qdio_free(struct ccw_device*);
137
138unsigned char qdio_get_slsb_state(struct ccw_device*, unsigned int flag,
139 unsigned int queue_number,
140 unsigned int qidx);
141
142extern void qdio_init_scrubber(void);
143
144struct qdesfmt0 {
145#ifdef QDIO_32_BIT
146 unsigned long res1; /* reserved */
147#endif /* QDIO_32_BIT */
148 unsigned long sliba; /* storage-list-information-block
149 address */
150#ifdef QDIO_32_BIT
151 unsigned long res2; /* reserved */
152#endif /* QDIO_32_BIT */
153 unsigned long sla; /* storage-list address */
154#ifdef QDIO_32_BIT
155 unsigned long res3; /* reserved */
156#endif /* QDIO_32_BIT */
157 unsigned long slsba; /* storage-list-state-block address */
158 unsigned int res4; /* reserved */
159 unsigned int akey : 4; /* access key for DLIB */
160 unsigned int bkey : 4; /* access key for SL */
161 unsigned int ckey : 4; /* access key for SBALs */
162 unsigned int dkey : 4; /* access key for SLSB */
163 unsigned int res5 : 16; /* reserved */
164} __attribute__ ((packed));
165
166/*
167 * Queue-Description record (QDR)
168 */
169struct qdr {
170 unsigned int qfmt : 8; /* queue format */
171 unsigned int pfmt : 8; /* impl. dep. parameter format */
172 unsigned int res1 : 8; /* reserved */
173 unsigned int ac : 8; /* adapter characteristics */
174 unsigned int res2 : 8; /* reserved */
175 unsigned int iqdcnt : 8; /* input-queue-descriptor count */
176 unsigned int res3 : 8; /* reserved */
177 unsigned int oqdcnt : 8; /* output-queue-descriptor count */
178 unsigned int res4 : 8; /* reserved */
179 unsigned int iqdsz : 8; /* input-queue-descriptor size */
180 unsigned int res5 : 8; /* reserved */
181 unsigned int oqdsz : 8; /* output-queue-descriptor size */
182 unsigned int res6[9]; /* reserved */
183#ifdef QDIO_32_BIT
184 unsigned long res7; /* reserved */
185#endif /* QDIO_32_BIT */
186 unsigned long qiba; /* queue-information-block address */
187 unsigned int res8; /* reserved */
5800266a 188 unsigned int qkey : 4; /* queue-information-block key */
1da177e4
LT		 189 unsigned int res9 : 28; /* reserved */
190/* union _qd {*/ /* why this? */
191 struct qdesfmt0 qdf0[126];
192/* } qd;*/
193} __attribute__ ((packed,aligned(4096)));
194
195
196/*
197 * queue information block (QIB)
198 */
8129ee16
FP		 199#define QIB_AC_INBOUND_PCI_SUPPORTED 0x80
200#define QIB_AC_OUTBOUND_PCI_SUPPORTED 0x40
201#define QIB_RFLAGS_ENABLE_QEBSM 0x80
202
1da177e4
LT		 203struct qib {
204 unsigned int qfmt : 8; /* queue format */
205 unsigned int pfmt : 8; /* impl. dep. parameter format */
8129ee16 206 unsigned int rflags : 8; /* QEBSM */
1da177e4
LT		 207 unsigned int ac : 8; /* adapter characteristics */
208 unsigned int res2; /* reserved */
209#ifdef QDIO_32_BIT
210 unsigned long res3; /* reserved */
211#endif /* QDIO_32_BIT */
212 unsigned long isliba; /* absolute address of 1st
213 input SLIB */
214#ifdef QDIO_32_BIT
215 unsigned long res4; /* reserved */
216#endif /* QDIO_32_BIT */
217 unsigned long osliba; /* absolute address of 1st
218 output SLIB */
219 unsigned int res5; /* reserved */
220 unsigned int res6; /* reserved */
221 unsigned char ebcnam[8]; /* adapter identifier in EBCDIC */
222 unsigned char res7[88]; /* reserved */
223 unsigned char parm[QDIO_MAX_BUFFERS_PER_Q];
224 /* implementation dependent
225 parameters */
226} __attribute__ ((packed,aligned(256)));
227
228
229/*
230 * storage-list-information block element (SLIBE)
231 */
232struct slibe {
233#ifdef QDIO_32_BIT
234 unsigned long res; /* reserved */
235#endif /* QDIO_32_BIT */
236 unsigned long parms; /* implementation dependent
237 parameters */
238};
239
240/*
241 * storage-list-information block (SLIB)
242 */
243struct slib {
244#ifdef QDIO_32_BIT
245 unsigned long res1; /* reserved */
246#endif /* QDIO_32_BIT */
247 unsigned long nsliba; /* next SLIB address (if any) */
248#ifdef QDIO_32_BIT
249 unsigned long res2; /* reserved */
250#endif /* QDIO_32_BIT */
251 unsigned long sla; /* SL address */
252#ifdef QDIO_32_BIT
253 unsigned long res3; /* reserved */
254#endif /* QDIO_32_BIT */
255 unsigned long slsba; /* SLSB address */
256 unsigned char res4[1000]; /* reserved */
257 struct slibe slibe[QDIO_MAX_BUFFERS_PER_Q]; /* SLIB elements */
258} __attribute__ ((packed,aligned(2048)));
259
260struct sbal_flags {
261 unsigned char res1 : 1; /* reserved */
262 unsigned char last : 1; /* last entry */
263 unsigned char cont : 1; /* contiguous storage */
264 unsigned char res2 : 1; /* reserved */
265 unsigned char frag : 2; /* fragmentation (s.below) */
266 unsigned char res3 : 2; /* reserved */
267} __attribute__ ((packed));
268
269#define SBAL_FLAGS_FIRST_FRAG 0x04000000UL
270#define SBAL_FLAGS_MIDDLE_FRAG 0x08000000UL
271#define SBAL_FLAGS_LAST_FRAG 0x0c000000UL
272#define SBAL_FLAGS_LAST_ENTRY 0x40000000UL
273#define SBAL_FLAGS_CONTIGUOUS 0x20000000UL
274
275#define SBAL_FLAGS0_DATA_CONTINUATION 0x20UL
276
277/* Awesome OpenFCP extensions */
278#define SBAL_FLAGS0_TYPE_STATUS 0x00UL
279#define SBAL_FLAGS0_TYPE_WRITE 0x08UL
280#define SBAL_FLAGS0_TYPE_READ 0x10UL
281#define SBAL_FLAGS0_TYPE_WRITE_READ 0x18UL
282#define SBAL_FLAGS0_MORE_SBALS 0x04UL
283#define SBAL_FLAGS0_COMMAND 0x02UL
284#define SBAL_FLAGS0_LAST_SBAL 0x00UL
285#define SBAL_FLAGS0_ONLY_SBAL SBAL_FLAGS0_COMMAND
286#define SBAL_FLAGS0_MIDDLE_SBAL SBAL_FLAGS0_MORE_SBALS
287#define SBAL_FLAGS0_FIRST_SBAL SBAL_FLAGS0_MORE_SBALS | SBAL_FLAGS0_COMMAND
288/* Naught of interest beyond this point */
289
290#define SBAL_FLAGS0_PCI 0x40
291struct sbal_sbalf_0 {
292 unsigned char res1 : 1; /* reserved */
293 unsigned char pci : 1; /* PCI indicator */
294 unsigned char cont : 1; /* data continuation */
295 unsigned char sbtype: 2; /* storage-block type (OpenFCP) */
296 unsigned char res2 : 3; /* reserved */
297} __attribute__ ((packed));
298
299struct sbal_sbalf_1 {
300 unsigned char res1 : 4; /* reserved */
301 unsigned char key : 4; /* storage key */
302} __attribute__ ((packed));
303
304struct sbal_sbalf_14 {
305 unsigned char res1 : 4; /* reserved */
306 unsigned char erridx : 4; /* error index */
307} __attribute__ ((packed));
308
309struct sbal_sbalf_15 {
310 unsigned char reason; /* reserved */
311} __attribute__ ((packed));
312
313union sbal_sbalf {
314 struct sbal_sbalf_0 i0;
315 struct sbal_sbalf_1 i1;
316 struct sbal_sbalf_14 i14;
317 struct sbal_sbalf_15 i15;
318 unsigned char value;
319};
320
321struct sbal_element {
322 union {
323 struct sbal_flags bits; /* flags */
324 unsigned char value;
325 } flags;
326 unsigned int res1 : 16; /* reserved */
327 union sbal_sbalf sbalf; /* SBAL flags */
328 unsigned int res2 : 16; /* reserved */
329 unsigned int count : 16; /* data count */
330#ifdef QDIO_32_BIT
331 unsigned long res3; /* reserved */
332#endif /* QDIO_32_BIT */
333 unsigned long addr; /* absolute data address */
334} __attribute__ ((packed,aligned(16)));
335
336/*
337 * strorage-block access-list (SBAL)
338 */
339struct sbal {
340 struct sbal_element element[QDIO_MAX_ELEMENTS_PER_BUFFER];
341} __attribute__ ((packed,aligned(256)));
342
343/*
344 * storage-list (SL)
345 */
346struct sl_element {
347#ifdef QDIO_32_BIT
348 unsigned long res; /* reserved */
349#endif /* QDIO_32_BIT */
350 unsigned long sbal; /* absolute SBAL address */
351} __attribute__ ((packed));
352
353struct sl {
354 struct sl_element element[QDIO_MAX_BUFFERS_PER_Q];
355} __attribute__ ((packed,aligned(1024)));
356
357/*
358 * storage-list-state block (SLSB)
359 */
360struct slsb_flags {
361 unsigned char owner : 2; /* SBAL owner */
362 unsigned char type : 1; /* buffer type */
363 unsigned char state : 5; /* processing state */
364} __attribute__ ((packed));
365
366
367struct slsb {
368 union {
369 unsigned char val[QDIO_MAX_BUFFERS_PER_Q];
370 struct slsb_flags flags[QDIO_MAX_BUFFERS_PER_Q];
371 } acc;
372} __attribute__ ((packed,aligned(256)));
373
374/*
375 * SLSB values
376 */
377#define SLSB_OWNER_PROG 1
378#define SLSB_OWNER_CU 2
379
380#define SLSB_TYPE_INPUT 0
381#define SLSB_TYPE_OUTPUT 1
382
383#define SLSB_STATE_NOT_INIT 0
384#define SLSB_STATE_EMPTY 1
385#define SLSB_STATE_PRIMED 2
386#define SLSB_STATE_HALTED 0xe
387#define SLSB_STATE_ERROR 0xf
388
389#define SLSB_P_INPUT_NOT_INIT 0x80
390#define SLSB_P_INPUT_PROCESSING 0x81
391#define SLSB_CU_INPUT_EMPTY 0x41
392#define SLSB_P_INPUT_PRIMED 0x82
393#define SLSB_P_INPUT_HALTED 0x8E
394#define SLSB_P_INPUT_ERROR 0x8F
395
396#define SLSB_P_OUTPUT_NOT_INIT 0xA0
397#define SLSB_P_OUTPUT_EMPTY 0xA1
398#define SLSB_CU_OUTPUT_PRIMED 0x62
399#define SLSB_P_OUTPUT_HALTED 0xAE
400#define SLSB_P_OUTPUT_ERROR 0xAF
401
402#define SLSB_ERROR_DURING_LOOKUP 0xFF
403
404#endif /* __QDIO_H__ */
Linux 6.x block layer and io_uring tree(s)