blob: c8d4c966f0ab6a5bb5f0a20a2723a8b9ffc89682 [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'Callaghan99974452020-10-13 13:28:33 +110026/* spi.c */
27int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
28int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
29int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, int unsigned len);
30
Edward O'Callaghan6bbdd322019-09-09 16:28:01 +100031/* spi25.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -070032int probe_spi_rdid(struct flashctx *flash);
33int probe_spi_rdid4(struct flashctx *flash);
34int probe_spi_rems(struct flashctx *flash);
35int probe_spi_res1(struct flashctx *flash);
36int probe_spi_res2(struct flashctx *flash);
Nikolai Artemiev4702c7c2020-08-31 12:49:50 +100037int probe_spi_res3(struct flashctx *flash);
38int probe_spi_at25f(struct flashctx *flash);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070039int spi_write_enable(struct flashctx *flash);
40int spi_write_disable(struct flashctx *flash);
41int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100042int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Alan Green1fdf13b2019-09-16 12:54:45 +100043int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070044int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100045int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070046int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Alan Green5d709732019-09-16 12:32:25 +100047int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Alan Green1fdf13b2019-09-16 12:54:45 +100048int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolai Artemiev4702c7c2020-08-31 12:49:50 +100049int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070050int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Patrick Georgi860875a2017-02-03 18:44:55 +010051int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
52int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolai Artemiev4702c7c2020-08-31 12:49:50 +100053int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan94934e82019-06-19 17:44:19 +100054int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolai Artemieva66b6cd2020-08-31 18:07:13 +100055erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Patrick Georgiab8353e2017-02-03 18:32:01 +010056int spi_chip_write_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -070057int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
58int 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 +010059int spi_write_chunked(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
Edward O'Callaghan99974452020-10-13 13:28:33 +110060int spi_enter_4ba(struct flashctx *flash);
61int spi_exit_4ba(struct flashctx *flash);
62int spi_set_extended_address(struct flashctx *, uint8_t addr_high);
hailfinger088dc812009-12-14 03:32:24 +000063
Edward O'Callaghan71e23142019-03-03 23:08:22 +110064
65/* spi25_statusreg.c */
66uint8_t spi_read_status_register(const struct flashctx *flash);
67int spi_write_status_register(const struct flashctx *flash, int status);
68void spi_prettyprint_status_register_bit(uint8_t status, int bit);
69int spi_prettyprint_status_register_plain(struct flashctx *flash);
70int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
71int spi_prettyprint_status_register_bp1_srwd(struct flashctx *flash);
72int spi_prettyprint_status_register_bp2_srwd(struct flashctx *flash);
73int spi_prettyprint_status_register_bp3_srwd(struct flashctx *flash);
74int spi_prettyprint_status_register_bp4_srwd(struct flashctx *flash);
75int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
76int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
77int spi_disable_blockprotect(struct flashctx *flash);
78int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
79int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
80int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
81int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
Edward O'Callaghan71e23142019-03-03 23:08:22 +110082int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
Edward O'Callaghan71e23142019-03-03 23:08:22 +110083int spi_prettyprint_status_register_at25df(struct flashctx *flash);
84int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
85int spi_prettyprint_status_register_at25f(struct flashctx *flash);
86int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
87int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
88int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
89int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
90int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
91int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
92int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
93int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
Edward O'Callaghan71e23142019-03-03 23:08:22 +110094int spi_disable_blockprotect_at25f(struct flashctx *flash);
95int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
96int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
97int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
98int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
99int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
100int spi_prettyprint_status_register_n25q(struct flashctx *flash);
101int spi_disable_blockprotect_n25q(struct flashctx *flash);
102int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
103int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
104int spi_prettyprint_status_register_sst25(struct flashctx *flash);
105int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
106int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
107int spi_disable_blockprotect_sst26_global_unprotect(struct flashctx *flash);
108
Nikolai Artemieva66b6cd2020-08-31 18:07:13 +1000109/* sfdp.c */
110int probe_spi_sfdp(struct flashctx *flash);
111
hailfingerfe7cd9e2011-11-04 21:35:26 +0000112/* opaque.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700113int probe_opaque(struct flashctx *flash);
114int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100115int write_opaque(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700116int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
117uint8_t read_status_opaque(const struct flashctx *flash);
118int write_status_opaque(const struct flashctx *flash, int status);
Duncan Laurie25a4ca22019-04-25 12:08:52 -0700119int check_access_opaque(const struct flashctx *flash, unsigned int start, unsigned int len, int read);
hailfingerfe7cd9e2011-11-04 21:35:26 +0000120
Alan Greendad2dae2019-09-16 15:55:08 +1000121/* at45db.c */
122int probe_spi_at45db(struct flashctx *flash);
123int spi_prettyprint_status_register_at45db(struct flashctx *flash);
124int spi_disable_blockprotect_at45db(struct flashctx *flash);
125int spi_read_at45db(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
126int spi_read_at45db_e8(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
127int spi_write_at45db(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
128int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
129int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
130int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
131int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
132int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
133
hailfinger088dc812009-12-14 03:32:24 +0000134/* 82802ab.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700135uint8_t wait_82802ab(struct flashctx *flash);
136int probe_82802ab(struct flashctx *flash);
137int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100138int write_82802ab(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
snelsonc0acbeb2010-03-19 18:47:06 +0000139void print_status_82802ab(uint8_t status);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700140int unlock_28f004s5(struct flashctx *flash);
141int unlock_lh28f008bjt(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000142
hailfinger088dc812009-12-14 03:32:24 +0000143/* jedec.c */
144uint8_t oddparity(uint8_t val);
Edward O'Callaghan85164712020-05-12 12:21:54 +1000145void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
146void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700147int probe_jedec(struct flashctx *flash);
Stefan Tauner6e400882014-08-03 14:15:14 +0000148int probe_jedec_29gl(struct flashctx *flash);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100149int write_jedec(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
150int write_jedec_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700151int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
152int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
153int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
hailfinger088dc812009-12-14 03:32:24 +0000154
Alan Greend793f5b2019-09-02 17:03:51 +1000155int unlock_regspace2_uniform_32k(struct flashctx *flash);
156int unlock_regspace2_uniform_64k(struct flashctx *flash);
157int unlock_regspace2_block_eraser_0(struct flashctx *flash);
158int unlock_regspace2_block_eraser_1(struct flashctx *flash);
159int printlock_regspace2_uniform_64k(struct flashctx *flash);
160int printlock_regspace2_block_eraser_0(struct flashctx *flash);
161int printlock_regspace2_block_eraser_1(struct flashctx *flash);
162
hailfinger088dc812009-12-14 03:32:24 +0000163/* sst28sf040.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700164int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
165int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Patrick Georgiab8353e2017-02-03 18:32:01 +0100166int write_28sf040(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700167int unprotect_28sf040(struct flashctx *flash);
168int protect_28sf040(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000169
hailfinger088dc812009-12-14 03:32:24 +0000170/* sst49lfxxxc.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700171int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
hailfinger088dc812009-12-14 03:32:24 +0000172
173/* sst_fwhub.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700174int printlock_sst_fwhub(struct flashctx *flash);
175int unlock_sst_fwhub(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000176
Edward O'Callaghan1c5d53b2021-01-05 10:16:40 +1100177/* s25f.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700178int probe_spi_big_spansion(struct flashctx *flash);
179int s25fl_block_erase(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Edward O'Callaghan9c4c9a52019-12-04 18:18:01 +1100180int s25f_get_modifier_bits(const struct flashctx *flash, struct modifier_bits *m);
181int s25f_set_modifier_bits(const struct flashctx *flash, struct modifier_bits *m);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700182int s25fs_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
David Hendricks398714f2014-07-03 17:49:41 -0700183
hailfingerf8993012010-12-05 16:33:59 +0000184/* w39.c */
Nikolai Artemievfc53a612020-08-31 18:02:25 +1000185int printlock_w39f010(struct flashctx * flash);
186int printlock_w39l010(struct flashctx * flash);
187int printlock_w39l020(struct flashctx * flash);
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700188int printlock_w39l040(struct flashctx * flash);
189int printlock_w39v040a(struct flashctx *flash);
190int printlock_w39v040b(struct flashctx *flash);
191int printlock_w39v040c(struct flashctx *flash);
192int printlock_w39v040fa(struct flashctx *flash);
193int printlock_w39v040fb(struct flashctx *flash);
194int printlock_w39v040fc(struct flashctx *flash);
195int printlock_w39v080a(struct flashctx *flash);
196int printlock_w39v080fa(struct flashctx *flash);
197int printlock_w39v080fa_dual(struct flashctx *flash);
Alan Greenebbee922019-09-02 11:36:59 +1000198int printlock_at49f(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000199
200/* w29ee011.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700201int probe_w29ee011(struct flashctx *flash);
hailfinger088dc812009-12-14 03:32:24 +0000202
Edward O'Callaghan86987442021-01-06 19:22:12 +1100203/* stm50.c */
204int erase_sector_stm50(struct flashctx *flash, unsigned int block, unsigned int blocksize);
hailfinger088dc812009-12-14 03:32:24 +0000205
Nikolai Artemiev9ff517b2020-08-31 13:05:03 +1000206/* en29lv640b.c */
207int probe_en29lv640b(struct flashctx *flash);
208int write_en29lv640b(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
209
Louis Yung-Chieh Loe53fa0f2011-04-11 17:18:41 +0800210/* dummyflasher.c */
Souvik Ghoshd75cd672016-06-17 14:21:39 -0700211int probe_variable_size(struct flashctx *flash);
Louis Yung-Chieh Loe53fa0f2011-04-11 17:18:41 +0800212
Edward O'Callaghana9c81002019-02-24 15:54:40 +1100213/* edi.c */
214int edi_chip_block_erase(struct flashctx *flash, unsigned int page, unsigned int size);
215int edi_chip_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
216int edi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
217int edi_probe_kb9012(struct flashctx *flash);
218
Nikolai Artemiev23d2d392020-08-31 13:57:37 +1000219/* spi95.c */
220int probe_spi_st95(struct flashctx *flash);
221int spi_block_erase_emulation(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
222
hailfinger088dc812009-12-14 03:32:24 +0000223#endif /* !__CHIPDRIVERS_H__ */