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.

Sign up for GitHub

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

Jump to bottom

Update CRC Algorithm Documentation #1094

Closed
mjmccaskey opened this issue Jan 13, 2021 · 1 comment · Fixed by #1182
Closed

Update CRC Algorithm Documentation #1094

mjmccaskey opened this issue Jan 13, 2021 · 1 comment · Fixed by #1182
Assignees
@zanzaben
Labels
docs This change only affects documentation.
Milestone
Caelum

Comments

@mjmccaskey
Copy link

Is your feature request related to a problem? Please describe.
It would be useful to update the documentation in CFE_ES_CalculateCRC function to include information on the CRC algorithms used, specifically CRC-16 as that is currently the only one implemented.

Describe the solution you'd like
Include the following information that describes the CRC16 algorithm

  • Name: CRC-16/ARC
  • Polynomial: 0x8005
  • Initialization: 0x0000
  • Reflect Input/Output: true
  • XorOut: 0x0000

Additional context
While the specific algorithm has several aliases (some listed here https://reveng.sourceforge.io/crc-catalogue/16.htm) this at least provides enough information for one to recreate the lookup table/perform their own sanity checks on the CRC calculations.

Requester Info
Mathew McCaskey
HX5 / NASA-GRC
Regenerative Fuel Cell Project
@skliper skliper mentioned this issue Jan 13, 2021
Closed
@skliper skliper added this to the 7.0.0 milestone Jan 13, 2021
@skliper skliper added the docs This change only affects documentation. label Jan 13, 2021
@skliper skliper mentioned this issue Jan 26, 2021
Merged
@skliper
Copy link
Contributor

skliper commented Feb 1, 2021

See also nasa/tblCRCTool#30

zanzaben added a commit to zanzaben/cFE that referenced this issue Feb 2, 2021
@zanzaben
Fix nasa#1094, Update CRC documentation
2f3a319
zanzaben added a commit to zanzaben/cFE that referenced this issue Feb 25, 2021
@zanzaben
Fix nasa#1094, Update CRC documentation
367c6f0
zanzaben added a commit to zanzaben/cFE that referenced this issue Feb 26, 2021
@zanzaben
Fix nasa#1094, Update CRC documentation
fed648a
zanzaben added a commit to zanzaben/cFE that referenced this issue Feb 26, 2021
@zanzaben
Fix nasa#1094, Update CRC documentation
f031492
zanzaben added a commit to zanzaben/cFE that referenced this issue Feb 26, 2021
@zanzaben
Fix nasa#1094, Update CRC documentation
49f37c1
@zanzaben zanzaben mentioned this issue Feb 26, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zanzaben zanzaben

Labels
docs This change only affects documentation.
Projects
None yet
Milestone
Caelum
Development

Successfully merging a pull request may close this issue.

Fix #1094, Update CRC documentation zanzaben/cFE
3 participants
@zanzaben @skliper @mjmccaskey