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
|
/* Copyright 2018 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.
*
* Cros Board Info
*/
#include "common.h"
#include "console.h"
#include "crc8.h"
#include "cros_board_info.h"
#include "gpio.h"
#include "host_command.h"
#include "i2c.h"
#include "util.h"
#define CPRINTS(format, args...) cprints(CC_SYSTEM, "CBI " format, ## args)
#define EEPROM_PAGE_WRITE_SIZE 16
static struct board_info bi;
/* TODO: Init it to -1. On error (I2C or bad contents), retry a read and set it
* to enum ec_error_list if it still fails. The successive calls can be
* immediately returned with the cached error code. This will avoid attempting
* reads doomed to fail. */
static int initialized;
static uint8_t cbi_crc8(const struct board_info *bi)
{
return crc8((uint8_t *)&bi->head.crc + 1, bi->head.total_size - 4);
}
/*
* Get board information from EEPROM
*/
static int read_board_info(void)
{
uint8_t buf[256];
uint8_t offset;
if (initialized)
return EC_SUCCESS;
CPRINTS("Reading board info");
/* Read header */
offset = 0;
if (i2c_xfer(I2C_PORT_EEPROM, I2C_ADDR_EEPROM,
&offset, 1, buf, sizeof(bi.head), I2C_XFER_SINGLE)) {
CPRINTS("Failed to read header");
return EC_ERROR_INVAL;
}
memcpy(&bi.head, buf, sizeof(bi.head));
/* Check magic */
if (memcmp(bi.head.magic, cbi_magic, sizeof(bi.head.magic))) {
CPRINTS("Bad magic");
return EC_ERROR_INVAL;
}
/* check version */
if (bi.head.major_version > CBI_VERSION_MAJOR) {
CPRINTS("Version mismatch");
return EC_ERROR_INVAL;
}
/* Check the data size. It's expected to support up to 64k but our
* buffer has practical limitation. */
if (bi.head.total_size < sizeof(bi) ||
bi.head.total_size > sizeof(buf)) {
CPRINTS("Bad size: %d", bi.head.total_size);
return EC_ERROR_OVERFLOW;
}
/* Read the rest */
offset = sizeof(bi.head);
if (i2c_xfer(I2C_PORT_EEPROM, I2C_ADDR_EEPROM, &offset, 1,
buf + sizeof(bi.head),
bi.head.total_size - sizeof(bi.head),
I2C_XFER_SINGLE)) {
CPRINTS("Failed to read body");
return EC_ERROR_INVAL;
}
/* Check CRC. This supports new fields unknown to this parser. */
if (cbi_crc8((struct board_info *)&buf) != bi.head.crc) {
CPRINTS("Bad CRC");
return EC_ERROR_INVAL;
}
/* Save only the data we understand. */
memcpy(&bi.head + 1, &buf[sizeof(bi.head)],
sizeof(bi) - sizeof(bi.head));
/* If we're handling previous version, clear all new fields */
initialized = 1;
return EC_SUCCESS;
}
static int eeprom_is_write_protected(void)
{
return !gpio_get_level(GPIO_WP_L);
}
static int write_board_info(void)
{
uint8_t buf[sizeof(bi) + 1];
/* The code is only tested for ST M24C02, whose page size for a single
* write is 16 byte. To support different EEPROMs, you may need to
* craft the i2c packets accordingly. */
_Static_assert(sizeof(bi) <= EEPROM_PAGE_WRITE_SIZE,
"struct board_info exceeds page write size");
int rv;
if (eeprom_is_write_protected()) {
CPRINTS("Failed to write for WP");
return EC_ERROR_ACCESS_DENIED;
}
buf[0] = 0; /* Offset 0 */
memcpy(&buf[1], &bi, sizeof(bi));
rv = i2c_xfer(I2C_PORT_EEPROM, I2C_ADDR_EEPROM, buf,
sizeof(bi) + 1, NULL, 0, I2C_XFER_SINGLE);
if (rv) {
CPRINTS("Failed to write for %d", rv);
return rv;
}
return EC_SUCCESS;
}
int cbi_get_board_version(uint32_t *version)
{
if (read_board_info())
return EC_ERROR_UNKNOWN;
*version = bi.version;
return EC_SUCCESS;
}
int cbi_get_sku_id(uint32_t *sku_id)
{
if (read_board_info())
return EC_ERROR_UNKNOWN;
*sku_id = bi.sku_id;
return EC_SUCCESS;
}
int cbi_get_oem_id(uint32_t *oem_id)
{
if (read_board_info())
return EC_ERROR_UNKNOWN;
*oem_id = bi.oem_id;
return EC_SUCCESS;
}
int board_get_version(void)
{
uint32_t version;
if (cbi_get_board_version(&version))
return -1;
return version;
}
static int hc_cbi_get(struct host_cmd_handler_args *args)
{
const struct __ec_align4 ec_params_get_cbi *p = args->params;
if (read_board_info())
return EC_RES_ERROR;
switch (p->type) {
case CBI_DATA_BOARD_VERSION:
*(uint32_t *)args->response = bi.version;
break;
case CBI_DATA_OEM_ID:
*(uint32_t *)args->response = bi.oem_id;
break;
case CBI_DATA_SKU_ID:
*(uint32_t *)args->response = bi.sku_id;
break;
default:
return EC_RES_INVALID_PARAM;
}
args->response_size = sizeof(uint32_t);
return EC_RES_SUCCESS;
}
DECLARE_HOST_COMMAND(EC_CMD_GET_CROS_BOARD_INFO,
hc_cbi_get,
EC_VER_MASK(0));
static int hc_cbi_set(struct host_cmd_handler_args *args)
{
const struct __ec_align4 ec_params_set_cbi *p = args->params;
if (p->flag & CBI_SET_INIT) {
memset(&bi, 0, sizeof(bi));
memcpy(&bi.head.magic, cbi_magic, sizeof(cbi_magic));
initialized = 1;
} else {
if (read_board_info())
return EC_RES_ERROR;
}
switch (p->type) {
case CBI_DATA_BOARD_VERSION:
if (p->data > UINT16_MAX)
return EC_RES_INVALID_PARAM;
bi.version = p->data;
break;
case CBI_DATA_OEM_ID:
if (p->data > UINT8_MAX)
return EC_RES_INVALID_PARAM;
bi.oem_id = p->data;
break;
case CBI_DATA_SKU_ID:
if (p->data > UINT8_MAX)
return EC_RES_INVALID_PARAM;
bi.sku_id = p->data;
break;
default:
return EC_RES_INVALID_PARAM;
}
/* Whether we're modifying existing data or creating new one,
* we take over the format. */
bi.head.major_version = CBI_VERSION_MAJOR;
bi.head.minor_version = CBI_VERSION_MINOR;
bi.head.total_size = sizeof(bi);
bi.head.crc = cbi_crc8(&bi);
/* Skip write if client asks so. */
if (p->flag & CBI_SET_NO_SYNC)
return EC_RES_SUCCESS;
if (write_board_info())
return EC_RES_ERROR;
return EC_RES_SUCCESS;
}
DECLARE_HOST_COMMAND(EC_CMD_SET_CROS_BOARD_INFO,
hc_cbi_set,
EC_VER_MASK(0));
|
