blob: b7a7a219999a28c9f5443f5272786c9f376685d3 [file] [log] [blame]
Carl-Daniel Hailfinger70539262007-10-15 21:45:29 +00001/*
2 * This file is part of the flashrom project.
3 *
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +00004 * Copyright (C) 2007, 2008, 2009, 2010, 2011 Carl-Daniel Hailfinger
Stefan Reinauera9424d52008-06-27 16:28:34 +00005 * Copyright (C) 2008 coresystems GmbH
Carl-Daniel Hailfinger70539262007-10-15 21:45:29 +00006 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
Carl-Daniel Hailfinger70539262007-10-15 21:45:29 +000015 */
16
17/*
18 * Contains the generic SPI framework
19 */
20
Patrick Georgi97bc95c2011-03-08 07:17:44 +000021#include <strings.h>
Carl-Daniel Hailfingerec489e42010-09-15 00:13:02 +000022#include <string.h>
Carl-Daniel Hailfinger70539262007-10-15 21:45:29 +000023#include "flash.h"
Carl-Daniel Hailfinger08454642009-06-15 14:14:48 +000024#include "flashchips.h"
Sean Nelson14ba6682010-02-26 05:48:29 +000025#include "chipdrivers.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000026#include "programmer.h"
Carl-Daniel Hailfingerd6cbf762008-05-13 14:58:23 +000027#include "spi.h"
Carl-Daniel Hailfinger70539262007-10-15 21:45:29 +000028
Edward O'Callaghan5eca4272020-04-12 17:27:53 +100029int spi_send_command(const struct flashctx *flash, unsigned int writecnt,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000030 unsigned int readcnt, const unsigned char *writearr,
31 unsigned char *readarr)
Carl-Daniel Hailfinger3d94a0e2007-10-16 21:09:06 +000032{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000033 return flash->mst->spi.command(flash, writecnt, readcnt, writearr,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000034 readarr);
Carl-Daniel Hailfinger3d94a0e2007-10-16 21:09:06 +000035}
36
Edward O'Callaghan5eca4272020-04-12 17:27:53 +100037int spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds)
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +000038{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000039 return flash->mst->spi.multicommand(flash, cmds);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000040}
41
Edward O'Callaghan5eca4272020-04-12 17:27:53 +100042int default_spi_send_command(const struct flashctx *flash, unsigned int writecnt,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000043 unsigned int readcnt,
44 const unsigned char *writearr,
45 unsigned char *readarr)
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000046{
47 struct spi_command cmd[] = {
48 {
49 .writecnt = writecnt,
50 .readcnt = readcnt,
51 .writearr = writearr,
52 .readarr = readarr,
53 }, {
54 .writecnt = 0,
55 .writearr = NULL,
56 .readcnt = 0,
57 .readarr = NULL,
58 }};
59
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000060 return spi_send_multicommand(flash, cmd);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000061}
62
Edward O'Callaghan5eca4272020-04-12 17:27:53 +100063int default_spi_send_multicommand(const struct flashctx *flash,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000064 struct spi_command *cmds)
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000065{
66 int result = 0;
Carl-Daniel Hailfinger26f7e642009-09-18 15:50:56 +000067 for (; (cmds->writecnt || cmds->readcnt) && !result; cmds++) {
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000068 result = spi_send_command(flash, cmds->writecnt, cmds->readcnt,
Carl-Daniel Hailfinger26f7e642009-09-18 15:50:56 +000069 cmds->writearr, cmds->readarr);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000070 }
71 return result;
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +000072}
73
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000074int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start,
75 unsigned int len)
Michael Karcher62797512011-05-11 17:07:02 +000076{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000077 unsigned int max_data = flash->mst->spi.max_data_read;
Michael Karcher62797512011-05-11 17:07:02 +000078 if (max_data == MAX_DATA_UNSPECIFIED) {
Nico Huberac90af62022-12-18 00:22:47 +000079 msg_perr("%s called, but SPI read chunk size not defined on this hardware.\n"
80 "Please report a bug at flashrom-stable@flashrom.org\n", __func__);
Michael Karcher62797512011-05-11 17:07:02 +000081 return 1;
82 }
83 return spi_read_chunked(flash, buf, start, len, max_data);
84}
85
Mark Marshallf20b7be2014-05-09 21:16:21 +000086int default_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Michael Karcher62797512011-05-11 17:07:02 +000087{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000088 unsigned int max_data = flash->mst->spi.max_data_write;
Michael Karcher62797512011-05-11 17:07:02 +000089 if (max_data == MAX_DATA_UNSPECIFIED) {
Nico Huberac90af62022-12-18 00:22:47 +000090 msg_perr("%s called, but SPI write chunk size not defined on this hardware.\n"
91 "Please report a bug at flashrom-stable@flashrom.org\n", __func__);
Michael Karcher62797512011-05-11 17:07:02 +000092 return 1;
93 }
94 return spi_write_chunked(flash, buf, start, len, max_data);
95}
96
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000097int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start,
98 unsigned int len)
Ronald Hoogenboom7ff530b2008-01-19 00:04:46 +000099{
Nico Huberd8b2e802019-06-18 23:39:56 +0200100 int ret;
101 size_t to_read;
102 for (; len; len -= to_read, buf += to_read, start += to_read) {
103 /* Do not cross 16MiB boundaries in a single transfer.
104 This helps with
105 o multi-die 4-byte-addressing chips,
106 o dediprog that has a protocol limit of 32MiB-512B. */
107 to_read = min(ALIGN_DOWN(start + 16*MiB, 16*MiB) - start, len);
108 ret = flash->mst->spi.read(flash, buf, start, to_read);
109 if (ret)
110 return ret;
111 }
112 return 0;
Ronald Hoogenboom7ff530b2008-01-19 00:04:46 +0000113}
114
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000115/*
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000116 * Program chip using page (256 bytes) programming.
117 * Some SPI masters can't do this, they use single byte programming instead.
Carl-Daniel Hailfinger9a795d82010-07-14 16:19:05 +0000118 * The redirect to single byte programming is achieved by setting
119 * .write_256 = spi_chip_write_1
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000120 */
Carl-Daniel Hailfinger9a795d82010-07-14 16:19:05 +0000121/* real chunksize is up to 256, logical chunksize is 256 */
Mark Marshallf20b7be2014-05-09 21:16:21 +0000122int spi_chip_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Carl-Daniel Hailfingerbfe5b4a2008-05-13 23:03:12 +0000123{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000124 return flash->mst->spi.write_256(flash, buf, start, len);
Carl-Daniel Hailfinger9a795d82010-07-14 16:19:05 +0000125}
126
Mark Marshallf20b7be2014-05-09 21:16:21 +0000127int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Nico Huber7bca1262012-06-15 22:28:12 +0000128{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000129 return flash->mst->spi.write_aai(flash, buf, start, len);
Nico Huber7bca1262012-06-15 22:28:12 +0000130}
131
Nico Huber5e08e3e2021-05-11 17:38:14 +0200132int register_spi_master(const struct spi_master *mst, void *data)
Michael Karcherb9dbe482011-05-11 17:07:07 +0000133{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000134 struct registered_master rmst;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000135
Anastasia Klimchuk7783f2f2021-07-05 09:18:06 +1000136 if (mst->shutdown) {
137 if (register_shutdown(mst->shutdown, data)) {
138 mst->shutdown(data); /* cleanup */
139 return 1;
140 }
141 }
142
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000143 if (!mst->write_aai || !mst->write_256 || !mst->read || !mst->command ||
144 !mst->multicommand ||
145 ((mst->command == default_spi_send_command) &&
146 (mst->multicommand == default_spi_send_multicommand))) {
Nico Huberac90af62022-12-18 00:22:47 +0000147 msg_perr("%s called with incomplete master definition.\n"
148 "Please report a bug at flashrom-stable@flashrom.org\n",
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000149 __func__);
150 return ERROR_FLASHROM_BUG;
151 }
152
153
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000154 rmst.buses_supported = BUS_SPI;
155 rmst.spi = *mst;
Nico Huber5e08e3e2021-05-11 17:38:14 +0200156 if (data)
157 rmst.spi.data = data;
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000158 return register_master(&rmst);
Stefan Tauner93f70232011-07-26 14:33:46 +0000159}