[mirror_ubuntu-zesty-kernel.git] / drivers / s390 / crypto / ap_bus.h

/*
 * Copyright IBM Corp. 2006, 2012
 * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
 *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
 *	      Ralph Wuerthner <rwuerthn@de.ibm.com>
 *	      Felix Beck <felix.beck@de.ibm.com>
 *	      Holger Dengler <hd@linux.vnet.ibm.com>
 *
 * Adjunct processor bus header file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _AP_BUS_H_
#define _AP_BUS_H_

#include <linux/device.h>
#include <linux/mod_devicetable.h>
#include <linux/types.h>

#define AP_DEVICES 64		/* Number of AP devices. */
#define AP_DOMAINS 256		/* Number of AP domains. */
#define AP_RESET_TIMEOUT (HZ*0.7)	/* Time in ticks for reset timeouts. */
#define AP_CONFIG_TIME 30	/* Time in seconds between AP bus rescans. */
#define AP_POLL_TIME 1		/* Time in ticks between receive polls. */

#define AP_POLL_IMMEDIATELY	1 /* continue running poll tasklet */
#define AP_POLL_AFTER_TIMEOUT	2 /* run poll tasklet again after timout */

extern int ap_domain_index;

/**
 * The ap_qid_t identifier of an ap queue. It contains a
 * 6 bit device index and a 4 bit queue index (domain).
 */
typedef unsigned int ap_qid_t;

#define AP_MKQID(_device, _queue) (((_device) & 63) << 8 | ((_queue) & 255))
#define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63)
#define AP_QID_QUEUE(_qid) ((_qid) & 255)

/**
 * structy ap_queue_status - Holds the AP queue status.
 * @queue_empty: Shows if queue is empty
 * @replies_waiting: Waiting replies
 * @queue_full: Is 1 if the queue is full
 * @pad: A 4 bit pad
 * @int_enabled: Shows if interrupts are enabled for the AP
 * @response_conde: Holds the 8 bit response code
 * @pad2: A 16 bit pad
 *
 * The ap queue status word is returned by all three AP functions
 * (PQAP, NQAP and DQAP).  There's a set of flags in the first
 * byte, followed by a 1 byte response code.
 */
struct ap_queue_status {
	unsigned int queue_empty	: 1;
	unsigned int replies_waiting	: 1;
	unsigned int queue_full		: 1;
	unsigned int pad1		: 4;
	unsigned int int_enabled	: 1;
	unsigned int response_code	: 8;
	unsigned int pad2		: 16;
} __packed;


#define AP_MAX_BITS 31
static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
{
	if (nr > AP_MAX_BITS)
		return 0;
	return (*ptr & (0x80000000u >> nr)) != 0;
}

#define AP_RESPONSE_NORMAL		0x00
#define AP_RESPONSE_Q_NOT_AVAIL		0x01
#define AP_RESPONSE_RESET_IN_PROGRESS	0x02
#define AP_RESPONSE_DECONFIGURED	0x03
#define AP_RESPONSE_CHECKSTOPPED	0x04
#define AP_RESPONSE_BUSY		0x05
#define AP_RESPONSE_INVALID_ADDRESS	0x06
#define AP_RESPONSE_OTHERWISE_CHANGED	0x07
#define AP_RESPONSE_Q_FULL		0x10
#define AP_RESPONSE_NO_PENDING_REPLY	0x10
#define AP_RESPONSE_INDEX_TOO_BIG	0x11
#define AP_RESPONSE_NO_FIRST_PART	0x13
#define AP_RESPONSE_MESSAGE_TOO_BIG	0x15
#define AP_RESPONSE_REQ_FAC_NOT_INST	0x16

/*
 * Known device types
 */
#define AP_DEVICE_TYPE_PCICC	3
#define AP_DEVICE_TYPE_PCICA	4
#define AP_DEVICE_TYPE_PCIXCC	5
#define AP_DEVICE_TYPE_CEX2A	6
#define AP_DEVICE_TYPE_CEX2C	7
#define AP_DEVICE_TYPE_CEX3A	8
#define AP_DEVICE_TYPE_CEX3C	9
#define AP_DEVICE_TYPE_CEX4	10
#define AP_DEVICE_TYPE_CEX5	11

