Home
4 PIC18 Diagnostic Test APIs
4.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 .
4.7.2 Functions
4.7.2.1 DIAG_FLASH_CalculateStoreCRC16
Software Requirement Reference ID : SW_FLASH_MEMORY_CHECKSUM_CRC_TEST_01. This API calculates 16-bit CRC for a given FLASH memory region and stores the same at FLASH 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
4 PIC18 Diagnostic Test APIs
- 4.1 SW_CPU_REGISTER_RESET_STATE_CHECK_01.
  This module contains functional safety diagnostics APIs for CPU Registers .
- 4.2 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. The Clock test implements the SW_CLOCK_PERIODIC_MONITOR_01 SW REQ. ID by using time-slot monitoring technique.. It verifies the reliability of the system. clock (i.e., the system clock should be neither too fast nor too slow)
- 4.3 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.
- 4.4 SW_CPU_REGISTER_TEST_01
  This module contains functional safety diagnostics APIs for CPU Registers .
- 4.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. .
- 4.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.
- 4.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 .
  - 4.7.1 Defines
  - 4.7.2 Functions
    - 4.7.2.1 DIAG_FLASH_CalculateStoreCRC16
      Software Requirement Reference ID : SW_FLASH_MEMORY_CHECKSUM_CRC_TEST_01. This API calculates 16-bit CRC for a given FLASH memory region and stores the same at FLASH address indicated by storeAddress argument.
    - 4.7.2.2 DIAG_FLASH_ValidateCRC16
      Software Requirement Reference ID : SW_FLASH_MEMORY_CHECKSUM_CRC_TEST_01. This API validates the CRC of a given FLASH memory region by re-calculating and comparing it with reference CRC stored by GUID-69010967-B93E-46A0-8CC6-74AE393CAAEC.html.
    - 4.7.2.3 DIAG_FLASH_CalculateCRC16
      Software Requirement Reference ID : SW_FLASH_MEMORY_CHECKSUM_CRC_TEST_01. This API calculates 16-bit CRC with Direct Computation method for given FLASH memory region. This API will be used by GUID-69010967-B93E-46A0-8CC6-74AE393CAAEC.html and GUID-FE913074-9A8F-474B-AC21-A643F84ED8F6.html.
- 4.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. .
- 4.9 SW_INTERRUPT_FREQUENCY_TEST_01
  This module contains functional safety diagnostics API for Interrupt Frequency Test.
- 4.10 SW_SRAM_MARCH_TEST_01 - MarchB
  This module contains functional safety diagnostics API for SRAM March-B. .
- 4.11 SW_SRAM_MARCH_TEST_01 - MarchC
  This module contains functional safety diagnostics APIs for SRAM March-C. .
- 4.12 SW_SRAM_MARCH_TEST_01 - MarchC_Minus
  This module contains functional safety diagnostics APIs for SRAM March-C Minus. .
- 4.13 SW_WATCHDOG_SIMPLE_TIMER_STARTUP_TEST_01
  This module contains functional safety diagnostics APIs for WatchDog Timer Test. .
- 4.14 SW_WATCHDOG_WINDOWED_TIMER_STARTUP_TEST_01
  This module contains functional safety diagnostics APIs for WatchDog Timer Test .
- 4.15 File List
  Here is a list of all documented files with brief descriptions
- 4.16 Class List
  Here is a list of all documented files with brief descriptions

4.7.2.1 DIAG_FLASH_CalculateStoreCRC16

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

diag_crc_status_t DIAG_FLASH_CalculateStoreCRC16(
    uint32_t startAddress,    uint32_t length,    uint32_t storeAddress
)

Parameters


[in] startAddress	uint32_t - starting address of FLASH memory region to be considered for CRC
[in] length	uint32_t - number of bytes from startAddress to be considered for CRC
[in] storeAddress	uint32_t - the FLASH 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