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