blob: b8af62a510a3bdb32131b18ca927d34a05fcfcc8 [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
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +000030/* spi.c, should probably be in spi_chip.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);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000036int spi_write_enable(struct flashctx *flash);
37int spi_write_disable(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000038int spi_block_erase_20(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
39int spi_block_erase_52(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
40int spi_block_erase_d7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
41int spi_block_erase_d8(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
42int spi_block_erase_60(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Tauner3c0fcd02012-09-21 12:46:56 +000043int spi_block_erase_62(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000044int spi_block_erase_c7(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
Stefan Taunerac1b4c82012-02-17 14:51:04 +000045erasefunc_t *spi_get_erasefn_from_opcode(uint8_t opcode);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000046int spi_chip_write_1(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
47int spi_chip_write_256(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
48int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start, int unsigned len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000049uint8_t spi_read_status_register(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000050int spi_write_status_register(struct flashctx *flash, int status);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +000051void spi_prettyprint_status_register_bit(uint8_t status, int bit);
Stefan Tauner1ba08f62012-08-02 23:51:28 +000052void spi_prettyprint_status_register_bp(uint8_t status, int bp);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +000053void spi_prettyprint_status_register_welwip(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000054int spi_prettyprint_status_register(struct flashctx *flash);
55int spi_disable_blockprotect(struct flashctx *flash);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000056int spi_byte_program(struct flashctx *flash, unsigned int addr, uint8_t databyte);
57int spi_nbyte_program(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
58int spi_nbyte_read(struct flashctx *flash, unsigned int addr, uint8_t *bytes, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000059int spi_read_chunked(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
60int spi_write_chunked(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
61int spi_aai_write(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +000062
Stefan Taunerac1b4c82012-02-17 14:51:04 +000063/* sfdp.c */
64int probe_spi_sfdp(struct flashctx *flash);
65
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +000066/* opaque.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000067int probe_opaque(struct flashctx *flash);
68int read_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
69int write_opaque(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
70int erase_opaque(struct flashctx *flash, unsigned int blockaddr, unsigned int blocklen);
Carl-Daniel Hailfinger532c7172011-11-04 21:35:26 +000071
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +000072/* a25.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000073int spi_prettyprint_status_register_amic_a25l05p(struct flashctx *flash);
74int spi_prettyprint_status_register_amic_a25l40p(struct flashctx *flash);
75int spi_prettyprint_status_register_amic_a25l032(struct flashctx *flash);
76int spi_prettyprint_status_register_amic_a25lq032(struct flashctx *flash);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +000077
78/* at25.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000079int spi_prettyprint_status_register_at25df(struct flashctx *flash);
80int spi_prettyprint_status_register_at25df_sec(struct flashctx *flash);
Stefan Tauner7bf4ed92012-08-26 21:04:27 +000081int spi_prettyprint_status_register_at25f512b(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000082int spi_prettyprint_status_register_at25fs010(struct flashctx *flash);
83int spi_prettyprint_status_register_at25fs040(struct flashctx *flash);
84int spi_prettyprint_status_register_atmel_at26df081a(struct flashctx *flash);
85int spi_disable_blockprotect_at25df(struct flashctx *flash);
86int spi_disable_blockprotect_at25df_sec(struct flashctx *flash);
Stefan Tauner7bf4ed92012-08-26 21:04:27 +000087int spi_disable_blockprotect_at25f512b(struct flashctx *flash);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000088int spi_disable_blockprotect_at25fs010(struct flashctx *flash);
89int spi_disable_blockprotect_at25fs040(struct flashctx *flash);
Carl-Daniel Hailfinger7a3bd8f2011-05-19 00:06:06 +000090
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +000091/* 82802ab.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000092uint8_t wait_82802ab(struct flashctx *flash);
93int probe_82802ab(struct flashctx *flash);
94int erase_block_82802ab(struct flashctx *flash, unsigned int page, unsigned int pagesize);
95int write_82802ab(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Sean Nelson28accc22010-03-19 18:47:06 +000096void print_status_82802ab(uint8_t status);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000097int unlock_82802ab(struct flashctx *flash);
98int unlock_28f004s5(struct flashctx *flash);
99int unlock_lh28f008bjt(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000100
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000101/* jedec.c */
102uint8_t oddparity(uint8_t val);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000103void toggle_ready_jedec(struct flashctx *flash, chipaddr dst);
104void data_polling_jedec(struct flashctx *flash, chipaddr dst, uint8_t data);
105int write_byte_program_jedec(struct flashctx *flash, chipaddr bios, uint8_t *src,
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000106 chipaddr dst);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000107int probe_jedec(struct flashctx *flash);
108int write_jedec(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
109int write_jedec_1(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
110int erase_sector_jedec(struct flashctx *flash, unsigned int page, unsigned int pagesize);
111int erase_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
112int erase_chip_block_jedec(struct flashctx *flash, unsigned int page, unsigned int blocksize);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000113
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000114/* m29f400bt.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000115int probe_m29f400bt(struct flashctx *flash);
116int block_erase_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
117int block_erase_chip_m29f400bt(struct flashctx *flash, unsigned int start, unsigned int len);
118int write_m29f400bt(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000119void protect_m29f400bt(struct flashctx *flash, chipaddr bios);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000120
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000121/* pm49fl00x.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000122int unlock_49fl00x(struct flashctx *flash);
123int lock_49fl00x(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000124
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000125/* sst28sf040.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000126int erase_chip_28sf040(struct flashctx *flash, unsigned int addr, unsigned int blocklen);
127int erase_sector_28sf040(struct flashctx *flash, unsigned int address, unsigned int sector_size);
128int write_28sf040(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
129int unprotect_28sf040(struct flashctx *flash);
130int protect_28sf040(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000131
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000132/* sst49lfxxxc.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000133int erase_sector_49lfxxxc(struct flashctx *flash, unsigned int address, unsigned int sector_size);
134int unlock_49lfxxxc(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000135
136/* sst_fwhub.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000137int printlock_sst_fwhub(struct flashctx *flash);
138int unlock_sst_fwhub(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000139
Carl-Daniel Hailfinger91882402010-12-05 16:33:59 +0000140/* w39.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000141int printlock_w39l040(struct flashctx * flash);
142int printlock_w39v040a(struct flashctx *flash);
143int printlock_w39v040b(struct flashctx *flash);
144int printlock_w39v040c(struct flashctx *flash);
145int printlock_w39v040fa(struct flashctx *flash);
146int printlock_w39v040fb(struct flashctx *flash);
147int printlock_w39v040fc(struct flashctx *flash);
148int printlock_w39v080a(struct flashctx *flash);
149int printlock_w39v080fa(struct flashctx *flash);
150int printlock_w39v080fa_dual(struct flashctx *flash);
151int unlock_w39v040fb(struct flashctx *flash);
152int unlock_w39v080fa(struct flashctx *flash);
David Borgf5a30f62012-04-15 13:16:32 +0000153int printlock_at49f(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000154
155/* w29ee011.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000156int probe_w29ee011(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000157
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000158/* stm50flw0x0x.c */
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000159int erase_sector_stm50flw0x0x(struct flashctx *flash, unsigned int block, unsigned int blocksize);
160int unlock_stm50flw0x0x(struct flashctx *flash);
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000161
Rudolf Marek47eff6b2012-04-14 22:51:40 +0000162/* en29lv640b.c */
163int probe_en29lv640b(struct flashctx *flash);
164int block_erase_en29lv640b(struct flashctx *flash, unsigned int start, unsigned int len);
165int block_erase_chip_en29lv640b(struct flashctx *flash, unsigned int start, unsigned int len);
166int write_en29lv640b(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len);
167
Carl-Daniel Hailfinger5d5c0722009-12-14 03:32:24 +0000168#endif /* !__CHIPDRIVERS_H__ */