blob: 43eb12c9e8007eac5a3ea18cb9fbc572be8b41a9 [file] [log] [blame]
hailfinger088dc812009-12-14 03:32:24 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2009 Carl-Daniel Hailfinger
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
hailfinger088dc812009-12-14 03:32:24 +000015 * Header file for flash chip drivers. Included from flash.h.
16 * As a general rule, every function listed here should take a pointer to
Souvik Ghoshd75cd672016-06-17 14:21:39 -070017 * struct flashctx as first parameter.
hailfinger088dc812009-12-14 03:32:24 +000018 */
19
20#ifndef __CHIPDRIVERS_H__
21#define __CHIPDRIVERS_H__ 1
22
Souvik Ghoshd75cd672016-06-17 14:21:39 -070023#include "flash.h" /* for chipaddr and flashctx */
Edward O'Callaghan9c4c9a52019-12-04 18:18:01 +110024#include "writeprotect.h" /* for modifier_bits */
stefanct8de303e2011-08-16 12:08:22 +000025
Edward O'Callaghan6bbdd322019-09-09 16:28:01 +100026/* spi25.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -070027int probe_spi_rdid(struct flashctx *flash);
28int probe_spi_rdid4(struct flashctx *flash);
29int probe_spi_rems(struct flashctx *flash);
30int probe_spi_res1(struct flashctx *flash);
31int probe_spi_res2(struct flashctx *flash);
Nikolai Artemiev4702c7c2020-08-31 12:49:50 +100032int probe_spi_res3(struct flashctx *flash);
33int probe_spi_at25f(struct flashctx *flash);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070034int spi_write_enable(struct flashctx *flash);
35int spi_write_disable(struct flashctx *flash);
36int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100037int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Alan Green1fdf13b2019-09-16 12:54:45 +100038int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070039int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100040int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070041int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Alan Green5d709732019-09-16 12:32:25 +100042int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Alan Green1fdf13b2019-09-16 12:54:45 +100043int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolai Artemiev4702c7c2020-08-31 12:49:50 +100044int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070045int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Patrick Georgi860875a2017-02-03 18:44:55 +010046int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
47int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolai Artemiev4702c7c2020-08-31 12:49:50 +100048int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100049int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Patrick Georgiab8353e2017-02-03 18:32:01 +010050int spi_chip_write_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
51int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070052int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, int unsigned len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070053int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
54int spi_read_chunked(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
Patrick Georgiab8353e2017-02-03 18:32:01 +010055int spi_write_chunked(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
56int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
hailfinger088dc812009-12-14 03:32:24 +000057
Edward O'Callaghan71e23142019-03-03 23:08:22 +110058
59/* spi25_statusreg.c */
60uint8_t spi_read_status_register(const struct flashctx *flash);
61int spi_write_status_register(const struct flashctx *flash, int status);
62void spi_prettyprint_status_register_bit(uint8_t status, int bit);
63int spi_prettyprint_status_register_plain(struct flashctx *flash);
64int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
65int spi_prettyprint_status_register_bp1_srwd(struct flashctx *flash);
66int spi_prettyprint_status_register_bp2_srwd(struct flashctx *flash);
67int spi_prettyprint_status_register_bp3_srwd(struct flashctx *flash);
68int spi_prettyprint_status_register_bp4_srwd(struct flashctx *flash);
69int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
70int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
71int spi_disable_blockprotect(struct flashctx *flash);
72int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
73int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
74int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
75int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
Edward O'Callaghan71e23142019-03-03 23:08:22 +110076int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
Edward O'Callaghan71e23142019-03-03 23:08:22 +110077int spi_prettyprint_status_register_at25df(struct flashctx *flash);
78int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
79int spi_prettyprint_status_register_at25f(struct flashctx *flash);
80int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
81int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
82int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
83int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
84int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
85int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
86int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
87int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
88int spi_disable_blockprotect_at25df(struct flashctx *flash);
89int spi_disable_blockprotect_at25df_sec(struct flashctx *flash);
90int spi_disable_blockprotect_at25f(struct flashctx *flash);
91int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
92int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
93int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
94int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
95int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
96int spi_prettyprint_status_register_n25q(struct flashctx *flash);
97int spi_disable_blockprotect_n25q(struct flashctx *flash);
98int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
99int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
100int spi_prettyprint_status_register_sst25(struct flashctx *flash);
101int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
102int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
103int spi_disable_blockprotect_sst26_global_unprotect(struct flashctx *flash);
104
hailfingerfe7cd9e2011-11-04 21:35:26 +0000105/* opaque.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700106int probe_opaque(struct flashctx *flash);
107int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100108int write_opaque(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700109int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
110uint8_t read_status_opaque(const struct flashctx *flash);
111int write_status_opaque(const struct flashctx *flash, int status);
Duncan Laurie25a4ca22019-04-25 12:08:52 -0700112int check_access_opaque(const struct flashctx *flash, unsigned int start, unsigned int len, int read);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000113
Alan Greendad2dae2019-09-16 15:55:08 +1000114/* at45db.c */
115int probe_spi_at45db(struct flashctx *flash);
116int spi_prettyprint_status_register_at45db(struct flashctx *flash);
117int spi_disable_blockprotect_at45db(struct flashctx *flash);
118int spi_read_at45db(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
119int spi_read_at45db_e8(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
120int spi_write_at45db(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
121int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
122int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
123int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
124int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
125int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
126
hailfinger088dc812009-12-14 03:32:24 +0000127/* 82802ab.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700128uint8_t wait_82802ab(struct flashctx *flash);
129int probe_82802ab(struct flashctx *flash);
130int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100131int write_82802ab(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
snelsonc0acbeb2010-03-19 18:47:06 +0000132void print_status_82802ab(uint8_t status);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700133int unlock_28f004s5(struct flashctx *flash);
134int unlock_lh28f008bjt(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000135
David Hendricks07af3a42011-07-11 22:13:02 -0700136/* ichspi.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700137int ich_hwseq_write_256(struct flashctx *flash, uint8_t *buf, int start, int len);
David Hendricks07af3a42011-07-11 22:13:02 -0700138
hailfinger088dc812009-12-14 03:32:24 +0000139/* jedec.c */
140uint8_t oddparity(uint8_t val);
Edward O'Callaghan85164712020-05-12 12:21:54 +1000141void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
142void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700143int probe_jedec(struct flashctx *flash);
Stefan Tauner6e400882014-08-03 14:15:14 +0000144int probe_jedec_29gl(struct flashctx *flash);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100145int write_jedec(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
146int write_jedec_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700147int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
148int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
149int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
hailfinger088dc812009-12-14 03:32:24 +0000150
Alan Greend793f5b2019-09-02 17:03:51 +1000151int unlock_regspace2_uniform_32k(struct flashctx *flash);
152int unlock_regspace2_uniform_64k(struct flashctx *flash);
153int unlock_regspace2_block_eraser_0(struct flashctx *flash);
154int unlock_regspace2_block_eraser_1(struct flashctx *flash);
155int printlock_regspace2_uniform_64k(struct flashctx *flash);
156int printlock_regspace2_block_eraser_0(struct flashctx *flash);
157int printlock_regspace2_block_eraser_1(struct flashctx *flash);
158
hailfinger088dc812009-12-14 03:32:24 +0000159/* m29f400bt.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700160int probe_m29f400bt(struct flashctx *flash);
161int block_erase_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
162int block_erase_chip_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100163int write_m29f400bt(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700164void protect_m29f400bt(struct flashctx *flash, chipaddr bios);
hailfinger088dc812009-12-14 03:32:24 +0000165
hailfinger088dc812009-12-14 03:32:24 +0000166/* sst28sf040.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700167int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
168int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100169int write_28sf040(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700170int unprotect_28sf040(struct flashctx *flash);
171int protect_28sf040(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000172
hailfinger088dc812009-12-14 03:32:24 +0000173/* sst49lfxxxc.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700174int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
175int unlock_49lfxxxc(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000176
177/* sst_fwhub.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700178int printlock_sst_fwhub(struct flashctx *flash);
179int unlock_sst_fwhub(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000180
Vadim Bendebury3a501162014-10-21 20:38:13 -0700181/* s25fl.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700182int probe_spi_big_spansion(struct flashctx *flash);
183int s25fl_block_erase(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Vadim Bendebury3a501162014-10-21 20:38:13 -0700184
David Hendricks148a4bf2015-03-13 21:02:42 -0700185/* s25f.c */
Edward O'Callaghan9c4c9a52019-12-04 18:18:01 +1100186int s25f_get_modifier_bits(const struct flashctx *flash, struct modifier_bits *m);
187int s25f_set_modifier_bits(const struct flashctx *flash, struct modifier_bits *m);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700188int s25fs_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
David Hendricks398714f2014-07-03 17:49:41 -0700189
hailfingerf8993012010-12-05 16:33:59 +0000190/* w39.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700191int printlock_w39l040(struct flashctx * flash);
192int printlock_w39v040a(struct flashctx *flash);
193int printlock_w39v040b(struct flashctx *flash);
194int printlock_w39v040c(struct flashctx *flash);
195int printlock_w39v040fa(struct flashctx *flash);
196int printlock_w39v040fb(struct flashctx *flash);
197int printlock_w39v040fc(struct flashctx *flash);
198int printlock_w39v080a(struct flashctx *flash);
199int printlock_w39v080fa(struct flashctx *flash);
200int printlock_w39v080fa_dual(struct flashctx *flash);
201int unlock_w39v040fb(struct flashctx *flash);
202int unlock_w39v080fa(struct flashctx *flash);
Alan Greenebbee922019-09-02 11:36:59 +1000203int printlock_at49f(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000204
205/* w29ee011.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700206int probe_w29ee011(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000207
hailfinger088dc812009-12-14 03:32:24 +0000208/* stm50flw0x0x.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700209int erase_sector_stm50flw0x0x(struct flashctx *flash, unsigned int block, unsigned int blocksize);
210int unlock_stm50flw0x0x(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000211
Louis Yung-Chieh Loe53fa0f2011-04-11 17:18:41 +0800212/* dummyflasher.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700213int probe_variable_size(struct flashctx *flash);
Louis Yung-Chieh Loe53fa0f2011-04-11 17:18:41 +0800214
Boris Baykov64d00c72016-06-11 18:28:59 +0200215/* spi4ba.c */
216int spi_enter_4ba_b7(struct flashctx *flash);
217int spi_enter_4ba_b7_we(struct flashctx *flash);
Ed Swierk47325ff2017-07-03 13:02:18 -0700218int spi_exit_4ba_e9(struct flashctx *flash);
219int spi_exit_4ba_e9_we(struct flashctx *flash);
Boris Baykov64d00c72016-06-11 18:28:59 +0200220int spi_byte_program_4ba(struct flashctx *flash, unsigned int addr, uint8_t databyte);
221int spi_nbyte_program_4ba(struct flashctx *flash, unsigned int addr, const uint8_t *bytes, unsigned int len);
222int spi_nbyte_read_4ba(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
223int spi_block_erase_20_4ba(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
224int spi_block_erase_52_4ba(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
225int spi_block_erase_d8_4ba(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Boris Baykov1a0e6d42016-06-11 18:29:02 +0200226int spi_byte_program_4ba_ereg(struct flashctx *flash, unsigned int addr, uint8_t databyte);
227int spi_nbyte_program_4ba_ereg(struct flashctx *flash, unsigned int addr, const uint8_t *bytes, unsigned int len);
228int spi_nbyte_read_4ba_ereg(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
229int spi_block_erase_20_4ba_ereg(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
230int spi_block_erase_52_4ba_ereg(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
231int spi_block_erase_d8_4ba_ereg(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Boris Baykov6323c242016-06-11 18:29:03 +0200232int spi_byte_program_4ba_direct(struct flashctx *flash, unsigned int addr, uint8_t databyte);
233int spi_nbyte_program_4ba_direct(struct flashctx *flash, unsigned int addr, const uint8_t *bytes, unsigned int len);
234int spi_nbyte_read_4ba_direct(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
235int spi_block_erase_21_4ba_direct(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
236int spi_block_erase_5c_4ba_direct(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
237int spi_block_erase_dc_4ba_direct(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Boris Baykov64d00c72016-06-11 18:28:59 +0200238
Edward O'Callaghana9c81002019-02-24 15:54:40 +1100239/* edi.c */
240int edi_chip_block_erase(struct flashctx *flash, unsigned int page, unsigned int size);
241int edi_chip_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
242int edi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
243int edi_probe_kb9012(struct flashctx *flash);
244
hailfinger088dc812009-12-14 03:32:24 +0000245#endif /* !__CHIPDRIVERS_H__ */