/*
 * Known function facilities
 */
#define AP_FUNC_MEX4K 1
#define AP_FUNC_CRT4K 2
#define AP_FUNC_COPRO 3
#define AP_FUNC_ACCEL 4
#define AP_FUNC_EP11  5
#define AP_FUNC_APXA  6

/*
 * AP reset flag states
 */
#define AP_RESET_IGNORE	0	/* request timeout will be ignored */
#define AP_RESET_ARMED	1	/* request timeout timer is active */
#define AP_RESET_DO	2	/* AP reset required */
#define AP_RESET_IN_PROGRESS	3	/* AP reset in progress */

/*
 * AP interrupt states
 */
#define AP_INTR_DISABLED	0	/* AP interrupt disabled */
#define AP_INTR_ENABLED		1	/* AP interrupt enabled */
#define AP_INTR_IN_PROGRESS	3	/* AP interrupt in progress */

struct ap_device;
struct ap_message;

struct ap_driver {
	struct device_driver driver;
	struct ap_device_id *ids;

	int (*probe)(struct ap_device *);
	void (*remove)(struct ap_device *);
	int request_timeout;		/* request timeout in jiffies */
};

#define to_ap_drv(x) container_of((x), struct ap_driver, driver)

int ap_driver_register(struct ap_driver *, struct module *, char *);
void ap_driver_unregister(struct ap_driver *);

struct ap_device {
	struct device device;
	struct ap_driver *drv;		/* Pointer to AP device driver. */
	spinlock_t lock;		/* Per device lock. */
	struct list_head list;		/* private list of all AP devices. */

	ap_qid_t qid;			/* AP queue id. */
	int queue_depth;		/* AP queue depth.*/
	int device_type;		/* AP device type. */
	int raw_hwtype;			/* AP raw hardware type. */
	unsigned int functions;		/* AP device function bitfield. */
	int unregistered;		/* marks AP device as unregistered */
	struct timer_list timeout;	/* Timer for request timeouts. */
	int reset;			/* Reset required after req. timeout. */

	int interrupt;			/* indicate if interrupts are enabled */
	int queue_count;		/* # messages currently on AP queue. */

	struct list_head pendingq;	/* List of message sent to AP queue. */
	int pendingq_count;		/* # requests on pendingq list. */
	struct list_head requestq;	/* List of message yet to be sent. */
	int requestq_count;		/* # requests on requestq list. */
	int total_request_count;	/* # requests ever for this AP device. */

	struct ap_message *reply;	/* Per device reply message. */

	void *private;			/* ap driver private pointer. */
};

#define to_ap_dev(x) container_of((x), struct ap_device, device)

struct ap_message {
	struct list_head list;		/* Request queueing. */
	unsigned long long psmid;	/* Message id. */
	void *message;			/* Pointer to message buffer. */
	size_t length;			/* Message length. */

	void *private;			/* ap driver private pointer. */
	unsigned int special:1;		/* Used for special commands. */
	/* receive is called from tasklet context */
	void (*receive)(struct ap_device *, struct ap_message *,
			struct ap_message *);
};

struct ap_config_info {
	unsigned int special_command:1;
	unsigned int ap_extended:1;
	unsigned char reserved1:6;
	unsigned char reserved2[15];
	unsigned int apm[8];		/* AP ID mask */
	unsigned int aqm[8];		/* AP queue mask */
	unsigned int adm[8];		/* AP domain mask */
	unsigned char reserved4[16];
} __packed;

#define AP_DEVICE(dt)					\
	.dev_type=(dt),					\
	.match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE,

/**
 * ap_init_message() - Initialize ap_message.
 * Initialize a message before using. Otherwise this might result in
 * unexpected behaviour.
 */
static inline void ap_init_message(struct ap_message *ap_msg)
{
	ap_msg->psmid = 0;
	ap_msg->length = 0;
	ap_msg->special = 0;
	ap_msg->receive = NULL;
}

