blob: b1911fea43c11d0e33a06691ea29c341cbaf812e [file] [log] [blame]
Sven Schnelle5ce5f702011-09-03 18:37:52 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2011 Sven Schnelle <svens@stackframe.org>
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.
Sven Schnelle5ce5f702011-09-03 18:37:52 +000014 */
15
16#include <stdio.h>
17#include <string.h>
18#include <stdlib.h>
Nico Huber9cecc7e2018-12-22 00:08:50 +010019#include <stdint.h>
20#include <inttypes.h>
Gwenhael Goavec-Merou8cd0c732015-11-14 02:55:12 +000021#include <fcntl.h>
Sven Schnelle5ce5f702011-09-03 18:37:52 +000022#include <errno.h>
23#include <ctype.h>
24#include <unistd.h>
Gwenhael Goavec-Merou8cd0c732015-11-14 02:55:12 +000025#include <sys/ioctl.h>
Stefan Tauner8868db32012-03-13 00:18:19 +000026#include <linux/types.h>
Sven Schnelle5ce5f702011-09-03 18:37:52 +000027#include "flash.h"
28#include "chipdrivers.h"
29#include "programmer.h"
30#include "spi.h"
Fabrice Fontainee0ceedf2019-07-17 19:04:12 +020031/*
32 * Linux versions prior to v4.14-rc7 may need linux/ioctl.h included here due
33 * to missing from linux/spi/spidev.h. This was fixed in the following commit:
34 * a2b4a79b88b2 spi: uapi: spidev: add missing ioctl header
35 */
36#include <linux/ioctl.h>
37#include <linux/spi/spidev.h>
Sven Schnelle5ce5f702011-09-03 18:37:52 +000038
Stefan Tauner23e10b82016-01-23 16:16:49 +000039/* Devices known to work with this module (FIXME: export as struct dev_entry):
40 * Beagle Bone Black
41 * Raspberry Pi
42 * HummingBoard
43 */
44
Keno Fischer1f33cb52015-11-15 14:58:25 +000045#define BUF_SIZE_FROM_SYSFS "/sys/module/spidev/parameters/bufsiz"
Anastasia Klimchuk84f03922021-04-13 11:26:25 +100046
47struct linux_spi_data {
48 int fd;
49 size_t max_kernel_buf_size;
50};
Sven Schnelle5ce5f702011-09-03 18:37:52 +000051
52static int linux_spi_shutdown(void *data);
Edward O'Callaghan5eca4272020-04-12 17:27:53 +100053static int linux_spi_send_command(const struct flashctx *flash, unsigned int writecnt,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000054 unsigned int readcnt,
55 const unsigned char *txbuf,
56 unsigned char *rxbuf);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000057static int linux_spi_read(struct flashctx *flash, uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +000058 unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +000059static int linux_spi_write_256(struct flashctx *flash, const uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +000060 unsigned int start, unsigned int len);
Sven Schnelle5ce5f702011-09-03 18:37:52 +000061
Nico Huber03f3a6d2021-05-11 17:53:34 +020062static const struct spi_master spi_master_linux = {
Nico Huber1cf407b2017-11-10 20:18:23 +010063 .features = SPI_MASTER_4BA,
Sven Schnelle5ce5f702011-09-03 18:37:52 +000064 .max_data_read = MAX_DATA_UNSPECIFIED, /* TODO? */
65 .max_data_write = MAX_DATA_UNSPECIFIED, /* TODO? */
66 .command = linux_spi_send_command,
67 .multicommand = default_spi_send_multicommand,
68 .read = linux_spi_read,
69 .write_256 = linux_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +000070 .write_aai = default_spi_write_aai,
Anastasia Klimchukc63d9182021-07-06 16:18:44 +100071 .shutdown = linux_spi_shutdown,
Sven Schnelle5ce5f702011-09-03 18:37:52 +000072};
73
Anastasia Klimchukc19ef9b2021-04-12 16:52:58 +100074/* Read max buffer size from sysfs, or use page size as fallback. */
Anastasia Klimchuk2a329662021-04-19 11:12:01 +100075static size_t get_max_kernel_buf_size()
76{
Anastasia Klimchukc19ef9b2021-04-12 16:52:58 +100077 size_t result = 0;
78 FILE *fp;
79 fp = fopen(BUF_SIZE_FROM_SYSFS, "r");
80 if (!fp) {
81 msg_pwarn("Cannot open %s: %s.\n", BUF_SIZE_FROM_SYSFS, strerror(errno));
82 goto out;
83 }
84
85 char buf[10];
86 if (!fgets(buf, sizeof(buf), fp)) {
87 if (feof(fp))
88 msg_pwarn("Cannot read %s: file is empty.\n", BUF_SIZE_FROM_SYSFS);
89 else
90 msg_pwarn("Cannot read %s: %s.\n", BUF_SIZE_FROM_SYSFS, strerror(errno));
91 goto out;
92 }
93
94 long int tmp;
95 errno = 0;
96 tmp = strtol(buf, NULL, 0);
97 if ((tmp < 0) || errno) {
98 msg_pwarn("Buffer size %ld from %s seems wrong.\n", tmp, BUF_SIZE_FROM_SYSFS);
99 } else {
100 msg_pdbg("%s: Using value from %s as max buffer size.\n", __func__, BUF_SIZE_FROM_SYSFS);
101 result = (size_t)tmp;
102 }
103
104out:
105 if (fp)
106 fclose(fp);
107
108 if (!result) {
109 msg_pdbg("%s: Using page size as max buffer size.\n", __func__);
110 result = (size_t)getpagesize();
111 }
112 return result;
113}
114
Thomas Heijligencc853d82021-05-04 15:32:17 +0200115static int linux_spi_init(void)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000116{
117 char *p, *endp, *dev;
Nico Huber9cecc7e2018-12-22 00:08:50 +0100118 uint32_t speed_hz = 2 * 1000 * 1000;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000119 /* FIXME: make the following configurable by CLI options. */
120 /* SPI mode 0 (beware this also includes: MSB first, CS active low and others */
121 const uint8_t mode = SPI_MODE_0;
122 const uint8_t bits = 8;
Anastasia Klimchuk2a329662021-04-19 11:12:01 +1000123 int fd;
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000124 size_t max_kernel_buf_size;
125 struct linux_spi_data *spi_data;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000126
Stefan Tauner0554ca52013-07-25 22:54:25 +0000127 p = extract_programmer_param("spispeed");
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000128 if (p && strlen(p)) {
Alexandru Gagniuc69dd09d2014-03-19 17:17:06 +0000129 speed_hz = (uint32_t)strtoul(p, &endp, 10) * 1000;
Nico Huber9cecc7e2018-12-22 00:08:50 +0100130 if (p == endp || speed_hz == 0) {
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000131 msg_perr("%s: invalid clock: %s kHz\n", __func__, p);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000132 free(p);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000133 return 1;
134 }
Nico Huber9cecc7e2018-12-22 00:08:50 +0100135 } else {
136 msg_pinfo("Using default %"PRIu32
137 "kHz clock. Use 'spispeed' parameter to override.\n",
138 speed_hz / 1000);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000139 }
Stefan Tauner0554ca52013-07-25 22:54:25 +0000140 free(p);
141
142 dev = extract_programmer_param("dev");
143 if (!dev || !strlen(dev)) {
144 msg_perr("No SPI device given. Use flashrom -p "
145 "linux_spi:dev=/dev/spidevX.Y\n");
146 free(dev);
147 return 1;
148 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000149
Sven Schnellecb24ddb2011-09-07 20:48:34 +0000150 msg_pdbg("Using device %s\n", dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000151 if ((fd = open(dev, O_RDWR)) == -1) {
152 msg_perr("%s: failed to open %s: %s\n", __func__,
153 dev, strerror(errno));
Stefan Tauner0554ca52013-07-25 22:54:25 +0000154 free(dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000155 return 1;
156 }
Stefan Tauner0554ca52013-07-25 22:54:25 +0000157 free(dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000158
Nico Huber9cecc7e2018-12-22 00:08:50 +0100159 if (ioctl(fd, SPI_IOC_WR_MAX_SPEED_HZ, &speed_hz) == -1) {
160 msg_perr("%s: failed to set speed to %"PRIu32"Hz: %s\n",
161 __func__, speed_hz, strerror(errno));
Anastasia Klimchukf876c0f2021-04-13 10:15:26 +1000162 goto init_err;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000163 }
Nico Huber9cecc7e2018-12-22 00:08:50 +0100164 msg_pdbg("Using %"PRIu32"kHz clock\n", speed_hz / 1000);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000165
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000166 if (ioctl(fd, SPI_IOC_WR_MODE, &mode) == -1) {
167 msg_perr("%s: failed to set SPI mode to 0x%02x: %s\n",
168 __func__, mode, strerror(errno));
Anastasia Klimchukf876c0f2021-04-13 10:15:26 +1000169 goto init_err;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000170 }
171
172 if (ioctl(fd, SPI_IOC_WR_BITS_PER_WORD, &bits) == -1) {
173 msg_perr("%s: failed to set the number of bits per SPI word to %u: %s\n",
174 __func__, bits == 0 ? 8 : bits, strerror(errno));
Anastasia Klimchukf876c0f2021-04-13 10:15:26 +1000175 goto init_err;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000176 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000177
Anastasia Klimchukc19ef9b2021-04-12 16:52:58 +1000178 max_kernel_buf_size = get_max_kernel_buf_size();
Keno Fischer1f33cb52015-11-15 14:58:25 +0000179 msg_pdbg("%s: max_kernel_buf_size: %zu\n", __func__, max_kernel_buf_size);
Anastasia Klimchukc19ef9b2021-04-12 16:52:58 +1000180
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000181 spi_data = calloc(1, sizeof(*spi_data));
182 if (!spi_data) {
183 msg_perr("Unable to allocated space for SPI master data\n");
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000184 goto init_err;
185 }
186 spi_data->fd = fd;
187 spi_data->max_kernel_buf_size = max_kernel_buf_size;
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000188
Anastasia Klimchukc63d9182021-07-06 16:18:44 +1000189 return register_spi_master(&spi_master_linux, spi_data);
Anastasia Klimchukf876c0f2021-04-13 10:15:26 +1000190
191init_err:
Anastasia Klimchuk2a329662021-04-19 11:12:01 +1000192 close(fd);
193 return 1;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000194}
195
196static int linux_spi_shutdown(void *data)
197{
Anastasia Klimchuk2a329662021-04-19 11:12:01 +1000198 struct linux_spi_data *spi_data = data;
199 close(spi_data->fd);
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000200 free(spi_data);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000201 return 0;
202}
203
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000204static int linux_spi_send_command(const struct flashctx *flash, unsigned int writecnt,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000205 unsigned int readcnt,
206 const unsigned char *txbuf,
207 unsigned char *rxbuf)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000208{
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000209 struct linux_spi_data *spi_data = flash->mst->spi.data;
Michael Karcher8371d722012-03-06 22:17:06 +0000210 int iocontrol_code;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000211 struct spi_ioc_transfer msg[2] = {
212 {
David Riley18f50972014-08-05 22:16:01 +0000213 .tx_buf = (uint64_t)(uintptr_t)txbuf,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000214 .len = writecnt,
215 },
216 {
David Riley18f50972014-08-05 22:16:01 +0000217 .rx_buf = (uint64_t)(uintptr_t)rxbuf,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000218 .len = readcnt,
219 },
220 };
221
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000222 if (spi_data->fd == -1)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000223 return -1;
Michael Karcher8371d722012-03-06 22:17:06 +0000224 /* The implementation currently does not support requests that
225 don't start with sending a command. */
226 if (writecnt == 0)
227 return SPI_INVALID_LENGTH;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000228
Michael Karcher8371d722012-03-06 22:17:06 +0000229 /* Just submit the first (write) request in case there is nothing
230 to read. Otherwise submit both requests. */
231 if (readcnt == 0)
232 iocontrol_code = SPI_IOC_MESSAGE(1);
233 else
234 iocontrol_code = SPI_IOC_MESSAGE(2);
235
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000236 if (ioctl(spi_data->fd, iocontrol_code, msg) == -1) {
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000237 msg_cerr("%s: ioctl: %s\n", __func__, strerror(errno));
238 return -1;
239 }
240 return 0;
241}
242
Keno Fischer1f33cb52015-11-15 14:58:25 +0000243static int linux_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000244{
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000245 struct linux_spi_data *spi_data = flash->mst->spi.data;
Nico Huber22418422018-03-08 16:14:15 +0100246 /* Older kernels use a single buffer for combined input and output
247 data. So account for longest possible command + address, too. */
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000248 return spi_read_chunked(flash, buf, start, len, spi_data->max_kernel_buf_size - 5);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000249}
250
Mark Marshallf20b7be2014-05-09 21:16:21 +0000251static int linux_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000252{
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000253 struct linux_spi_data *spi_data = flash->mst->spi.data;
Keno Fischer1f33cb52015-11-15 14:58:25 +0000254 /* 5 bytes must be reserved for longest possible command + address. */
Anastasia Klimchuk84f03922021-04-13 11:26:25 +1000255 return spi_write_chunked(flash, buf, start, len, spi_data->max_kernel_buf_size - 5);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000256}
Stefan Tauner8868db32012-03-13 00:18:19 +0000257
Thomas Heijligencc853d82021-05-04 15:32:17 +0200258const struct programmer_entry programmer_linux_spi = {
259 .name = "linux_spi",
260 .type = OTHER,
261 .devs.note = "Device files /dev/spidev*.*\n",
262 .init = linux_spi_init,
263 .map_flash_region = fallback_map,
264 .unmap_flash_region = fallback_unmap,
265 .delay = internal_delay,
266};