POK Functions

Introduction

===========================================================================

---

Functions
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...
int32_t	SDL_POK_getStatus (SDL_POK_Inst instance, SDL_POK_thrStatus *pStatus)
	POK Function to get the threshold status of the POK instance. More...

Function Documentation

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.

SDL_POK_getStatus()

int32_t SDL_POK_getStatus	(	SDL_POK_Inst	instance,
		SDL_POK_thrStatus *	pStatus
	)

POK Function to get the threshold status of the POK instance.

============================================================================

Parameters

instance	Instance of POK
pStatus	Pointer to the threshold status

Returns

SDL_PASS for success. SDL Error Code for Failure.