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