Home
3 PIC16 Diagnostic Test APIs
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.2.3 Functions
3.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
- 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.2.1 Defines
  - 3.2.2 Enums
  - 3.2.3 Functions
    - 3.2.3.1 diag_ClockTestSetup
      For the SW_CLOCK_PERIODIC_MONITOR_01 API to initialize the timer1 settings to run the test.
    - 3.2.3.2 diag_Timer1Restore
      For the SW_CLOCK_PERIODIC_MONITOR_01 API to restore the timer1 settings based on the application settings This is called after the GUID-3178CF62-3AD3-4168-A783-0F84682ADFB6.html has completed.
    - 3.2.3.3 diag_ClockTestTimer
      For the SW_CLOCK_PERIODIC_MONITOR_01 API to calculate the diag_clockCount value to be used in GUID-34E1D838-B2F9-4544-9329-9A327F9C8054.html API.
    - 3.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.
- 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.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.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