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