blob: e1d6aa9e7daa1ec4b8da22c63a629e56b6ebb3bf [file] [log] [blame]
Carl-Daniel Hailfinger5d5c0722009-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 *
Carl-Daniel Hailfinger5d5c0722009-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
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000017 * struct flashctx as first parameter.
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +000018 */
19
20#ifndef __CHIPDRIVERS_H__
21#define __CHIPDRIVERS_H__ 1
22
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000023#include "flash.h" /* for chipaddr and flashctx */
Stefan Taunera63c7c42011-08-16 12:08:22 +000024
Stefan Taunereb582572012-09-21 12:52:50 +000025/* spi.c */
Mark Marshallf20b7be2014-05-09 21:16:21 +000026int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
27int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Stefan Taunereb582572012-09-21 12:52:50 +000028int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, int unsigned len);
29
30/* spi25.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000031int probe_spi_rdid(struct flashctx *flash);
32int probe_spi_rdid4(struct flashctx *flash);
33int probe_spi_rems(struct flashctx *flash);
34int probe_spi_res1(struct flashctx *flash);
35int probe_spi_res2(struct flashctx *flash);
Stefan Tauner3f5e35d2013-04-19 01:58:33 +000036int probe_spi_res3(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000037int probe_spi_at25f(struct flashctx *flash);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000038int spi_write_enable(struct flashctx *flash);
39int spi_write_disable(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000040int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +020041int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner94b39b42012-10-27 00:06:02 +000042int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000043int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +020044int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000045int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner3c0fcd02012-09-21 12:46:56 +000046int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +000047int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +000048int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000049int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +000050int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
51int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev579f1e02013-06-28 21:28:37 +000052int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +020053int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Taunerac1b4c82012-02-17 14:51:04 +000054erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Mark Marshallf20b7be2014-05-09 21:16:21 +000055int 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 +000056int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000057int 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 +000058int 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 +010059int spi_enter_4ba(struct flashctx *flash);
60int spi_exit_4ba(struct flashctx *flash);
Nico Huber7eb38aa2019-03-21 15:42:54 +010061int spi_set_extended_address(struct flashctx *, uint8_t addr_high);
Nico Huber7e3c81a2017-10-14 18:56:50 +020062
Nico Huber9dc3d8d2020-04-27 22:51:49 +000063
Stefan Tauner6ee37e22012-12-29 15:03:51 +000064/* spi25_statusreg.c */
Edward O'Callaghane4ddc362020-04-12 17:27:53 +100065uint8_t spi_read_status_register(const struct flashctx *flash);
66int spi_write_status_register(const struct flashctx *flash, int status);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +000067void spi_prettyprint_status_register_bit(uint8_t status, int bit);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000068int spi_prettyprint_status_register_plain(struct flashctx *flash);
Stefan Tauner278ba6e2013-06-28 21:28:27 +000069int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
Stefan Tauner12f3d512014-05-27 21:27:27 +000070int spi_prettyprint_status_register_bp1_srwd(struct flashctx *flash);
71int spi_prettyprint_status_register_bp2_srwd(struct flashctx *flash);
72int spi_prettyprint_status_register_bp3_srwd(struct flashctx *flash);
73int spi_prettyprint_status_register_bp4_srwd(struct flashctx *flash);
Stefan Tauner85f09f72014-05-27 21:27:14 +000074int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
Ben Gardnerbcf61092015-11-22 02:23:31 +000075int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000076int spi_disable_blockprotect(struct flashctx *flash);
Stefan Taunera60d4082014-06-04 16:17:03 +000077int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
Stefan Tauner278ba6e2013-06-28 21:28:27 +000078int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
79int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
80int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000081int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
82int spi_prettyprint_status_register_at25df(struct flashctx *flash);
83int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000084int spi_prettyprint_status_register_at25f(struct flashctx *flash);
85int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000086int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000087int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000088int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
89int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
90int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
Stefan Taunercecb2c52013-06-20 22:55:41 +000091int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
92int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000093int spi_disable_blockprotect_at25f(struct flashctx *flash);
94int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000095int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
96int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
97int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
Nikolay Nikolaevd0e3ea12013-06-28 21:29:08 +000098int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +000099int spi_prettyprint_status_register_n25q(struct flashctx *flash);
100int spi_disable_blockprotect_n25q(struct flashctx *flash);
Nikolay Nikolaevc80c4a32013-06-28 21:29:44 +0000101int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
102int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000103int spi_prettyprint_status_register_sst25(struct flashctx *flash);
104int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
105int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
Wei Hu25584de2018-04-30 14:02:08 -0700106int spi_disable_blockprotect_sst26_global_unprotect(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000107
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000108/* sfdp.c */
109int probe_spi_sfdp(struct flashctx *flash);
110
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000111/* opaque.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000112int probe_opaque(struct flashctx *flash);
113int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000114int write_opaque(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000115int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000116
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000117/* at45db.c */
118int probe_spi_at45db(struct flashctx *flash);
119int spi_prettyprint_status_register_at45db(struct flashctx *flash);
120int spi_disable_blockprotect_at45db(struct flashctx *flash);
121int spi_read_at45db(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Stefan Taunerfdc4f7e2013-08-27 18:02:12 +0000122int spi_read_at45db_e8(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000123int spi_write_at45db(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000124int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
125int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
126int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
127int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner1dd5d3a2013-08-27 18:02:19 +0000128int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000129
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000130/* 82802ab.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000131uint8_t wait_82802ab(struct flashctx *flash);
132int probe_82802ab(struct flashctx *flash);
133int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000134int write_82802ab(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Sean Nelson28accc22010-03-19 18:47:06 +0000135void print_status_82802ab(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000136int unlock_28f004s5(struct flashctx *flash);
137int unlock_lh28f008bjt(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000138
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000139/* jedec.c */
140uint8_t oddparity(uint8_t val);
Stefan Tauner0ab1e5d2014-05-29 11:51:24 +0000141void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
142void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000143int probe_jedec(struct flashctx *flash);
Stefan Tauner03a9c3c2014-08-03 14:15:14 +0000144int probe_jedec_29gl(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000145int 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);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000147int 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);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000150
Carl-Daniel Hailfingeref3ac8a2014-08-03 13:05:34 +0000151int 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);
Carl-Daniel Hailfingeref3ac8a2014-08-03 13:05:34 +0000155int 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
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000159/* sst28sf040.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000160int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
161int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Edward O'Callaghan6cdde542020-12-19 11:57:30 +1100162int write_28sf040(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000163int unprotect_28sf040(struct flashctx *flash);
164int protect_28sf040(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000165
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000166/* sst49lfxxxc.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000167int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000168
169/* sst_fwhub.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000170int printlock_sst_fwhub(struct flashctx *flash);
171int unlock_sst_fwhub(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000172
Nikolai Artemievadbae0e2020-10-06 16:59:51 +1100173/* s25f.c */
174int probe_spi_big_spansion(struct flashctx *flash);
175int s25fl_block_erase(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
176int s25fs_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
177
Carl-Daniel Hailfinger91882402010-12-05 16:33:59 +0000178/* w39.c */
Kyösti Mälkkic31243e2012-10-28 01:50:08 +0000179int printlock_w39f010(struct flashctx * flash);
180int printlock_w39l010(struct flashctx * flash);
181int printlock_w39l020(struct flashctx * flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000182int printlock_w39l040(struct flashctx * flash);
183int printlock_w39v040a(struct flashctx *flash);
184int printlock_w39v040b(struct flashctx *flash);
185int printlock_w39v040c(struct flashctx *flash);
186int printlock_w39v040fa(struct flashctx *flash);
187int printlock_w39v040fb(struct flashctx *flash);
188int printlock_w39v040fc(struct flashctx *flash);
189int printlock_w39v080a(struct flashctx *flash);
190int printlock_w39v080fa(struct flashctx *flash);
191int printlock_w39v080fa_dual(struct flashctx *flash);
David Borgf5a30f62012-04-15 13:16:32 +0000192int printlock_at49f(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000193
194/* w29ee011.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000195int probe_w29ee011(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000196
Stefan Tauner4404f732013-09-12 08:28:56 +0000197/* stm50.c */
198int erase_sector_stm50(struct flashctx *flash, unsigned int block, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000199
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000200/* en29lv640b.c */
201int probe_en29lv640b(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000202int write_en29lv640b(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000203
Namyoon Woo31498222020-08-27 16:03:16 -0700204/* dummyflasher.c */
205int probe_variable_size(struct flashctx *flash);
206
Paul Kocialkowski80ae14e2018-01-15 01:07:46 +0300207/* edi.c */
208int edi_chip_block_erase(struct flashctx *flash, unsigned int page, unsigned int size);
209int edi_chip_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
210int edi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
211int edi_probe_kb9012(struct flashctx *flash);
212
Konstantin Grudnev3d8868c2019-07-23 00:48:54 +0300213/* spi95.c */
214int probe_spi_st95(struct flashctx *flash);
215int spi_block_erase_emulation(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
216
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000217#endif /* !__CHIPDRIVERS_H__ */