LXR linux/arch/s390/include/asm/qdio.h

   1/*
   2 * Copyright IBM Corp. 2000, 2008
   3 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
   4 *            Jan Glauber <jang@linux.vnet.ibm.com>
   5 *
   6 */
   7#ifndef __QDIO_H__
   8#define __QDIO_H__
   9
  10#include <linux/interrupt.h>
  11#include <asm/cio.h>
  12#include <asm/ccwdev.h>
  13
  14/* only use 4 queues to save some cachelines */
  15#define QDIO_MAX_QUEUES_PER_IRQ         4
  16#define QDIO_MAX_BUFFERS_PER_Q          128
  17#define QDIO_MAX_BUFFERS_MASK           (QDIO_MAX_BUFFERS_PER_Q - 1)
  18#define QDIO_MAX_ELEMENTS_PER_BUFFER    16
  19#define QDIO_SBAL_SIZE                  256
  20
  21#define QDIO_QETH_QFMT                  0
  22#define QDIO_ZFCP_QFMT                  1
  23#define QDIO_IQDIO_QFMT                 2
  24
  25/**
  26 * struct qdesfmt0 - queue descriptor, format 0
  27 * @sliba: storage list information block address
  28 * @sla: storage list address
  29 * @slsba: storage list state block address
  30 * @akey: access key for DLIB
  31 * @bkey: access key for SL
  32 * @ckey: access key for SBALs
  33 * @dkey: access key for SLSB
  34 */
  35struct qdesfmt0 {
  36        u64 sliba;
  37        u64 sla;
  38        u64 slsba;
  39        u32      : 32;
  40        u32 akey : 4;
  41        u32 bkey : 4;
  42        u32 ckey : 4;
  43        u32 dkey : 4;
  44        u32      : 16;
  45} __attribute__ ((packed));
  46
  47#define QDR_AC_MULTI_BUFFER_ENABLE 0x01
  48
  49/**
  50 * struct qdr - queue description record (QDR)
  51 * @qfmt: queue format
  52 * @pfmt: implementation dependent parameter format
  53 * @ac: adapter characteristics
  54 * @iqdcnt: input queue descriptor count
  55 * @oqdcnt: output queue descriptor count
  56 * @iqdsz: inpout queue descriptor size
  57 * @oqdsz: output queue descriptor size
  58 * @qiba: queue information block address
  59 * @qkey: queue information block key
  60 * @qdf0: queue descriptions
  61 */
  62struct qdr {
  63        u32 qfmt   : 8;
  64        u32 pfmt   : 8;
  65        u32        : 8;
  66        u32 ac     : 8;
  67        u32        : 8;
  68        u32 iqdcnt : 8;
  69        u32        : 8;
  70        u32 oqdcnt : 8;
  71        u32        : 8;
  72        u32 iqdsz  : 8;
  73        u32        : 8;
  74        u32 oqdsz  : 8;
  75        /* private: */
  76        u32 res[9];
  77        /* public: */
  78        u64 qiba;
  79        u32        : 32;
  80        u32 qkey   : 4;
  81        u32        : 28;
  82        struct qdesfmt0 qdf0[126];
  83} __attribute__ ((packed, aligned(4096)));
  84
  85#define QIB_AC_OUTBOUND_PCI_SUPPORTED   0x40
  86#define QIB_RFLAGS_ENABLE_QEBSM         0x80
  87#define QIB_RFLAGS_ENABLE_DATA_DIV      0x02
  88
  89/**
  90 * struct qib - queue information block (QIB)
  91 * @qfmt: queue format
  92 * @pfmt: implementation dependent parameter format
  93 * @rflags: QEBSM
  94 * @ac: adapter characteristics
  95 * @isliba: absolute address of first input SLIB
  96 * @osliba: absolute address of first output SLIB
  97 * @ebcnam: adapter identifier in EBCDIC
  98 * @parm: implementation dependent parameters
  99 */
 100struct qib {
 101        u32 qfmt   : 8;
 102        u32 pfmt   : 8;
 103        u32 rflags : 8;
 104        u32 ac     : 8;
 105        u32        : 32;
 106        u64 isliba;
 107        u64 osliba;
 108        u32        : 32;
 109        u32        : 32;
 110        u8 ebcnam[8];
 111        /* private: */
 112        u8 res[88];
 113        /* public: */
 114        u8 parm[QDIO_MAX_BUFFERS_PER_Q];
 115} __attribute__ ((packed, aligned(256)));
 116
 117/**
 118 * struct slibe - storage list information block element (SLIBE)
 119 * @parms: implementation dependent parameters
 120 */
 121struct slibe {
 122        u64 parms;
 123};
 124
 125/**
 126 * struct qaob - queue asynchronous operation block
 127 * @res0: reserved parameters
 128 * @res1: reserved parameter
 129 * @res2: reserved parameter
 130 * @res3: reserved parameter
 131 * @aorc: asynchronous operation return code
 132 * @flags: internal flags
 133 * @cbtbs: control block type
 134 * @sb_count: number of storage blocks
 135 * @sba: storage block element addresses
 136 * @dcount: size of storage block elements
 137 * @user0: user defineable value
 138 * @res4: reserved paramater
 139 * @user1: user defineable value
 140 * @user2: user defineable value
 141 */
 142struct qaob {
 143        u64 res0[6];
 144        u8 res1;
 145        u8 res2;
 146        u8 res3;
 147        u8 aorc;
 148        u8 flags;
 149        u16 cbtbs;
 150        u8 sb_count;
 151        u64 sba[QDIO_MAX_ELEMENTS_PER_BUFFER];
 152        u16 dcount[QDIO_MAX_ELEMENTS_PER_BUFFER];
 153        u64 user0;
 154        u64 res4[2];
 155        u64 user1;
 156        u64 user2;
 157} __attribute__ ((packed, aligned(256)));
 158
 159/**
 160 * struct slib - storage list information block (SLIB)
 161 * @nsliba: next SLIB address (if any)
 162 * @sla: SL address
 163 * @slsba: SLSB address
 164 * @slibe: SLIB elements
 165 */
 166struct slib {
 167        u64 nsliba;
 168        u64 sla;
 169        u64 slsba;
 170        /* private: */
 171        u8 res[1000];
 172        /* public: */
 173        struct slibe slibe[QDIO_MAX_BUFFERS_PER_Q];
 174} __attribute__ ((packed, aligned(2048)));
 175
 176#define SBAL_EFLAGS_LAST_ENTRY          0x40
 177#define SBAL_EFLAGS_CONTIGUOUS          0x20
 178#define SBAL_EFLAGS_FIRST_FRAG          0x04
 179#define SBAL_EFLAGS_MIDDLE_FRAG         0x08
 180#define SBAL_EFLAGS_LAST_FRAG           0x0c
 181#define SBAL_EFLAGS_MASK                0x6f
 182
 183#define SBAL_SFLAGS0_PCI_REQ            0x40
 184#define SBAL_SFLAGS0_DATA_CONTINUATION  0x20
 185
 186/* Awesome OpenFCP extensions */
 187#define SBAL_SFLAGS0_TYPE_STATUS        0x00
 188#define SBAL_SFLAGS0_TYPE_WRITE         0x08
 189#define SBAL_SFLAGS0_TYPE_READ          0x10
 190#define SBAL_SFLAGS0_TYPE_WRITE_READ    0x18
 191#define SBAL_SFLAGS0_MORE_SBALS         0x04
 192#define SBAL_SFLAGS0_COMMAND            0x02
 193#define SBAL_SFLAGS0_LAST_SBAL          0x00
 194#define SBAL_SFLAGS0_ONLY_SBAL          SBAL_SFLAGS0_COMMAND
 195#define SBAL_SFLAGS0_MIDDLE_SBAL        SBAL_SFLAGS0_MORE_SBALS
 196#define SBAL_SFLAGS0_FIRST_SBAL (SBAL_SFLAGS0_MORE_SBALS | SBAL_SFLAGS0_COMMAND)
 197
 198/**
 199 * struct qdio_buffer_element - SBAL entry
 200 * @eflags: SBAL entry flags
 201 * @scount: SBAL count
 202 * @sflags: whole SBAL flags
 203 * @length: length
 204 * @addr: address
 205*/
 206struct qdio_buffer_element {
 207        u8 eflags;
 208        /* private: */
 209        u8 res1;
 210        /* public: */
 211        u8 scount;
 212        u8 sflags;
 213        u32 length;
 214#ifdef CONFIG_32BIT
 215        /* private: */
 216        void *res2;
 217        /* public: */
 218#endif
 219        void *addr;
 220} __attribute__ ((packed, aligned(16)));
 221
 222/**
 223 * struct qdio_buffer - storage block address list (SBAL)
 224 * @element: SBAL entries
 225 */
 226struct qdio_buffer {
 227        struct qdio_buffer_element element[QDIO_MAX_ELEMENTS_PER_BUFFER];
 228} __attribute__ ((packed, aligned(256)));
 229
 230/**
 231 * struct sl_element - storage list entry
 232 * @sbal: absolute SBAL address
 233 */
 234struct sl_element {
 235#ifdef CONFIG_32BIT
 236        /* private: */
 237        unsigned long reserved;
 238        /* public: */
 239#endif
 240        unsigned long sbal;
 241} __attribute__ ((packed));
 242
 243/**
 244 * struct sl - storage list (SL)
 245 * @element: SL entries
 246 */
 247struct sl {
 248        struct sl_element element[QDIO_MAX_BUFFERS_PER_Q];
 249} __attribute__ ((packed, aligned(1024)));
 250
 251/**
 252 * struct slsb - storage list state block (SLSB)
 253 * @val: state per buffer
 254 */
 255struct slsb {
 256        u8 val[QDIO_MAX_BUFFERS_PER_Q];
 257} __attribute__ ((packed, aligned(256)));
 258
 259/**
 260 * struct qdio_outbuf_state - SBAL related asynchronous operation information
 261 *   (for communication with upper layer programs)
 262 *   (only required for use with completion queues)
 263 * @flags: flags indicating state of buffer
 264 * @aob: pointer to QAOB used for the particular SBAL
 265 * @user: pointer to upper layer program's state information related to SBAL
 266 *        (stored in user1 data of QAOB)
 267 */
 268struct qdio_outbuf_state {
 269        u8 flags;
 270        struct qaob *aob;
 271        void *user;
 272};
 273
 274#define QDIO_OUTBUF_STATE_FLAG_NONE     0x00
 275#define QDIO_OUTBUF_STATE_FLAG_PENDING  0x01
 276
 277#define CHSC_AC1_INITIATE_INPUTQ        0x80
 278
 279
 280/* qdio adapter-characteristics-1 flag */
 281#define AC1_SIGA_INPUT_NEEDED           0x40    /* process input queues */
 282#define AC1_SIGA_OUTPUT_NEEDED          0x20    /* process output queues */
 283#define AC1_SIGA_SYNC_NEEDED            0x10    /* ask hypervisor to sync */
 284#define AC1_AUTOMATIC_SYNC_ON_THININT   0x08    /* set by hypervisor */
 285#define AC1_AUTOMATIC_SYNC_ON_OUT_PCI   0x04    /* set by hypervisor */
 286#define AC1_SC_QEBSM_AVAILABLE          0x02    /* available for subchannel */
 287#define AC1_SC_QEBSM_ENABLED            0x01    /* enabled for subchannel */
 288
 289#define CHSC_AC2_MULTI_BUFFER_AVAILABLE 0x0080
 290#define CHSC_AC2_MULTI_BUFFER_ENABLED   0x0040
 291#define CHSC_AC2_DATA_DIV_AVAILABLE     0x0010
 292#define CHSC_AC2_DATA_DIV_ENABLED       0x0002
 293
 294#define CHSC_AC3_FORMAT2_CQ_AVAILABLE   0x8000
 295
 296struct qdio_ssqd_desc {
 297        u8 flags;
 298        u8:8;
 299        u16 sch;
 300        u8 qfmt;
 301        u8 parm;
 302        u8 qdioac1;
 303        u8 sch_class;
 304        u8 pcnt;
 305        u8 icnt;
 306        u8:8;
 307        u8 ocnt;
 308        u8:8;
 309        u8 mbccnt;
 310        u16 qdioac2;
 311        u64 sch_token;
 312        u8 mro;
 313        u8 mri;
 314        u16 qdioac3;
 315        u16:16;
 316        u8:8;
 317        u8 mmwc;
 318} __attribute__ ((packed));
 319
 320/* params are: ccw_device, qdio_error, queue_number,
 321   first element processed, number of elements processed, int_parm */
 322typedef void qdio_handler_t(struct ccw_device *, unsigned int, int,
 323                            int, int, unsigned long);
 324
 325/* qdio errors reported to the upper-layer program */
 326#define QDIO_ERROR_ACTIVATE                     0x0001
 327#define QDIO_ERROR_GET_BUF_STATE                0x0002
 328#define QDIO_ERROR_SET_BUF_STATE                0x0004
 329#define QDIO_ERROR_SLSB_STATE                   0x0100
 330
 331#define QDIO_ERROR_FATAL                        0x00ff
 332#define QDIO_ERROR_TEMPORARY                    0xff00
 333
 334/* for qdio_cleanup */
 335#define QDIO_FLAG_CLEANUP_USING_CLEAR           0x01
 336#define QDIO_FLAG_CLEANUP_USING_HALT            0x02
 337
 338/**
 339 * struct qdio_initialize - qdio initalization data
 340 * @cdev: associated ccw device
 341 * @q_format: queue format
 342 * @adapter_name: name for the adapter
 343 * @qib_param_field_format: format for qib_parm_field
 344 * @qib_param_field: pointer to 128 bytes or NULL, if no param field
 345 * @qib_rflags: rflags to set
 346 * @input_slib_elements: pointer to no_input_qs * 128 words of data or NULL
 347 * @output_slib_elements: pointer to no_output_qs * 128 words of data or NULL
 348 * @no_input_qs: number of input queues
 349 * @no_output_qs: number of output queues
 350 * @input_handler: handler to be called for input queues
 351 * @output_handler: handler to be called for output queues
 352 * @queue_start_poll_array: polling handlers (one per input queue or NULL)
 353 * @int_parm: interruption parameter
 354 * @input_sbal_addr_array:  address of no_input_qs * 128 pointers
 355 * @output_sbal_addr_array: address of no_output_qs * 128 pointers
 356 * @output_sbal_state_array: no_output_qs * 128 state info (for CQ or NULL)
 357 */
 358struct qdio_initialize {
 359        struct ccw_device *cdev;
 360        unsigned char q_format;
 361        unsigned char qdr_ac;
 362        unsigned char adapter_name[8];
 363        unsigned int qib_param_field_format;
 364        unsigned char *qib_param_field;
 365        unsigned char qib_rflags;
 366        unsigned long *input_slib_elements;
 367        unsigned long *output_slib_elements;
 368        unsigned int no_input_qs;
 369        unsigned int no_output_qs;
 370        qdio_handler_t *input_handler;
 371        qdio_handler_t *output_handler;
 372        void (**queue_start_poll_array) (struct ccw_device *, int,
 373                                          unsigned long);
 374        int scan_threshold;
 375        unsigned long int_parm;
 376        void **input_sbal_addr_array;
 377        void **output_sbal_addr_array;
 378        struct qdio_outbuf_state *output_sbal_state_array;
 379};
 380
 381#define QDIO_STATE_INACTIVE             0x00000002 /* after qdio_cleanup */
 382#define QDIO_STATE_ESTABLISHED          0x00000004 /* after qdio_establish */
 383#define QDIO_STATE_ACTIVE               0x00000008 /* after qdio_activate */
 384#define QDIO_STATE_STOPPED              0x00000010 /* after queues went down */
 385
 386#define QDIO_FLAG_SYNC_INPUT            0x01
 387#define QDIO_FLAG_SYNC_OUTPUT           0x02
 388#define QDIO_FLAG_PCI_OUT               0x10
 389
 390extern int qdio_allocate(struct qdio_initialize *);
 391extern int qdio_establish(struct qdio_initialize *);
 392extern int qdio_activate(struct ccw_device *);
 393extern void qdio_release_aob(struct qaob *);
 394extern int do_QDIO(struct ccw_device *, unsigned int, int, unsigned int,
 395                   unsigned int);
 396extern int qdio_start_irq(struct ccw_device *, int);
 397extern int qdio_stop_irq(struct ccw_device *, int);
 398extern int qdio_get_next_buffers(struct ccw_device *, int, int *, int *);
 399extern int qdio_shutdown(struct ccw_device *, int);
 400extern int qdio_free(struct ccw_device *);
 401extern int qdio_get_ssqd_desc(struct ccw_device *, struct qdio_ssqd_desc *);
 402
 403#endif /* __QDIO_H__ */
 404