3
|
1 |
/*
|
|
2 |
pm_policy_chipset_api.h
|
|
3 |
|
|
4 |
Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
5 |
All rights reserved.
|
|
6 |
|
|
7 |
This program and the accompanying materials are made available
|
|
8 |
under the terms of the Eclipse Public License v1.0 which accompanies
|
|
9 |
this distribution, and is available at
|
|
10 |
http://www.eclipse.org/legal/epl-v10.html
|
|
11 |
|
|
12 |
Initial Contributors:
|
|
13 |
Nokia Corporation - initial contribution.
|
|
14 |
|
|
15 |
Contributors:
|
|
16 |
*/
|
|
17 |
|
|
18 |
/** @file
|
|
19 |
@brief PM Policy Chipset API H
|
|
20 |
|
|
21 |
The purpose of this interface is to enable Nokia to affect power management
|
|
22 |
functionalities implemented below the Chipset API.
|
|
23 |
This interface is meant to be used only by Symbian kernel side clients.
|
|
24 |
|
|
25 |
@publishedDeviceAbstraction
|
|
26 |
*/
|
|
27 |
|
|
28 |
#ifndef PM_POLICY_CHIPSET_API_H
|
|
29 |
#define PM_POLICY_CHIPSET_API_H
|
|
30 |
|
|
31 |
|
|
32 |
// Include files
|
|
33 |
|
|
34 |
#include <kern_priv.h>
|
|
35 |
#include "pm_definitions_chipset_api.h"
|
|
36 |
|
|
37 |
|
|
38 |
// Class declaration
|
|
39 |
|
|
40 |
/**
|
|
41 |
@brief Class description
|
|
42 |
|
|
43 |
This class contains static methods to set and get certain power management
|
|
44 |
policy parameters. There are no data members.
|
|
45 |
*/
|
|
46 |
class PMPolicy
|
|
47 |
{
|
|
48 |
public:
|
|
49 |
/**
|
|
50 |
This enumeration is purposed to include the list of known load
|
|
51 |
prediction algorithms. It is mainly used for enquiring about current
|
|
52 |
algorithm and for setting and getting their parameters if applicable.
|
|
53 |
*/
|
|
54 |
enum TAlgorithm
|
|
55 |
{
|
|
56 |
EAlgoAll, /**< Any algorithm that is in use */
|
|
57 |
EAlgoAVGn, /**< Weighted average of past loads */
|
|
58 |
EAlgoMAW, /**< Moving average workload */
|
|
59 |
EAlgoLMS, /**< Least mean square */
|
|
60 |
EAlgoUnknown /**< Any other algorithm */
|
|
61 |
};
|
|
62 |
|
|
63 |
/**
|
|
64 |
The purpose of this enumeration is to specify the type of parameters
|
|
65 |
that can be changed for one or more of the load prediction algorithms.
|
|
66 |
*/
|
|
67 |
enum TParam
|
|
68 |
{
|
|
69 |
EParamSampleCount = 1 /**< number of history samples */
|
|
70 |
};
|
|
71 |
|
|
72 |
/**
|
|
73 |
Method to set the load prediction trigger delay. When the predicted load
|
|
74 |
is changed, it waits the specific amount of time before triggering the
|
|
75 |
OPP change. If the load changes back to the previous OPP window during
|
|
76 |
the wait period, then no OPP change will be done.
|
|
77 |
|
|
78 |
@param aRes The performance resource
|
|
79 |
@param aDelayInc Delay to be applied when the load is increasing
|
|
80 |
@param aDelayDec Delay to be applied when the load is decreasing
|
|
81 |
|
|
82 |
@return One of the system wide Symbian error codes according to the API
|
|
83 |
error handling specification.
|
|
84 |
|
|
85 |
@pre Called from thread context with interrupts enabled.
|
|
86 |
*/
|
|
87 |
IMPORT_C static TInt SetLoadPredTrigDelay(TPerfRes aRes, TInt aDelayInc,
|
|
88 |
TInt aDelayDec);
|
|
89 |
|
|
90 |
/**
|
|
91 |
Method to get the current trigger delay setting value of a particular
|
|
92 |
load monitor.
|
|
93 |
|
|
94 |
@param aRes The performance resource
|
|
95 |
@param aDelayInc Current delay setting when the load is increasing
|
|
96 |
@param aDelayDec Current delay setting when the load is decreasing
|
|
97 |
|
|
98 |
@return One of the system wide Symbian error codes according to the API
|
|
99 |
error handling specification.
|
|
100 |
|
|
101 |
@pre Called from thread context with interrupts enabled.
|
|
102 |
*/
|
|
103 |
IMPORT_C static TInt GetLoadPredTrigDelay(TPerfRes aRes,
|
|
104 |
TInt& aDelayInc, TInt& aDelayDec);
|
|
105 |
|
|
106 |
/**
|
|
107 |
Method to lock the load monitor trigger delay. If it is already in
|
|
108 |
locked state, this call is ignored.
|
|
109 |
|
|
110 |
@param aRes The performance resource
|
|
111 |
|
|
112 |
@return One of the system wide Symbian error codes according to the API
|
|
113 |
error handling specification.
|
|
114 |
|
|
115 |
@pre Called from thread context with interrupts enabled.
|
|
116 |
*/
|
|
117 |
IMPORT_C static TInt LockLoadPredTrigDelay(TPerfRes aRes);
|
|
118 |
|
|
119 |
/**
|
|
120 |
Method to unlock the load monitor trigger delay. If it is not in locked
|
|
121 |
state, this call is ignored.
|
|
122 |
|
|
123 |
@param aRes The performance resource
|
|
124 |
|
|
125 |
@return One of the system wide Symbian error codes according to the API
|
|
126 |
error handling specification.
|
|
127 |
|
|
128 |
@pre Called from thread context with interrupts enabled.
|
|
129 |
*/
|
|
130 |
IMPORT_C static TInt UnlockLoadPredTrigDelay(TPerfRes aRes);
|
|
131 |
|
|
132 |
/**
|
|
133 |
Method to set the WP tick period
|
|
134 |
@param aMon Monitor id
|
|
135 |
@param aPeriod New period value to be set (in milliseconds)
|
|
136 |
@return One of the system wide Symbian error codes according to the API
|
|
137 |
error handling specification
|
|
138 |
*/
|
|
139 |
IMPORT_C static TInt SetWpTickPeriod(TDvfsMonitor aMon, TUint aPeriod);
|
|
140 |
|
|
141 |
/**
|
|
142 |
Method to get the WP tick period
|
|
143 |
@param aMon Monitor id
|
|
144 |
@param aPeriod [Out] Current period value
|
|
145 |
@return One of the system wide Symbian error codes according to the API
|
|
146 |
error handling specification
|
|
147 |
*/
|
|
148 |
IMPORT_C static TInt GetWpTickPeriod(TDvfsMonitor aMon, TUint& aPeriod);
|
|
149 |
|
|
150 |
/**
|
|
151 |
Method to lock the WP tick period setting. If it is already locked, this
|
|
152 |
call is ignored
|
|
153 |
@param aMon Monitor id
|
|
154 |
@return One of the system wide Symbian error codes according to the API
|
|
155 |
error handling specification
|
|
156 |
*/
|
|
157 |
IMPORT_C static TInt LockWpTickPeriod(TDvfsMonitor aMon);
|
|
158 |
|
|
159 |
/**
|
|
160 |
Method to unlock the WP tick period setting. If it is not locked, this
|
|
161 |
call is ignored
|
|
162 |
@param aMon Monitor id
|
|
163 |
@return One of the system wide Symbian error codes according to the API
|
|
164 |
error handling specification
|
|
165 |
*/
|
|
166 |
IMPORT_C static TInt UnlockWpTickPeriod(TDvfsMonitor aMon);
|
|
167 |
|
|
168 |
/**
|
|
169 |
Method to set the WP window width
|
|
170 |
@param aMon Monitor id
|
|
171 |
@param aWidth The WP window width to set (in number of prediction ticks)
|
|
172 |
@return One of the system wide Symbian error codes according to the API
|
|
173 |
error handling specification
|
|
174 |
*/
|
|
175 |
IMPORT_C static TInt SetWpWindowWidth(TDvfsMonitor aMon, TUint aWidth);
|
|
176 |
|
|
177 |
/**
|
|
178 |
Method to get the WP window width
|
|
179 |
@param aMon Monitor id
|
|
180 |
@param aWidth [Out] The WP window width to get (in number of prediction ticks)
|
|
181 |
@return One of the system wide Symbian error codes according to the API
|
|
182 |
error handling specification
|
|
183 |
*/
|
|
184 |
IMPORT_C static TInt GetWpWindowWidth(TDvfsMonitor aMon, TUint& aWidth);
|
|
185 |
|
|
186 |
/**
|
|
187 |
Method to lock the WP window width. Does nothing if it is already locked
|
|
188 |
@param aMon Monitor id
|
|
189 |
@return One of the system wide Symbian error codes according to the API
|
|
190 |
error handling specification
|
|
191 |
*/
|
|
192 |
IMPORT_C static TInt LockWpWindowWidth(TDvfsMonitor aMon);
|
|
193 |
|
|
194 |
/**
|
|
195 |
Method to unlock the WP window width. Does nothing if it is not locked
|
|
196 |
@param aMon Monitor id
|
|
197 |
@return One of the system wide Symbian error codes according to the API
|
|
198 |
error handling specification
|
|
199 |
*/
|
|
200 |
IMPORT_C static TInt UnlockWpWindowWidth(TDvfsMonitor aMon);
|
|
201 |
|
|
202 |
/**
|
|
203 |
Method to get the current load prediction algorithm.
|
|
204 |
|
|
205 |
@param aMon The DVFS monitor
|
|
206 |
@param aAlgo Current algorithm returned to the caller (out parameter)
|
|
207 |
@param aCustom Any additional information (optional parameter).
|
|
208 |
|
|
209 |
@return One of the system wide Symbian error codes according to the API
|
|
210 |
error handling specification.
|
|
211 |
|
|
212 |
@pre Called from thread context with interrupts enabled.
|
|
213 |
*/
|
|
214 |
IMPORT_C static TInt GetCurrentAlgorithm(TDvfsMonitor aMon,
|
|
215 |
TAlgorithm& aAlgo, TInt* aCustom = 0);
|
|
216 |
|
|
217 |
/**
|
|
218 |
Method to set parameters to load monitor algorithm.
|
|
219 |
|
|
220 |
@param aMon The DVFS monitor
|
|
221 |
@param aAlgo Algorithm whose parameter has to be changed.
|
|
222 |
@param aParam Algorithm parameter name.
|
|
223 |
@param aArg The parameter value.
|
|
224 |
|
|
225 |
@return One of the system wide Symbian error codes according to the API
|
|
226 |
error handling specification.
|
|
227 |
|
|
228 |
@pre Called from thread context with interrupts enabled.
|
|
229 |
*/
|
|
230 |
IMPORT_C static TInt SetLoadMonitorParam(TDvfsMonitor aMon,
|
|
231 |
TAlgorithm aAlgo, TParam aParam, TAny* aArg);
|
|
232 |
|
|
233 |
/**
|
|
234 |
Method to retrieve existing parameters from load monitor algorithms.
|
|
235 |
|
|
236 |
@param aMon The DVFS monitor
|
|
237 |
@param aAlgo Algorithm whose parameter has to be retrieved.
|
|
238 |
@param aParam Algorithm parameter name.
|
|
239 |
@param aArg Pointer to a location where the value must be stored. This
|
|
240 |
can not be null (passing null value results in returning error code).
|
|
241 |
|
|
242 |
@return One of the system wide Symbian error codes according to the API
|
|
243 |
error handling specification.
|
|
244 |
|
|
245 |
@pre Called from thread context with interrupts enabled.
|
|
246 |
*/
|
|
247 |
IMPORT_C static TInt GetLoadMonitorParam(TDvfsMonitor aMon,
|
|
248 |
TAlgorithm aAlgo, TParam aParam, TAny* aArg);
|
|
249 |
|
|
250 |
/**
|
|
251 |
Locks the load monitor parameters. This lock should apply only to known
|
|
252 |
parameters of known algorithms – those that are enumerated in this
|
|
253 |
specification.
|
|
254 |
|
|
255 |
@param aMon The DVFS monitor
|
|
256 |
|
|
257 |
@return One of the system wide Symbian error codes according to the API
|
|
258 |
error handling specification.
|
|
259 |
|
|
260 |
@pre Called from thread context with interrupts enabled.
|
|
261 |
*/
|
|
262 |
IMPORT_C static TInt LockLoadMonitorParam(TDvfsMonitor aMon);
|
|
263 |
|
|
264 |
/**
|
|
265 |
Unlocks the load monitor parameters.
|
|
266 |
|
|
267 |
@param aMon The DVFS monitor
|
|
268 |
|
|
269 |
@return One of the system wide Symbian error codes according to the API
|
|
270 |
error handling specification.
|
|
271 |
|
|
272 |
@pre Called from thread context with interrupts enabled.
|
|
273 |
*/
|
|
274 |
IMPORT_C static TInt UnlockLoadMonitorParam(TDvfsMonitor aMon);
|
|
275 |
|
|
276 |
/**
|
|
277 |
Method to enable or disable a particular operation point.
|
|
278 |
|
|
279 |
@param aPerfRes Performance resource ID.
|
|
280 |
@param aOPP The operation point that is to be enable or disabled
|
|
281 |
@param aEnable If ETrue is specified, the OPP is enabled and if EFalse
|
|
282 |
is specified, then the OPP is disabled.
|
|
283 |
|
|
284 |
@return One of the system wide Symbian error codes according to the API
|
|
285 |
error handling specification.
|
|
286 |
|
|
287 |
@pre Called from thread context with interrupts enabled.
|
|
288 |
*/
|
|
289 |
IMPORT_C static TInt SetOPPState(TPerfRes aPerfRes, TInt aOPP,
|
|
290 |
TBool aEnable);
|
|
291 |
|
|
292 |
/**
|
|
293 |
Method to set the status of a list of operation points.
|
|
294 |
|
|
295 |
@param aPerfRes Performance resource ID.
|
|
296 |
@param aOppState Array containing the operation point status to be set.
|
|
297 |
|
|
298 |
@return One of the system wide Symbian error codes according to the API
|
|
299 |
error handling specification.
|
|
300 |
|
|
301 |
@pre Called from thread context with interrupts enabled.
|
|
302 |
*/
|
|
303 |
IMPORT_C static TInt SetOPPState(TPerfRes aPerfRes,
|
|
304 |
RArray<TBool>& aOppState);
|
|
305 |
|
|
306 |
/**
|
|
307 |
Method to get the current enabled/disabled status of a particular
|
|
308 |
operation point. OPPs are specified in the same way as mentioned
|
|
309 |
earlier.
|
|
310 |
Argument:
|
|
311 |
@param aPerfRes Performance resource ID.
|
|
312 |
@param aOPP The operation point that is to be checked.
|
|
313 |
@param aEnable Status of the operation point returned to the caller.
|
|
314 |
|
|
315 |
@return One of the system wide Symbian error codes according to the API
|
|
316 |
error handling specification.
|
|
317 |
|
|
318 |
@pre Called from thread context with interrupts enabled.
|
|
319 |
*/
|
|
320 |
IMPORT_C static TInt GetOPPState(TPerfRes aPerfRes, TInt aOPP,
|
|
321 |
TBool& aEnable);
|
|
322 |
|
|
323 |
/**
|
|
324 |
Method to get the full list of operation point enabled status.
|
|
325 |
Argument:
|
|
326 |
@param aPerfRes Performance resource ID.
|
|
327 |
@param aOppState Array containing the operation point enabled status
|
|
328 |
indexed by the operation point enumeration.
|
|
329 |
|
|
330 |
@return One of the system wide Symbian error codes according to the API
|
|
331 |
error handling specification.
|
|
332 |
|
|
333 |
@pre Called from thread context with interrupts enabled.
|
|
334 |
*/
|
|
335 |
IMPORT_C static TInt GetOPPState(TPerfRes aPerfRes,
|
|
336 |
RArray<TBool>& aOppState);
|
|
337 |
|
|
338 |
/**
|
|
339 |
Method to pass context inputs to the vendor software.
|
|
340 |
Argument:
|
|
341 |
@param aArg0 Argument 0
|
|
342 |
@param aArg1 Argument 1
|
|
343 |
@param aArg2 Argument 2
|
|
344 |
@param aArg3 Argument 3
|
|
345 |
|
|
346 |
@return None.
|
|
347 |
|
|
348 |
@pre Called from thread context with interrupts enabled.
|
|
349 |
*/
|
|
350 |
IMPORT_C static void SetInput(TUint32 aArg0, TUint32 aArg1,
|
|
351 |
TUint32 aArg2, TUint32 aArg3);
|
|
352 |
};
|
|
353 |
|
|
354 |
|
|
355 |
#endif // PM_POLICY_CHIPSET_API_H
|