ref: b37b80f57b925327aa624a2b1f79e1db06368c9a
parent: 50f8d1e755362ce3cf0593355ad8e57d6b6efed4
author: gkostka <kostka.grzegorz@gmail.com>
date: Tue Oct 21 14:12:55 EDT 2014
Add comments to crc32c module
--- a/lwext4/ext4_crc32c.c
+++ b/lwext4/ext4_crc32c.c
@@ -33,7 +33,7 @@
*/
/**
* @file ext4_crc32c.c
- * @brief Crc32c routine. tahen from FreeBSD kernel.
+ * @brief Crc32c routine. Taken from FreeBSD kernel.
*/
#include <ext4_config.h>
--- a/lwext4/ext4_crc32c.h
+++ b/lwext4/ext4_crc32c.h
@@ -33,7 +33,7 @@
*/
/**
* @file ext4_crc32c.h
- * @brief Crc32c routine. tahen from FreeBSD kernel.
+ * @brief Crc32c routine. Taken from FreeBSD kernel.
*/
#ifndef LWEXT4_EXT4_CRC32C_H_
@@ -42,6 +42,11 @@
#include <ext4_config.h>
#include <stdint.h>
+/**@brief CRC32C algorithm.
+ * @param crc input feed
+ * @param buffer input buffer
+ * @param length input buffer length (bytes)
+ * @return updated crc32c value*/
uint32_t ext4_crc32c(uint32_t crc, const void *buffer, uint32_t length);