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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
///////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_PowerService
/// \brief This file supports the power service state machine.
///
///////////////////////////////////////////////////////////////////////////////
#ifndef POWER_SERVICE_SERVER_INCLUDE_SS_POWER_STATE_MACHINE_H_
#define POWER_SERVICE_SERVER_INCLUDE_SS_POWER_STATE_MACHINE_H_
#include <system_service/ss_power_service.h>
#include "ss_power_state_hysteresis.h"
class PowerSessionHandler;
class PowerStateMachine {
class Base_State {
public:
virtual void onWakeup(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
}
virtual void onStartComplete(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
virtual void onLaunchComplete(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
// LCOV_EXCL_START 200: virtual function
virtual void onShutdown(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
virtual void onStopComplete(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
virtual void onShutdownComplete(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
// LCOV_EXCL_START 200: virtual function
virtual void onNormalVoltageEncountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
// LCOV_EXCL_START 200: virtual function
virtual void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
// LCOV_EXCL_START 200: virtual function
virtual void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
// LCOV_EXCL_START 200: virtual function
virtual void onSoftwareUpdate(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
// LCOV_EXCL_START 200: virtual function
virtual void onHysteresisAborted(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
// LCOV_EXCL_START 200: virtual function
virtual void onHysteresisTimeout(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
virtual PCSTR name() = 0;
/// State Entry and Exit methods
// LCOV_EXCL_START 200: virtual function
virtual void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
// LCOV_EXCL_START 200: virtual function
virtual void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 200: virtual function
};
friend class Base_State;
class Wakeup : public Base_State {
public:
void onWakeup(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onShutdown(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onNormalVoltageEncountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onSoftwareUpdate(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
virtual PCSTR name();
// LCOV_EXCL_START 8: fist status, no entry
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
AGL_ASSERT_NOT_TESTED(); // LCOV_EXCL_LINE 200: test assert
}
// LCOV_EXCL_STOP 8: fist status, no entry
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
}
};
friend class Wakeup;
class WakeupActive : public Wakeup {
public:
void onShutdown(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
}
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
}
};
friend class WakeupActive;
class WakeupPending : public Wakeup {
public:
void onWakeup(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onStartComplete(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLaunchComplete(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onNormalVoltageEncountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
}
};
friend class WakeupPending;
class Shutdown : public Base_State {
public:
void onWakeup(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onShutdown(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession) { // NOLINT (runtime/references)
}
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onHysteresisAborted(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onHysteresisTimeout(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class Shutdown;
class ShutdownActive : public Base_State {
public:
void onShutdown(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class ShutdownActive;
class LowVoltage1 : public Base_State {
public:
void onWakeup(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onNormalVoltageEncountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onHysteresisAborted(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onHysteresisTimeout(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class LowVoltage1;
class LowVoltage1Active : public Base_State {
public:
void onNormalVoltageEncountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class LowVoltage1Active;
class LowVoltage2 : public Base_State {
public:
void onWakeup(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onNormalVoltageEncountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onHysteresisAborted(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onHysteresisTimeout(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class LowVoltage2;
class LowVoltage2Active : public Base_State {
public:
void onNormalVoltageEncountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class LowVoltage2Active;
class NormalVoltage : public Base_State {
public:
void onShutdown(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onSoftwareUpdate(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class NormalVoltage;
class SoftwareUpdate : public Base_State {
public:
void onShutdown(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage1Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onLowVoltage2Encountered(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
PCSTR name();
void onEntry(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void onExit(PowerStateMachine &u, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
friend class SoftwareUpdate;
public:
typedef enum _Power_State_Machine_Events {
epsmeWAKEUP = epswsPWRON,
epsmeSHUTDOWN = epscnCANSLEEP,
epsmeLVI1_ENCOUNTERED = epsvsLVI1,
epsmeLVI2_ENCOUNTERED = epsvsLVI2,
epsmeNORMAL_VOLTAGE_ENCOUNTERED = epsvsNORMAL,
epsmeSTART_COMPLETE = 0xD1,
epsmeSTOP_COMPLETE = 0xD2,
epsmeSOFTWARE_UPDATE = 0xE1,
epsmeSHUTDOWN_HYSTERESIS_ABORTED = 0xF1,
epsmeLVI1_HYSTERESIS_ABORTED = 0xF2,
epsmeLVI2_HYSTERESIS_ABORTED = 0xF3,
epsmeSHUTDOWN_HYSTERESIS_TM_OUT = 0xFA,
epsmeLVI1_HYSTERESIS_TM_OUT = 0xFB,
epsmeLVI2_HYSTERESIS_TM_OUT = 0xFC,
} ePowerStateMachineEvents;
PowerStateMachine();
virtual ~PowerStateMachine();
void onEvent(HANDLE h_app, PowerSessionHandler & oSession, // NOLINT (runtime/references)
ePowerStateMachineEvents evt);
EFrameworkunifiedStatus initialize(HANDLE h_app, PowerConfigParams & refConfigParms); // NOLINT (runtime/references)
PCSTR name();
private:
static Wakeup WakeupState;
static WakeupActive WakeupActiveState;
static WakeupPending WakeupPendingState;
static LowVoltage1 LowVoltage1State;
static LowVoltage1Active LowVoltage1ActiveState;
static LowVoltage2 LowVoltage2State;
static LowVoltage2Active LowVoltage2ActiveState;
static Shutdown ShutdownState;
static ShutdownActive ShutdownActiveState;
static NormalVoltage NormalVoltageState;
static SoftwareUpdate SoftwareUpdateState;
Base_State *m_pCurrentState;
Base_State *m_pPreviousState;
Base_State *m_pOnHysteresisTimeoutState;
PowerStateHysteresis m_oShutdownHysteresis;
PowerStateHysteresis m_oLowVoltage1Hysteresis;
PowerStateHysteresis m_oLowVoltage2Hysteresis;
RequiredModuleList m_lstWakeupModules;
RequiredModuleList m_lstShutdownModules;
RequiredModuleList m_lstLvi2Modules;
HANDLE m_hHysteresisTimer;
typedef struct _state_info {
EPWR_POWER_STATE_TYPE wake;
EPWR_VOLTAGE_STATE_TYPE voltage;
EPWR_WAKEUP_LEVEL_TYPE level;
EPWR_WAKEUP_FACTOR_TYPE factor;
EPWR_CRANK_STATE_TYPE crank;
} Pwr_StateInfo;
Pwr_StateInfo m_tStateInfo;
PowerStateMachine(PowerStateMachine&);
PowerStateMachine & operator=(PowerStateMachine &);
/// Helper methods
void NextState(Base_State & refState, HANDLE h_app, // NOLINT (runtime/references)
PowerSessionHandler & oSession); // NOLINT (runtime/references)
void GotoStateOnHysteresisTimeout(Base_State & refState); // NOLINT (runtime/references)
void startHysteresisTimer(PowerStateHysteresis & hys_info); // NOLINT (runtime/references)
void reStartHysteresisTimer(PowerStateHysteresis & hys_info); // NOLINT (runtime/references)
void stopHysteresisTimer(PowerStateHysteresis & hys_info); // NOLINT (runtime/references)
void publishPowerLVIStatus(HANDLE h_app, PCSTR nNotifNm, UI_32 value);
void publishPowerLevelType(HANDLE h_app, UI_32 value);
void OnVoltage(Base_State * pState, HANDLE h_app,
PowerSessionHandler & oSession); // NOLINT (runtime/references)
};
#endif // POWER_SERVICE_SERVER_INCLUDE_SS_POWER_STATE_MACHINE_H_
|
