]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/s390/cio/qdio.h
Merge branch 'for-next' into for-linus
[mirror_ubuntu-hirsute-kernel.git] / drivers / s390 / cio / qdio.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
779e6e1c 2/*
a53c8fab 3 * Copyright IBM Corp. 2000, 2009
779e6e1c
JG
4 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
5 * Jan Glauber <jang@linux.vnet.ibm.com>
6 */
1da177e4
LT
7#ifndef _CIO_QDIO_H
8#define _CIO_QDIO_H
9
0b642ede 10#include <asm/page.h>
9d92a7e1 11#include <asm/schid.h>
22f99347 12#include <asm/debug.h>
779e6e1c 13#include "chsc.h"
a8237fc4 14
3a601bfe 15#define QDIO_BUSY_BIT_PATIENCE (100 << 12) /* 100 microseconds */
be8d97a5
JG
16#define QDIO_BUSY_BIT_RETRY_DELAY 10 /* 10 milliseconds */
17#define QDIO_BUSY_BIT_RETRIES 1000 /* = 10s retry time */
3a601bfe 18#define QDIO_INPUT_THRESHOLD (500 << 12) /* 500 microseconds */
1da177e4
LT
19
20enum qdio_irq_states {
21 QDIO_IRQ_STATE_INACTIVE,
22 QDIO_IRQ_STATE_ESTABLISHED,
23 QDIO_IRQ_STATE_ACTIVE,
24 QDIO_IRQ_STATE_STOPPED,
25 QDIO_IRQ_STATE_CLEANUP,
26 QDIO_IRQ_STATE_ERR,
27 NR_QDIO_IRQ_STATES,
28};
29
779e6e1c
JG
30/* used as intparm in do_IO */
31#define QDIO_DOING_ESTABLISH 1
32#define QDIO_DOING_ACTIVATE 2
33#define QDIO_DOING_CLEANUP 3
34
35#define SLSB_STATE_NOT_INIT 0x0
36#define SLSB_STATE_EMPTY 0x1
37#define SLSB_STATE_PRIMED 0x2
104ea556 38#define SLSB_STATE_PENDING 0x3
779e6e1c
JG
39#define SLSB_STATE_HALTED 0xe
40#define SLSB_STATE_ERROR 0xf
41#define SLSB_TYPE_INPUT 0x0
42#define SLSB_TYPE_OUTPUT 0x20
43#define SLSB_OWNER_PROG 0x80
44#define SLSB_OWNER_CU 0x40
45
46#define SLSB_P_INPUT_NOT_INIT \
47 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_NOT_INIT) /* 0x80 */
48#define SLSB_P_INPUT_ACK \
49 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x81 */
50#define SLSB_CU_INPUT_EMPTY \
51 (SLSB_OWNER_CU | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x41 */
52#define SLSB_P_INPUT_PRIMED \
53 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_PRIMED) /* 0x82 */
54#define SLSB_P_INPUT_HALTED \
55 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_HALTED) /* 0x8e */
56#define SLSB_P_INPUT_ERROR \
57 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_ERROR) /* 0x8f */
58#define SLSB_P_OUTPUT_NOT_INIT \
59 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_NOT_INIT) /* 0xa0 */
60#define SLSB_P_OUTPUT_EMPTY \
61 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_EMPTY) /* 0xa1 */
104ea556 62#define SLSB_P_OUTPUT_PENDING \
63 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_PENDING) /* 0xa3 */
779e6e1c
JG
64#define SLSB_CU_OUTPUT_PRIMED \
65 (SLSB_OWNER_CU | SLSB_TYPE_OUTPUT | SLSB_STATE_PRIMED) /* 0x62 */
66#define SLSB_P_OUTPUT_HALTED \
67 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_HALTED) /* 0xae */
68#define SLSB_P_OUTPUT_ERROR \
69 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_ERROR) /* 0xaf */
70
71#define SLSB_ERROR_DURING_LOOKUP 0xff
72
73/* additional CIWs returned by extended Sense-ID */
74#define CIW_TYPE_EQUEUE 0x3 /* establish QDIO queues */
75#define CIW_TYPE_AQUEUE 0x4 /* activate QDIO queues */
1da177e4 76
779e6e1c
JG
77/* flags for st qdio sch data */
78#define CHSC_FLAG_QDIO_CAPABILITY 0x80
79#define CHSC_FLAG_VALIDITY 0x40
80
958c0ba4
JG
81/* SIGA flags */
82#define QDIO_SIGA_WRITE 0x00
83#define QDIO_SIGA_READ 0x01
84#define QDIO_SIGA_SYNC 0x02
b7f143d0 85#define QDIO_SIGA_WRITEM 0x03
104ea556 86#define QDIO_SIGA_WRITEQ 0x04
958c0ba4
JG
87#define QDIO_SIGA_QEBSM_FLAG 0x80
88
779e6e1c
JG
89static inline int do_sqbs(u64 token, unsigned char state, int queue,
90 int *start, int *count)
91{
92 register unsigned long _ccq asm ("0") = *count;
93 register unsigned long _token asm ("1") = token;
94 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
1da177e4 95
779e6e1c
JG
96 asm volatile(
97 " .insn rsy,0xeb000000008A,%1,0,0(%2)"
98 : "+d" (_ccq), "+d" (_queuestart)
99 : "d" ((unsigned long)state), "d" (_token)
100 : "memory", "cc");
101 *count = _ccq & 0xff;
102 *start = _queuestart & 0xff;
8129ee16 103
779e6e1c 104 return (_ccq >> 32) & 0xff;
8129ee16
FP
105}
106
779e6e1c 107static inline int do_eqbs(u64 token, unsigned char *state, int queue,
50f769df 108 int *start, int *count, int ack)
8129ee16 109{
8129ee16 110 register unsigned long _ccq asm ("0") = *count;
779e6e1c 111 register unsigned long _token asm ("1") = token;
8129ee16 112 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
50f769df 113 unsigned long _state = (unsigned long)ack << 63;
8129ee16 114
94c12cc7
MS
115 asm volatile(
116 " .insn rrf,0xB99c0000,%1,%2,0,0"
117 : "+d" (_ccq), "+d" (_queuestart), "+d" (_state)
779e6e1c
JG
118 : "d" (_token)
119 : "memory", "cc");
8129ee16
FP
120 *count = _ccq & 0xff;
121 *start = _queuestart & 0xff;
122 *state = _state & 0xff;
123
124 return (_ccq >> 32) & 0xff;
1da177e4 125}
1da177e4 126
779e6e1c 127struct qdio_irq;
1da177e4 128
779e6e1c
JG
129struct siga_flag {
130 u8 input:1;
131 u8 output:1;
132 u8 sync:1;
90adac58
JG
133 u8 sync_after_ai:1;
134 u8 sync_out_after_pci:1;
135 u8:3;
779e6e1c 136} __attribute__ ((packed));
1da177e4 137
6486cda6
JG
138struct qdio_dev_perf_stat {
139 unsigned int adapter_int;
140 unsigned int qdio_int;
141 unsigned int pci_request_int;
142
143 unsigned int tasklet_inbound;
144 unsigned int tasklet_inbound_resched;
145 unsigned int tasklet_inbound_resched2;
146 unsigned int tasklet_outbound;
147
148 unsigned int siga_read;
149 unsigned int siga_write;
150 unsigned int siga_sync;
151
152 unsigned int inbound_call;
153 unsigned int inbound_handler;
154 unsigned int stop_polling;
155 unsigned int inbound_queue_full;
156 unsigned int outbound_call;
157 unsigned int outbound_handler;
0195843b 158 unsigned int outbound_queue_full;
6486cda6
JG
159 unsigned int fast_requeue;
160 unsigned int target_full;
161 unsigned int eqbs;
162 unsigned int eqbs_partial;
163 unsigned int sqbs;
164 unsigned int sqbs_partial;
d36deae7 165 unsigned int int_discarded;
432ac5e0 166} ____cacheline_aligned;
6486cda6 167
d307297f
JG
168struct qdio_queue_perf_stat {
169 /*
170 * Sorted into order-2 buckets: 1, 2-3, 4-7, ... 64-127, 128.
171 * Since max. 127 SBALs are scanned reuse entry for 128 as queue full
172 * aka 127 SBALs found.
173 */
174 unsigned int nr_sbals[8];
175 unsigned int nr_sbal_error;
176 unsigned int nr_sbal_nop;
177 unsigned int nr_sbal_total;
178};
179
d36deae7
JG
180enum qdio_queue_irq_states {
181 QDIO_QUEUE_IRQS_DISABLED,
182};
183
779e6e1c
JG
184struct qdio_input_q {
185 /* input buffer acknowledgement flag */
186 int polling;
e85dea0e
JG
187 /* first ACK'ed buffer */
188 int ack_start;
50f769df
JG
189 /* how much sbals are acknowledged with qebsm */
190 int ack_count;
779e6e1c
JG
191 /* last time of noticing incoming data */
192 u64 timestamp;
d36deae7
JG
193 /* upper-layer polling flag */
194 unsigned long queue_irq_state;
195 /* callback to start upper-layer polling */
196 void (*queue_start_poll) (struct ccw_device *, int, unsigned long);
1da177e4 197};
1da177e4 198
779e6e1c 199struct qdio_output_q {
779e6e1c
JG
200 /* PCIs are enabled for the queue */
201 int pci_out_enabled;
104ea556 202 /* cq: use asynchronous output buffers */
203 int use_cq;
204 /* cq: aobs used for particual SBAL */
205 struct qaob **aobs;
206 /* cq: sbal state related to asynchronous operation */
207 struct qdio_outbuf_state *sbal_state;
779e6e1c
JG
208 /* timer to check for more outbound work */
209 struct timer_list timer;
210};
1da177e4 211
d307297f
JG
212/*
213 * Note on cache alignment: grouped slsb and write mostly data at the beginning
214 * sbal[] is read-only and starts on a new cacheline followed by read mostly.
215 */
1da177e4 216struct qdio_q {
779e6e1c 217 struct slsb slsb;
d307297f 218
779e6e1c
JG
219 union {
220 struct qdio_input_q in;
221 struct qdio_output_q out;
222 } u;
1da177e4 223
779e6e1c
JG
224 /*
225 * inbound: next buffer the program should check for
d307297f 226 * outbound: next buffer to check if adapter processed it
779e6e1c
JG
227 */
228 int first_to_check;
1da177e4 229
779e6e1c
JG
230 /* beginning position for calling the program */
231 int first_to_kick;
1da177e4 232
779e6e1c
JG
233 /* number of buffers in use by the adapter */
234 atomic_t nr_buf_used;
1da177e4 235
779e6e1c 236 /* error condition during a data transfer */
1da177e4 237 unsigned int qdio_error;
1da177e4 238
a2b86019
JG
239 /* last scan of the queue */
240 u64 timestamp;
241
d307297f
JG
242 struct tasklet_struct tasklet;
243 struct qdio_queue_perf_stat q_stats;
244
245 struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q] ____cacheline_aligned;
246
247 /* queue number */
248 int nr;
249
250 /* bitmask of queue number */
251 int mask;
252
253 /* input or output queue */
254 int is_input_q;
255
d307297f
JG
256 /* upper-layer program handler */
257 qdio_handler_t (*handler);
779e6e1c 258
d307297f
JG
259 struct dentry *debugfs_q;
260 struct qdio_irq *irq_ptr;
261 struct sl *sl;
779e6e1c 262 /*
5382fe11
JG
263 * A page is allocated under this pointer and used for slib and sl.
264 * slib is 2048 bytes big and sl points to offset PAGE_SIZE / 2.
779e6e1c
JG
265 */
266 struct slib *slib;
1da177e4
LT
267} __attribute__ ((aligned(256)));
268
269struct qdio_irq {
779e6e1c
JG
270 struct qib qib;
271 u32 *dsci; /* address of device state change indicator */
272 struct ccw_device *cdev;
94c43bda 273 struct list_head entry; /* list of thinint devices */
3f09bb89 274 struct dentry *debugfs_dev;
6486cda6 275 struct dentry *debugfs_perf;
1da177e4
LT
276
277 unsigned long int_parm;
a8237fc4 278 struct subchannel_id schid;
779e6e1c 279 unsigned long sch_token; /* QEBSM facility */
8129ee16 280
1da177e4
LT
281 enum qdio_irq_states state;
282
779e6e1c 283 struct siga_flag siga_flag; /* siga sync information from qdioac */
1da177e4 284
779e6e1c
JG
285 int nr_input_qs;
286 int nr_output_qs;
1da177e4
LT
287
288 struct ccw1 ccw;
1da177e4
LT
289 struct ciw equeue;
290 struct ciw aqueue;
291
779e6e1c 292 struct qdio_ssqd_desc ssqd_desc;
779e6e1c 293 void (*orig_handler) (struct ccw_device *, unsigned long, struct irb *);
1da177e4 294
313dc689 295 unsigned int scan_threshold; /* used SBALs before tasklet schedule */
6486cda6 296 int perf_stat_enabled;
432ac5e0 297
1da177e4 298 struct qdr *qdr;
779e6e1c
JG
299 unsigned long chsc_page;
300
1da177e4
LT
301 struct qdio_q *input_qs[QDIO_MAX_QUEUES_PER_IRQ];
302 struct qdio_q *output_qs[QDIO_MAX_QUEUES_PER_IRQ];
779e6e1c 303
22f99347 304 debug_info_t *debug_area;
779e6e1c 305 struct mutex setup_mutex;
432ac5e0 306 struct qdio_dev_perf_stat perf_stat;
1da177e4 307};
779e6e1c
JG
308
309/* helper functions */
310#define queue_type(q) q->irq_ptr->qib.qfmt
22f99347 311#define SCH_NO(q) (q->irq_ptr->schid.sch_no)
779e6e1c
JG
312
313#define is_thinint_irq(irq) \
314 (irq->qib.qfmt == QDIO_IQDIO_QFMT || \
315 css_general_characteristics.aif_osa)
316
d307297f
JG
317#define qperf(__qdev, __attr) ((__qdev)->perf_stat.(__attr))
318
46112810 319#define QDIO_PERF_STAT_INC(__irq, __attr) \
d307297f 320({ \
46112810 321 struct qdio_irq *qdev = __irq; \
d307297f
JG
322 if (qdev->perf_stat_enabled) \
323 (qdev->perf_stat.__attr)++; \
324})
325
46112810
JW
326#define qperf_inc(__q, __attr) QDIO_PERF_STAT_INC((__q)->irq_ptr, __attr)
327
d307297f
JG
328static inline void account_sbals_error(struct qdio_q *q, int count)
329{
330 q->q_stats.nr_sbal_error += count;
331 q->q_stats.nr_sbal_total += count;
332}
6486cda6 333
779e6e1c
JG
334/* the highest iqdio queue is used for multicast */
335static inline int multicast_outbound(struct qdio_q *q)
336{
337 return (q->irq_ptr->nr_output_qs > 1) &&
338 (q->nr == q->irq_ptr->nr_output_qs - 1);
339}
340
f85b2b29 341#define pci_out_supported(irq) ((irq)->qib.ac & QIB_AC_OUTBOUND_PCI_SUPPORTED)
779e6e1c
JG
342#define is_qebsm(q) (q->irq_ptr->sch_token != 0)
343
779e6e1c
JG
344#define need_siga_in(q) (q->irq_ptr->siga_flag.input)
345#define need_siga_out(q) (q->irq_ptr->siga_flag.output)
90adac58
JG
346#define need_siga_sync(q) (unlikely(q->irq_ptr->siga_flag.sync))
347#define need_siga_sync_after_ai(q) \
348 (unlikely(q->irq_ptr->siga_flag.sync_after_ai))
349#define need_siga_sync_out_after_pci(q) \
350 (unlikely(q->irq_ptr->siga_flag.sync_out_after_pci))
779e6e1c 351
dbb0dd02
JA
352#define for_each_input_queue(irq_ptr, q, i) \
353 for (i = 0; i < irq_ptr->nr_input_qs && \
354 ({ q = irq_ptr->input_qs[i]; 1; }); i++)
355#define for_each_output_queue(irq_ptr, q, i) \
356 for (i = 0; i < irq_ptr->nr_output_qs && \
357 ({ q = irq_ptr->output_qs[i]; 1; }); i++)
779e6e1c 358
a320412d
JW
359#define add_buf(bufnr, inc) QDIO_BUFNR((bufnr) + (inc))
360#define next_buf(bufnr) add_buf(bufnr, 1)
361#define sub_buf(bufnr, dec) QDIO_BUFNR((bufnr) - (dec))
362#define prev_buf(bufnr) sub_buf(bufnr, 1)
779e6e1c 363
d36deae7
JG
364#define queue_irqs_enabled(q) \
365 (test_bit(QDIO_QUEUE_IRQS_DISABLED, &q->u.in.queue_irq_state) == 0)
366#define queue_irqs_disabled(q) \
367 (test_bit(QDIO_QUEUE_IRQS_DISABLED, &q->u.in.queue_irq_state) != 0)
368
a2b86019
JG
369extern u64 last_ai_time;
370
779e6e1c 371/* prototypes for thin interrupt */
779e6e1c
JG
372void qdio_setup_thinint(struct qdio_irq *irq_ptr);
373int qdio_establish_thinint(struct qdio_irq *irq_ptr);
374void qdio_shutdown_thinint(struct qdio_irq *irq_ptr);
94c43bda
JW
375void tiqdio_add_device(struct qdio_irq *irq_ptr);
376void tiqdio_remove_device(struct qdio_irq *irq_ptr);
779e6e1c
JG
377void tiqdio_inbound_processing(unsigned long q);
378int tiqdio_allocate_memory(void);
379void tiqdio_free_memory(void);
380int tiqdio_register_thinints(void);
381void tiqdio_unregister_thinints(void);
5f4026f8
JG
382void clear_nonshared_ind(struct qdio_irq *);
383int test_nonshared_ind(struct qdio_irq *);
104ea556 384
779e6e1c
JG
385/* prototypes for setup */
386void qdio_inbound_processing(unsigned long data);
387void qdio_outbound_processing(unsigned long data);
cb9f780a 388void qdio_outbound_timer(struct timer_list *t);
779e6e1c
JG
389void qdio_int_handler(struct ccw_device *cdev, unsigned long intparm,
390 struct irb *irb);
391int qdio_allocate_qs(struct qdio_irq *irq_ptr, int nr_input_qs,
392 int nr_output_qs);
393void qdio_setup_ssqd_info(struct qdio_irq *irq_ptr);
bbd50e17
JG
394int qdio_setup_get_ssqd(struct qdio_irq *irq_ptr,
395 struct subchannel_id *schid,
396 struct qdio_ssqd_desc *data);
779e6e1c
JG
397int qdio_setup_irq(struct qdio_initialize *init_data);
398void qdio_print_subchannel_info(struct qdio_irq *irq_ptr,
399 struct ccw_device *cdev);
400void qdio_release_memory(struct qdio_irq *irq_ptr);
50f769df
JG
401int qdio_setup_create_sysfs(struct ccw_device *cdev);
402void qdio_setup_destroy_sysfs(struct ccw_device *cdev);
779e6e1c
JG
403int qdio_setup_init(void);
404void qdio_setup_exit(void);
104ea556 405int qdio_enable_async_operation(struct qdio_output_q *q);
406void qdio_disable_async_operation(struct qdio_output_q *q);
407struct qaob *qdio_allocate_aob(void);
779e6e1c 408
60b5df2f
JG
409int debug_get_buf_state(struct qdio_q *q, unsigned int bufnr,
410 unsigned char *state);
779e6e1c 411#endif /* _CIO_QDIO_H */