[linux-2.6-block.git] / arch / s390 / include / asm / qdio.h

/* 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/cio.h>
#include <asm/ccwdev.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_SBAL_SIZE			256

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

/**
 * struct qdesfmt0 - queue descriptor, format 0
 * @sliba: storage list information block address
 * @sla: storage list address
 * @slsba: storage list state block address
 * @akey: access key for SLIB
 * @bkey: access key for SL
 * @ckey: access key for SBALs
 * @dkey: access key for SLSB
 */
struct qdesfmt0 {
	u64 sliba;
	u64 sla;
	u64 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: queue information block address
 * @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: */
	u64 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: absolute address of first input SLIB
 * @osliba: absolute 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 defineable value
 * @res4: reserved paramater
 * @user1: user defineable value
 * @user2: user defineable value
 */
struct qaob {
	u64 res0[6];
	u8 res1;
	u8 res2;
	u8 res3;
	u8 aorc;
	u8 flags;
	u16 cbtbs;
	u8 sb_count;
	u64 sba[QDIO_MAX_ELEMENTS_PER_BUFFER];
	u16 dcount[QDIO_MAX_ELEMENTS_PER_BUFFER];
	u64 user0;
	u64 res4[2];
	u64 user1;
	u64 user2;
} __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: address
*/
struct qdio_buffer_element {
	u8 eflags;
	/* private: */
	u8 res1;
	/* public: */
	u8 scount;
	u8 sflags;
	u32 length;
	void *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 {
	unsigned long 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)));

/**
 * struct qdio_outbuf_state - SBAL related asynchronous operation information
 *   (for communication with upper layer programs)
 *   (only required for use with completion queues)
 * @flags: flags indicating state of buffer
 * @user: pointer to upper layer program's state information related to SBAL
 *        (stored in user1 data of QAOB)
 */
struct qdio_outbuf_state {
	u8 flags;
	void *user;
};

#define QDIO_OUTBUF_STATE_FLAG_PENDING	0x01

#define CHSC_AC1_INITIATE_INPUTQ	0x80


/* qdio adapter-characteristics-1 flag */
#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_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 to the upper-layer program */
#define QDIO_ERROR_ACTIVATE			0x0001
#define QDIO_ERROR_GET_BUF_STATE		0x0002
#define QDIO_ERROR_SET_BUF_STATE		0x0004
#define QDIO_ERROR_SLSB_STATE			0x0100

#define QDIO_ERROR_FATAL			0x00ff
#define QDIO_ERROR_TEMPORARY			0xff00

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

/**
 * struct qdio_initialize - qdio initialization data
 * @cdev: associated ccw device
 * @q_format: queue format
 * @qdr_ac: feature flags to set
 * @adapter_name: name for the adapter
 * @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
 * @input_slib_elements: pointer to no_input_qs * 128 words of data or NULL
 * @output_slib_elements: pointer to no_output_qs * 128 words of data or NULL
 * @no_input_qs: number of input queues
 * @no_output_qs: number of output queues
 * @input_handler: handler to be called for input queues
 * @output_handler: handler to be called for output queues
 * @queue_start_poll_array: polling handlers (one per input queue or NULL)
 * @scan_threshold: # of in-use buffers that triggers scan on output queue
 * @int_parm: interruption parameter
 * @input_sbal_addr_array:  address of no_input_qs * 128 pointers
 * @output_sbal_addr_array: address of no_output_qs * 128 pointers
 * @output_sbal_state_array: no_output_qs * 128 state info (for CQ or NULL)
 */
struct qdio_initialize {
	struct ccw_device *cdev;
	unsigned char q_format;
	unsigned char qdr_ac;
	unsigned char adapter_name[8];
	unsigned int qib_param_field_format;
	unsigned char *qib_param_field;
	unsigned char qib_rflags;
	unsigned long *input_slib_elements;
	unsigned long *output_slib_elements;
	unsigned int no_input_qs;
	unsigned int no_output_qs;
	qdio_handler_t *input_handler;
	qdio_handler_t *output_handler;
	void (**queue_start_poll_array) (struct ccw_device *, int,
					  unsigned long);
	unsigned int scan_threshold;
	unsigned long int_parm;
	struct qdio_buffer **input_sbal_addr_array;
	struct qdio_buffer **output_sbal_addr_array;
	struct qdio_outbuf_state *output_sbal_state_array;
};

