blob: aa73c1815d14b51ed392561f0f7ef8c48e37a3ce [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
Sven Schnelle5ce5f702011-09-03 18:37:52 +000047static int fd = -1;
Keno Fischer1f33cb52015-11-15 14:58:25 +000048#define BUF_SIZE_FROM_SYSFS "/sys/module/spidev/parameters/bufsiz"
49static size_t max_kernel_buf_size;
Sven Schnelle5ce5f702011-09-03 18:37:52 +000050
51static int linux_spi_shutdown(void *data);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000052static int linux_spi_send_command(struct flashctx *flash, unsigned int writecnt,
53 unsigned int readcnt,
54 const unsigned char *txbuf,
55 unsigned char *rxbuf);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000056static int linux_spi_read(struct flashctx *flash, uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +000057 unsigned int start, unsigned int len);
Mark Marshallf20b7be2014-05-09 21:16:21 +000058static int linux_spi_write_256(struct flashctx *flash, const uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +000059 unsigned int start, unsigned int len);
Sven Schnelle5ce5f702011-09-03 18:37:52 +000060
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000061static const struct spi_master spi_master_linux = {
Nico Huber1cf407b2017-11-10 20:18:23 +010062 .features = SPI_MASTER_4BA,
Sven Schnelle5ce5f702011-09-03 18:37:52 +000063 .max_data_read = MAX_DATA_UNSPECIFIED, /* TODO? */
64 .max_data_write = MAX_DATA_UNSPECIFIED, /* TODO? */
65 .command = linux_spi_send_command,
66 .multicommand = default_spi_send_multicommand,
67 .read = linux_spi_read,
68 .write_256 = linux_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +000069 .write_aai = default_spi_write_aai,
Sven Schnelle5ce5f702011-09-03 18:37:52 +000070};
71
72int linux_spi_init(void)
73{
74 char *p, *endp, *dev;
Nico Huber9cecc7e2018-12-22 00:08:50 +010075 uint32_t speed_hz = 2 * 1000 * 1000;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +000076 /* FIXME: make the following configurable by CLI options. */
77 /* SPI mode 0 (beware this also includes: MSB first, CS active low and others */
78 const uint8_t mode = SPI_MODE_0;
79 const uint8_t bits = 8;
Sven Schnelle5ce5f702011-09-03 18:37:52 +000080
Stefan Tauner0554ca52013-07-25 22:54:25 +000081 p = extract_programmer_param("spispeed");
Sven Schnelle5ce5f702011-09-03 18:37:52 +000082 if (p && strlen(p)) {
Alexandru Gagniuc69dd09d2014-03-19 17:17:06 +000083 speed_hz = (uint32_t)strtoul(p, &endp, 10) * 1000;
Nico Huber9cecc7e2018-12-22 00:08:50 +010084 if (p == endp || speed_hz == 0) {
Sven Schnelle5ce5f702011-09-03 18:37:52 +000085 msg_perr("%s: invalid clock: %s kHz\n", __func__, p);
Stefan Tauner0554ca52013-07-25 22:54:25 +000086 free(p);
Sven Schnelle5ce5f702011-09-03 18:37:52 +000087 return 1;
88 }
Nico Huber9cecc7e2018-12-22 00:08:50 +010089 } else {
90 msg_pinfo("Using default %"PRIu32
91 "kHz clock. Use 'spispeed' parameter to override.\n",
92 speed_hz / 1000);
Sven Schnelle5ce5f702011-09-03 18:37:52 +000093 }
Stefan Tauner0554ca52013-07-25 22:54:25 +000094 free(p);
95
96 dev = extract_programmer_param("dev");
97 if (!dev || !strlen(dev)) {
98 msg_perr("No SPI device given. Use flashrom -p "
99 "linux_spi:dev=/dev/spidevX.Y\n");
100 free(dev);
101 return 1;
102 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000103
Sven Schnellecb24ddb2011-09-07 20:48:34 +0000104 msg_pdbg("Using device %s\n", dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000105 if ((fd = open(dev, O_RDWR)) == -1) {
106 msg_perr("%s: failed to open %s: %s\n", __func__,
107 dev, strerror(errno));
Stefan Tauner0554ca52013-07-25 22:54:25 +0000108 free(dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000109 return 1;
110 }
Stefan Tauner0554ca52013-07-25 22:54:25 +0000111 free(dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000112
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000113 if (register_shutdown(linux_spi_shutdown, NULL))
114 return 1;
115 /* We rely on the shutdown function for cleanup from here on. */
116
Nico Huber9cecc7e2018-12-22 00:08:50 +0100117 if (ioctl(fd, SPI_IOC_WR_MAX_SPEED_HZ, &speed_hz) == -1) {
118 msg_perr("%s: failed to set speed to %"PRIu32"Hz: %s\n",
119 __func__, speed_hz, strerror(errno));
120 return 1;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000121 }
Nico Huber9cecc7e2018-12-22 00:08:50 +0100122 msg_pdbg("Using %"PRIu32"kHz clock\n", speed_hz / 1000);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000123
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000124 if (ioctl(fd, SPI_IOC_WR_MODE, &mode) == -1) {
125 msg_perr("%s: failed to set SPI mode to 0x%02x: %s\n",
126 __func__, mode, strerror(errno));
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000127 return 1;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000128 }
129
130 if (ioctl(fd, SPI_IOC_WR_BITS_PER_WORD, &bits) == -1) {
131 msg_perr("%s: failed to set the number of bits per SPI word to %u: %s\n",
132 __func__, bits == 0 ? 8 : bits, strerror(errno));
133 return 1;
134 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000135
Keno Fischer1f33cb52015-11-15 14:58:25 +0000136 /* Read max buffer size from sysfs, or use page size as fallback. */
137 FILE *fp;
138 fp = fopen(BUF_SIZE_FROM_SYSFS, "r");
139 if (!fp) {
140 msg_pwarn("Cannot open %s: %s.\n", BUF_SIZE_FROM_SYSFS, strerror(errno));
141 goto out;
142 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000143
Keno Fischer1f33cb52015-11-15 14:58:25 +0000144 char buf[10];
Jacob Garber1c0c8fd2019-08-12 14:14:40 -0600145 if (!fgets(buf, sizeof(buf), fp)) {
Keno Fischer1f33cb52015-11-15 14:58:25 +0000146 if (feof(fp))
147 msg_pwarn("Cannot read %s: file is empty.\n", BUF_SIZE_FROM_SYSFS);
148 else
149 msg_pwarn("Cannot read %s: %s.\n", BUF_SIZE_FROM_SYSFS, strerror(errno));
150 goto out;
151 }
152
153 long int tmp;
154 errno = 0;
155 tmp = strtol(buf, NULL, 0);
156 if ((tmp < 0) || errno) {
157 msg_pwarn("Buffer size %ld from %s seems wrong.\n", tmp, BUF_SIZE_FROM_SYSFS);
158 } else {
159 msg_pdbg("%s: Using value from %s as max buffer size.\n", __func__, BUF_SIZE_FROM_SYSFS);
160 max_kernel_buf_size = (size_t)tmp;
161 }
162
163out:
164 if (fp)
165 fclose(fp);
166
167 if (!max_kernel_buf_size) {
168 msg_pdbg("%s: Using page size as max buffer size.\n", __func__);
169 max_kernel_buf_size = (size_t)getpagesize();
170 }
171
172 msg_pdbg("%s: max_kernel_buf_size: %zu\n", __func__, max_kernel_buf_size);
173 register_spi_master(&spi_master_linux);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000174 return 0;
175}
176
177static int linux_spi_shutdown(void *data)
178{
179 if (fd != -1) {
180 close(fd);
181 fd = -1;
182 }
183 return 0;
184}
185
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000186static int linux_spi_send_command(struct flashctx *flash, unsigned int writecnt,
187 unsigned int readcnt,
188 const unsigned char *txbuf,
189 unsigned char *rxbuf)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000190{
Michael Karcher8371d722012-03-06 22:17:06 +0000191 int iocontrol_code;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000192 struct spi_ioc_transfer msg[2] = {
193 {
David Riley18f50972014-08-05 22:16:01 +0000194 .tx_buf = (uint64_t)(uintptr_t)txbuf,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000195 .len = writecnt,
196 },
197 {
David Riley18f50972014-08-05 22:16:01 +0000198 .rx_buf = (uint64_t)(uintptr_t)rxbuf,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000199 .len = readcnt,
200 },
201 };
202
203 if (fd == -1)
204 return -1;
Michael Karcher8371d722012-03-06 22:17:06 +0000205 /* The implementation currently does not support requests that
206 don't start with sending a command. */
207 if (writecnt == 0)
208 return SPI_INVALID_LENGTH;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000209
Michael Karcher8371d722012-03-06 22:17:06 +0000210 /* Just submit the first (write) request in case there is nothing
211 to read. Otherwise submit both requests. */
212 if (readcnt == 0)
213 iocontrol_code = SPI_IOC_MESSAGE(1);
214 else
215 iocontrol_code = SPI_IOC_MESSAGE(2);
216
217 if (ioctl(fd, iocontrol_code, msg) == -1) {
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000218 msg_cerr("%s: ioctl: %s\n", __func__, strerror(errno));
219 return -1;
220 }
221 return 0;
222}
223
Keno Fischer1f33cb52015-11-15 14:58:25 +0000224static int linux_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000225{
Nico Huber22418422018-03-08 16:14:15 +0100226 /* Older kernels use a single buffer for combined input and output
227 data. So account for longest possible command + address, too. */
228 return spi_read_chunked(flash, buf, start, len, max_kernel_buf_size - 5);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000229}
230
Mark Marshallf20b7be2014-05-09 21:16:21 +0000231static 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 +0000232{
Keno Fischer1f33cb52015-11-15 14:58:25 +0000233 /* 5 bytes must be reserved for longest possible command + address. */
234 return spi_write_chunked(flash, buf, start, len, max_kernel_buf_size - 5);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000235}
Stefan Tauner8868db32012-03-13 00:18:19 +0000236
237#endif // CONFIG_LINUX_SPI == 1