blob: 4ece42e3b0c83c3813deb7f9c23eef1f532966ba [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 *
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 +000022 * struct flashctx as first parameter.
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +000023 */
24
25#ifndef __CHIPDRIVERS_H__
26#define __CHIPDRIVERS_H__ 1
27
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000028#include "flash.h" /* for chipaddr and flashctx */
Stefan Taunera63c7c42011-08-16 12:08:22 +000029
Stefan Taunereb582572012-09-21 12:52:50 +000030/* spi.c */
Mark Marshallf20b7be2014-05-09 21:16:21 +000031int 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 +000033int 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 +000036int 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 +000041int probe_spi_res3(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000042int probe_spi_at25f(struct flashctx *flash);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000043int spi_write_enable(struct flashctx *flash);
44int spi_write_disable(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000045int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner94b39b42012-10-27 00:06:02 +000046int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000047int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000048int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner3c0fcd02012-09-21 12:46:56 +000049int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +000050int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +000051int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000052int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +000053int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
54int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev579f1e02013-06-28 21:28:37 +000055int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Taunerac1b4c82012-02-17 14:51:04 +000056erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Mark Marshallf20b7be2014-05-09 21:16:21 +000057int 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 +000058int spi_byte_program(struct flashctx *flash, unsigned int addr, uint8_t databyte);
Mark Marshallf20b7be2014-05-09 21:16:21 +000059int spi_nbyte_program(struct flashctx *flash, unsigned int addr, const uint8_t *bytes, unsigned int len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000060int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000061int 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 +000062int spi_write_chunked(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +000063
Stefan Tauner6ee37e22012-12-29 15:03:51 +000064/* spi25_statusreg.c */
65uint8_t spi_read_status_register(struct flashctx *flash);
66int spi_write_status_register(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);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000075int spi_disable_blockprotect(struct flashctx *flash);
Stefan Taunera60d4082014-06-04 16:17:03 +000076int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
Stefan Tauner278ba6e2013-06-28 21:28:27 +000077int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
78int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
79int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000080int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
81int spi_prettyprint_status_register_at25df(struct flashctx *flash);
82int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000083int spi_prettyprint_status_register_at25f(struct flashctx *flash);
84int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000085int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000086int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000087int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
88int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
89int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
Stefan Taunercecb2c52013-06-20 22:55:41 +000090int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
91int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +000092int spi_disable_blockprotect_at25f(struct flashctx *flash);
93int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +000094int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
95int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
96int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
Nikolay Nikolaevd0e3ea12013-06-28 21:29:08 +000097int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +000098int spi_prettyprint_status_register_n25q(struct flashctx *flash);
99int spi_disable_blockprotect_n25q(struct flashctx *flash);
Nikolay Nikolaevc80c4a32013-06-28 21:29:44 +0000100int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
101int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000102int spi_prettyprint_status_register_sst25(struct flashctx *flash);
103int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
104int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
105
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000106/* sfdp.c */
107int probe_spi_sfdp(struct flashctx *flash);
108
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000109/* opaque.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000110int probe_opaque(struct flashctx *flash);
111int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000112int write_opaque(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000113int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000114
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000115/* at45db.c */
116int probe_spi_at45db(struct flashctx *flash);
117int spi_prettyprint_status_register_at45db(struct flashctx *flash);
118int spi_disable_blockprotect_at45db(struct flashctx *flash);
119int spi_read_at45db(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Stefan Taunerfdc4f7e2013-08-27 18:02:12 +0000120int spi_read_at45db_e8(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000121int spi_write_at45db(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000122int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
123int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
124int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
125int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner1dd5d3a2013-08-27 18:02:19 +0000126int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000127
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000128/* 82802ab.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000129uint8_t wait_82802ab(struct flashctx *flash);
130int probe_82802ab(struct flashctx *flash);
131int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000132int write_82802ab(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Sean Nelson28accc22010-03-19 18:47:06 +0000133void print_status_82802ab(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000134int unlock_28f004s5(struct flashctx *flash);
135int unlock_lh28f008bjt(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000136
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000137/* jedec.c */
138uint8_t oddparity(uint8_t val);
Stefan Tauner0ab1e5d2014-05-29 11:51:24 +0000139void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
140void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000141int probe_jedec(struct flashctx *flash);
Stefan Tauner03a9c3c2014-08-03 14:15:14 +0000142int probe_jedec_29gl(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000143int write_jedec(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
144int write_jedec_1(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000145int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
146int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
147int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000148
Carl-Daniel Hailfingeref3ac8a2014-08-03 13:05:34 +0000149int unlock_regspace2_uniform_32k(struct flashctx *flash);
150int unlock_regspace2_uniform_64k(struct flashctx *flash);
151int unlock_regspace2_block_eraser_0(struct flashctx *flash);
152int unlock_regspace2_block_eraser_1(struct flashctx *flash);
153int unlock_regspace2_block(const struct flashctx *flash, chipaddr off);
154int printlock_regspace2_uniform_64k(struct flashctx *flash);
155int printlock_regspace2_block_eraser_0(struct flashctx *flash);
156int printlock_regspace2_block_eraser_1(struct flashctx *flash);
157
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000158/* m29f400bt.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000159int probe_m29f400bt(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000160int write_m29f400bt(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000161void protect_m29f400bt(struct flashctx *flash, chipaddr bios);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000162
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000163/* sst28sf040.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000164int 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);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000166int write_28sf040(struct flashctx *flash, const uint8_t *buf,unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000167int unprotect_28sf040(struct flashctx *flash);
168int protect_28sf040(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000169
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000170/* sst49lfxxxc.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000171int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000172
173/* sst_fwhub.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000174int printlock_sst_fwhub(struct flashctx *flash);
175int unlock_sst_fwhub(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000176
Carl-Daniel Hailfinger91882402010-12-05 16:33:59 +0000177/* w39.c */
Kyösti Mälkkic31243e2012-10-28 01:50:08 +0000178int printlock_w39f010(struct flashctx * flash);
179int printlock_w39l010(struct flashctx * flash);
180int printlock_w39l020(struct flashctx * flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000181int printlock_w39l040(struct flashctx * flash);
182int printlock_w39v040a(struct flashctx *flash);
183int printlock_w39v040b(struct flashctx *flash);
184int printlock_w39v040c(struct flashctx *flash);
185int printlock_w39v040fa(struct flashctx *flash);
186int printlock_w39v040fb(struct flashctx *flash);
187int printlock_w39v040fc(struct flashctx *flash);
188int printlock_w39v080a(struct flashctx *flash);
189int printlock_w39v080fa(struct flashctx *flash);
190int printlock_w39v080fa_dual(struct flashctx *flash);
David Borgf5a30f62012-04-15 13:16:32 +0000191int printlock_at49f(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000192
193/* w29ee011.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000194int probe_w29ee011(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000195
Stefan Tauner4404f732013-09-12 08:28:56 +0000196/* stm50.c */
197int erase_sector_stm50(struct flashctx *flash, unsigned int block, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000198
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000199/* en29lv640b.c */
200int probe_en29lv640b(struct flashctx *flash);
Stefan Taunerf2756fa2014-06-01 02:21:02 +0000201int erase_block_shifted_jedec(struct flashctx *flash, unsigned int start, unsigned int len);
202int erase_chip_block_shifted_jedec(struct flashctx *flash, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000203int write_en29lv640b(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000204
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000205#endif /* !__CHIPDRIVERS_H__ */