xref: /linux/drivers/s390/crypto/zcrypt_api.h (revision 95e9fd10f06cb5642028b6b851e32b8c8afb4571)
1 /*
2  *  zcrypt 2.1.0
3  *
4  *  Copyright IBM Corp. 2001, 2006
5  *  Author(s): Robert Burroughs
6  *	       Eric Rossman (edrossma@us.ibm.com)
7  *	       Cornelia Huck <cornelia.huck@de.ibm.com>
8  *
9  *  Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
10  *  Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
11  *				  Ralph Wuerthner <rwuerthn@de.ibm.com>
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2, or (at your option)
16  * any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26  */
27 
28 #ifndef _ZCRYPT_API_H_
29 #define _ZCRYPT_API_H_
30 
31 #include "ap_bus.h"
32 #include <asm/zcrypt.h>
33 
34 /* deprecated status calls */
35 #define ICAZ90STATUS		_IOR(ZCRYPT_IOCTL_MAGIC, 0x10, struct ica_z90_status)
36 #define Z90STAT_PCIXCCCOUNT	_IOR(ZCRYPT_IOCTL_MAGIC, 0x43, int)
37 
38 /**
39  * This structure is deprecated and the corresponding ioctl() has been
40  * replaced with individual ioctl()s for each piece of data!
41  */
42 struct ica_z90_status {
43 	int totalcount;
44 	int leedslitecount; // PCICA
45 	int leeds2count;    // PCICC
46 	// int PCIXCCCount; is not in struct for backward compatibility
47 	int requestqWaitCount;
48 	int pendingqWaitCount;
49 	int totalOpenCount;
50 	int cryptoDomain;
51 	// status: 0=not there, 1=PCICA, 2=PCICC, 3=PCIXCC_MCL2, 4=PCIXCC_MCL3,
52 	//	   5=CEX2C
53 	unsigned char status[64];
54 	// qdepth: # work elements waiting for each device
55 	unsigned char qdepth[64];
56 };
57 
58 /**
59  * device type for an actual device is either PCICA, PCICC, PCIXCC_MCL2,
60  * PCIXCC_MCL3, CEX2C, or CEX2A
61  *
62  * NOTE: PCIXCC_MCL3 refers to a PCIXCC with May 2004 version of Licensed
63  *	 Internal Code (LIC) (EC J12220 level 29).
64  *	 PCIXCC_MCL2 refers to any LIC before this level.
65  */
66 #define ZCRYPT_PCICA		1
67 #define ZCRYPT_PCICC		2
68 #define ZCRYPT_PCIXCC_MCL2	3
69 #define ZCRYPT_PCIXCC_MCL3	4
70 #define ZCRYPT_CEX2C		5
71 #define ZCRYPT_CEX2A		6
72 #define ZCRYPT_CEX3C		7
73 #define ZCRYPT_CEX3A		8
74 
75 /**
76  * Large random numbers are pulled in 4096 byte chunks from the crypto cards
77  * and stored in a page. Be careful when increasing this buffer due to size
78  * limitations for AP requests.
79  */
80 #define ZCRYPT_RNG_BUFFER_SIZE	4096
81 
82 struct zcrypt_device;
83 
84 struct zcrypt_ops {
85 	long (*rsa_modexpo)(struct zcrypt_device *, struct ica_rsa_modexpo *);
86 	long (*rsa_modexpo_crt)(struct zcrypt_device *,
87 				struct ica_rsa_modexpo_crt *);
88 	long (*send_cprb)(struct zcrypt_device *, struct ica_xcRB *);
89 	long (*rng)(struct zcrypt_device *, char *);
90 };
91 
92 struct zcrypt_device {
93 	struct list_head list;		/* Device list. */
94 	spinlock_t lock;		/* Per device lock. */
95 	struct kref refcount;		/* device refcounting */
96 	struct ap_device *ap_dev;	/* The "real" ap device. */
97 	struct zcrypt_ops *ops;		/* Crypto operations. */
98 	int online;			/* User online/offline */
99 
100 	int user_space_type;		/* User space device id. */
101 	char *type_string;		/* User space device name. */
102 	int min_mod_size;		/* Min number of bits. */
103 	int max_mod_size;		/* Max number of bits. */
104 	int short_crt;			/* Card has crt length restriction. */
105 	int speed_rating;		/* Speed of the crypto device. */
106 
107 	int request_count;		/* # current requests. */
108 
109 	struct ap_message reply;	/* Per-device reply structure. */
110 	int max_exp_bit_length;
111 };
112 
113 struct zcrypt_device *zcrypt_device_alloc(size_t);
114 void zcrypt_device_free(struct zcrypt_device *);
115 void zcrypt_device_get(struct zcrypt_device *);
116 int zcrypt_device_put(struct zcrypt_device *);
117 int zcrypt_device_register(struct zcrypt_device *);
118 void zcrypt_device_unregister(struct zcrypt_device *);
119 int zcrypt_api_init(void);
120 void zcrypt_api_exit(void);
121 
122 #endif /* _ZCRYPT_API_H_ */
123