DOC Interface

Interface for the Data Operation Circuit. More...

Data Structures
struct	doc_callback_args_t
struct	doc_data_t
struct	doc_cfg_t
struct	doc_api_t
struct	doc_instance_t

Macros
#define	DOC_API_VERSION_MAJOR   (2U)

Typedefs
typedef uint16_t	doc_size_t
typedef void	doc_ctrl_t

Enumerations
enum	doc_event_t { DOC_EVENT_COMPARISON_MISMATCH = 0x00, DOC_EVENT_ADDITION = 0x01, DOC_EVENT_SUBTRACTION = 0x02, DOC_EVENT_COMPARISON_MATCH = 0x04 }
enum	doc_status_t { DOC_STATUS_CONDITION_FALSE = 0, DOC_STATUS_CONDITION_TRUE = 1 }

Detailed Description

Interface for the Data Operation Circuit.

Defines the API and data structures for the DOC implementation of the Data Operation Circuit (DOC) interface.

Summary

This module implements the DOC_API using the Data Operation Circuit (DOC).

Implemented by: DOC

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

DOC Interface description: Data Operation Circuit Driver

Macro Definition Documentation

DOC_API_VERSION_MAJOR

#define DOC_API_VERSION_MAJOR   (2U)

Register definitions, common services and error codes.

Typedef Documentation

doc_ctrl_t

typedef void doc_ctrl_t

DOC control block. Allocate an instance specific control block to pass into the DOC API calls.

Implemented as

• doc_instance_ctrl_t

doc_size_t

typedef uint16_t doc_size_t

Size of the comparison data supported by the Data Operation Circuit (DOC)

Enumeration Type Documentation

doc_event_t

enum doc_event_t

Event that can trigger a callback function.

Enumerator
DOC_EVENT_COMPARISON_MISMATCH	Comparison of data has resulted in a mismatch.
DOC_EVENT_ADDITION	Addition of data has resulted in a value greater than H'FFFF.
DOC_EVENT_SUBTRACTION	Subtraction of data has resulted in a value less than H'0000.
DOC_EVENT_COMPARISON_MATCH	Comparison of data has resulted in a match.

doc_status_t

enum doc_status_t

Status of the data comparison operation.

Enumerator
DOC_STATUS_CONDITION_FALSE	Data comparison condition NOT met (match or mismatch), addition result NOT > H'FFFF, subtraction result NOT < H'0000.
DOC_STATUS_CONDITION_TRUE	Data comparison condition met (match or mismatch), addition result > H'FFFF, subtraction result < H'0000.