[S390] qdio: rework debug feature logging
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / s390 / cio / qdio.h
CommitLineData
779e6e1c
JG
1/*
2 * linux/drivers/s390/cio/qdio.h
3 *
4 * Copyright 2000,2008 IBM Corp.
5 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
6 * Jan Glauber <jang@linux.vnet.ibm.com>
7 */
1da177e4
LT
8#ifndef _CIO_QDIO_H
9#define _CIO_QDIO_H
10
0b642ede 11#include <asm/page.h>
9d92a7e1 12#include <asm/schid.h>
22f99347 13#include <asm/debug.h>
779e6e1c 14#include "chsc.h"
a8237fc4 15
779e6e1c
JG
16#define QDIO_BUSY_BIT_PATIENCE 100 /* 100 microseconds */
17#define QDIO_BUSY_BIT_GIVE_UP 2000000 /* 2 seconds = eternity */
18#define QDIO_INPUT_THRESHOLD 500 /* 500 microseconds */
1da177e4 19
4bcb3a37
UB
20/*
21 * if an asynchronous HiperSockets queue runs full, the 10 seconds timer wait
22 * till next initiative to give transmitted skbs back to the stack is too long.
23 * Therefore polling is started in case of multicast queue is filled more
24 * than 50 percent.
25 */
26#define QDIO_IQDIO_POLL_LVL 65 /* HS multicast queue */
27
1da177e4
LT
28enum qdio_irq_states {
29 QDIO_IRQ_STATE_INACTIVE,
30 QDIO_IRQ_STATE_ESTABLISHED,
31 QDIO_IRQ_STATE_ACTIVE,
32 QDIO_IRQ_STATE_STOPPED,
33 QDIO_IRQ_STATE_CLEANUP,
34 QDIO_IRQ_STATE_ERR,
35 NR_QDIO_IRQ_STATES,
36};
37
779e6e1c
JG
38/* used as intparm in do_IO */
39#define QDIO_DOING_ESTABLISH 1
40#define QDIO_DOING_ACTIVATE 2
41#define QDIO_DOING_CLEANUP 3
42
43#define SLSB_STATE_NOT_INIT 0x0
44#define SLSB_STATE_EMPTY 0x1
45#define SLSB_STATE_PRIMED 0x2
46#define SLSB_STATE_HALTED 0xe
47#define SLSB_STATE_ERROR 0xf
48#define SLSB_TYPE_INPUT 0x0
49#define SLSB_TYPE_OUTPUT 0x20
50#define SLSB_OWNER_PROG 0x80
51#define SLSB_OWNER_CU 0x40
52
53#define SLSB_P_INPUT_NOT_INIT \
54 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_NOT_INIT) /* 0x80 */
55#define SLSB_P_INPUT_ACK \
56 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x81 */
57#define SLSB_CU_INPUT_EMPTY \
58 (SLSB_OWNER_CU | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x41 */
59#define SLSB_P_INPUT_PRIMED \
60 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_PRIMED) /* 0x82 */
61#define SLSB_P_INPUT_HALTED \
62 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_HALTED) /* 0x8e */
63#define SLSB_P_INPUT_ERROR \
64 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_ERROR) /* 0x8f */
65#define SLSB_P_OUTPUT_NOT_INIT \
66 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_NOT_INIT) /* 0xa0 */
67#define SLSB_P_OUTPUT_EMPTY \
68 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_EMPTY) /* 0xa1 */
69#define SLSB_CU_OUTPUT_PRIMED \
70 (SLSB_OWNER_CU | SLSB_TYPE_OUTPUT | SLSB_STATE_PRIMED) /* 0x62 */
71#define SLSB_P_OUTPUT_HALTED \
72 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_HALTED) /* 0xae */
73#define SLSB_P_OUTPUT_ERROR \
74 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_ERROR) /* 0xaf */
75
76#define SLSB_ERROR_DURING_LOOKUP 0xff
77
78/* additional CIWs returned by extended Sense-ID */
79#define CIW_TYPE_EQUEUE 0x3 /* establish QDIO queues */
80#define CIW_TYPE_AQUEUE 0x4 /* activate QDIO queues */
1da177e4 81
779e6e1c
JG
82/* flags for st qdio sch data */
83#define CHSC_FLAG_QDIO_CAPABILITY 0x80
84#define CHSC_FLAG_VALIDITY 0x40
85
86/* qdio adapter-characteristics-1 flag */
87#define AC1_SIGA_INPUT_NEEDED 0x40 /* process input queues */
88#define AC1_SIGA_OUTPUT_NEEDED 0x20 /* process output queues */
89#define AC1_SIGA_SYNC_NEEDED 0x10 /* ask hypervisor to sync */
90#define AC1_AUTOMATIC_SYNC_ON_THININT 0x08 /* set by hypervisor */
91#define AC1_AUTOMATIC_SYNC_ON_OUT_PCI 0x04 /* set by hypervisor */
92#define AC1_SC_QEBSM_AVAILABLE 0x02 /* available for subchannel */
93#define AC1_SC_QEBSM_ENABLED 0x01 /* enabled for subchannel */
1da177e4 94
779e6e1c
JG
95#ifdef CONFIG_64BIT
96static inline int do_sqbs(u64 token, unsigned char state, int queue,
97 int *start, int *count)
98{
99 register unsigned long _ccq asm ("0") = *count;
100 register unsigned long _token asm ("1") = token;
101 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
1da177e4 102
779e6e1c
JG
103 asm volatile(
104 " .insn rsy,0xeb000000008A,%1,0,0(%2)"
105 : "+d" (_ccq), "+d" (_queuestart)
106 : "d" ((unsigned long)state), "d" (_token)
107 : "memory", "cc");
108 *count = _ccq & 0xff;
109 *start = _queuestart & 0xff;
8129ee16 110
779e6e1c 111 return (_ccq >> 32) & 0xff;
8129ee16
FP
112}
113
779e6e1c
JG
114static inline int do_eqbs(u64 token, unsigned char *state, int queue,
115 int *start, int *count)
8129ee16 116{
8129ee16 117 register unsigned long _ccq asm ("0") = *count;
779e6e1c 118 register unsigned long _token asm ("1") = token;
8129ee16
FP
119 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
120 unsigned long _state = 0;
121
94c12cc7
MS
122 asm volatile(
123 " .insn rrf,0xB99c0000,%1,%2,0,0"
124 : "+d" (_ccq), "+d" (_queuestart), "+d" (_state)
779e6e1c
JG
125 : "d" (_token)
126 : "memory", "cc");
8129ee16
FP
127 *count = _ccq & 0xff;
128 *start = _queuestart & 0xff;
129 *state = _state & 0xff;
130
131 return (_ccq >> 32) & 0xff;
1da177e4 132}
779e6e1c
JG
133#else
134static inline int do_sqbs(u64 token, unsigned char state, int queue,
135 int *start, int *count) { return 0; }
136static inline int do_eqbs(u64 token, unsigned char *state, int queue,
137 int *start, int *count) { return 0; }
138#endif /* CONFIG_64BIT */
1da177e4 139
779e6e1c 140struct qdio_irq;
1da177e4 141
779e6e1c
JG
142struct siga_flag {
143 u8 input:1;
144 u8 output:1;
145 u8 sync:1;
146 u8 no_sync_ti:1;
147 u8 no_sync_out_ti:1;
148 u8 no_sync_out_pci:1;
149 u8:2;
150} __attribute__ ((packed));
1da177e4 151
779e6e1c 152struct chsc_ssqd_area {
e1776856 153 struct chsc_header request;
779e6e1c
JG
154 u16:10;
155 u8 ssid:2;
156 u8 fmt:4;
e1776856 157 u16 first_sch;
779e6e1c 158 u16:16;
e1776856 159 u16 last_sch;
779e6e1c 160 u32:32;
e1776856 161 struct chsc_header response;
779e6e1c
JG
162 u32:32;
163 struct qdio_ssqd_desc qdio_ssqd;
164} __attribute__ ((packed));
e1776856 165
779e6e1c
JG
166struct scssc_area {
167 struct chsc_header request;
168 u16 operation_code;
169 u16:16;
170 u32:32;
171 u32:32;
172 u64 summary_indicator_addr;
173 u64 subchannel_indicator_addr;
174 u32 ks:4;
175 u32 kc:4;
176 u32:21;
177 u32 isc:3;
178 u32 word_with_d_bit;
179 u32:32;
180 struct subchannel_id schid;
181 u32 reserved[1004];
182 struct chsc_header response;
183 u32:32;
184} __attribute__ ((packed));
185
186struct qdio_input_q {
187 /* input buffer acknowledgement flag */
188 int polling;
189
190 /* last time of noticing incoming data */
191 u64 timestamp;
192
193 /* lock for clearing the acknowledgement */
194 spinlock_t lock;
1da177e4 195};
1da177e4 196
779e6e1c
JG
197struct qdio_output_q {
198 /* failed siga-w attempts*/
199 atomic_t busy_siga_counter;
1da177e4 200
779e6e1c
JG
201 /* start time of busy condition */
202 u64 timestamp;
1da177e4 203
779e6e1c
JG
204 /* PCIs are enabled for the queue */
205 int pci_out_enabled;
1da177e4 206
7a0f4755
KDW
207 /* IQDIO: output multiple buffers (enhanced SIGA) */
208 int use_enh_siga;
209
779e6e1c
JG
210 /* timer to check for more outbound work */
211 struct timer_list timer;
212};
1da177e4 213
1da177e4 214struct qdio_q {
779e6e1c
JG
215 struct slsb slsb;
216 union {
217 struct qdio_input_q in;
218 struct qdio_output_q out;
219 } u;
1da177e4 220
779e6e1c
JG
221 /* queue number */
222 int nr;
1da177e4 223
779e6e1c
JG
224 /* bitmask of queue number */
225 int mask;
1da177e4 226
779e6e1c 227 /* input or output queue */
1da177e4 228 int is_input_q;
1da177e4 229
779e6e1c
JG
230 /* list of thinint input queues */
231 struct list_head entry;
1da177e4 232
779e6e1c 233 /* upper-layer program handler */
1da177e4
LT
234 qdio_handler_t (*handler);
235
779e6e1c
JG
236 /*
237 * inbound: next buffer the program should check for
238 * outbound: next buffer to check for having been processed
239 * by the card
240 */
241 int first_to_check;
1da177e4 242
779e6e1c
JG
243 /* first_to_check of the last time */
244 int last_move_ftc;
1da177e4 245
779e6e1c
JG
246 /* beginning position for calling the program */
247 int first_to_kick;
1da177e4 248
779e6e1c
JG
249 /* number of buffers in use by the adapter */
250 atomic_t nr_buf_used;
1da177e4 251
779e6e1c 252 struct qdio_irq *irq_ptr;
1da177e4 253 struct tasklet_struct tasklet;
1da177e4 254
779e6e1c 255 /* error condition during a data transfer */
1da177e4 256 unsigned int qdio_error;
1da177e4
LT
257
258 struct sl *sl;
779e6e1c
JG
259 struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
260
261 /*
262 * Warning: Leave this member at the end so it won't be cleared in
263 * qdio_fill_qs. A page is allocated under this pointer and used for
264 * slib and sl. slib is 2048 bytes big and sl points to offset
265 * PAGE_SIZE / 2.
266 */
267 struct slib *slib;
1da177e4
LT
268} __attribute__ ((aligned(256)));
269
270struct qdio_irq {
779e6e1c
JG
271 struct qib qib;
272 u32 *dsci; /* address of device state change indicator */
273 struct ccw_device *cdev;
1da177e4
LT
274
275 unsigned long int_parm;
a8237fc4 276 struct subchannel_id schid;
779e6e1c 277 unsigned long sch_token; /* QEBSM facility */
8129ee16 278
1da177e4
LT
279 enum qdio_irq_states state;
280
779e6e1c 281 struct siga_flag siga_flag; /* siga sync information from qdioac */
1da177e4 282
779e6e1c
JG
283 int nr_input_qs;
284 int nr_output_qs;
1da177e4
LT
285
286 struct ccw1 ccw;
1da177e4
LT
287 struct ciw equeue;
288 struct ciw aqueue;
289
779e6e1c
JG
290 struct qdio_ssqd_desc ssqd_desc;
291
292 void (*orig_handler) (struct ccw_device *, unsigned long, struct irb *);
1da177e4 293
779e6e1c
JG
294 /*
295 * Warning: Leave these members together at the end so they won't be
296 * cleared in qdio_setup_irq.
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;
1da177e4 306};
779e6e1c
JG
307
308/* helper functions */
309#define queue_type(q) q->irq_ptr->qib.qfmt
22f99347 310#define SCH_NO(q) (q->irq_ptr->schid.sch_no)
779e6e1c
JG
311
312#define is_thinint_irq(irq) \
313 (irq->qib.qfmt == QDIO_IQDIO_QFMT || \
314 css_general_characteristics.aif_osa)
315
316/* the highest iqdio queue is used for multicast */
317static inline int multicast_outbound(struct qdio_q *q)
318{
319 return (q->irq_ptr->nr_output_qs > 1) &&
320 (q->nr == q->irq_ptr->nr_output_qs - 1);
321}
322
323static inline unsigned long long get_usecs(void)
324{
325 return monotonic_clock() >> 12;
326}
327
328#define pci_out_supported(q) \
329 (q->irq_ptr->qib.ac & QIB_AC_OUTBOUND_PCI_SUPPORTED)
330#define is_qebsm(q) (q->irq_ptr->sch_token != 0)
331
332#define need_siga_sync_thinint(q) (!q->irq_ptr->siga_flag.no_sync_ti)
333#define need_siga_sync_out_thinint(q) (!q->irq_ptr->siga_flag.no_sync_out_ti)
334#define need_siga_in(q) (q->irq_ptr->siga_flag.input)
335#define need_siga_out(q) (q->irq_ptr->siga_flag.output)
336#define need_siga_sync(q) (q->irq_ptr->siga_flag.sync)
337#define siga_syncs_out_pci(q) (q->irq_ptr->siga_flag.no_sync_out_pci)
338
339#define for_each_input_queue(irq_ptr, q, i) \
340 for (i = 0, q = irq_ptr->input_qs[0]; \
341 i < irq_ptr->nr_input_qs; \
342 q = irq_ptr->input_qs[++i])
343#define for_each_output_queue(irq_ptr, q, i) \
344 for (i = 0, q = irq_ptr->output_qs[0]; \
345 i < irq_ptr->nr_output_qs; \
346 q = irq_ptr->output_qs[++i])
347
348#define prev_buf(bufnr) \
349 ((bufnr + QDIO_MAX_BUFFERS_MASK) & QDIO_MAX_BUFFERS_MASK)
350#define next_buf(bufnr) \
351 ((bufnr + 1) & QDIO_MAX_BUFFERS_MASK)
352#define add_buf(bufnr, inc) \
353 ((bufnr + inc) & QDIO_MAX_BUFFERS_MASK)
354
355/* prototypes for thin interrupt */
356void qdio_sync_after_thinint(struct qdio_q *q);
357int get_buf_state(struct qdio_q *q, unsigned int bufnr, unsigned char *state);
358void qdio_check_outbound_after_thinint(struct qdio_q *q);
359int qdio_inbound_q_moved(struct qdio_q *q);
360void qdio_kick_inbound_handler(struct qdio_q *q);
361void qdio_stop_polling(struct qdio_q *q);
362int qdio_siga_sync_q(struct qdio_q *q);
363
364void qdio_setup_thinint(struct qdio_irq *irq_ptr);
365int qdio_establish_thinint(struct qdio_irq *irq_ptr);
366void qdio_shutdown_thinint(struct qdio_irq *irq_ptr);
367void tiqdio_add_input_queues(struct qdio_irq *irq_ptr);
368void tiqdio_remove_input_queues(struct qdio_irq *irq_ptr);
369void tiqdio_inbound_processing(unsigned long q);
370int tiqdio_allocate_memory(void);
371void tiqdio_free_memory(void);
372int tiqdio_register_thinints(void);
373void tiqdio_unregister_thinints(void);
374
375/* prototypes for setup */
376void qdio_inbound_processing(unsigned long data);
377void qdio_outbound_processing(unsigned long data);
378void qdio_outbound_timer(unsigned long data);
379void qdio_int_handler(struct ccw_device *cdev, unsigned long intparm,
380 struct irb *irb);
381int qdio_allocate_qs(struct qdio_irq *irq_ptr, int nr_input_qs,
382 int nr_output_qs);
383void qdio_setup_ssqd_info(struct qdio_irq *irq_ptr);
bbd50e17
JG
384int qdio_setup_get_ssqd(struct qdio_irq *irq_ptr,
385 struct subchannel_id *schid,
386 struct qdio_ssqd_desc *data);
779e6e1c
JG
387int qdio_setup_irq(struct qdio_initialize *init_data);
388void qdio_print_subchannel_info(struct qdio_irq *irq_ptr,
389 struct ccw_device *cdev);
390void qdio_release_memory(struct qdio_irq *irq_ptr);
391int qdio_setup_init(void);
392void qdio_setup_exit(void);
393
394#endif /* _CIO_QDIO_H */