Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / ad55d5a4ea4bc82450b076fbf9faffc130a698bb / . / chipdrivers.h
blob: 149620a4103cccc739403bfbd78c041a105c4205 [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 *
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]15 * 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 +0000[diff] [blame]17 * struct flashctx as first parameter.
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]18 */
19
20#ifndef __CHIPDRIVERS_H__
21#define __CHIPDRIVERS_H__ 1
22
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]23#include "flash.h" /* for chipaddr and flashctx */
Stefan Taunera63c7c42011-08-16 12:08:22 +0000[diff] [blame]24
Stefan Taunereb582572012-09-21 12:52:50 +0000[diff] [blame]25/* spi.c */
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]26int 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 +0000[diff] [blame]28int 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 +0000[diff] [blame]31int 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 +0000[diff] [blame]36int probe_spi_res3(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]37int probe_spi_at25f(struct flashctx *flash);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]38int spi_write_enable(struct flashctx *flash);
39int spi_write_disable(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]40int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]41int spi_block_erase_21(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner94b39b42012-10-27 00:06:02 +0000[diff] [blame]42int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]43int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huberfffc48d2022-05-28 14:26:06 +0200[diff] [blame]44int spi_block_erase_53(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]45int spi_block_erase_5c(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]46int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner3c0fcd02012-09-21 12:46:56 +0000[diff] [blame]47int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +0000[diff] [blame]48int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +0000[diff] [blame]49int spi_block_erase_c4(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]50int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner730e7e72013-05-01 14:04:19 +0000[diff] [blame]51int 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);
Nikolay Nikolaev579f1e02013-06-28 21:28:37 +0000[diff] [blame]53int spi_block_erase_db(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]54int spi_block_erase_dc(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000[diff] [blame]55erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]56int 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]57int 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]58int 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]59int 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]60int spi_enter_4ba(struct flashctx *flash);
61int spi_exit_4ba(struct flashctx *flash);
Nico Huber7eb38aa2019-03-21 15:42:54 +0100[diff] [blame]62int spi_set_extended_address(struct flashctx *, uint8_t addr_high);
Nico Huber7e3c81a2017-10-14 18:56:50 +0200[diff] [blame]63
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]64
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]65/* spi25_statusreg.c */
Nikolai Artemiev01675222021-10-20 22:30:41 +1100[diff] [blame]66int spi_read_register(const struct flashctx *flash, enum flash_reg reg, uint8_t *value);
67int spi_write_register(const struct flashctx *flash, enum flash_reg reg, uint8_t value);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000[diff] [blame]68void spi_prettyprint_status_register_bit(uint8_t status, int bit);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]69int spi_prettyprint_status_register_plain(struct flashctx *flash);
Stefan Tauner278ba6e2013-06-28 21:28:27 +0000[diff] [blame]70int spi_prettyprint_status_register_default_welwip(struct flashctx *flash);
Stefan Tauner12f3d512014-05-27 21:27:27 +0000[diff] [blame]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);
Stefan Tauner85f09f72014-05-27 21:27:14 +0000[diff] [blame]75int spi_prettyprint_status_register_bp2_bpl(struct flashctx *flash);
Ben Gardnerbcf61092015-11-22 02:23:31 +0000[diff] [blame]76int spi_prettyprint_status_register_bp2_tb_bpl(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]77int spi_disable_blockprotect(struct flashctx *flash);
Stefan Taunera60d4082014-06-04 16:17:03 +0000[diff] [blame]78int spi_disable_blockprotect_bp1_srwd(struct flashctx *flash);
Stefan Tauner278ba6e2013-06-28 21:28:27 +0000[diff] [blame]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);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]82int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
83int spi_prettyprint_status_register_at25df(struct flashctx *flash);
84int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]85int spi_prettyprint_status_register_at25f(struct flashctx *flash);
86int spi_prettyprint_status_register_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]87int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]88int spi_prettyprint_status_register_at25f4096(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]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);
Stefan Taunercecb2c52013-06-20 22:55:41 +0000[diff] [blame]92int spi_disable_blockprotect_at2x_global_unprotect(struct flashctx *flash);
93int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashctx *flash);
Stefan Tauner57794ac2012-12-29 15:04:20 +0000[diff] [blame]94int spi_disable_blockprotect_at25f(struct flashctx *flash);
95int spi_disable_blockprotect_at25f512a(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]96int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
97int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
98int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
Nikolay Nikolaevd0e3ea12013-06-28 21:29:08 +0000[diff] [blame]99int spi_prettyprint_status_register_en25s_wp(struct flashctx *flash);
Nikolay Nikolaev6f59b0b2013-06-28 21:29:51 +0000[diff] [blame]100int spi_prettyprint_status_register_n25q(struct flashctx *flash);
101int spi_disable_blockprotect_n25q(struct flashctx *flash);
Nikolay Nikolaevc80c4a32013-06-28 21:29:44 +0000[diff] [blame]102int spi_prettyprint_status_register_bp2_ep_srwd(struct flashctx *flash);
103int spi_disable_blockprotect_bp2_ep_srwd(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]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);
Wei Hu25584de2018-04-30 14:02:08 -0700[diff] [blame]107int spi_disable_blockprotect_sst26_global_unprotect(struct flashctx *flash);
Stefan Tauner6ee37e22012-12-29 15:03:51 +0000[diff] [blame]108
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000[diff] [blame]109/* sfdp.c */
110int probe_spi_sfdp(struct flashctx *flash);
111
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000[diff] [blame]112/* opaque.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]113int probe_opaque(struct flashctx *flash);
114int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]115int 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]116int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000[diff] [blame]117
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000[diff] [blame]118/* at45db.c */
119int probe_spi_at45db(struct flashctx *flash);
120int spi_prettyprint_status_register_at45db(struct flashctx *flash);
121int spi_disable_blockprotect_at45db(struct flashctx *flash);
122int 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]123int 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]124int 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]125int spi_erase_at45db_page(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
126int spi_erase_at45db_block(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
127int spi_erase_at45db_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
128int spi_erase_at45db_chip(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner1dd5d3a2013-08-27 18:02:19 +0000[diff] [blame]129int spi_erase_at45cs_sector(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Aidan Thorntondb4e87d2013-08-27 18:01:53 +0000[diff] [blame]130
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]131/* 82802ab.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]132uint8_t wait_82802ab(struct flashctx *flash);
133int probe_82802ab(struct flashctx *flash);
134int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]135int 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]136void print_status_82802ab(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]137int unlock_28f004s5(struct flashctx *flash);
138int unlock_lh28f008bjt(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]139
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]140/* jedec.c */
141uint8_t oddparity(uint8_t val);
Stefan Tauner0ab1e5d2014-05-29 11:51:24 +0000[diff] [blame]142void toggle_ready_jedec(const struct flashctx *flash, chipaddr dst);
143void data_polling_jedec(const struct flashctx *flash, chipaddr dst, uint8_t data);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]144int probe_jedec(struct flashctx *flash);
Stefan Tauner03a9c3c2014-08-03 14:15:14 +0000[diff] [blame]145int probe_jedec_29gl(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]146int write_jedec(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
147int 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]148int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
149int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
150int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]151
Carl-Daniel Hailfingeref3ac8a2014-08-03 13:05:34 +0000[diff] [blame]152int unlock_regspace2_uniform_32k(struct flashctx *flash);
153int unlock_regspace2_uniform_64k(struct flashctx *flash);
154int unlock_regspace2_block_eraser_0(struct flashctx *flash);
155int unlock_regspace2_block_eraser_1(struct flashctx *flash);
Carl-Daniel Hailfingeref3ac8a2014-08-03 13:05:34 +0000[diff] [blame]156int printlock_regspace2_uniform_64k(struct flashctx *flash);
157int printlock_regspace2_block_eraser_0(struct flashctx *flash);
158int printlock_regspace2_block_eraser_1(struct flashctx *flash);
159
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]160/* sst28sf040.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]161int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
162int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]163int 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]164int unprotect_28sf040(struct flashctx *flash);
165int protect_28sf040(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]166
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]167/* sst49lfxxxc.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]168int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]169
170/* sst_fwhub.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]171int printlock_sst_fwhub(struct flashctx *flash);
172int unlock_sst_fwhub(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]173
Carl-Daniel Hailfinger91882402010-12-05 16:33:59 +0000[diff] [blame]174/* w39.c */
Kyösti Mälkkic31243e2012-10-28 01:50:08 +0000[diff] [blame]175int printlock_w39f010(struct flashctx * flash);
176int printlock_w39l010(struct flashctx * flash);
177int printlock_w39l020(struct flashctx * flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]178int printlock_w39l040(struct flashctx * flash);
179int printlock_w39v040a(struct flashctx *flash);
180int printlock_w39v040b(struct flashctx *flash);
181int printlock_w39v040c(struct flashctx *flash);
182int printlock_w39v040fa(struct flashctx *flash);
183int printlock_w39v040fb(struct flashctx *flash);
184int printlock_w39v040fc(struct flashctx *flash);
185int printlock_w39v080a(struct flashctx *flash);
186int printlock_w39v080fa(struct flashctx *flash);
187int printlock_w39v080fa_dual(struct flashctx *flash);
David Borgf5a30f62012-04-15 13:16:32 +0000[diff] [blame]188int printlock_at49f(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]189
190/* w29ee011.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]191int probe_w29ee011(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]192
Stefan Tauner4404f732013-09-12 08:28:56 +0000[diff] [blame]193/* stm50.c */
194int erase_sector_stm50(struct flashctx *flash, unsigned int block, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]195
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000[diff] [blame]196/* en29lv640b.c */
197int probe_en29lv640b(struct flashctx *flash);
Mark Marshallf20b7be2014-05-09 21:16:21 +0000[diff] [blame]198int 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]199
Paul Kocialkowski80ae14e2018-01-15 01:07:46 +0300[diff] [blame]200/* edi.c */
201int edi_chip_block_erase(struct flashctx *flash, unsigned int page, unsigned int size);
202int edi_chip_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len);
203int edi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
204int edi_probe_kb9012(struct flashctx *flash);
205
Konstantin Grudnev3d8868c2019-07-23 00:48:54 +0300[diff] [blame]206/* spi95.c */
207int probe_spi_st95(struct flashctx *flash);
208int spi_block_erase_emulation(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
209
Nikolai Artemievc9feb1b2021-10-21 01:35:13 +1100[diff] [blame]210/* writeprotect_ranges.c */
211void decode_range_spi25(size_t *start, size_t *len, const struct wp_bits *, size_t chip_len);
212
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]213#endif /* !__CHIPDRIVERS_H__ */