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
|
/* Copyright (c) 2012 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.
*/
/*
* Chipset module for Chrome EC.
*
* This is intended to be a platform/chipset-neutral interface, implemented by
* all main chipsets (x86, gaia, etc.).
*/
#ifndef __CROS_EC_CHIPSET_H
#define __CROS_EC_CHIPSET_H
#include "common.h"
#include "gpio.h"
/*
* Chipset state mask
*
* Note that this is a non-exhaustive list of states which the main chipset can
* be in, and is potentially one-to-many for real, underlying chipset states.
* That's why chipset_in_state() asks "Is the chipset in something
* approximating this state?" and not "Tell me what state the chipset is in and
* I'll compare it myself with the state(s) I want."
*/
enum chipset_state_mask {
CHIPSET_STATE_HARD_OFF = 0x01, /* Hard off (G3) */
CHIPSET_STATE_SOFT_OFF = 0x02, /* Soft off (S5) */
CHIPSET_STATE_SUSPEND = 0x04, /* Suspend (S3) */
CHIPSET_STATE_ON = 0x08, /* On (S0) */
CHIPSET_STATE_STANDBY = 0x10, /* Standby (S0ix) */
/* Common combinations */
CHIPSET_STATE_ANY_OFF = (CHIPSET_STATE_HARD_OFF |
CHIPSET_STATE_SOFT_OFF), /* Any off state */
/* This combination covers any kind of suspend i.e. S3 or S0ix. */
CHIPSET_STATE_ANY_SUSPEND = (CHIPSET_STATE_SUSPEND |
CHIPSET_STATE_STANDBY),
};
#ifdef HAS_TASK_CHIPSET
/**
* Check if chipset is in a given state.
*
* @param state_mask Combination of one or more CHIPSET_STATE_* flags.
*
* @return non-zero if the chipset is in one of the states specified in the
* mask.
*/
int chipset_in_state(int state_mask);
/**
* Ask the chipset to exit the hard off state.
*
* Does nothing if the chipset has already left the state, or was not in the
* state to begin with.
*/
void chipset_exit_hard_off(void);
/* This is a private chipset-specific implementation for use only by
* throttle_ap() . Don't call this directly!
*/
void chipset_throttle_cpu(int throttle);
/**
* Immediately shut off power to main processor and chipset.
*
* This is intended for use when the system is too hot or battery power is
* critical.
*/
void chipset_force_shutdown(void);
/**
* Reset the CPU and/or chipset.
*/
void chipset_reset(void);
/**
* Interrupt handler to power GPIO inputs.
*/
void power_interrupt(enum gpio_signal signal);
/**
* Handle assert of eSPI_Reset# pin.
*/
void chipset_handle_espi_reset_assert(void);
/**
* Perform chipset pre-initialization work within the context of chipset task.
*/
void chipset_pre_init_callback(void);
#else /* !HAS_TASK_CHIPSET */
/* When no chipset is present, assume it is always off. */
static inline int chipset_in_state(int state_mask)
{
return state_mask & CHIPSET_STATE_ANY_OFF;
}
static inline void chipset_exit_hard_off(void) { }
static inline void chipset_throttle_cpu(int throttle) { }
static inline void chipset_force_shutdown(void) { }
static inline void chipset_reset(void) { }
static inline void power_interrupt(enum gpio_signal signal) { }
static inline void chipset_handle_espi_reset_assert(void) { }
static inline void chipset_handle_reboot(void) { }
#endif /* !HAS_TASK_CHIPSET */
/**
* Optional chipset check if PLTRST# is valid.
*
* @return non-zero if PLTRST# is valid, 0 if invalid.
*/
int chipset_pltrst_is_valid(void) __attribute__((weak));
/**
* Execute chipset-specific reboot.
*/
void chipset_handle_reboot(void);
/**
* GPIO interrupt handler of reset request from AP.
*
* It is used in SDM845 chipset power sequence.
*/
void chipset_reset_request_interrupt(enum gpio_signal signal);
/**
* Chipset-specific power signal interrupt, overrides the default one.
*
* It is used in SDM845, to handle the short-low-pulse during the reset
* sequence which we don't consider it as a power-lost.
*/
void chipset_power_signal_interrupt(enum gpio_signal signal);
#endif /* __CROS_EC_CHIPSET_H */
|