1 /******************************************************************************
2 * Copyright (C) 2016, Huada Semiconductor Co.,Ltd All rights reserved.
3 *
4 * This software is owned and published by:
5 * Huada Semiconductor Co.,Ltd ("HDSC").
6 *
7 * BY DOWNLOADING, INSTALLING OR USING THIS SOFTWARE, YOU AGREE TO BE BOUND
8 * BY ALL THE TERMS AND CONDITIONS OF THIS AGREEMENT.
9 *
10 * This software contains source code for use with HDSC
11 * components. This software is licensed by HDSC to be adapted only
12 * for use in systems utilizing HDSC components. HDSC shall not be
13 * responsible for misuse or illegal use of this software for devices not
14 * supported herein. HDSC is providing this software "AS IS" and will
15 * not be responsible for issues arising from incorrect user implementation
16 * of the software.
17 *
18 * Disclaimer:
19 * HDSC MAKES NO WARRANTY, EXPRESS OR IMPLIED, ARISING BY LAW OR OTHERWISE,
20 * REGARDING THE SOFTWARE (INCLUDING ANY ACOOMPANYING WRITTEN MATERIALS),
21 * ITS PERFORMANCE OR SUITABILITY FOR YOUR INTENDED USE, INCLUDING,
22 * WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, THE IMPLIED
23 * WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE, AND THE IMPLIED
24 * WARRANTY OF NONINFRINGEMENT.
25 * HDSC SHALL HAVE NO LIABILITY (WHETHER IN CONTRACT, WARRANTY, TORT,
26 * NEGLIGENCE OR OTHERWISE) FOR ANY DAMAGES WHATSOEVER (INCLUDING, WITHOUT
27 * LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION,
28 * LOSS OF BUSINESS INFORMATION, OR OTHER PECUNIARY LOSS) ARISING FROM USE OR
29 * INABILITY TO USE THE SOFTWARE, INCLUDING, WITHOUT LIMITATION, ANY DIRECT,
30 * INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES OR LOSS OF DATA,
31 * SAVINGS OR PROFITS,
32 * EVEN IF Disclaimer HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
33 * YOU ASSUME ALL RESPONSIBILITIES FOR SELECTION OF THE SOFTWARE TO ACHIEVE YOUR
34 * INTENDED RESULTS, AND FOR THE INSTALLATION OF, USE OF, AND RESULTS OBTAINED
35 * FROM, THE SOFTWARE.
36 *
37 * This software may be replicated in part or whole for the licensed use,
38 * with the restriction that this Disclaimer and Copyright notice must be
39 * included with each copy of this software, whether used in part or whole,
40 * at all times.
41 */
42 /******************************************************************************/
43 /** \file crc.h
44  **
45  ** CRC 数据结构及API声明.
46  **
47  **   - 2016-05-04  LuX V1.0.
48  **
49  ******************************************************************************/
50 
51 #ifndef __CRC_H__
52 #define __CRC_H__
53 
54 /******************************************************************************
55  * Include files
56  ******************************************************************************/
57 #include "sysctrl.h"
58 
59 /* C binding of definitions if building with C++ compiler */
60 #ifdef __cplusplus
61 extern "C"
62 {
63 #endif
64 
65 /**
66  ******************************************************************************
67  ** \defgroup CrcGroup Cyclic Redundancy Check (CRC)
68   **
69  ******************************************************************************/
70 //@{
71 
72 /******************************************************************************
73  * Global type definitions
74  ******************************************************************************/
75 
76 
77 /******************************************************************************
78  * Global definitions
79  ******************************************************************************/
80 
81 /******************************************************************************
82  * Local type definitions ('typedef')
83  ******************************************************************************/
84 
85 /******************************************************************************
86  * Global variable definitions ('extern')
87  ******************************************************************************/
88 
89 /******************************************************************************
90  * Global function prototypes (definition in C source)
91  ******************************************************************************/
92 //CRC16 编码值获取
93 uint16_t CRC16_Get8(uint8_t* pu8Data, uint32_t u32Len);
94 uint16_t CRC16_Get16(uint16_t* pu16Data, uint32_t u32Len);
95 uint16_t CRC16_Get32(uint32_t* pu32Data, uint32_t u32Len);
96 //CRC16 校验
97 en_result_t CRC16_Check8(uint8_t* pu8Data, uint32_t u32Len, uint16_t u16CRC);
98 en_result_t CRC16_Check16(uint16_t* pu16Data, uint32_t u32Len, uint16_t u16CRC);
99 en_result_t CRC16_Check32(uint32_t* pu32Data, uint32_t u32Len, uint16_t u16CRC);
100 
101 
102 //CRC32 编码值获取
103 uint32_t CRC32_Get8(uint8_t* pu8Data, uint32_t u32Len);
104 uint32_t CRC32_Get16(uint16_t* pu16Data, uint32_t u32Len);
105 uint32_t CRC32_Get32(uint32_t* pu32Data, uint32_t u32Len);
106 //CRC32 校验
107 en_result_t CRC32_Check8(uint8_t* pu8Data, uint32_t u32Len, uint32_t u32CRC);
108 en_result_t CRC32_Check16(uint16_t* pu16Data, uint32_t u32Len, uint32_t u32CRC);
109 en_result_t CRC32_Check32(uint32_t* pu32Data, uint32_t u32Len, uint32_t u32CRC);
110 //@} // CRC Group
111 
112 #ifdef __cplusplus
113 }
114 #endif
115 
116 #endif /* __CRC_H__ */
117 /******************************************************************************
118  * EOF (not truncated)
119  ******************************************************************************/
120 
121