[linux-block.git] / drivers / s390 / crypto / zcrypt_api.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 *  Copyright IBM Corp. 2001, 2019
 *  Author(s): Robert Burroughs
 *	       Eric Rossman (edrossma@us.ibm.com)
 *	       Cornelia Huck <cornelia.huck@de.ibm.com>
 *
 *  Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
 *  Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
 *				  Ralph Wuerthner <rwuerthn@de.ibm.com>
 *  MSGTYPE restruct:		  Holger Dengler <hd@linux.vnet.ibm.com>
 */

#ifndef _ZCRYPT_API_H_
#define _ZCRYPT_API_H_

#include <linux/atomic.h>
#include <asm/debug.h>
#include <asm/zcrypt.h>
#include "ap_bus.h"

/**
 * Supported device types
 */
#define ZCRYPT_CEX2C		5
#define ZCRYPT_CEX2A		6
#define ZCRYPT_CEX3C		7
#define ZCRYPT_CEX3A		8
#define ZCRYPT_CEX4	       10
#define ZCRYPT_CEX5	       11
#define ZCRYPT_CEX6	       12
#define ZCRYPT_CEX7	       13

/**
 * Large random numbers are pulled in 4096 byte chunks from the crypto cards
 * and stored in a page. Be careful when increasing this buffer due to size
 * limitations for AP requests.
 */
#define ZCRYPT_RNG_BUFFER_SIZE	4096

/*
 * Identifier for Crypto Request Performance Index
 */
enum crypto_ops {
	MEX_1K,
	MEX_2K,
	MEX_4K,
	CRT_1K,
	CRT_2K,
	CRT_4K,
	HWRNG,
	SECKEY,
	NUM_OPS
};

struct zcrypt_queue;

/* struct to hold tracking information for a userspace request/response */
struct zcrypt_track {
	int again_counter;		/* retry attempts counter */
	int last_qid;			/* last qid used */
	int last_rc;			/* last return code */
};

/* defines related to message tracking */
#define TRACK_AGAIN_MAX 10
#define TRACK_AGAIN_CARD_WEIGHT_PENALTY  1000
#define TRACK_AGAIN_QUEUE_WEIGHT_PENALTY 10000

struct zcrypt_ops {
	long (*rsa_modexpo)(struct zcrypt_queue *, struct ica_rsa_modexpo *);
	long (*rsa_modexpo_crt)(struct zcrypt_queue *,
				struct ica_rsa_modexpo_crt *);
	long (*send_cprb)(bool userspace, struct zcrypt_queue *, struct ica_xcRB *,
			  struct ap_message *);
	long (*send_ep11_cprb)(bool userspace, struct zcrypt_queue *, struct ep11_urb *,
			       struct ap_message *);
	long (*rng)(struct zcrypt_queue *, char *, struct ap_message *);
	struct list_head list;		/* zcrypt ops list. */
	struct module *owner;
	int variant;
	char name[128];
};

struct zcrypt_card {
	struct list_head list;		/* Device list. */
	struct list_head zqueues;	/* List of zcrypt queues */
	struct kref refcount;		/* device refcounting */
	struct ap_card *card;		/* The "real" ap card device. */
	int online;			/* User online/offline */

	int user_space_type;		/* User space device id. */
	char *type_string;		/* User space device name. */
	int min_mod_size;		/* Min number of bits. */
	int max_mod_size;		/* Max number of bits. */
	int max_exp_bit_length;
	const int *speed_rating;	/* Speed idx of crypto ops. */
	atomic_t load;			/* Utilization of the crypto device */

	int request_count;		/* # current requests. */
};

struct zcrypt_queue {
	struct list_head list;		/* Device list. */
	struct kref refcount;		/* device refcounting */
	struct zcrypt_card *zcard;
	struct zcrypt_ops *ops;		/* Crypto operations. */
	struct ap_queue *queue;		/* The "real" ap queue device. */
	int online;			/* User online/offline */