/**
 * enum qdio_brinfo_entry_type - type of address entry for qdio_brinfo_desc()
 * @l3_ipv6_addr: entry contains IPv6 address
 * @l3_ipv4_addr: entry contains IPv4 address
 * @l2_addr_lnid: entry contains MAC address and VLAN ID
 */
enum qdio_brinfo_entry_type {l3_ipv6_addr, l3_ipv4_addr, l2_addr_lnid};

/**
 * struct qdio_brinfo_entry_XXX - Address entry for qdio_brinfo_desc()
 * @nit:  Network interface token
 * @addr: Address of one of the three types
 *
 * The struct is passed to the callback function by qdio_brinfo_desc()
 */
struct qdio_brinfo_entry_l3_ipv6 {
	u64 nit;
	struct { unsigned char _s6_addr[16]; } addr;
} __packed;
struct qdio_brinfo_entry_l3_ipv4 {
	u64 nit;
	struct { uint32_t _s_addr; } addr;
} __packed;
struct qdio_brinfo_entry_l2 {
	u64 nit;
	struct { u8 mac[6]; u16 lnid; } addr_lnid;
} __packed;

#define QDIO_STATE_INACTIVE		0x00000002 /* after qdio_cleanup */
#define QDIO_STATE_ESTABLISHED		0x00000004 /* after qdio_establish */
#define QDIO_STATE_ACTIVE		0x00000008 /* after qdio_activate */
#define QDIO_STATE_STOPPED		0x00000010 /* after queues went down */

#define QDIO_FLAG_SYNC_INPUT		0x01
#define QDIO_FLAG_SYNC_OUTPUT		0x02
#define QDIO_FLAG_PCI_OUT		0x10

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 qdio_initialize *);
extern int qdio_establish(struct qdio_initialize *);
extern int qdio_activate(struct ccw_device *);
extern void qdio_release_aob(struct qaob *);
extern int do_QDIO(struct ccw_device *, unsigned int, int, unsigned int,
		   unsigned int);
extern int qdio_start_irq(struct ccw_device *, int);
extern int qdio_stop_irq(struct ccw_device *, int);
extern int qdio_get_next_buffers(struct ccw_device *, int, int *, int *);
extern int qdio_inspect_queue(struct ccw_device *cdev, unsigned int nr,
			      bool is_input, unsigned int *bufnr,
			      unsigned int *error);
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 *);
extern int qdio_pnso_brinfo(struct subchannel_id schid,
		int cnc, u16 *response,
		void (*cb)(void *priv, enum qdio_brinfo_entry_type type,
				void *entry),
		void *priv);

#endif /* __QDIO_H__ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4	2	/*
a53c8fab	3	* Copyright IBM Corp. 2000, 2008
1da177e4	4	* Author(s): Utz Bacher <utz.bacher@de.ibm.com>
779e6e1c	5	* Jan Glauber <jang@linux.vnet.ibm.com>
1da177e4 LT	6	*
	7	*/
	8	#ifndef __QDIO_H__
	9	#define __QDIO_H__
	10
1da177e4 LT	11	#include <linux/interrupt.h>
	12	#include <asm/cio.h>
	13	#include <asm/ccwdev.h>
	14
