blob: 56f1fdf52f6ce12c656513b8b8f0fa5457c056e8 [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.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21/*
22 * Contains the generic SPI framework
23 */
24
Patrick Georgi97bc95c2011-03-08 07:17:44 +000025#include <strings.h>
Carl-Daniel Hailfingerec489e42010-09-15 00:13:02 +000026#include <string.h>
Carl-Daniel Hailfinger70539262007-10-15 21:45:29 +000027#include "flash.h"
Carl-Daniel Hailfinger08454642009-06-15 14:14:48 +000028#include "flashchips.h"
Sean Nelson14ba6682010-02-26 05:48:29 +000029#include "chipdrivers.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000030#include "programmer.h"
Carl-Daniel Hailfingerd6cbf762008-05-13 14:58:23 +000031#include "spi.h"
Carl-Daniel Hailfinger70539262007-10-15 21:45:29 +000032
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000033int spi_send_command(struct flashctx *flash, unsigned int writecnt,
34 unsigned int readcnt, const unsigned char *writearr,
35 unsigned char *readarr)
Carl-Daniel Hailfinger3d94a0e2007-10-16 21:09:06 +000036{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000037 return flash->mst->spi.command(flash, writecnt, readcnt, writearr,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000038 readarr);
Carl-Daniel Hailfinger3d94a0e2007-10-16 21:09:06 +000039}
40
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000041int spi_send_multicommand(struct flashctx *flash, struct spi_command *cmds)
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +000042{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000043 return flash->mst->spi.multicommand(flash, cmds);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000044}
45
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000046int default_spi_send_command(struct flashctx *flash, unsigned int writecnt,
47 unsigned int readcnt,
48 const unsigned char *writearr,
49 unsigned char *readarr)
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000050{
51 struct spi_command cmd[] = {
52 {
53 .writecnt = writecnt,
54 .readcnt = readcnt,
55 .writearr = writearr,
56 .readarr = readarr,
57 }, {
58 .writecnt = 0,
59 .writearr = NULL,
60 .readcnt = 0,
61 .readarr = NULL,
62 }};
63
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000064 return spi_send_multicommand(flash, cmd);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000065}
66
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000067int default_spi_send_multicommand(struct flashctx *flash,
68 struct spi_command *cmds)
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000069{
70 int result = 0;
Carl-Daniel Hailfinger26f7e642009-09-18 15:50:56 +000071 for (; (cmds->writecnt || cmds->readcnt) && !result; cmds++) {
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000072 result = spi_send_command(flash, cmds->writecnt, cmds->readcnt,
Carl-Daniel Hailfinger26f7e642009-09-18 15:50:56 +000073 cmds->writearr, cmds->readarr);
Carl-Daniel Hailfinger02487aa2009-07-22 15:36:50 +000074 }
75 return result;
Carl-Daniel Hailfingerd0478292009-07-10 21:08:55 +000076}
77
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000078int default_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start,
79 unsigned int len)
Michael Karcher62797512011-05-11 17:07:02 +000080{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000081 unsigned int max_data = flash->mst->spi.max_data_read;
Michael Karcher62797512011-05-11 17:07:02 +000082 if (max_data == MAX_DATA_UNSPECIFIED) {
83 msg_perr("%s called, but SPI read chunk size not defined "
84 "on this hardware. Please report a bug at "
85 "flashrom@flashrom.org\n", __func__);
86 return 1;
87 }
88 return spi_read_chunked(flash, buf, start, len, max_data);
89}
90
Mark Marshallf20b7be2014-05-09 21:16:21 +000091int default_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Michael Karcher62797512011-05-11 17:07:02 +000092{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000093 unsigned int max_data = flash->mst->spi.max_data_write;
Michael Karcher62797512011-05-11 17:07:02 +000094 if (max_data == MAX_DATA_UNSPECIFIED) {
95 msg_perr("%s called, but SPI write chunk size not defined "
96 "on this hardware. Please report a bug at "
97 "flashrom@flashrom.org\n", __func__);
98 return 1;
99 }
100 return spi_write_chunked(flash, buf, start, len, max_data);
101}
102
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000103int spi_chip_read(struct flashctx *flash, uint8_t *buf, unsigned int start,
104 unsigned int len)
Ronald Hoogenboom7ff530b2008-01-19 00:04:46 +0000105{
Nico Hubered098d62017-04-21 23:47:08 +0200106 return flash->mst->spi.read(flash, buf, start, len);
Ronald Hoogenboom7ff530b2008-01-19 00:04:46 +0000107}
108
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000109/*
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000110 * Program chip using page (256 bytes) programming.
111 * Some SPI masters can't do this, they use single byte programming instead.
Carl-Daniel Hailfinger9a795d82010-07-14 16:19:05 +0000112 * The redirect to single byte programming is achieved by setting
113 * .write_256 = spi_chip_write_1
Carl-Daniel Hailfinger96930c32009-05-09 02:30:21 +0000114 */
Carl-Daniel Hailfinger9a795d82010-07-14 16:19:05 +0000115/* real chunksize is up to 256, logical chunksize is 256 */
Mark Marshallf20b7be2014-05-09 21:16:21 +0000116int 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 +0000117{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000118 return flash->mst->spi.write_256(flash, buf, start, len);
Carl-Daniel Hailfinger9a795d82010-07-14 16:19:05 +0000119}
120
Mark Marshallf20b7be2014-05-09 21:16:21 +0000121int spi_aai_write(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Nico Huber7bca1262012-06-15 22:28:12 +0000122{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000123 return flash->mst->spi.write_aai(flash, buf, start, len);
Nico Huber7bca1262012-06-15 22:28:12 +0000124}
125
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000126int register_spi_master(const struct spi_master *mst)
Michael Karcherb9dbe482011-05-11 17:07:07 +0000127{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000128 struct registered_master rmst;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000129
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000130 if (!mst->write_aai || !mst->write_256 || !mst->read || !mst->command ||
131 !mst->multicommand ||
132 ((mst->command == default_spi_send_command) &&
133 (mst->multicommand == default_spi_send_multicommand))) {
134 msg_perr("%s called with incomplete master definition. "
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000135 "Please report a bug at flashrom@flashrom.org\n",
136 __func__);
137 return ERROR_FLASHROM_BUG;
138 }
139
140
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000141 rmst.buses_supported = BUS_SPI;
142 rmst.spi = *mst;
143 return register_master(&rmst);
Stefan Tauner93f70232011-07-26 14:33:46 +0000144}