xref: /openssl/crypto/s390x_arch.h (revision f928304a)
1 /*
2  * Copyright 2017-2024 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9 
10 #ifndef OSSL_CRYPTO_S390X_ARCH_H
11 # define OSSL_CRYPTO_S390X_ARCH_H
12 
13 # ifndef __ASSEMBLER__
14 
15 #include "crypto/bn.h"
16 
17 void s390x_kimd(const unsigned char *in, size_t len, unsigned int fc,
18                 void *param);
19 void s390x_klmd(const unsigned char *in, size_t inlen, unsigned char *out,
20                 size_t outlen, unsigned int fc, void *param);
21 void s390x_km(const unsigned char *in, size_t len, unsigned char *out,
22               unsigned int fc, void *param);
23 void s390x_kmac(const unsigned char *in, size_t len, unsigned int fc,
24                 void *param);
25 void s390x_kmo(const unsigned char *in, size_t len, unsigned char *out,
26                unsigned int fc, void *param);
27 void s390x_kmf(const unsigned char *in, size_t len, unsigned char *out,
28                unsigned int fc, void *param);
29 void s390x_kma(const unsigned char *aad, size_t alen, const unsigned char *in,
30                size_t len, unsigned char *out, unsigned int fc, void *param);
31 int s390x_pcc(unsigned int fc, void *param);
32 int s390x_kdsa(unsigned int fc, void *param, const unsigned char *in,
33                size_t len);
34 
35 void s390x_flip_endian32(unsigned char dst[32], const unsigned char src[32]);
36 void s390x_flip_endian64(unsigned char dst[64], const unsigned char src[64]);
37 
38 int s390x_x25519_mul(unsigned char u_dst[32],
39                      const unsigned char u_src[32],
40                      const unsigned char d_src[32]);
41 int s390x_x448_mul(unsigned char u_dst[56],
42                    const unsigned char u_src[56],
43                    const unsigned char d_src[56]);
44 int s390x_ed25519_mul(unsigned char x_dst[32],
45                       unsigned char y_dst[32],
46                       const unsigned char x_src[32],
47                       const unsigned char y_src[32],
48                       const unsigned char d_src[32]);
49 int s390x_ed448_mul(unsigned char x_dst[57],
50                     unsigned char y_dst[57],
51                     const unsigned char x_src[57],
52                     const unsigned char y_src[57],
53                     const unsigned char d_src[57]);
54 
55 /*
56  * The field elements of OPENSSL_s390xcap_P are the 64-bit words returned by
57  * the STFLE instruction followed by the 64-bit word pairs returned by
58  * instructions' QUERY functions. If STFLE returns fewer data or an instruction
59  * is not supported, the corresponding field elements are zero.
60  */
61 struct OPENSSL_s390xcap_st {
62     unsigned long long stfle[4];
63     unsigned long long kimd[2];
64     unsigned long long klmd[2];
65     unsigned long long km[2];
66     unsigned long long kmc[2];
67     unsigned long long kmac[2];
68     unsigned long long kmctr[2];
69     unsigned long long kmo[2];
70     unsigned long long kmf[2];
71     unsigned long long prno[2];
72     unsigned long long kma[2];
73     unsigned long long pcc[2];
74     unsigned long long kdsa[2];
75 };
76 
77 #  if defined(__GNUC__) && defined(__linux)
78 __attribute__((visibility("hidden")))
79 #  endif
80 extern struct OPENSSL_s390xcap_st OPENSSL_s390xcap_P;
81 
82 #  ifdef S390X_MOD_EXP
83 #   if defined(__GNUC__) && defined(__linux)
84 __attribute__((visibility("hidden")))
85 #   endif
86 extern int OPENSSL_s390xcex;
87 #   if defined(__GNUC__) && defined(__linux)
88 __attribute__((visibility("hidden")))
89 #   endif
90 extern int OPENSSL_s390xcex_nodev;
91 #  endif
92 
93 /* Max number of 64-bit words currently returned by STFLE */
94 #  define S390X_STFLE_MAX       3
95 
96 /* convert facility bit number or function code to bit mask */
97 #  define S390X_CAPBIT(i)       (1ULL << (63 - (i) % 64))
98 
99 # endif
100 
101 /* OPENSSL_s390xcap_P offsets [bytes] */
102 # define S390X_STFLE            0x00
103 # define S390X_KIMD             0x20
104 # define S390X_KLMD             0x30
105 # define S390X_KM               0x40
106 # define S390X_KMC              0x50
107 # define S390X_KMAC             0x60
108 # define S390X_KMCTR            0x70
109 # define S390X_KMO              0x80
110 # define S390X_KMF              0x90
111 # define S390X_PRNO             0xa0
112 # define S390X_KMA              0xb0
113 # define S390X_PCC              0xc0
114 # define S390X_KDSA             0xd0
115 
116 /* Facility Bit Numbers */
117 # define S390X_MSA              17      /* message-security-assist */
118 # define S390X_STCKF            25      /* store-clock-fast */
119 # define S390X_MSA5             57      /* message-security-assist-ext. 5 */
120 # define S390X_MSA3             76      /* message-security-assist-ext. 3 */
121 # define S390X_MSA4             77      /* message-security-assist-ext. 4 */
122 # define S390X_MSA12            86      /* message-security-assist-ext. 12 */
123 # define S390X_VX               129     /* vector */
124 # define S390X_VXD              134     /* vector packed decimal */
125 # define S390X_VXE              135     /* vector enhancements 1 */
126 # define S390X_MSA8             146     /* message-security-assist-ext. 8 */
127 # define S390X_MSA9             155     /* message-security-assist-ext. 9 */
128 
129 /* Function Codes */
130 
131 /* all instructions */
132 # define S390X_QUERY            0
133 
134 /* kimd/klmd */
135 # define S390X_SHA_1            1
136 # define S390X_SHA_256          2
137 # define S390X_SHA_512          3
138 # define S390X_SHA3_224         32
139 # define S390X_SHA3_256         33
140 # define S390X_SHA3_384         34
141 # define S390X_SHA3_512         35
142 # define S390X_KECCAK_224       32
143 # define S390X_KECCAK_256       33
144 # define S390X_KECCAK_384       34
145 # define S390X_KECCAK_512       35
146 # define S390X_SHAKE_128        36
147 # define S390X_SHAKE_256        37
148 # define S390X_GHASH            65
149 
150 /* km/kmc/kmac/kmctr/kmo/kmf/kma */
151 # define S390X_AES_128          18
152 # define S390X_AES_192          19
153 # define S390X_AES_256          20
154 
155 /* km */
156 # define S390X_XTS_AES_128      50
157 # define S390X_XTS_AES_256      52
158 # define S390X_XTS_AES_128_MSA10 82
159 # define S390X_XTS_AES_256_MSA10 84
160 
161 /* kmac */
162 # define S390X_HMAC_SHA_224     112
163 # define S390X_HMAC_SHA_256     113
164 # define S390X_HMAC_SHA_384     114
165 # define S390X_HMAC_SHA_512     115
166 
167 /* prno */
168 # define S390X_SHA_512_DRNG     3
169 # define S390X_TRNG             114
170 
171 /* pcc */
172 # define S390X_SCALAR_MULTIPLY_P256     64
173 # define S390X_SCALAR_MULTIPLY_P384     65
174 # define S390X_SCALAR_MULTIPLY_P521     66
175 # define S390X_SCALAR_MULTIPLY_ED25519  72
176 # define S390X_SCALAR_MULTIPLY_ED448    73
177 # define S390X_SCALAR_MULTIPLY_X25519   80
178 # define S390X_SCALAR_MULTIPLY_X448     81
179 
180 /* kdsa */
181 # define S390X_ECDSA_VERIFY_P256        1
182 # define S390X_ECDSA_VERIFY_P384        2
183 # define S390X_ECDSA_VERIFY_P521        3
184 # define S390X_ECDSA_SIGN_P256          9
185 # define S390X_ECDSA_SIGN_P384          10
186 # define S390X_ECDSA_SIGN_P521          11
187 # define S390X_EDDSA_VERIFY_ED25519     32
188 # define S390X_EDDSA_VERIFY_ED448       36
189 # define S390X_EDDSA_SIGN_ED25519       40
190 # define S390X_EDDSA_SIGN_ED448         44
191 
192 /* Register 0 Flags */
193 # define S390X_DECRYPT          0x80
194 # define S390X_KMA_LPC          0x100
195 # define S390X_KMA_LAAD         0x200
196 # define S390X_KMA_HS           0x400
197 # define S390X_KDSA_D           0x80
198 # define S390X_KIMD_NIP         0x8000
199 # define S390X_KLMD_DUFOP       0x4000
200 # define S390X_KLMD_NIP         0x8000
201 # define S390X_KLMD_PS          0x100
202 # define S390X_KMAC_IKP         0x8000
203 # define S390X_KMAC_IIMP        0x4000
204 # define S390X_KMAC_CCUP        0x2000
205 
206 #endif
207