	atomic_t load;			/* Utilization of the crypto device */

	int request_count;		/* # current requests. */

	struct ap_message reply;	/* Per-device reply structure. */
};

/* transport layer rescanning */
extern atomic_t zcrypt_rescan_req;

extern spinlock_t zcrypt_list_lock;
extern int zcrypt_device_count;
extern struct list_head zcrypt_card_list;

#define for_each_zcrypt_card(_zc) \
	list_for_each_entry(_zc, &zcrypt_card_list, list)

#define for_each_zcrypt_queue(_zq, _zc) \
	list_for_each_entry(_zq, &(_zc)->zqueues, list)

struct zcrypt_card *zcrypt_card_alloc(void);
void zcrypt_card_free(struct zcrypt_card *);
void zcrypt_card_get(struct zcrypt_card *);
int zcrypt_card_put(struct zcrypt_card *);
int zcrypt_card_register(struct zcrypt_card *);
void zcrypt_card_unregister(struct zcrypt_card *);

struct zcrypt_queue *zcrypt_queue_alloc(size_t);
void zcrypt_queue_free(struct zcrypt_queue *);
void zcrypt_queue_get(struct zcrypt_queue *);
int zcrypt_queue_put(struct zcrypt_queue *);
int zcrypt_queue_register(struct zcrypt_queue *);
void zcrypt_queue_unregister(struct zcrypt_queue *);
void zcrypt_queue_force_online(struct zcrypt_queue *, int);

int zcrypt_rng_device_add(void);
void zcrypt_rng_device_remove(void);

void zcrypt_msgtype_register(struct zcrypt_ops *);
void zcrypt_msgtype_unregister(struct zcrypt_ops *);
struct zcrypt_ops *zcrypt_msgtype(unsigned char *, int);
int zcrypt_api_init(void);
void zcrypt_api_exit(void);
long zcrypt_send_cprb(struct ica_xcRB *xcRB);
long zcrypt_send_ep11_cprb(struct ep11_urb *urb);
void zcrypt_device_status_mask_ext(struct zcrypt_device_status_ext *devstatus);
int zcrypt_device_status_ext(int card, int queue,
			     struct zcrypt_device_status_ext *devstatus);

static inline unsigned long z_copy_from_user(bool userspace,
					     void *to,
					     const void __user *from,
					     unsigned long n)
{
	if (likely(userspace))
		return copy_from_user(to, from, n);
	memcpy(to, (void __force *) from, n);
	return 0;
}

static inline unsigned long z_copy_to_user(bool userspace,
					   void __user *to,
					   const void *from,
					   unsigned long n)
{
	if (likely(userspace))
		return copy_to_user(to, from, n);
	memcpy((void __force *) to, from, n);
	return 0;
}

#endif /* _ZCRYPT_API_H_ */
Commit	Line	Data
ac2b96f3	1	/* SPDX-License-Identifier: GPL-2.0+ */
2dbc2418	2	/*
cf2957f3	3	* Copyright IBM Corp. 2001, 2019
2dbc2418 MS	4	* Author(s): Robert Burroughs
	5	* Eric Rossman (edrossma@us.ibm.com)
	6	* Cornelia Huck <cornelia.huck@de.ibm.com>
	7	*
	8	* Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
	9	* Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
	10	* Ralph Wuerthner <rwuerthn@de.ibm.com>
5e55a488	11	* MSGTYPE restruct: Holger Dengler <hd@linux.vnet.ibm.com>
2dbc2418 MS	12	*/
	13
	14	#ifndef _ZCRYPT_API_H_
	15	#define _ZCRYPT_API_H_
	16
