diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2017-09-08 16:35:55 -0700 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-09-26 15:01:20 -0600 |
| commit | 8a29896a6e31c7aa2ca3b50d8aefe05f280b0b7e (patch) | |
| tree | 8ef874d134297f6543ec7498739958b709aa44d4 /lib/crc8.c | |
| parent | 44e9f099367716dde33618b7d5d25c3123437ba6 (diff) | |
| download | linux-0-day-8a29896a6e31c7aa2ca3b50d8aefe05f280b0b7e.tar.gz linux-0-day-8a29896a6e31c7aa2ca3b50d8aefe05f280b0b7e.tar.xz | |
docs: clean up and add rest of CRC functions to kernel-api.rst
Add the rest of the CRC library functions to kernel-api.
- try to clarify crc32() by adding '@' to a function parameter
- reorder kernel-api CRC functions to be less random
- add more CRC functions to kernel-api
- correct the function parameter names in several places
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'lib/crc8.c')
| -rw-r--r-- | lib/crc8.c | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/lib/crc8.c b/lib/crc8.c index 87b59cafdb839..595a5a75e3cd6 100644 --- a/lib/crc8.c +++ b/lib/crc8.c @@ -20,11 +20,11 @@ #include <linux/crc8.h> #include <linux/printk.h> -/* +/** * crc8_populate_msb - fill crc table for given polynomial in reverse bit order. * - * table: table to be filled. - * polynomial: polynomial for which table is to be filled. + * @table: table to be filled. + * @polynomial: polynomial for which table is to be filled. */ void crc8_populate_msb(u8 table[CRC8_TABLE_SIZE], u8 polynomial) { @@ -42,11 +42,11 @@ void crc8_populate_msb(u8 table[CRC8_TABLE_SIZE], u8 polynomial) } EXPORT_SYMBOL(crc8_populate_msb); -/* +/** * crc8_populate_lsb - fill crc table for given polynomial in regular bit order. * - * table: table to be filled. - * polynomial: polynomial for which table is to be filled. + * @table: table to be filled. + * @polynomial: polynomial for which table is to be filled. */ void crc8_populate_lsb(u8 table[CRC8_TABLE_SIZE], u8 polynomial) { @@ -63,13 +63,13 @@ void crc8_populate_lsb(u8 table[CRC8_TABLE_SIZE], u8 polynomial) } EXPORT_SYMBOL(crc8_populate_lsb); -/* +/** * crc8 - calculate a crc8 over the given input data. * - * table: crc table used for calculation. - * pdata: pointer to data buffer. - * nbytes: number of bytes in data buffer. - * crc: previous returned crc8 value. + * @table: crc table used for calculation. + * @pdata: pointer to data buffer. + * @nbytes: number of bytes in data buffer. + * @crc: previous returned crc8 value. */ u8 crc8(const u8 table[CRC8_TABLE_SIZE], u8 *pdata, size_t nbytes, u8 crc) { |