coreboot-kgpe-d16/util/cbfstool/fmd_parser.y
Hung-Te Lin 9497fcb742 cbfstool: Change FMD annotation to flags
The idea of "annotation" for firmware sections was pretty flexible, but
in future we will want multiple attributes applied to same area. For
example, indicate the section must be preserved when updating firmware
so serial number or MAC address can be preserved.

The solution here is to extend annotation so it can take multiple
identifiers (flags) in a row. For example, to declare a 64KB COREBOOT
section as CBFS using annotation:

 COREBOOT(CBFS)@0x0 64k

If there's a new flag "PRESERVE" indicating the section must be
preserved before update, we can declare it following CBFS flag:

 COREBOOT(CBFS PRESERVE)@0x0 64k

The flags are directly parsed in fmd_parser, and stored in an union
flashmap_flags. Output modules can choose to ignore or process the
flags.

Currently the only supported flag is "CBFS" (for backward compatible
with annotation). There will be more new flags in follow up patches.

BUG=chromium:936768
TEST=make; boots on x86 "google/eve" and arm "google/kukui" devices

Change-Id: Ie2d99f570e6faff6ed3a4344d6af7526a4515fae
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/31706
Reviewed-by: Julius Werner <jwerner@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2019-03-05 19:31:43 +00:00

190 lines
4.8 KiB
Text

/*
* fmd_parser.y, parser generator for flashmap descriptor language
*
* Copyright (C) 2015 Google, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
%{
#include "fmd_scanner.h"
#include "common.h"
#include <stdlib.h>
struct flashmap_descriptor *res = NULL;
%}
%union {
unsigned intval;
char *strval;
struct unsigned_option maybe_intval;
struct flashmap_descriptor *region_ptr;
union flashmap_flags flags;
struct descriptor_list region_listhdr;
}
%code requires {
#include "fmd.h"
#include "option.h"
#include <stdbool.h>
struct descriptor_node {
struct flashmap_descriptor *val;
struct descriptor_node *next;
};
struct descriptor_list {
size_t len;
struct descriptor_node *head;
struct descriptor_node *tail;
};
extern struct flashmap_descriptor *res;
struct flashmap_descriptor *parse_descriptor(
char *name, union flashmap_flags flags, struct unsigned_option offset,
struct unsigned_option size, struct descriptor_list children);
void yyerror(const char *s);
}
%token <intval> INTEGER
%token OCTAL
%token <strval> STRING
%token FLAG_CBFS
%type <region_ptr> flash_region
%type <strval> region_name
%type <flags> region_flags_opt
%type <flags> region_flags
%type <flags> region_flag
%type <maybe_intval> region_offset_opt
%type <maybe_intval> region_offset
%type <maybe_intval> region_size_opt
%type <maybe_intval> region_size
%type <region_listhdr> region_list_opt
%type <region_listhdr> region_list
%type <region_listhdr> region_list_entries
%%
flash_chip: region_name region_offset_opt region_size region_list
{
union flashmap_flags flags = { .v=0 };
if (!(res = parse_descriptor($1, flags, $2, $3, $4)))
YYABORT;
};
flash_region: region_name region_flags_opt region_offset_opt region_size_opt
region_list_opt
{
struct flashmap_descriptor *node = parse_descriptor($1, $2, $3, $4, $5);
if (!node)
YYABORT;
if (node->flags.f.cbfs && !fmd_process_flag_cbfs(node)) {
ERROR("Section '%s' cannot have flag 'CBFS''\n", node->name);
YYABORT;
}
$$ = node;
};
region_name: STRING
{
if (!$1) {
perror("E: While allocating section name");
YYABORT;
}
};
region_flags_opt: { $$ = (union flashmap_flags){ .v=0 }; }
| '(' region_flags ')' { $$ = $2; };
region_flags: region_flag | region_flag region_flags { $$.v = $1.v | $2.v; };
region_flag: FLAG_CBFS { $$.v = 0; $$.f.cbfs = 1; };
region_offset_opt: { $$ = (struct unsigned_option){false, 0}; }
| region_offset;
region_offset: '@' INTEGER { $$ = (struct unsigned_option){true, $2}; };
region_size_opt: { $$ = (struct unsigned_option){false, 0}; }
| region_size;
region_size: INTEGER { $$ = (struct unsigned_option){true, $1}; };
region_list_opt:
{
$$ = (struct descriptor_list)
{.len = 0, .head = NULL, .tail = NULL};
}
| region_list;
region_list: '{' region_list_entries '}' { $$ = $2; };
region_list_entries: flash_region
{
struct descriptor_node *node = malloc(sizeof(*node));
if (!node) {
perror("E: While allocating linked list node");
YYABORT;
}
node->val = $1;
node->next = NULL;
$$ = (struct descriptor_list){.len = 1, .head = node, .tail = node};
}
| region_list_entries flash_region
{
struct descriptor_node *node = malloc(sizeof(*node));
if (!node) {
perror("E: While allocating linked list node");
YYABORT;
}
node->val = $2;
node->next = NULL;
$1.tail->next = node;
$$ = (struct descriptor_list)
{.len = $1.len + 1, .head = $1.head, .tail = node};
};
%%
struct flashmap_descriptor *parse_descriptor(
char *name, union flashmap_flags flags, struct unsigned_option offset,
struct unsigned_option size, struct descriptor_list children)
{
struct flashmap_descriptor *region = malloc(sizeof(*region));
if (!region) {
perror("E: While allocating descriptor section");
return NULL;
}
region->name = name;
region->flags = flags;
region->offset_known = offset.val_known;
region->offset = offset.val;
region->size_known = size.val_known;
region->size = size.val;
region->list_len = children.len;
if (region->list_len) {
region->list = malloc(region->list_len * sizeof(*region->list));
if (!region->list) {
perror("E: While allocating node children array");
return NULL;
}
struct descriptor_node *cur_node = children.head;
for (unsigned idx = 0; idx < region->list_len; ++idx) {
region->list[idx] = cur_node->val;
struct descriptor_node *next_node = cur_node->next;
free(cur_node);
cur_node = next_node;
}
} else {
region->list = NULL;
}
return region;
}
void yyerror(const char *s)
{
fprintf(stderr, "%s\n", s);
}