summaryrefslogtreecommitdiff
path: root/common/rollback.c
blob: c720b6b97bbfbacf7e1bfa1ddd39c65ec0587a33 (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
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
/* 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.
 */

/* Rollback protection logic. */

#include "common.h"
#include "console.h"
#include "flash.h"
#include "rollback.h"
#include "system.h"
#include "util.h"

/* Console output macros */
#define CPRINTS(format, args...) cprints(CC_SYSTEM, format, ## args)

/* Number of rollback regions */
#define ROLLBACK_REGIONS 2

/*
 * Note: Do not change this structure without also updating
 * common/firmware_image.S .image.ROLLBACK section.
 */
struct rollback_data {
	int32_t rollback_min_version;
	uint32_t cookie;
};

/* We need at least 2 erasable blocks in the rollback region. */
BUILD_ASSERT(CONFIG_ROLLBACK_SIZE >= ROLLBACK_REGIONS*CONFIG_FLASH_ERASE_SIZE);
BUILD_ASSERT(sizeof(struct rollback_data) <= CONFIG_FLASH_ERASE_SIZE);

static uintptr_t get_rollback_offset(int region)
{
	return CONFIG_ROLLBACK_OFF + region * CONFIG_FLASH_ERASE_SIZE;
}

static int read_rollback(int region, struct rollback_data *data)
{
	uintptr_t offset;

	offset = get_rollback_offset(region);

	if (flash_read(offset, sizeof(*data), (char *)data))
		return EC_ERROR_UNKNOWN;

	return EC_SUCCESS;
}

/*
 * Get the most recent rollback information.
 *
 * @rollback_min_version: Minimum version to accept for rollback protection,
 *                        or 0 if no rollback information is present.
 *
 * Return most recent region index on success (>= 0, or 0 if no rollback
 * region is valid), negative value on error.
 */
static int get_latest_rollback(int32_t *rollback_min_version)
{
	int region;
	int min_region = 0;

	*rollback_min_version = 0;

	for (region = 0; region < ROLLBACK_REGIONS; region++) {
		struct rollback_data data;

		if (read_rollback(region, &data))
			return -1;

		/* Check if not initialized or invalid cookie. */
		if (data.cookie != CROS_EC_ROLLBACK_COOKIE)
			continue;

		if (data.rollback_min_version > *rollback_min_version) {
			min_region = region;
			*rollback_min_version = data.rollback_min_version;
		}
	}

	return min_region;
}

int32_t rollback_get_minimum_version(void)
{
	int32_t rollback_min_version;

	if (get_latest_rollback(&rollback_min_version) < 0)
		return -1;

	return rollback_min_version;
}

int rollback_lock(void)
{
	int ret;

	/* Already locked */
	if (flash_get_protect() & EC_FLASH_PROTECT_ROLLBACK_NOW)
		return EC_SUCCESS;

	CPRINTS("Protecting rollback");

	/* This may do nothing if WP is not enabled, or RO is not protected. */
	ret = flash_set_protect(EC_FLASH_PROTECT_ROLLBACK_AT_BOOT, -1);

	if (!(flash_get_protect() & EC_FLASH_PROTECT_ROLLBACK_NOW) &&
	      flash_get_protect() & EC_FLASH_PROTECT_ROLLBACK_AT_BOOT) {
		/*
		 * If flash protection is still not enabled (some chips may
		 * be able to enable it immediately), reboot.
		 */
		cflush();
		system_reset(SYSTEM_RESET_HARD | SYSTEM_RESET_PRESERVE_FLAGS);
	}

	return ret;
}

int rollback_update(int32_t next_min_version)
{
	struct rollback_data data;
	uintptr_t offset;
	int region;
	int32_t current_min_version;

	if (flash_get_protect() & EC_FLASH_PROTECT_ROLLBACK_NOW)
		return EC_ERROR_ACCESS_DENIED;

	region = get_latest_rollback(&current_min_version);

	if (region < 0)
		return EC_ERROR_UNKNOWN;

	/* Do not accept to decrement the value. */
	if (next_min_version < current_min_version)
		return EC_ERROR_INVAL;

	/* No need to update if version is already correct. */
	if (next_min_version == current_min_version)
		return EC_SUCCESS;

	/* Use the other region. */
	region = (region + 1) % ROLLBACK_REGIONS;

	offset = get_rollback_offset(region);

	data.rollback_min_version = next_min_version;
	data.cookie = CROS_EC_ROLLBACK_COOKIE;

	/* Offset should never be part of active image. */
	if (system_unsafe_to_overwrite(offset, CONFIG_FLASH_ERASE_SIZE))
		return EC_ERROR_UNKNOWN;

	if (flash_erase(offset, CONFIG_FLASH_ERASE_SIZE))
		return EC_ERROR_UNKNOWN;

	if (flash_write(offset, sizeof(data), (char *)&data))
		return EC_ERROR_UNKNOWN;

	return EC_SUCCESS;
}

static int command_rollback_info(int argc, char **argv)
{
	int region, ret, min_region;
	int32_t rollback_min_version;

	min_region = get_latest_rollback(&rollback_min_version);

	if (min_region < 0)
		return EC_ERROR_UNKNOWN;

	ccprintf("rollback minimum version: %d\n", rollback_min_version);

	for (region = 0; region < ROLLBACK_REGIONS; region++) {
		struct rollback_data data;

		ret = read_rollback(region, &data);
		if (ret)
			return ret;

		ccprintf("rollback %d: %08x %08x%s\n",
			region, data.rollback_min_version, data.cookie,
			min_region == region ? " *" : "");
	}

	return EC_SUCCESS;
}
DECLARE_SAFE_CONSOLE_COMMAND(rollbackinfo, command_rollback_info,
			     NULL,
			     "Print rollback info");

static int command_rollback_update(int argc, char **argv)
{
	int32_t min_version;
	char *e;

	if (argc < 2)
		return EC_ERROR_PARAM_COUNT;

	min_version = strtoi(argv[1], &e, 0);

	if (*e || min_version < 0)
		return EC_ERROR_PARAM1;

	return rollback_update(min_version);
}
DECLARE_CONSOLE_COMMAND(rollbackupdate, command_rollback_update,
			"min_version",
			"Update rollback info");