dabecb29 HD	17	#include <linux/atomic.h>
dabecb29 HD	18	#include <asm/debug.h>
2dbc2418	19	#include <asm/zcrypt.h>
dabecb29	20	#include "ap_bus.h"
2dbc2418	21
2dbc2418	22	/**
ee410de8	23	* Supported device types
2dbc2418	24	*/
2dbc2418 MS	25	#define ZCRYPT_CEX2C 5
2dbc2418 MS	26	#define ZCRYPT_CEX2A 6
8e89b6be FB	27	#define ZCRYPT_CEX3C 7
8e89b6be FB	28	#define ZCRYPT_CEX3A 8
91f3e3ea	29	#define ZCRYPT_CEX4 10
bdea1f1b	30	#define ZCRYPT_CEX5 11
21214b04	31	#define ZCRYPT_CEX6 12
cf2957f3	32	#define ZCRYPT_CEX7 13
2dbc2418	33
2f7c8bd6 RW	34	/**
2f7c8bd6 RW	35	* Large random numbers are pulled in 4096 byte chunks from the crypto cards
25985edc	36	* and stored in a page. Be careful when increasing this buffer due to size
2f7c8bd6 RW	37	* limitations for AP requests.
	38	*/
	39	#define ZCRYPT_RNG_BUFFER_SIZE 4096
	40
34a15167 IT	41	/*
	42	* Identifier for Crypto Request Performance Index
	43	*/
	44	enum crypto_ops {
e28d2af4	45	MEX_1K,
34a15167 IT	46	MEX_2K,
	47	MEX_4K,
	48	CRT_1K,
	49	CRT_2K,
	50	CRT_4K,
	51	HWRNG,
	52	SECKEY,
	53	NUM_OPS
	54	};
	55
e28d2af4	56	struct zcrypt_queue;
2dbc2418	57
91ffc519 HF	58	/* struct to hold tracking information for a userspace request/response */
	59	struct zcrypt_track {
	60	int again_counter; /* retry attempts counter */
	61	int last_qid; /* last qid used */
	62	int last_rc; /* last return code */
	63	};
	64
	65	/* defines related to message tracking */
	66	#define TRACK_AGAIN_MAX 10
	67	#define TRACK_AGAIN_CARD_WEIGHT_PENALTY 1000
	68	#define TRACK_AGAIN_QUEUE_WEIGHT_PENALTY 10000
	69
2dbc2418	70	struct zcrypt_ops {
e28d2af4 IT	71	long (rsa_modexpo)(struct zcrypt_queue , struct ica_rsa_modexpo *);
e28d2af4 IT	72	long (rsa_modexpo_crt)(struct zcrypt_queue ,
2dbc2418	73	struct ica_rsa_modexpo_crt *);
52f72feb	74	long (send_cprb)(bool userspace, struct zcrypt_queue , struct ica_xcRB *,
34a15167	75	struct ap_message *);
52f72feb	76	long (send_ep11_cprb)(bool userspace, struct zcrypt_queue , struct ep11_urb *,
34a15167	77	struct ap_message *);
e28d2af4	78	long (rng)(struct zcrypt_queue , char , struct ap_message );
5e55a488 HD	79	struct list_head list; /* zcrypt ops list. */
	80	struct module *owner;
	81	int variant;
121a868d	82	char name[128];
2dbc2418 MS	83	};
2dbc2418 MS	84
e28d2af4	85	struct zcrypt_card {
2dbc2418	86	struct list_head list; /* Device list. */
e28d2af4	87	struct list_head zqueues; /* List of zcrypt queues */
2dbc2418	88	struct kref refcount; /* device refcounting */
e28d2af4	89	struct ap_card card; / The "real" ap card device. */
2dbc2418 MS	90	int online; /* User online/offline */
	91
	92	int user_space_type; /* User space device id. */
	93	char type_string; / User space device name. */
	94	int min_mod_size; /* Min number of bits. */
	95	int max_mod_size; /* Max number of bits. */
e28d2af4	96	int max_exp_bit_length;
91ffc519	97	const int speed_rating; / Speed idx of crypto ops. */
e28d2af4 IT	98	atomic_t load; /* Utilization of the crypto device */
	99
	100	int request_count; /* # current requests. */
e28d2af4 IT	101	};
	102
	103	struct zcrypt_queue {
	104	struct list_head list; /* Device list. */
	105	struct kref refcount; /* device refcounting */
	106	struct zcrypt_card *zcard;
	107	struct zcrypt_ops ops; / Crypto operations. */
	108	struct ap_queue queue; / The "real" ap queue device. */
	109	int online; /* User online/offline */
	110
	111	atomic_t load; /* Utilization of the crypto device */
2dbc2418 MS	112
	113	int request_count; /* # current requests. */
	114
	115	struct ap_message reply; /* Per-device reply structure. */
	116	};
	117