/*
 * Note: don't use ap_send/ap_recv after using ap_queue_message
 * for the first time. Otherwise the ap message queue will get
 * confused.
 */
int ap_send(ap_qid_t, unsigned long long, void *, size_t);
int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);

void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
void ap_flush_queue(struct ap_device *ap_dev);
void ap_bus_force_rescan(void);

int ap_module_init(void);
void ap_module_exit(void);

#endif /* _AP_BUS_H_ */
Commit	Line	Data
1534c382	1	/*
75014550	2	* Copyright IBM Corp. 2006, 2012
1534c382 MS	3	* Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
	4	* Martin Schwidefsky <schwidefsky@de.ibm.com>
	5	* Ralph Wuerthner <rwuerthn@de.ibm.com>
cb17a636	6	* Felix Beck <felix.beck@de.ibm.com>
6bed05bc	7	* Holger Dengler <hd@linux.vnet.ibm.com>
1534c382 MS	8	*
	9	* Adjunct processor bus header file.
	10	*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License as published by
	13	* the Free Software Foundation; either version 2, or (at your option)
	14	* any later version.
	15	*
	16	* This program is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	* GNU General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	24	*/
	25
	26	#ifndef _AP_BUS_H_
	27	#define _AP_BUS_H_
	28
	29	#include <linux/device.h>
	30	#include <linux/mod_devicetable.h>
	31	#include <linux/types.h>
	32
	33	#define AP_DEVICES 64 /* Number of AP devices. */
170387a8	34	#define AP_DOMAINS 256 /* Number of AP domains. */
91f3e3ea	35	#define AP_RESET_TIMEOUT (HZ0.7) / Time in ticks for reset timeouts. */
1534c382 MS	36	#define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */
	37	#define AP_POLL_TIME 1 /* Time in ticks between receive polls. */
	38
c50a160c IT	39	#define AP_POLL_IMMEDIATELY 1 /* continue running poll tasklet */
	40	#define AP_POLL_AFTER_TIMEOUT 2 /* run poll tasklet again after timout */
	41
1534c382 MS	42	extern int ap_domain_index;
	43
	44	/**
	45	* The ap_qid_t identifier of an ap queue. It contains a
	46	* 6 bit device index and a 4 bit queue index (domain).
	47	*/
	48	typedef unsigned int ap_qid_t;
	49
170387a8	50	#define AP_MKQID(_device, _queue) (((_device) & 63) << 8 \| ((_queue) & 255))
1534c382	51	#define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63)
170387a8	52	#define AP_QID_QUEUE(_qid) ((_qid) & 255)
1534c382 MS	53
1534c382 MS	54	/**
1749a81d FB	55	* structy ap_queue_status - Holds the AP queue status.
	56	* @queue_empty: Shows if queue is empty
	57	* @replies_waiting: Waiting replies
	58	* @queue_full: Is 1 if the queue is full
	59	* @pad: A 4 bit pad
	60	* @int_enabled: Shows if interrupts are enabled for the AP
	61	* @response_conde: Holds the 8 bit response code
	62	* @pad2: A 16 bit pad
	63	*
1534c382 MS	64	* The ap queue status word is returned by all three AP functions
	65	* (PQAP, NQAP and DQAP). There's a set of flags in the first
	66	* byte, followed by a 1 byte response code.
	67	*/
	68	struct ap_queue_status {
	69	unsigned int queue_empty : 1;
	70	unsigned int replies_waiting : 1;
	71	unsigned int queue_full : 1;
cb17a636 FB	72	unsigned int pad1 : 4;
cb17a636 FB	73	unsigned int int_enabled : 1;
1534c382 MS	74	unsigned int response_code : 8;
1534c382 MS	75	unsigned int pad2 : 16;
6bed05bc HD	76	} __packed;
6bed05bc HD	77
6bed05bc	78
75014550 HD	79	#define AP_MAX_BITS 31
75014550 HD	80	static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
6bed05bc	81	{
75014550	82	if (nr > AP_MAX_BITS)
6bed05bc	83	return 0;
75014550	84	return (*ptr & (0x80000000u >> nr)) != 0;
6bed05bc	85	}
1534c382 MS	86
	87	#define AP_RESPONSE_NORMAL 0x00
	88	#define AP_RESPONSE_Q_NOT_AVAIL 0x01
	89	#define AP_RESPONSE_RESET_IN_PROGRESS 0x02
	90	#define AP_RESPONSE_DECONFIGURED 0x03
	91	#define AP_RESPONSE_CHECKSTOPPED 0x04
	92	#define AP_RESPONSE_BUSY 0x05
