blob: 4483a345633cc9b69a625b25025b0f1f6b3b4fe0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*
ChibiOS - Copyright (C) 2015 Michael D. Spradling
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file crcsw.h
* @brief CRC software driver.
*
* @addtogroup CRC
* @{
*/
#include "hal.h"
#if HAL_USE_CRC || defined(__DOXYGEN__)
#if CRCSW_USE_CRC1 || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief CRC1 software driver enable switch.
* @details If set to @p TRUE the support for CRC1 is included.
* @note The default is @p FALSE
*/
#if !defined(CRCSW_USE_CRC1) || defined(__DOXYGEN__)
#define CRCSW_USE_CRC1 FALSE
#endif
/**
* @brief Enables software CRC32
*/
#if !defined(CRCSW_CRC32_TABLE) || defined(__DOXYGEN__)
#define CRCSW_CRC32_TABLE FALSE
#endif
/**
* @brief Enables software CRC16
*/
#if !defined(CRCSW_CRC16_TABLE) || defined(__DOXYGEN__)
#define CRCSW_CRC16_TABLE FALSE
#endif
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if CRCSW_USE_CRC1 && CRC_USE_DMA
#error "Software CRC does not support DMA(CRC_USE_DMA)"
#endif
#if CRCSW_CRC32_TABLE == FALSE && CRCSW_CRC16_TABLE == FALSE && \
CRCSW_PROGRAMMABLE == FALSE
#error "At least one of CRCSW_PROGRAMMABLE, CRCSW_CRC32_TABLE, or CRCSW_CRC16_TABLE must be defined"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a structure representing an CRC driver.
*/
typedef struct CRCDriver CRCDriver;
/**
* @brief Driver configuration structure.
*/
typedef struct {
/**
* @brief The size of polynomial to be used for CRC.
*/
uint32_t poly_size;
/**
* @brief The coefficients of the polynomial to be used for CRC.
*/
uint32_t poly;
/**
* @brief The inital value
*/
uint32_t initial_val;
/**
* @brief The final XOR value
*/
uint32_t final_val;
/**
* @brief Reflect bit order data going into CRC
*/
bool reflect_data;
/**
* @brief Reflect bit order of final remainder
*/
bool reflect_remainder;
/* End of the mandatory fields.*/
/**
* @brief The crc lookup table to use when calculating CRC.
*/
const uint32_t *table;
} CRCConfig;
/**
* @brief Structure representing an CRC driver.
*/
struct CRCDriver {
/**
* @brief Driver state.
*/
crcstate_t state;
/**
* @brief Current configuration data.
*/
const CRCConfig *config;
#if CRC_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
/**
* @brief Mutex protecting the peripheral.
*/
mutex_t mutex;
#endif /* CRC_USE_MUTUAL_EXCLUSION */
/* End of the mandatory fields.*/
/**
* @brief Current value of calculated CRC.
*/
uint32_t crc;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
#if CRCSW_CRC32_TABLE || defined(__DOXYGEN__)
/**
* @brief Configuration that represents CRC32
*/
#define CRCSW_CRC32_TABLE_CONFIG (&crcsw_crc32_config)
#endif
#if CRCSW_CRC16_TABLE || defined(__DOXYGEN__)
/**
* @brief Configuration that represents CRC16
*/
#define CRCSW_CRC16_TABLE_CONFIG (&crcsw_crc16_config)
#endif
/*===========================================================================*/
/* Driver local definitions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported variables. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local variables and types. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local functions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver interrupt handlers. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported functions. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
extern CRCDriver CRCD1;
#if CRCSW_CRC32_TABLE
extern const CRCConfig crcsw_crc32_config;
#endif
#if CRCSW_CRC16_TABLE
extern const CRCConfig crcsw_crc16_config;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void crc_lld_init(void);
void crc_lld_start(CRCDriver *crcp);
void crc_lld_stop(CRCDriver *crcp);
void crc_lld_reset(CRCDriver *crcp);
uint32_t crc_lld_calc(CRCDriver *crcp, size_t n, const void *buf);
#ifdef __cplusplus
}
#endif
#endif /* CRCSW_USE_CRC1 */
#endif /* HAL_USE_CRC */
/** @} */
|
