mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-27 07:02:34 +02:00
9fc100f549
Allow chips to specify functions that map status register bits to protection ranges. These are used to enumerate available ranges and determine the protection state of chips. The patch also adds a range decoding function for the example chips. Many other chips can also be handled by it, though some will require different functions (e.g. MX25L6406 and related chips). Another approach that has been tried in cros flashrom is maintaining tables of range data, but it quickly becomes error prone and hard to validate. Using a function to interpret the ranges allows compact encoding with most chips and is flexible enough to allow chips with less predictable ranges to be handled as well. BUG=b:195381327,b:153800563 BRANCH=none TEST=dumped range tables, checked against datasheets Change-Id: Id163ed80938a946a502ed116e48e8236e36eb203 Signed-off-by: Nikolai Artemiev <nartemiev@google.com> Reviewed-on: https://review.coreboot.org/c/flashrom/+/58480 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Nico Huber <nico.h@gmx.de> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
223 lines
12 KiB
C
223 lines
12 KiB
C
/*
|
|
* This file is part of the flashrom project.
|
|
*
|
|
* Copyright (C) 2009 Carl-Daniel Hailfinger
|
|
*
|
|
* 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.
|
|
*
|
|
* Header file for flash chip drivers. Included from flash.h.
|
|
* As a general rule, every function listed here should take a pointer to
|
|
* struct flashctx as first parameter.
|
|
*/
|
|
|
|
#ifndef __CHIPDRIVERS_H__
|
|
#define __CHIPDRIVERS_H__ 1
|
|
|
|
#include "flash.h" /* for chipaddr and flashctx */
|
|
|
|
/* spi.c */
|
|
int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, int unsigned len);
|
|
|
|
/* spi25.c */
|
|
int probe_spi_rdid(struct flashctx *flash);
|
|
int probe_spi_rdid4(struct flashctx *flash);
|
|
int probe_spi_rems(struct flashctx *flash);
|
|
int probe_spi_res1(struct flashctx *flash);
|
|
int probe_spi_res2(struct flashctx *flash);
|
|
int probe_spi_res3(struct flashctx *flash);
|
|
int probe_spi_at25f(struct flashctx *flash);
|
|
int spi_write_enable(struct flashctx *flash);
|
|
int spi_write_disable(struct flashctx *flash);
|
|
int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
|
|
int spi_chip_write_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
|
|
int spi_read_chunked(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
|
|
int spi_write_chunked(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
|
|
int spi_enter_4ba(struct flashctx *flash);
|
|
int spi_exit_4ba(struct flashctx *flash);
|
|
int spi_set_extended_address(struct flashctx *, uint8_t addr_high);
|
|
|
|
|
|
/* spi25_statusreg.c */
|
|
/* FIXME: replace spi_read_status_register() calls with spi_read_register() */
|
|
uint8_t spi_read_status_register(const struct flashctx *flash);
|
|
int spi_read_register(const struct flashctx *flash, enum flash_reg reg, uint8_t *value);
|
|
int spi_write_register(const struct flashctx *flash, enum flash_reg reg, uint8_t value);
|
|
void spi_prettyprint_status_register_bit(uint8_t status, int bit);
|
|
int spi_prettyprint_status_register_plain(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_bp1_srwd(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_bp2_srwd(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_bp3_srwd(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_bp4_srwd(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
|
|
int spi_disable_blockprotect(struct flashctx *flash);
|
|
int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
|
|
int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
|
|
int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
|
|
int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25df(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25f(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at25f(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_n25q(struct flashctx *flash);
|
|
int spi_disable_blockprotect_n25q(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
|
|
int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_sst25(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
|
|
int spi_disable_blockprotect_sst26_global_unprotect(struct flashctx *flash);
|
|
|
|
/* sfdp.c */
|
|
int probe_spi_sfdp(struct flashctx *flash);
|
|
|
|
/* opaque.c */
|
|
int probe_opaque(struct flashctx *flash);
|
|
int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
|
|
int write_opaque(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
|
|
|
|
/* at45db.c */
|
|
int probe_spi_at45db(struct flashctx *flash);
|
|
int spi_prettyprint_status_register_at45db(struct flashctx *flash);
|
|
int spi_disable_blockprotect_at45db(struct flashctx *flash);
|
|
int spi_read_at45db(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
|
|
int spi_read_at45db_e8(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
|
|
int spi_write_at45db(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
|
|
/* 82802ab.c */
|
|
uint8_t wait_82802ab(struct flashctx *flash);
|
|
int probe_82802ab(struct flashctx *flash);
|
|
int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
|
|
int write_82802ab(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
void print_status_82802ab(uint8_t status);
|
|
int unlock_28f004s5(struct flashctx *flash);
|
|
int unlock_lh28f008bjt(struct flashctx *flash);
|
|
|
|
/* jedec.c */
|
|
uint8_t oddparity(uint8_t val);
|
|
void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
|
|
void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
|
|
int probe_jedec(struct flashctx *flash);
|
|
int probe_jedec_29gl(struct flashctx *flash);
|
|
int write_jedec(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int write_jedec_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
|
|
int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
|
|
int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
|
|
|
|
int unlock_regspace2_uniform_32k(struct flashctx *flash);
|
|
int unlock_regspace2_uniform_64k(struct flashctx *flash);
|
|
int unlock_regspace2_block_eraser_0(struct flashctx *flash);
|
|
int unlock_regspace2_block_eraser_1(struct flashctx *flash);
|
|
int printlock_regspace2_uniform_64k(struct flashctx *flash);
|
|
int printlock_regspace2_block_eraser_0(struct flashctx *flash);
|
|
int printlock_regspace2_block_eraser_1(struct flashctx *flash);
|
|
|
|
/* sst28sf040.c */
|
|
int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
|
|
int write_28sf040(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int unprotect_28sf040(struct flashctx *flash);
|
|
int protect_28sf040(struct flashctx *flash);
|
|
|
|
/* sst49lfxxxc.c */
|
|
int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
|
|
|
|
/* sst_fwhub.c */
|
|
int printlock_sst_fwhub(struct flashctx *flash);
|
|
int unlock_sst_fwhub(struct flashctx *flash);
|
|
|
|
/* s25f.c */
|
|
int probe_spi_big_spansion(struct flashctx *flash);
|
|
int s25fl_block_erase(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
int s25fs_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
|
|
/* w39.c */
|
|
int printlock_w39f010(struct flashctx * flash);
|
|
int printlock_w39l010(struct flashctx * flash);
|
|
int printlock_w39l020(struct flashctx * flash);
|
|
int printlock_w39l040(struct flashctx * flash);
|
|
int printlock_w39v040a(struct flashctx *flash);
|
|
int printlock_w39v040b(struct flashctx *flash);
|
|
int printlock_w39v040c(struct flashctx *flash);
|
|
int printlock_w39v040fa(struct flashctx *flash);
|
|
int printlock_w39v040fb(struct flashctx *flash);
|
|
int printlock_w39v040fc(struct flashctx *flash);
|
|
int printlock_w39v080a(struct flashctx *flash);
|
|
int printlock_w39v080fa(struct flashctx *flash);
|
|
int printlock_w39v080fa_dual(struct flashctx *flash);
|
|
int printlock_at49f(struct flashctx *flash);
|
|
|
|
/* w29ee011.c */
|
|
int probe_w29ee011(struct flashctx *flash);
|
|
|
|
/* stm50.c */
|
|
int erase_sector_stm50(struct flashctx *flash, unsigned int block, unsigned int blocksize);
|
|
|
|
/* en29lv640b.c */
|
|
int probe_en29lv640b(struct flashctx *flash);
|
|
int write_en29lv640b(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
|
|
/* dummyflasher.c */
|
|
int probe_variable_size(struct flashctx *flash);
|
|
|
|
/* edi.c */
|
|
int edi_chip_block_erase(struct flashctx *flash, unsigned int page, unsigned int size);
|
|
int edi_chip_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
|
|
int edi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
|
|
int edi_probe_kb9012(struct flashctx *flash);
|
|
|
|
/* spi95.c */
|
|
int probe_spi_st95(struct flashctx *flash);
|
|
int spi_block_erase_emulation(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
|
|
|
|
/* writeprotect_ranges.c */
|
|
void decode_range_spi25(size_t *start, size_t *len, const struct wp_bits *, size_t chip_len);
|
|
|
|
#endif /* !__CHIPDRIVERS_H__ */
|