AVR IEC60730 Class B Diagnostic Library v5.0.0 API Documentation

Introduction

This document contains API documentation for the diagnostic tests included MPLAB® Code Configurator AVR® IEC60730 Class B Diagnostic Library.

1 Software Requirements

1.1 Clock Frequency Test

1.2 CPU Program Counter

1.3 CPU Registers

1.4 EEPROM CRC

1.5 FLASH CRC

1.6 Interrupt Frequency

1.7 SRAM - Checkerboard Algorithm

1.8 SRAM - March C-Minus Algorithm

1.9 Simple Watchdog Timer

1.10 Windowed Watchdog Timer

2 Clock Frequency Test

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

2.1 Defines

2.2 Functions

3 CPU Program Counter

This module contains functional safety diagnostics APIs for CPU Program counter test.

This module contains functional safety diagnostics APIs for CPU Registers.

4.1 Defines

4.2 Enums

4.3 Functions

5 EEPROM - 16-bit CRC

This module contains APIs to calculate, store and validate 16-bit CCITT CRC for a given EEPROM region.

5.1 Defines

5.2 Functions

6 EEPROM - 32-bit CRC

This module contains APIs to calculate, store and validate 32-bit CCITT CRC for a given EEPROM region.

6.1 Defines

6.2 Functions

7 FLASH - 16-bit CRC

This module contains APIs to calculate, store and validate 16-bit CCITT CRC for a given FLASH region.

7.1 Defines

7.2 Functions

8 FLASH - 32-bit CRC

This module contains APIs to calculate, store and validate 32-bit CCITT CRC for a given FLASH region.

8.1 Defines

8.2 Functions

9 Interrupt Frequency Test

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

9.1 Structs

9.2 Enums

9.3 Functions

10 SRAM - Checkerboard Algorithm

This module contains functional safety diagnostics APIs for SRAM Checkerboard Test.

10.1 Defines

10.2 Functions

11 SRAM - March C-Minus Algorithm

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

11.1 Defines

11.2 Functions

12 Simple Watchdog Timer

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

12.1 Defines

12.2 Enums

12.3 Functions

13 Windowed Watchdog Timer

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

Here is a list of all documented files with brief descriptions

14.1 diag_clock_freq_types.h File Reference

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

14.2 diag_clock_frequency.c File Reference

This file contains APIs to test Clock Frequency diagnosis periodically.

14.3 diag_clock_frequency.h File Reference

This file contains API prototypes for Periodic Clock Frequency.

14.4 diag_config.h File Reference

14.5 diag_cpu_program_counter.c File Reference

This file contains APIs to test CPU using program counter functional test.

14.6 diag_cpu_program_counter.h File Reference

This file contains prototypes for APIs to test CPU Program Counter.

14.7 diag_cpu_registers.c File Reference

This file contains APIs to test CPU Registers.

14.8 diag_cpu_registers.h File Reference

This file contains prototypes for APIs to test CPU Registers.

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

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

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

14.12 diag_crc32_lookup_table.h File Reference

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

14.13 diag_device_macros.h File Reference

This common file contains macros that group device specific macros to account for differences and similarities in device architectures.

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

14.15 diag_eeprom_crc16_direct.c File Reference

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

14.16 diag_eeprom_crc16_lookup.c File Reference

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

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

14.18 diag_eeprom_crc32_direct.c File Reference

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

14.19 diag_eeprom_crc32_lookup.c File Reference

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

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

14.21 diag_flash_crc16_direct.c File Reference

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

14.22 diag_flash_crc16_lookup.c File Reference

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

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

14.24 diag_flash_crc32_direct.c File Reference

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

14.25 diag_flash_crc32_lookup.c File Reference

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

14.26 diag_intr_freq.c File Reference

This file contains APIs for Interrupt Frequency test.

14.27 diag_intr_freq.h File Reference

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

14.28 diag_memory_types.h File Reference

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

14.29 diag_sram_checkerboard.c File Reference

This file contains APIs to test SRAM using Checkerboard algorithm.

14.30 diag_sram_checkerboard.h File Reference

This file contains API prototypes for SRAM Checkerboard algorithm.

14.31 diag_sram_marchc_minus.c File Reference

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

14.32 diag_sram_marchc_minus.h File Reference

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

14.33 diag_sram_types.h File Reference

This file contains common type definitions for SRAM diagnostics module.

14.34 diag_wdt_simple_timer.c File Reference

14.35 diag_wdt_simple_timer.h File Reference

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

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

14.37 diag_wdt_windowed_timer.h File Reference

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

15 Class List

Here is a list of all documented files with brief descriptions