/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright IBM Corp. 2000, 2008
 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
 *            Jan Glauber <jang@linux.vnet.ibm.com>
 *
 */
#ifndef __QDIO_H__
#define __QDIO_H__

#include <linux/interrupt.h>
#include <asm/dma-types.h>
#include <asm/ccwdev.h>
#include <asm/cio.h>

/* only use 4 queues to save some cachelines */
#define QDIO_MAX_QUEUES_PER_IRQ         4
#define QDIO_MAX_BUFFERS_PER_Q          128
#define QDIO_MAX_BUFFERS_MASK           (QDIO_MAX_BUFFERS_PER_Q - 1)
#define QDIO_BUFNR(num)                 ((num) & QDIO_MAX_BUFFERS_MASK)
#define QDIO_MAX_ELEMENTS_PER_BUFFER    16

#define QDIO_QETH_QFMT                  0
#define QDIO_ZFCP_QFMT                  1
#define QDIO_IQDIO_QFMT                 2

/**
 * struct qdesfmt0 - queue descriptor, format 0
 * @sliba: absolute address of storage list information block
 * @sla: absolute address of storage list
 * @slsba: absolute address of storage list state block
 * @akey: access key for SLIB
 * @bkey: access key for SL
 * @ckey: access key for SBALs
 * @dkey: access key for SLSB
 */
struct qdesfmt0 {
        dma64_t sliba;
        dma64_t sla;
        dma64_t slsba;
        u32      : 32;
        u32 akey : 4;
        u32 bkey : 4;
        u32 ckey : 4;
        u32 dkey : 4;
        u32      : 16;
} __attribute__ ((packed));

#define QDR_AC_MULTI_BUFFER_ENABLE 0x01

/**
 * struct qdr - queue description record (QDR)
 * @qfmt: queue format
 * @ac: adapter characteristics
 * @iqdcnt: input queue descriptor count
 * @oqdcnt: output queue descriptor count
 * @iqdsz: input queue descriptor size
 * @oqdsz: output queue descriptor size
 * @qiba: absolute address of queue information block
 * @qkey: queue information block key
 * @qdf0: queue descriptions
 */
struct qdr {
        u32 qfmt   : 8;
        u32        : 16;
        u32 ac     : 8;
        u32        : 8;
        u32 iqdcnt : 8;
        u32        : 8;
        u32 oqdcnt : 8;
        u32        : 8;
        u32 iqdsz  : 8;
        u32        : 8;
        u32 oqdsz  : 8;
        /* private: */
        u32 res[9];
        /* public: */
        dma64_t qiba;
        u32        : 32;
        u32 qkey   : 4;
        u32        : 28;
        struct qdesfmt0 qdf0[126];
} __packed __aligned(PAGE_SIZE);

#define QIB_AC_OUTBOUND_PCI_SUPPORTED   0x40
#define QIB_RFLAGS_ENABLE_QEBSM         0x80
#define QIB_RFLAGS_ENABLE_DATA_DIV      0x02

/**
 * struct qib - queue information block (QIB)
 * @qfmt: queue format
 * @pfmt: implementation dependent parameter format
 * @rflags: QEBSM
 * @ac: adapter characteristics
 * @isliba: logical address of first input SLIB
 * @osliba: logical address of first output SLIB
 * @ebcnam: adapter identifier in EBCDIC
 * @parm: implementation dependent parameters
 */
struct qib {
        u32 qfmt   : 8;
        u32 pfmt   : 8;
        u32 rflags : 8;
        u32 ac     : 8;
        u32        : 32;
        u64 isliba;
        u64 osliba;
        u32        : 32;
        u32        : 32;
        u8 ebcnam[8];
        /* private: */
        u8 res[88];
        /* public: */
        u8 parm[128];
} __attribute__ ((packed, aligned(256)));

/**
 * struct slibe - storage list information block element (SLIBE)
 * @parms: implementation dependent parameters
 */
struct slibe {
        u64 parms;
};

/**
 * struct qaob - queue asynchronous operation block
 * @res0: reserved parameters
 * @res1: reserved parameter
 * @res2: reserved parameter
 * @res3: reserved parameter
 * @aorc: asynchronous operation return code
 * @flags: internal flags
 * @cbtbs: control block type
 * @sb_count: number of storage blocks
 * @sba: storage block element addresses
 * @dcount: size of storage block elements
 * @user0: user definable value
 * @res4: reserved parameter
 * @user1: user definable value
 */
