2 * linux/drivers/s390/cio/qdio.h
4 * Copyright 2000,2009 IBM Corp.
5 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
6 * Jan Glauber <jang@linux.vnet.ibm.com>
12 #include <asm/schid.h>
13 #include <asm/debug.h>
16 #define QDIO_BUSY_BIT_PATIENCE 100 /* 100 microseconds */
17 #define QDIO_INPUT_THRESHOLD 500 /* 500 microseconds */
20 * if an asynchronous HiperSockets queue runs full, the 10 seconds timer wait
21 * till next initiative to give transmitted skbs back to the stack is too long.
22 * Therefore polling is started in case of multicast queue is filled more
25 #define QDIO_IQDIO_POLL_LVL 65 /* HS multicast queue */
27 enum qdio_irq_states {
28 QDIO_IRQ_STATE_INACTIVE,
29 QDIO_IRQ_STATE_ESTABLISHED,
30 QDIO_IRQ_STATE_ACTIVE,
31 QDIO_IRQ_STATE_STOPPED,
32 QDIO_IRQ_STATE_CLEANUP,
37 /* used as intparm in do_IO */
38 #define QDIO_DOING_ESTABLISH 1
39 #define QDIO_DOING_ACTIVATE 2
40 #define QDIO_DOING_CLEANUP 3
42 #define SLSB_STATE_NOT_INIT 0x0
43 #define SLSB_STATE_EMPTY 0x1
44 #define SLSB_STATE_PRIMED 0x2
45 #define SLSB_STATE_HALTED 0xe
46 #define SLSB_STATE_ERROR 0xf
47 #define SLSB_TYPE_INPUT 0x0
48 #define SLSB_TYPE_OUTPUT 0x20
49 #define SLSB_OWNER_PROG 0x80
50 #define SLSB_OWNER_CU 0x40
52 #define SLSB_P_INPUT_NOT_INIT \
53 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_NOT_INIT) /* 0x80 */
54 #define SLSB_P_INPUT_ACK \
55 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x81 */
56 #define SLSB_CU_INPUT_EMPTY \
57 (SLSB_OWNER_CU | SLSB_TYPE_INPUT | SLSB_STATE_EMPTY) /* 0x41 */
58 #define SLSB_P_INPUT_PRIMED \
59 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_PRIMED) /* 0x82 */
60 #define SLSB_P_INPUT_HALTED \
61 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_HALTED) /* 0x8e */
62 #define SLSB_P_INPUT_ERROR \
63 (SLSB_OWNER_PROG | SLSB_TYPE_INPUT | SLSB_STATE_ERROR) /* 0x8f */
64 #define SLSB_P_OUTPUT_NOT_INIT \
65 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_NOT_INIT) /* 0xa0 */
66 #define SLSB_P_OUTPUT_EMPTY \
67 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_EMPTY) /* 0xa1 */
68 #define SLSB_CU_OUTPUT_PRIMED \
69 (SLSB_OWNER_CU | SLSB_TYPE_OUTPUT | SLSB_STATE_PRIMED) /* 0x62 */
70 #define SLSB_P_OUTPUT_HALTED \
71 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_HALTED) /* 0xae */
72 #define SLSB_P_OUTPUT_ERROR \
73 (SLSB_OWNER_PROG | SLSB_TYPE_OUTPUT | SLSB_STATE_ERROR) /* 0xaf */
75 #define SLSB_ERROR_DURING_LOOKUP 0xff
77 /* additional CIWs returned by extended Sense-ID */
78 #define CIW_TYPE_EQUEUE 0x3 /* establish QDIO queues */
79 #define CIW_TYPE_AQUEUE 0x4 /* activate QDIO queues */
81 /* flags for st qdio sch data */
82 #define CHSC_FLAG_QDIO_CAPABILITY 0x80
83 #define CHSC_FLAG_VALIDITY 0x40
85 /* qdio adapter-characteristics-1 flag */
86 #define AC1_SIGA_INPUT_NEEDED 0x40 /* process input queues */
87 #define AC1_SIGA_OUTPUT_NEEDED 0x20 /* process output queues */
88 #define AC1_SIGA_SYNC_NEEDED 0x10 /* ask hypervisor to sync */
89 #define AC1_AUTOMATIC_SYNC_ON_THININT 0x08 /* set by hypervisor */
90 #define AC1_AUTOMATIC_SYNC_ON_OUT_PCI 0x04 /* set by hypervisor */
91 #define AC1_SC_QEBSM_AVAILABLE 0x02 /* available for subchannel */
92 #define AC1_SC_QEBSM_ENABLED 0x01 /* enabled for subchannel */
95 static inline int do_sqbs(u64 token, unsigned char state, int queue,
96 int *start, int *count)
98 register unsigned long _ccq asm ("0") = *count;
99 register unsigned long _token asm ("1") = token;
100 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
103 " .insn rsy,0xeb000000008A,%1,0,0(%2)"
104 : "+d" (_ccq), "+d" (_queuestart)
105 : "d" ((unsigned long)state), "d" (_token)
107 *count = _ccq & 0xff;
108 *start = _queuestart & 0xff;
110 return (_ccq >> 32) & 0xff;
113 static inline int do_eqbs(u64 token, unsigned char *state, int queue,
114 int *start, int *count, int ack)
116 register unsigned long _ccq asm ("0") = *count;
117 register unsigned long _token asm ("1") = token;
118 unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
119 unsigned long _state = (unsigned long)ack << 63;
122 " .insn rrf,0xB99c0000,%1,%2,0,0"
123 : "+d" (_ccq), "+d" (_queuestart), "+d" (_state)
126 *count = _ccq & 0xff;
127 *start = _queuestart & 0xff;
128 *state = _state & 0xff;
130 return (_ccq >> 32) & 0xff;
133 static inline int do_sqbs(u64 token, unsigned char state, int queue,
134 int *start, int *count) { return 0; }
135 static inline int do_eqbs(u64 token, unsigned char *state, int queue,
136 int *start, int *count, int ack) { return 0; }
137 #endif /* CONFIG_64BIT */
147 u8 no_sync_out_pci:1;
149 } __attribute__ ((packed));
151 struct chsc_ssqd_area {
152 struct chsc_header request;
160 struct chsc_header response;
162 struct qdio_ssqd_desc qdio_ssqd;
163 } __attribute__ ((packed));
166 struct chsc_header request;
171 u64 summary_indicator_addr;
172 u64 subchannel_indicator_addr;
179 struct subchannel_id schid;
181 struct chsc_header response;
183 } __attribute__ ((packed));
185 struct qdio_dev_perf_stat {
186 unsigned int adapter_int;
187 unsigned int qdio_int;
188 unsigned int pci_request_int;
190 unsigned int tasklet_inbound;
191 unsigned int tasklet_inbound_resched;
192 unsigned int tasklet_inbound_resched2;
193 unsigned int tasklet_outbound;
195 unsigned int siga_read;
196 unsigned int siga_write;
197 unsigned int siga_sync;
199 unsigned int inbound_call;
200 unsigned int inbound_handler;
201 unsigned int stop_polling;
202 unsigned int inbound_queue_full;
203 unsigned int outbound_call;
204 unsigned int outbound_handler;
205 unsigned int fast_requeue;
206 unsigned int target_full;
208 unsigned int eqbs_partial;
210 unsigned int sqbs_partial;
213 struct qdio_input_q {
214 /* input buffer acknowledgement flag */
217 /* first ACK'ed buffer */
220 /* how much sbals are acknowledged with qebsm */
223 /* last time of noticing incoming data */
227 struct qdio_output_q {
228 /* PCIs are enabled for the queue */
231 /* IQDIO: output multiple buffers (enhanced SIGA) */
234 /* timer to check for more outbound work */
235 struct timer_list timer;
241 struct qdio_input_q in;
242 struct qdio_output_q out;
248 /* bitmask of queue number */
251 /* input or output queue */
254 /* list of thinint input queues */
255 struct list_head entry;
257 /* upper-layer program handler */
258 qdio_handler_t (*handler);
261 * inbound: next buffer the program should check for
262 * outbound: next buffer to check for having been processed
267 /* first_to_check of the last time */
270 /* beginning position for calling the program */
273 /* number of buffers in use by the adapter */
274 atomic_t nr_buf_used;
276 struct qdio_irq *irq_ptr;
277 struct dentry *debugfs_q;
278 struct tasklet_struct tasklet;
280 /* error condition during a data transfer */
281 unsigned int qdio_error;
284 struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
287 * Warning: Leave this member at the end so it won't be cleared in
288 * qdio_fill_qs. A page is allocated under this pointer and used for
289 * slib and sl. slib is 2048 bytes big and sl points to offset
293 } __attribute__ ((aligned(256)));
297 u32 *dsci; /* address of device state change indicator */
298 struct ccw_device *cdev;
299 struct dentry *debugfs_dev;
300 struct dentry *debugfs_perf;
302 unsigned long int_parm;
303 struct subchannel_id schid;
304 unsigned long sch_token; /* QEBSM facility */
306 enum qdio_irq_states state;
308 struct siga_flag siga_flag; /* siga sync information from qdioac */
317 struct qdio_ssqd_desc ssqd_desc;
318 void (*orig_handler) (struct ccw_device *, unsigned long, struct irb *);
320 struct qdio_dev_perf_stat perf_stat;
321 int perf_stat_enabled;
323 * Warning: Leave these members together at the end so they won't be
324 * cleared in qdio_setup_irq.
327 unsigned long chsc_page;
329 struct qdio_q *input_qs[QDIO_MAX_QUEUES_PER_IRQ];
330 struct qdio_q *output_qs[QDIO_MAX_QUEUES_PER_IRQ];
332 debug_info_t *debug_area;
333 struct mutex setup_mutex;
336 /* helper functions */
337 #define queue_type(q) q->irq_ptr->qib.qfmt
338 #define SCH_NO(q) (q->irq_ptr->schid.sch_no)
340 #define is_thinint_irq(irq) \
341 (irq->qib.qfmt == QDIO_IQDIO_QFMT || \
342 css_general_characteristics.aif_osa)
344 #define qperf(qdev,attr) qdev->perf_stat.attr
345 #define qperf_inc(q,attr) if (q->irq_ptr->perf_stat_enabled) \
346 q->irq_ptr->perf_stat.attr++
348 /* the highest iqdio queue is used for multicast */
349 static inline int multicast_outbound(struct qdio_q *q)
351 return (q->irq_ptr->nr_output_qs > 1) &&
352 (q->nr == q->irq_ptr->nr_output_qs - 1);
355 static inline unsigned long long get_usecs(void)
357 return monotonic_clock() >> 12;
360 #define pci_out_supported(q) \
361 (q->irq_ptr->qib.ac & QIB_AC_OUTBOUND_PCI_SUPPORTED)
362 #define is_qebsm(q) (q->irq_ptr->sch_token != 0)
364 #define need_siga_sync_thinint(q) (!q->irq_ptr->siga_flag.no_sync_ti)
365 #define need_siga_sync_out_thinint(q) (!q->irq_ptr->siga_flag.no_sync_out_ti)
366 #define need_siga_in(q) (q->irq_ptr->siga_flag.input)
367 #define need_siga_out(q) (q->irq_ptr->siga_flag.output)
368 #define need_siga_sync(q) (q->irq_ptr->siga_flag.sync)
369 #define siga_syncs_out_pci(q) (q->irq_ptr->siga_flag.no_sync_out_pci)
371 #define for_each_input_queue(irq_ptr, q, i) \
372 for (i = 0, q = irq_ptr->input_qs[0]; \
373 i < irq_ptr->nr_input_qs; \
374 q = irq_ptr->input_qs[++i])
375 #define for_each_output_queue(irq_ptr, q, i) \
376 for (i = 0, q = irq_ptr->output_qs[0]; \
377 i < irq_ptr->nr_output_qs; \
378 q = irq_ptr->output_qs[++i])
380 #define prev_buf(bufnr) \
381 ((bufnr + QDIO_MAX_BUFFERS_MASK) & QDIO_MAX_BUFFERS_MASK)
382 #define next_buf(bufnr) \
383 ((bufnr + 1) & QDIO_MAX_BUFFERS_MASK)
384 #define add_buf(bufnr, inc) \
385 ((bufnr + inc) & QDIO_MAX_BUFFERS_MASK)
386 #define sub_buf(bufnr, dec) \
387 ((bufnr - dec) & QDIO_MAX_BUFFERS_MASK)
389 /* prototypes for thin interrupt */
390 void qdio_setup_thinint(struct qdio_irq *irq_ptr);
391 int qdio_establish_thinint(struct qdio_irq *irq_ptr);
392 void qdio_shutdown_thinint(struct qdio_irq *irq_ptr);
393 void tiqdio_add_input_queues(struct qdio_irq *irq_ptr);
394 void tiqdio_remove_input_queues(struct qdio_irq *irq_ptr);
395 void tiqdio_inbound_processing(unsigned long q);
396 int tiqdio_allocate_memory(void);
397 void tiqdio_free_memory(void);
398 int tiqdio_register_thinints(void);
399 void tiqdio_unregister_thinints(void);
401 /* prototypes for setup */
402 void qdio_inbound_processing(unsigned long data);
403 void qdio_outbound_processing(unsigned long data);
404 void qdio_outbound_timer(unsigned long data);
405 void qdio_int_handler(struct ccw_device *cdev, unsigned long intparm,
407 int qdio_allocate_qs(struct qdio_irq *irq_ptr, int nr_input_qs,
409 void qdio_setup_ssqd_info(struct qdio_irq *irq_ptr);
410 int qdio_setup_get_ssqd(struct qdio_irq *irq_ptr,
411 struct subchannel_id *schid,
412 struct qdio_ssqd_desc *data);
413 int qdio_setup_irq(struct qdio_initialize *init_data);
414 void qdio_print_subchannel_info(struct qdio_irq *irq_ptr,
415 struct ccw_device *cdev);
416 void qdio_release_memory(struct qdio_irq *irq_ptr);
417 int qdio_setup_create_sysfs(struct ccw_device *cdev);
418 void qdio_setup_destroy_sysfs(struct ccw_device *cdev);
419 int qdio_setup_init(void);
420 void qdio_setup_exit(void);
422 int debug_get_buf_state(struct qdio_q *q, unsigned int bufnr,
423 unsigned char *state);
424 #endif /* _CIO_QDIO_H */