jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

stm32: crc: merge duplicate documentation

Browse Source 
Avoids warnings from doxygen.  Leaves it purely in the headers so it's
accessible in code completion as well.
This commit is contained in:
Karl Palsson 2020-01-28 22:41:14 +00:00
parent 6f25d51be6
commit 8c37e5cea0
2 changed files with 10 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/libopencm3/stm32/common/crc_common_all.h
View File

@ -94,16 +94,20 @@ BEGIN_DECLS
void crc_reset(void); void crc_reset(void);
/** /**
* Add a word to the CRC calculator and return the result. * Writes a data word to the register, the write operation stalling until
* @param data new word to add to the CRC calculator * the computation is complete.
* @return final CRC calculator value * @param[in] data new word to add to the CRC calculator
* @returns int32 Computed CRC result
*/ */
uint32_t crc_calculate(uint32_t data); uint32_t crc_calculate(uint32_t data);
/** /**
* Add a block of data to the CRC calculator and return the final result * Add a block of data to the CRC calculator and return the final result.
* @param datap pointer to the start of a block of 32bit data words * Writes data words consecutively to the register, the write operation
* @param size length of data, in 32bit increments * stalling until the computation of each word is complete, then
* returns the final result
* @param[in] datap pointer to an array of 32 bit data words.
* @param[in] size length of data, in 32bit increments
* @return final CRC calculator value * @return final CRC calculator value
*/ */
uint32_t crc_calculate_block(uint32_t *datap, int size); uint32_t crc_calculate_block(uint32_t *datap, int size);

28
lib/stm32/common/crc_common_all.c
View File

@ -28,28 +28,11 @@
/**@{*/ /**@{*/
/*---------------------------------------------------------------------------*/
/** @brief CRC Reset.
Reset the CRC unit and forces the data register to all 1s.
*/
void crc_reset(void) void crc_reset(void)
{ {
CRC_CR |= CRC_CR_RESET; CRC_CR |= CRC_CR_RESET;
} }
/*---------------------------------------------------------------------------*/
/** @brief CRC Calculate.
Writes a data word to the register, the write operation stalling until the
computation is complete.
@param[in] data Unsigned int32.
@returns int32 Computed CRC result
*/
uint32_t crc_calculate(uint32_t data) uint32_t crc_calculate(uint32_t data)
{ {
CRC_DR = data; CRC_DR = data;
@ -57,17 +40,6 @@ uint32_t crc_calculate(uint32_t data)
return CRC_DR; return CRC_DR;
} }
/*---------------------------------------------------------------------------*/
/** @brief CRC Calculate of a Block of Data.
Writes data words consecutively to the register, the write operation stalling
until the computation of each word is complete.
@param[in] datap Unsigned int32. pointer to an array of 32 bit data words.
@param[in] size int. Size of the array.
@returns int32 Final computed CRC result
*/
uint32_t crc_calculate_block(uint32_t *datap, int size) uint32_t crc_calculate_block(uint32_t *datap, int size)
{ {
int i; int i;