OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

cavs: pm: improve PM_RUNTIME_HOST_DMA_L1 documentation 

Reword doxygen comments and change the private helper function
names to better reflect the actual implementation. No functional
change.

The PM_RUNTIME_HOST_DMA_L1 resource is used to coordinate host DMA
users, so that DMI link is kept in L1 until all users are ready to
activate the link. This is a bit unusual usage of runtime-pm interface
in that a 'put on a resource' triggers transition to higher power state,
so this deserves some more documentation.

Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
This commit is contained in:
Kai Vehmanen 2021-06-29 15:38:17 +03:00 committed by Liam Girdwood
parent 8c863f43af
commit 8633d5fd6d
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/include/sof/lib/pm_runtime.h
View File

@ -33,7 +33,7 @@
/** \brief Runtime power management context */
enum pm_runtime_context {
PM_RUNTIME_HOST_DMA_L1 = 0, /**< Host DMA L1 Exit */
PM_RUNTIME_HOST_DMA_L1 = 0, /**< Host DMA L1 */
SSP_CLK, /**< SSP Clock */
SSP_POW, /**< SSP Power */
DMIC_CLK, /**< DMIC Clock */

16
src/platform/intel/cavs/lib/pm_runtime.c
View File

@ -46,8 +46,11 @@ DECLARE_SOF_UUID("power", power_uuid, 0x76cc9773, 0x440c, 0x4df9,
DECLARE_TR_CTX(power_tr, SOF_UUID(power_uuid), LOG_LEVEL_INFO);
/** \brief Registers Host DMA access by incrementing ref counter. */
static void cavs_pm_runtime_host_dma_l1_entry(void)
/**
* \brief Registers Host DMA usage that should not trigger
* transition to L0 via forced L1 exit.
*/
static void cavs_pm_runtime_host_dma_l1_get(void)
{
struct pm_runtime_data *prd = pm_runtime_data_get();
struct cavs_pm_runtime_data *pprd = prd->platform_data;
@ -61,9 +64,10 @@ static void cavs_pm_runtime_host_dma_l1_entry(void)
}
/**
* \brief Forces Host DMAs to exit L1.
* \brief Releases Host DMA usage preventing L1 exit. If this
* the last user, forced L1 exit is performed.
*/
static inline void cavs_pm_runtime_force_host_dma_l1_exit(void)
static inline void cavs_pm_runtime_host_dma_l1_put(void)
{
struct pm_runtime_data *prd = pm_runtime_data_get();
struct cavs_pm_runtime_data *pprd = prd->platform_data;
@ -477,7 +481,7 @@ void platform_pm_runtime_get(enum pm_runtime_context context, uint32_t index,
/* Action based on context */
switch (context) {
case PM_RUNTIME_HOST_DMA_L1:
cavs_pm_runtime_host_dma_l1_entry();
cavs_pm_runtime_host_dma_l1_get();
break;
#if CONFIG_INTEL_SSP
case SSP_CLK:
@ -517,7 +521,7 @@ void platform_pm_runtime_put(enum pm_runtime_context context, uint32_t index,
{
switch (context) {
case PM_RUNTIME_HOST_DMA_L1:
cavs_pm_runtime_force_host_dma_l1_exit();
cavs_pm_runtime_host_dma_l1_put();
break;
#if CONFIG_INTEL_SSP
case SSP_CLK: