lib/librte_net/rte_net_crc.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Intel Corporation.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_NET_CRC_H_
  35 #define _RTE_NET_CRC_H_
  36
  37 #include <stdint.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /** CRC polynomials */
  44 #define CRC32_ETH_POLYNOMIAL 0x04c11db7UL
  45 #define CRC16_CCITT_POLYNOMIAL 0x1021U
  46
  47 #define CRC_LUT_SIZE 256
  48
  49 /** CRC types */
  50 enum rte_net_crc_type {
  51         RTE_NET_CRC16_CCITT = 0,
  52         RTE_NET_CRC32_ETH,
  53         RTE_NET_CRC_REQS
  54 };
  55
  56 /** CRC compute algorithm */
  57 enum rte_net_crc_alg {
  58         RTE_NET_CRC_SCALAR = 0,
  59         RTE_NET_CRC_SSE42,
  60         RTE_NET_CRC_NEON,
  61 };
  62
  63 /**
  64  * This API set the CRC computation algorithm (i.e. scalar version,
  65  * x86 64-bit sse4.2 intrinsic version, etc.) and internal data
  66  * structure.
  67  *
  68  * @param alg
  69  *   This parameter is used to select the CRC implementation version.
  70  *   - RTE_NET_CRC_SCALAR
  71  *   - RTE_NET_CRC_SSE42 (Use 64-bit SSE4.2 intrinsic)
  72  *   - RTE_NET_CRC_NEON (Use ARM Neon intrinsic)
  73  */
  74 void
  75 rte_net_crc_set_alg(enum rte_net_crc_alg alg);
  76
  77 /**
  78  * CRC compute API
  79  *
  80  * @param data
  81  *   Pointer to the packet data for CRC computation
  82  * @param data_len
  83  *   Data length for CRC computation
  84  * @param type
  85  *   CRC type (enum rte_net_crc_type)
  86  *
  87  * @return
  88  *   CRC value
  89  */
  90 uint32_t
  91 rte_net_crc_calc(const void *data,
  92         uint32_t data_len,
  93         enum rte_net_crc_type type);
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99
 100 #endif /* _RTE_NET_CRC_H_ */