432ac5e0 JG	15	/* only use 4 queues to save some cachelines */
432ac5e0 JG	16	#define QDIO_MAX_QUEUES_PER_IRQ 4
779e6e1c JG	17	#define QDIO_MAX_BUFFERS_PER_Q 128
779e6e1c JG	18	#define QDIO_MAX_BUFFERS_MASK (QDIO_MAX_BUFFERS_PER_Q - 1)
e53edf74	19	#define QDIO_BUFNR(num) ((num) & QDIO_MAX_BUFFERS_MASK)
779e6e1c JG	20	#define QDIO_MAX_ELEMENTS_PER_BUFFER 16
	21	#define QDIO_SBAL_SIZE 256
	22
	23	#define QDIO_QETH_QFMT 0
	24	#define QDIO_ZFCP_QFMT 1
	25	#define QDIO_IQDIO_QFMT 2
	26
	27	/**
	28	* struct qdesfmt0 - queue descriptor, format 0
	29	* @sliba: storage list information block address
	30	* @sla: storage list address
	31	* @slsba: storage list state block address
d655e5b4	32	* @akey: access key for SLIB
779e6e1c JG	33	* @bkey: access key for SL
	34	* @ckey: access key for SBALs
	35	* @dkey: access key for SLSB
	36	*/
1da177e4	37	struct qdesfmt0 {
779e6e1c JG	38	u64 sliba;
	39	u64 sla;
	40	u64 slsba;
	41	u32 : 32;
	42	u32 akey : 4;
	43	u32 bkey : 4;
	44	u32 ckey : 4;
	45	u32 dkey : 4;
	46	u32 : 16;
1da177e4 LT	47	} __attribute__ ((packed));
1da177e4 LT	48
dfe5bb50 SS	49	#define QDR_AC_MULTI_BUFFER_ENABLE 0x01
dfe5bb50 SS	50
779e6e1c JG	51	/**
	52	* struct qdr - queue description record (QDR)
	53	* @qfmt: queue format
779e6e1c JG	54	* @ac: adapter characteristics
	55	* @iqdcnt: input queue descriptor count
	56	* @oqdcnt: output queue descriptor count
d655e5b4	57	* @iqdsz: input queue descriptor size
779e6e1c JG	58	* @oqdsz: output queue descriptor size
	59	* @qiba: queue information block address
	60	* @qkey: queue information block key
	61	* @qdf0: queue descriptions
1da177e4 LT	62	*/
1da177e4 LT	63	struct qdr {
779e6e1c	64	u32 qfmt : 8;
d655e5b4	65	u32 : 16;
779e6e1c JG	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];
f1c1174f	83	} __packed __aligned(PAGE_SIZE);
779e6e1c JG	84
779e6e1c JG	85	#define QIB_AC_OUTBOUND_PCI_SUPPORTED 0x40
8129ee16	86	#define QIB_RFLAGS_ENABLE_QEBSM 0x80
dcc18f48	87	#define QIB_RFLAGS_ENABLE_DATA_DIV 0x02
8129ee16	88
779e6e1c JG	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	*/
1da177e4	100	struct qib {
779e6e1c JG	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: */
9f494438	114	u8 parm[128];
779e6e1c JG	115	} __attribute__ ((packed, aligned(256)));
	116
	117	/**
	118	* struct slibe - storage list information block element (SLIBE)
	119	* @parms: implementation dependent parameters
1da177e4 LT	120	*/
1da177e4 LT	121	struct slibe {
779e6e1c	122	u64 parms;
1da177e4 LT	123	};
1da177e4 LT	124
104ea556	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	*/
	142	struct 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
779e6e1c JG	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
1da177e4 LT	165	*/
1da177e4 LT	166	struct slib {
779e6e1c JG	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
3ec90878 JG	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
1da177e4	182
3ec90878 JG	183	#define SBAL_SFLAGS0_PCI_REQ 0x40
3ec90878 JG	184	#define SBAL_SFLAGS0_DATA_CONTINUATION 0x20
1da177e4 LT	185
1da177e4 LT	186	/* Awesome OpenFCP extensions */
3ec90878 JG	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)
1da177e4	197
779e6e1c JG	198	/**
779e6e1c JG	199	* struct qdio_buffer_element - SBAL entry
3ec90878 JG	200	* @eflags: SBAL entry flags
	201	* @scount: SBAL count
	202	* @sflags: whole SBAL flags
779e6e1c JG	203	* @length: length
	204	* @addr: address
	205	*/
	206	struct qdio_buffer_element {
3ec90878 JG	207	u8 eflags;
	208	/* private: */
	209	u8 res1;
	210	/* public: */
	211	u8 scount;
	212	u8 sflags;
779e6e1c	213	u32 length;
779e6e1c JG	214	void *addr;
779e6e1c JG	215	} __attribute__ ((packed, aligned(16)));
1da177e4	216
779e6e1c JG	217	/**
	218	* struct qdio_buffer - storage block address list (SBAL)
	219	* @element: SBAL entries
1da177e4	220	*/
779e6e1c JG	221	struct qdio_buffer {
	222	struct qdio_buffer_element element[QDIO_MAX_ELEMENTS_PER_BUFFER];
	223	} __attribute__ ((packed, aligned(256)));
