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