blob: f4d30c98d02e11c205375e0151942006cbf08e29 [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.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
Stefan Tauner8868db32012-03-13 00:18:19 +000020#if CONFIG_LINUX_SPI == 1
21
Sven Schnelle5ce5f702011-09-03 18:37:52 +000022#include <stdio.h>
23#include <string.h>
24#include <stdlib.h>
25#include <sys/fcntl.h>
26#include <errno.h>
27#include <ctype.h>
28#include <unistd.h>
Stefan Tauner8868db32012-03-13 00:18:19 +000029#include <linux/types.h>
Sven Schnelle5ce5f702011-09-03 18:37:52 +000030#include <linux/spi/spidev.h>
31#include <sys/ioctl.h>
32#include "flash.h"
33#include "chipdrivers.h"
34#include "programmer.h"
35#include "spi.h"
36
37static int fd = -1;
38
39static int linux_spi_shutdown(void *data);
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000040static int linux_spi_send_command(struct flashctx *flash, unsigned int writecnt,
41 unsigned int readcnt,
42 const unsigned char *txbuf,
43 unsigned char *rxbuf);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000044static int linux_spi_read(struct flashctx *flash, uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +000045 unsigned int start, unsigned int len);
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +000046static int linux_spi_write_256(struct flashctx *flash, uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +000047 unsigned int start, unsigned int len);
Sven Schnelle5ce5f702011-09-03 18:37:52 +000048
49static const struct spi_programmer spi_programmer_linux = {
50 .type = SPI_CONTROLLER_LINUX,
51 .max_data_read = MAX_DATA_UNSPECIFIED, /* TODO? */
52 .max_data_write = MAX_DATA_UNSPECIFIED, /* TODO? */
53 .command = linux_spi_send_command,
54 .multicommand = default_spi_send_multicommand,
55 .read = linux_spi_read,
56 .write_256 = linux_spi_write_256,
57};
58
59int linux_spi_init(void)
60{
61 char *p, *endp, *dev;
Sven Schnellecb24ddb2011-09-07 20:48:34 +000062 uint32_t speed = 0;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +000063 /* FIXME: make the following configurable by CLI options. */
64 /* SPI mode 0 (beware this also includes: MSB first, CS active low and others */
65 const uint8_t mode = SPI_MODE_0;
66 const uint8_t bits = 8;
Sven Schnelle5ce5f702011-09-03 18:37:52 +000067
68 dev = extract_programmer_param("dev");
69 if (!dev || !strlen(dev)) {
70 msg_perr("No SPI device given. Use flashrom -p "
71 "linux_spi:dev=/dev/spidevX.Y\n");
72 return 1;
73 }
74
75 p = extract_programmer_param("speed");
76 if (p && strlen(p)) {
Sven Schnellecb24ddb2011-09-07 20:48:34 +000077 speed = (uint32_t)strtoul(p, &endp, 10) * 1024;
Sven Schnelle5ce5f702011-09-03 18:37:52 +000078 if (p == endp) {
79 msg_perr("%s: invalid clock: %s kHz\n", __func__, p);
80 return 1;
81 }
82 }
83
Sven Schnellecb24ddb2011-09-07 20:48:34 +000084 msg_pdbg("Using device %s\n", dev);
Sven Schnelle5ce5f702011-09-03 18:37:52 +000085 if ((fd = open(dev, O_RDWR)) == -1) {
86 msg_perr("%s: failed to open %s: %s\n", __func__,
87 dev, strerror(errno));
88 return 1;
89 }
90
Stefan Tauner2c3e9d52012-03-03 18:09:33 +000091 if (register_shutdown(linux_spi_shutdown, NULL))
92 return 1;
93 /* We rely on the shutdown function for cleanup from here on. */
94
Sven Schnellecb24ddb2011-09-07 20:48:34 +000095 if (speed > 0) {
96 if (ioctl(fd, SPI_IOC_WR_MAX_SPEED_HZ, &speed) == -1) {
Stefan Tauner2c3e9d52012-03-03 18:09:33 +000097 msg_perr("%s: failed to set speed to %d Hz: %s\n",
Sven Schnellecb24ddb2011-09-07 20:48:34 +000098 __func__, speed, strerror(errno));
Sven Schnellecb24ddb2011-09-07 20:48:34 +000099 return 1;
100 }
101
102 msg_pdbg("Using %d kHz clock\n", speed);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000103 }
104
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000105 if (ioctl(fd, SPI_IOC_WR_MODE, &mode) == -1) {
106 msg_perr("%s: failed to set SPI mode to 0x%02x: %s\n",
107 __func__, mode, strerror(errno));
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000108 return 1;
Stefan Tauner2c3e9d52012-03-03 18:09:33 +0000109 }
110
111 if (ioctl(fd, SPI_IOC_WR_BITS_PER_WORD, &bits) == -1) {
112 msg_perr("%s: failed to set the number of bits per SPI word to %u: %s\n",
113 __func__, bits == 0 ? 8 : bits, strerror(errno));
114 return 1;
115 }
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000116
117 register_spi_programmer(&spi_programmer_linux);
118
119 return 0;
120}
121
122static int linux_spi_shutdown(void *data)
123{
124 if (fd != -1) {
125 close(fd);
126 fd = -1;
127 }
128 return 0;
129}
130
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000131static int linux_spi_send_command(struct flashctx *flash, unsigned int writecnt,
132 unsigned int readcnt,
133 const unsigned char *txbuf,
134 unsigned char *rxbuf)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000135{
Michael Karcher8371d722012-03-06 22:17:06 +0000136 int iocontrol_code;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000137 struct spi_ioc_transfer msg[2] = {
138 {
Uwe Hermann48446c82011-09-06 18:17:02 +0000139 .tx_buf = (uint64_t)(ptrdiff_t)txbuf,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000140 .len = writecnt,
141 },
142 {
Uwe Hermann48446c82011-09-06 18:17:02 +0000143 .rx_buf = (uint64_t)(ptrdiff_t)rxbuf,
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000144 .len = readcnt,
145 },
146 };
147
148 if (fd == -1)
149 return -1;
Michael Karcher8371d722012-03-06 22:17:06 +0000150 /* The implementation currently does not support requests that
151 don't start with sending a command. */
152 if (writecnt == 0)
153 return SPI_INVALID_LENGTH;
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000154
Michael Karcher8371d722012-03-06 22:17:06 +0000155 /* Just submit the first (write) request in case there is nothing
156 to read. Otherwise submit both requests. */
157 if (readcnt == 0)
158 iocontrol_code = SPI_IOC_MESSAGE(1);
159 else
160 iocontrol_code = SPI_IOC_MESSAGE(2);
161
162 if (ioctl(fd, iocontrol_code, msg) == -1) {
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000163 msg_cerr("%s: ioctl: %s\n", __func__, strerror(errno));
164 return -1;
165 }
166 return 0;
167}
168
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000169static int linux_spi_read(struct flashctx *flash, uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000170 unsigned int start, unsigned int len)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000171{
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000172 return spi_read_chunked(flash, buf, start, len,
173 (unsigned int)getpagesize());
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000174}
175
Carl-Daniel Hailfinger63fd9022011-12-14 22:25:15 +0000176static int linux_spi_write_256(struct flashctx *flash, uint8_t *buf,
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000177 unsigned int start, unsigned int len)
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000178{
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000179 return spi_write_chunked(flash, buf, start, len,
180 ((unsigned int)getpagesize()) - 4);
Sven Schnelle5ce5f702011-09-03 18:37:52 +0000181}
Stefan Tauner8868db32012-03-13 00:18:19 +0000182
183#endif // CONFIG_LINUX_SPI == 1