blob: 43dd6cfbd5902d0481e350e2d8846ddc5873570f [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 */
David Hendricks148a4bf2015-03-13 21:02:42 -070024#include "writeprotect.h" /* for generic_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);
32int spi_write_enable(struct flashctx *flash);
33int spi_write_disable(struct flashctx *flash);
34int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100035int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070036int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100037int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070038int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Alan Green5d709732019-09-16 12:32:25 +100039int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070040int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Patrick Georgi860875a2017-02-03 18:44:55 +010041int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
42int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100043int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Patrick Georgiab8353e2017-02-03 18:32:01 +010044int spi_chip_write_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
45int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070046int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, int unsigned len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070047int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
48int 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 +010049int spi_write_chunked(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
50int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
hailfinger088dc812009-12-14 03:32:24 +000051
Edward O'Callaghan71e23142019-03-03 23:08:22 +110052
53/* spi25_statusreg.c */
54uint8_t spi_read_status_register(const struct flashctx *flash);
55int spi_write_status_register(const struct flashctx *flash, int status);
56void spi_prettyprint_status_register_bit(uint8_t status, int bit);
57int spi_prettyprint_status_register_plain(struct flashctx *flash);
58int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
59int spi_prettyprint_status_register_bp1_srwd(struct flashctx *flash);
60int spi_prettyprint_status_register_bp2_srwd(struct flashctx *flash);
61int spi_prettyprint_status_register_bp3_srwd(struct flashctx *flash);
62int spi_prettyprint_status_register_bp4_srwd(struct flashctx *flash);
63int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
64int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
65int spi_disable_blockprotect(struct flashctx *flash);
66int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
67int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
68int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
69int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
Edward O'Callaghan71e23142019-03-03 23:08:22 +110070int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
Edward O'Callaghan71e23142019-03-03 23:08:22 +110071int spi_prettyprint_status_register_at25df(struct flashctx *flash);
72int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
73int spi_prettyprint_status_register_at25f(struct flashctx *flash);
74int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
75int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
76int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
77int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
78int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
79int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
80int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
81int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
82int spi_disable_blockprotect_at25df(struct flashctx *flash);
83int spi_disable_blockprotect_at25df_sec(struct flashctx *flash);
84int spi_disable_blockprotect_at25f(struct flashctx *flash);
85int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
86int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
87int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
88int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
89int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
90int spi_prettyprint_status_register_n25q(struct flashctx *flash);
91int spi_disable_blockprotect_n25q(struct flashctx *flash);
92int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
93int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
94int spi_prettyprint_status_register_sst25(struct flashctx *flash);
95int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
96int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
97int spi_disable_blockprotect_sst26_global_unprotect(struct flashctx *flash);
98
hailfingerfe7cd9e2011-11-04 21:35:26 +000099/* opaque.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700100int probe_opaque(struct flashctx *flash);
101int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100102int write_opaque(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700103int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
104uint8_t read_status_opaque(const struct flashctx *flash);
105int write_status_opaque(const struct flashctx *flash, int status);
Duncan Laurie25a4ca22019-04-25 12:08:52 -0700106int check_access_opaque(const struct flashctx *flash, unsigned int start, unsigned int len, int read);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000107
hailfinger088dc812009-12-14 03:32:24 +0000108/* 82802ab.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700109uint8_t wait_82802ab(struct flashctx *flash);
110int probe_82802ab(struct flashctx *flash);
111int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100112int write_82802ab(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
snelsonc0acbeb2010-03-19 18:47:06 +0000113void print_status_82802ab(uint8_t status);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700114int unlock_28f004s5(struct flashctx *flash);
115int unlock_lh28f008bjt(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000116
David Hendricks07af3a42011-07-11 22:13:02 -0700117/* ichspi.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700118int ich_hwseq_probe(struct flashctx *flash);
119int ich_hwseq_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
120int ich_hwseq_block_erase(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
121int ich_hwseq_write_256(struct flashctx *flash, uint8_t *buf, int start, int len);
David Hendricks07af3a42011-07-11 22:13:02 -0700122
hailfinger088dc812009-12-14 03:32:24 +0000123/* jedec.c */
124uint8_t oddparity(uint8_t val);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700125void toggle_ready_jedec(struct flashctx *flash, chipaddr dst);
126void data_polling_jedec(struct flashctx *flash, chipaddr dst, uint8_t data);
127int write_byte_program_jedec(struct flashctx *flash, chipaddr bios, uint8_t *src,
hailfinger088dc812009-12-14 03:32:24 +0000128 chipaddr dst);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700129int probe_jedec(struct flashctx *flash);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100130int write_jedec(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
131int write_jedec_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700132int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
133int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
134int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
hailfinger088dc812009-12-14 03:32:24 +0000135
Alan Greend793f5b2019-09-02 17:03:51 +1000136int unlock_regspace2_uniform_32k(struct flashctx *flash);
137int unlock_regspace2_uniform_64k(struct flashctx *flash);
138int unlock_regspace2_block_eraser_0(struct flashctx *flash);
139int unlock_regspace2_block_eraser_1(struct flashctx *flash);
140int printlock_regspace2_uniform_64k(struct flashctx *flash);
141int printlock_regspace2_block_eraser_0(struct flashctx *flash);
142int printlock_regspace2_block_eraser_1(struct flashctx *flash);
143
hailfinger088dc812009-12-14 03:32:24 +0000144/* m29f400bt.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700145int probe_m29f400bt(struct flashctx *flash);
146int block_erase_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
147int block_erase_chip_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100148int write_m29f400bt(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700149void protect_m29f400bt(struct flashctx *flash, chipaddr bios);
hailfinger088dc812009-12-14 03:32:24 +0000150
hailfinger088dc812009-12-14 03:32:24 +0000151/* sst28sf040.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700152int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
153int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100154int write_28sf040(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700155int unprotect_28sf040(struct flashctx *flash);
156int protect_28sf040(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000157
hailfinger088dc812009-12-14 03:32:24 +0000158/* sst49lfxxxc.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700159int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
160int unlock_49lfxxxc(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000161
162/* sst_fwhub.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700163int printlock_sst_fwhub(struct flashctx *flash);
164int unlock_sst_fwhub(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000165
Vadim Bendebury3a501162014-10-21 20:38:13 -0700166/* s25fl.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700167int probe_spi_big_spansion(struct flashctx *flash);
168int s25fl_block_erase(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Vadim Bendebury3a501162014-10-21 20:38:13 -0700169
David Hendricks148a4bf2015-03-13 21:02:42 -0700170/* s25f.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700171int s25f_get_modifier_bits(const struct flashctx *flash, struct generic_modifier_bits *m);
172int s25f_set_modifier_bits(const struct flashctx *flash, struct generic_modifier_bits *m);
173int s25fs_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
David Hendricks398714f2014-07-03 17:49:41 -0700174
hailfingerf8993012010-12-05 16:33:59 +0000175/* w39.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700176int printlock_w39l040(struct flashctx * flash);
177int printlock_w39v040a(struct flashctx *flash);
178int printlock_w39v040b(struct flashctx *flash);
179int printlock_w39v040c(struct flashctx *flash);
180int printlock_w39v040fa(struct flashctx *flash);
181int printlock_w39v040fb(struct flashctx *flash);
182int printlock_w39v040fc(struct flashctx *flash);
183int printlock_w39v080a(struct flashctx *flash);
184int printlock_w39v080fa(struct flashctx *flash);
185int printlock_w39v080fa_dual(struct flashctx *flash);
186int unlock_w39v040fb(struct flashctx *flash);
187int unlock_w39v080fa(struct flashctx *flash);
Alan Greenebbee922019-09-02 11:36:59 +1000188int printlock_at49f(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000189
190/* w29ee011.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700191int probe_w29ee011(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000192
hailfinger088dc812009-12-14 03:32:24 +0000193/* stm50flw0x0x.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700194int erase_sector_stm50flw0x0x(struct flashctx *flash, unsigned int block, unsigned int blocksize);
195int unlock_stm50flw0x0x(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000196
Louis Yung-Chieh Loe53fa0f2011-04-11 17:18:41 +0800197/* dummyflasher.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700198int probe_variable_size(struct flashctx *flash);
Louis Yung-Chieh Loe53fa0f2011-04-11 17:18:41 +0800199
Boris Baykov64d00c72016-06-11 18:28:59 +0200200/* spi4ba.c */
201int spi_enter_4ba_b7(struct flashctx *flash);
202int spi_enter_4ba_b7_we(struct flashctx *flash);
Ed Swierk47325ff2017-07-03 13:02:18 -0700203int spi_exit_4ba_e9(struct flashctx *flash);
204int spi_exit_4ba_e9_we(struct flashctx *flash);
Boris Baykov64d00c72016-06-11 18:28:59 +0200205int spi_byte_program_4ba(struct flashctx *flash, unsigned int addr, uint8_t databyte);
206int spi_nbyte_program_4ba(struct flashctx *flash, unsigned int addr, const uint8_t *bytes, unsigned int len);
207int spi_nbyte_read_4ba(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
208int spi_block_erase_20_4ba(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
209int spi_block_erase_52_4ba(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
210int spi_block_erase_d8_4ba(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Boris Baykov1a0e6d42016-06-11 18:29:02 +0200211int spi_byte_program_4ba_ereg(struct flashctx *flash, unsigned int addr, uint8_t databyte);
212int spi_nbyte_program_4ba_ereg(struct flashctx *flash, unsigned int addr, const uint8_t *bytes, unsigned int len);
213int spi_nbyte_read_4ba_ereg(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
214int spi_block_erase_20_4ba_ereg(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
215int spi_block_erase_52_4ba_ereg(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
216int spi_block_erase_d8_4ba_ereg(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Boris Baykov6323c242016-06-11 18:29:03 +0200217int spi_byte_program_4ba_direct(struct flashctx *flash, unsigned int addr, uint8_t databyte);
218int spi_nbyte_program_4ba_direct(struct flashctx *flash, unsigned int addr, const uint8_t *bytes, unsigned int len);
219int spi_nbyte_read_4ba_direct(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
220int spi_block_erase_21_4ba_direct(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
221int spi_block_erase_5c_4ba_direct(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
222int spi_block_erase_dc_4ba_direct(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Boris Baykov64d00c72016-06-11 18:28:59 +0200223
Edward O'Callaghana9c81002019-02-24 15:54:40 +1100224/* edi.c */
225int edi_chip_block_erase(struct flashctx *flash, unsigned int page, unsigned int size);
226int edi_chip_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
227int edi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
228int edi_probe_kb9012(struct flashctx *flash);
229
hailfinger088dc812009-12-14 03:32:24 +0000230#endif /* !__CHIPDRIVERS_H__ */