Gitiles
Code Review Sign In
review.sourcearcade.org / flashprog / 64f53a1c9f5bd11b8b35cff757ac6d4aa37b0c59 / . / include / chipdrivers / spi.h
blob: 16465611eb7bea73b5bc9419e10d3dfc98b98811 [file] [log] [blame]
Nico Huberfbc41d22026-02-22 23:04:01 +0100[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
16#ifndef __CHIPDRIVERS_SPI_H__
17#define __CHIPDRIVERS_SPI_H__ 1
18
19#include <stdint.h>
20
21struct flashprog_flashctx;
Nico Huber43125762023-05-01 15:56:16 +0200[diff] [blame]22struct master_common;
23struct bus_probe;
Nico Huberfbc41d22026-02-22 23:04:01 +0100[diff] [blame]24
25/* spi.c */
26int spi_aai_write(struct flashprog_flashctx *, const uint8_t *buf, unsigned int start, unsigned int len);
27int spi_chip_write_256(struct flashprog_flashctx *, const uint8_t *buf, unsigned int start, unsigned int len);
28int spi_chip_read(struct flashprog_flashctx *, uint8_t *buf, unsigned int start, int unsigned len);
29
30/* spi25.c */
Nico Huber43125762023-05-01 15:56:16 +0200[diff] [blame]31struct found_id *probe_spi_rdid(const struct bus_probe *, const struct master_common *);
Nico Huber64f53a12026-02-15 16:04:29 +0100[diff] [blame^]32struct found_id *probe_spi_rems(const struct bus_probe *, const struct master_common *);
33struct found_id *probe_spi_res(const struct bus_probe *, const struct master_common *);
34struct found_id *probe_spi_at25f(const struct bus_probe *, const struct master_common *);
Nico Huber43125762023-05-01 15:56:16 +0200[diff] [blame]35
Nico Huberfbc41d22026-02-22 23:04:01 +0100[diff] [blame]36int spi_simple_write_cmd(struct flashprog_flashctx *, uint8_t op, unsigned int poll_delay);
Nico Huberfbc41d22026-02-22 23:04:01 +0100[diff] [blame]37int spi_write_enable(struct flashprog_flashctx *);
38int spi_write_disable(struct flashprog_flashctx *);
39int spi_block_erase_20(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
40int spi_block_erase_21(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
41int spi_block_erase_50(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
42int spi_block_erase_52(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
43int spi_block_erase_53(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
44int spi_block_erase_5c(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
45int spi_block_erase_60(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
46int spi_block_erase_62(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
47int spi_block_erase_81(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
48int spi_block_erase_c4(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
49int spi_block_erase_c7(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
50int spi_block_erase_d7(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
51int spi_block_erase_d8(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
52int spi_block_erase_db(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
53int spi_block_erase_dc(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
54int spi_chip_write_1(struct flashprog_flashctx *, const uint8_t *buf, unsigned int start, unsigned int len);
55int spi_nbyte_read(struct flashprog_flashctx *, uint8_t *dst, unsigned int addr, unsigned int len);
56int spi_write_chunked(struct flashprog_flashctx *, const uint8_t *buf, unsigned int start, unsigned int len, unsigned int chunksize);
57int spi_set_extended_address(struct flashprog_flashctx *, uint8_t addr_high);
58
59enum preparation_steps;
60int spi_prepare_io(struct flashprog_flashctx *, enum preparation_steps);
61void spi_finish_io(struct flashprog_flashctx *);
62
63enum flash_reg;
64enum wrsr_target;
65int spi_read_register(const struct flashprog_flashctx *, enum flash_reg reg, uint8_t *value);
66int spi_write_register(const struct flashprog_flashctx *, enum flash_reg reg, uint8_t value, enum wrsr_target);
67void spi_prettyprint_status_register_bit(uint8_t status, int bit);
68int spi_prettyprint_status_register_plain(struct flashprog_flashctx *);
69int spi_prettyprint_status_register_default_welwip(struct flashprog_flashctx *);
70int spi_prettyprint_status_register_bp1_srwd(struct flashprog_flashctx *);
71int spi_prettyprint_status_register_bp2_srwd(struct flashprog_flashctx *);
72int spi_prettyprint_status_register_bp3_srwd(struct flashprog_flashctx *);
73int spi_prettyprint_status_register_bp4_srwd(struct flashprog_flashctx *);
74int spi_prettyprint_status_register_bp2_bpl(struct flashprog_flashctx *);
75int spi_prettyprint_status_register_bp2_tb_bpl(struct flashprog_flashctx *);
76int spi_disable_blockprotect(struct flashprog_flashctx *);
77int spi_disable_blockprotect_bp1_srwd(struct flashprog_flashctx *);
78int spi_disable_blockprotect_bp2_srwd(struct flashprog_flashctx *);
79int spi_disable_blockprotect_bp3_srwd(struct flashprog_flashctx *);
80int spi_disable_blockprotect_bp4_srwd(struct flashprog_flashctx *);
81int spi_prettyprint_status_register_amic_a25l032(struct flashprog_flashctx *);
82int spi_prettyprint_status_register_at25df(struct flashprog_flashctx *);
83int spi_prettyprint_status_register_at25df_sec(struct flashprog_flashctx *);
84int spi_prettyprint_status_register_at25f(struct flashprog_flashctx *);
85int spi_prettyprint_status_register_at25f512a(struct flashprog_flashctx *);
86int spi_prettyprint_status_register_at25f512b(struct flashprog_flashctx *);
87int spi_prettyprint_status_register_at25f4096(struct flashprog_flashctx *);
88int spi_prettyprint_status_register_at25fs010(struct flashprog_flashctx *);
89int spi_prettyprint_status_register_at25fs040(struct flashprog_flashctx *);
90int spi_prettyprint_status_register_at26df081a(struct flashprog_flashctx *);
91int spi_disable_blockprotect_at2x_global_unprotect(struct flashprog_flashctx *);
92int spi_disable_blockprotect_at2x_global_unprotect_sec(struct flashprog_flashctx *);
93int spi_disable_blockprotect_at25f(struct flashprog_flashctx *);
94int spi_disable_blockprotect_at25f512a(struct flashprog_flashctx *);
95int spi_disable_blockprotect_at25f512b(struct flashprog_flashctx *);
96int spi_disable_blockprotect_at25fs010(struct flashprog_flashctx *);
97int spi_disable_blockprotect_at25fs040(struct flashprog_flashctx *);
98int spi_prettyprint_status_register_en25s_wp(struct flashprog_flashctx *);
99int spi_prettyprint_status_register_n25q(struct flashprog_flashctx *);
100int spi_disable_blockprotect_n25q(struct flashprog_flashctx *);
101int spi_prettyprint_status_register_bp2_ep_srwd(struct flashprog_flashctx *);
102int spi_disable_blockprotect_bp2_ep_srwd(struct flashprog_flashctx *);
103int spi_prettyprint_status_register_sst25(struct flashprog_flashctx *);
104int spi_prettyprint_status_register_sst25vf016(struct flashprog_flashctx *);
105int spi_prettyprint_status_register_sst25vf040b(struct flashprog_flashctx *);
106int spi_disable_blockprotect_sst26_global_unprotect(struct flashprog_flashctx *);
107
108/* at45db.c */
109int spi_prepare_at45db(struct flashprog_flashctx *, enum preparation_steps);
110int spi_prettyprint_status_register_at45db(struct flashprog_flashctx *);
111int spi_disable_blockprotect_at45db(struct flashprog_flashctx *);
112int spi_read_at45db(struct flashprog_flashctx *, uint8_t *buf, unsigned int start, unsigned int len);
113int spi_read_at45db_e8(struct flashprog_flashctx *, uint8_t *buf, unsigned int start, unsigned int len);
114int spi_write_at45db(struct flashprog_flashctx *, const uint8_t *buf, unsigned int start, unsigned int len);
115int spi_erase_at45db_page(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
116int spi_erase_at45db_block(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
117int spi_erase_at45db_sector(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
118int spi_erase_at45db_chip(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
119int spi_erase_at45cs_sector(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
120
121/* spi95.c */
122int probe_spi_st95(struct flashprog_flashctx *);
123int spi_block_erase_emulation(struct flashprog_flashctx *, unsigned int addr, unsigned int blocklen);
124
125/* writeprotect_ranges.c */
126struct wp_bits;
127void decode_range_spi25(size_t *start, size_t *len, const struct wp_bits *, size_t chip_len);
128void decode_range_spi25_64k_block(size_t *start, size_t *len, const struct wp_bits *, size_t chip_len);
129void decode_range_spi25_bit_cmp(size_t *start, size_t *len, const struct wp_bits *, size_t chip_len);
130void decode_range_spi25_2x_block(size_t *start, size_t *len, const struct wp_bits *, size_t chip_len);
131
132/* sfdp.c */
133int probe_spi_sfdp(struct flashprog_flashctx *);
134
135#endif /* !__CHIPDRIVERS_SPI_H__ */