Spdk/include/spdk/crc16.h
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

51 lines
1.0 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) Intel Corporation.
* All rights reserved.
*/
/**
* \file
* CRC-16 utility functions
*/
#ifndef SPDK_CRC16_H
#define SPDK_CRC16_H
#include "spdk/stdinc.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* T10-DIF CRC-16 polynomial
*/
#define SPDK_T10DIF_CRC16_POLYNOMIAL 0x8bb7u
/**
* Calculate T10-DIF CRC-16 checksum.
*
* \param init_crc Initial CRC-16 value.
* \param buf Data buffer to checksum.
* \param len Length of buf in bytes.
* \return CRC-16 value.
*/
uint16_t spdk_crc16_t10dif(uint16_t init_crc, const void *buf, size_t len);
/**
* Calculate T10-DIF CRC-16 checksum and copy data.
*
* \param init_crc Initial CRC-16 value.
* \param dst Destination data buffer for copy.
* \param src Source data buffer for CRC calculation and copy.
* \param len Length of buffer in bytes.
* \return CRC-16 value.
*/
uint16_t spdk_crc16_t10dif_copy(uint16_t init_crc, uint8_t *dst, uint8_t *src,
size_t len);
#ifdef __cplusplus
}
#endif
#endif /* SPDK_CRC16_H */