blob: 46779a02040cfcf3d8e8f1caba8750f04ebac0fd [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
Stefan Tauner8868db32012-03-13 00:18:19 +000016#if CONFIG_LINUX_SPI == 1
17
Sven Schnelle5ce5f702011-09-03 18:37:52 +000018#include <stdio.h>
19#include <string.h>
20#include <stdlib.h>
Nico Huber9cecc7e2018-12-22 00:08:50 +010021#include <stdint.h>
22#include <inttypes.h>
Gwenhael Goavec-Merou8cd0c732015-11-14 02:55:12 +000023#include <fcntl.h>
Sven Schnelle5ce5f702011-09-03 18:37:52 +000024#include <errno.h>
25#include <ctype.h>
26#include <unistd.h>
Gwenhael Goavec-Merou8cd0c732015-11-14 02:55:12 +000027#include <sys/ioctl.h>
Stefan Tauner8868db32012-03-13 00:18:19 +000028#include <linux/types.h>
Sven Schnelle5ce5f702011-09-03 18:37:52 +000029#include "flash.h"
30#include "chipdrivers.h"
31#include "programmer.h"
32#include "spi.h"
Fabrice Fontainee0ceedf2019-07-17 19:04:12 +020033/*
34 * Linux versions prior to v4.14-rc7 may need linux/ioctl.h included here due
35 * to missing from linux/spi/spidev.h. This was fixed in the following commit:
36 * a2b4a79b88b2 spi: uapi: spidev: add missing ioctl header
37 */
38#include <linux/ioctl.h>
39#include <linux/spi/spidev.h>
Sven Schnelle5ce5f702011-09-03 18:37:52 +000040
Stefan Tauner23e10b82016-01-23 16:16:49 +000041/* Devices known to work with this module (FIXME: export as struct dev_entry):
42 * Beagle Bone Black
43 * Raspberry Pi
44 * HummingBoard
45 */
46
Keno Fischer1f33cb52015-11-15 14:58:25 +000047#define BUF_SIZE_FROM_SYSFS "/sys/module/spidev/parameters/bufsiz"
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100048
49struct linux_spi_data {
50 int fd;
51 size_t max_kernel_buf_size;
52};
Sven Schnelle5ce5f702011-09-03 18:37:52 +000053
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110054static int linux_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len)
55{
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100056 struct linux_spi_data *spi_data = flash->mst->spi.data;
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110057 /* Older kernels use a single buffer for combined input and output
58 data. So account for longest possible command + address, too. */
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100059 return spi_read_chunked(flash, buf, start, len, spi_data->max_kernel_buf_size - 5);
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110060}
61
62static int linux_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
63{
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100064 struct linux_spi_data *spi_data = flash->mst->spi.data;
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110065 /* 5 bytes must be reserved for longest possible command + address. */
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100066 return spi_write_chunked(flash, buf, start, len, spi_data->max_kernel_buf_size - 5);
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110067}
68
69static int linux_spi_shutdown(void *data)
70{
Anastasia Klimchuk2a703e42021-04-19 11:12:01 +100071 struct linux_spi_data *spi_data = data;
72 close(spi_data->fd);
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100073 free(spi_data);
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110074 return 0;
75}
76
Edward O'Callaghane4ddc362020-04-12 17:27:53 +100077static int linux_spi_send_command(const struct flashctx *flash, unsigned int writecnt,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000078 unsigned int readcnt,
79 const unsigned char *txbuf,
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110080 unsigned char *rxbuf)
81{
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100082 struct linux_spi_data *spi_data = flash->mst->spi.data;
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110083 int iocontrol_code;
84 struct spi_ioc_transfer msg[2] = {
85 {
86 .tx_buf = (uint64_t)(uintptr_t)txbuf,
87 .len = writecnt,
88 },
89 {
90 .rx_buf = (uint64_t)(uintptr_t)rxbuf,
91 .len = readcnt,
92 },
93 };
94
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +100095 if (spi_data->fd == -1)
Anastasia Klimchukf1391c72021-02-15 15:04:20 +110096 return -1;
97 /* The implementation currently does not support requests that
98 don't start with sending a command. */
99 if (writecnt == 0)
100 return SPI_INVALID_LENGTH;
101
102 /* Just submit the first (write) request in case there is nothing
103 to read. Otherwise submit both requests. */
104 if (readcnt == 0)
105 iocontrol_code = SPI_IOC_MESSAGE(1);
106 else
107 iocontrol_code = SPI_IOC_MESSAGE(2);
108
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +1000109 if (ioctl(spi_data->fd, iocontrol_code, msg) == -1) {
Anastasia Klimchukf1391c72021-02-15 15:04:20 +1100110 msg_cerr("%s: ioctl: %s\n", __func__, strerror(errno));
111 return -1;
112 }
113 return 0;
114}
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000115
Nico Huber90739d12021-05-11 17:53:34 +0200116static const struct spi_master spi_master_linux = {
Nico Huber1cf407b2017-11-10 20:18:23 +0100117 .features = SPI_MASTER_4BA,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000118 .max_data_read = MAX_DATA_UNSPECIFIED, /* TODO? */
119 .max_data_write = MAX_DATA_UNSPECIFIED, /* TODO? */
120 .command = linux_spi_send_command,
121 .multicommand = default_spi_send_multicommand,
122 .read = linux_spi_read,
123 .write_256 = linux_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000124 .write_aai = default_spi_write_aai,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000125};
126
Anastasia Klimchukf227cd32021-04-12 16:52:58 +1000127/* Read max buffer size from sysfs, or use page size as fallback. */
Anastasia Klimchuk2a703e42021-04-19 11:12:01 +1000128static size_t get_max_kernel_buf_size()
129{
Anastasia Klimchukf227cd32021-04-12 16:52:58 +1000130 size_t result = 0;
131 FILE *fp;
132 fp = fopen(BUF_SIZE_FROM_SYSFS, "r");
133 if (!fp) {
134 msg_pwarn("Cannot open %s: %s.\n", BUF_SIZE_FROM_SYSFS, strerror(errno));
135 goto out;
136 }
137
138 char buf[10];
139 if (!fgets(buf, sizeof(buf), fp)) {
140 if (feof(fp))
141 msg_pwarn("Cannot read %s: file is empty.\n", BUF_SIZE_FROM_SYSFS);
142 else
143 msg_pwarn("Cannot read %s: %s.\n", BUF_SIZE_FROM_SYSFS, strerror(errno));
144 goto out;
145 }
146
147 long int tmp;
148 errno = 0;
149 tmp = strtol(buf, NULL, 0);
150 if ((tmp < 0) || errno) {
151 msg_pwarn("Buffer size %ld from %s seems wrong.\n", tmp, BUF_SIZE_FROM_SYSFS);
152 } else {
153 msg_pdbg("%s: Using value from %s as max buffer size.\n", __func__, BUF_SIZE_FROM_SYSFS);
154 result = (size_t)tmp;
155 }
156
157out:
158 if (fp)
159 fclose(fp);
160
161 if (!result) {
162 msg_pdbg("%s: Using page size as max buffer size.\n", __func__);
163 result = (size_t)getpagesize();
164 }
165 return result;
166}
167
Thomas Heijligen4f5169d2021-05-04 15:32:17 +0200168static int linux_spi_init(void)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000169{
170 char *p, *endp, *dev;
Nico Huber9cecc7e2018-12-22 00:08:50 +0100171 uint32_t speed_hz = 2 * 1000 * 1000;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000172 /* FIXME: make the following configurable by CLI options. */
173 /* SPI mode 0 (beware this also includes: MSB first, CS active low and others */
174 const uint8_t mode = SPI_MODE_0;
175 const uint8_t bits = 8;
Anastasia Klimchuk2a703e42021-04-19 11:12:01 +1000176 int fd;
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +1000177 size_t max_kernel_buf_size;
178 struct linux_spi_data *spi_data;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000179
Stefan Tauner0554ca52013-07-25 22:54:25 +0000180 p = extract_programmer_param("spispeed");
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000181 if (p && strlen(p)) {
Alexandru Gagniuc69dd09d2014-03-19 17:17:06 +0000182 speed_hz = (uint32_t)strtoul(p, &endp, 10) * 1000;
Nico Huber9cecc7e2018-12-22 00:08:50 +0100183 if (p == endp || speed_hz == 0) {
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000184 msg_perr("%s: invalid clock: %s kHz\n", __func__, p);
Stefan Tauner0554ca52013-07-25 22:54:25 +0000185 free(p);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000186 return 1;
187 }
Nico Huber9cecc7e2018-12-22 00:08:50 +0100188 } else {
189 msg_pinfo("Using default %"PRIu32
190 "kHz clock. Use 'spispeed' parameter to override.\n",
191 speed_hz / 1000);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000192 }
Stefan Tauner0554ca52013-07-25 22:54:25 +0000193 free(p);
194
195 dev = extract_programmer_param("dev");
196 if (!dev || !strlen(dev)) {
197 msg_perr("No SPI device given. Use flashrom -p "
198 "linux_spi:dev=/dev/spidevX.Y\n");
199 free(dev);
200 return 1;
201 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000202
Sven Schnellecb24ddb2011-09-07 20:48:34 +0000203 msg_pdbg("Using device %s\n", dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000204 if ((fd = open(dev, O_RDWR)) == -1) {
205 msg_perr("%s: failed to open %s: %s\n", __func__,
206 dev, strerror(errno));
Stefan Tauner0554ca52013-07-25 22:54:25 +0000207 free(dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000208 return 1;
209 }
Stefan Tauner0554ca52013-07-25 22:54:25 +0000210 free(dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000211
Nico Huber9cecc7e2018-12-22 00:08:50 +0100212 if (ioctl(fd, SPI_IOC_WR_MAX_SPEED_HZ, &speed_hz) == -1) {
213 msg_perr("%s: failed to set speed to %"PRIu32"Hz: %s\n",
214 __func__, speed_hz, strerror(errno));
Anastasia Klimchuk6b5736c2021-04-13 10:15:26 +1000215 goto init_err;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000216 }
Nico Huber9cecc7e2018-12-22 00:08:50 +0100217 msg_pdbg("Using %"PRIu32"kHz clock\n", speed_hz / 1000);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000218
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000219 if (ioctl(fd, SPI_IOC_WR_MODE, &mode) == -1) {
220 msg_perr("%s: failed to set SPI mode to 0x%02x: %s\n",
221 __func__, mode, strerror(errno));
Anastasia Klimchuk6b5736c2021-04-13 10:15:26 +1000222 goto init_err;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000223 }
224
225 if (ioctl(fd, SPI_IOC_WR_BITS_PER_WORD, &bits) == -1) {
226 msg_perr("%s: failed to set the number of bits per SPI word to %u: %s\n",
227 __func__, bits == 0 ? 8 : bits, strerror(errno));
Anastasia Klimchuk6b5736c2021-04-13 10:15:26 +1000228 goto init_err;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000229 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000230
Anastasia Klimchukf227cd32021-04-12 16:52:58 +1000231 max_kernel_buf_size = get_max_kernel_buf_size();
Keno Fischer1f33cb52015-11-15 14:58:25 +0000232 msg_pdbg("%s: max_kernel_buf_size: %zu\n", __func__, max_kernel_buf_size);
Anastasia Klimchukf227cd32021-04-12 16:52:58 +1000233
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +1000234 spi_data = calloc(1, sizeof(*spi_data));
235 if (!spi_data) {
236 msg_perr("Unable to allocated space for SPI master data\n");
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +1000237 goto init_err;
238 }
239 spi_data->fd = fd;
240 spi_data->max_kernel_buf_size = max_kernel_buf_size;
Anastasia Klimchuk1b13f252021-04-13 11:26:25 +1000241
242 if (register_shutdown(linux_spi_shutdown, spi_data)) {
243 free(spi_data);
Anastasia Klimchuk6b5736c2021-04-13 10:15:26 +1000244 goto init_err;
245 }
Nico Huber90739d12021-05-11 17:53:34 +0200246 register_spi_master(&spi_master_linux, spi_data);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000247 return 0;
Anastasia Klimchuk6b5736c2021-04-13 10:15:26 +1000248
249init_err:
Anastasia Klimchuk2a703e42021-04-19 11:12:01 +1000250 close(fd);
251 return 1;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000252}
253
Thomas Heijligen4f5169d2021-05-04 15:32:17 +0200254const struct programmer_entry programmer_linux_spi = {
255 .name = "linux_spi",
256 .type = OTHER,
257 .devs.note = "Device files /dev/spidev*.*\n",
258 .init = linux_spi_init,
259 .map_flash_region = fallback_map,
260 .unmap_flash_region = fallback_unmap,
261 .delay = internal_delay,
262};
263
Stefan Tauner8868db32012-03-13 00:18:19 +0000264#endif // CONFIG_LINUX_SPI == 1