ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix doxygen for MbedCRC

pull/11023/head
Bartek Szatkowski 2019-06-17 10:21:16 +01:00 committed by Evelyne Donnaes
parent ad3b345aa4
commit d8907da90c
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
drivers/MbedCRC.h
View File

@ -43,9 +43,11 @@ namespace mbed {
/** \addtogroup drivers */ /** \addtogroup drivers */
/** @{*/ /** @{*/
extern SingletonPtr<PlatformMutex> mbed_crc_mutex;
/** CRC object provides CRC generation through hardware/software /** CRC object provides CRC generation through hardware/software
* *
* ROM polynomial tables for supported polynomials (:: crc_polynomial_t) will be used for * ROM polynomial tables for supported polynomials (::crc_polynomial) will be used for
* software CRC computation, if ROM tables are not available then CRC is computed runtime * software CRC computation, if ROM tables are not available then CRC is computed runtime
* bit by bit for all data input. * bit by bit for all data input.
* @note Synchronization level: Thread safe * @note Synchronization level: Thread safe
@ -93,9 +95,6 @@ namespace mbed {
* @endcode * @endcode
* @ingroup drivers * @ingroup drivers
*/ */
extern SingletonPtr<PlatformMutex> mbed_crc_mutex;
template <uint32_t polynomial = POLY_32BIT_ANSI, uint8_t width = 32> template <uint32_t polynomial = POLY_32BIT_ANSI, uint8_t width = 32>
class MbedCRC { class MbedCRC {

14
hal/crc_api.h
View File

@ -28,13 +28,13 @@
* Different polynomial values supported * Different polynomial values supported
*/ */
typedef enum crc_polynomial { typedef enum crc_polynomial {
POLY_OTHER = 0, POLY_OTHER = 0, ///< Custom polynomial
POLY_8BIT_CCITT = 0x07, // x8+x2+x+1 POLY_8BIT_CCITT = 0x07, ///< x8+x2+x+1
POLY_7BIT_SD = 0x9, // x7+x3+1; POLY_7BIT_SD = 0x9, ///< x7+x3+1
POLY_16BIT_CCITT = 0x1021, // x16+x12+x5+1 POLY_16BIT_CCITT = 0x1021, ///< x16+x12+x5+1
POLY_16BIT_IBM = 0x8005, // x16+x15+x2+1 POLY_16BIT_IBM = 0x8005, ///< x16+x15+x2+1
POLY_32BIT_ANSI = 0x04C11DB7, // x32+x26+x23+x22+x16+x12+x11+x10+x8+x7+x5+x4+x2+x+1 POLY_32BIT_ANSI = 0x04C11DB7, ///< x32+x26+x23+x22+x16+x12+x11+x10+x8+x7+x5+x4+x2+x+1
POLY_32BIT_REV_ANSI = 0xEDB88320 POLY_32BIT_REV_ANSI = 0xEDB88320 ///< x31+x30+x29+x27+x26+x24+x23+x21+x20+x19+x15+x9+x8+x5
} crc_polynomial_t; } crc_polynomial_t;
typedef struct crc_mbed_config { typedef struct crc_mbed_config {