LPM (Link Power Management) Functions

General Description

The LPM functions provide an API to use the LPM feature available in the USB block.

Functions
__STATIC_INLINE uint32_t	Cy_USBFS_Dev_Drv_Lpm_GetBeslValue (USBFS_Type const *base)
	Returns the Best Effort Service Latency (BESL) value sent by the host as part of the LPM token transaction. More...
__STATIC_INLINE bool	Cy_USBFS_Dev_Drv_Lpm_RemoteWakeUpAllowed (USBFS_Type const *base)
	Returns the remote wakeup permission set by the Host as part of the LPM token transaction. More...
__STATIC_INLINE void	Cy_USBFS_Dev_Drv_Lpm_SetResponse (USBFS_Type *base, cy_en_usbfs_dev_drv_lpm_req_t response)
	Configures the response in the handshake packet that the device sends when an LPM token packet is received. More...
__STATIC_INLINE cy_en_usbfs_dev_drv_lpm_req_t	Cy_USBFS_Dev_Drv_Lpm_GetResponse (USBFS_Type const *base)
	Returns the response value that the device sends as part of the handshake packet when an LPM token packet is received. More...

Function Documentation

Cy_USBFS_Dev_Drv_Lpm_GetBeslValue()

__STATIC_INLINE uint32_t Cy_USBFS_Dev_Drv_Lpm_GetBeslValue

(

USBFS_Type const *

base

)

Returns the Best Effort Service Latency (BESL) value sent by the host as part of the LPM token transaction.

Parameters

base	The pointer to the USBFS instance.

Returns

BESL value (4-bits)

Cy_USBFS_Dev_Drv_Lpm_RemoteWakeUpAllowed()

__STATIC_INLINE bool Cy_USBFS_Dev_Drv_Lpm_RemoteWakeUpAllowed

(

USBFS_Type const *

base

)

Returns the remote wakeup permission set by the Host as part of the LPM token transaction.

Parameters

base	The pointer to the USBFS instance.

Returns

Remote wakeup permission: true - allowed, false - not allowed.

Cy_USBFS_Dev_Drv_Lpm_SetResponse()

__STATIC_INLINE void Cy_USBFS_Dev_Drv_Lpm_SetResponse	(	USBFS_Type *	base,
		cy_en_usbfs_dev_drv_lpm_req_t	response
	)

Configures the response in the handshake packet that the device sends when an LPM token packet is received.

Parameters

base	The pointer to the USBFS instance.
response	The response to return for an LPM token packet. See cy_en_usbfs_dev_drv_lpm_req_t for the set of options.

Cy_USBFS_Dev_Drv_Lpm_GetResponse()

__STATIC_INLINE cy_en_usbfs_dev_drv_lpm_req_t Cy_USBFS_Dev_Drv_Lpm_GetResponse

(

USBFS_Type const *

base

)

Returns the response value that the device sends as part of the handshake packet when an LPM token packet is received.

Parameters

base	The pointer to the USBFS instance.

Returns

The response to return for an LPM token packet. See cy_en_usbfs_dev_drv_lpm_req_t for the set of options.