Home
4 PIC18 Diagnostic Test APIs
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.3.4 Functions
4.3.4.2 DIAG_ClockLineFreq
For the SW_CLOCK_PERIODIC_MONITOR_02 API to The Clock Test Using Line Frequency implements the independent-time-slot-monitoring for the SW_CLOCK_PERIODIC_MONITOR_02 requirment in ISO-26262 standard. It verifies the reliability of the system clock (i.e., the system clock should neither be too fast nor too slow). This test uses the AC line frequency to verify proper CPU clock operation. The AC line frequency is measured by using a zero-cross-detection circuit that is connected to the input of the Timer1 Gate Module.

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.3.1 Structs
  - 4.3.2 Defines
  - 4.3.3 Enums
  - 4.3.4 Functions
    - 4.3.4.1 DIAG_InputPulseCapture
      The Clock Line Frequency Test implements the independent-time-slot-monitoring technique to comply with the SW_CLOCK_PERIODIC_MONITOR_02 requirement ID.
    - 4.3.4.2 DIAG_ClockLineFreq
      For the SW_CLOCK_PERIODIC_MONITOR_02 API to The Clock Test Using Line Frequency implements the independent-time-slot-monitoring for the SW_CLOCK_PERIODIC_MONITOR_02 requirment in ISO-26262 standard. It verifies the reliability of the system clock (i.e., the system clock should neither be too fast nor too slow). This test uses the AC line frequency to verify proper CPU clock operation. The AC line frequency is measured by using a zero-cross-detection circuit that is connected to the input of the Timer1 Gate Module.
    - 4.3.4.3 DIAG_Timer1GateCutomInterruptHandler
      This API is called from the Timer1 Gate ISR from where the API updates the period value of the reference line frequency signal.
  - 4.3.5 Variables
- 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.16 Class List
  Here is a list of all documented files with brief descriptions

4.3.4.2 DIAG_ClockLineFreq

For the SW_CLOCK_PERIODIC_MONITOR_02 API to The Clock Test Using Line Frequency implements the independent-time-slot-monitoring for the SW_CLOCK_PERIODIC_MONITOR_02 requirment in ISO-26262 standard. It verifies the reliability of the system clock (i.e., the system clock should neither be too fast nor too slow). This test uses the AC line frequency to verify proper CPU clock operation. The AC line frequency is measured by using a zero-cross-detection circuit that is connected to the input of the Timer1 Gate Module.

diag_clock_line_status_t DIAG_ClockLineFreq(
    uint32_t sysclock,    uint8_t linefreq,    uint8_t tolerance
)

Parameters


[in] sysclock	uint32_t - CPU system clock frequency value
[in] linefreq	uint8_t - Reference line frequency value
[in] tolerance	uint8_t - Limit for deviation frequency value

Returns


diag_clock_line_status_t	DIAG_CLOCK_TEST_PASS - Success, DIAG_CLOCK_TEST_FAIL - Failure, DIAG_CLOCK_TEST_IN_PROGRESS - In-Progress, DIAG_CLOCK_TEST_COMPLETE - Complete, DIAG_INVALID_INPUT_TOLERANCE - Invalid, DIAG_INVALID_LINE_FREQ - Invalid