Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / 3a826043dbd389b4be2f5783c1b984ba297b8179 / . / chipdrivers.h
blob: af59c30f79928824e176c65dcd5e8ae7fc06ab8e [file] [log] [blame]
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]1/*
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 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 *
20 * Header file for flash chip drivers. Included from flash.h.
21 * As a general rule, every function listed here should take a pointer to
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]22 * struct flashctx as first parameter.
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]23 */
24
25#ifndef __CHIPDRIVERS_H__
26#define __CHIPDRIVERS_H__ 1
27
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]28#include "flash.h" /* for chipaddr and flashctx */
Stefan Taunera63c7c42011-08-16 12:08:22 +0000[diff] [blame]29
Stefan Taunereb582572012-09-21 12:52:50 +0000[diff] [blame]30/* spi.c */
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]31int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
32int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Stefan Taunereb582572012-09-21 12:52:50 +0000[diff] [blame]33int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, int unsigned len);
34
35/* spi25.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]36int probe_spi_rdid(struct flashctx *flash);
37int probe_spi_rdid4(struct flashctx *flash);
38int probe_spi_rems(struct flashctx *flash);
39int probe_spi_res1(struct flashctx *flash);
40int probe_spi_res2(struct flashctx *flash);
Stefan Tauner3f5e35d2013-04-19 01:58:33 +0000[diff] [blame]41int probe_spi_res3(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]42int probe_spi_at25f(struct flashctx *flash);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]43int spi_write_enable(struct flashctx *flash);
44int spi_write_disable(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]45int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]46int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner94b39b42012-10-27 00:06:02 +0000[diff] [blame]47int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]48int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]49int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]50int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner3c0fcd02012-09-21 12:46:56 +0000[diff] [blame]51int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +0000[diff] [blame]52int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +0000[diff] [blame]53int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]54int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +0000[diff] [blame]55int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
56int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev579f1e02013-06-28 21:28:37 +0000[diff] [blame]57int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]58int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000[diff] [blame]59erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]60int spi_chip_write_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]61int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]62int spi_read_chunked(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]63int spi_write_chunked(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
Nico Huberfe34d2a2017-11-10 21:10:20 +0100[diff] [blame]64int spi_enter_4ba(struct flashctx *flash);
65int spi_exit_4ba(struct flashctx *flash);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]66
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]67
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]68/* spi25_statusreg.c */
69uint8_t spi_read_status_register(struct flashctx *flash);
70int spi_write_status_register(struct flashctx *flash, int status);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000[diff] [blame]71void spi_prettyprint_status_register_bit(uint8_t status, int bit);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]72int spi_prettyprint_status_register_plain(struct flashctx *flash);
Stefan Tauner278ba6e2013-06-28 21:28:27 +0000[diff] [blame]73int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
Stefan Tauner12f3d512014-05-27 21:27:27 +0000[diff] [blame]74int spi_prettyprint_status_register_bp1_srwd(struct flashctx *flash);
75int spi_prettyprint_status_register_bp2_srwd(struct flashctx *flash);
76int spi_prettyprint_status_register_bp3_srwd(struct flashctx *flash);
77int spi_prettyprint_status_register_bp4_srwd(struct flashctx *flash);
Stefan Tauner85f09f72014-05-27 21:27:14 +0000[diff] [blame]78int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
Ben Gardnerbcf61092015-11-22 02:23:31 +0000[diff] [blame]79int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]80int spi_disable_blockprotect(struct flashctx *flash);
Stefan Taunera60d4082014-06-04 16:17:03 +0000[diff] [blame]81int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
Stefan Tauner278ba6e2013-06-28 21:28:27 +0000[diff] [blame]82int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
83int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
84int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]85int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
86int spi_prettyprint_status_register_at25df(struct flashctx *flash);
87int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]88int spi_prettyprint_status_register_at25f(struct flashctx *flash);
89int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]90int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]91int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]92int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
93int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
94int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
Stefan Taunercecb2c52013-06-20 22:55:41 +0000[diff] [blame]95int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
96int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]97int spi_disable_blockprotect_at25f(struct flashctx *flash);
98int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]99int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
100int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
101int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
Nikolay Nikolaevd0e3ea12013-06-28 21:29:08 +0000[diff] [blame]102int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +0000[diff] [blame]103int spi_prettyprint_status_register_n25q(struct flashctx *flash);
104int spi_disable_blockprotect_n25q(struct flashctx *flash);
Nikolay Nikolaevc80c4a32013-06-28 21:29:44 +0000[diff] [blame]105int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
106int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]107int spi_prettyprint_status_register_sst25(struct flashctx *flash);
108int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
109int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
110
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000[diff] [blame]111/* sfdp.c */
112int probe_spi_sfdp(struct flashctx *flash);
113
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000[diff] [blame]114/* opaque.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]115int probe_opaque(struct flashctx *flash);
116int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]117int write_opaque(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]118int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000[diff] [blame]119
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000[diff] [blame]120/* at45db.c */
121int probe_spi_at45db(struct flashctx *flash);
122int spi_prettyprint_status_register_at45db(struct flashctx *flash);
123int spi_disable_blockprotect_at45db(struct flashctx *flash);
124int spi_read_at45db(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Stefan Taunerfdc4f7e2013-08-27 18:02:12 +0000[diff] [blame]125int spi_read_at45db_e8(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]126int spi_write_at45db(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000[diff] [blame]127int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
128int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
129int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
130int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner1dd5d3a2013-08-27 18:02:19 +0000[diff] [blame]131int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000[diff] [blame]132
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]133/* 82802ab.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]134uint8_t wait_82802ab(struct flashctx *flash);
135int probe_82802ab(struct flashctx *flash);
136int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]137int write_82802ab(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Sean Nelson28accc22010-03-19 18:47:06 +0000[diff] [blame]138void print_status_82802ab(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]139int unlock_28f004s5(struct flashctx *flash);
140int unlock_lh28f008bjt(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]141
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]142/* jedec.c */
143uint8_t oddparity(uint8_t val);
Stefan Tauner0ab1e5d2014-05-29 11:51:24 +0000[diff] [blame]144void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
145void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]146int probe_jedec(struct flashctx *flash);
Stefan Tauner03a9c3c2014-08-03 14:15:14 +0000[diff] [blame]147int probe_jedec_29gl(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]148int write_jedec(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
149int write_jedec_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]150int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
151int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
152int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]153
Carl-Daniel Hailfingeref3ac8a2014-08-03 13:05:34 +0000[diff] [blame]154int unlock_regspace2_uniform_32k(struct flashctx *flash);
155int unlock_regspace2_uniform_64k(struct flashctx *flash);
156int unlock_regspace2_block_eraser_0(struct flashctx *flash);
157int unlock_regspace2_block_eraser_1(struct flashctx *flash);
Carl-Daniel Hailfingeref3ac8a2014-08-03 13:05:34 +0000[diff] [blame]158int printlock_regspace2_uniform_64k(struct flashctx *flash);
159int printlock_regspace2_block_eraser_0(struct flashctx *flash);
160int printlock_regspace2_block_eraser_1(struct flashctx *flash);
161
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]162/* sst28sf040.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]163int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
164int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]165int write_28sf040(struct flashctx *flash, const uint8_t *buf,unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]166int unprotect_28sf040(struct flashctx *flash);
167int protect_28sf040(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]168
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]169/* sst49lfxxxc.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]170int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]171
172/* sst_fwhub.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]173int printlock_sst_fwhub(struct flashctx *flash);
174int unlock_sst_fwhub(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]175
Carl-Daniel Hailfinger91882402010-12-05 16:33:59 +0000[diff] [blame]176/* w39.c */
Kyösti Mälkkic31243e2012-10-28 01:50:08 +0000[diff] [blame]177int printlock_w39f010(struct flashctx * flash);
178int printlock_w39l010(struct flashctx * flash);
179int printlock_w39l020(struct flashctx * flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]180int printlock_w39l040(struct flashctx * flash);
181int printlock_w39v040a(struct flashctx *flash);
182int printlock_w39v040b(struct flashctx *flash);
183int printlock_w39v040c(struct flashctx *flash);
184int printlock_w39v040fa(struct flashctx *flash);
185int printlock_w39v040fb(struct flashctx *flash);
186int printlock_w39v040fc(struct flashctx *flash);
187int printlock_w39v080a(struct flashctx *flash);
188int printlock_w39v080fa(struct flashctx *flash);
189int printlock_w39v080fa_dual(struct flashctx *flash);
David Borgf5a30f62012-04-15 13:16:32 +0000[diff] [blame]190int printlock_at49f(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]191
192/* w29ee011.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]193int probe_w29ee011(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]194
Stefan Tauner4404f732013-09-12 08:28:56 +0000[diff] [blame]195/* stm50.c */
196int erase_sector_stm50(struct flashctx *flash, unsigned int block, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]197
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000[diff] [blame]198/* en29lv640b.c */
199int probe_en29lv640b(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]200int write_en29lv640b(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000[diff] [blame]201
Paul Kocialkowski80ae14e2018-01-15 01:07:46 +0300[diff] [blame]202/* edi.c */
203int edi_chip_block_erase(struct flashctx *flash, unsigned int page, unsigned int size);
204int edi_chip_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
205int edi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
206int edi_probe_kb9012(struct flashctx *flash);
207
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]208#endif /* !__CHIPDRIVERS_H__ */