Home
4 PIC18 Diagnostic Test APIs
4.15 File List
Here is a list of all documented files with brief descriptions
4.15.2 diag_clock_sosc_freq.h File Reference
This file contains all the variable definitions and the prototypes for the APIs used in performing the Clock Test using a secondary oscillator crystal as reference.

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.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.15.1 diag_clock_sosc_freq.c File Reference
    This file contains the APIs to perform the Clock Test using a secondary oscillator crystal as reference.
  - 4.15.2 diag_clock_sosc_freq.h File Reference
    This file contains all the variable definitions and the prototypes for the APIs used in performing the Clock Test using a secondary oscillator crystal as reference.
  - 4.15.3 diag_clockline_freq.c File Reference
    This file contains the APIs to perform the Clock Line frequency test.
  - 4.15.4 diag_clockline_freq.h File Reference
    This file contains all the variable defintions and the prototypes for the APIs used in performing the Clock Line frequency test.
  - 4.15.5 diag_config.h File Reference
  - 4.15.6 diag_cpu_registers.c File Reference
    This file contains APIs to test CPU Registers.
  - 4.15.7 diag_cpu_registers.h File Reference
    This file contains prototypes for APIs to test CPU Registers.
  - 4.15.8 diag_cpu_registers_reset_state_check.c File Reference
    This file contains API to diagnose CPU register reset state.
  - 4.15.9 diag_cpu_registers_reset_state_check.h File Reference
    This file contains prototypes for APIs to diagnose CPU register reset state.
  - 4.15.10 diag_crc16_lookup_table.h File Reference
    This file contains Look-up table for 16-bit CCITT CRC algorithm.
  - 4.15.11 diag_crc32_lookup_table.h File Reference
    This file contains Look-up table for 32-bit CRC algorithm.
  - 4.15.12 diag_eeprom_crc16.h File Reference
    This file contains prototypes for APIs to calculate, store and validate 16-bit CCITT CRC for a given EEPROM region.
  - 4.15.13 diag_eeprom_crc16_direct.c File Reference
    This file contains APIs to test EEPROM using CRC16 CCITT Direct Computation algorithm.
  - 4.15.14 diag_eeprom_crc16_lookup.c File Reference
    This file contains APIs to test EEPROM using CRC16 CCITT Look-up Table algorithm.
  - 4.15.15 diag_eeprom_crc32.h File Reference
    This file contains prototypes for APIs to calculate, store and validate 32-bit CRC for a given EEPROM region.
  - 4.15.16 diag_eeprom_crc32_direct.c File Reference
    This file contains APIs to test EEPROM using CRC32 Direct Computation algorithm.
  - 4.15.17 diag_eeprom_crc32_lookup.c File Reference
    This file contains APIs to test EEPROM using CRC32 Look-up Table algorithm.
  - 4.15.18 diag_flash_crc16.h File Reference
    This file contains prototypes for APIs to calculate, store and validate 16-bit CCITT CRC for a given FLASH region.
  - 4.15.19 diag_flash_crc16_direct.c File Reference
    This file contains APIs to test FLASH using CRC16 CCITT Direct Computation algorithm.
  - 4.15.20 diag_flash_crc16_lookup.c File Reference
    This file contains APIs to test FLASH using CRC16 CCITT Look-up Table algorithm.
  - 4.15.21 diag_flash_crc32.h File Reference
    This file contains prototypes for APIs to calculate, store and validate 32-bit CRC for a given FLASH region.
  - 4.15.22 diag_flash_crc32_direct.c File Reference
    This file contains APIs to test FLASH using CRC32 Direct Computation algorithm.
  - 4.15.23 diag_flash_crc32_lookup.c File Reference
    This file contains APIs to test FLASH using CRC32 Look-up Table algorithm.
  - 4.15.24 diag_intr_freq.c File Reference
    This file contains the API to perform Interrupt Frequency test.
  - 4.15.25 diag_intr_freq.h File Reference
    This file contains API prototypes for Interrupt frequency test.
  - 4.15.26 diag_memory_types.h File Reference
    This file contains common type definitions for EEPROM and FLASH module.
  - 4.15.27 diag_sram_march_types.h File Reference
    This file contains common macros and return types for SRAM diagnostics module.
  - 4.15.28 diag_sram_marchb.c File Reference
    This file contains the API to test SRAM using March B algorithm.
  - 4.15.29 diag_sram_marchb.h File Reference
    This file contains API prototypes for SRAM March-B test.
  - 4.15.30 diag_sram_marchc.c File Reference
    This file contains APIs to test SRAM using March C algorithm.
  - 4.15.31 diag_sram_marchc.h File Reference
    This file contains API prototypes for SRAM March-C test.
  - 4.15.32 diag_sram_marchc_minus.c File Reference
    This file contains APIs to test SRAM using March C- algorithm.
  - 4.15.33 diag_sram_marchc_minus.h File Reference
    This file contains API prototypes for SRAM March-C Minus test.
  - 4.15.34 diag_wdt_simple_timer.c File Reference
    This file contains APIs to test WDT in Simple-Timer Mode using Indirect Time-Slot Monitoring method.
  - 4.15.35 diag_wdt_simple_timer.h File Reference
    This file contains API prototypes for Indirect Time-Slot Monitoring based WDT Test (Simple-Timer Mode)
  - 4.15.36 diag_wdt_windowed_timer.c File Reference
    This file contains APIs to test WDT in Windowed-Timer Mode using Indirect Time-Slot Monitoring method.
  - 4.15.37 diag_wdt_windowed_timer.h File Reference
    This file contains API prototypes for Indirect Time-Slot Monitoring based WDT Test (Windowed-Timer Mode)
- 4.16 Class List
  Here is a list of all documented files with brief descriptions

4.15.2 diag_clock_sosc_freq.h File Reference

This file contains all the variable definitions and the prototypes for the APIs used in performing the Clock Test using a secondary oscillator crystal as reference.

Includes

../../../diag_common/config/diag_config.h
stdint.h
stdlib.h
xc.h

Enums

This enumeration contains return codes for SW_CLOCK_PERIODIC_MONITOR_01 diagnostics tests.

diag_clock_status_t
DIAG_CLOCK_TEST_PASS: 0 - indicates that is successful 0 - indicates that is successful
DIAG_CLOCK_TEST_FAIL: 1 - indicates that is unsuccessful 1 - indicates that is unsuccessful
DIAG_INVALID_NULL_INPUT: 2 - indicates that input value is invalid
DIAG_CLOCK_TEST_TIMEOUT: 3 - indicates that has timed out

Functions

Table 4-5. voiddiag_ClockTestSetup (void)

Parameters


	void

Returns


void	None

Table 4-6. voiddiag_Timer1Restore (void)

Parameters


	void

Returns


void	None This is called after the diag_ClockTestTimer has completed

Table 4-7. voiddiag_ClockTestTimer (void)

Parameters


	void

Returns


void	None

Table 4-8. diag_clock_status_tDIAG_Clock_SOSC (uint32_t clockFrequency, uint32_t referenceFrequency, uint8_t msec, uint8_t tolerance)

Parameters


[in] clockFrequency	uint32_t - CPU system clock frequency value
[in] referenceFrequency	uint32_t - Reference secondary oscillator frequency value
[in] msec	uint8_t - Time in msec to run the test
[in] tolerance	uint8_t - Limit for deviation frequency value

Returns


diag_clock_status_t	DIAG_CLOCK_TEST_PASS - Success, DIAG_CLOCK_TEST_FAIL - Failure, DIAG_INVALID_NULL_INPUT - Invalid, DIAG_CLOCK_TEST_TIMEOUT - Timeout