File tree Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Original file line number Diff line number Diff line change @@ -81,11 +81,13 @@ extern "C" {
81
81
* and final xor of 0xFFFFFFFF, and reflection of both input and output. If any
82
82
* of these settings cannot be configured the polynomial is not supported.
83
83
*
84
- * \param polynomial CRC Polynomial. Example polynomial: 0x1021 = x^12+x^5+1
84
+ * \param config Contains CRC configuration parameters for initialising the
85
+ * hardware CRC module. For example, polynomial and initial seed
86
+ * values.
85
87
*
86
88
* \return True if running if the polynomial is supported, false if not.
87
89
*/
88
- bool hal_crc_is_supported (const crc_mbed_config_t * polynomial );
90
+ bool hal_crc_is_supported (const crc_mbed_config_t * config );
89
91
90
92
/** Initialise the hardware CRC module with the given polynomial
91
93
*
@@ -113,9 +115,11 @@ bool hal_crc_is_supported(const crc_mbed_config_t* polynomial);
113
115
* from two different contexts may lead to configurations being overwrite and
114
116
* results being lost.
115
117
*
116
- * \param polynomial CRC Polynomial. Example polynomial: 0x1021 = x^12+x^5+1
118
+ * \param config Contains CRC configuration parameters for initialising the
119
+ * hardware CRC module. For example, polynomial and initial seed
120
+ * values.
117
121
*/
118
- void hal_crc_compute_partial_start (const crc_mbed_config_t * polynomial );
122
+ void hal_crc_compute_partial_start (const crc_mbed_config_t * config );
119
123
120
124
/** Writes data to the current CRC module.
121
125
*
You can’t perform that action at this time.
0 commit comments