CC3200 Peripheral Driver Library User's Guide  1.2.0
crc.h
1 //*****************************************************************************
2 //
3 // crc.h
4 //
5 // Defines and Macros for CRC module.
6 //
7 // Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com/
8 //
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions
12 // are met:
13 //
14 // Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the
20 // distribution.
21 //
22 // Neither the name of Texas Instruments Incorporated nor the names of
23 // its contributors may be used to endorse or promote products derived
24 // from this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 //*****************************************************************************
39 
40 #ifndef __DRIVERLIB_CRC_H__
41 #define __DRIVERLIB_CRC_H__
42 
43 //*****************************************************************************
44 //
45 // If building with a C++ compiler, make all of the definitions in this header
46 // have a C binding.
47 //
48 //*****************************************************************************
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
54 //*****************************************************************************
55 //
56 // The following defines are used in the ui32Config argument of the
57 // ECConfig function.
58 //
59 //*****************************************************************************
60 #define CRC_CFG_INIT_SEED 0x00000000 // Initialize with seed
61 #define CRC_CFG_INIT_0 0x00004000 // Initialize to all '0s'
62 #define CRC_CFG_INIT_1 0x00006000 // Initialize to all '1s'
63 #define CRC_CFG_SIZE_8BIT 0x00001000 // Input Data Size
64 #define CRC_CFG_SIZE_32BIT 0x00000000 // Input Data Size
65 #define CRC_CFG_RESINV 0x00000200 // Result Inverse Enable
66 #define CRC_CFG_OBR 0x00000100 // Output Reverse Enable
67 #define CRC_CFG_IBR 0x00000080 // Bit reverse enable
68 #define CRC_CFG_ENDIAN_SBHW 0x00000000 // Swap byte in half-word
69 #define CRC_CFG_ENDIAN_SHW 0x00000010 // Swap half-word
70 #define CRC_CFG_TYPE_P8005 0x00000000 // Polynomial 0x8005
71 #define CRC_CFG_TYPE_P1021 0x00000001 // Polynomial 0x1021
72 #define CRC_CFG_TYPE_P4C11DB7 0x00000002 // Polynomial 0x4C11DB7
73 #define CRC_CFG_TYPE_P1EDC6F41 0x00000003 // Polynomial 0x1EDC6F41
74 #define CRC_CFG_TYPE_TCPCHKSUM 0x00000008 // TCP checksum
75 
76 //*****************************************************************************
77 //
78 // Function prototypes.
79 //
80 //*****************************************************************************
81 extern void CRCConfigSet(uint32_t ui32Base, uint32_t ui32CRCConfig);
82 extern uint32_t CRCDataProcess(uint32_t ui32Base, void *puiDataIn,
83  uint32_t ui32DataLength, uint32_t ui32Config);
84 extern void CRCDataWrite(uint32_t ui32Base, uint32_t ui32Data);
85 extern uint32_t CRCResultRead(uint32_t ui32Base);
86 extern void CRCSeedSet(uint32_t ui32Base, uint32_t ui32Seed);
87 
88 
89 //*****************************************************************************
90 //
91 // Mark the end of the C bindings section for C++ compilers.
92 //
93 //*****************************************************************************
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif // __DRIVERLIB_CRC_H__
uint32_t CRCResultRead(uint32_t ui32Base)
Definition: crc.c:203
uint32_t CRCDataProcess(uint32_t ui32Base, void *puiDataIn, uint32_t ui32DataLength, uint32_t ui32Config)
Definition: crc.c:244
void CRCDataWrite(uint32_t ui32Base, uint32_t ui32Data)
Definition: crc.c:175
void CRCSeedSet(uint32_t ui32Base, uint32_t ui32Seed)
Definition: crc.c:142
void CRCConfigSet(uint32_t ui32Base, uint32_t ui32CRCConfig)
Definition: crc.c:97