Home
3 PIC16 Diagnostic Test APIs
3.5 SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01 - CRC16
This module contains APIs to calculate, store and validate 16-bit CCITT CRC for a given EEPROM region.
3.5.2 Functions
3.5.2.1 DIAG_EEPROM_CalculateStoreCRC16
Software Requirement Reference ID : SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01. This API calculates 16-bit CRC for a given EEPROM memory region and stores the same at EEPROM address indicated by storeAddress argument.

Introduction
This document contains API documentation for the diagnostic tests included in the MPLAB® Code Configurator PIC16/18 ISO26262 Diagnostic Library.
1 Software Requirements: PIC16
2 Software Requirements: PIC18
3 PIC16 Diagnostic Test APIs
- 3.1 SW_CPU_REGISTER_RESET_STATE_CHECK_01
  This module contains functional safety diagnostics APIs for CPU Registers.
- 3.2 SW_CLOCK_PERIODIC_MONITOR_01
  Software Requirement ID: SW_CLOCK_PERIODIC_MONITOR_01 This module contains APIs to calculate and validate the frequency of the CPU clock using a reference Secondary Oscillator Crystal. It verifies the reliability of the system clock (i.e., the system clock should be neither too fast nor too slow)
- 3.3 SW_CLOCK_PERIODIC_MONITOR_02
  Software Requirement ID: SW_CLOCK_PERIODIC_MONITOR_02. This module contains APIs to calculate, store and validate the frequency of the CPU clock using a reference line frequency.
- 3.4 SW_CPU_REGISTER_TEST_01
  This module contains functional safety diagnostics APIs for CPU Registers.
- 3.5 SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01 - CRC16
  This module contains APIs to calculate, store and validate 16-bit CCITT CRC for a given EEPROM region.
  - 3.5.1 Defines
  - 3.5.2 Functions
    - 3.5.2.1 DIAG_EEPROM_CalculateStoreCRC16
      Software Requirement Reference ID : SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01. This API calculates 16-bit CRC for a given EEPROM memory region and stores the same at EEPROM address indicated by storeAddress argument.
    - 3.5.2.2 DIAG_EEPROM_ValidateCRC16
      Software Requirement Reference ID : SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01. This API validates the CRC of a given EEPROM memory region by re-calculating and comparing it with reference CRC stored by GUID-590CD1BC-7260-4C2B-8605-857B51652C15.html.
    - 3.5.2.3 DIAG_EEPROM_CalculateCRC16
      Software Requirement Reference ID : SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01. This API calculates 16-bit CRC with CCITT Direct Computation method for given EEPROM memory region. This API will be used by GUID-590CD1BC-7260-4C2B-8605-857B51652C15.html and GUID-A3A99AEA-E515-4443-AFA2-7E7B0839DF2E.html
- 3.6 SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01 - CRC32
  This module contains APIs to calculate, store and validate 32-bit CCITT CRC for a given EEPROM region.
- 3.7 SW_FLASH_MEMORY_CHECKSUM_CRC_TEST_01 - CRC16
  This module contains APIs to calculate, store and validate 16-bit CCITT CRC for a given FLASH region.
- 3.8 SW_FLASH_MEMORY_CHECKSUM_CRC_TEST_01 - CRC32
  This module contains APIs to calculate, store and validate 32-bit CCITT CRC for a given FLASH region.
- 3.9 SW_INTERRUPT_FREQUENCY_TEST_01
  This module contains functional safety diagnostics API for SW_INTERRUPT_FREQUENCY_TEST_01.
- 3.10 SW_SRAM_MARCH_TEST_01 - MarchB
  This module contains functional safety diagnostics API for SRAM March-B.
- 3.11 SW_SRAM_MARCH_TEST_01 - MarchC
  This module contains functional safety diagnostics APIs for SRAM March-C.
- 3.12 SW_SRAM_MARCH_TEST_01 - MarchC_Minus
  This module contains functional safety diagnostics APIs for SRAM March-C Minus.
- 3.13 SW_WATCHDOG_SIMPLE_TIMER_STARTUP_TEST_01
  This module contains functional safety diagnostics APIs for WatchDog Timer Test.
- 3.14 SW_WATCHDOG_WINDOWED_TIMER_STARTUP_TEST_01
  This module contains functional safety diagnostics APIs for WatchDog Timer Test.
- 3.15 File List
  Here is a list of all documented files with brief descriptions
- 3.16 Class List
  Here is a list of all documented files with brief descriptions
4 PIC18 Diagnostic Test APIs

3.5.2.1 DIAG_EEPROM_CalculateStoreCRC16

Software Requirement Reference ID : SW_EEPROM_MEMORY_CHECKSUM_CRC_TEST_01. This API calculates 16-bit CRC for a given EEPROM memory region and stores the same at EEPROM address indicated by storeAddress argument.

diag_crc_status_t DIAG_EEPROM_CalculateStoreCRC16(
    uint16_t startAddress,    uint16_t length,    uint16_t storeAddress
)

Parameters


[in] startAddress	uint16_t - starting address of EEPROM memory region to be considered for CRC
[in] length	uint16_t - number of bytes from startAddress to be considered for CRC
[in] storeAddress	uint16_t - the EEPROM address where calculated CRC will be stored

Returns


diag_crc_status_t	CRC_OK= 0, CRC_ERROR= 1, CRC_INVALID_ADDRESS= 2, CRC_INVALID_LENGTH= 3