cb17a636 FB	93	#define AP_RESPONSE_INVALID_ADDRESS 0x06
cb17a636 FB	94	#define AP_RESPONSE_OTHERWISE_CHANGED 0x07
1534c382 MS	95	#define AP_RESPONSE_Q_FULL 0x10
	96	#define AP_RESPONSE_NO_PENDING_REPLY 0x10
	97	#define AP_RESPONSE_INDEX_TOO_BIG 0x11
	98	#define AP_RESPONSE_NO_FIRST_PART 0x13
	99	#define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
a6a5d73a	100	#define AP_RESPONSE_REQ_FAC_NOT_INST 0x16
1534c382	101
1749a81d	102	/*
1534c382 MS	103	* Known device types
	104	*/
	105	#define AP_DEVICE_TYPE_PCICC 3
	106	#define AP_DEVICE_TYPE_PCICA 4
	107	#define AP_DEVICE_TYPE_PCIXCC 5
	108	#define AP_DEVICE_TYPE_CEX2A 6
	109	#define AP_DEVICE_TYPE_CEX2C 7
ffda4f71 FB	110	#define AP_DEVICE_TYPE_CEX3A 8
ffda4f71 FB	111	#define AP_DEVICE_TYPE_CEX3C 9
1e2076f4	112	#define AP_DEVICE_TYPE_CEX4 10
bdea1f1b	113	#define AP_DEVICE_TYPE_CEX5 11
1534c382	114
b26bd941 HD	115	/*
	116	* Known function facilities
	117	*/
	118	#define AP_FUNC_MEX4K 1
	119	#define AP_FUNC_CRT4K 2
	120	#define AP_FUNC_COPRO 3
	121	#define AP_FUNC_ACCEL 4
91f3e3ea IT	122	#define AP_FUNC_EP11 5
91f3e3ea IT	123	#define AP_FUNC_APXA 6
b26bd941	124
1749a81d	125	/*
af512ed0 RW	126	* AP reset flag states
	127	*/
	128	#define AP_RESET_IGNORE 0 /* request timeout will be ignored */
	129	#define AP_RESET_ARMED 1 /* request timeout timer is active */
	130	#define AP_RESET_DO 2 /* AP reset required */
c50a160c IT	131	#define AP_RESET_IN_PROGRESS 3 /* AP reset in progress */
	132
	133	/*
	134	* AP interrupt states
	135	*/
	136	#define AP_INTR_DISABLED 0 /* AP interrupt disabled */
	137	#define AP_INTR_ENABLED 1 /* AP interrupt enabled */
	138	#define AP_INTR_IN_PROGRESS 3 /* AP interrupt in progress */
