blob: 51fc9c6063973a56756158c5e70f0c5b85073baf [file] [log] [blame]
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +00001/*
2 * This file is part of the flashrom project.
3 *
Carl-Daniel Hailfinger5824fbf2010-05-21 23:09:42 +00004 * Copyright (C) 2009, 2010 Carl-Daniel Hailfinger
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +00005 *
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
20#include <stdio.h>
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000021#include <string.h>
22#include <stdlib.h>
23#include <ctype.h>
24#include "flash.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000025#include "programmer.h"
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000026#include "spi.h"
27
Carl-Daniel Hailfinger0d974e72010-07-17 12:54:09 +000028/* Note that CS# is active low, so val=0 means the chip is active. */
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000029static void bitbang_spi_set_cs(const const struct bitbang_spi_master *master, int val)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000030{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000031 master->set_cs(val);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000032}
33
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000034static void bitbang_spi_set_sck(const const struct bitbang_spi_master *master, int val)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000035{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000036 master->set_sck(val);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000037}
38
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000039static void bitbang_spi_set_mosi(const const struct bitbang_spi_master *master, int val)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000040{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000041 master->set_mosi(val);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000042}
43
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000044static int bitbang_spi_get_miso(const const struct bitbang_spi_master *master)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000045{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000046 return master->get_miso();
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000047}
48
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000049static void bitbang_spi_request_bus(const const struct bitbang_spi_master *master)
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000050{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000051 if (master->request_bus)
52 master->request_bus();
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000053}
54
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000055static void bitbang_spi_release_bus(const const struct bitbang_spi_master *master)
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000056{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000057 if (master->release_bus)
58 master->release_bus();
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000059}
60
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000061static int bitbang_spi_send_command(struct flashctx *flash,
62 unsigned int writecnt, unsigned int readcnt,
63 const unsigned char *writearr,
64 unsigned char *readarr);
Michael Karcherb9dbe482011-05-11 17:07:07 +000065
66static const struct spi_programmer spi_programmer_bitbang = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +000067 .type = SPI_CONTROLLER_BITBANG,
68 .max_data_read = MAX_DATA_READ_UNLIMITED,
69 .max_data_write = MAX_DATA_WRITE_UNLIMITED,
70 .command = bitbang_spi_send_command,
71 .multicommand = default_spi_send_multicommand,
72 .read = default_spi_read,
73 .write_256 = default_spi_write_256,
Michael Karcherb9dbe482011-05-11 17:07:07 +000074};
75
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000076#if 0 // until it is needed
77static int bitbang_spi_shutdown(const struct bitbang_spi_master *master)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000078{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000079 /* FIXME: Run bitbang_spi_release_bus here or per command? */
80 return 0;
81}
82#endif
83
84int bitbang_spi_init(const struct bitbang_spi_master *master)
85{
86 struct spi_programmer pgm = spi_programmer_bitbang;
Carl-Daniel Hailfinger17e23ac2010-07-18 14:42:28 +000087 /* BITBANG_SPI_INVALID is 0, so if someone forgot to initialize ->type,
88 * we catch it here. Same goes for missing initialization of bitbanging
89 * functions.
90 */
91 if (!master || master->type == BITBANG_SPI_INVALID || !master->set_cs ||
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000092 !master->set_sck || !master->set_mosi || !master->get_miso ||
93 (master->request_bus && !master->release_bus) ||
94 (!master->request_bus && master->release_bus)) {
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000095 msg_perr("Incomplete SPI bitbang master setting!\n"
96 "Please report a bug at flashrom@flashrom.org\n");
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000097 return ERROR_FLASHROM_BUG;
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000098 }
99
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000100 pgm.data = master;
101 register_spi_programmer(&pgm);
Carl-Daniel Hailfinger0d974e72010-07-17 12:54:09 +0000102
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000103 /* Only mess with the bus if we're sure nobody else uses it. */
104 bitbang_spi_request_bus(master);
105 bitbang_spi_set_cs(master, 1);
106 bitbang_spi_set_sck(master, 0);
107 bitbang_spi_set_mosi(master, 0);
108 /* FIXME: Release SPI bus here and request it again for each command or
109 * don't release it now and only release it on programmer shutdown?
110 */
111 bitbang_spi_release_bus(master);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000112 return 0;
113}
114
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000115static uint8_t bitbang_spi_rw_byte(const struct bitbang_spi_master *master,
116 uint8_t val)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000117{
118 uint8_t ret = 0;
119 int i;
120
121 for (i = 7; i >= 0; i--) {
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000122 bitbang_spi_set_mosi(master, (val >> i) & 1);
123 programmer_delay(master->half_period);
124 bitbang_spi_set_sck(master, 1);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000125 ret <<= 1;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000126 ret |= bitbang_spi_get_miso(master);
127 programmer_delay(master->half_period);
128 bitbang_spi_set_sck(master, 0);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000129 }
130 return ret;
131}
132
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000133static int bitbang_spi_send_command(struct flashctx *flash,
134 unsigned int writecnt, unsigned int readcnt,
135 const unsigned char *writearr,
136 unsigned char *readarr)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000137{
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000138 int i;
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000139 const struct bitbang_spi_master *master = flash->pgm->spi.data;
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000140
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +0000141 /* FIXME: Run bitbang_spi_request_bus here or in programmer init?
142 * Requesting and releasing the SPI bus is handled in here to allow the
143 * programmer to use its own SPI engine for native accesses.
144 */
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000145 bitbang_spi_request_bus(master);
146 bitbang_spi_set_cs(master, 0);
Michael Karcher1a854fc2010-07-17 10:42:34 +0000147 for (i = 0; i < writecnt; i++)
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000148 bitbang_spi_rw_byte(master, writearr[i]);
Michael Karcher1a854fc2010-07-17 10:42:34 +0000149 for (i = 0; i < readcnt; i++)
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000150 readarr[i] = bitbang_spi_rw_byte(master, 0);
Michael Karcher1a854fc2010-07-17 10:42:34 +0000151
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000152 programmer_delay(master->half_period);
153 bitbang_spi_set_cs(master, 1);
154 programmer_delay(master->half_period);
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +0000155 /* FIXME: Run bitbang_spi_release_bus here or in programmer init? */
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000156 bitbang_spi_release_bus(master);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000157
158 return 0;
159}