1da177e4	224
779e6e1c JG	225	/**
	226	* struct sl_element - storage list entry
	227	* @sbal: absolute SBAL address
1da177e4 LT	228	*/
1da177e4 LT	229	struct sl_element {
779e6e1c	230	unsigned long sbal;
1da177e4 LT	231	} __attribute__ ((packed));
1da177e4 LT	232
779e6e1c JG	233	/**
	234	* struct sl - storage list (SL)
	235	* @element: SL entries
	236	*/
1da177e4 LT	237	struct sl {
1da177e4 LT	238	struct sl_element element[QDIO_MAX_BUFFERS_PER_Q];
779e6e1c	239	} __attribute__ ((packed, aligned(1024)));
1da177e4	240
779e6e1c JG	241	/**
	242	* struct slsb - storage list state block (SLSB)
	243	* @val: state per buffer
1da177e4	244	*/
779e6e1c JG	245	struct slsb {
	246	u8 val[QDIO_MAX_BUFFERS_PER_Q];
	247	} __attribute__ ((packed, aligned(256)));
	248
104ea556	249	/**
	250	* struct qdio_outbuf_state - SBAL related asynchronous operation information
	251	* (for communication with upper layer programs)
	252	* (only required for use with completion queues)
	253	* @flags: flags indicating state of buffer
104ea556	254	* @user: pointer to upper layer program's state information related to SBAL
	255	* (stored in user1 data of QAOB)
	256	*/
	257	struct qdio_outbuf_state {
	258	u8 flags;
104ea556	259	void *user;
	260	};
	261
104ea556	262	#define QDIO_OUTBUF_STATE_FLAG_PENDING 0x01
	263
	264	#define CHSC_AC1_INITIATE_INPUTQ 0x80
	265
9cb7284f	266
	267	/* qdio adapter-characteristics-1 flag */
	268	#define AC1_SIGA_INPUT_NEEDED 0x40 /* process input queues */
	269	#define AC1_SIGA_OUTPUT_NEEDED 0x20 /* process output queues */
	270	#define AC1_SIGA_SYNC_NEEDED 0x10 /* ask hypervisor to sync */
	271	#define AC1_AUTOMATIC_SYNC_ON_THININT 0x08 /* set by hypervisor */
	272	#define AC1_AUTOMATIC_SYNC_ON_OUT_PCI 0x04 /* set by hypervisor */
	273	#define AC1_SC_QEBSM_AVAILABLE 0x02 /* available for subchannel */
	274	#define AC1_SC_QEBSM_ENABLED 0x01 /* enabled for subchannel */
	275
050276ab SM	276	#define CHSC_AC2_MULTI_BUFFER_AVAILABLE 0x0080
050276ab SM	277	#define CHSC_AC2_MULTI_BUFFER_ENABLED 0x0040
104ea556	278	#define CHSC_AC2_DATA_DIV_AVAILABLE 0x0010
	279	#define CHSC_AC2_DATA_DIV_ENABLED 0x0002
	280
	281	#define CHSC_AC3_FORMAT2_CQ_AVAILABLE 0x8000
	282
