2 * Accelerated CRC32(C) using ARM CRC, NEON and Crypto Extensions instructions
4 * Copyright (C) 2016 Linaro Ltd <ard.biesheuvel@linaro.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
11 #include <linux/cpufeature.h>
12 #include <linux/crc32.h>
13 #include <linux/init.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/string.h>
18 #include <crypto/internal/hash.h>
20 #include <asm/hwcap.h>
23 #include <asm/unaligned.h>
25 #define PMULL_MIN_LEN 64L /* minimum size of buffer
26 * for crc32_pmull_le_16 */
27 #define SCALE_F 16L /* size of NEON register */
29 asmlinkage u32
crc32_pmull_le(const u8 buf
[], u32 len
, u32 init_crc
);
30 asmlinkage u32
crc32_armv8_le(u32 init_crc
, const u8 buf
[], u32 len
);
32 asmlinkage u32
crc32c_pmull_le(const u8 buf
[], u32 len
, u32 init_crc
);
33 asmlinkage u32
crc32c_armv8_le(u32 init_crc
, const u8 buf
[], u32 len
);
35 static u32 (*fallback_crc32
)(u32 init_crc
, const u8 buf
[], u32 len
);
36 static u32 (*fallback_crc32c
)(u32 init_crc
, const u8 buf
[], u32 len
);
38 static int crc32_cra_init(struct crypto_tfm
*tfm
)
40 u32
*key
= crypto_tfm_ctx(tfm
);
46 static int crc32c_cra_init(struct crypto_tfm
*tfm
)
48 u32
*key
= crypto_tfm_ctx(tfm
);
54 static int crc32_setkey(struct crypto_shash
*hash
, const u8
*key
,
57 u32
*mctx
= crypto_shash_ctx(hash
);
59 if (keylen
!= sizeof(u32
)) {
60 crypto_shash_set_flags(hash
, CRYPTO_TFM_RES_BAD_KEY_LEN
);
63 *mctx
= le32_to_cpup((__le32
*)key
);
67 static int crc32_init(struct shash_desc
*desc
)
69 u32
*mctx
= crypto_shash_ctx(desc
->tfm
);
70 u32
*crc
= shash_desc_ctx(desc
);
76 static int crc32_update(struct shash_desc
*desc
, const u8
*data
,
79 u32
*crc
= shash_desc_ctx(desc
);
81 *crc
= crc32_armv8_le(*crc
, data
, length
);
85 static int crc32c_update(struct shash_desc
*desc
, const u8
*data
,
88 u32
*crc
= shash_desc_ctx(desc
);
90 *crc
= crc32c_armv8_le(*crc
, data
, length
);
94 static int crc32_final(struct shash_desc
*desc
, u8
*out
)
96 u32
*crc
= shash_desc_ctx(desc
);
98 put_unaligned_le32(*crc
, out
);
102 static int crc32c_final(struct shash_desc
*desc
, u8
*out
)
104 u32
*crc
= shash_desc_ctx(desc
);
106 put_unaligned_le32(~*crc
, out
);
110 static int crc32_pmull_update(struct shash_desc
*desc
, const u8
*data
,
113 u32
*crc
= shash_desc_ctx(desc
);
116 if (may_use_simd()) {
117 if ((u32
)data
% SCALE_F
) {
118 l
= min_t(u32
, length
, SCALE_F
- ((u32
)data
% SCALE_F
));
120 *crc
= fallback_crc32(*crc
, data
, l
);
126 if (length
>= PMULL_MIN_LEN
) {
127 l
= round_down(length
, SCALE_F
);
130 *crc
= crc32_pmull_le(data
, l
, *crc
);
139 *crc
= fallback_crc32(*crc
, data
, length
);
144 static int crc32c_pmull_update(struct shash_desc
*desc
, const u8
*data
,
147 u32
*crc
= shash_desc_ctx(desc
);
150 if (may_use_simd()) {
151 if ((u32
)data
% SCALE_F
) {
152 l
= min_t(u32
, length
, SCALE_F
- ((u32
)data
% SCALE_F
));
154 *crc
= fallback_crc32c(*crc
, data
, l
);
160 if (length
>= PMULL_MIN_LEN
) {
161 l
= round_down(length
, SCALE_F
);
164 *crc
= crc32c_pmull_le(data
, l
, *crc
);
173 *crc
= fallback_crc32c(*crc
, data
, length
);
178 static struct shash_alg crc32_pmull_algs
[] = { {
179 .setkey
= crc32_setkey
,
181 .update
= crc32_update
,
182 .final
= crc32_final
,
183 .descsize
= sizeof(u32
),
184 .digestsize
= sizeof(u32
),
186 .base
.cra_ctxsize
= sizeof(u32
),
187 .base
.cra_init
= crc32_cra_init
,
188 .base
.cra_name
= "crc32",
189 .base
.cra_driver_name
= "crc32-arm-ce",
190 .base
.cra_priority
= 200,
191 .base
.cra_flags
= CRYPTO_ALG_OPTIONAL_KEY
,
192 .base
.cra_blocksize
= 1,
193 .base
.cra_module
= THIS_MODULE
,
195 .setkey
= crc32_setkey
,
197 .update
= crc32c_update
,
198 .final
= crc32c_final
,
199 .descsize
= sizeof(u32
),
200 .digestsize
= sizeof(u32
),
202 .base
.cra_ctxsize
= sizeof(u32
),
203 .base
.cra_init
= crc32c_cra_init
,
204 .base
.cra_name
= "crc32c",
205 .base
.cra_driver_name
= "crc32c-arm-ce",
206 .base
.cra_priority
= 200,
207 .base
.cra_flags
= CRYPTO_ALG_OPTIONAL_KEY
,
208 .base
.cra_blocksize
= 1,
209 .base
.cra_module
= THIS_MODULE
,
212 static int __init
crc32_pmull_mod_init(void)
214 if (elf_hwcap2
& HWCAP2_PMULL
) {
215 crc32_pmull_algs
[0].update
= crc32_pmull_update
;
216 crc32_pmull_algs
[1].update
= crc32c_pmull_update
;
218 if (elf_hwcap2
& HWCAP2_CRC32
) {
219 fallback_crc32
= crc32_armv8_le
;
220 fallback_crc32c
= crc32c_armv8_le
;
222 fallback_crc32
= crc32_le
;
223 fallback_crc32c
= __crc32c_le
;
225 } else if (!(elf_hwcap2
& HWCAP2_CRC32
)) {
229 return crypto_register_shashes(crc32_pmull_algs
,
230 ARRAY_SIZE(crc32_pmull_algs
));
233 static void __exit
crc32_pmull_mod_exit(void)
235 crypto_unregister_shashes(crc32_pmull_algs
,
236 ARRAY_SIZE(crc32_pmull_algs
));
239 static const struct cpu_feature crc32_cpu_feature
[] = {
240 { cpu_feature(CRC32
) }, { cpu_feature(PMULL
) }, { }
242 MODULE_DEVICE_TABLE(cpu
, crc32_cpu_feature
);
244 module_init(crc32_pmull_mod_init
);
245 module_exit(crc32_pmull_mod_exit
);
247 MODULE_AUTHOR("Ard Biesheuvel <ard.biesheuvel@linaro.org>");
248 MODULE_LICENSE("GPL v2");
249 MODULE_ALIAS_CRYPTO("crc32");
250 MODULE_ALIAS_CRYPTO("crc32c");