struct qaob {
        u64 res0[6];
        u8 res1;
        u8 res2;
        u8 res3;
        u8 aorc;
        u8 flags;
        u16 cbtbs;
        u8 sb_count;
        dma64_t sba[QDIO_MAX_ELEMENTS_PER_BUFFER];
        u16 dcount[QDIO_MAX_ELEMENTS_PER_BUFFER];
        u64 user0;
        u64 res4[2];
        u8 user1[16];
} __attribute__ ((packed, aligned(256)));

/**
 * struct slib - storage list information block (SLIB)
 * @nsliba: next SLIB address (if any)
 * @sla: SL address
 * @slsba: SLSB address
 * @slibe: SLIB elements
 */
struct slib {
        u64 nsliba;
        u64 sla;
        u64 slsba;
        /* private: */
        u8 res[1000];
        /* public: */
        struct slibe slibe[QDIO_MAX_BUFFERS_PER_Q];
} __attribute__ ((packed, aligned(2048)));

#define SBAL_EFLAGS_LAST_ENTRY          0x40
#define SBAL_EFLAGS_CONTIGUOUS          0x20
#define SBAL_EFLAGS_FIRST_FRAG          0x04
#define SBAL_EFLAGS_MIDDLE_FRAG         0x08
#define SBAL_EFLAGS_LAST_FRAG           0x0c
#define SBAL_EFLAGS_MASK                0x6f

#define SBAL_SFLAGS0_PCI_REQ            0x40
#define SBAL_SFLAGS0_DATA_CONTINUATION  0x20

/* Awesome OpenFCP extensions */
#define SBAL_SFLAGS0_TYPE_STATUS        0x00
#define SBAL_SFLAGS0_TYPE_WRITE         0x08
#define SBAL_SFLAGS0_TYPE_READ          0x10
#define SBAL_SFLAGS0_TYPE_WRITE_READ    0x18
#define SBAL_SFLAGS0_MORE_SBALS         0x04
#define SBAL_SFLAGS0_COMMAND            0x02
#define SBAL_SFLAGS0_LAST_SBAL          0x00
#define SBAL_SFLAGS0_ONLY_SBAL          SBAL_SFLAGS0_COMMAND
#define SBAL_SFLAGS0_MIDDLE_SBAL        SBAL_SFLAGS0_MORE_SBALS
#define SBAL_SFLAGS0_FIRST_SBAL (SBAL_SFLAGS0_MORE_SBALS | SBAL_SFLAGS0_COMMAND)

/**
 * struct qdio_buffer_element - SBAL entry
 * @eflags: SBAL entry flags
 * @scount: SBAL count
 * @sflags: whole SBAL flags
 * @length: length
 * @addr: absolute data address
*/
struct qdio_buffer_element {
        u8 eflags;
        /* private: */
        u8 res1;
        /* public: */
        u8 scount;
        u8 sflags;
        u32 length;
        dma64_t addr;
} __attribute__ ((packed, aligned(16)));

/**
 * struct qdio_buffer - storage block address list (SBAL)
 * @element: SBAL entries
 */
struct qdio_buffer {
        struct qdio_buffer_element element[QDIO_MAX_ELEMENTS_PER_BUFFER];
} __attribute__ ((packed, aligned(256)));

/**
 * struct sl_element - storage list entry
 * @sbal: absolute SBAL address
 */
struct sl_element {
        dma64_t sbal;
} __attribute__ ((packed));

/**
 * struct sl - storage list (SL)
 * @element: SL entries
 */
struct sl {
        struct sl_element element[QDIO_MAX_BUFFERS_PER_Q];
} __attribute__ ((packed, aligned(1024)));

/**
 * struct slsb - storage list state block (SLSB)
 * @val: state per buffer
 */
struct slsb {
        u8 val[QDIO_MAX_BUFFERS_PER_Q];
} __attribute__ ((packed, aligned(256)));

/* qdio adapter-characteristics-1 flag */
#define CHSC_AC1_INITIATE_INPUTQ        0x80
#define AC1_SIGA_INPUT_NEEDED           0x40    /* process input queues */
#define AC1_SIGA_OUTPUT_NEEDED          0x20    /* process output queues */
#define AC1_SIGA_SYNC_NEEDED            0x10    /* ask hypervisor to sync */
#define AC1_AUTOMATIC_SYNC_ON_THININT   0x08    /* set by hypervisor */
#define AC1_AUTOMATIC_SYNC_ON_OUT_PCI   0x04    /* set by hypervisor */
#define AC1_SC_QEBSM_AVAILABLE          0x02    /* available for subchannel */
#define AC1_SC_QEBSM_ENABLED            0x01    /* enabled for subchannel */

