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
|
/* Copyright 2017 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.
*
* Case Closed Debugging configuration
*/
#ifndef __CROS_EC_CCD_CONFIG_H
#define __CROS_EC_CCD_CONFIG_H
/* Case-closed debugging state */
enum ccd_state {
CCD_STATE_LOCKED = 0,
CCD_STATE_UNLOCKED,
CCD_STATE_OPENED,
/* Number of CCD states */
CCD_STATE_COUNT
};
/* Flags */
enum ccd_flag {
/* Flags that can only be set internally; fill from bottom up */
/*
* Test lab mode is enabled. This MUST be in the first byte so that
* it's in a constant position across all versions of CCD config.
*
* Note: This is used internally by CCD config. Do NOT test this
* to control other things; use capabilities for those.
*/
CCD_FLAG_TEST_LAB = (1 << 0),
/*
* What state were we in when the password was set?
* (0=opened, 1=unlocked)
*/
CCD_FLAG_PASSWORD_SET_WHEN_UNLOCKED = (1 << 1),
/* (flags in the middle are unused) */
/* Flags that can be set via ccd_set_flags(); fill from top down */
/* Override write protect at boot */
CCD_FLAG_OVERRIDE_WP_AT_BOOT = (1 << 22),
/*
* If overriding WP at boot, set it to what value
* (0=disabled, 1=enabled)
*/
CCD_FLAG_OVERRIDE_WP_STATE_ENABLED = (1 << 23),
};
/* Capabilities */
enum ccd_capability {
/* UARTs to/from AP and EC */
CCD_CAP_GSC_RX_AP_TX = 0,
CCD_CAP_GSC_TX_AP_RX = 1,
CCD_CAP_GSC_RX_EC_TX = 2,
CCD_CAP_GSC_TX_EC_RX = 3,
/* Access to AP SPI flash */
CCD_CAP_AP_FLASH = 4,
/* Access to EC flash (SPI or internal) */
CCD_CAP_EC_FLASH = 5,
/* Override WP temporarily or at boot */
CCD_CAP_OVERRIDE_WP = 6,
/* Reboot EC or AP */
CCD_CAP_REBOOT_EC_AP = 7,
/* GSC restricted console commands */
CCD_CAP_GSC_RESTRICTED_CONSOLE = 8,
/* Allow ccd-unlock or ccd-open without AP reboot */
CCD_CAP_UNLOCK_WITHOUT_AP_REBOOT = 9,
/* Allow ccd-unlock or ccd-open without short physical presence */
CCD_CAP_UNLOCK_WITHOUT_SHORT_PP = 10,
/* Allow ccd-open without wiping TPM data */
CCD_CAP_OPEN_WITHOUT_TPM_WIPE = 11,
/* Allow ccd-open without long physical presence */
CCD_CAP_OPEN_WITHOUT_LONG_PP = 12,
/* Allow removing the battery to bypass physical presence requirement */
CCD_CAP_REMOVE_BATTERY_BYPASSES_PP = 13,
/* Allow GSC firmware update without wiping TPM data */
CCD_CAP_GSC_FW_UPDATE_WITHOUT_TPM_WIPE = 14,
/* Access to I2C via USB */
CCD_CAP_I2C = 15,
/* Read-only access to hash or dump EC or AP flash */
CCD_CAP_FLASH_READ = 16,
/* Number of currently defined capabilities */
CCD_CAP_COUNT
};
/*
* Subcommand code, used to pass different CCD commands using the same TPM
* vendor command.
*/
enum ccd_vendor_subcommands {
CCDV_PASSWORD = 0,
CCDV_OPEN = 1,
CCDV_UNLOCK = 2,
CCDV_LOCK = 3,
CCDV_PP_POLL_UNLOCK = 4,
CCDV_PP_POLL_OPEN = 5,
};
enum ccd_pp_state {
CCD_PP_CLOSED = 0,
CCD_PP_AWAITING_PRESS = 1,
CCD_PP_BETWEEN_PRESSES = 2,
CCD_PP_DONE = 3
};
/**
* Initialize CCD configuration at boot.
*
* This must be called before any command which gets/sets the configuration.
*
* @param state Initial case-closed debugging state. This should be
* CCD_STATE_LOCKED unless this is a debug build, or if
* a previous value is being restored after a low-power
* resume.
*/
void ccd_config_init(enum ccd_state state);
/**
* Get a single CCD flag.
*
* @param flag Flag to get
* @return 1 if flag is set, 0 if flag is clear
*/
int ccd_get_flag(enum ccd_flag flag);
/**
* Set a single CCD flag.
*
* @param flag Flag to set
* @param value New value for flag (0=clear, non-zero=set)
* @return EC_SUCCESS or non-zero error code.
*/
int ccd_set_flag(enum ccd_flag flag, int value);
/**
* Check if a CCD capability is enabled in the current CCD mode.
*
* @param cap Capability to check
* @return 1 if capability is enabled, 0 if disabled
*/
int ccd_is_cap_enabled(enum ccd_capability cap);
/**
* Get the current CCD state.
*
* This is intended for use by the board if it needs to back up the CCD state
* across low-power states and then restore it when calling ccd_config_init().
* Do NOT use this to gate debug capabilities; use ccd_is_cap_enabled() or
* ccd_get_flag() instead.
*
* @return The current CCD state.
*/
enum ccd_state ccd_get_state(void);
/**
* Force CCD disabled.
*
* This should be called if security checks fail and for some reason the board
* can't immediately reboot. It locks CCD and disables all CCD capabilities
* until reboot.
*/
void ccd_disable(void);
/* Flags for ccd_reset_config() */
enum ccd_reset_config_flags {
/* Also reset test lab flag */
CCD_RESET_TEST_LAB = (1 << 0),
/* Only reset Always/UnlessLocked settings */
CCD_RESET_UNLOCKED_ONLY = (1 << 1),
/* Use RMA/factory defaults */
CCD_RESET_RMA = (1 << 2)
};
/**
* Reset CCD config to the desired state.
*
* @param flags Reset flags (see enum ccd_reset_config_flags)
* @return EC_SUCCESS, or non-zero if error.
*/
int ccd_reset_config(unsigned int flags);
/**
* Inform CCD about TPM reset so that the password management state machine
* can be restarted.
*/
void ccd_tpm_reset_callback(void);
#endif /* __CROS_EC_CCD_CONFIG_H */
|
