drivers/s390/cio/qdio.h

   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  */
   8 #ifndef _CIO_QDIO_H
   9 #define _CIO_QDIO_H
  10
  11 #include <asm/page.h>
  12 #include <asm/schid.h>
  13 #include "chsc.h"
  14
  15 #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 */
  18
  19 enum 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
  29 /* used as intparm in do_IO */
  30 #define QDIO_DOING_ESTABLISH    1
  31 #define QDIO_DOING_ACTIVATE     2
  32 #define QDIO_DOING_CLEANUP      3
  33
  34 #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
  43
  44 #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 */
  66
  67 #define SLSB_ERROR_DURING_LOOKUP  0xff
  68
  69 /* 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 */
  72
  73 /* flags for st qdio sch data */
  74 #define CHSC_FLAG_QDIO_CAPABILITY       0x80
  75 #define CHSC_FLAG_VALIDITY              0x40
  76
  77 /* 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 */
  85
  86 #ifdef CONFIG_64BIT
  87 static 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;
  93
  94         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;
 101
 102         return (_ccq >> 32) & 0xff;
 103 }
 104
 105 static inline int do_eqbs(u64 token, unsigned char *state, int queue,
 106                           int *start, int *count)
 107 {
 108         register unsigned long _ccq asm ("0") = *count;
 109         register unsigned long _token asm ("1") = token;
 110         unsigned long _queuestart = ((unsigned long)queue << 32) | *start;
 111         unsigned long _state = 0;
 112
 113         asm volatile(
 114                 "       .insn   rrf,0xB99c0000,%1,%2,0,0"
 115                 : "+d" (_ccq), "+d" (_queuestart), "+d" (_state)
 116                 : "d" (_token)
 117                 : "memory", "cc");
 118         *count = _ccq & 0xff;
 119         *start = _queuestart & 0xff;
 120         *state = _state & 0xff;
 121
 122         return (_ccq >> 32) & 0xff;
 123 }
 124 #else
 125 static inline int do_sqbs(u64 token, unsigned char state, int queue,
 126                           int *start, int *count) { return 0; }
 127 static inline int do_eqbs(u64 token, unsigned char *state, int queue,
 128                           int *start, int *count) { return 0; }
 129 #endif /* CONFIG_64BIT */
 130
 131 struct qdio_irq;
 132
 133 struct 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));
 142
 143 struct chsc_ssqd_area {
 144         struct chsc_header request;
 145         u16:10;
 146         u8 ssid:2;
 147         u8 fmt:4;
 148         u16 first_sch;
 149         u16:16;
 150         u16 last_sch;
 151         u32:32;
 152         struct chsc_header response;
 153         u32:32;
 154         struct qdio_ssqd_desc qdio_ssqd;
 155 } __attribute__ ((packed));
 156
 157 struct 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
 177 struct 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;
 186 };
 187
 188 struct qdio_output_q {
 189         /* failed siga-w attempts*/
 190         atomic_t busy_siga_counter;
 191
 192         /* start time of busy condition */
 193         u64 timestamp;
 194
 195         /* PCIs are enabled for the queue */
 196         int pci_out_enabled;
 197
 198         /* timer to check for more outbound work */
 199         struct timer_list timer;
 200 };
 201
 202 struct qdio_q {
 203         struct slsb slsb;
 204         union {
 205                 struct qdio_input_q in;
 206                 struct qdio_output_q out;
 207         } u;
 208
 209         /* queue number */
 210         int nr;
 211
 212         /* bitmask of queue number */
 213         int mask;
 214
 215         /* input or output queue */
 216         int is_input_q;
 217
 218         /* list of thinint input queues */
 219         struct list_head entry;
 220
 221         /* upper-layer program handler */
 222         qdio_handler_t (*handler);
 223
 224         /*
 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;
 230
 231         /* first_to_check of the last time */
 232         int last_move_ftc;
 233
 234         /* beginning position for calling the program */
 235         int first_to_kick;
 236
 237         /* number of buffers in use by the adapter */
 238         atomic_t nr_buf_used;
 239
 240         struct qdio_irq *irq_ptr;
 241         struct tasklet_struct tasklet;
 242
 243         /* error condition during a data transfer */
 244         unsigned int qdio_error;
 245
 246         struct sl *sl;
 247         struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
 248
 249         /*
 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;
 256 } __attribute__ ((aligned(256)));
 257
 258 struct qdio_irq {
 259         struct qib qib;
 260         u32 *dsci;              /* address of device state change indicator */
 261         struct ccw_device *cdev;
 262
 263         unsigned long int_parm;
 264         struct subchannel_id schid;
 265         unsigned long sch_token;        /* QEBSM facility */
 266
 267         enum qdio_irq_states state;
 268
 269         struct siga_flag siga_flag;     /* siga sync information from qdioac */
 270
 271         int nr_input_qs;
 272         int nr_output_qs;
 273
 274         struct ccw1 ccw;
 275         struct ciw equeue;
 276         struct ciw aqueue;
 277
 278         struct qdio_ssqd_desc ssqd_desc;
 279
 280         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          */
 286         struct qdr *qdr;
 287         unsigned long chsc_page;
 288
 289         struct qdio_q *input_qs[QDIO_MAX_QUEUES_PER_IRQ];
 290         struct qdio_q *output_qs[QDIO_MAX_QUEUES_PER_IRQ];
 291
 292         struct mutex setup_mutex;
 293 };
 294
 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 */
 303 static 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
 309 static 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 */
 342 void qdio_sync_after_thinint(struct qdio_q *q);
 343 int get_buf_state(struct qdio_q *q, unsigned int bufnr, unsigned char *state);
 344 void qdio_check_outbound_after_thinint(struct qdio_q *q);
 345 int qdio_inbound_q_moved(struct qdio_q *q);
 346 void qdio_kick_inbound_handler(struct qdio_q *q);
 347 void qdio_stop_polling(struct qdio_q *q);
 348 int qdio_siga_sync_q(struct qdio_q *q);
 349
 350 void qdio_setup_thinint(struct qdio_irq *irq_ptr);
 351 int qdio_establish_thinint(struct qdio_irq *irq_ptr);
 352 void qdio_shutdown_thinint(struct qdio_irq *irq_ptr);
 353 void tiqdio_add_input_queues(struct qdio_irq *irq_ptr);
 354 void tiqdio_remove_input_queues(struct qdio_irq *irq_ptr);
 355 void tiqdio_inbound_processing(unsigned long q);
 356 int tiqdio_allocate_memory(void);
 357 void tiqdio_free_memory(void);
 358 int tiqdio_register_thinints(void);
 359 void tiqdio_unregister_thinints(void);
 360
 361 /* prototypes for setup */
 362 void qdio_inbound_processing(unsigned long data);
 363 void qdio_outbound_processing(unsigned long data);
 364 void qdio_outbound_timer(unsigned long data);
 365 void qdio_int_handler(struct ccw_device *cdev, unsigned long intparm,
 366                       struct irb *irb);
 367 int qdio_allocate_qs(struct qdio_irq *irq_ptr, int nr_input_qs,
 368                      int nr_output_qs);
 369 void qdio_setup_ssqd_info(struct qdio_irq *irq_ptr);
 370 int qdio_setup_irq(struct qdio_initialize *init_data);
 371 void qdio_print_subchannel_info(struct qdio_irq *irq_ptr,
 372                                 struct ccw_device *cdev);
 373 void qdio_release_memory(struct qdio_irq *irq_ptr);
 374 int qdio_setup_init(void);
 375 void qdio_setup_exit(void);
 376
 377 #endif /* _CIO_QDIO_H */