1
0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-27 23:22:37 +02:00
flashrom/writeprotect.h
Nikolai Artemiev cff87a8488 libflashrom,writeprotect: add functions for reading/writing WP configs
New functions are exposed through the libflashrom API for
reading/writing chip's WP settins: `flashrom_wp_{read,write}_cfg()`.

They read/write an opaque `struct flashrom_wp_cfg` instance, which
includes the flash protection range and status register protection mode.

This commit also adds `{read,write}_wp_bits()` helper functions that
read/write chip-specific WP configuration bits.

BUG=b:195381327,b:153800563
BRANCH=none
TEST=flashrom --wp-{enable,disable,range,list,status} at end of patch series

Change-Id: I3ad25708c3321b8fb0216c3eaf6ffc07616537ad
Signed-off-by: Nikolai Artemiev <nartemiev@google.com>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/58479
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
Reviewed-by: Edward O'Callaghan <quasisec@chromium.org>
Reviewed-by: Nico Huber <nico.h@gmx.de>
2022-03-01 04:10:12 +00:00

81 lines
2.0 KiB
C

/*
* This file is part of the flashrom project.
*
* Copyright (C) 2010 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; either version 2 of the License, or
* (at your option) any later version.
*
* 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.
*
*/
#ifndef __WRITEPROTECT_H__
#define __WRITEPROTECT_H__ 1
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "libflashrom.h"
#define MAX_BP_BITS 4
/* Chip protection range: start address and length. */
struct wp_range {
size_t start, len;
};
/* Generic description of a chip's write protection configuration. */
struct flashrom_wp_cfg {
enum flashrom_wp_mode mode;
struct wp_range range;
};
/*
* Description of a chip's write protection configuration.
*
* It allows most WP code to store and manipulate a chip's configuration
* without knowing the exact layout of bits in the chip's status registers.
*/
struct wp_bits {
/* Status register protection bit (SRP) */
bool srp_bit_present;
uint8_t srp;
/* Status register lock bit (SRL) */
bool srl_bit_present;
uint8_t srl;
/* Complement bit (CMP) */
bool cmp_bit_present;
uint8_t cmp;
/* Sector/block protection bit (SEC) */
bool sec_bit_present;
uint8_t sec;
/* Top/bottom protection bit (TB) */
bool tb_bit_present;
uint8_t tb;
/* Block protection bits (BP) */
size_t bp_bit_count;
uint8_t bp[MAX_BP_BITS];
};
struct flashrom_flashctx;
/* Write WP configuration to the chip */
enum flashrom_wp_result wp_write_cfg(struct flashrom_flashctx *, const struct flashrom_wp_cfg *);
/* Read WP configuration from the chip */
enum flashrom_wp_result wp_read_cfg(struct flashrom_wp_cfg *, struct flashrom_flashctx *);
#endif /* !__WRITEPROTECT_H__ */