1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/*
* This file is part of the flashrom project.
*
* Copyright (C) 2007, 2008, 2009, 2010, 2011 Carl-Daniel Hailfinger
* Copyright (C) 2008 coresystems GmbH
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
/*
* Contains the generic SPI framework
*/
#include <strings.h>
#include <string.h>
#include "flash.h"
#include "flashchips.h"
#include "chipdrivers.h"
#include "programmer.h"
#include "spi.h"
static int default_spi_send_command(const struct flashctx *flash, unsigned int writecnt,
unsigned int readcnt,
const unsigned char *writearr,
unsigned char *readarr)
{
struct spi_command cmd[] = {
{
.writecnt = writecnt,
.readcnt = readcnt,
.writearr = writearr,
.readarr = readarr,
}, {
.writecnt = 0,
.writearr = NULL,
.readcnt = 0,
.readarr = NULL,
}};
return spi_send_multicommand(flash, cmd);
}
static int default_spi_send_multicommand(const struct flashctx *flash,
struct spi_command *cmds)
{
int result = 0;
for (; (cmds->writecnt || cmds->readcnt) && !result; cmds++) {
result = spi_send_command(flash, cmds->writecnt, cmds->readcnt,
cmds->writearr, cmds->readarr);
}
return result;
}
int spi_send_command(const struct flashctx *flash, unsigned int writecnt,
unsigned int readcnt, const unsigned char *writearr,
unsigned char *readarr)
{
if (flash->mst->spi.command)
return flash->mst->spi.command(flash, writecnt, readcnt, writearr, readarr);
return default_spi_send_command(flash, writecnt, readcnt, writearr, readarr);
}
int spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds)
{
if (flash->mst->spi.multicommand)
return flash->mst->spi.multicommand(flash, cmds);
return default_spi_send_multicommand(flash, cmds);
}
int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start,
unsigned int len)
{
unsigned int max_data = flash->mst->spi.max_data_read;
if (max_data == MAX_DATA_UNSPECIFIED) {
msg_perr("%s called, but SPI read chunk size not defined "
"on this hardware. Please report a bug at "
"flashrom@flashrom.org\n", __func__);
return 1;
}
return spi_read_chunked(flash, buf, start, len, max_data);
}
int default_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
{
unsigned int max_data = flash->mst->spi.max_data_write;
if (max_data == MAX_DATA_UNSPECIFIED) {
msg_perr("%s called, but SPI write chunk size not defined "
"on this hardware. Please report a bug at "
"flashrom@flashrom.org\n", __func__);
return 1;
}
return spi_write_chunked(flash, buf, start, len, max_data);
}
int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start,
unsigned int len)
{
int ret;
size_t to_read;
size_t start_address = start;
size_t end_address = len - start;
for (; len; len -= to_read, buf += to_read, start += to_read) {
/* Do not cross 16MiB boundaries in a single transfer.
This helps with
o multi-die 4-byte-addressing chips,
o dediprog that has a protocol limit of 32MiB-512B. */
to_read = min(ALIGN_DOWN(start + 16*MiB, 16*MiB) - start, len);
ret = flash->mst->spi.read(flash, buf, start, to_read);
if (ret)
return ret;
update_progress(flash, FLASHROM_PROGRESS_READ, start - start_address + to_read, end_address);
}
return 0;
}
/*
* Program chip using page (256 bytes) programming.
* Some SPI masters can't do this, they use single byte programming instead.
* The redirect to single byte programming is achieved by setting
* .write_256 = spi_chip_write_1
*/
/* real chunksize is up to 256, logical chunksize is 256 */
int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
{
return flash->mst->spi.write_256(flash, buf, start, len);
}
int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
{
if (flash->mst->spi.write_aai)
return flash->mst->spi.write_aai(flash, buf, start, len);
return default_spi_write_aai(flash, buf, start, len);
}
bool spi_probe_opcode(const struct flashctx *flash, uint8_t opcode)
{
if (!flash->mst->spi.probe_opcode)
return true; /* no probe_opcode implies default of supported. */
return flash->mst->spi.probe_opcode(flash, opcode);
}
int register_spi_master(const struct spi_master *mst, void *data)
{
struct registered_master rmst = {0};
if (mst->shutdown) {
if (register_shutdown(mst->shutdown, data)) {
mst->shutdown(data); /* cleanup */
return 1;
}
}
if (!mst->write_256 || !mst->read || (!mst->command && !mst->multicommand)) {
msg_perr("%s called with incomplete master definition. "
"Please report a bug at flashrom@flashrom.org\n",
__func__);
return ERROR_FLASHROM_BUG;
}
rmst.buses_supported = BUS_SPI;
rmst.spi = *mst;
if (data)
rmst.spi.data = data;
return register_master(&rmst);
}
/*
* The following array has erasefn and opcode list pair. The opcode list pair is
* 0 termintated and must have size one more than the maximum number of opcodes
* used by any erasefn. Also the opcodes must be in increasing order.
*/
static const struct {
enum block_erase_func func;
uint8_t opcode[3];
} function_opcode_list[] = {
{SPI_BLOCK_ERASE_20, {0x20}},
{SPI_BLOCK_ERASE_21, {0x21}},
{SPI_BLOCK_ERASE_50, {0x50}},
{SPI_BLOCK_ERASE_52, {0x52}},
{SPI_BLOCK_ERASE_53, {0x53}},
{SPI_BLOCK_ERASE_5C, {0x5c}},
{SPI_BLOCK_ERASE_60, {0x60}},
{SPI_BLOCK_ERASE_62, {0x62}},
{SPI_BLOCK_ERASE_81, {0x81}},
{SPI_BLOCK_ERASE_C4, {0xc4}},
{SPI_BLOCK_ERASE_C7, {0xc7}},
{SPI_BLOCK_ERASE_D7, {0xd7}},
{SPI_BLOCK_ERASE_D8, {0xd8}},
{SPI_BLOCK_ERASE_DB, {0xdb}},
{SPI_BLOCK_ERASE_DC, {0xdc}},
//AT45CS1282
{SPI_ERASE_AT45CS_SECTOR, {0x50, 0x7c, 0}},
//AT45DB**
{SPI_ERASE_AT45DB_PAGE, {0x81}},
{SPI_ERASE_AT45DB_BLOCK, {0x50}},
{SPI_ERASE_AT45DB_SECTOR, {0x7c}},
{SPI_ERASE_AT45DB_CHIP, {0xc7}},
//SF25F**
{S25FL_BLOCK_ERASE, {0xdc}},
{S25FS_BLOCK_ERASE_D8, {0xd8}},
};
/*
* @brief Get erase function pointer from passed opcode list.
*
* Get the pointer to the erase function which uses passed opcodes and is used
* by the passed flashcip. The passed opcode_list must have opcodes in
* increasing order.
*
* @param chip Pointer to the flashchip structure.
* @param opcode_list Pointer to the array of opcodes.
* @param opcode_count Number of opcodes in 'opcode_list'
*
* @result Pointer to erase function matching 'chip' and 'opcode_list' or NULL on failure
*/
const uint8_t *spi_get_opcode_from_erasefn(enum block_erase_func func)
{
size_t i;
for (i = 0; i < ARRAY_SIZE(function_opcode_list); i++) {
if (function_opcode_list[i].func == func)
return function_opcode_list[i].opcode;
}
msg_cinfo("%s: unknown erase function (0x%d). Please report "
"this at flashrom@flashrom.org\n", __func__, func);
return NULL;
}
|