1 //*****************************************************************************
2 //
3 // crc.h - Defines and Macros for CRC module.
4 //
5 // Copyright (c) 2012-2020 Texas Instruments Incorporated.  All rights reserved.
6 // Software License Agreement
7 //
8 //   Redistribution and use in source and binary forms, with or without
9 //   modification, are permitted provided that the following conditions
10 //   are met:
11 //
12 //   Redistributions of source code must retain the above copyright
13 //   notice, this list of conditions and the following disclaimer.
14 //
15 //   Redistributions in binary form must reproduce the above copyright
16 //   notice, this list of conditions and the following disclaimer in the
17 //   documentation and/or other materials provided with the
18 //   distribution.
19 //
20 //   Neither the name of Texas Instruments Incorporated nor the names of
21 //   its contributors may be used to endorse or promote products derived
22 //   from this software without specific prior written permission.
23 //
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 //
36 // This is part of revision 2.2.0.295 of the Tiva Peripheral Driver Library.
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     0x00000020  // 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 #if 0
82 extern void ECClockGatingReqest(uint32_t ui32Base, uint32_t ui32ECIP,
83                                 bool bGate);
84 #endif
85 extern void CRCConfigSet(uint32_t ui32Base, uint32_t ui32CRCConfig);
86 extern uint32_t CRCDataProcess(uint32_t ui32Base, uint32_t *pui32DataIn,
87                                uint32_t ui32DataLength, bool bPPResult);
88 extern void CRCDataWrite(uint32_t ui32Base, uint32_t ui32Data);
89 extern uint32_t CRCResultRead(uint32_t ui32Base, bool bPPResult);
90 extern void CRCSeedSet(uint32_t ui32Base, uint32_t ui32Seed);
91 
92 //*****************************************************************************
93 //
94 // Mark the end of the C bindings section for C++ compilers.
95 //
96 //*****************************************************************************
97 #ifdef __cplusplus
98 }
99 #endif
100 
101 #endif // __DRIVERLIB_CRC_H__
102