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