Loading...
1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright IBM Corp. 2001, 2019
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>
11 * MSGTYPE restruct: Holger Dengler <hd@linux.vnet.ibm.com>
12 */
13
14#ifndef _ZCRYPT_API_H_
15#define _ZCRYPT_API_H_
16
17#include <linux/atomic.h>
18#include <asm/debug.h>
19#include <asm/zcrypt.h>
20#include "ap_bus.h"
21
22/**
23 * Supported device types
24 */
25#define ZCRYPT_CEX2C 5
26#define ZCRYPT_CEX2A 6
27#define ZCRYPT_CEX3C 7
28#define ZCRYPT_CEX3A 8
29#define ZCRYPT_CEX4 10
30#define ZCRYPT_CEX5 11
31#define ZCRYPT_CEX6 12
32#define ZCRYPT_CEX7 13
33
34/**
35 * Large random numbers are pulled in 4096 byte chunks from the crypto cards
36 * and stored in a page. Be careful when increasing this buffer due to size
37 * limitations for AP requests.
38 */
39#define ZCRYPT_RNG_BUFFER_SIZE 4096
40
41/*
42 * Identifier for Crypto Request Performance Index
43 */
44enum crypto_ops {
45 MEX_1K,
46 MEX_2K,
47 MEX_4K,
48 CRT_1K,
49 CRT_2K,
50 CRT_4K,
51 HWRNG,
52 SECKEY,
53 NUM_OPS
54};
55
56struct zcrypt_queue;
57
58struct zcrypt_ops {
59 long (*rsa_modexpo)(struct zcrypt_queue *, struct ica_rsa_modexpo *);
60 long (*rsa_modexpo_crt)(struct zcrypt_queue *,
61 struct ica_rsa_modexpo_crt *);
62 long (*send_cprb)(struct zcrypt_queue *, struct ica_xcRB *,
63 struct ap_message *);
64 long (*send_ep11_cprb)(struct zcrypt_queue *, struct ep11_urb *,
65 struct ap_message *);
66 long (*rng)(struct zcrypt_queue *, char *, struct ap_message *);
67 struct list_head list; /* zcrypt ops list. */
68 struct module *owner;
69 int variant;
70 char name[128];
71};
72
73struct zcrypt_card {
74 struct list_head list; /* Device list. */
75 struct list_head zqueues; /* List of zcrypt queues */
76 struct kref refcount; /* device refcounting */
77 struct ap_card *card; /* The "real" ap card device. */
78 int online; /* User online/offline */
79
80 int user_space_type; /* User space device id. */
81 char *type_string; /* User space device name. */
82 int min_mod_size; /* Min number of bits. */
83 int max_mod_size; /* Max number of bits. */
84 int max_exp_bit_length;
85 int speed_rating[NUM_OPS]; /* Speed idx of crypto ops. */
86 atomic_t load; /* Utilization of the crypto device */
87
88 int request_count; /* # current requests. */
89};
90
91struct zcrypt_queue {
92 struct list_head list; /* Device list. */
93 struct kref refcount; /* device refcounting */
94 struct zcrypt_card *zcard;
95 struct zcrypt_ops *ops; /* Crypto operations. */
96 struct ap_queue *queue; /* The "real" ap queue device. */
97 int online; /* User online/offline */
98
99 atomic_t load; /* Utilization of the crypto device */
100
101 int request_count; /* # current requests. */
102
103 struct ap_message reply; /* Per-device reply structure. */
104};
105
106/* transport layer rescanning */
107extern atomic_t zcrypt_rescan_req;
108
109extern spinlock_t zcrypt_list_lock;
110extern int zcrypt_device_count;
111extern struct list_head zcrypt_card_list;
112
113#define for_each_zcrypt_card(_zc) \
114 list_for_each_entry(_zc, &zcrypt_card_list, list)
115
116#define for_each_zcrypt_queue(_zq, _zc) \
117 list_for_each_entry(_zq, &(_zc)->zqueues, list)
118
119struct zcrypt_card *zcrypt_card_alloc(void);
120void zcrypt_card_free(struct zcrypt_card *);
121void zcrypt_card_get(struct zcrypt_card *);
122int zcrypt_card_put(struct zcrypt_card *);
123int zcrypt_card_register(struct zcrypt_card *);
124void zcrypt_card_unregister(struct zcrypt_card *);
125
126struct zcrypt_queue *zcrypt_queue_alloc(size_t);
127void zcrypt_queue_free(struct zcrypt_queue *);
128void zcrypt_queue_get(struct zcrypt_queue *);
129int zcrypt_queue_put(struct zcrypt_queue *);
130int zcrypt_queue_register(struct zcrypt_queue *);
131void zcrypt_queue_unregister(struct zcrypt_queue *);
132void zcrypt_queue_force_online(struct zcrypt_queue *, int);
133
134int zcrypt_rng_device_add(void);
135void zcrypt_rng_device_remove(void);
136
137void zcrypt_msgtype_register(struct zcrypt_ops *);
138void zcrypt_msgtype_unregister(struct zcrypt_ops *);
139struct zcrypt_ops *zcrypt_msgtype(unsigned char *, int);
140int zcrypt_api_init(void);
141void zcrypt_api_exit(void);
142long zcrypt_send_cprb(struct ica_xcRB *xcRB);
143long zcrypt_send_ep11_cprb(struct ep11_urb *urb);
144void zcrypt_device_status_mask_ext(struct zcrypt_device_status_ext *devstatus);
145int zcrypt_device_status_ext(int card, int queue,
146 struct zcrypt_device_status_ext *devstatus);
147
148#endif /* _ZCRYPT_API_H_ */
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 */
44struct 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
84struct zcrypt_device;
85
86struct 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
94struct 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
115struct zcrypt_device *zcrypt_device_alloc(size_t);
116void zcrypt_device_free(struct zcrypt_device *);
117void zcrypt_device_get(struct zcrypt_device *);
118int zcrypt_device_put(struct zcrypt_device *);
119int zcrypt_device_register(struct zcrypt_device *);
120void zcrypt_device_unregister(struct zcrypt_device *);
121int zcrypt_api_init(void);
122void zcrypt_api_exit(void);
123
124#endif /* _ZCRYPT_API_H_ */