Blame - chipdrivers.h - flashprog

blob: 8405220d755050d848e95db58984ce71ec63728f [file] [log] [blame]

Carl-Daniel Hailfinger	5d5c072	2009-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 Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	22	* struct flashctx as first parameter.
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	23	*/
				24
				25	#ifndef __CHIPDRIVERS_H__
				26	#define __CHIPDRIVERS_H__ 1
				27
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	28	#include "flash.h" /* for chipaddr and flashctx */
Stefan Tauner	a63c7c4	2011-08-16 12:08:22 +0000	[diff] [blame]	29
Stefan Tauner	eb58257	2012-09-21 12:52:50 +0000	[diff] [blame]	30	/* spi.c */
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	31	int spi_aai_write(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
				32	int spi_chip_write_256(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
Stefan Tauner	eb58257	2012-09-21 12:52:50 +0000	[diff] [blame]	33	int spi_chip_read(struct flashctx flash, uint8_t buf, unsigned int start, int unsigned len);
				34
				35	/* spi25.c */
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	36	int probe_spi_rdid(struct flashctx *flash);
				37	int probe_spi_rdid4(struct flashctx *flash);
				38	int probe_spi_rems(struct flashctx *flash);
				39	int probe_spi_res1(struct flashctx *flash);
				40	int probe_spi_res2(struct flashctx *flash);
Stefan Tauner	3f5e35d	2013-04-19 01:58:33 +0000	[diff] [blame]	41	int probe_spi_res3(struct flashctx *flash);
Stefan Tauner	57794ac	2012-12-29 15:04:20 +0000	[diff] [blame]	42	int probe_spi_at25f(struct flashctx *flash);
Carl-Daniel Hailfinger	8a3c60c	2011-12-18 15:01:24 +0000	[diff] [blame]	43	int spi_write_enable(struct flashctx *flash);
				44	int spi_write_disable(struct flashctx *flash);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	45	int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber	7e3c81a	2017-10-14 18:56:50 +0200	[diff] [blame]	46	int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner	94b39b4	2012-10-27 00:06:02 +0000	[diff] [blame]	47	int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	48	int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber	7e3c81a	2017-10-14 18:56:50 +0200	[diff] [blame]	49	int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	50	int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner	3c0fcd0	2012-09-21 12:46:56 +0000	[diff] [blame]	51	int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner	730e7e7	2013-05-01 14:04:19 +0000	[diff] [blame]	52	int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev	6f59b0b	2013-06-28 21:29:51 +0000	[diff] [blame]	53	int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	54	int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner	730e7e7	2013-05-01 14:04:19 +0000	[diff] [blame]	55	int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
				56	int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev	579f1e0	2013-06-28 21:28:37 +0000	[diff] [blame]	57	int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber	7e3c81a	2017-10-14 18:56:50 +0200	[diff] [blame]	58	int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner	ac1b4c8	2012-02-17 14:51:04 +0000	[diff] [blame]	59	erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	60	int spi_chip_write_1(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger	8a3c60c	2011-12-18 15:01:24 +0000	[diff] [blame]	61	int spi_nbyte_read(struct flashctx flash, unsigned int addr, uint8_t bytes, unsigned int len);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	62	int spi_read_chunked(struct flashctx flash, uint8_t buf, unsigned int start, unsigned int len, unsigned int chunksize);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	63	int spi_write_chunked(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len, unsigned int chunksize);
Nico Huber	fe34d2a	2017-11-10 21:10:20 +0100	[diff] [blame]	64	int spi_enter_4ba(struct flashctx *flash);
				65	int spi_exit_4ba(struct flashctx *flash);
Nico Huber	7e3c81a	2017-10-14 18:56:50 +0200	[diff] [blame]	66
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	67
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	68	/* spi25_statusreg.c */
				69	uint8_t spi_read_status_register(struct flashctx *flash);
				70	int spi_write_status_register(struct flashctx *flash, int status);
Aidan Thornton	db4e87d	2013-08-27 18:01:53 +0000	[diff] [blame]	71	void spi_prettyprint_status_register_bit(uint8_t status, int bit);
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	72	int spi_prettyprint_status_register_plain(struct flashctx *flash);
Stefan Tauner	278ba6e	2013-06-28 21:28:27 +0000	[diff] [blame]	73	int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
Stefan Tauner	12f3d51	2014-05-27 21:27:27 +0000	[diff] [blame]	74	int spi_prettyprint_status_register_bp1_srwd(struct flashctx *flash);
				75	int spi_prettyprint_status_register_bp2_srwd(struct flashctx *flash);
				76	int spi_prettyprint_status_register_bp3_srwd(struct flashctx *flash);
				77	int spi_prettyprint_status_register_bp4_srwd(struct flashctx *flash);
Stefan Tauner	85f09f7	2014-05-27 21:27:14 +0000	[diff] [blame]	78	int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
Ben Gardner	bcf6109	2015-11-22 02:23:31 +0000	[diff] [blame]	79	int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	80	int spi_disable_blockprotect(struct flashctx *flash);
Stefan Tauner	a60d408	2014-06-04 16:17:03 +0000	[diff] [blame]	81	int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
Stefan Tauner	278ba6e	2013-06-28 21:28:27 +0000	[diff] [blame]	82	int spi_disable_blockprotect_bp2_srwd(struct flashctx *flash);
				83	int spi_disable_blockprotect_bp3_srwd(struct flashctx *flash);
				84	int spi_disable_blockprotect_bp4_srwd(struct flashctx *flash);
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	85	int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
				86	int spi_prettyprint_status_register_at25df(struct flashctx *flash);
				87	int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
Stefan Tauner	57794ac	2012-12-29 15:04:20 +0000	[diff] [blame]	88	int spi_prettyprint_status_register_at25f(struct flashctx *flash);
				89	int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	90	int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
Stefan Tauner	57794ac	2012-12-29 15:04:20 +0000	[diff] [blame]	91	int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	92	int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
				93	int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
				94	int spi_prettyprint_status_register_at26df081a(struct flashctx *flash);
Stefan Tauner	cecb2c5	2013-06-20 22:55:41 +0000	[diff] [blame]	95	int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
				96	int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
Stefan Tauner	57794ac	2012-12-29 15:04:20 +0000	[diff] [blame]	97	int spi_disable_blockprotect_at25f(struct flashctx *flash);
				98	int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	99	int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
				100	int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
				101	int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
Nikolay Nikolaev	d0e3ea1	2013-06-28 21:29:08 +0000	[diff] [blame]	102	int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
Nikolay Nikolaev	6f59b0b	2013-06-28 21:29:51 +0000	[diff] [blame]	103	int spi_prettyprint_status_register_n25q(struct flashctx *flash);
				104	int spi_disable_blockprotect_n25q(struct flashctx *flash);
Nikolay Nikolaev	c80c4a3	2013-06-28 21:29:44 +0000	[diff] [blame]	105	int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
				106	int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
Stefan Tauner	6ee37e2	2012-12-29 15:03:51 +0000	[diff] [blame]	107	int spi_prettyprint_status_register_sst25(struct flashctx *flash);
				108	int spi_prettyprint_status_register_sst25vf016(struct flashctx *flash);
				109	int spi_prettyprint_status_register_sst25vf040b(struct flashctx *flash);
				110
Stefan Tauner	ac1b4c8	2012-02-17 14:51:04 +0000	[diff] [blame]	111	/* sfdp.c */
				112	int probe_spi_sfdp(struct flashctx *flash);
				113
Carl-Daniel Hailfinger	532c717	2011-11-04 21:35:26 +0000	[diff] [blame]	114	/* opaque.c */
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	115	int probe_opaque(struct flashctx *flash);
				116	int read_opaque(struct flashctx flash, uint8_t buf, unsigned int start, unsigned int len);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	117	int write_opaque(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	118	int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfinger	532c717	2011-11-04 21:35:26 +0000	[diff] [blame]	119
Aidan Thornton	db4e87d	2013-08-27 18:01:53 +0000	[diff] [blame]	120	/* at45db.c */
				121	int probe_spi_at45db(struct flashctx *flash);
				122	int spi_prettyprint_status_register_at45db(struct flashctx *flash);
				123	int spi_disable_blockprotect_at45db(struct flashctx *flash);
				124	int spi_read_at45db(struct flashctx flash, uint8_t buf, unsigned int start, unsigned int len);
Stefan Tauner	fdc4f7e	2013-08-27 18:02:12 +0000	[diff] [blame]	125	int spi_read_at45db_e8(struct flashctx flash, uint8_t buf, unsigned int start, unsigned int len);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	126	int spi_write_at45db(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
Aidan Thornton	db4e87d	2013-08-27 18:01:53 +0000	[diff] [blame]	127	int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
				128	int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
				129	int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
				130	int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner	1dd5d3a	2013-08-27 18:02:19 +0000	[diff] [blame]	131	int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Aidan Thornton	db4e87d	2013-08-27 18:01:53 +0000	[diff] [blame]	132
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	133	/* 82802ab.c */
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	134	uint8_t wait_82802ab(struct flashctx *flash);
				135	int probe_82802ab(struct flashctx *flash);
				136	int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	137	int write_82802ab(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
Sean Nelson	28accc2	2010-03-19 18:47:06 +0000	[diff] [blame]	138	void print_status_82802ab(uint8_t status);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	139	int unlock_28f004s5(struct flashctx *flash);
				140	int unlock_lh28f008bjt(struct flashctx *flash);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	141
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	142	/* jedec.c */
				143	uint8_t oddparity(uint8_t val);
Stefan Tauner	0ab1e5d	2014-05-29 11:51:24 +0000	[diff] [blame]	144	void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
				145	void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	146	int probe_jedec(struct flashctx *flash);
Stefan Tauner	03a9c3c	2014-08-03 14:15:14 +0000	[diff] [blame]	147	int probe_jedec_29gl(struct flashctx *flash);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	148	int write_jedec(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
				149	int write_jedec_1(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	150	int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
				151	int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
				152	int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	153
Carl-Daniel Hailfinger	ef3ac8a	2014-08-03 13:05:34 +0000	[diff] [blame]	154	int unlock_regspace2_uniform_32k(struct flashctx *flash);
				155	int unlock_regspace2_uniform_64k(struct flashctx *flash);
				156	int unlock_regspace2_block_eraser_0(struct flashctx *flash);
				157	int unlock_regspace2_block_eraser_1(struct flashctx *flash);
Carl-Daniel Hailfinger	ef3ac8a	2014-08-03 13:05:34 +0000	[diff] [blame]	158	int printlock_regspace2_uniform_64k(struct flashctx *flash);
				159	int printlock_regspace2_block_eraser_0(struct flashctx *flash);
				160	int printlock_regspace2_block_eraser_1(struct flashctx *flash);
				161
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	162	/* sst28sf040.c */
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	163	int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
				164	int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	165	int write_28sf040(struct flashctx flash, const uint8_t buf,unsigned int start, unsigned int len);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	166	int unprotect_28sf040(struct flashctx *flash);
				167	int protect_28sf040(struct flashctx *flash);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	168
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	169	/* sst49lfxxxc.c */
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	170	int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	171
				172	/* sst_fwhub.c */
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	173	int printlock_sst_fwhub(struct flashctx *flash);
				174	int unlock_sst_fwhub(struct flashctx *flash);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	175
Carl-Daniel Hailfinger	9188240	2010-12-05 16:33:59 +0000	[diff] [blame]	176	/* w39.c */
Kyösti Mälkki	c31243e	2012-10-28 01:50:08 +0000	[diff] [blame]	177	int printlock_w39f010(struct flashctx * flash);
				178	int printlock_w39l010(struct flashctx * flash);
				179	int printlock_w39l020(struct flashctx * flash);
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	180	int printlock_w39l040(struct flashctx * flash);
				181	int printlock_w39v040a(struct flashctx *flash);
				182	int printlock_w39v040b(struct flashctx *flash);
				183	int printlock_w39v040c(struct flashctx *flash);
				184	int printlock_w39v040fa(struct flashctx *flash);
				185	int printlock_w39v040fb(struct flashctx *flash);
				186	int printlock_w39v040fc(struct flashctx *flash);
				187	int printlock_w39v080a(struct flashctx *flash);
				188	int printlock_w39v080fa(struct flashctx *flash);
				189	int printlock_w39v080fa_dual(struct flashctx *flash);
David Borg	f5a30f6	2012-04-15 13:16:32 +0000	[diff] [blame]	190	int printlock_at49f(struct flashctx *flash);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	191
				192	/* w29ee011.c */
Carl-Daniel Hailfinger	63fd902	2011-12-14 22:25:15 +0000	[diff] [blame]	193	int probe_w29ee011(struct flashctx *flash);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	194
Stefan Tauner	4404f73	2013-09-12 08:28:56 +0000	[diff] [blame]	195	/* stm50.c */
				196	int erase_sector_stm50(struct flashctx *flash, unsigned int block, unsigned int blocksize);
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	197
Rudolf Marek	47eff6b	2012-04-14 22:51:40 +0000	[diff] [blame]	198	/* en29lv640b.c */
				199	int probe_en29lv640b(struct flashctx *flash);
Mark Marshall	f20b7be	2014-05-09 21:16:21 +0000	[diff] [blame]	200	int write_en29lv640b(struct flashctx flash, const uint8_t buf, unsigned int start, unsigned int len);
Rudolf Marek	47eff6b	2012-04-14 22:51:40 +0000	[diff] [blame]	201
Carl-Daniel Hailfinger	5d5c072	2009-12-14 03:32:24 +0000	[diff] [blame]	202	#endif /* !__CHIPDRIVERS_H__ */