Home
4 PIC18 Diagnostic Test APIs
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.2.3 Functions
4.2.3.4 DIAG_Clock_SOSC
For the SW_CLOCK_PERIODIC_MONITOR_01 API to calculate and validate the frequency of the CPU clock using a reference Secondary Oscillator Crystal.

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.2.1 Defines
  - 4.2.2 Enums
  - 4.2.3 Functions
    - 4.2.3.1 diag_ClockTestSetup
      For the SW_CLOCK_PERIODIC_MONITOR_01 API to initialize the timer1 settings to run the test.
    - 4.2.3.2 diag_Timer1Restore
      For the SW_CLOCK_PERIODIC_MONITOR_01 API to restore the timer1 settings based on the application settings.
    - 4.2.3.3 diag_ClockTestTimer
      For the SW_CLOCK_PERIODIC_MONITOR_01 API to calculate the diag_clockCount value to be used in GUID-CA6431D6-0107-4747-8D13-AAD13ED2CE7E.html API.
    - 4.2.3.4 DIAG_Clock_SOSC
      For the SW_CLOCK_PERIODIC_MONITOR_01 API to calculate and validate the frequency of the CPU clock using a reference Secondary Oscillator Crystal.
- 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.16 Class List
  Here is a list of all documented files with brief descriptions

4.2.3.4 DIAG_Clock_SOSC

For the SW_CLOCK_PERIODIC_MONITOR_01 API to calculate and validate the frequency of the CPU clock using a reference Secondary Oscillator Crystal.

diag_clock_status_t DIAG_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