]> www.infradead.org Git - users/jedix/linux-maple.git/commit
lib/crc64: rename CRC64-Rocksoft to CRC64-NVME
authorEric Biggers <ebiggers@google.com>
Thu, 30 Jan 2025 03:51:22 +0000 (19:51 -0800)
committerEric Biggers <ebiggers@google.com>
Sun, 9 Feb 2025 04:06:24 +0000 (20:06 -0800)
commitf6c3f6fb32301dfb35fed3ef8a39de3e13c67ad2
treef2a3e8d2e3f7dc1b44e898c9999612fbe6c3af8d
parent0fcec0b73adc5f86597d342062114b77bcf7ec9d
lib/crc64: rename CRC64-Rocksoft to CRC64-NVME

This CRC64 variant comes from the NVME NVM Command Set Specification
(https://nvmexpress.org/wp-content/uploads/NVM-Express-NVM-Command-Set-Specification-1.0e-2024.07.29-Ratified.pdf).

The "Rocksoft Model CRC Algorithm", published in 1993 and available at
https://www.zlib.net/crc_v3.txt, is a generalized CRC algorithm that can
calculate any variant of CRC, given a list of parameters such as
polynomial, bit order, etc.  It is not a CRC variant.

The NVME NVM Command Set Specification has a table that gives the
"Rocksoft Model Parameters" for the CRC variant it uses.  When support
for this CRC variant was added to Linux, this table seems to have been
misinterpreted as naming the CRC variant the "Rocksoft" CRC.  In fact,
the table names the CRC variant as the "NVM Express 64b CRC".

Most implementations of this CRC variant outside Linux have been calling
it CRC64-NVME.  Therefore, update Linux to match.

While at it, remove the superfluous "update" from the function name, so
crc64_rocksoft_update() is now just crc64_nvme(), matching most of the
other CRC library functions.

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-4-ebiggers@kernel.org
Signed-off-by: Eric Biggers <ebiggers@google.com>
block/t10-pi.c
include/linux/crc64.h
lib/crc64.c
lib/gen_crc64table.c