AM62x MCU+ SDK  10.01.00

Introduction

Files

file  sciclient_lpm.h
 This file contains the definition of all the message IDs, message formats to be able to interact with the System Controller firmware for low power modes.
 

Functions

int32_t Sciclient_lpmSetModuleConstraint (uint32_t moduleId, uint8_t state, uint32_t timeout)
 Message to set constraint on a module. This is used to set constraint on a module. Setting a constraint ensures that module will not be powered off or reset in the selected mode. Based on exclusive access, multiple processing entities can put constraints on a specific hardware block. More...
 
int32_t Sciclient_lpmGetModuleConstraint (uint32_t moduleId, uint8_t *state, uint32_t timeout)
 Message to get the state of constraint on a Module. This request does not require the processing entity to have control of the device via a set device state request. More...
 
int32_t Sciclient_lpmSetLatencyConstraint (uint16_t resumeLatency, uint8_t state, uint32_t timeout)
 Message to set the system resume latency constraint. This is used to set latency for waking up from low power mode that is, to ensure that the resume time from selected low power mode will be less than the latency constraint value. More...
 
int32_t Sciclient_lpmGetLatencyConstraint (uint16_t *resumeLatency, uint8_t *state, uint32_t timeout)
 Message to get the system resume latency constraint value. More...
 
int32_t Sciclient_lpmGetNextSysMode (uint32_t timeout, uint8_t *sysMode)
 Message to get the next system mode. More...
 
int32_t Sciclient_lpmGetNextHostState (uint32_t timeout, uint8_t *hostState)
 Message to get the next host state. More...
 

Enumerations

enum  gLPMSysModes {
  TISCI_LPM_SYS_MODE_DEEP_SLEEP = 0U, TISCI_LPM_SYS_MODE_MCU_ONLY, TISCI_LPM_SYS_MODE_IO_ONLY_PLUS_DDR, TISCI_LPM_SYS_MODE_PARTIAL_IO,
  TISCI_LPM_SYS_MODE_STANDBY, TISCI_LPM_SYS_MODE_NOT_SELECTED = 0xFEU
}
 

Enumeration Type Documentation

◆ gLPMSysModes

Enumerator
TISCI_LPM_SYS_MODE_DEEP_SLEEP 
TISCI_LPM_SYS_MODE_MCU_ONLY 
TISCI_LPM_SYS_MODE_IO_ONLY_PLUS_DDR 
TISCI_LPM_SYS_MODE_PARTIAL_IO 
TISCI_LPM_SYS_MODE_STANDBY 
TISCI_LPM_SYS_MODE_NOT_SELECTED 

Function Documentation

◆ Sciclient_lpmSetModuleConstraint()

int32_t Sciclient_lpmSetModuleConstraint ( uint32_t  moduleId,
uint8_t  state,
uint32_t  timeout 
)

Message to set constraint on a module. This is used to set constraint on a module. Setting a constraint ensures that module will not be powered off or reset in the selected mode. Based on exclusive access, multiple processing entities can put constraints on a specific hardware block.


Message: TISCI_MSG_LPM_SET_DEVICE_CONSTRAINT
Request: tisci_msg_lpm_set_device_constraint_req
Response: tisci_msg_lpm_set_device_constraint_resp

Parameters
moduleIdModule for which the constraint should be set. Refer Sciclient_PmDeviceIds.
stateModule Constraint State requested. 1 - Set the constraint 0 - Clear the constraint
timeoutGives a sense of how long to wait for the operation. Refer SystemP_Timeout.
Returns
SystemP_SUCCESS on success, else failure

◆ Sciclient_lpmGetModuleConstraint()

int32_t Sciclient_lpmGetModuleConstraint ( uint32_t  moduleId,
uint8_t *  state,
uint32_t  timeout 
)

Message to get the state of constraint on a Module. This request does not require the processing entity to have control of the device via a set device state request.


Message: TISCI_MSG_LPM_GET_DEVICE_CONSTRAINT
Request: tisci_msg_lpm_get_device_constraint_req
Response: tisci_msg_lpm_get_device_constraint_resp

Parameters
moduleIdModule for which the constraint has to be queried. Refer Sciclient_PmDeviceIds.
stateModule Constraint State returned. 1 - Constraint is set 0 - Constraint is not set
timeoutGives a sense of how long to wait for the operation. Refer SystemP_Timeout.
Returns
SystemP_SUCCESS on success, else failure

◆ Sciclient_lpmSetLatencyConstraint()

int32_t Sciclient_lpmSetLatencyConstraint ( uint16_t  resumeLatency,
uint8_t  state,
uint32_t  timeout 
)

Message to set the system resume latency constraint. This is used to set latency for waking up from low power mode that is, to ensure that the resume time from selected low power mode will be less than the latency constraint value.


Message: TISCI_MSG_LPM_SET_LATENCY_CONSTRAINT
Request: tisci_msg_lpm_set_latency_constraint_req
Response: tisci_msg_lpm_set_latency_constraint_resp

Parameters
resumeLatencyThe maximum acceptable latency to wake up from low power mode (in milliseconds).
stateModule Constraint State requested. 1 - Set the latency constraint value 0 - Clear the latency constraint value
timeoutGives a sense of how long to wait for the operation. Refer SystemP_Timeout.
Returns
SystemP_SUCCESS on success, else failure

◆ Sciclient_lpmGetLatencyConstraint()

int32_t Sciclient_lpmGetLatencyConstraint ( uint16_t *  resumeLatency,
uint8_t *  state,
uint32_t  timeout 
)

Message to get the system resume latency constraint value.


Message: TISCI_MSG_LPM_GET_LATENCY_CONSTRAINT
Request: tisci_msg_lpm_get_latency_constraint_req
Response: tisci_msg_lpm_get_latency_constraint_resp

Parameters
resumeLatencyThe current value of resume latency constraint.
stateModule Constraint State returned. 1 - Latency constraint is set 0 - Latency constraint is not set
timeoutGives a sense of how long to wait for the operation. Refer SystemP_Timeout.
Returns
SystemP_SUCCESS on success, else failure

◆ Sciclient_lpmGetNextSysMode()

int32_t Sciclient_lpmGetNextSysMode ( uint32_t  timeout,
uint8_t *  sysMode 
)

Message to get the next system mode.


Message: TISCI_MSG_LPM_GET_NEXT_SYS_MODE
Request: tisci_msg_lpm_get_next_sys_mode_req
Response: tisci_msg_lpm_get_next_sys_mode_resp

Parameters
sysModeNext system mode returned.
timeoutGives a sense of how long to wait for the operation. Refer SystemP_Timeout.
Returns
SystemP_SUCCESS on success, else failure

◆ Sciclient_lpmGetNextHostState()

int32_t Sciclient_lpmGetNextHostState ( uint32_t  timeout,
uint8_t *  hostState 
)

Message to get the next host state.


Message: TISCI_MSG_LPM_GET_NEXT_HOST_STATE
Request: tisci_msg_lpm_get_next_host_state_req
Response: tisci_msg_lpm_get_next_host_state_resp

Parameters
hostStateNext host state returned.
timeoutGives a sense of how long to wait for the operation. Refer SystemP_Timeout.
Returns
SystemP_SUCCESS on success, else failure