779e6e1c JG	283	struct qdio_ssqd_desc {
	284	u8 flags;
	285	u8:8;
	286	u16 sch;
	287	u8 qfmt;
	288	u8 parm;
	289	u8 qdioac1;
	290	u8 sch_class;
	291	u8 pcnt;
	292	u8 icnt;
	293	u8:8;
	294	u8 ocnt;
	295	u8:8;
	296	u8 mbccnt;
	297	u16 qdioac2;
	298	u64 sch_token;
7a0f4755 KDW	299	u8 mro;
7a0f4755 KDW	300	u8 mri;
104ea556	301	u16 qdioac3;
7a0f4755 KDW	302	u16:16;
	303	u8:8;
	304	u8 mmwc;
1da177e4 LT	305	} __attribute__ ((packed));
1da177e4 LT	306
779e6e1c JG	307	/* params are: ccw_device, qdio_error, queue_number,
	308	first element processed, number of elements processed, int_parm */
	309	typedef void qdio_handler_t(struct ccw_device *, unsigned int, int,
	310	int, int, unsigned long);
1da177e4	311
779e6e1c	312	/* qdio errors reported to the upper-layer program */
1549d13f JG	313	#define QDIO_ERROR_ACTIVATE 0x0001
	314	#define QDIO_ERROR_GET_BUF_STATE 0x0002
	315	#define QDIO_ERROR_SET_BUF_STATE 0x0004
	316	#define QDIO_ERROR_SLSB_STATE 0x0100
	317
	318	#define QDIO_ERROR_FATAL 0x00ff
	319	#define QDIO_ERROR_TEMPORARY 0xff00
1da177e4	320
779e6e1c JG	321	/* for qdio_cleanup */
	322	#define QDIO_FLAG_CLEANUP_USING_CLEAR 0x01
	323	#define QDIO_FLAG_CLEANUP_USING_HALT 0x02
	324
	325	/**
b4a96015	326	* struct qdio_initialize - qdio initialization data
779e6e1c JG	327	* @cdev: associated ccw device
779e6e1c JG	328	* @q_format: queue format
d655e5b4	329	* @qdr_ac: feature flags to set
779e6e1c JG	330	* @adapter_name: name for the adapter
	331	* @qib_param_field_format: format for qib_parm_field
	332	* @qib_param_field: pointer to 128 bytes or NULL, if no param field
dcc18f48	333	* @qib_rflags: rflags to set
779e6e1c JG	334	* @input_slib_elements: pointer to no_input_qs * 128 words of data or NULL
	335	* @output_slib_elements: pointer to no_output_qs * 128 words of data or NULL
	336	* @no_input_qs: number of input queues
	337	* @no_output_qs: number of output queues
	338	* @input_handler: handler to be called for input queues
	339	* @output_handler: handler to be called for output queues
e58b0d90	340	* @queue_start_poll_array: polling handlers (one per input queue or NULL)
d655e5b4	341	* @scan_threshold: # of in-use buffers that triggers scan on output queue
779e6e1c	342	* @int_parm: interruption parameter
779e6e1c JG	343	* @input_sbal_addr_array: address of no_input_qs * 128 pointers
779e6e1c JG	344	* @output_sbal_addr_array: address of no_output_qs * 128 pointers
104ea556	345	* @output_sbal_state_array: no_output_qs * 128 state info (for CQ or NULL)
1da177e4	346	*/
779e6e1c JG	347	struct qdio_initialize {
	348	struct ccw_device *cdev;
	349	unsigned char q_format;
dfe5bb50	350	unsigned char qdr_ac;
779e6e1c JG	351	unsigned char adapter_name[8];
	352	unsigned int qib_param_field_format;
	353	unsigned char *qib_param_field;
dcc18f48	354	unsigned char qib_rflags;
779e6e1c JG	355	unsigned long *input_slib_elements;
	356	unsigned long *output_slib_elements;
	357	unsigned int no_input_qs;
	358	unsigned int no_output_qs;
	359	qdio_handler_t *input_handler;
	360	qdio_handler_t *output_handler;
e58b0d90 SM	361	void (*queue_start_poll_array) (struct ccw_device , int,
e58b0d90 SM	362	unsigned long);
313dc689	363	unsigned int scan_threshold;
779e6e1c	364	unsigned long int_parm;
bdf11767 JW	365	struct qdio_buffer **input_sbal_addr_array;
bdf11767 JW	366	struct qdio_buffer **output_sbal_addr_array;
104ea556	367	struct qdio_outbuf_state *output_sbal_state_array;
779e6e1c JG	368	};
779e6e1c JG	369
1c59a861 EC	370	/**
	371	* enum qdio_brinfo_entry_type - type of address entry for qdio_brinfo_desc()
	372	* @l3_ipv6_addr: entry contains IPv6 address
	373	* @l3_ipv4_addr: entry contains IPv4 address
	374	* @l2_addr_lnid: entry contains MAC address and VLAN ID
	375	*/
	376	enum qdio_brinfo_entry_type {l3_ipv6_addr, l3_ipv4_addr, l2_addr_lnid};
	377
	378	/**
	379	* struct qdio_brinfo_entry_XXX - Address entry for qdio_brinfo_desc()
	380	* @nit: Network interface token
	381	* @addr: Address of one of the three types
	382	*
	383	* The struct is passed to the callback function by qdio_brinfo_desc()
	384	*/
	385	struct qdio_brinfo_entry_l3_ipv6 {
	386	u64 nit;
	387	struct { unsigned char _s6_addr[16]; } addr;
	388	} __packed;
	389	struct qdio_brinfo_entry_l3_ipv4 {
	390	u64 nit;
	391	struct { uint32_t _s_addr; } addr;
	392	} __packed;
	393	struct qdio_brinfo_entry_l2 {
	394	u64 nit;
	395	struct { u8 mac[6]; u16 lnid; } addr_lnid;
	396	} __packed;
	397
