Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CFE ES CRC does not document polynomial #266

Closed
skliper opened this issue Sep 30, 2019 · 2 comments
Closed

CFE ES CRC does not document polynomial #266

skliper opened this issue Sep 30, 2019 · 2 comments
Labels
docs This change only affects documentation. duplicate enhancement

Comments

@skliper
Copy link
Contributor

skliper commented Sep 30, 2019

4/16/18: Mark Pallone (GSFC PACE/OCI)reported
The generator polynomial used in a CRC implementation is fundamental information. The CFE_ES_CalculateCRC function does not state what generator polynomial it's using:

/*****************************************************************************/
/**
** \brief Calculate a CRC on a block of memory
**
** \par Description
** This routine calculates a cyclic redundancy check (CRC) on a block of memory. The CRC algorithm
** used is determined by the last parameter.
**
** \par Assumptions, External Events, and Notes:
** None
**
** \param[in] DataPtr Pointer to the base of the memory block.
**
** \param[in] DataLength The number of bytes in the memory block.
**
** \param[in] InputCRC A starting value for use in the CRC calculation. This parameter
** allows the user to calculate the CRC of non-contiguous blocks as
** a single value. Nominally, the user should set this value to zero.
**
** \param[in] TypeCRC One of the following CRC algorithm selections:
** \arg \c CFE_MISSION_ES_CRC_8 - (Not currently implemented)
** \arg \c CFE_MISSION_ES_CRC_16 - a CRC-16 algorithm
** \arg \c CFE_MISSION_ES_CRC_32 - (not currently implemented)
**
** \return The result of the CRC calculation on the specified memory block, or error code \ref CFEReturnCodes
**
******************************************************************************/

Dave McComas Addition: This is a subset of a larger documentation issue. The cFE should have a flight-ground ICD

EDIT - updated link

@skliper skliper self-assigned this Sep 30, 2019
@skliper
Copy link
Contributor Author

skliper commented Sep 30, 2019

Imported from trac issue 235. Created by dcmccom3 on 2018-04-19T08:47:25, last modified: 2019-03-01T15:27:58

@skliper skliper removed their assignment Sep 30, 2019
@skliper skliper added the docs This change only affects documentation. label May 12, 2020
@skliper skliper changed the title : CFE ES CRC does not document polynomial CFE ES CRC does not document polynomial Jan 6, 2021
@skliper
Copy link
Contributor Author

skliper commented Jan 13, 2021

Duplicate of #1094, although it actually documents what the algorithm is so closing this issue.

@skliper skliper closed this as completed Jan 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation. duplicate enhancement
Projects
None yet
Development

No branches or pull requests

1 participant