MCC AVR ISO26262 Diagnostic Library v2.0.0 API Documentation

Introduction

This document contains API documentation for the diagnostic tests included in the MPLAB® Code Configurator AVR® ISO26262 Diagnostic Library.

1 Software Requirements

1.1 CPU Self Test

1.2 Clock Frequency Test

1.3 CPU Registers

1.4 EEPROM CRC

1.5 FLASH CRC

1.6 Interrupt Frequency

1.7 SRAM - March C-Minus Algorithm

1.8 Simple Watchdog Timer

1.9 Windowed Watchdog Timer

2 SW_CPU_SELF_TEST_LIB_01

This file contains prototypes and datatypes for CPU self tests.

3 SW_CPU_SELF_TEST_LIB_01 - Subset-1

This file contains prototypes and datatypes for CPU self test subset-1.

3.1 Defines

3.2 Functions

4 SW_CPU_SELF_TEST_LIB_01 - subset-2

This file contains prototypes and datatypes for CPU self test subset-2.

4.1 Defines

4.2 Functions

5 SW_CPU_SELF_TEST_LIB_01 - subset-3

This file contains prototypes and datatypes for CPU self test subset-3.

5.1 Defines

5.2 Functions

6 SW_CLOCK_PERIODIC_MONITOR_01

This module contains functional safety diagnostics APIs for Clock Frequency test.

6.1 Defines

6.2 Functions

7 SW_CPU_REGISTER_TEST_01

This module contains functional safety diagnostics APIs for CPU Registers.

7.1 Defines

7.2 Enums

7.3 Functions

8 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.

8.1 Defines

8.2 Functions

9 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.

9.1 Defines

9.2 Functions

10 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.

10.1 Defines

10.2 Functions

11 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.

11.1 Defines

11.2 Functions

12 SW_INTERRUPT_FREQUENCY_TEST_01

This module contains functional safety diagnostics API for Interrupt Frequency Test.

13 SW_SRAM_MARCH_TEST_01 - MarchC_Minus

This module contains functional safety diagnostics APIs for SRAM March-C Minus.

13.1 Defines

13.2 Functions

14 SW_WATCHDOG_SIMPLE_TIMER_STARTUP_TEST_01

This module contains functional safety diagnostics APIs for WatchDog Timer Test.

14.1 Defines

14.2 Enums

14.3 Functions

15 SW_WDT_WINDOWED_TIMER_STARTUP_TEST_01

This module contains functional safety diagnostics APIs for WatchDog Timer Test.

Here is a list of all documented files with brief descriptions

16.1 diag_clock_freq_types.h File Reference

This file contains common type definitions for Startup and Periodic types of Clock Frequency diagnostics.

16.2 diag_clock_frequency.c File Reference

This file contains APIs to test Clock Frequency diagnosis periodically.

16.3 diag_clock_frequency.h File Reference

This file contains API prototypes for Periodic Clock Frequency.

16.4 diag_config.h File Reference

This file contains macros to hold the user settings for diagnostics library.

16.5 diag_cpu_registers.c File Reference

This file contains APIs to test CPU Registers.

16.6 diag_cpu_registers.h File Reference

This file contains prototypes for APIs to test CPU Registers.

16.7 diag_cpu_selftest.c File Reference

This file contains implementation for CPU self tests.

16.8 diag_cpu_selftest.h File Reference

This file contains function prototypes and other datatypes for CPU self tests.

16.9 diag_cpu_selftest_subset1.c File Reference

16.10 diag_cpu_selftest_subset1.h File Reference

This file contains prototypes and datatypes for CPU self test subset-1.

16.11 diag_cpu_selftest_subset2.c File Reference

This file contains implementation for CPU self test subset-2.

16.12 diag_cpu_selftest_subset2.h File Reference

This file contains prototypes and datatypes for CPU self test subset-2.

16.13 diag_cpu_selftest_subset3.c File Reference

This file contains implementation for CPU self test subset-1.

16.14 diag_cpu_selftest_subset3.h File Reference

This file contains prototypes and datatypes for CPU self test subset-3.

16.15 diag_crc16_lookup_table.c File Reference

This file contains look up table and an API to read its contents for 16-bit CCITT CRC algorithm.

16.16 diag_crc16_lookup_table.h File Reference

This file contains prototype of API to read look up table contents for 16-bit CCITT CRC algorithm.

16.17 diag_crc32_lookup_table.c File Reference

This file contains look up table and an API to read its contents for 32-bit CRC algorithm.

16.18 diag_crc32_lookup_table.h File Reference

This file contains prototype of API to read look up table contents for 32-bit CRC algorithm.

16.19 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.

16.20 diag_eeprom_crc16_direct.c File Reference

This file contains APIs to test EEPROM using CRC16 CCITT Direct Computation algorithm.

16.21 diag_eeprom_crc16_lookup.c File Reference

This file contains APIs to test EEPROM using CRC16 CCITT Look-up Table algorithm.

16.22 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.

16.23 diag_eeprom_crc32_direct.c File Reference

This file contains APIs to test EEPROM using CRC32 Direct Computation algorithm.

16.24 diag_eeprom_crc32_lookup.c File Reference

This file contains APIs to test EEPROM using CRC32 Look-up Table algorithm.

16.25 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.

16.26 diag_flash_crc16_direct.c File Reference

This file contains APIs to test FLASH using CRC16 CCITT Direct Computation algorithm.

16.27 diag_flash_crc16_lookup.c File Reference

This file contains APIs to test FLASH using CRC16 CCITT Look-up Table algorithm.

16.28 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.

16.29 diag_flash_crc32_direct.c File Reference

This file contains APIs to test FLASH using CRC32 Direct Computation algorithm.

16.30 diag_flash_crc32_lookup.c File Reference

This file contains APIs to test FLASH using CRC32 Look-up Table algorithm.

16.31 diag_intr_freq.c File Reference

This file contains APIs for Interrupt Frequency test.

16.32 diag_intr_freq.h File Reference

This file contains data structures and API prototypes for Interrupt Frequency Test.

16.33 diag_memory_types.h File Reference

This file contains common type definitions for EEPROM and FLASH module.

16.34 diag_sram_marchc_minus.c File Reference

This file contains APIs to test SRAM using March-C Minus algorithm.

16.35 diag_sram_marchc_minus.h File Reference

This file contains API prototypes for SRAM March-C Minus test.

16.36 diag_sram_types.h File Reference

This file contains common type definitions for SRAM diagnostics module.

16.37 diag_startup.c File Reference

This file contains the calls to the on-startup SRAM March test.

16.38 diag_wdt_simple_timer.c File Reference

This file contains APIs to test WDT in Simple-Timer Mode using Indirect Time-Slot Monitoring method.

16.39 diag_wdt_simple_timer.h File Reference

This file contains API prototypes for Indirect Time-Slot Monitoring based WDT Test (Simple-Timer Mode)

16.40 diag_wdt_windowed_timer.c File Reference

This file contains APIs to test WDT in Windowed-Timer Mode using Indirect Time-Slot Monitoring method.

16.41 diag_wdt_windowed_timer.h File Reference

This file contains API prototypes for Indirect Time-Slot Monitoring based WDT Test (Windowed-Timer Mode)

17 Class List

Here is a list of all documented files with brief descriptions