Software APIs
Typedefs | Enumerations
dif_base.h File Reference

(5e04ded)

Shared macros and headers for DIFs. More...

Go to the source code of this file.

Typedefs

typedef enum dif_result dif_result_t
 The result of a DIF operation. More...
 
typedef enum dif_toggle dif_toggle_t
 A toggle state: enabled, or disabled. More...
 

Enumerations

enum  dif_result {
  kDifOk = 0,
  kDifError = 1,
  kDifBadArg = 2,
  kDifLocked = 3,
  kDifUnavailable = 4,
  kDifIpFifoFull = 5,
  kDifOutOfRange = 6,
  kDifUnaligned = 7
}
 The result of a DIF operation. More...
 
enum  dif_toggle {
  kDifToggleDisabled = 0,
  kDifToggleEnabled = 1
}
 A toggle state: enabled, or disabled. More...
 

Detailed Description

Shared macros and headers for DIFs.

Definition in file dif_base.h.

Typedef Documentation

◆ dif_result_t

typedef enum dif_result dif_result_t

The result of a DIF operation.

NOTE: additional result values can be defined in the manually-implemented header by creating an additional *_result_t enum type. See the Lifecycle Controller DIF for how this may be implemented.

◆ dif_toggle_t

typedef enum dif_toggle dif_toggle_t

A toggle state: enabled, or disabled.

This enum may be used instead of a bool when describing an enabled/disabled state.

Enumeration Type Documentation

◆ dif_result

enum dif_result

The result of a DIF operation.

NOTE: additional result values can be defined in the manually-implemented header by creating an additional *_result_t enum type. See the Lifecycle Controller DIF for how this may be implemented.

Enumerator
kDifOk 

Indicates that the operation succeeded.

kDifError 

Indicates some unspecified failure.

kDifBadArg 

Indicates that some parameter passed into a function failed a precondition.

When this value is returned, no hardware operations occurred.

kDifLocked 

The operation failed because writes to a required register are disabled.

kDifUnavailable 

The operation failed because the IP is processing an operation, and will finish in some amount of time.

A function that returns this error may be retried at any time, and is guaranteed to have not produced any side effects.

kDifIpFifoFull 

Indicates that the Ip's FIFO (if it has one or more of) is full.

kDifOutOfRange 

Indicates that the attempted operation would attempt a read/write to an address that would go out of range.

kDifUnaligned 

Indicates that the attempted operation would attempt a read/write to an address that is not aligned.

Definition at line 24 of file dif_base.h.

◆ dif_toggle

enum dif_toggle

A toggle state: enabled, or disabled.

This enum may be used instead of a bool when describing an enabled/disabled state.

Enumerator
kDifToggleDisabled 

The "disabled" state.

kDifToggleEnabled 

The "enabled" state.

Definition at line 74 of file dif_base.h.