Skip to content

Commit eb202a2

Browse files
author
Steven Cartmell
committed
HAL CRC: Update function documentation with new config parameter
1 parent df6051d commit eb202a2

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

hal/crc_api.h

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,13 @@ extern "C" {
8181
* and final xor of 0xFFFFFFFF, and reflection of both input and output. If any
8282
* of these settings cannot be configured the polynomial is not supported.
8383
*
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.
8587
*
8688
* \return True if running if the polynomial is supported, false if not.
8789
*/
88-
bool hal_crc_is_supported(const crc_mbed_config_t* polynomial);
90+
bool hal_crc_is_supported(const crc_mbed_config_t* config);
8991

9092
/** Initialise the hardware CRC module with the given polynomial
9193
*
@@ -113,9 +115,11 @@ bool hal_crc_is_supported(const crc_mbed_config_t* polynomial);
113115
* from two different contexts may lead to configurations being overwrite and
114116
* results being lost.
115117
*
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.
117121
*/
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);
119123

120124
/** Writes data to the current CRC module.
121125
*

0 commit comments

Comments
 (0)