blob: 229bfb7e60384adba7bee7a687424dd5350c244a (
plain)
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
|
/* Copyright 2022 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* @file
* @brief Declare functions that are supplied externally.
* The functions are all prepended with board_ap_power_ to indicate
* they have external implementations.
*
* TODO(b/223923728): Longer term, a framework should be put in place to
* allow extensibility for selected functions.
*
* The external functions may need to access
* devicetree properties for values such
* as timeouts etc.
*/
#ifndef __AP_PWRSEQ_AP_POWER_BOARD_FUNCTIONS_H__
#define __AP_PWRSEQ_AP_POWER_BOARD_FUNCTIONS_H__
#include <zephyr/devicetree.h>
/**
* @brief Force AP shutdown
*
* Immediately shut down the AP.
*/
void board_ap_power_force_shutdown(void);
/**
* @brief Called to transition from G3 to S5
*
* Action to start transition from G3 to S5.
* Usually involves enabling the main power rails.
*/
void board_ap_power_action_g3_s5(void);
/**
* @brief Called to transition from S3 to S0
*
* Action to start transition from S3 to S0.
*/
void board_ap_power_action_s3_s0(void);
/* @brief Called to transition from S0 to S3
*
* Action to start transition from S0 to S3.
*/
void board_ap_power_action_s0_s3(void);
/* @brief Called on S0 state
*
* Action to handle S0 state.
*/
void board_ap_power_action_s0(void);
/**
* @brief Assert PCH power OK signal to AP
*
* @return 0 Success
* @return -1 Timeout or error
*/
int board_ap_power_assert_pch_power_ok(void);
/**
* @brief Check board power rails enabled or not
*
* @return true Enabled
* @return false Not enabled
*/
bool board_ap_power_check_power_rails_enabled(void);
/**
* @brief macro to access configuration properties from DTS
*/
#define AP_PWRSEQ_DT_VALUE(p) \
DT_PROP(DT_COMPAT_GET_ANY_STATUS_OKAY(intel_ap_pwrseq), p) \
#endif /* __AP_PWRSEQ_AP_POWER_BOARD_FUNCTIONS_H__ */
|
