blob: 610dc28458b4f2988dcb8db36b8c882c668bf393 [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.
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000014 */
15
16#include <stdio.h>
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000017#include <string.h>
18#include <stdlib.h>
19#include <ctype.h>
20#include "flash.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000021#include "programmer.h"
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000022#include "spi.h"
23
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +110024struct bitbang_spi_master_data {
25 const struct bitbang_spi_master *mst;
Anastasia Klimchuka447c122021-05-31 11:20:01 +100026 void *spi_data;
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +110027};
28
Carl-Daniel Hailfinger0d974e72010-07-17 12:54:09 +000029/* Note that CS# is active low, so val=0 means the chip is active. */
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100030static void bitbang_spi_set_cs(const struct bitbang_spi_master * const master, int val, void *spi_data)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000031{
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100032 master->set_cs(val, spi_data);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000033}
34
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100035static void bitbang_spi_set_sck(const struct bitbang_spi_master * const master, int val, void *spi_data)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000036{
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100037 master->set_sck(val, spi_data);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000038}
39
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100040static void bitbang_spi_request_bus(const struct bitbang_spi_master * const master, void *spi_data)
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000041{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000042 if (master->request_bus)
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100043 master->request_bus(spi_data);
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000044}
45
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100046static void bitbang_spi_release_bus(const struct bitbang_spi_master * const master, void *spi_data)
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000047{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000048 if (master->release_bus)
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100049 master->release_bus(spi_data);
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +000050}
51
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100052static void bitbang_spi_set_sck_set_mosi(const struct bitbang_spi_master * const master, int sck, int mosi,
53 void *spi_data)
Daniel Thompsonb623f402018-06-05 09:38:19 +010054{
55 if (master->set_sck_set_mosi) {
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100056 master->set_sck_set_mosi(sck, mosi, spi_data);
Daniel Thompsonb623f402018-06-05 09:38:19 +010057 return;
58 }
59
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100060 master->set_sck(sck, spi_data);
61 master->set_mosi(mosi, spi_data);
Daniel Thompsonb623f402018-06-05 09:38:19 +010062}
63
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100064static int bitbang_spi_set_sck_get_miso(const struct bitbang_spi_master * const master, int sck,
65 void *spi_data)
Daniel Thompsonb623f402018-06-05 09:38:19 +010066{
67 if (master->set_sck_get_miso)
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100068 return master->set_sck_get_miso(sck, spi_data);
Daniel Thompsonb623f402018-06-05 09:38:19 +010069
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +100070 master->set_sck(sck, spi_data);
71 return master->get_miso(spi_data);
Daniel Thompsonb623f402018-06-05 09:38:19 +010072}
73
Edward O'Callaghan5eca4272020-04-12 17:27:53 +100074static int bitbang_spi_send_command(const struct flashctx *flash,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000075 unsigned int writecnt, unsigned int readcnt,
76 const unsigned char *writearr,
77 unsigned char *readarr);
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +110078static int bitbang_spi_shutdown(void *data);
Michael Karcherb9dbe482011-05-11 17:07:07 +000079
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000080static const struct spi_master spi_master_bitbang = {
Nico Huber1cf407b2017-11-10 20:18:23 +010081 .features = SPI_MASTER_4BA,
Uwe Hermann91f4afa2011-07-28 08:13:25 +000082 .max_data_read = MAX_DATA_READ_UNLIMITED,
83 .max_data_write = MAX_DATA_WRITE_UNLIMITED,
84 .command = bitbang_spi_send_command,
85 .multicommand = default_spi_send_multicommand,
86 .read = default_spi_read,
87 .write_256 = default_spi_write_256,
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +110088 .shutdown = bitbang_spi_shutdown,
Aarya Chaumal0cea7532022-07-04 18:21:50 +053089 .probe_opcode = default_spi_probe_opcode,
Michael Karcherb9dbe482011-05-11 17:07:07 +000090};
91
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +110092static int bitbang_spi_shutdown(void *data)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +000093{
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000094 /* FIXME: Run bitbang_spi_release_bus here or per command? */
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +110095 free(data);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000096 return 0;
97}
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +000098
Anastasia Klimchuka447c122021-05-31 11:20:01 +100099int register_spi_bitbang_master(const struct bitbang_spi_master *master, void *spi_data)
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000100{
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000101 struct spi_master mst = spi_master_bitbang;
Nico Hubercb44eb72017-04-22 00:09:42 +0200102 /* If someone forgot to initialize a bitbang function, we catch it here. */
103 if (!master || !master->set_cs ||
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000104 !master->set_sck || !master->set_mosi || !master->get_miso ||
105 (master->request_bus && !master->release_bus) ||
106 (!master->request_bus && master->release_bus)) {
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +0000107 msg_perr("Incomplete SPI bitbang master setting!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200108 "Please report a bug at flashprog@flashprog.org\n");
109 return ERROR_FLASHPROG_BUG;
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +0000110 }
111
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +1100112 struct bitbang_spi_master_data *data = calloc(1, sizeof(struct bitbang_spi_master_data));
113 if (!data) {
114 msg_perr("Out of memory!\n");
115 return ERROR_OOM;
116 }
117
118 data->mst = master;
Anastasia Klimchuka447c122021-05-31 11:20:01 +1000119 data->spi_data = spi_data;
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +1100120 register_spi_master(&mst, data);
Carl-Daniel Hailfinger0d974e72010-07-17 12:54:09 +0000121
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000122 /* Only mess with the bus if we're sure nobody else uses it. */
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000123 bitbang_spi_request_bus(master, spi_data);
124 bitbang_spi_set_cs(master, 1, spi_data);
125 bitbang_spi_set_sck_set_mosi(master, 0, 0, spi_data);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000126 /* FIXME: Release SPI bus here and request it again for each command or
127 * don't release it now and only release it on programmer shutdown?
128 */
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000129 bitbang_spi_release_bus(master, spi_data);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000130 return 0;
131}
132
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000133static uint8_t bitbang_spi_read_byte(const struct bitbang_spi_master *master, void *spi_data)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000134{
135 uint8_t ret = 0;
136 int i;
137
138 for (i = 7; i >= 0; i--) {
Daniel Thompson455a6fc2018-06-05 09:55:20 +0100139 if (i == 0)
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000140 bitbang_spi_set_sck_set_mosi(master, 0, 0, spi_data);
Daniel Thompson455a6fc2018-06-05 09:55:20 +0100141 else
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000142 bitbang_spi_set_sck(master, 0, spi_data);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000143 programmer_delay(master->half_period);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000144 ret <<= 1;
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000145 ret |= bitbang_spi_set_sck_get_miso(master, 1, spi_data);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000146 programmer_delay(master->half_period);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000147 }
148 return ret;
149}
150
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000151static void bitbang_spi_write_byte(const struct bitbang_spi_master *master, uint8_t val, void *spi_data)
Daniel Thompson455a6fc2018-06-05 09:55:20 +0100152{
153 int i;
154
155 for (i = 7; i >= 0; i--) {
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000156 bitbang_spi_set_sck_set_mosi(master, 0, (val >> i) & 1, spi_data);
Daniel Thompson455a6fc2018-06-05 09:55:20 +0100157 programmer_delay(master->half_period);
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000158 bitbang_spi_set_sck(master, 1, spi_data);
Daniel Thompson455a6fc2018-06-05 09:55:20 +0100159 programmer_delay(master->half_period);
160 }
161}
162
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000163static int bitbang_spi_send_command(const struct flashctx *flash,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000164 unsigned int writecnt, unsigned int readcnt,
165 const unsigned char *writearr,
166 unsigned char *readarr)
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000167{
Nico Huber519be662018-12-23 20:03:35 +0100168 unsigned int i;
Edward O'Callaghancbc5ba02021-01-06 14:10:52 +1100169 const struct bitbang_spi_master_data *data = flash->mst->spi.data;
170 const struct bitbang_spi_master *master = data->mst;
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000171
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +0000172 /* FIXME: Run bitbang_spi_request_bus here or in programmer init?
173 * Requesting and releasing the SPI bus is handled in here to allow the
174 * programmer to use its own SPI engine for native accesses.
175 */
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000176 bitbang_spi_request_bus(master, data->spi_data);
177 bitbang_spi_set_cs(master, 0, data->spi_data);
Michael Karcher1a854fc2010-07-17 10:42:34 +0000178 for (i = 0; i < writecnt; i++)
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000179 bitbang_spi_write_byte(master, writearr[i], data->spi_data);
Michael Karcher1a854fc2010-07-17 10:42:34 +0000180 for (i = 0; i < readcnt; i++)
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000181 readarr[i] = bitbang_spi_read_byte(master, data->spi_data);
Michael Karcher1a854fc2010-07-17 10:42:34 +0000182
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000183 bitbang_spi_set_sck(master, 0, data->spi_data);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000184 programmer_delay(master->half_period);
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000185 bitbang_spi_set_cs(master, 1, data->spi_data);
Carl-Daniel Hailfingerc40cff72011-12-20 00:19:29 +0000186 programmer_delay(master->half_period);
Carl-Daniel Hailfinger28228882010-09-15 00:17:37 +0000187 /* FIXME: Run bitbang_spi_release_bus here or in programmer init? */
Anastasia Klimchuk6e6cce02021-05-26 10:07:59 +1000188 bitbang_spi_release_bus(master, data->spi_data);
Carl-Daniel Hailfinger547872b2009-09-28 13:15:16 +0000189
190 return 0;
191}