summaryrefslogtreecommitdiff
path: root/common/fmap.c
blob: 438a45d1c1a200de01c2bbdab050c5c26dbc1f88 (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
/*
 * 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.
 */

#include <stdint.h>
#include "config.h"

/* FMAP structs. See http://code.google.com/p/flashmap/wiki/FmapSpec */
#define FMAP_NAMELEN 32
#define FMAP_SIGNATURE "__FMAP__"
#define FMAP_SIGNATURE_SIZE 8
#define FMAP_VER_MAJOR 1
#define FMAP_VER_MINOR 0
#define FMAP_SEARCH_STRIDE 64		/* Spec revision 1.01 */

typedef struct _FmapHeader {
	char        fmap_signature[FMAP_SIGNATURE_SIZE];
	uint8_t     fmap_ver_major;
	uint8_t     fmap_ver_minor;
	uint64_t    fmap_base;
	uint32_t    fmap_size;
	char        fmap_name[FMAP_NAMELEN];
	uint16_t    fmap_nareas;
} __attribute__((packed)) FmapHeader;

#define FMAP_AREA_STATIC      (1 << 0)	/* can be checksummed */
#define FMAP_AREA_COMPRESSED  (1 << 1)  /* may be compressed */
#define FMAP_AREA_RO          (1 << 2)  /* writes may fail */

typedef struct _FmapAreaHeader {
	uint32_t area_offset;
	uint32_t area_size;
	char     area_name[FMAP_NAMELEN];
	uint16_t area_flags;
} __attribute__((packed)) FmapAreaHeader;


#define NUM_EC_FMAP_AREAS 14
const struct _ec_fmap {
	FmapHeader header;
	FmapAreaHeader area[NUM_EC_FMAP_AREAS];
} ec_fmap __attribute__((section(".google"))) = {
	/* Header */
	{
		.fmap_signature = {'_', '_', 'F', 'M', 'A', 'P', '_', '_'},
		.fmap_ver_major = FMAP_VER_MAJOR,
		.fmap_ver_minor = FMAP_VER_MINOR,
		.fmap_base = CONFIG_FLASH_BASE,
		/* NOTE: EC implementation reserves one bank for itself */
		.fmap_size = CONFIG_FLASH_SIZE - CONFIG_FLASH_BANK_SIZE,
		.fmap_name = "EC_FMAP",
		.fmap_nareas = NUM_EC_FMAP_AREAS,
	},

	{
	/* RO Firmware */
		{
			.area_name = "RO_SECTION",
			.area_offset = CONFIG_FW_RO_OFF,
			.area_size = CONFIG_FW_IMAGE_SIZE,
			.area_flags = FMAP_AREA_STATIC | FMAP_AREA_RO,
		},
		{
			.area_name = "BOOT_STUB",
			.area_offset = CONFIG_FW_RO_OFF,
			.area_size = CONFIG_FW_RO_SIZE,
			.area_flags = FMAP_AREA_STATIC | FMAP_AREA_RO,
		},
		{
			.area_name = "RO_FRID",	/* FIXME: Where is it? */
			.area_offset = CONFIG_FW_RO_OFF,
			.area_size = 0,
			.area_flags = FMAP_AREA_STATIC | FMAP_AREA_RO,
		},

		/* Other RO stuff: FMAP, GBB, etc. */
		{
			.area_name = "ROOT_KEY",
			.area_offset = CONFIG_VBOOT_ROOTKEY_OFF,
			.area_size = CONFIG_VBOOT_ROOTKEY_SIZE,
			.area_flags = FMAP_AREA_STATIC | FMAP_AREA_RO,
		},
		{
			/* FIXME(wfrichar): GBB != FMAP. Use the right terms */
			.area_name = "FMAP",
			.area_offset = (uint32_t)&ec_fmap,
			.area_size = sizeof(ec_fmap),
			.area_flags = FMAP_AREA_STATIC | FMAP_AREA_RO,
		},
		{
			/* A dummy region to identify it as EC firmware */
			.area_name = "EC_IMAGE",
			.area_offset = CONFIG_FW_RO_OFF,
			.area_size = 0, /* Always zero */
			.area_flags = FMAP_AREA_STATIC | FMAP_AREA_RO,
		},

		/* Firmware A */
		{
			.area_name = "RW_SECTION_A",
			.area_offset = CONFIG_FW_A_OFF,
			.area_size = CONFIG_FW_IMAGE_SIZE,
			.area_flags = FMAP_AREA_STATIC,
		},
		{
			.area_name = "FW_MAIN_A",
			.area_offset = CONFIG_FW_A_OFF,
			.area_size = CONFIG_FW_A_SIZE,
			.area_flags = FMAP_AREA_STATIC,
		},
		{
			.area_name = "RW_FWID_A", /* FIXME: Where is it? */
			.area_offset = CONFIG_FW_A_OFF,
			.area_size = 0,
			.area_flags = FMAP_AREA_STATIC,
		},
		{
			.area_name = "VBLOCK_A",
			.area_offset = CONFIG_VBLOCK_A_OFF,
			.area_size = CONFIG_VBLOCK_A_SIZE,
			.area_flags = FMAP_AREA_STATIC,
		},

		/* Firmware B */
		{
			.area_name = "RW_SECTION_B",
			.area_offset = CONFIG_FW_B_OFF,
			.area_size = CONFIG_FW_IMAGE_SIZE,
			.area_flags = FMAP_AREA_STATIC,
		},
		{
			.area_name = "FW_MAIN_B",
			.area_offset = CONFIG_FW_B_OFF,
			.area_size = CONFIG_FW_B_SIZE,
			.area_flags = FMAP_AREA_STATIC,
		},
		{
			.area_name = "RW_FWID_B", /* FIXME: Where is it? */
			.area_offset = CONFIG_FW_B_OFF,
			.area_size = 0,
			.area_flags = FMAP_AREA_STATIC,
		},
		{
			.area_name = "VBLOCK_B",
			.area_offset = CONFIG_VBLOCK_B_OFF,
			.area_size = CONFIG_VBLOCK_B_SIZE,
			.area_flags = FMAP_AREA_STATIC,
		},
	}
};