Skip to content

Commit 13f1217

Browse files
author
Amanda Butler
authored
Edit MbedCRC.h
Review changes, and edit file while I'm at it.
1 parent fda4988 commit 13f1217

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

drivers/MbedCRC.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
#include "platform/SingletonPtr.h"
2424
#include "platform/PlatformMutex.h"
2525

26-
/* This is invalid warning from the compiler for below section of code
26+
/* This is an invalid warning from the compiler for the below section of code
2727
if ((width < 8) && (NULL == _crc_table)) {
2828
p_crc = (uint32_t)(p_crc << (8 - width));
2929
}
@@ -47,16 +47,16 @@ extern SingletonPtr<PlatformMutex> mbed_crc_mutex;
4747

4848
/** CRC object provides CRC generation through hardware or software
4949
*
50-
* CRC sums can be generated using three different method: hardware, software ROM tables
50+
* CRC sums can be generated using three different methods: hardware, software ROM tables
5151
* and bitwise computation. The mode used is selected automatically based on required
5252
* polynomial and hardware capabilities. Any polynomial in standard form (`x^3 + x + 1`)
5353
* can be used for computation, but custom ones can affect the performance.
5454
*
55-
* First choice is the hardware mode, the supported polynomial are hardware specific and
56-
* you will need to consult your MCU manual to discover them. Next ROM polynomial tables
57-
* are tried (you can find list of supported polynomials here ::crc_polynomial) if selected
58-
* configuration is supported it will accelerate the software computations. If ROM tables
59-
* are not available for selected polynomial then CRC is computed at runtime bit by bit
55+
* First choice is the hardware mode. The supported polynomials are hardware specific, and
56+
* you need to consult your MCU manual to discover them. Next, ROM polynomial tables
57+
* are tried (you can find list of supported polynomials here ::crc_polynomial). If the selected
58+
* configuration is supported, it will accelerate the software computations. If ROM tables
59+
* are not available for the selected polynomial, then CRC is computed at run time bit by bit
6060
* for all data input.
6161
* @note Synchronization level: Thread safe
6262
*

0 commit comments

Comments
 (0)