dabecb29 HD	118	/* transport layer rescanning */
	119	extern atomic_t zcrypt_rescan_req;
	120
e28d2af4 IT	121	extern spinlock_t zcrypt_list_lock;
	122	extern int zcrypt_device_count;
	123	extern struct list_head zcrypt_card_list;
	124
e28d2af4 IT	125	#define for_each_zcrypt_card(_zc) \
	126	list_for_each_entry(_zc, &zcrypt_card_list, list)
	127
	128	#define for_each_zcrypt_queue(_zq, _zc) \
	129	list_for_each_entry(_zq, &(_zc)->zqueues, list)
	130
	131	struct zcrypt_card *zcrypt_card_alloc(void);
	132	void zcrypt_card_free(struct zcrypt_card *);
	133	void zcrypt_card_get(struct zcrypt_card *);
	134	int zcrypt_card_put(struct zcrypt_card *);
	135	int zcrypt_card_register(struct zcrypt_card *);
	136	void zcrypt_card_unregister(struct zcrypt_card *);
e28d2af4 IT	137
	138	struct zcrypt_queue *zcrypt_queue_alloc(size_t);
	139	void zcrypt_queue_free(struct zcrypt_queue *);
	140	void zcrypt_queue_get(struct zcrypt_queue *);
	141	int zcrypt_queue_put(struct zcrypt_queue *);
	142	int zcrypt_queue_register(struct zcrypt_queue *);
	143	void zcrypt_queue_unregister(struct zcrypt_queue *);
	144	void zcrypt_queue_force_online(struct zcrypt_queue *, int);
e28d2af4 IT	145
	146	int zcrypt_rng_device_add(void);
	147	void zcrypt_rng_device_remove(void);
	148
5e55a488 HD	149	void zcrypt_msgtype_register(struct zcrypt_ops *);
5e55a488 HD	150	void zcrypt_msgtype_unregister(struct zcrypt_ops *);
236fb2ab	151	struct zcrypt_ops zcrypt_msgtype(unsigned char , int);
2dbc2418 MS	152	int zcrypt_api_init(void);
2dbc2418 MS	153	void zcrypt_api_exit(void);
a1d001e2	154	long zcrypt_send_cprb(struct ica_xcRB *xcRB);
a7367997	155	long zcrypt_send_ep11_cprb(struct ep11_urb *urb);
af4a7227	156	void zcrypt_device_status_mask_ext(struct zcrypt_device_status_ext *devstatus);
4da57a2f HF	157	int zcrypt_device_status_ext(int card, int queue,
4da57a2f HF	158	struct zcrypt_device_status_ext *devstatus);
2dbc2418	159
52f72feb HF	160	static inline unsigned long z_copy_from_user(bool userspace,
	161	void *to,
	162	const void __user *from,
	163	unsigned long n)
	164	{
	165	if (likely(userspace))
	166	return copy_from_user(to, from, n);
	167	memcpy(to, (void __force *) from, n);
	168	return 0;
	169	}
	170
	171	static inline unsigned long z_copy_to_user(bool userspace,
	172	void __user *to,
	173	const void *from,
	174	unsigned long n)
	175	{
	176	if (likely(userspace))
	177	return copy_to_user(to, from, n);
	178	memcpy((void __force *) to, from, n);
	179	return 0;
	180	}
	181
2dbc2418	182	#endif /* _ZCRYPT_API_H_ */