3
0
Fork 0
forked from mirrors/linux
kernel/include/linux/crc64.h
Eric Biggers 067bc8717a lib/crc64: add support for arch-optimized implementations
Add support for architecture-optimized implementations of the CRC64
library functions, following the approach taken for the CRC32 and
CRC-T10DIF library functions.

Also take the opportunity to tweak the function prototypes:
- Use 'const void *' for the lib entry points (since this is easier for
  users) but 'const u8 *' for the underlying arch and generic functions
  (since this is easier for the implementations of these functions).
- Don't bother with __pure.  It's an unusual optimization that doesn't
  help properly written code.  It's a weird quirk we can do without.

Reviewed-by: Ard Biesheuvel <ardb@kernel.org>
Reviewed-by: "Martin K. Petersen" <martin.petersen@oracle.com>
Acked-by: Keith Busch <kbusch@kernel.org>
Link: https://lore.kernel.org/r/20250130035130.180676-6-ebiggers@kernel.org
Signed-off-by: Eric Biggers <ebiggers@google.com>
2025-02-08 20:06:28 -08:00

46 lines
1.5 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/*
* See lib/crc64.c for the related specification and polynomial arithmetic.
*/
#ifndef _LINUX_CRC64_H
#define _LINUX_CRC64_H
#include <linux/types.h>
u64 crc64_be_arch(u64 crc, const u8 *p, size_t len);
u64 crc64_be_generic(u64 crc, const u8 *p, size_t len);
u64 crc64_nvme_arch(u64 crc, const u8 *p, size_t len);
u64 crc64_nvme_generic(u64 crc, const u8 *p, size_t len);
/**
* crc64_be - Calculate bitwise big-endian ECMA-182 CRC64
* @crc: seed value for computation. 0 or (u64)~0 for a new CRC calculation,
* or the previous crc64 value if computing incrementally.
* @p: pointer to buffer over which CRC64 is run
* @len: length of buffer @p
*/
static inline u64 crc64_be(u64 crc, const void *p, size_t len)
{
if (IS_ENABLED(CONFIG_CRC64_ARCH))
return crc64_be_arch(crc, p, len);
return crc64_be_generic(crc, p, len);
}
/**
* crc64_nvme - Calculate CRC64-NVME
* @crc: seed value for computation. 0 for a new CRC calculation, or the
* previous crc64 value if computing incrementally.
* @p: pointer to buffer over which CRC64 is run
* @len: length of buffer @p
*
* This computes the CRC64 defined in the NVME NVM Command Set Specification,
* *including the bitwise inversion at the beginning and end*.
*/
static inline u64 crc64_nvme(u64 crc, const void *p, size_t len)
{
if (IS_ENABLED(CONFIG_CRC64_ARCH))
return ~crc64_nvme_arch(~crc, p, len);
return ~crc64_nvme_generic(~crc, p, len);
}
#endif /* _LINUX_CRC64_H */