xilpuf
Vitis Drivers API Documentation
xpuf_defs.h File Reference

Overview

This file contains the xilpuf API IDs.

MODIFICATION HISTORY:
Ver   Who  Date     Changes


1.0 kpt 01/04/22 Initial release 2.3 ng 11/22/23 Fixed doxygen grouping

 

Macros

#define XPUF_REGISTRATION   (0x0U)
 PUF Operation - PUF Registration. More...
 
#define XPUF_REGEN_ON_DEMAND   (0x1U)
 PUF Operation - PUF On demand regeneration. More...
 
#define XPUF_REGEN_ID_ONLY   (0x2U)
 PUF Operation - PUF ID only regeneration. More...
 
#define XPUF_SYNDROME_MODE_4K   (0x0U)
 PUF Mode - 4K Syndrome mode. More...
 
#define XPUF_SHUTTER_VALUE   (0x81000100U)
 PUF Shutter Value - Versal. More...
 

Enumerations

enum  XPuf_ReadOption { XPUF_READ_FROM_RAM, XPUF_READ_FROM_EFUSE_CACHE }
 
enum  XPuf_ApiId {
  XPUF_API_FEATURES = 0U, XPUF_PUF_REGISTRATION, XPUF_PUF_REGENERATION, XPUF_PUF_CLEAR_PUF_ID,
  XPUF_API_MAX
}
 

Macro Definition Documentation

#define XPUF_REGEN_ID_ONLY   (0x2U)

PUF Operation - PUF ID only regeneration.

Referenced by XPuf_Regeneration().

#define XPUF_REGEN_ON_DEMAND   (0x1U)

PUF Operation - PUF On demand regeneration.

Referenced by XPuf_Regeneration().

#define XPUF_REGISTRATION   (0x0U)

PUF Operation - PUF Registration.

#define XPUF_SHUTTER_VALUE   (0x81000100U)

PUF Shutter Value - Versal.

#define XPUF_SYNDROME_MODE_4K   (0x0U)

PUF Mode - 4K Syndrome mode.

Enumeration Type Documentation

enum XPuf_ApiId
Enumerator
XPUF_API_FEATURES 

API id for features.

XPUF_PUF_REGISTRATION 

API id for PUF registration.

XPUF_PUF_REGENERATION 

API id for PUF regeneration.

XPUF_PUF_CLEAR_PUF_ID 

API id for PUF clear id.

XPUF_API_MAX 

Number of API features.

Enumerator
XPUF_READ_FROM_RAM 

Read helper data from memory.

XPUF_READ_FROM_EFUSE_CACHE 

Read helper data from eFuse cache.