blob: c1a70985abfaf7d877fa60d4d6f72a78640cf5e9 [file] [log] [blame]
Jan Glauber779e6e12008-07-17 17:16:48 +02001/*
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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#ifndef _CIO_QDIO_H
9#define _CIO_QDIO_H
10
Peter Oberparleiter0b642ed2005-05-01 08:58:58 -070011#include <asm/page.h>
Cornelia Huck9d92a7e2008-07-14 09:59:05 +020012#include <asm/schid.h>
Jan Glauber779e6e12008-07-17 17:16:48 +020013#include "chsc.h"
Cornelia Hucka8237fc2006-01-06 00:19:21 -080014
Jan Glauber779e6e12008-07-17 17:16:48 +020015#define QDIO_BUSY_BIT_PATIENCE 100 /* 100 microseconds */
16#define QDIO_BUSY_BIT_GIVE_UP 2000000 /* 2 seconds = eternity */
17#define QDIO_INPUT_THRESHOLD 500 /* 500 microseconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19enum 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
Jan Glauber779e6e12008-07-17 17:16:48 +020029/* used as intparm in do_IO */
30#define QDIO_DOING_ESTABLISH 1
31#define QDIO_DOING_ACTIVATE 2
32#define QDIO_DOING_CLEANUP 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Jan Glauber779e6e12008-07-17 17:16:48 +020034#define SLSB_STATE_NOT_INIT 0x0
35#define SLSB_STATE_EMPTY 0x1
36#define SLSB_STATE_PRIMED 0x2
37#define SLSB_STATE_HALTED 0xe
38#define SLSB_STATE_ERROR 0xf
39#define SLSB_TYPE_INPUT 0x0
40#define SLSB_TYPE_OUTPUT 0x20
41#define SLSB_OWNER_PROG 0x80
42#define SLSB_OWNER_CU 0x40
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Jan Glauber779e6e12008-07-17 17:16:48 +020044#define SLSB_P_INPUT_NOT_INIT \
45 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_NOT_INIT) /* 0x80 */
46#define SLSB_P_INPUT_ACK \
47 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x81 */
48#define SLSB_CU_INPUT_EMPTY \
49 (SLSB_OWNER_CU | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x41 */
50#define SLSB_P_INPUT_PRIMED \
51 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_PRIMED) /* 0x82 */
52#define SLSB_P_INPUT_HALTED \
53 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_HALTED) /* 0x8e */
54#define SLSB_P_INPUT_ERROR \
55 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_ERROR) /* 0x8f */
56#define SLSB_P_OUTPUT_NOT_INIT \
57 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_NOT_INIT) /* 0xa0 */
58#define SLSB_P_OUTPUT_EMPTY \
59 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_EMPTY) /* 0xa1 */
60#define SLSB_CU_OUTPUT_PRIMED \
61 (SLSB_OWNER_CU | SLSB_TYPE_OUTPUT | SLSB_STATE_PRIMED) /* 0x62 */
62#define SLSB_P_OUTPUT_HALTED \
63 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_HALTED) /* 0xae */
64#define SLSB_P_OUTPUT_ERROR \
65 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_ERROR) /* 0xaf */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Jan Glauber779e6e12008-07-17 17:16:48 +020067#define SLSB_ERROR_DURING_LOOKUP 0xff
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Jan Glauber779e6e12008-07-17 17:16:48 +020069/* additional CIWs returned by extended Sense-ID */
70#define CIW_TYPE_EQUEUE 0x3 /* establish QDIO queues */
71#define CIW_TYPE_AQUEUE 0x4 /* activate QDIO queues */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
Jan Glauber779e6e12008-07-17 17:16:48 +020073/* flags for st qdio sch data */
74#define CHSC_FLAG_QDIO_CAPABILITY 0x80
75#define CHSC_FLAG_VALIDITY 0x40
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Jan Glauber779e6e12008-07-17 17:16:48 +020077/* qdio adapter-characteristics-1 flag */
78#define AC1_SIGA_INPUT_NEEDED 0x40 /* process input queues */
79#define AC1_SIGA_OUTPUT_NEEDED 0x20 /* process output queues */
80#define AC1_SIGA_SYNC_NEEDED 0x10 /* ask hypervisor to sync */
81#define AC1_AUTOMATIC_SYNC_ON_THININT 0x08 /* set by hypervisor */
82#define AC1_AUTOMATIC_SYNC_ON_OUT_PCI 0x04 /* set by hypervisor */
83#define AC1_SC_QEBSM_AVAILABLE 0x02 /* available for subchannel */
84#define AC1_SC_QEBSM_ENABLED 0x01 /* enabled for subchannel */
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Martin Schwidefsky347a8dc2006-01-06 00:19:28 -080086#ifdef CONFIG_64BIT
Jan Glauber779e6e12008-07-17 17:16:48 +020087static inline int do_sqbs(u64 token, unsigned char state, int queue,
88 int *start, int *count)
89{
90 register unsigned long _ccq asm ("0") = *count;
91 register unsigned long _token asm ("1") = token;
92 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
Frank Pavlic8129ee12006-01-06 00:19:20 -080093
Jan Glauber779e6e12008-07-17 17:16:48 +020094 asm volatile(
95 " .insn rsy,0xeb000000008A,%1,0,0(%2)"
96 : "+d" (_ccq), "+d" (_queuestart)
97 : "d" ((unsigned long)state), "d" (_token)
98 : "memory", "cc");
99 *count = _ccq & 0xff;
100 *start = _queuestart & 0xff;
Frank Pavlic8129ee12006-01-06 00:19:20 -0800101
Jan Glauber779e6e12008-07-17 17:16:48 +0200102 return (_ccq >> 32) & 0xff;
Frank Pavlic8129ee12006-01-06 00:19:20 -0800103}
104
Jan Glauber779e6e12008-07-17 17:16:48 +0200105static inline int do_eqbs(u64 token, unsigned char *state, int queue,
106 int *start, int *count)
Frank Pavlic8129ee12006-01-06 00:19:20 -0800107{
Frank Pavlic8129ee12006-01-06 00:19:20 -0800108 register unsigned long _ccq asm ("0") = *count;
Jan Glauber779e6e12008-07-17 17:16:48 +0200109 register unsigned long _token asm ("1") = token;
Frank Pavlic8129ee12006-01-06 00:19:20 -0800110 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
111 unsigned long _state = 0;
112
Martin Schwidefsky94c12cc2006-09-28 16:56:43 +0200113 asm volatile(
114 " .insn rrf,0xB99c0000,%1,%2,0,0"
115 : "+d" (_ccq), "+d" (_queuestart), "+d" (_state)
Jan Glauber779e6e12008-07-17 17:16:48 +0200116 : "d" (_token)
117 : "memory", "cc");
Frank Pavlic8129ee12006-01-06 00:19:20 -0800118 *count = _ccq & 0xff;
119 *start = _queuestart & 0xff;
120 *state = _state & 0xff;
121
122 return (_ccq >> 32) & 0xff;
Jan Glauber779e6e12008-07-17 17:16:48 +0200123}
Frank Pavlic8129ee12006-01-06 00:19:20 -0800124#else
Jan Glauber779e6e12008-07-17 17:16:48 +0200125static inline int do_sqbs(u64 token, unsigned char state, int queue,
126 int *start, int *count) { return 0; }
127static inline int do_eqbs(u64 token, unsigned char *state, int queue,
128 int *start, int *count) { return 0; }
129#endif /* CONFIG_64BIT */
Frank Pavlic8129ee12006-01-06 00:19:20 -0800130
Jan Glauber779e6e12008-07-17 17:16:48 +0200131struct qdio_irq;
Frank Pavlic8129ee12006-01-06 00:19:20 -0800132
Jan Glauber779e6e12008-07-17 17:16:48 +0200133struct siga_flag {
134 u8 input:1;
135 u8 output:1;
136 u8 sync:1;
137 u8 no_sync_ti:1;
138 u8 no_sync_out_ti:1;
139 u8 no_sync_out_pci:1;
140 u8:2;
141} __attribute__ ((packed));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Jan Glauber779e6e12008-07-17 17:16:48 +0200143struct chsc_ssqd_area {
Ursula Braune1776852008-04-17 07:46:22 +0200144 struct chsc_header request;
Jan Glauber779e6e12008-07-17 17:16:48 +0200145 u16:10;
146 u8 ssid:2;
147 u8 fmt:4;
Ursula Braune1776852008-04-17 07:46:22 +0200148 u16 first_sch;
Jan Glauber779e6e12008-07-17 17:16:48 +0200149 u16:16;
Ursula Braune1776852008-04-17 07:46:22 +0200150 u16 last_sch;
Jan Glauber779e6e12008-07-17 17:16:48 +0200151 u32:32;
Ursula Braune1776852008-04-17 07:46:22 +0200152 struct chsc_header response;
Jan Glauber779e6e12008-07-17 17:16:48 +0200153 u32:32;
154 struct qdio_ssqd_desc qdio_ssqd;
155} __attribute__ ((packed));
156
157struct scssc_area {
158 struct chsc_header request;
159 u16 operation_code;
160 u16:16;
161 u32:32;
162 u32:32;
163 u64 summary_indicator_addr;
164 u64 subchannel_indicator_addr;
165 u32 ks:4;
166 u32 kc:4;
167 u32:21;
168 u32 isc:3;
169 u32 word_with_d_bit;
170 u32:32;
171 struct subchannel_id schid;
172 u32 reserved[1004];
173 struct chsc_header response;
174 u32:32;
175} __attribute__ ((packed));
176
177struct qdio_input_q {
178 /* input buffer acknowledgement flag */
179 int polling;
180
181 /* last time of noticing incoming data */
182 u64 timestamp;
183
184 /* lock for clearing the acknowledgement */
185 spinlock_t lock;
Ursula Braune1776852008-04-17 07:46:22 +0200186};
187
Jan Glauber779e6e12008-07-17 17:16:48 +0200188struct qdio_output_q {
189 /* failed siga-w attempts*/
190 atomic_t busy_siga_counter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Jan Glauber779e6e12008-07-17 17:16:48 +0200192 /* start time of busy condition */
193 u64 timestamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Jan Glauber779e6e12008-07-17 17:16:48 +0200195 /* PCIs are enabled for the queue */
196 int pci_out_enabled;
Ursula Braun00c0c642007-05-04 18:47:49 +0200197
Jan Glauber779e6e12008-07-17 17:16:48 +0200198 /* timer to check for more outbound work */
199 struct timer_list timer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202struct qdio_q {
Jan Glauber779e6e12008-07-17 17:16:48 +0200203 struct slsb slsb;
204 union {
205 struct qdio_input_q in;
206 struct qdio_output_q out;
207 } u;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
Jan Glauber779e6e12008-07-17 17:16:48 +0200209 /* queue number */
210 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Jan Glauber779e6e12008-07-17 17:16:48 +0200212 /* bitmask of queue number */
213 int mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Jan Glauber779e6e12008-07-17 17:16:48 +0200215 /* input or output queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 int is_input_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Jan Glauber779e6e12008-07-17 17:16:48 +0200218 /* list of thinint input queues */
219 struct list_head entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Jan Glauber779e6e12008-07-17 17:16:48 +0200221 /* upper-layer program handler */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 qdio_handler_t (*handler);
223
Jan Glauber779e6e12008-07-17 17:16:48 +0200224 /*
225 * inbound: next buffer the program should check for
226 * outbound: next buffer to check for having been processed
227 * by the card
228 */
229 int first_to_check;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Jan Glauber779e6e12008-07-17 17:16:48 +0200231 /* first_to_check of the last time */
232 int last_move_ftc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Jan Glauber779e6e12008-07-17 17:16:48 +0200234 /* beginning position for calling the program */
235 int first_to_kick;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Jan Glauber779e6e12008-07-17 17:16:48 +0200237 /* number of buffers in use by the adapter */
238 atomic_t nr_buf_used;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Jan Glauber779e6e12008-07-17 17:16:48 +0200240 struct qdio_irq *irq_ptr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 struct tasklet_struct tasklet;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Jan Glauber779e6e12008-07-17 17:16:48 +0200243 /* error condition during a data transfer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 unsigned int qdio_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246 struct sl *sl;
Jan Glauber779e6e12008-07-17 17:16:48 +0200247 struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Jan Glauber779e6e12008-07-17 17:16:48 +0200249 /*
250 * Warning: Leave this member at the end so it won't be cleared in
251 * qdio_fill_qs. A page is allocated under this pointer and used for
252 * slib and sl. slib is 2048 bytes big and sl points to offset
253 * PAGE_SIZE / 2.
254 */
255 struct slib *slib;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256} __attribute__ ((aligned(256)));
257
258struct qdio_irq {
Jan Glauber779e6e12008-07-17 17:16:48 +0200259 struct qib qib;
260 u32 *dsci; /* address of device state change indicator */
261 struct ccw_device *cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263 unsigned long int_parm;
Cornelia Hucka8237fc2006-01-06 00:19:21 -0800264 struct subchannel_id schid;
Jan Glauber779e6e12008-07-17 17:16:48 +0200265 unsigned long sch_token; /* QEBSM facility */
Frank Pavlic8129ee12006-01-06 00:19:20 -0800266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 enum qdio_irq_states state;
268
Jan Glauber779e6e12008-07-17 17:16:48 +0200269 struct siga_flag siga_flag; /* siga sync information from qdioac */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Jan Glauber779e6e12008-07-17 17:16:48 +0200271 int nr_input_qs;
272 int nr_output_qs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
274 struct ccw1 ccw;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 struct ciw equeue;
276 struct ciw aqueue;
277
Jan Glauber779e6e12008-07-17 17:16:48 +0200278 struct qdio_ssqd_desc ssqd_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Jan Glauber779e6e12008-07-17 17:16:48 +0200280 void (*orig_handler) (struct ccw_device *, unsigned long, struct irb *);
281
282 /*
283 * Warning: Leave these members together at the end so they won't be
284 * cleared in qdio_setup_irq.
285 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 struct qdr *qdr;
Jan Glauber779e6e12008-07-17 17:16:48 +0200287 unsigned long chsc_page;
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct qdio_q *input_qs[QDIO_MAX_QUEUES_PER_IRQ];
290 struct qdio_q *output_qs[QDIO_MAX_QUEUES_PER_IRQ];
Jan Glauber779e6e12008-07-17 17:16:48 +0200291
292 struct mutex setup_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293};
Jan Glauber779e6e12008-07-17 17:16:48 +0200294
295/* helper functions */
296#define queue_type(q) q->irq_ptr->qib.qfmt
297
298#define is_thinint_irq(irq) \
299 (irq->qib.qfmt == QDIO_IQDIO_QFMT || \
300 css_general_characteristics.aif_osa)
301
302/* the highest iqdio queue is used for multicast */
303static inline int multicast_outbound(struct qdio_q *q)
304{
305 return (q->irq_ptr->nr_output_qs > 1) &&
306 (q->nr == q->irq_ptr->nr_output_qs - 1);
307}
308
309static inline unsigned long long get_usecs(void)
310{
311 return monotonic_clock() >> 12;
312}
313
314#define pci_out_supported(q) \
315 (q->irq_ptr->qib.ac & QIB_AC_OUTBOUND_PCI_SUPPORTED)
316#define is_qebsm(q) (q->irq_ptr->sch_token != 0)
317
318#define need_siga_sync_thinint(q) (!q->irq_ptr->siga_flag.no_sync_ti)
319#define need_siga_sync_out_thinint(q) (!q->irq_ptr->siga_flag.no_sync_out_ti)
320#define need_siga_in(q) (q->irq_ptr->siga_flag.input)
321#define need_siga_out(q) (q->irq_ptr->siga_flag.output)
322#define need_siga_sync(q) (q->irq_ptr->siga_flag.sync)
323#define siga_syncs_out_pci(q) (q->irq_ptr->siga_flag.no_sync_out_pci)
324
325#define for_each_input_queue(irq_ptr, q, i) \
326 for (i = 0, q = irq_ptr->input_qs[0]; \
327 i < irq_ptr->nr_input_qs; \
328 q = irq_ptr->input_qs[++i])
329#define for_each_output_queue(irq_ptr, q, i) \
330 for (i = 0, q = irq_ptr->output_qs[0]; \
331 i < irq_ptr->nr_output_qs; \
332 q = irq_ptr->output_qs[++i])
333
334#define prev_buf(bufnr) \
335 ((bufnr + QDIO_MAX_BUFFERS_MASK) & QDIO_MAX_BUFFERS_MASK)
336#define next_buf(bufnr) \
337 ((bufnr + 1) & QDIO_MAX_BUFFERS_MASK)
338#define add_buf(bufnr, inc) \
339 ((bufnr + inc) & QDIO_MAX_BUFFERS_MASK)
340
341/* prototypes for thin interrupt */
342void qdio_sync_after_thinint(struct qdio_q *q);
343int get_buf_state(struct qdio_q *q, unsigned int bufnr, unsigned char *state);
344void qdio_check_outbound_after_thinint(struct qdio_q *q);
345int qdio_inbound_q_moved(struct qdio_q *q);
346void qdio_kick_inbound_handler(struct qdio_q *q);
347void qdio_stop_polling(struct qdio_q *q);
348int qdio_siga_sync_q(struct qdio_q *q);
349
350void qdio_setup_thinint(struct qdio_irq *irq_ptr);
351int qdio_establish_thinint(struct qdio_irq *irq_ptr);
352void qdio_shutdown_thinint(struct qdio_irq *irq_ptr);
353void tiqdio_add_input_queues(struct qdio_irq *irq_ptr);
354void tiqdio_remove_input_queues(struct qdio_irq *irq_ptr);
355void tiqdio_inbound_processing(unsigned long q);
356int tiqdio_allocate_memory(void);
357void tiqdio_free_memory(void);
358int tiqdio_register_thinints(void);
359void tiqdio_unregister_thinints(void);
360
361/* prototypes for setup */
362void qdio_inbound_processing(unsigned long data);
363void qdio_outbound_processing(unsigned long data);
364void qdio_outbound_timer(unsigned long data);
365void qdio_int_handler(struct ccw_device *cdev, unsigned long intparm,
366 struct irb *irb);
367int qdio_allocate_qs(struct qdio_irq *irq_ptr, int nr_input_qs,
368 int nr_output_qs);
369void qdio_setup_ssqd_info(struct qdio_irq *irq_ptr);
370int qdio_setup_irq(struct qdio_initialize *init_data);
371void qdio_print_subchannel_info(struct qdio_irq *irq_ptr,
372 struct ccw_device *cdev);
373void qdio_release_memory(struct qdio_irq *irq_ptr);
374int qdio_setup_init(void);
375void qdio_setup_exit(void);
376
377#endif /* _CIO_QDIO_H */