POK Functions

Introduction

Structures and Enums

Data Structures
struct	SDL_POK_staticRegs
	POK Static Registers structure. More...

Functions
int32_t	SDL_POK_enablePP (SDL_PRG_Inst instance, bool enable)
	POK Function to enable or disable ping/pong mode for a specified PRG. Only supported for v1 version of the IP. More...
int32_t	SDL_POK_getStaticRegisters (SDL_POK_Inst instance, SDL_POK_staticRegs *pStaticRegs)
	POK Function to get the Static Registers. This function reads the values of the static registers such as hysteresis control, voltage detect mode, trim, PORGP and module status. More...
int32_t	SDL_POK_init (SDL_POK_Inst instance, SDL_POK_config *pConfig)
	POK module configuration API. More...
int32_t	SDL_POK_verifyConfig (SDL_POK_Inst instance, SDL_POK_config *pConfig)
	POK Function to verify the written configuration. This function checks the provided config against the written config and returns the verification status. More...

Function Documentation

SDL_POK_enablePP()

int32_t SDL_POK_enablePP	(	SDL_PRG_Inst	instance,
		bool	enable
	)

POK Function to enable or disable ping/pong mode for a specified PRG. Only supported for v1 version of the IP.

Parameters

instance	Instance of PRG
enable	Enable or disable the ping/pong mode

Returns

SDL_PASS for success. SDL Error Code for failure.

SDL_POK_getStaticRegisters()

int32_t SDL_POK_getStaticRegisters	(	SDL_POK_Inst	instance,
		SDL_POK_staticRegs *	pStaticRegs
	)

POK Function to get the Static Registers. This function reads the values of the static registers such as hysteresis control, voltage detect mode, trim, PORGP and module status.

Parameters

instance	Instance of POK
pStaticRegs	Pointer to the static registers structure

Returns

SDL_PASS for success. SDL Error Code for Failure.

SDL_POK_init()

int32_t SDL_POK_init	(	SDL_POK_Inst	instance,
		SDL_POK_config *	pConfig
	)

POK module configuration API.

Parameters

instance	Instance of POK
pConfig	Pointer to the configuration structure

Returns

SDL_PASS for success. SDL Error Code for Failure.

SDL_POK_verifyConfig()

int32_t SDL_POK_verifyConfig	(	SDL_POK_Inst	instance,
		SDL_POK_config *	pConfig
	)

POK Function to verify the written configuration. This function checks the provided config against the written config and returns the verification status.

Parameters

instance	Instance of POK
pConfig	Pointer to the configuration structure

Returns

SDL_PASS if configuration is verified to match. SDL Error Code for Failure.