| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
crc_8xx.h
Go to the documentation of this file.
1 /*
2 * @brief LPC8xx Cyclic Redundancy Check (CRC) Engine driver
3 *
4 * @note
5 * Copyright(C) NXP Semiconductors, 2012
6 * All rights reserved.
7 *
8 * @par
9 * Software that is described herein is for illustrative purposes only
10 * which provides customers with programming information regarding the
11 * LPC products. This software is supplied "AS IS" without any warranties of
12 * any kind, and NXP Semiconductors and its licenser disclaim any and
13 * all warranties, express or implied, including all implied warranties of
14 * merchantability, fitness for a particular purpose and non-infringement of
15 * intellectual property rights. NXP Semiconductors assumes no responsibility
16 * or liability for the use of the software, conveys no license or rights under any
17 * patent, copyright, mask work right, or any other intellectual property rights in
18 * or to any products. NXP Semiconductors reserves the right to make changes
19 * in the software without notification. NXP Semiconductors also makes no
20 * representation or warranty that such application will be suitable for the
21 * specified use without further testing or modification.
22 *
23 * @par
24 * Permission to use, copy, modify, and distribute this software and its
25 * documentation is hereby granted, under NXP Semiconductors' and its
26 * licensor's relevant copyrights in the software, without fee, provided that it
27 * is used in conjunction with NXP Semiconductors microcontrollers. This
28 * copyright, permission, and disclaimer notice must appear in all copies of
29 * this code.
30 */
31
32 #ifndef __CRC_8XX_H_
33 #define __CRC_8XX_H_
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
48 typedef IP_CRC_001_POLY_T CRC_POLY_T;
49
54 STATIC INLINE void Chip_CRC_Init(void)
55 {
56 /* turn on the clock to the CRC engine */
57 Chip_Clock_EnablePeriphClock(SYSCTL_CLOCK_CRC);
58 IP_CRC_Init(LPC_CRC);
59 }
60
65 STATIC INLINE void Chip_CRC_Deinit(void)
66 {
67 /* turn off the clock to the CRC engine */
68 IP_CRC_DeInit(LPC_CRC);
69 Chip_Clock_DisablePeriphClock(SYSCTL_CLOCK_CRC);
70 }
71
80 STATIC INLINE void Chip_CRC_SetPoly(CRC_POLY_T poly, uint32_t flags)
81 {
82 IP_CRC_SetPoly(LPC_CRC, poly, flags);
83 }
84
90 STATIC INLINE void Chip_CRC_UseDefaultConfig(CRC_POLY_T poly)
91 {
92 IP_CRC_UseDefaultConfig(LPC_CRC, poly);
93 }
94
100 STATIC INLINE void Chip_CRC_SetMode(uint32_t mode)
101 {
102 IP_CRC_SetMode(LPC_CRC, mode);
103 }
104
109 STATIC INLINE uint32_t Chip_CRC_GetMode(void)
110 {
111 return IP_CRC_GetMode(LPC_CRC);
112 }
113
119 STATIC INLINE void Chip_CRC_SetSeed(uint32_t seed)
120 {
121 IP_CRC_SetSeed(LPC_CRC, seed);
122 }
123
128 STATIC INLINE uint32_t Chip_CRC_GetSeed(void)
129 {
130 return IP_CRC_GetSeed(LPC_CRC);
131 }
132
138 STATIC INLINE void Chip_CRC_Write8(uint8_t data)
139 {
140 IP_CRC_Write8(LPC_CRC, data);
141 }
142
148 STATIC INLINE void Chip_CRC_Write16(uint16_t data)
149 {
150 IP_CRC_Write16(LPC_CRC, data);
151 }
152
158 STATIC INLINE void Chip_CRC_Write32(uint32_t data)
159 {
160 IP_CRC_Write32(LPC_CRC, data);
161 }
162
167 STATIC INLINE uint32_t Chip_CRC_Sum(void)
168 {
169 return IP_CRC_ReadSum(LPC_CRC);
170 }
171
178 uint32_t Chip_CRC_CRC8(const uint8_t *data, uint32_t bytes);
179
186 uint32_t Chip_CRC_CRC16(const uint16_t *data, uint32_t hwords);
187
194 uint32_t Chip_CRC_CRC32(const uint32_t *data, uint32_t words);
195
200 #ifdef __cplusplus
201 }
202 #endif
203
204 #endif /* __CRC_8XX_H_ */