drivers/s390/crypto/zcrypt_api.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  *  Copyright IBM Corp. 2001, 2019
   4  *  Author(s): Robert Burroughs
   5  *             Eric Rossman ([email protected])
   6  *             Cornelia Huck <[email protected]>
   7  *
   8  *  Hotplug & misc device support: Jochen Roehrig ([email protected])
   9  *  Major cleanup & driver split: Martin Schwidefsky <[email protected]>
  10  *                                Ralph Wuerthner <[email protected]>
  11  *  MSGTYPE restruct:             Holger Dengler <[email protected]>
  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  */
  44 enum 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
  56 struct zcrypt_queue;
  57
  58 struct 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
  73 struct 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
  91 struct 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 */
 107 extern atomic_t zcrypt_rescan_req;
 108
 109 extern spinlock_t zcrypt_list_lock;
 110 extern int zcrypt_device_count;
 111 extern 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
 119 struct zcrypt_card *zcrypt_card_alloc(void);
 120 void zcrypt_card_free(struct zcrypt_card *);
 121 void zcrypt_card_get(struct zcrypt_card *);
 122 int zcrypt_card_put(struct zcrypt_card *);
 123 int zcrypt_card_register(struct zcrypt_card *);
 124 void zcrypt_card_unregister(struct zcrypt_card *);
 125
 126 struct zcrypt_queue *zcrypt_queue_alloc(size_t);
 127 void zcrypt_queue_free(struct zcrypt_queue *);
 128 void zcrypt_queue_get(struct zcrypt_queue *);
 129 int zcrypt_queue_put(struct zcrypt_queue *);
 130 int zcrypt_queue_register(struct zcrypt_queue *);
 131 void zcrypt_queue_unregister(struct zcrypt_queue *);
 132 void zcrypt_queue_force_online(struct zcrypt_queue *, int);
 133
 134 int zcrypt_rng_device_add(void);
 135 void zcrypt_rng_device_remove(void);
 136
 137 void zcrypt_msgtype_register(struct zcrypt_ops *);
 138 void zcrypt_msgtype_unregister(struct zcrypt_ops *);
 139 struct zcrypt_ops *zcrypt_msgtype(unsigned char *, int);
 140 int zcrypt_api_init(void);
 141 void zcrypt_api_exit(void);
 142 long zcrypt_send_cprb(struct ica_xcRB *xcRB);
 143 void zcrypt_device_status_mask_ext(struct zcrypt_device_status_ext *devstatus);
 144 int zcrypt_device_status_ext(int card, int queue,
 145                              struct zcrypt_device_status_ext *devstatus);
 146
 147 #endif /* _ZCRYPT_API_H_ */