Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / 78ffbeaa029fb827dcdf9c02262adbda4673e5eb / . / chipdrivers.h
blob: f11080775f8c174efd5755e990aef99a071ca07c [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 */
31int spi_aai_write(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
32int spi_chip_write_256(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
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);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]41int spi_write_enable(struct flashctx *flash);
42int spi_write_disable(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]43int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner94b39b42012-10-27 00:06:02 +0000[diff] [blame]44int spi_block_erase_50(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]45int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner94b39b42012-10-27 00:06:02 +0000[diff] [blame]46int spi_block_erase_81(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]47int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
48int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
49int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner3c0fcd02012-09-21 12:46:56 +0000[diff] [blame]50int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]51int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000[diff] [blame]52erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]53int spi_chip_write_1(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]54uint8_t spi_read_status_register(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]55int spi_write_status_register(struct flashctx *flash, int status);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +0000[diff] [blame]56void spi_prettyprint_status_register_bit(uint8_t status, int bit);
Stefan Tauner1ba08f62012-08-02 23:51:28 +0000[diff] [blame]57void spi_prettyprint_status_register_bp(uint8_t status, int bp);
Stefan Tauner5609f9d2012-09-22 01:38:06 +0000[diff] [blame]58void spi_prettyprint_status_register_srwd(uint8_t status);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +0000[diff] [blame]59void spi_prettyprint_status_register_welwip(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]60int spi_prettyprint_status_register(struct flashctx *flash);
61int spi_disable_blockprotect(struct flashctx *flash);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]62int spi_byte_program(struct flashctx *flash, unsigned int addr, uint8_t databyte);
63int spi_nbyte_program(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
64int 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]65int spi_read_chunked(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
66int spi_write_chunked(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]67
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000[diff] [blame]68/* sfdp.c */
69int probe_spi_sfdp(struct flashctx *flash);
70
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000[diff] [blame]71/* opaque.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]72int probe_opaque(struct flashctx *flash);
73int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
74int write_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
75int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +0000[diff] [blame]76
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +0000[diff] [blame]77/* a25.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]78int spi_prettyprint_status_register_amic_a25l05p(struct flashctx *flash);
79int spi_prettyprint_status_register_amic_a25l40p(struct flashctx *flash);
80int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
81int spi_prettyprint_status_register_amic_a25lq032(struct flashctx *flash);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +0000[diff] [blame]82
83/* at25.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]84int spi_prettyprint_status_register_at25df(struct flashctx *flash);
85int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
Stefan Tauner7bf4ed92012-08-26 21:04:27 +0000[diff] [blame]86int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]87int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
88int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
89int spi_prettyprint_status_register_atmel_at26df081a(struct flashctx *flash);
90int spi_disable_blockprotect_at25df(struct flashctx *flash);
91int spi_disable_blockprotect_at25df_sec(struct flashctx *flash);
Stefan Tauner7bf4ed92012-08-26 21:04:27 +0000[diff] [blame]92int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]93int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
94int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +0000[diff] [blame]95
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]96/* 82802ab.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]97uint8_t wait_82802ab(struct flashctx *flash);
98int probe_82802ab(struct flashctx *flash);
99int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
100int write_82802ab(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Sean Nelson28accc22010-03-19 18:47:06 +0000[diff] [blame]101void print_status_82802ab(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]102int unlock_82802ab(struct flashctx *flash);
103int unlock_28f004s5(struct flashctx *flash);
104int unlock_lh28f008bjt(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]105
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]106/* jedec.c */
107uint8_t oddparity(uint8_t val);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]108void toggle_ready_jedec(struct flashctx *flash, chipaddr dst);
109void data_polling_jedec(struct flashctx *flash, chipaddr dst, uint8_t data);
110int write_byte_program_jedec(struct flashctx *flash, chipaddr bios, uint8_t *src,
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]111 chipaddr dst);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]112int probe_jedec(struct flashctx *flash);
113int write_jedec(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
114int write_jedec_1(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
115int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
116int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
117int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]118
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]119/* m29f400bt.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]120int probe_m29f400bt(struct flashctx *flash);
121int block_erase_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
122int block_erase_chip_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
123int write_m29f400bt(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000[diff] [blame]124void protect_m29f400bt(struct flashctx *flash, chipaddr bios);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]125
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]126/* pm49fl00x.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]127int unlock_49fl00x(struct flashctx *flash);
128int lock_49fl00x(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]129
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]130/* sst28sf040.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]131int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
132int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
133int write_28sf040(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
134int unprotect_28sf040(struct flashctx *flash);
135int protect_28sf040(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]136
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]137/* sst49lfxxxc.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]138int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
139int unlock_49lfxxxc(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]140
141/* sst_fwhub.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]142int printlock_sst_fwhub(struct flashctx *flash);
143int unlock_sst_fwhub(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]144
Carl-Daniel Hailfinger91882402010-12-05 16:33:59 +0000[diff] [blame]145/* w39.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]146int printlock_w39l040(struct flashctx * flash);
147int printlock_w39v040a(struct flashctx *flash);
148int printlock_w39v040b(struct flashctx *flash);
149int printlock_w39v040c(struct flashctx *flash);
150int printlock_w39v040fa(struct flashctx *flash);
151int printlock_w39v040fb(struct flashctx *flash);
152int printlock_w39v040fc(struct flashctx *flash);
153int printlock_w39v080a(struct flashctx *flash);
154int printlock_w39v080fa(struct flashctx *flash);
155int printlock_w39v080fa_dual(struct flashctx *flash);
156int unlock_w39v040fb(struct flashctx *flash);
157int unlock_w39v080fa(struct flashctx *flash);
David Borgf5a30f62012-04-15 13:16:32 +0000[diff] [blame]158int printlock_at49f(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]159
160/* w29ee011.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]161int probe_w29ee011(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]162
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]163/* stm50flw0x0x.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000[diff] [blame]164int erase_sector_stm50flw0x0x(struct flashctx *flash, unsigned int block, unsigned int blocksize);
165int unlock_stm50flw0x0x(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]166
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000[diff] [blame]167/* en29lv640b.c */
168int probe_en29lv640b(struct flashctx *flash);
169int block_erase_en29lv640b(struct flashctx *flash, unsigned int start, unsigned int len);
170int block_erase_chip_en29lv640b(struct flashctx *flash, unsigned int start, unsigned int len);
171int write_en29lv640b(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
172
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000[diff] [blame]173#endif /* !__CHIPDRIVERS_H__ */