af512ed0	139
1534c382 MS	140	struct ap_device;
	141	struct ap_message;
	142
	143	struct ap_driver {
	144	struct device_driver driver;
	145	struct ap_device_id *ids;
	146
	147	int (probe)(struct ap_device );
	148	void (remove)(struct ap_device );
af512ed0	149	int request_timeout; /* request timeout in jiffies */
1534c382 MS	150	};
	151
	152	#define to_ap_drv(x) container_of((x), struct ap_driver, driver)
	153
	154	int ap_driver_register(struct ap_driver , struct module , char *);
	155	void ap_driver_unregister(struct ap_driver *);
	156
	157	struct ap_device {
	158	struct device device;
	159	struct ap_driver drv; / Pointer to AP device driver. */
	160	spinlock_t lock; /* Per device lock. */
cf352ce0	161	struct list_head list; /* private list of all AP devices. */
1534c382 MS	162
	163	ap_qid_t qid; /* AP queue id. */
	164	int queue_depth; /* AP queue depth.*/
	165	int device_type; /* AP device type. */
42f4dd61	166	int raw_hwtype; /* AP raw hardware type. */
b26bd941	167	unsigned int functions; /* AP device function bitfield. */
1534c382	168	int unregistered; /* marks AP device as unregistered */
af512ed0 RW	169	struct timer_list timeout; /* Timer for request timeouts. */
af512ed0 RW	170	int reset; /* Reset required after req. timeout. */
1534c382	171
c50a160c	172	int interrupt; /* indicate if interrupts are enabled */
1534c382 MS	173	int queue_count; /* # messages currently on AP queue. */
	174
	175	struct list_head pendingq; /* List of message sent to AP queue. */
	176	int pendingq_count; /* # requests on pendingq list. */
	177	struct list_head requestq; /* List of message yet to be sent. */
	178	int requestq_count; /* # requests on requestq list. */
	179	int total_request_count; /* # requests ever for this AP device. */
	180
	181	struct ap_message reply; / Per device reply message. */
	182
	183	void private; / ap driver private pointer. */
	184	};
	185
	186	#define to_ap_dev(x) container_of((x), struct ap_device, device)
	187
	188	struct ap_message {
	189	struct list_head list; /* Request queueing. */
	190	unsigned long long psmid; /* Message id. */
	191	void message; / Pointer to message buffer. */
	192	size_t length; /* Message length. */
	193
	194	void private; / ap driver private pointer. */
a6a5d73a	195	unsigned int special:1; /* Used for special commands. */
54a8f561 HD	196	/* receive is called from tasklet context */
	197	void (receive)(struct ap_device , struct ap_message *,
	198	struct ap_message *);
1534c382 MS	199	};
1534c382 MS	200
75014550 HD	201	struct ap_config_info {
	202	unsigned int special_command:1;
	203	unsigned int ap_extended:1;
	204	unsigned char reserved1:6;
	205	unsigned char reserved2[15];
	206	unsigned int apm[8]; /* AP ID mask */
	207	unsigned int aqm[8]; /* AP queue mask */
	208	unsigned int adm[8]; /* AP domain mask */
	209	unsigned char reserved4[16];
	210	} __packed;
	211
1534c382 MS	212	#define AP_DEVICE(dt) \
	213	.dev_type=(dt), \
	214	.match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE,
	215
468ffddf FB	216	/**
	217	* ap_init_message() - Initialize ap_message.
	218	* Initialize a message before using. Otherwise this might result in
	219	* unexpected behaviour.
	220	*/
	221	static inline void ap_init_message(struct ap_message *ap_msg)
	222	{
	223	ap_msg->psmid = 0;
	224	ap_msg->length = 0;
a6a5d73a	225	ap_msg->special = 0;
54a8f561	226	ap_msg->receive = NULL;
468ffddf FB	227	}
468ffddf FB	228
1749a81d	229	/*
1534c382 MS	230	* Note: don't use ap_send/ap_recv after using ap_queue_message
	231	* for the first time. Otherwise the ap message queue will get
	232	* confused.
	233	*/
	234	int ap_send(ap_qid_t, unsigned long long, void *, size_t);
	235	int ap_recv(ap_qid_t, unsigned long long , void , size_t);
	236
	237	void ap_queue_message(struct ap_device ap_dev, struct ap_message ap_msg);
	238	void ap_cancel_message(struct ap_device ap_dev, struct ap_message ap_msg);
	239	void ap_flush_queue(struct ap_device *ap_dev);
dabecb29	240	void ap_bus_force_rescan(void);
1534c382 MS	241
	242	int ap_module_init(void);
	243	void ap_module_exit(void);
	244
	245	#endif /* _AP_BUS_H_ */