xref: /aosp_15_r20/external/flashrom/mediatek_i2c_spi.c (revision 0d6140be3aa665ecc836e8907834fcd3e3b018fc)
1*0d6140beSAndroid Build Coastguard Worker /*
2*0d6140beSAndroid Build Coastguard Worker  * This file is part of the flashrom project.
3*0d6140beSAndroid Build Coastguard Worker  *
4*0d6140beSAndroid Build Coastguard Worker  * Copyright (C) 2021 The Chromium OS Authors
5*0d6140beSAndroid Build Coastguard Worker  *
6*0d6140beSAndroid Build Coastguard Worker  * This program is free software; you can redistribute it and/or modify
7*0d6140beSAndroid Build Coastguard Worker  * it under the terms of the GNU General Public License as published by
8*0d6140beSAndroid Build Coastguard Worker  * the Free Software Foundation; either version 2 of the License, or
9*0d6140beSAndroid Build Coastguard Worker  * (at your option) any later version.
10*0d6140beSAndroid Build Coastguard Worker  *
11*0d6140beSAndroid Build Coastguard Worker  * This program is distributed in the hope that it will be useful,
12*0d6140beSAndroid Build Coastguard Worker  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13*0d6140beSAndroid Build Coastguard Worker  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14*0d6140beSAndroid Build Coastguard Worker  * GNU General Public License for more details.
15*0d6140beSAndroid Build Coastguard Worker  */
16*0d6140beSAndroid Build Coastguard Worker 
17*0d6140beSAndroid Build Coastguard Worker #include <linux/i2c-dev.h>
18*0d6140beSAndroid Build Coastguard Worker #include <linux/i2c.h>
19*0d6140beSAndroid Build Coastguard Worker #include <stdlib.h>
20*0d6140beSAndroid Build Coastguard Worker #include <string.h>
21*0d6140beSAndroid Build Coastguard Worker #include <sys/ioctl.h>
22*0d6140beSAndroid Build Coastguard Worker #include <unistd.h>
23*0d6140beSAndroid Build Coastguard Worker 
24*0d6140beSAndroid Build Coastguard Worker #include "flash.h"
25*0d6140beSAndroid Build Coastguard Worker #include "i2c_helper.h"
26*0d6140beSAndroid Build Coastguard Worker #include "programmer.h"
27*0d6140beSAndroid Build Coastguard Worker #include "spi.h"
28*0d6140beSAndroid Build Coastguard Worker 
29*0d6140beSAndroid Build Coastguard Worker #define ISP_PORT   (0x92 >> 1)
30*0d6140beSAndroid Build Coastguard Worker #define DEBUG_PORT (0xb2 >> 1)
31*0d6140beSAndroid Build Coastguard Worker 
32*0d6140beSAndroid Build Coastguard Worker #define MTK_CMD_WRITE 0x10
33*0d6140beSAndroid Build Coastguard Worker #define MTK_CMD_READ 0x11
34*0d6140beSAndroid Build Coastguard Worker #define MTK_CMD_END 0x12
35*0d6140beSAndroid Build Coastguard Worker 
36*0d6140beSAndroid Build Coastguard Worker struct mediatek_data {
37*0d6140beSAndroid Build Coastguard Worker 	int fd;
38*0d6140beSAndroid Build Coastguard Worker 	unsigned long funcs;
39*0d6140beSAndroid Build Coastguard Worker };
40*0d6140beSAndroid Build Coastguard Worker 
41*0d6140beSAndroid Build Coastguard Worker // Returns null pointer on error.
get_data_from_context(const struct flashctx * flash)42*0d6140beSAndroid Build Coastguard Worker static const struct mediatek_data *get_data_from_context(
43*0d6140beSAndroid Build Coastguard Worker 	const struct flashctx *flash)
44*0d6140beSAndroid Build Coastguard Worker {
45*0d6140beSAndroid Build Coastguard Worker 	if (!flash || !flash->mst || !flash->mst->spi.data) {
46*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Unable to extract data from flash context\n");
47*0d6140beSAndroid Build Coastguard Worker 		return NULL;
48*0d6140beSAndroid Build Coastguard Worker 	}
49*0d6140beSAndroid Build Coastguard Worker 	return (const struct mediatek_data *)flash->mst->spi.data;
50*0d6140beSAndroid Build Coastguard Worker }
51*0d6140beSAndroid Build Coastguard Worker 
52*0d6140beSAndroid Build Coastguard Worker // Returns bytes read, negative value on error.
read_raw(const struct mediatek_data * port,uint16_t addr,uint8_t * buf,size_t len)53*0d6140beSAndroid Build Coastguard Worker static int read_raw(const struct mediatek_data *port, uint16_t addr,
54*0d6140beSAndroid Build Coastguard Worker 	uint8_t *buf, size_t len)
55*0d6140beSAndroid Build Coastguard Worker {
56*0d6140beSAndroid Build Coastguard Worker 	int ret;
57*0d6140beSAndroid Build Coastguard Worker 
58*0d6140beSAndroid Build Coastguard Worker 	if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
59*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Invalid length for read command: %zu\n", len);
60*0d6140beSAndroid Build Coastguard Worker 		return SPI_INVALID_LENGTH;
61*0d6140beSAndroid Build Coastguard Worker 	}
62*0d6140beSAndroid Build Coastguard Worker 
63*0d6140beSAndroid Build Coastguard Worker 	ret = ioctl(port->fd, I2C_SLAVE, addr);
64*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
65*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to set slave address 0x%02x (%d)\n", addr, ret);
66*0d6140beSAndroid Build Coastguard Worker 		return ret;
67*0d6140beSAndroid Build Coastguard Worker 	}
68*0d6140beSAndroid Build Coastguard Worker 
69*0d6140beSAndroid Build Coastguard Worker 	if (port->funcs & I2C_FUNC_I2C) {
70*0d6140beSAndroid Build Coastguard Worker 		// Use raw I2C read.
71*0d6140beSAndroid Build Coastguard Worker 		uint8_t command = MTK_CMD_READ;
72*0d6140beSAndroid Build Coastguard Worker 		if (write(port->fd, &command, 1) != 1) {
73*0d6140beSAndroid Build Coastguard Worker 			return SPI_GENERIC_ERROR;
74*0d6140beSAndroid Build Coastguard Worker 		}
75*0d6140beSAndroid Build Coastguard Worker 		if (read(port->fd, buf, len) != (int)len) {
76*0d6140beSAndroid Build Coastguard Worker 			return SPI_GENERIC_ERROR;
77*0d6140beSAndroid Build Coastguard Worker 		}
78*0d6140beSAndroid Build Coastguard Worker 		return len;
79*0d6140beSAndroid Build Coastguard Worker 	}
80*0d6140beSAndroid Build Coastguard Worker 
81*0d6140beSAndroid Build Coastguard Worker 	union i2c_smbus_data data = {
82*0d6140beSAndroid Build Coastguard Worker 		.block[0] = len,
83*0d6140beSAndroid Build Coastguard Worker 	};
84*0d6140beSAndroid Build Coastguard Worker 	struct i2c_smbus_ioctl_data args = {
85*0d6140beSAndroid Build Coastguard Worker 		.read_write = I2C_SMBUS_READ,
86*0d6140beSAndroid Build Coastguard Worker 		.command = MTK_CMD_READ,
87*0d6140beSAndroid Build Coastguard Worker 		.size = I2C_SMBUS_I2C_BLOCK_DATA,
88*0d6140beSAndroid Build Coastguard Worker 		.data = &data,
89*0d6140beSAndroid Build Coastguard Worker 	};
90*0d6140beSAndroid Build Coastguard Worker 	ret = ioctl(port->fd, I2C_SMBUS, &args);
91*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
92*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to read SMBus I2C block data\n");
93*0d6140beSAndroid Build Coastguard Worker 		return ret;
94*0d6140beSAndroid Build Coastguard Worker 	}
95*0d6140beSAndroid Build Coastguard Worker 	memcpy(buf, args.data->block + 1, len);
96*0d6140beSAndroid Build Coastguard Worker 	return args.data->block[0];
97*0d6140beSAndroid Build Coastguard Worker }
98*0d6140beSAndroid Build Coastguard Worker 
99*0d6140beSAndroid Build Coastguard Worker // Returns non-zero value on error.
write_command(const struct mediatek_data * port,uint16_t addr,uint8_t command,const uint8_t * buf,size_t len)100*0d6140beSAndroid Build Coastguard Worker static int write_command(const struct mediatek_data *port, uint16_t addr,
101*0d6140beSAndroid Build Coastguard Worker 	uint8_t command, const uint8_t *buf, size_t len)
102*0d6140beSAndroid Build Coastguard Worker {
103*0d6140beSAndroid Build Coastguard Worker 	int ret;
104*0d6140beSAndroid Build Coastguard Worker 
105*0d6140beSAndroid Build Coastguard Worker 	if (len > I2C_SMBUS_BLOCK_MAX) {
106*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Invalid length for write command: %zu\n", len);
107*0d6140beSAndroid Build Coastguard Worker 		return SPI_INVALID_LENGTH;
108*0d6140beSAndroid Build Coastguard Worker 	}
109*0d6140beSAndroid Build Coastguard Worker 
110*0d6140beSAndroid Build Coastguard Worker 	ret = ioctl(port->fd, I2C_SLAVE, addr);
111*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
112*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to set slave address: 0x%02x\n", addr);
113*0d6140beSAndroid Build Coastguard Worker 		return ret;
114*0d6140beSAndroid Build Coastguard Worker 	}
115*0d6140beSAndroid Build Coastguard Worker 
116*0d6140beSAndroid Build Coastguard Worker 	if (port->funcs & I2C_FUNC_I2C) {
117*0d6140beSAndroid Build Coastguard Worker 		// Use raw I2C write.
118*0d6140beSAndroid Build Coastguard Worker 		uint8_t raw_buffer[I2C_SMBUS_BLOCK_MAX + 1];
119*0d6140beSAndroid Build Coastguard Worker 		raw_buffer[0] = command;
120*0d6140beSAndroid Build Coastguard Worker 		if (len > 0) {
121*0d6140beSAndroid Build Coastguard Worker 			memcpy(raw_buffer + 1, buf, len);
122*0d6140beSAndroid Build Coastguard Worker 		}
123*0d6140beSAndroid Build Coastguard Worker 		if (write(port->fd, raw_buffer, len + 1) != (int)(len + 1)) {
124*0d6140beSAndroid Build Coastguard Worker 			return SPI_GENERIC_ERROR;
125*0d6140beSAndroid Build Coastguard Worker 		}
126*0d6140beSAndroid Build Coastguard Worker 		return 0;
127*0d6140beSAndroid Build Coastguard Worker 	}
128*0d6140beSAndroid Build Coastguard Worker 
129*0d6140beSAndroid Build Coastguard Worker 	union i2c_smbus_data data = {0};
130*0d6140beSAndroid Build Coastguard Worker 	struct i2c_smbus_ioctl_data args = {
131*0d6140beSAndroid Build Coastguard Worker 		.read_write = I2C_SMBUS_WRITE,
132*0d6140beSAndroid Build Coastguard Worker 		.command = command,
133*0d6140beSAndroid Build Coastguard Worker 		.data = &data,
134*0d6140beSAndroid Build Coastguard Worker 	};
135*0d6140beSAndroid Build Coastguard Worker 
136*0d6140beSAndroid Build Coastguard Worker 	// Special case single byte commands, as empty I2C block data commands
137*0d6140beSAndroid Build Coastguard Worker 	// failed on this component in practice.
138*0d6140beSAndroid Build Coastguard Worker 	if (len == 0) {
139*0d6140beSAndroid Build Coastguard Worker 		args.size = I2C_SMBUS_BYTE;
140*0d6140beSAndroid Build Coastguard Worker 		ret = ioctl(port->fd, I2C_SMBUS, &args);
141*0d6140beSAndroid Build Coastguard Worker 		if (ret) {
142*0d6140beSAndroid Build Coastguard Worker 			msg_pdbg("Failed to write SMBus byte: 0x%02x\n", command);
143*0d6140beSAndroid Build Coastguard Worker 		}
144*0d6140beSAndroid Build Coastguard Worker 		return ret;
145*0d6140beSAndroid Build Coastguard Worker 	}
146*0d6140beSAndroid Build Coastguard Worker 
147*0d6140beSAndroid Build Coastguard Worker 	args.size = I2C_SMBUS_I2C_BLOCK_DATA;
148*0d6140beSAndroid Build Coastguard Worker 	data.block[0] = len;
149*0d6140beSAndroid Build Coastguard Worker 	if (buf && len) {
150*0d6140beSAndroid Build Coastguard Worker 		memcpy(data.block + 1, buf, len);
151*0d6140beSAndroid Build Coastguard Worker 	}
152*0d6140beSAndroid Build Coastguard Worker 	ret = ioctl(port->fd, I2C_SMBUS, &args);
153*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
154*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to write SMBus I2C block data: 0x%02x\n", command);
155*0d6140beSAndroid Build Coastguard Worker 	}
156*0d6140beSAndroid Build Coastguard Worker 	return ret;
157*0d6140beSAndroid Build Coastguard Worker }
158*0d6140beSAndroid Build Coastguard Worker 
159*0d6140beSAndroid Build Coastguard Worker // Returns non-zero value on error.
write_raw(const struct mediatek_data * port,uint16_t addr,const uint8_t * buf,size_t len)160*0d6140beSAndroid Build Coastguard Worker static int write_raw(const struct mediatek_data *port, uint16_t addr,
161*0d6140beSAndroid Build Coastguard Worker 	const uint8_t *buf, size_t len)
162*0d6140beSAndroid Build Coastguard Worker {
163*0d6140beSAndroid Build Coastguard Worker 	if (len < 1) {
164*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Invalid write length: %zu\n", len);
165*0d6140beSAndroid Build Coastguard Worker 		return SPI_INVALID_LENGTH;
166*0d6140beSAndroid Build Coastguard Worker 	}
167*0d6140beSAndroid Build Coastguard Worker 	return write_command(port, addr, buf[0], buf + 1, len - 1);
168*0d6140beSAndroid Build Coastguard Worker }
169*0d6140beSAndroid Build Coastguard Worker 
170*0d6140beSAndroid Build Coastguard Worker // Read from a GPIO register via debug port. Returns non-zero value on error.
mediatek_read_gpio(const struct mediatek_data * port,uint16_t gpio_addr,uint8_t * value)171*0d6140beSAndroid Build Coastguard Worker static int mediatek_read_gpio(const struct mediatek_data *port,
172*0d6140beSAndroid Build Coastguard Worker 	uint16_t gpio_addr, uint8_t *value)
173*0d6140beSAndroid Build Coastguard Worker {
174*0d6140beSAndroid Build Coastguard Worker 	int ret;
175*0d6140beSAndroid Build Coastguard Worker 
176*0d6140beSAndroid Build Coastguard Worker 	uint8_t data[2];
177*0d6140beSAndroid Build Coastguard Worker 	data[0] = gpio_addr >> 8;
178*0d6140beSAndroid Build Coastguard Worker 	data[1] = gpio_addr & 0xff;
179*0d6140beSAndroid Build Coastguard Worker 
180*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, MTK_CMD_WRITE, data, ARRAY_SIZE(data));
181*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
182*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to issue read GPIO command at address 0x%04x\n", gpio_addr);
183*0d6140beSAndroid Build Coastguard Worker 		return ret;
184*0d6140beSAndroid Build Coastguard Worker 	}
185*0d6140beSAndroid Build Coastguard Worker 
186*0d6140beSAndroid Build Coastguard Worker 	size_t len = 1;
187*0d6140beSAndroid Build Coastguard Worker 	ret = read_raw(port, DEBUG_PORT, value, len);
188*0d6140beSAndroid Build Coastguard Worker 	if (ret < 0) {
189*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to read GPIO register at address 0x%04x\n", gpio_addr);
190*0d6140beSAndroid Build Coastguard Worker 		return ret;
191*0d6140beSAndroid Build Coastguard Worker 	}
192*0d6140beSAndroid Build Coastguard Worker 
193*0d6140beSAndroid Build Coastguard Worker 	if (ret != 1) {
194*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("GPIO read returned improper length: %d\n", ret);
195*0d6140beSAndroid Build Coastguard Worker 		return SPI_INVALID_LENGTH;
196*0d6140beSAndroid Build Coastguard Worker 	}
197*0d6140beSAndroid Build Coastguard Worker 
198*0d6140beSAndroid Build Coastguard Worker 	return 0;
199*0d6140beSAndroid Build Coastguard Worker }
200*0d6140beSAndroid Build Coastguard Worker 
201*0d6140beSAndroid Build Coastguard Worker // Write to a GPIO register via the debug port. Returns non-zero value on error.
mediatek_write_gpio(const struct mediatek_data * port,uint16_t gpio_addr,uint8_t value)202*0d6140beSAndroid Build Coastguard Worker static int mediatek_write_gpio(const struct mediatek_data *port,
203*0d6140beSAndroid Build Coastguard Worker 	uint16_t gpio_addr, uint8_t value)
204*0d6140beSAndroid Build Coastguard Worker {
205*0d6140beSAndroid Build Coastguard Worker 	uint8_t data[3];
206*0d6140beSAndroid Build Coastguard Worker 	data[0] = gpio_addr >> 8;
207*0d6140beSAndroid Build Coastguard Worker 	data[1] = gpio_addr & 0xff;
208*0d6140beSAndroid Build Coastguard Worker 	data[2] = value;
209*0d6140beSAndroid Build Coastguard Worker 
210*0d6140beSAndroid Build Coastguard Worker 	return write_command(port, DEBUG_PORT, MTK_CMD_WRITE, data, ARRAY_SIZE(data));
211*0d6140beSAndroid Build Coastguard Worker }
212*0d6140beSAndroid Build Coastguard Worker 
213*0d6140beSAndroid Build Coastguard Worker // Write a single bit value to a GPIO register via the debug port. Returns
214*0d6140beSAndroid Build Coastguard Worker // non-zero value on error.
mediatek_set_gpio_bit(const struct mediatek_data * port,uint16_t gpio_addr,int bit,int value)215*0d6140beSAndroid Build Coastguard Worker static int mediatek_set_gpio_bit(const struct mediatek_data *port,
216*0d6140beSAndroid Build Coastguard Worker 	uint16_t gpio_addr, int bit, int value)
217*0d6140beSAndroid Build Coastguard Worker {
218*0d6140beSAndroid Build Coastguard Worker 	int ret;
219*0d6140beSAndroid Build Coastguard Worker 	uint8_t data;
220*0d6140beSAndroid Build Coastguard Worker 
221*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_read_gpio(port, gpio_addr, &data);
222*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
223*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to read GPIO 0x%04x\n", gpio_addr);
224*0d6140beSAndroid Build Coastguard Worker 		return ret;
225*0d6140beSAndroid Build Coastguard Worker 	}
226*0d6140beSAndroid Build Coastguard Worker 
227*0d6140beSAndroid Build Coastguard Worker 	if (value) {
228*0d6140beSAndroid Build Coastguard Worker 		data |= (1 << bit);
229*0d6140beSAndroid Build Coastguard Worker 	} else {
230*0d6140beSAndroid Build Coastguard Worker 		data &= ~(1 << bit);
231*0d6140beSAndroid Build Coastguard Worker 	}
232*0d6140beSAndroid Build Coastguard Worker 
233*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_write_gpio(port, gpio_addr, data);
234*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
235*0d6140beSAndroid Build Coastguard Worker 		msg_pdbg("Failed to set GPIO 0x%04x to 0x%02x\n", gpio_addr, data);
236*0d6140beSAndroid Build Coastguard Worker 		return ret;
237*0d6140beSAndroid Build Coastguard Worker 	}
238*0d6140beSAndroid Build Coastguard Worker 	return ret;
239*0d6140beSAndroid Build Coastguard Worker }
240*0d6140beSAndroid Build Coastguard Worker 
241*0d6140beSAndroid Build Coastguard Worker // Poke the GPIO line that goes to SPI WP# using the MST9U GPIO register
242*0d6140beSAndroid Build Coastguard Worker // addresses. Returns non-zero value on error.
mediatek_set_write_protect(const struct mediatek_data * port,int protected)243*0d6140beSAndroid Build Coastguard Worker static int mediatek_set_write_protect(const struct mediatek_data *port,
244*0d6140beSAndroid Build Coastguard Worker 	int protected)
245*0d6140beSAndroid Build Coastguard Worker {
246*0d6140beSAndroid Build Coastguard Worker 	int ret;
247*0d6140beSAndroid Build Coastguard Worker 
248*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_set_gpio_bit(port, 0x426, 7, (protected == 0));
249*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
250*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to set GPIO out value: %d\n", protected == 0);
251*0d6140beSAndroid Build Coastguard Worker 		return ret;
252*0d6140beSAndroid Build Coastguard Worker 	}
253*0d6140beSAndroid Build Coastguard Worker 
254*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_set_gpio_bit(port, 0x428, 7, (protected != 0));
255*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
256*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to set GPIO enable value: %d\n", protected != 0);
257*0d6140beSAndroid Build Coastguard Worker 		return ret;
258*0d6140beSAndroid Build Coastguard Worker 	}
259*0d6140beSAndroid Build Coastguard Worker 
260*0d6140beSAndroid Build Coastguard Worker 	return 0;
261*0d6140beSAndroid Build Coastguard Worker }
262*0d6140beSAndroid Build Coastguard Worker 
263*0d6140beSAndroid Build Coastguard Worker // Enter serial debug mode using "Option 1" for MST9U and select I2C channel 0
264*0d6140beSAndroid Build Coastguard Worker // to configure write protect GPIOs. Returns non-zero value on error.
mediatek_enter_serial_debug_mode(const struct mediatek_data * port)265*0d6140beSAndroid Build Coastguard Worker static int mediatek_enter_serial_debug_mode(const struct mediatek_data *port)
266*0d6140beSAndroid Build Coastguard Worker {
267*0d6140beSAndroid Build Coastguard Worker 	int ret;
268*0d6140beSAndroid Build Coastguard Worker 
269*0d6140beSAndroid Build Coastguard Worker 	uint8_t enter_serial_debug[] = { 'S', 'E', 'R', 'D', 'B' };
270*0d6140beSAndroid Build Coastguard Worker 	ret = write_raw(port, DEBUG_PORT, enter_serial_debug,
271*0d6140beSAndroid Build Coastguard Worker 		ARRAY_SIZE(enter_serial_debug));
272*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
273*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to send enter serial debug mode command\n");
274*0d6140beSAndroid Build Coastguard Worker 		return ret;
275*0d6140beSAndroid Build Coastguard Worker 	}
276*0d6140beSAndroid Build Coastguard Worker 
277*0d6140beSAndroid Build Coastguard Worker 	uint8_t enter_single_step_1[] = { 0xc0, 0xc1, 0x53 };
278*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, MTK_CMD_WRITE,
279*0d6140beSAndroid Build Coastguard Worker 		enter_single_step_1, ARRAY_SIZE(enter_single_step_1));
280*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
281*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to enter serial single step mode (part 1)\n");
282*0d6140beSAndroid Build Coastguard Worker 		return ret;
283*0d6140beSAndroid Build Coastguard Worker 	}
284*0d6140beSAndroid Build Coastguard Worker 
285*0d6140beSAndroid Build Coastguard Worker 	uint8_t enter_single_step_2[] = { 0x1f, 0xc1, 0x53 };
286*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, MTK_CMD_WRITE, enter_single_step_2,
287*0d6140beSAndroid Build Coastguard Worker 		ARRAY_SIZE(enter_single_step_2));
288*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
289*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to enter serial single step mode (part 2)\n");
290*0d6140beSAndroid Build Coastguard Worker 		return ret;
291*0d6140beSAndroid Build Coastguard Worker 	}
292*0d6140beSAndroid Build Coastguard Worker 
293*0d6140beSAndroid Build Coastguard Worker 	// Send each I2C channel 0 configuration byte individually.
294*0d6140beSAndroid Build Coastguard Worker 	uint8_t i2c_channel_0_config[] =
295*0d6140beSAndroid Build Coastguard Worker 		{ 0x80, 0x82, 0x84, 0x51, 0x7f, 0x37, 0x61 };
296*0d6140beSAndroid Build Coastguard Worker 	for (size_t i = 0; i < ARRAY_SIZE(i2c_channel_0_config); ++i) {
297*0d6140beSAndroid Build Coastguard Worker 		ret = write_command(
298*0d6140beSAndroid Build Coastguard Worker 			port, DEBUG_PORT, i2c_channel_0_config[i], NULL, 0);
299*0d6140beSAndroid Build Coastguard Worker 		if (ret) {
300*0d6140beSAndroid Build Coastguard Worker 			msg_perr("Failed to configure i2c channel 0: 0x%02x\n",
301*0d6140beSAndroid Build Coastguard Worker 				i2c_channel_0_config[i]);
302*0d6140beSAndroid Build Coastguard Worker 			return ret;
303*0d6140beSAndroid Build Coastguard Worker 		}
304*0d6140beSAndroid Build Coastguard Worker 	}
305*0d6140beSAndroid Build Coastguard Worker 
306*0d6140beSAndroid Build Coastguard Worker 	uint8_t enter_single_step_3[] = { 0x00, 0x00, 0x00 };
307*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, MTK_CMD_WRITE, enter_single_step_3,
308*0d6140beSAndroid Build Coastguard Worker 		ARRAY_SIZE(enter_single_step_3));
309*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
310*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to enter serial single step mode (part 3)\n");
311*0d6140beSAndroid Build Coastguard Worker 		return ret;
312*0d6140beSAndroid Build Coastguard Worker 	}
313*0d6140beSAndroid Build Coastguard Worker 
314*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, 0x35, NULL, 0);
315*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
316*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to send serial debug command (part 1)\n");
317*0d6140beSAndroid Build Coastguard Worker 		return ret;
318*0d6140beSAndroid Build Coastguard Worker 	}
319*0d6140beSAndroid Build Coastguard Worker 
320*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, 0x71, NULL, 0);
321*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
322*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to send serial debug command (part 2)\n");
323*0d6140beSAndroid Build Coastguard Worker 		return ret;
324*0d6140beSAndroid Build Coastguard Worker 	}
325*0d6140beSAndroid Build Coastguard Worker 
326*0d6140beSAndroid Build Coastguard Worker 	return 0;
327*0d6140beSAndroid Build Coastguard Worker }
328*0d6140beSAndroid Build Coastguard Worker 
329*0d6140beSAndroid Build Coastguard Worker // Returns non-zero value on error.
mediatek_enter_isp(const struct mediatek_data * port)330*0d6140beSAndroid Build Coastguard Worker static int mediatek_enter_isp(const struct mediatek_data *port)
331*0d6140beSAndroid Build Coastguard Worker {
332*0d6140beSAndroid Build Coastguard Worker 	int ret;
333*0d6140beSAndroid Build Coastguard Worker 
334*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_enter_serial_debug_mode(port);
335*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
336*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to enter serial debug mode\n");
337*0d6140beSAndroid Build Coastguard Worker 		return ret;
338*0d6140beSAndroid Build Coastguard Worker 	}
339*0d6140beSAndroid Build Coastguard Worker 
340*0d6140beSAndroid Build Coastguard Worker 	// MediaTek documentation says to do this twice just in case.
341*0d6140beSAndroid Build Coastguard Worker 	uint8_t enter_isp[] = { 'M', 'S', 'T', 'A', 'R' };
342*0d6140beSAndroid Build Coastguard Worker 	ret = write_raw(port, ISP_PORT, enter_isp, ARRAY_SIZE(enter_isp));
343*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
344*0d6140beSAndroid Build Coastguard Worker 		msg_gwarn("Failed to enter ISP mode, trying again\n");
345*0d6140beSAndroid Build Coastguard Worker 	}
346*0d6140beSAndroid Build Coastguard Worker 	ret = write_raw(port, ISP_PORT, enter_isp, ARRAY_SIZE(enter_isp));
347*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
348*0d6140beSAndroid Build Coastguard Worker 		msg_gwarn("Might already be in ISP mode, ignoring\n");
349*0d6140beSAndroid Build Coastguard Worker 	}
350*0d6140beSAndroid Build Coastguard Worker 
351*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_set_write_protect(port, 0);
352*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
353*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to disable write protection\n");
354*0d6140beSAndroid Build Coastguard Worker 		return ret;
355*0d6140beSAndroid Build Coastguard Worker 	}
356*0d6140beSAndroid Build Coastguard Worker 
357*0d6140beSAndroid Build Coastguard Worker 	return 0;
358*0d6140beSAndroid Build Coastguard Worker }
359*0d6140beSAndroid Build Coastguard Worker 
360*0d6140beSAndroid Build Coastguard Worker // Returns non-zero value on error.
mediatek_exit_isp(const struct mediatek_data * port)361*0d6140beSAndroid Build Coastguard Worker static int mediatek_exit_isp(const struct mediatek_data *port)
362*0d6140beSAndroid Build Coastguard Worker {
363*0d6140beSAndroid Build Coastguard Worker 	int ret;
364*0d6140beSAndroid Build Coastguard Worker 
365*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_set_write_protect(port, 1);
366*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
367*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to re-enable write protect\n");
368*0d6140beSAndroid Build Coastguard Worker 		return ret;
369*0d6140beSAndroid Build Coastguard Worker 	}
370*0d6140beSAndroid Build Coastguard Worker 
371*0d6140beSAndroid Build Coastguard Worker 	uint8_t exit_single_step[] = { 0xc0, 0xc1, 0xff };
372*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, MTK_CMD_WRITE, exit_single_step,
373*0d6140beSAndroid Build Coastguard Worker 		ARRAY_SIZE(exit_single_step));
374*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
375*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to exit single step mode\n");
376*0d6140beSAndroid Build Coastguard Worker 		return ret;
377*0d6140beSAndroid Build Coastguard Worker 	}
378*0d6140beSAndroid Build Coastguard Worker 
379*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, 0x34, NULL, 0);
380*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
381*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to exit serial debug mode (1), ignoring\n");
382*0d6140beSAndroid Build Coastguard Worker 	}
383*0d6140beSAndroid Build Coastguard Worker 
384*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, DEBUG_PORT, 0x45, NULL, 0);
385*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
386*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to exit serial debug mode (2), ignoring\n");
387*0d6140beSAndroid Build Coastguard Worker 	}
388*0d6140beSAndroid Build Coastguard Worker 
389*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, ISP_PORT, 0x24, NULL, 0);
390*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
391*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to exit ISP mode command, ignoring\n");
392*0d6140beSAndroid Build Coastguard Worker 	}
393*0d6140beSAndroid Build Coastguard Worker 
394*0d6140beSAndroid Build Coastguard Worker 	return 0;
395*0d6140beSAndroid Build Coastguard Worker }
396*0d6140beSAndroid Build Coastguard Worker 
mediatek_send_command(const struct flashctx * flash,unsigned int writecnt,unsigned int readcnt,const uint8_t * writearr,uint8_t * readarr)397*0d6140beSAndroid Build Coastguard Worker static int mediatek_send_command(const struct flashctx *flash,
398*0d6140beSAndroid Build Coastguard Worker 	unsigned int writecnt, unsigned int readcnt,
399*0d6140beSAndroid Build Coastguard Worker 	const uint8_t *writearr, uint8_t *readarr)
400*0d6140beSAndroid Build Coastguard Worker {
401*0d6140beSAndroid Build Coastguard Worker 	const struct mediatek_data *port = get_data_from_context(flash);
402*0d6140beSAndroid Build Coastguard Worker 	if (!port) {
403*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to extract chip data for ISP command\n");
404*0d6140beSAndroid Build Coastguard Worker 		return SPI_GENERIC_ERROR;
405*0d6140beSAndroid Build Coastguard Worker 	}
406*0d6140beSAndroid Build Coastguard Worker 
407*0d6140beSAndroid Build Coastguard Worker 	int ret;
408*0d6140beSAndroid Build Coastguard Worker 
409*0d6140beSAndroid Build Coastguard Worker 	if (writecnt) {
410*0d6140beSAndroid Build Coastguard Worker 		ret = write_command(port, ISP_PORT, MTK_CMD_WRITE,
411*0d6140beSAndroid Build Coastguard Worker 			writearr, writecnt);
412*0d6140beSAndroid Build Coastguard Worker 		if (ret) {
413*0d6140beSAndroid Build Coastguard Worker 			msg_perr("Failed to issue ISP write command\n");
414*0d6140beSAndroid Build Coastguard Worker 			return ret;
415*0d6140beSAndroid Build Coastguard Worker 		}
416*0d6140beSAndroid Build Coastguard Worker 	}
417*0d6140beSAndroid Build Coastguard Worker 
418*0d6140beSAndroid Build Coastguard Worker 	if (readcnt) {
419*0d6140beSAndroid Build Coastguard Worker 		size_t len = readcnt;
420*0d6140beSAndroid Build Coastguard Worker 		ret = read_raw(port, ISP_PORT, readarr, len);
421*0d6140beSAndroid Build Coastguard Worker 		if (ret < 0) {
422*0d6140beSAndroid Build Coastguard Worker 			msg_perr("Failed to read ISP command result\n");
423*0d6140beSAndroid Build Coastguard Worker 			return ret;
424*0d6140beSAndroid Build Coastguard Worker 		}
425*0d6140beSAndroid Build Coastguard Worker 
426*0d6140beSAndroid Build Coastguard Worker 		if (ret != (int)readcnt) {
427*0d6140beSAndroid Build Coastguard Worker 			msg_perr("Read length mismatched: expected %u got %d\n", readcnt, ret);
428*0d6140beSAndroid Build Coastguard Worker 			return SPI_INVALID_LENGTH;
429*0d6140beSAndroid Build Coastguard Worker 		}
430*0d6140beSAndroid Build Coastguard Worker 	}
431*0d6140beSAndroid Build Coastguard Worker 
432*0d6140beSAndroid Build Coastguard Worker 	// End the current command.
433*0d6140beSAndroid Build Coastguard Worker 	ret = write_command(port, ISP_PORT, MTK_CMD_END, NULL, 0);
434*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
435*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to end ISP command\n");
436*0d6140beSAndroid Build Coastguard Worker 		return ret;
437*0d6140beSAndroid Build Coastguard Worker 	}
438*0d6140beSAndroid Build Coastguard Worker 
439*0d6140beSAndroid Build Coastguard Worker 	return 0;
440*0d6140beSAndroid Build Coastguard Worker }
441*0d6140beSAndroid Build Coastguard Worker 
mediatek_shutdown(void * data)442*0d6140beSAndroid Build Coastguard Worker static int mediatek_shutdown(void *data)
443*0d6140beSAndroid Build Coastguard Worker {
444*0d6140beSAndroid Build Coastguard Worker 	int ret = 0;
445*0d6140beSAndroid Build Coastguard Worker 	struct mediatek_data *port = (struct mediatek_data *)data;
446*0d6140beSAndroid Build Coastguard Worker 
447*0d6140beSAndroid Build Coastguard Worker 	ret |= mediatek_exit_isp(port);
448*0d6140beSAndroid Build Coastguard Worker 	i2c_close(port->fd);
449*0d6140beSAndroid Build Coastguard Worker 	free(data);
450*0d6140beSAndroid Build Coastguard Worker 
451*0d6140beSAndroid Build Coastguard Worker 	return ret;
452*0d6140beSAndroid Build Coastguard Worker }
453*0d6140beSAndroid Build Coastguard Worker 
454*0d6140beSAndroid Build Coastguard Worker static const struct spi_master spi_master_i2c_mediatek = {
455*0d6140beSAndroid Build Coastguard Worker 	.max_data_read	= I2C_SMBUS_BLOCK_MAX,
456*0d6140beSAndroid Build Coastguard Worker 	// Leave room for 1-byte command and up to a 4-byte address.
457*0d6140beSAndroid Build Coastguard Worker 	.max_data_write	= I2C_SMBUS_BLOCK_MAX - 5,
458*0d6140beSAndroid Build Coastguard Worker 	.command	= mediatek_send_command,
459*0d6140beSAndroid Build Coastguard Worker 	.read		= default_spi_read,
460*0d6140beSAndroid Build Coastguard Worker 	.write_256	= default_spi_write_256,
461*0d6140beSAndroid Build Coastguard Worker 	.shutdown	= mediatek_shutdown,
462*0d6140beSAndroid Build Coastguard Worker };
463*0d6140beSAndroid Build Coastguard Worker 
get_params(const struct programmer_cfg * cfg,bool * allow_brick)464*0d6140beSAndroid Build Coastguard Worker static int get_params(const struct programmer_cfg *cfg, bool *allow_brick)
465*0d6140beSAndroid Build Coastguard Worker {
466*0d6140beSAndroid Build Coastguard Worker 	char *brick_str = NULL;
467*0d6140beSAndroid Build Coastguard Worker 	int ret = 0;
468*0d6140beSAndroid Build Coastguard Worker 
469*0d6140beSAndroid Build Coastguard Worker 	*allow_brick = false; /* Default behaviour is to bail. */
470*0d6140beSAndroid Build Coastguard Worker 	brick_str = extract_programmer_param_str(cfg, "allow_brick");
471*0d6140beSAndroid Build Coastguard Worker 	if (brick_str) {
472*0d6140beSAndroid Build Coastguard Worker 		if (!strcmp(brick_str, "yes")) {
473*0d6140beSAndroid Build Coastguard Worker 			*allow_brick = true;
474*0d6140beSAndroid Build Coastguard Worker 		} else {
475*0d6140beSAndroid Build Coastguard Worker 			msg_perr("%s: Incorrect param format, allow_brick=yes.\n", __func__);
476*0d6140beSAndroid Build Coastguard Worker 			ret = SPI_GENERIC_ERROR;
477*0d6140beSAndroid Build Coastguard Worker 		}
478*0d6140beSAndroid Build Coastguard Worker 	}
479*0d6140beSAndroid Build Coastguard Worker 	free(brick_str);
480*0d6140beSAndroid Build Coastguard Worker 
481*0d6140beSAndroid Build Coastguard Worker 	return ret;
482*0d6140beSAndroid Build Coastguard Worker }
483*0d6140beSAndroid Build Coastguard Worker 
mediatek_init(const struct programmer_cfg * cfg)484*0d6140beSAndroid Build Coastguard Worker static int mediatek_init(const struct programmer_cfg *cfg)
485*0d6140beSAndroid Build Coastguard Worker {
486*0d6140beSAndroid Build Coastguard Worker 	int ret;
487*0d6140beSAndroid Build Coastguard Worker 	bool allow_brick;
488*0d6140beSAndroid Build Coastguard Worker 
489*0d6140beSAndroid Build Coastguard Worker 	if (get_params(cfg, &allow_brick))
490*0d6140beSAndroid Build Coastguard Worker 		return SPI_GENERIC_ERROR;
491*0d6140beSAndroid Build Coastguard Worker 
492*0d6140beSAndroid Build Coastguard Worker 	/*
493*0d6140beSAndroid Build Coastguard Worker 	 * TODO: Once board_enable can facilitate safe i2c allow listing
494*0d6140beSAndroid Build Coastguard Worker 	 * 	 then this can be removed.
495*0d6140beSAndroid Build Coastguard Worker 	 */
496*0d6140beSAndroid Build Coastguard Worker 	if (!allow_brick) {
497*0d6140beSAndroid Build Coastguard Worker 		msg_perr("%s: For i2c drivers you must explicitly 'allow_brick=yes'. ", __func__);
498*0d6140beSAndroid Build Coastguard Worker 		msg_perr("There is currently no way to determine if the programmer works on a board "
499*0d6140beSAndroid Build Coastguard Worker 			 "as i2c device address space can be overloaded. Set 'allow_brick=yes' if "
500*0d6140beSAndroid Build Coastguard Worker 			 "you are sure you know what you are doing.\n");
501*0d6140beSAndroid Build Coastguard Worker 		return SPI_GENERIC_ERROR;
502*0d6140beSAndroid Build Coastguard Worker 	}
503*0d6140beSAndroid Build Coastguard Worker 
504*0d6140beSAndroid Build Coastguard Worker 	int fd = i2c_open_from_programmer_params(cfg, ISP_PORT, 0);
505*0d6140beSAndroid Build Coastguard Worker 	if (fd < 0) {
506*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to open i2c\n");
507*0d6140beSAndroid Build Coastguard Worker 		return fd;
508*0d6140beSAndroid Build Coastguard Worker 	}
509*0d6140beSAndroid Build Coastguard Worker 
510*0d6140beSAndroid Build Coastguard Worker 	struct mediatek_data *port = calloc(1, sizeof(*port));
511*0d6140beSAndroid Build Coastguard Worker 	if (!port) {
512*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Unable to allocate space for SPI master data\n");
513*0d6140beSAndroid Build Coastguard Worker 		i2c_close(fd);
514*0d6140beSAndroid Build Coastguard Worker 		return SPI_GENERIC_ERROR;
515*0d6140beSAndroid Build Coastguard Worker 	}
516*0d6140beSAndroid Build Coastguard Worker 	port->fd = fd;
517*0d6140beSAndroid Build Coastguard Worker 
518*0d6140beSAndroid Build Coastguard Worker 	ret = ioctl(fd, I2C_FUNCS, &(port->funcs));
519*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
520*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to fetch I2C bus functionality\n");
521*0d6140beSAndroid Build Coastguard Worker 		free(port);
522*0d6140beSAndroid Build Coastguard Worker 		i2c_close(fd);
523*0d6140beSAndroid Build Coastguard Worker 		return ret;
524*0d6140beSAndroid Build Coastguard Worker 	}
525*0d6140beSAndroid Build Coastguard Worker 
526*0d6140beSAndroid Build Coastguard Worker 	ret = mediatek_enter_isp(port);
527*0d6140beSAndroid Build Coastguard Worker 	if (ret) {
528*0d6140beSAndroid Build Coastguard Worker 		msg_perr("Failed to enter ISP mode\n");
529*0d6140beSAndroid Build Coastguard Worker 		free(port);
530*0d6140beSAndroid Build Coastguard Worker 		i2c_close(fd);
531*0d6140beSAndroid Build Coastguard Worker 		return ret;
532*0d6140beSAndroid Build Coastguard Worker 	}
533*0d6140beSAndroid Build Coastguard Worker 
534*0d6140beSAndroid Build Coastguard Worker 	return register_spi_master(&spi_master_i2c_mediatek, port);
535*0d6140beSAndroid Build Coastguard Worker }
536*0d6140beSAndroid Build Coastguard Worker 
537*0d6140beSAndroid Build Coastguard Worker const struct programmer_entry programmer_mediatek_i2c_spi = {
538*0d6140beSAndroid Build Coastguard Worker 	.name			= "mediatek_i2c_spi",
539*0d6140beSAndroid Build Coastguard Worker 	.type			= OTHER,
540*0d6140beSAndroid Build Coastguard Worker 	.devs.note		= "Device files /dev/i2c-*\n",
541*0d6140beSAndroid Build Coastguard Worker 	.init			= mediatek_init,
542*0d6140beSAndroid Build Coastguard Worker };
543