Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 1 | /* |
| 2 | * This file is part of the flashrom project. |
| 3 | * |
| 4 | * Copyright (C) 2010 Carl-Daniel Hailfinger |
| 5 | * Copyright (C) 2014 Justin Chevrier |
| 6 | * |
| 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. |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 15 | */ |
| 16 | |
| 17 | /* |
| 18 | * Connections are as follows: |
| 19 | * |
| 20 | * +------+-----+----------+ |
| 21 | * | SPI | Pin | PICkit2 | |
| 22 | * +------+-----+----------+ |
| 23 | * | /CS | 1 | VPP/MCLR | |
| 24 | * | VCC | 2 | VDD | |
| 25 | * | GND | 3 | GND | |
| 26 | * | MISO | 4 | PGD | |
| 27 | * | SCLK | 5 | PDC | |
| 28 | * | MOSI | 6 | AUX | |
| 29 | * +------+-----+----------+ |
| 30 | * |
| 31 | * Inspiration and some specifics of the interface came via the AVRDude |
| 32 | * PICkit2 code: https://github.com/steve-m/avrdude/blob/master/pickit2.c |
| 33 | */ |
| 34 | |
| 35 | #include "platform.h" |
| 36 | |
| 37 | #include <stdlib.h> |
| 38 | #include <stdio.h> |
| 39 | #include <string.h> |
| 40 | #include <limits.h> |
| 41 | #include <errno.h> |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 42 | #include <libusb.h> |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 43 | |
| 44 | #include "flash.h" |
| 45 | #include "chipdrivers.h" |
| 46 | #include "programmer.h" |
| 47 | #include "spi.h" |
| 48 | |
Thomas Heijligen | cc853d8 | 2021-05-04 15:32:17 +0200 | [diff] [blame] | 49 | static const struct dev_entry devs_pickit2_spi[] = { |
Stefan Tauner | f31fe84 | 2016-02-22 08:59:15 +0000 | [diff] [blame] | 50 | {0x04D8, 0x0033, OK, "Microchip", "PICkit 2"}, |
| 51 | |
Evgeny Zinoviev | 83c56b8 | 2019-11-05 17:47:43 +0300 | [diff] [blame] | 52 | {0} |
Stefan Tauner | f31fe84 | 2016-02-22 08:59:15 +0000 | [diff] [blame] | 53 | }; |
| 54 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 55 | struct pickit2_spi_data { |
| 56 | libusb_device_handle *pickit2_handle; |
| 57 | }; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 58 | |
| 59 | /* Default USB transaction timeout in ms */ |
| 60 | #define DFLT_TIMEOUT 10000 |
| 61 | |
| 62 | #define CMD_LENGTH 64 |
| 63 | #define ENDPOINT_OUT 0x01 |
| 64 | #define ENDPOINT_IN 0x81 |
| 65 | |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 66 | #define CMD_GET_VERSION 0x76 |
| 67 | #define CMD_SET_VDD 0xA0 |
| 68 | #define CMD_SET_VPP 0xA1 |
| 69 | #define CMD_READ_VDD_VPP 0xA3 |
| 70 | #define CMD_EXEC_SCRIPT 0xA6 |
| 71 | #define CMD_CLR_DLOAD_BUFF 0xA7 |
| 72 | #define CMD_DOWNLOAD_DATA 0xA8 |
| 73 | #define CMD_CLR_ULOAD_BUFF 0xA9 |
| 74 | #define CMD_UPLOAD_DATA 0xAA |
| 75 | #define CMD_END_OF_BUFFER 0xAD |
| 76 | |
| 77 | #define SCR_SPI_READ_BUF 0xC5 |
| 78 | #define SCR_SPI_WRITE_BUF 0xC6 |
| 79 | #define SCR_SET_AUX 0xCF |
| 80 | #define SCR_LOOP 0xE9 |
| 81 | #define SCR_SET_ICSP_CLK_PERIOD 0xEA |
| 82 | #define SCR_SET_PINS 0xF3 |
| 83 | #define SCR_BUSY_LED_OFF 0xF4 |
| 84 | #define SCR_BUSY_LED_ON 0xF5 |
| 85 | #define SCR_MCLR_GND_OFF 0xF6 |
| 86 | #define SCR_MCLR_GND_ON 0xF7 |
| 87 | #define SCR_VPP_PWM_OFF 0xF8 |
| 88 | #define SCR_VPP_PWM_ON 0xF9 |
| 89 | #define SCR_VPP_OFF 0xFA |
| 90 | #define SCR_VPP_ON 0xFB |
| 91 | #define SCR_VDD_OFF 0xFE |
| 92 | #define SCR_VDD_ON 0xFF |
| 93 | |
Angel Pons | 75d6ec6 | 2022-07-16 12:12:50 +0200 | [diff] [blame] | 94 | static int pickit2_interrupt_transfer(libusb_device_handle *handle, unsigned char endpoint, unsigned char *data) |
| 95 | { |
| 96 | int transferred; |
| 97 | return libusb_interrupt_transfer(handle, endpoint, data, CMD_LENGTH, &transferred, DFLT_TIMEOUT); |
| 98 | } |
| 99 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 100 | static int pickit2_get_firmware_version(libusb_device_handle *pickit2_handle) |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 101 | { |
| 102 | int ret; |
| 103 | uint8_t command[CMD_LENGTH] = {CMD_GET_VERSION, CMD_END_OF_BUFFER}; |
Elyes HAOUAS | 0cacb11 | 2019-02-04 12:16:38 +0100 | [diff] [blame] | 104 | |
Angel Pons | 75d6ec6 | 2022-07-16 12:12:50 +0200 | [diff] [blame] | 105 | ret = pickit2_interrupt_transfer(pickit2_handle, ENDPOINT_OUT, command); |
Elyes HAOUAS | 3384fb6 | 2019-07-18 14:00:13 +0200 | [diff] [blame] | 106 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 107 | if (ret != 0) { |
| 108 | msg_perr("Command Get Firmware Version failed!\n"); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 109 | return 1; |
| 110 | } |
| 111 | |
Angel Pons | 75d6ec6 | 2022-07-16 12:12:50 +0200 | [diff] [blame] | 112 | ret = pickit2_interrupt_transfer(pickit2_handle, ENDPOINT_IN, command); |
Elyes HAOUAS | 3384fb6 | 2019-07-18 14:00:13 +0200 | [diff] [blame] | 113 | |
| 114 | if (ret != 0) { |
| 115 | msg_perr("Command Get Firmware Version failed!\n"); |
| 116 | return 1; |
| 117 | } |
| 118 | |
| 119 | msg_pdbg("PICkit2 Firmware Version: %d.%d\n", (int)command[0], (int)command[1]); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 120 | return 0; |
| 121 | } |
| 122 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 123 | static int pickit2_set_spi_voltage(libusb_device_handle *pickit2_handle, int millivolt) |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 124 | { |
| 125 | double voltage_selector; |
| 126 | switch (millivolt) { |
| 127 | case 0: |
| 128 | /* Admittedly this one is an assumption. */ |
| 129 | voltage_selector = 0; |
| 130 | break; |
| 131 | case 1800: |
| 132 | voltage_selector = 1.8; |
| 133 | break; |
| 134 | case 2500: |
| 135 | voltage_selector = 2.5; |
| 136 | break; |
| 137 | case 3500: |
| 138 | voltage_selector = 3.5; |
| 139 | break; |
| 140 | default: |
| 141 | msg_perr("Unknown voltage %i mV! Aborting.\n", millivolt); |
| 142 | return 1; |
| 143 | } |
| 144 | msg_pdbg("Setting SPI voltage to %u.%03u V\n", millivolt / 1000, |
| 145 | millivolt % 1000); |
| 146 | |
| 147 | uint8_t command[CMD_LENGTH] = { |
| 148 | CMD_SET_VDD, |
| 149 | voltage_selector * 2048 + 672, |
| 150 | (voltage_selector * 2048 + 672) / 256, |
| 151 | voltage_selector * 36, |
| 152 | CMD_SET_VPP, |
| 153 | 0x40, |
| 154 | voltage_selector * 18.61, |
| 155 | voltage_selector * 13, |
| 156 | CMD_END_OF_BUFFER |
| 157 | }; |
Angel Pons | 75d6ec6 | 2022-07-16 12:12:50 +0200 | [diff] [blame] | 158 | int ret = pickit2_interrupt_transfer(pickit2_handle, ENDPOINT_OUT, command); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 159 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 160 | if (ret != 0) { |
| 161 | msg_perr("Command Set Voltage failed!\n"); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 162 | return 1; |
| 163 | } |
| 164 | |
| 165 | return 0; |
| 166 | } |
| 167 | |
| 168 | struct pickit2_spispeeds { |
| 169 | const char *const name; |
| 170 | const int speed; |
| 171 | }; |
| 172 | |
| 173 | static const struct pickit2_spispeeds spispeeds[] = { |
| 174 | { "1M", 0x1 }, |
| 175 | { "500k", 0x2 }, |
| 176 | { "333k", 0x3 }, |
| 177 | { "250k", 0x4 }, |
| 178 | { NULL, 0x0 }, |
| 179 | }; |
| 180 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 181 | static int pickit2_set_spi_speed(libusb_device_handle *pickit2_handle, unsigned int spispeed_idx) |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 182 | { |
| 183 | msg_pdbg("SPI speed is %sHz\n", spispeeds[spispeed_idx].name); |
| 184 | |
| 185 | uint8_t command[CMD_LENGTH] = { |
| 186 | CMD_EXEC_SCRIPT, |
| 187 | 2, |
| 188 | SCR_SET_ICSP_CLK_PERIOD, |
| 189 | spispeed_idx, |
| 190 | CMD_END_OF_BUFFER |
| 191 | }; |
| 192 | |
Angel Pons | 75d6ec6 | 2022-07-16 12:12:50 +0200 | [diff] [blame] | 193 | int ret = pickit2_interrupt_transfer(pickit2_handle, ENDPOINT_OUT, command); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 194 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 195 | if (ret != 0) { |
| 196 | msg_perr("Command Set SPI Speed failed!\n"); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 197 | return 1; |
| 198 | } |
| 199 | |
| 200 | return 0; |
| 201 | } |
| 202 | |
Edward O'Callaghan | 5eca427 | 2020-04-12 17:27:53 +1000 | [diff] [blame] | 203 | static int pickit2_spi_send_command(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt, |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 204 | const unsigned char *writearr, unsigned char *readarr) |
| 205 | { |
Felix Singer | 48c3f18 | 2022-07-29 03:16:19 +0200 | [diff] [blame] | 206 | const unsigned int total_packetsize = writecnt + readcnt + 20; |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 207 | struct pickit2_spi_data *pickit2_data = flash->mst->spi.data; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 208 | |
| 209 | /* Maximum number of bytes per transaction (including command overhead) is 64. Lets play it safe |
| 210 | * and always assume the worst case scenario of 20 bytes command overhead. |
| 211 | */ |
Felix Singer | 48c3f18 | 2022-07-29 03:16:19 +0200 | [diff] [blame] | 212 | if (total_packetsize > CMD_LENGTH) { |
Felix Singer | d07c4a4 | 2022-07-29 03:09:02 +0200 | [diff] [blame] | 213 | msg_perr("\nTotal packetsize (%i) is greater than %i supported, aborting.\n", |
Felix Singer | 48c3f18 | 2022-07-29 03:16:19 +0200 | [diff] [blame] | 214 | total_packetsize, CMD_LENGTH); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 215 | return 1; |
| 216 | } |
| 217 | |
| 218 | uint8_t buf[CMD_LENGTH] = {CMD_DOWNLOAD_DATA, writecnt}; |
Nico Huber | 519be66 | 2018-12-23 20:03:35 +0100 | [diff] [blame] | 219 | unsigned int i = 2; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 220 | for (; i < writecnt + 2; i++) { |
| 221 | buf[i] = writearr[i - 2]; |
| 222 | } |
| 223 | |
| 224 | buf[i++] = CMD_CLR_ULOAD_BUFF; |
| 225 | buf[i++] = CMD_EXEC_SCRIPT; |
| 226 | |
| 227 | /* Determine script length based on number of bytes to be read or written */ |
| 228 | if (writecnt == 1 && readcnt == 1) |
| 229 | buf[i++] = 7; |
| 230 | else if (writecnt == 1 || readcnt == 1) |
| 231 | buf[i++] = 10; |
| 232 | else |
| 233 | buf[i++] = 13; |
Elyes HAOUAS | 0cacb11 | 2019-02-04 12:16:38 +0100 | [diff] [blame] | 234 | |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 235 | /* Assert CS# */ |
| 236 | buf[i++] = SCR_VPP_OFF; |
| 237 | buf[i++] = SCR_MCLR_GND_ON; |
| 238 | |
| 239 | buf[i++] = SCR_SPI_WRITE_BUF; |
| 240 | |
| 241 | if (writecnt > 1) { |
| 242 | buf[i++] = SCR_LOOP; |
| 243 | buf[i++] = 1; /* Loop back one instruction */ |
| 244 | buf[i++] = writecnt - 1; /* Number of times to loop */ |
| 245 | } |
| 246 | |
| 247 | if (readcnt) |
| 248 | buf[i++] = SCR_SPI_READ_BUF; |
| 249 | |
| 250 | if (readcnt > 1) { |
| 251 | buf[i++] = SCR_LOOP; |
| 252 | buf[i++] = 1; /* Loop back one instruction */ |
| 253 | buf[i++] = readcnt - 1; /* Number of times to loop */ |
| 254 | } |
| 255 | |
| 256 | /* De-assert CS# */ |
| 257 | buf[i++] = SCR_MCLR_GND_OFF; |
| 258 | buf[i++] = SCR_VPP_PWM_ON; |
| 259 | buf[i++] = SCR_VPP_ON; |
| 260 | |
| 261 | buf[i++] = CMD_UPLOAD_DATA; |
| 262 | buf[i++] = CMD_END_OF_BUFFER; |
| 263 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 264 | int ret = pickit2_interrupt_transfer(pickit2_data->pickit2_handle, ENDPOINT_OUT, buf); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 265 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 266 | if (ret != 0) { |
| 267 | msg_perr("Send SPI failed!\n"); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 268 | return 1; |
| 269 | } |
| 270 | |
| 271 | if (readcnt) { |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 272 | int length = 0; |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 273 | ret = libusb_interrupt_transfer(pickit2_data->pickit2_handle, |
| 274 | ENDPOINT_IN, buf, CMD_LENGTH, &length, DFLT_TIMEOUT); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 275 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 276 | if (length == 0 || ret != 0) { |
| 277 | msg_perr("Receive SPI failed\n"); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 278 | return 1; |
| 279 | } |
| 280 | |
| 281 | /* First byte indicates number of bytes transferred from upload buffer */ |
| 282 | if (buf[0] != readcnt) { |
| 283 | msg_perr("Unexpected number of bytes transferred, expected %i, got %i!\n", |
| 284 | readcnt, ret); |
| 285 | return 1; |
| 286 | } |
Elyes HAOUAS | 0cacb11 | 2019-02-04 12:16:38 +0100 | [diff] [blame] | 287 | |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 288 | /* Actual data starts at byte number two */ |
| 289 | memcpy(readarr, &buf[1], readcnt); |
| 290 | } |
| 291 | |
| 292 | return 0; |
| 293 | } |
| 294 | |
| 295 | /* Copied from dediprog.c */ |
| 296 | /* Might be useful for other USB devices as well. static for now. */ |
| 297 | static int parse_voltage(char *voltage) |
| 298 | { |
| 299 | char *tmp = NULL; |
| 300 | int i; |
| 301 | int millivolt = 0, fraction = 0; |
| 302 | |
| 303 | if (!voltage || !strlen(voltage)) { |
| 304 | msg_perr("Empty voltage= specified.\n"); |
| 305 | return -1; |
| 306 | } |
| 307 | millivolt = (int)strtol(voltage, &tmp, 0); |
| 308 | voltage = tmp; |
| 309 | /* Handle "," and "." as decimal point. Everything after it is assumed |
| 310 | * to be in decimal notation. |
| 311 | */ |
| 312 | if ((*voltage == '.') || (*voltage == ',')) { |
| 313 | voltage++; |
| 314 | for (i = 0; i < 3; i++) { |
| 315 | fraction *= 10; |
| 316 | /* Don't advance if the current character is invalid, |
| 317 | * but continue multiplying. |
| 318 | */ |
| 319 | if ((*voltage < '0') || (*voltage > '9')) |
| 320 | continue; |
| 321 | fraction += *voltage - '0'; |
| 322 | voltage++; |
| 323 | } |
| 324 | /* Throw away remaining digits. */ |
| 325 | voltage += strspn(voltage, "0123456789"); |
| 326 | } |
| 327 | /* The remaining string must be empty or "mV" or "V". */ |
| 328 | tolower_string(voltage); |
| 329 | |
| 330 | /* No unit or "V". */ |
| 331 | if ((*voltage == '\0') || !strncmp(voltage, "v", 1)) { |
| 332 | millivolt *= 1000; |
| 333 | millivolt += fraction; |
| 334 | } else if (!strncmp(voltage, "mv", 2) || |
| 335 | !strncmp(voltage, "millivolt", 9)) { |
| 336 | /* No adjustment. fraction is discarded. */ |
| 337 | } else { |
| 338 | /* Garbage at the end of the string. */ |
| 339 | msg_perr("Garbage voltage= specified.\n"); |
| 340 | return -1; |
| 341 | } |
| 342 | return millivolt; |
| 343 | } |
| 344 | |
Anastasia Klimchuk | c63d918 | 2021-07-06 16:18:44 +1000 | [diff] [blame] | 345 | static int pickit2_shutdown(void *data); |
| 346 | |
Nico Huber | 03f3a6d | 2021-05-11 17:53:34 +0200 | [diff] [blame] | 347 | static const struct spi_master spi_master_pickit2 = { |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 348 | .max_data_read = 40, |
| 349 | .max_data_write = 40, |
| 350 | .command = pickit2_spi_send_command, |
| 351 | .multicommand = default_spi_send_multicommand, |
| 352 | .read = default_spi_read, |
| 353 | .write_256 = default_spi_write_256, |
| 354 | .write_aai = default_spi_write_aai, |
Anastasia Klimchuk | c63d918 | 2021-07-06 16:18:44 +1000 | [diff] [blame] | 355 | .shutdown = pickit2_shutdown, |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 356 | }; |
| 357 | |
| 358 | static int pickit2_shutdown(void *data) |
| 359 | { |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 360 | struct pickit2_spi_data *pickit2_data = data; |
| 361 | |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 362 | /* Set all pins to float and turn voltages off */ |
| 363 | uint8_t command[CMD_LENGTH] = { |
| 364 | CMD_EXEC_SCRIPT, |
| 365 | 8, |
| 366 | SCR_SET_PINS, |
| 367 | 3, /* Bit-0=1(PDC In), Bit-1=1(PGD In), Bit-2=0(PDC LL), Bit-3=0(PGD LL) */ |
| 368 | SCR_SET_AUX, |
| 369 | 1, /* Bit-0=1(Aux In), Bit-1=0(Aux LL) */ |
| 370 | SCR_MCLR_GND_OFF, |
| 371 | SCR_VPP_OFF, |
| 372 | SCR_VDD_OFF, |
| 373 | SCR_BUSY_LED_OFF, |
| 374 | CMD_END_OF_BUFFER |
| 375 | }; |
| 376 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 377 | int ret = pickit2_interrupt_transfer(pickit2_data->pickit2_handle, ENDPOINT_OUT, command); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 378 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 379 | if (ret != 0) { |
| 380 | msg_perr("Command Shutdown failed!\n"); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 381 | ret = 1; |
| 382 | } |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 383 | if (libusb_release_interface(pickit2_data->pickit2_handle, 0) != 0) { |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 384 | msg_perr("Could not release USB interface!\n"); |
| 385 | ret = 1; |
| 386 | } |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 387 | libusb_close(pickit2_data->pickit2_handle); |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 388 | libusb_exit(NULL); |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 389 | |
| 390 | free(data); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 391 | return ret; |
| 392 | } |
| 393 | |
Thomas Heijligen | cc853d8 | 2021-05-04 15:32:17 +0200 | [diff] [blame] | 394 | static int pickit2_spi_init(void) |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 395 | { |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 396 | uint8_t buf[CMD_LENGTH] = { |
| 397 | CMD_EXEC_SCRIPT, |
| 398 | 10, /* Script length */ |
| 399 | SCR_SET_PINS, |
| 400 | 2, /* Bit-0=0(PDC Out), Bit-1=1(PGD In), Bit-2=0(PDC LL), Bit-3=0(PGD LL) */ |
| 401 | SCR_SET_AUX, |
| 402 | 0, /* Bit-0=0(Aux Out), Bit-1=0(Aux LL) */ |
| 403 | SCR_VDD_ON, |
| 404 | SCR_MCLR_GND_OFF, /* Let CS# float */ |
| 405 | SCR_VPP_PWM_ON, |
| 406 | SCR_VPP_ON, /* Pull CS# high */ |
| 407 | SCR_BUSY_LED_ON, |
| 408 | CMD_CLR_DLOAD_BUFF, |
| 409 | CMD_CLR_ULOAD_BUFF, |
| 410 | CMD_END_OF_BUFFER |
| 411 | }; |
| 412 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 413 | libusb_device_handle *pickit2_handle; |
| 414 | struct pickit2_spi_data *pickit2_data; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 415 | int spispeed_idx = 0; |
| 416 | char *spispeed = extract_programmer_param("spispeed"); |
| 417 | if (spispeed != NULL) { |
| 418 | int i = 0; |
| 419 | for (; spispeeds[i].name; i++) { |
| 420 | if (strcasecmp(spispeeds[i].name, spispeed) == 0) { |
| 421 | spispeed_idx = i; |
| 422 | break; |
| 423 | } |
| 424 | } |
| 425 | if (spispeeds[i].name == NULL) { |
| 426 | msg_perr("Error: Invalid 'spispeed' value.\n"); |
| 427 | free(spispeed); |
| 428 | return 1; |
| 429 | } |
| 430 | free(spispeed); |
| 431 | } |
| 432 | |
| 433 | int millivolt = 3500; |
| 434 | char *voltage = extract_programmer_param("voltage"); |
| 435 | if (voltage != NULL) { |
| 436 | millivolt = parse_voltage(voltage); |
| 437 | free(voltage); |
| 438 | if (millivolt < 0) |
| 439 | return 1; |
| 440 | } |
| 441 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 442 | if (libusb_init(NULL) < 0) { |
| 443 | msg_perr("Couldn't initialize libusb!\n"); |
| 444 | return -1; |
| 445 | } |
| 446 | |
| 447 | #if LIBUSB_API_VERSION < 0x01000106 |
| 448 | libusb_set_debug(NULL, 3); |
| 449 | #else |
| 450 | libusb_set_option(NULL, LIBUSB_OPTION_LOG_LEVEL, LIBUSB_LOG_LEVEL_INFO); |
| 451 | #endif |
| 452 | |
Stefan Tauner | f31fe84 | 2016-02-22 08:59:15 +0000 | [diff] [blame] | 453 | const uint16_t vid = devs_pickit2_spi[0].vendor_id; |
| 454 | const uint16_t pid = devs_pickit2_spi[0].device_id; |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 455 | pickit2_handle = libusb_open_device_with_vid_pid(NULL, vid, pid); |
| 456 | if (pickit2_handle == NULL) { |
| 457 | msg_perr("Could not open device PICkit2!\n"); |
| 458 | libusb_exit(NULL); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 459 | return 1; |
| 460 | } |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 461 | |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 462 | if (libusb_set_configuration(pickit2_handle, 1) != 0) { |
| 463 | msg_perr("Could not set USB device configuration.\n"); |
| 464 | libusb_close(pickit2_handle); |
| 465 | libusb_exit(NULL); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 466 | return 1; |
| 467 | } |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 468 | if (libusb_claim_interface(pickit2_handle, 0) != 0) { |
| 469 | msg_perr("Could not claim USB device interface\n"); |
| 470 | libusb_close(pickit2_handle); |
| 471 | libusb_exit(NULL); |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 472 | return 1; |
| 473 | } |
| 474 | |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 475 | pickit2_data = calloc(1, sizeof(*pickit2_data)); |
| 476 | if (!pickit2_data) { |
| 477 | msg_perr("Unable to allocate space for SPI master data\n"); |
| 478 | libusb_close(pickit2_handle); |
| 479 | libusb_exit(NULL); |
| 480 | return 1; |
| 481 | } |
| 482 | pickit2_data->pickit2_handle = pickit2_handle; |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 483 | |
| 484 | if (pickit2_get_firmware_version(pickit2_handle)) |
Anastasia Klimchuk | 1c9c73a | 2021-04-30 11:25:44 +1000 | [diff] [blame] | 485 | goto init_err_cleanup_exit; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 486 | |
| 487 | /* Command Set SPI Speed */ |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 488 | if (pickit2_set_spi_speed(pickit2_handle, spispeed_idx)) |
Anastasia Klimchuk | 1c9c73a | 2021-04-30 11:25:44 +1000 | [diff] [blame] | 489 | goto init_err_cleanup_exit; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 490 | |
| 491 | /* Command Set SPI Voltage */ |
| 492 | msg_pdbg("Setting voltage to %i mV.\n", millivolt); |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 493 | if (pickit2_set_spi_voltage(pickit2_handle, millivolt) != 0) |
Anastasia Klimchuk | 1c9c73a | 2021-04-30 11:25:44 +1000 | [diff] [blame] | 494 | goto init_err_cleanup_exit; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 495 | |
| 496 | /* Perform basic setup. |
| 497 | * Configure pin directions and logic levels, turn Vdd on, turn busy LED on and clear buffers. */ |
Angel Pons | 75d6ec6 | 2022-07-16 12:12:50 +0200 | [diff] [blame] | 498 | if (pickit2_interrupt_transfer(pickit2_handle, ENDPOINT_OUT, buf) != 0) { |
Thomas Heijligen | b221cd7 | 2019-04-05 15:08:35 +0200 | [diff] [blame] | 499 | msg_perr("Command Setup failed!\n"); |
Anastasia Klimchuk | 1c9c73a | 2021-04-30 11:25:44 +1000 | [diff] [blame] | 500 | goto init_err_cleanup_exit; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 501 | } |
| 502 | |
Anastasia Klimchuk | c63d918 | 2021-07-06 16:18:44 +1000 | [diff] [blame] | 503 | return register_spi_master(&spi_master_pickit2, pickit2_data); |
Anastasia Klimchuk | 1c9c73a | 2021-04-30 11:25:44 +1000 | [diff] [blame] | 504 | |
| 505 | init_err_cleanup_exit: |
Anastasia Klimchuk | 47e7d47 | 2021-04-30 14:10:04 +1000 | [diff] [blame] | 506 | pickit2_shutdown(pickit2_data); |
Anastasia Klimchuk | 1c9c73a | 2021-04-30 11:25:44 +1000 | [diff] [blame] | 507 | return 1; |
Justin Chevrier | 66e554b | 2015-02-08 21:58:10 +0000 | [diff] [blame] | 508 | } |
Thomas Heijligen | cc853d8 | 2021-05-04 15:32:17 +0200 | [diff] [blame] | 509 | |
| 510 | const struct programmer_entry programmer_pickit2_spi = { |
| 511 | .name = "pickit2_spi", |
| 512 | .type = USB, |
| 513 | .devs.dev = devs_pickit2_spi, |
| 514 | .init = pickit2_spi_init, |
| 515 | .map_flash_region = fallback_map, |
| 516 | .unmap_flash_region = fallback_unmap, |
| 517 | .delay = internal_delay, |
| 518 | }; |