blob: c3814aab6d84b9b93951d9e92aff8e6d101a2343 [file] [log] [blame]
Peter Stugebf196e92009-01-26 03:08:45 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2008 Peter Stuge <peter@stuge.se>
Carl-Daniel Hailfinger5609fa72010-01-07 03:32:17 +00005 * Copyright (C) 2009,2010 Carl-Daniel Hailfinger
Peter Stugebf196e92009-01-26 03:08:45 +00006 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
Peter Stugebf196e92009-01-26 03:08:45 +000015 */
16
Carl-Daniel Hailfingercceafa22010-05-26 01:45:41 +000017#if defined(__i386__) || defined(__x86_64__)
18
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +110019#include <stdlib.h>
20
Peter Stugebf196e92009-01-26 03:08:45 +000021#include "flash.h"
Sean Nelson14ba6682010-02-26 05:48:29 +000022#include "chipdrivers.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000023#include "programmer.h"
Patrick Georgi32508eb2012-07-20 20:35:14 +000024#include "hwaccess.h"
Peter Stugebf196e92009-01-26 03:08:45 +000025#include "spi.h"
26
27#define WBSIO_PORT1 0x2e
28#define WBSIO_PORT2 0x4e
29
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +110030struct wbsio_spi_data {
31 uint16_t spibase;
32};
Peter Stugebf196e92009-01-26 03:08:45 +000033
Uwe Hermann7b2969b2009-04-15 10:52:49 +000034static uint16_t wbsio_get_spibase(uint16_t port)
35{
Peter Stugebf196e92009-01-26 03:08:45 +000036 uint8_t id;
37 uint16_t flashport = 0;
38
39 w836xx_ext_enter(port);
Carl-Daniel Hailfinger24c1a162009-05-25 23:26:50 +000040 id = sio_read(port, 0x20);
Uwe Hermann7b2969b2009-04-15 10:52:49 +000041 if (id != 0xa0) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +000042 msg_perr("\nW83627 not found at 0x%x, id=0x%02x want=0xa0.\n", port, id);
Peter Stugebf196e92009-01-26 03:08:45 +000043 goto done;
44 }
45
Carl-Daniel Hailfinger24c1a162009-05-25 23:26:50 +000046 if (0 == (sio_read(port, 0x24) & 2)) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +000047 msg_perr("\nW83627 found at 0x%x, but SPI pins are not enabled. (CR[0x24] bit 1=0)\n", port);
Peter Stugebf196e92009-01-26 03:08:45 +000048 goto done;
49 }
50
Carl-Daniel Hailfinger24c1a162009-05-25 23:26:50 +000051 sio_write(port, 0x07, 0x06);
52 if (0 == (sio_read(port, 0x30) & 1)) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +000053 msg_perr("\nW83627 found at 0x%x, but SPI is not enabled. (LDN6[0x30] bit 0=0)\n", port);
Peter Stugebf196e92009-01-26 03:08:45 +000054 goto done;
55 }
56
Carl-Daniel Hailfinger24c1a162009-05-25 23:26:50 +000057 flashport = (sio_read(port, 0x62) << 8) | sio_read(port, 0x63);
Peter Stugebf196e92009-01-26 03:08:45 +000058
59done:
60 w836xx_ext_leave(port);
61 return flashport;
62}
63
Peter Stugebf196e92009-01-26 03:08:45 +000064/* W83627DHG has 11 command modes:
65 * 1=1 command only
66 * 2=1 command+1 data write
67 * 3=1 command+2 data read
68 * 4=1 command+3 address
69 * 5=1 command+3 address+1 data write
70 * 6=1 command+3 address+4 data write
71 * 7=1 command+3 address+1 dummy address inserted by wbsio+4 data read
72 * 8=1 command+3 address+1 data read
73 * 9=1 command+3 address+2 data read
74 * a=1 command+3 address+3 data read
75 * b=1 command+3 address+4 data read
76 *
77 * mode[7:4] holds the command mode
78 * mode[3:0] holds SPI address bits [19:16]
79 *
80 * The Winbond SPI master only supports 20 bit addresses on the SPI bus. :\
81 * Would one more byte of RAM in the chip (to get all 24 bits) really make
82 * such a big difference?
83 */
Edward O'Callaghane4ddc362020-04-12 17:27:53 +100084static int wbsio_spi_send_command(const struct flashctx *flash, unsigned int writecnt,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +000085 unsigned int readcnt,
86 const unsigned char *writearr,
87 unsigned char *readarr)
Uwe Hermann7b2969b2009-04-15 10:52:49 +000088{
Nico Huber519be662018-12-23 20:03:35 +010089 unsigned int i;
Peter Stugebf196e92009-01-26 03:08:45 +000090 uint8_t mode = 0;
91
Sean Nelsonf7f7a552010-01-09 23:34:45 +000092 msg_pspew("%s:", __func__);
Peter Stugebf196e92009-01-26 03:08:45 +000093
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +110094 const struct wbsio_spi_data *data =
95 (const struct wbsio_spi_data *)flash->mst->spi.data;
96
Peter Stugebf196e92009-01-26 03:08:45 +000097 if (1 == writecnt && 0 == readcnt) {
98 mode = 0x10;
99 } else if (2 == writecnt && 0 == readcnt) {
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100100 OUTB(writearr[1], data->spibase + 4);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000101 msg_pspew(" data=0x%02x", writearr[1]);
Peter Stugebf196e92009-01-26 03:08:45 +0000102 mode = 0x20;
103 } else if (1 == writecnt && 2 == readcnt) {
104 mode = 0x30;
105 } else if (4 == writecnt && 0 == readcnt) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000106 msg_pspew(" addr=0x%02x", (writearr[1] & 0x0f));
Peter Stugebf196e92009-01-26 03:08:45 +0000107 for (i = 2; i < writecnt; i++) {
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100108 OUTB(writearr[i], data->spibase + i);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000109 msg_pspew("%02x", writearr[i]);
Peter Stugebf196e92009-01-26 03:08:45 +0000110 }
111 mode = 0x40 | (writearr[1] & 0x0f);
112 } else if (5 == writecnt && 0 == readcnt) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000113 msg_pspew(" addr=0x%02x", (writearr[1] & 0x0f));
Peter Stugebf196e92009-01-26 03:08:45 +0000114 for (i = 2; i < 4; i++) {
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100115 OUTB(writearr[i], data->spibase + i);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000116 msg_pspew("%02x", writearr[i]);
Peter Stugebf196e92009-01-26 03:08:45 +0000117 }
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100118 OUTB(writearr[i], data->spibase + i);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000119 msg_pspew(" data=0x%02x", writearr[i]);
Peter Stugebf196e92009-01-26 03:08:45 +0000120 mode = 0x50 | (writearr[1] & 0x0f);
121 } else if (8 == writecnt && 0 == readcnt) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000122 msg_pspew(" addr=0x%02x", (writearr[1] & 0x0f));
Peter Stugebf196e92009-01-26 03:08:45 +0000123 for (i = 2; i < 4; i++) {
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100124 OUTB(writearr[i], data->spibase + i);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000125 msg_pspew("%02x", writearr[i]);
Peter Stugebf196e92009-01-26 03:08:45 +0000126 }
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000127 msg_pspew(" data=0x");
Peter Stugebf196e92009-01-26 03:08:45 +0000128 for (; i < writecnt; i++) {
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100129 OUTB(writearr[i], data->spibase + i);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000130 msg_pspew("%02x", writearr[i]);
Peter Stugebf196e92009-01-26 03:08:45 +0000131 }
132 mode = 0x60 | (writearr[1] & 0x0f);
133 } else if (5 == writecnt && 4 == readcnt) {
134 /* XXX: TODO not supported by flashrom infrastructure!
135 * This mode, 7, discards the fifth byte in writecnt,
136 * but since we can not express that in flashrom, fail
137 * the operation for now.
138 */
139 ;
140 } else if (4 == writecnt && readcnt >= 1 && readcnt <= 4) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000141 msg_pspew(" addr=0x%02x", (writearr[1] & 0x0f));
Peter Stugebf196e92009-01-26 03:08:45 +0000142 for (i = 2; i < writecnt; i++) {
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100143 OUTB(writearr[i], data->spibase + i);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000144 msg_pspew("%02x", writearr[i]);
Peter Stugebf196e92009-01-26 03:08:45 +0000145 }
146 mode = ((7 + readcnt) << 4) | (writearr[1] & 0x0f);
147 }
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000148 msg_pspew(" cmd=%02x mode=%02x\n", writearr[0], mode);
Peter Stugebf196e92009-01-26 03:08:45 +0000149
150 if (!mode) {
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000151 msg_perr("%s: unsupported command type wr=%d rd=%d\n",
Peter Stugebf196e92009-01-26 03:08:45 +0000152 __func__, writecnt, readcnt);
Carl-Daniel Hailfinger142e30f2009-07-14 10:26:56 +0000153 /* Command type refers to the number of bytes read/written. */
154 return SPI_INVALID_LENGTH;
Peter Stugebf196e92009-01-26 03:08:45 +0000155 }
156
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100157 OUTB(writearr[0], data->spibase);
158 OUTB(mode, data->spibase + 1);
Carl-Daniel Hailfingerca8bfc62009-06-05 17:48:08 +0000159 programmer_delay(10);
Peter Stugebf196e92009-01-26 03:08:45 +0000160
161 if (!readcnt)
162 return 0;
163
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000164 msg_pspew("%s: returning data =", __func__);
Peter Stugebf196e92009-01-26 03:08:45 +0000165 for (i = 0; i < readcnt; i++) {
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100166 readarr[i] = INB(data->spibase + 4 + i);
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000167 msg_pspew(" 0x%02x", readarr[i]);
Peter Stugebf196e92009-01-26 03:08:45 +0000168 }
Sean Nelsonf7f7a552010-01-09 23:34:45 +0000169 msg_pspew("\n");
Peter Stugebf196e92009-01-26 03:08:45 +0000170 return 0;
171}
172
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000173static int wbsio_spi_read(struct flashctx *flash, uint8_t *buf,
174 unsigned int start, unsigned int len)
Uwe Hermann7b2969b2009-04-15 10:52:49 +0000175{
Carl-Daniel Hailfingerccd71c22012-03-01 22:38:27 +0000176 mmio_readn((void *)(flash->virtual_memory + start), buf, len);
177 return 0;
Peter Stugebf196e92009-01-26 03:08:45 +0000178}
179
Nico Huber90739d12021-05-11 17:53:34 +0200180static const struct spi_master spi_master_wbsio = {
Edward O'Callaghan60aec982020-11-23 11:54:49 +1100181 .max_data_read = MAX_DATA_UNSPECIFIED,
182 .max_data_write = MAX_DATA_UNSPECIFIED,
183 .command = wbsio_spi_send_command,
184 .multicommand = default_spi_send_multicommand,
185 .read = wbsio_spi_read,
186 .write_256 = spi_chip_write_1,
187 .write_aai = spi_chip_write_1,
188};
189
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100190static int wbsio_spi_shutdown(void *data)
191{
192 free(data);
193 return 0;
194}
195
Edward O'Callaghan60aec982020-11-23 11:54:49 +1100196int wbsio_check_for_spi(void)
197{
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100198 uint16_t wbsio_spibase = 0;
199
Edward O'Callaghan60aec982020-11-23 11:54:49 +1100200 if (0 == (wbsio_spibase = wbsio_get_spibase(WBSIO_PORT1)))
201 if (0 == (wbsio_spibase = wbsio_get_spibase(WBSIO_PORT2)))
202 return 1;
203
204 msg_pspew("\nwbsio_spibase = 0x%x\n", wbsio_spibase);
205
206 msg_pdbg("%s: Winbond saved on 4 register bits so max chip size is "
207 "1024 kB!\n", __func__);
208 max_rom_decode.spi = 1024 * 1024;
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100209
Angel Pons3bd47522021-06-07 12:33:53 +0200210 struct wbsio_spi_data *data = calloc(1, sizeof(*data));
Edward O'Callaghan976d0fc2020-11-23 12:07:30 +1100211 if (!data) {
212 msg_perr("Unable to allocate space for extra SPI master data.\n");
213 return SPI_GENERIC_ERROR;
214 }
215 data->spibase = wbsio_spibase;
216
217 register_shutdown(wbsio_spi_shutdown, data);
Nico Huber90739d12021-05-11 17:53:34 +0200218 register_spi_master(&spi_master_wbsio, data);
Edward O'Callaghan60aec982020-11-23 11:54:49 +1100219
220 return 0;
221}
222
223#endif /* defined(__i386__) || defined(__x86_64__) */