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