drivers/s390/cio/qdio.h

   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_queue_irq_states {
 181         QDIO_QUEUE_IRQS_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         /* upper-layer polling flag */
 192         unsigned long queue_irq_state;
 193         /* callback to start upper-layer polling */
 194         void (*queue_start_poll) (struct ccw_device *, int, unsigned long);
 195 };
 196
 197 struct qdio_output_q {
 198         /* PCIs are enabled for the queue */
 199         int pci_out_enabled;
 200         /* cq: use asynchronous output buffers */
 201         int use_cq;
 202         /* cq: aobs used for particual SBAL */
 203         struct qaob **aobs;
 204         /* cq: sbal state related to asynchronous operation */
 205         struct qdio_outbuf_state *sbal_state;
 206         /* timer to check for more outbound work */
 207         struct timer_list timer;
 208 };
 209
 210 /*
 211  * Note on cache alignment: grouped slsb and write mostly data at the beginning
 212  * sbal[] is read-only and starts on a new cacheline followed by read mostly.
 213  */
 214 struct qdio_q {
 215         struct slsb slsb;
 216
 217         union {
 218                 struct qdio_input_q in;
 219                 struct qdio_output_q out;
 220         } u;
 221
 222         /*
 223          * inbound: next buffer the program should check for
 224          * outbound: next buffer to check if adapter processed it
 225          */
 226         int first_to_check;
 227
 228         /* beginning position for calling the program */
 229         int first_to_kick;
 230
 231         /* number of buffers in use by the adapter */
 232         atomic_t nr_buf_used;
 233
 234         /* error condition during a data transfer */
 235         unsigned int qdio_error;
 236
 237         /* last scan of the queue */
 238         u64 timestamp;
 239
 240         struct tasklet_struct tasklet;
 241         struct qdio_queue_perf_stat q_stats;
 242
 243         struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q] ____cacheline_aligned;
 244
 245         /* queue number */
 246         int nr;
 247
 248         /* bitmask of queue number */
 249         int mask;
 250
 251         /* input or output queue */
 252         int is_input_q;
 253
 254         /* upper-layer program handler */
 255         qdio_handler_t (*handler);
 256
 257         struct dentry *debugfs_q;
 258         struct qdio_irq *irq_ptr;
 259         struct sl *sl;
 260         /*
 261          * A page is allocated under this pointer and used for slib and sl.
 262          * slib is 2048 bytes big and sl points to offset PAGE_SIZE / 2.
 263          */
 264         struct slib *slib;
 265 } __attribute__ ((aligned(256)));
 266
 267 struct qdio_irq {
 268         struct qib qib;
 269         u32 *dsci;              /* address of device state change indicator */
 270         struct ccw_device *cdev;
 271         struct list_head entry;         /* list of thinint devices */
 272         struct dentry *debugfs_dev;
 273         struct dentry *debugfs_perf;
 274
 275         unsigned long int_parm;
 276         struct subchannel_id schid;
 277         unsigned long sch_token;        /* QEBSM facility */
 278
 279         enum qdio_irq_states state;
 280
 281         struct siga_flag siga_flag;     /* siga sync information from qdioac */
 282
 283         int nr_input_qs;
 284         int nr_output_qs;
 285
 286         struct ccw1 ccw;
 287         struct ciw equeue;
 288         struct ciw aqueue;
 289
 290         struct qdio_ssqd_desc ssqd_desc;
 291         void (*orig_handler) (struct ccw_device *, unsigned long, struct irb *);
 292
 293         unsigned int scan_threshold;    /* used SBALs before tasklet schedule */
 294         int perf_stat_enabled;
 295
 296         struct qdr *qdr;
 297         unsigned long chsc_page;
 298
 299         struct qdio_q *input_qs[QDIO_MAX_QUEUES_PER_IRQ];
 300         struct qdio_q *output_qs[QDIO_MAX_QUEUES_PER_IRQ];
 301
 302         debug_info_t *debug_area;
 303         struct mutex setup_mutex;
 304         struct qdio_dev_perf_stat perf_stat;
 305 };
 306
 307 /* helper functions */
 308 #define queue_type(q)   q->irq_ptr->qib.qfmt
 309 #define SCH_NO(q)       (q->irq_ptr->schid.sch_no)
 310
 311 #define is_thinint_irq(irq) \
 312         (irq->qib.qfmt == QDIO_IQDIO_QFMT || \
 313          css_general_characteristics.aif_osa)
 314
 315 #define qperf(__qdev, __attr)   ((__qdev)->perf_stat.(__attr))
 316
 317 #define QDIO_PERF_STAT_INC(__irq, __attr)                               \
 318 ({                                                                      \
 319         struct qdio_irq *qdev = __irq;                                  \
 320         if (qdev->perf_stat_enabled)                                    \
 321                 (qdev->perf_stat.__attr)++;                             \
 322 })
 323
 324 #define qperf_inc(__q, __attr)  QDIO_PERF_STAT_INC((__q)->irq_ptr, __attr)
 325
 326 static inline void account_sbals_error(struct qdio_q *q, int count)
 327 {
 328         q->q_stats.nr_sbal_error += count;
 329         q->q_stats.nr_sbal_total += count;
 330 }
 331
 332 /* the highest iqdio queue is used for multicast */
 333 static inline int multicast_outbound(struct qdio_q *q)
 334 {
 335         return (q->irq_ptr->nr_output_qs > 1) &&
 336                (q->nr == q->irq_ptr->nr_output_qs - 1);
 337 }
 338
 339 #define pci_out_supported(irq) ((irq)->qib.ac & QIB_AC_OUTBOUND_PCI_SUPPORTED)
 340 #define is_qebsm(q)                     (q->irq_ptr->sch_token != 0)
 341
 342 #define need_siga_in(q)                 (q->irq_ptr->siga_flag.input)
 343 #define need_siga_out(q)                (q->irq_ptr->siga_flag.output)
 344 #define need_siga_sync(q)               (unlikely(q->irq_ptr->siga_flag.sync))
 345 #define need_siga_sync_after_ai(q)      \
 346         (unlikely(q->irq_ptr->siga_flag.sync_after_ai))
 347 #define need_siga_sync_out_after_pci(q) \
 348         (unlikely(q->irq_ptr->siga_flag.sync_out_after_pci))
 349
 350 #define for_each_input_queue(irq_ptr, q, i)             \
 351         for (i = 0; i < irq_ptr->nr_input_qs &&         \
 352                 ({ q = irq_ptr->input_qs[i]; 1; }); i++)
 353 #define for_each_output_queue(irq_ptr, q, i)            \
 354         for (i = 0; i < irq_ptr->nr_output_qs &&        \
 355                 ({ q = irq_ptr->output_qs[i]; 1; }); i++)
 356
 357 #define add_buf(bufnr, inc)     QDIO_BUFNR((bufnr) + (inc))
 358 #define next_buf(bufnr)         add_buf(bufnr, 1)
 359 #define sub_buf(bufnr, dec)     QDIO_BUFNR((bufnr) - (dec))
 360 #define prev_buf(bufnr)         sub_buf(bufnr, 1)
 361
 362 #define queue_irqs_enabled(q)                   \
 363         (test_bit(QDIO_QUEUE_IRQS_DISABLED, &q->u.in.queue_irq_state) == 0)
 364 #define queue_irqs_disabled(q)                  \
 365         (test_bit(QDIO_QUEUE_IRQS_DISABLED, &q->u.in.queue_irq_state) != 0)
 366
 367 extern u64 last_ai_time;
 368
 369 /* prototypes for thin interrupt */
 370 void qdio_setup_thinint(struct qdio_irq *irq_ptr);
 371 int qdio_establish_thinint(struct qdio_irq *irq_ptr);
 372 void qdio_shutdown_thinint(struct qdio_irq *irq_ptr);
 373 void tiqdio_add_device(struct qdio_irq *irq_ptr);
 374 void tiqdio_remove_device(struct qdio_irq *irq_ptr);
 375 void tiqdio_inbound_processing(unsigned long q);
 376 int tiqdio_allocate_memory(void);
 377 void tiqdio_free_memory(void);
 378 int tiqdio_register_thinints(void);
 379 void tiqdio_unregister_thinints(void);
 380 void clear_nonshared_ind(struct qdio_irq *);
 381 int test_nonshared_ind(struct qdio_irq *);
 382
 383 /* prototypes for setup */
 384 void qdio_inbound_processing(unsigned long data);
 385 void qdio_outbound_processing(unsigned long data);
 386 void qdio_outbound_timer(struct timer_list *t);
 387 void qdio_int_handler(struct ccw_device *cdev, unsigned long intparm,
 388                       struct irb *irb);
 389 int qdio_allocate_qs(struct qdio_irq *irq_ptr, int nr_input_qs,
 390                      int nr_output_qs);
 391 void qdio_setup_ssqd_info(struct qdio_irq *irq_ptr);
 392 int qdio_setup_get_ssqd(struct qdio_irq *irq_ptr,
 393                         struct subchannel_id *schid,
 394                         struct qdio_ssqd_desc *data);
 395 int qdio_setup_irq(struct qdio_initialize *init_data);
 396 void qdio_print_subchannel_info(struct qdio_irq *irq_ptr,
 397                                 struct ccw_device *cdev);
 398 void qdio_release_memory(struct qdio_irq *irq_ptr);
 399 int qdio_setup_create_sysfs(struct ccw_device *cdev);
 400 void qdio_setup_destroy_sysfs(struct ccw_device *cdev);
 401 int qdio_setup_init(void);
 402 void qdio_setup_exit(void);
 403 int qdio_enable_async_operation(struct qdio_output_q *q);
 404 void qdio_disable_async_operation(struct qdio_output_q *q);
 405 struct qaob *qdio_allocate_aob(void);
 406
 407 int debug_get_buf_state(struct qdio_q *q, unsigned int bufnr,
 408                         unsigned char *state);
 409 #endif /* _CIO_QDIO_H */