forked from thesofproject/sof
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpm_runtime.h
More file actions
114 lines (97 loc) · 3.75 KB
/
pm_runtime.h
File metadata and controls
114 lines (97 loc) · 3.75 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
* Copyright (c) 2018, Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Intel Corporation nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Author: Tomasz Lauda <tomasz.lauda@linux.intel.com>
*/
/**
* \file include/sof/pm_runtime.h
* \brief Runtime power management header file
* \author Tomasz Lauda <tomasz.lauda@linux.intel.com>
*/
#ifndef __INCLUDE_PM_RUNTIME__
#define __INCLUDE_PM_RUNTIME__
#include <sof/lock.h>
#include <sof/trace.h>
#include <sof/wait.h>
/** \addtogroup pm_runtime PM Runtime
* PM runtime specification.
* @{
*/
/** \brief Power management trace function. */
#define trace_pm(__e) trace_event(TRACE_CLASS_POWER, __e)
#define tracev_pm(__e) tracev_event(TRACE_CLASS_POWER, __e)
/** \brief Power management trace value function. */
#define tracev_pm_value(__e) tracev_value(__e)
/* PM runtime flags */
#define RPM_ASYNC 0x01 /**< Request is asynchronous */
/** \brief Runtime power management context */
enum pm_runtime_context {
PM_RUNTIME_HOST_DMA_L1 = 0, /**< Host DMA L1 Exit */
SSP_CLK, /**< SSP Clock */
DMIC_CLK, /**< DMIC Clock */
DMIC_POW, /**< DMIC Power */
DW_DMAC_CLK /**< DW DMAC Clock */
};
/** \brief Runtime power management data. */
struct pm_runtime_data {
spinlock_t lock; /**< lock mechanism */
void *platform_data; /**< platform specific data */
};
/**
* \brief Initializes runtime power management.
*/
void pm_runtime_init(void);
/**
* \brief Retrieves power management resource (async).
*
* \param[in] context Type of power management context.
* \param[in] index Index of the device.
*/
void pm_runtime_get(enum pm_runtime_context context, uint32_t index);
/**
* \brief Retrieves power management resource.
*
* \param[in] context Type of power management context.
* \param[in] index Index of the device.
*/
void pm_runtime_get_sync(enum pm_runtime_context context, uint32_t index);
/**
* \brief Releases power management resource (async).
*
* \param[in] context Type of power management context.
* \param[in] index Index of the device.
*/
void pm_runtime_put(enum pm_runtime_context context, uint32_t index);
/**
* \brief Releases power management resource.
*
* \param[in] context Type of power management context.
* \param[in] index Index of the device.
*/
void pm_runtime_put_sync(enum pm_runtime_context context, uint32_t index);
/** @}*/
#endif /* __INCLUDE_PM_RUNTIME__ */