#define CHSC_AC2_MULTI_BUFFER_AVAILABLE 0x0080
#define CHSC_AC2_MULTI_BUFFER_ENABLED   0x0040
#define CHSC_AC2_DATA_DIV_AVAILABLE     0x0010
#define CHSC_AC2_SNIFFER_AVAILABLE      0x0008
#define CHSC_AC2_DATA_DIV_ENABLED       0x0002

#define CHSC_AC3_FORMAT2_CQ_AVAILABLE   0x8000

struct qdio_ssqd_desc {
        u8 flags;
        u8:8;
        u16 sch;
        u8 qfmt;
        u8 parm;
        u8 qdioac1;
        u8 sch_class;
        u8 pcnt;
        u8 icnt;
        u8:8;
        u8 ocnt;
        u8:8;
        u8 mbccnt;
        u16 qdioac2;
        u64 sch_token;
        u8 mro;
        u8 mri;
        u16 qdioac3;
        u16:16;
        u8:8;
        u8 mmwc;
} __attribute__ ((packed));

/* params are: ccw_device, qdio_error, queue_number,
   first element processed, number of elements processed, int_parm */
typedef void qdio_handler_t(struct ccw_device *, unsigned int, int,
                            int, int, unsigned long);

/* qdio errors reported through the queue handlers: */
#define QDIO_ERROR_ACTIVATE                     0x0001
#define QDIO_ERROR_GET_BUF_STATE                0x0002
#define QDIO_ERROR_SET_BUF_STATE                0x0004

/* extra info for completed SBALs: */
#define QDIO_ERROR_SLSB_STATE                   0x0100
#define QDIO_ERROR_SLSB_PENDING                 0x0200

/* for qdio_cleanup */
#define QDIO_FLAG_CLEANUP_USING_CLEAR           0x01
#define QDIO_FLAG_CLEANUP_USING_HALT            0x02

/**
 * struct qdio_initialize - qdio initialization data
 * @q_format: queue format
 * @qdr_ac: feature flags to set
 * @qib_param_field_format: format for qib_parm_field
 * @qib_param_field: pointer to 128 bytes or NULL, if no param field
 * @qib_rflags: rflags to set
 * @no_input_qs: number of input queues
 * @no_output_qs: number of output queues
 * @input_handler: handler to be called for input queues, and device-wide errors
 * @output_handler: handler to be called for output queues
 * @irq_poll: Data IRQ polling handler
 * @scan_threshold: # of in-use buffers that triggers scan on output queue
 * @int_parm: interruption parameter
 * @input_sbal_addr_array:  per-queue array, each element points to 128 SBALs
 * @output_sbal_addr_array: per-queue array, each element points to 128 SBALs
 */
struct qdio_initialize {
        unsigned char q_format;
        unsigned char qdr_ac;
        unsigned int qib_param_field_format;
        unsigned char *qib_param_field;
        unsigned char qib_rflags;
        unsigned int no_input_qs;
        unsigned int no_output_qs;
        qdio_handler_t *input_handler;
        qdio_handler_t *output_handler;
        void (*irq_poll)(struct ccw_device *cdev, unsigned long data);
        unsigned long int_parm;
        struct qdio_buffer ***input_sbal_addr_array;
        struct qdio_buffer ***output_sbal_addr_array;
};

int qdio_alloc_buffers(struct qdio_buffer **buf, unsigned int count);
void qdio_free_buffers(struct qdio_buffer **buf, unsigned int count);
void qdio_reset_buffers(struct qdio_buffer **buf, unsigned int count);

extern int qdio_allocate(struct ccw_device *cdev, unsigned int no_input_qs,
                         unsigned int no_output_qs);
extern int qdio_establish(struct ccw_device *cdev,
                          struct qdio_initialize *init_data);
extern int qdio_activate(struct ccw_device *);
extern int qdio_start_irq(struct ccw_device *cdev);
extern int qdio_stop_irq(struct ccw_device *cdev);
extern int qdio_inspect_input_queue(struct ccw_device *cdev, unsigned int nr,
                                    unsigned int *bufnr, unsigned int *error);
extern int qdio_inspect_output_queue(struct ccw_device *cdev, unsigned int nr,
                                     unsigned int *bufnr, unsigned int *error);
extern int qdio_add_bufs_to_input_queue(struct ccw_device *cdev,
                                        unsigned int q_nr, unsigned int bufnr,
                                        unsigned int count);
extern int qdio_add_bufs_to_output_queue(struct ccw_device *cdev,
                                         unsigned int q_nr, unsigned int bufnr,
                                         unsigned int count, struct qaob *aob);
extern int qdio_shutdown(struct ccw_device *, int);
extern int qdio_free(struct ccw_device *);
extern int qdio_get_ssqd_desc(struct ccw_device *, struct qdio_ssqd_desc *);

#endif /* __QDIO_H__ */