Skip to content

Commit 50639d6

Browse files
Mel WCruz Monrreal II
authored andcommitted
Adding periods
1 parent 1d41b0e commit 50639d6

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

drivers/MbedCRC.h

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ class MbedCRC {
176176
*
177177
* CRC data if not available fully, CRC can be computed in parts with available data.
178178
*
179-
* In case of hardware, intermediate values and states are saved by hardware and mutex
179+
* In case of hardware, intermediate values and states are saved by hardware. Mutex
180180
* locking is used to serialize access to hardware CRC.
181181
*
182182
* In case of software CRC, previous CRC output should be passed as argument to the
@@ -218,7 +218,7 @@ class MbedCRC {
218218
return status;
219219
}
220220

221-
/** Compute partial start, indicate start of partial computation
221+
/** Compute partial start, indicate start of partial computation.
222222
*
223223
* This API should be called before performing any partial computation
224224
* with compute_partial API.
@@ -285,7 +285,7 @@ class MbedCRC {
285285
return 0;
286286
}
287287

288-
/** Get the current CRC polynomial
288+
/** Get the current CRC polynomial.
289289
*
290290
* @return Polynomial value
291291
*/
@@ -311,7 +311,7 @@ class MbedCRC {
311311
uint32_t *_crc_table;
312312
CrcMode _mode;
313313

314-
/** Acquire exclusive access to CRC hardware/software
314+
/** Acquire exclusive access to CRC hardware/software.
315315
*/
316316
void lock()
317317
{
@@ -322,7 +322,7 @@ class MbedCRC {
322322
#endif
323323
}
324324

325-
/** Release exclusive access to CRC hardware/software
325+
/** Release exclusive access to CRC hardware/software.
326326
*/
327327
virtual void unlock()
328328
{
@@ -333,7 +333,7 @@ class MbedCRC {
333333
#endif
334334
}
335335

336-
/** Get the current CRC data size
336+
/** Get the current CRC data size.
337337
*
338338
* @return CRC data size in bytes
339339
*/
@@ -342,7 +342,7 @@ class MbedCRC {
342342
return (width <= 8 ? 1 : (width <= 16 ? 2 : 4));
343343
}
344344

345-
/** Get the top bit of current CRC
345+
/** Get the top bit of current CRC.
346346
*
347347
* @return Top bit is set high for respective data width of current CRC
348348
* Top bit for CRC width less then 8 bits will be set as 8th bit.
@@ -352,7 +352,7 @@ class MbedCRC {
352352
return (width < 8 ? (1u << 7) : (uint32_t)(1ul << (width - 1)));
353353
}
354354

355-
/** Get the CRC data mask
355+
/** Get the CRC data mask.
356356
*
357357
* @return CRC data mask is generated based on current CRC width
358358
*/
@@ -361,7 +361,7 @@ class MbedCRC {
361361
return (width < 8 ? ((1u << 8) - 1) : (uint32_t)((uint64_t)(1ull << width) - 1));
362362
}
363363

364-
/** Final value of CRC is reflected
364+
/** Final value of CRC is reflected.
365365
*
366366
* @param data final crc value, which should be reflected
367367
* @return Reflected CRC value
@@ -384,7 +384,7 @@ class MbedCRC {
384384
}
385385
}
386386

387-
/** Data bytes are reflected
387+
/** Data bytes are reflected.
388388
*
389389
* @param data value to be reflected
390390
* @return Reflected data value
@@ -406,7 +406,7 @@ class MbedCRC {
406406
}
407407
}
408408

409-
/** Bitwise CRC computation
409+
/** Bitwise CRC computation.
410410
*
411411
* @param buffer data buffer
412412
* @param size size of the data
@@ -450,7 +450,7 @@ class MbedCRC {
450450
return 0;
451451
}
452452

453-
/** CRC computation using ROM tables
453+
/** CRC computation using ROM tables.
454454
*
455455
* @param buffer data buffer
456456
* @param size size of the data
@@ -496,7 +496,7 @@ class MbedCRC {
496496
return 0;
497497
}
498498

499-
/** Constructor init called from all specialized cases of constructor
499+
/** Constructor init called from all specialized cases of constructor.
500500
* Note: All construtor common code should be in this function.
501501
*/
502502
void mbed_crc_ctor(void)

0 commit comments

Comments
 (0)