779e6e1c JG	398	#define QDIO_STATE_INACTIVE 0x00000002 /* after qdio_cleanup */
	399	#define QDIO_STATE_ESTABLISHED 0x00000004 /* after qdio_establish */
	400	#define QDIO_STATE_ACTIVE 0x00000008 /* after qdio_activate */
	401	#define QDIO_STATE_STOPPED 0x00000010 /* after queues went down */
	402
	403	#define QDIO_FLAG_SYNC_INPUT 0x01
	404	#define QDIO_FLAG_SYNC_OUTPUT 0x02
	405	#define QDIO_FLAG_PCI_OUT 0x10
	406
5245c924 SO	407	int qdio_alloc_buffers(struct qdio_buffer **buf, unsigned int count);
	408	void qdio_free_buffers(struct qdio_buffer **buf, unsigned int count);
	409	void qdio_reset_buffers(struct qdio_buffer **buf, unsigned int count);
	410
bbd50e17 JG	411	extern int qdio_allocate(struct qdio_initialize *);
bbd50e17 JG	412	extern int qdio_establish(struct qdio_initialize *);
779e6e1c	413	extern int qdio_activate(struct ccw_device *);
104ea556	414	extern void qdio_release_aob(struct qaob *);
d36deae7 JG	415	extern int do_QDIO(struct ccw_device *, unsigned int, int, unsigned int,
	416	unsigned int);
	417	extern int qdio_start_irq(struct ccw_device *, int);
	418	extern int qdio_stop_irq(struct ccw_device *, int);
	419	extern int qdio_get_next_buffers(struct ccw_device , int, int , int *);
7c47f5af JW	420	extern int qdio_inspect_queue(struct ccw_device *cdev, unsigned int nr,
	421	bool is_input, unsigned int *bufnr,
	422	unsigned int *error);
d36deae7	423	extern int qdio_shutdown(struct ccw_device *, int);
779e6e1c	424	extern int qdio_free(struct ccw_device *);
d36deae7	425	extern int qdio_get_ssqd_desc(struct ccw_device , struct qdio_ssqd_desc );
1c59a861 EC	426	extern int qdio_pnso_brinfo(struct subchannel_id schid,
	427	int cnc, u16 *response,
	428	void (cb)(void priv, enum qdio_brinfo_entry_type type,
	429	void *entry),
	430	void *priv);
1da177e4 LT	431
1da177e4 LT	432	#endif /* __QDIO_H__ */