1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
26 #include <jtag/interface.h>
29 /* -ino: 060521-1036 */
30 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
31 #include <machine/sysarch.h>
32 #include <machine/cpufunc.h>
33 #define ioperm(startport, length, enable)\
34 i386_set_ioperm((startport), (length), (enable))
35 #endif /* __FreeBSD__ */
37 #if PARPORT_USE_PPDEV == 1
38 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
39 #include <dev/ppbus/ppi.h>
40 #include <dev/ppbus/ppbconf.h>
41 #define PPRSTATUS PPIGSTATUS
42 #define PPWDATA PPISDATA
44 #include <linux/parport.h>
45 #include <linux/ppdev.h>
47 #include <sys/ioctl.h>
48 #else /* not PARPORT_USE_PPDEV */
54 #if PARPORT_USE_GIVEIO == 1 && IS_CYGWIN == 1
58 /* parallel port cable description
62 uint8_t TDO_MASK; /* status port bit containing current TDO value */
63 uint8_t TRST_MASK; /* data port bit for TRST */
64 uint8_t TMS_MASK; /* data port bit for TMS */
65 uint8_t TCK_MASK; /* data port bit for TCK */
66 uint8_t TDI_MASK; /* data port bit for TDI */
67 uint8_t SRST_MASK; /* data port bit for SRST */
68 uint8_t OUTPUT_INVERT; /* data port bits that should be inverted */
69 uint8_t INPUT_INVERT; /* status port that should be inverted */
70 uint8_t PORT_INIT; /* initialize data port with this value */
71 uint8_t PORT_EXIT; /* de-initialize data port with this value */
72 uint8_t LED_MASK; /* data port bit for LED */
75 static const struct cable cables[] = {
76 /* name tdo trst tms tck tdi srst o_inv i_inv init exit led */
77 { "wiggler", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x80, 0x00 },
78 { "wiggler2", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x00, 0x20 },
79 { "wiggler_ntrst_inverted", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x11, 0x80, 0x80, 0x80, 0x00 },
80 { "old_amt_wiggler", 0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x11, 0x80, 0x80, 0x80, 0x00 },
81 { "arm-jtag", 0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x01, 0x80, 0x80, 0x80, 0x00 },
82 { "chameleon", 0x80, 0x00, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
83 { "dlc5", 0x10, 0x00, 0x04, 0x02, 0x01, 0x00, 0x00, 0x00, 0x10, 0x10, 0x00 },
84 { "triton", 0x80, 0x08, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
85 { "lattice", 0x40, 0x10, 0x04, 0x02, 0x01, 0x08, 0x00, 0x00, 0x18, 0x18, 0x00 },
86 { "flashlink", 0x20, 0x10, 0x02, 0x01, 0x04, 0x20, 0x30, 0x20, 0x00, 0x00, 0x00 },
87 /* Altium Universal JTAG cable. Set the cable to Xilinx Mode and wire to target as follows:
92 SOFT TCK - Target TRST
93 SOFT TDI - Target SRST
95 { "altium", 0x10, 0x20, 0x04, 0x02, 0x01, 0x80, 0x00, 0x00, 0x10, 0x00, 0x08 },
96 { "aspo", 0x10, 0x01, 0x04, 0x08, 0x02, 0x10, 0x17, 0x00, 0x17, 0x17, 0x00 },
97 { NULL, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
101 static char *parport_cable;
102 static uint16_t parport_port;
103 static bool parport_exit;
104 static uint32_t parport_toggling_time_ns = 1000;
105 static int wait_states;
107 /* interface variables
109 static const struct cable *cable;
110 static uint8_t dataport_value;
112 #if PARPORT_USE_PPDEV == 1
113 static int device_handle;
115 static unsigned long dataport;
116 static unsigned long statusport;
119 static bb_value_t parport_read(void)
123 #if PARPORT_USE_PPDEV == 1
124 ioctl(device_handle, PPRSTATUS, &data);
126 data = inb(statusport);
129 if ((data ^ cable->INPUT_INVERT) & cable->TDO_MASK)
135 static inline void parport_write_data(void)
138 output = dataport_value ^ cable->OUTPUT_INVERT;
140 #if PARPORT_USE_PPDEV == 1
141 ioctl(device_handle, PPWDATA, &output);
143 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
144 outb(dataport, output);
146 outb(output, dataport);
151 static int parport_write(int tck, int tms, int tdi)
153 int i = wait_states + 1;
156 dataport_value |= cable->TCK_MASK;
158 dataport_value &= ~cable->TCK_MASK;
161 dataport_value |= cable->TMS_MASK;
163 dataport_value &= ~cable->TMS_MASK;
166 dataport_value |= cable->TDI_MASK;
168 dataport_value &= ~cable->TDI_MASK;
171 parport_write_data();
176 /* (1) assert or (0) deassert reset lines */
177 static int parport_reset(int trst, int srst)
179 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
182 dataport_value |= cable->TRST_MASK;
184 dataport_value &= ~cable->TRST_MASK;
187 dataport_value |= cable->SRST_MASK;
189 dataport_value &= ~cable->SRST_MASK;
191 parport_write_data();
196 /* turn LED on parport adapter on (1) or off (0) */
197 static int parport_led(int on)
200 dataport_value |= cable->LED_MASK;
202 dataport_value &= ~cable->LED_MASK;
204 parport_write_data();
209 static int parport_speed(int speed)
215 static int parport_khz(int khz, int *jtag_speed)
218 LOG_DEBUG("RCLK not supported");
222 *jtag_speed = 499999 / (khz * parport_toggling_time_ns);
226 static int parport_speed_div(int speed, int *khz)
228 uint32_t denominator = (speed + 1) * parport_toggling_time_ns;
230 *khz = (499999 + denominator) / denominator;
234 #if PARPORT_USE_GIVEIO == 1
235 static int parport_get_giveio_access(void)
238 OSVERSIONINFO version;
240 version.dwOSVersionInfoSize = sizeof version;
241 if (!GetVersionEx(&version)) {
245 if (version.dwPlatformId != VER_PLATFORM_WIN32_NT)
248 h = CreateFile("\\\\.\\giveio", GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
249 if (h == INVALID_HANDLE_VALUE) {
260 static struct bitbang_interface parport_bitbang = {
261 .read = &parport_read,
262 .write = &parport_write,
263 .reset = &parport_reset,
264 .blink = &parport_led,
267 static int parport_init(void)
269 const struct cable *cur_cable;
270 #if PARPORT_USE_PPDEV == 1
276 if (parport_cable == NULL) {
277 parport_cable = strdup("wiggler");
278 LOG_WARNING("No parport cable specified, using default 'wiggler'");
281 while (cur_cable->name) {
282 if (strcmp(cur_cable->name, parport_cable) == 0) {
290 LOG_ERROR("No matching cable found for %s", parport_cable);
291 return ERROR_JTAG_INIT_FAILED;
294 dataport_value = cable->PORT_INIT;
296 #if PARPORT_USE_PPDEV == 1
297 if (device_handle > 0) {
298 LOG_ERROR("device is already opened");
299 return ERROR_JTAG_INIT_FAILED;
302 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
303 LOG_DEBUG("opening /dev/ppi%d...", parport_port);
305 snprintf(buffer, 256, "/dev/ppi%d", parport_port);
306 device_handle = open(buffer, O_WRONLY);
307 #else /* not __FreeBSD__, __FreeBSD_kernel__ */
308 LOG_DEBUG("opening /dev/parport%d...", parport_port);
310 snprintf(buffer, 256, "/dev/parport%d", parport_port);
311 device_handle = open(buffer, O_WRONLY);
312 #endif /* __FreeBSD__, __FreeBSD_kernel__ */
314 if (device_handle < 0) {
316 LOG_ERROR("cannot open device. check it exists and that user read and write rights are set. errno=%d", err);
317 return ERROR_JTAG_INIT_FAILED;
320 LOG_DEBUG("...open");
322 #if !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
323 int i = ioctl(device_handle, PPCLAIM);
326 LOG_ERROR("cannot claim device");
327 return ERROR_JTAG_INIT_FAILED;
330 i = PARPORT_MODE_COMPAT;
331 i = ioctl(device_handle, PPSETMODE, &i);
333 LOG_ERROR(" cannot set compatible mode to device");
334 return ERROR_JTAG_INIT_FAILED;
337 i = IEEE1284_MODE_COMPAT;
338 i = ioctl(device_handle, PPNEGOT, &i);
340 LOG_ERROR("cannot set compatible 1284 mode to device");
341 return ERROR_JTAG_INIT_FAILED;
343 #endif /* not __FreeBSD__, __FreeBSD_kernel__ */
345 #else /* not PARPORT_USE_PPDEV */
346 if (parport_port == 0) {
347 parport_port = 0x378;
348 LOG_WARNING("No parport port specified, using default '0x378' (LPT1)");
351 dataport = parport_port;
352 statusport = parport_port + 1;
354 LOG_DEBUG("requesting privileges for parallel port 0x%lx...", dataport);
355 #if PARPORT_USE_GIVEIO == 1
356 if (parport_get_giveio_access() != 0) {
357 #else /* PARPORT_USE_GIVEIO */
358 if (ioperm(dataport, 3, 1) != 0) {
359 #endif /* PARPORT_USE_GIVEIO */
360 LOG_ERROR("missing privileges for direct i/o");
361 return ERROR_JTAG_INIT_FAILED;
363 LOG_DEBUG("...privileges granted");
365 /* make sure parallel port is in right mode (clear tristate and interrupt */
366 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
367 outb(parport_port + 2, 0x0);
369 outb(0x0, parport_port + 2);
372 #endif /* PARPORT_USE_PPDEV */
374 if (parport_reset(0, 0) != ERROR_OK)
376 if (parport_write(0, 0, 0) != ERROR_OK)
378 if (parport_led(1) != ERROR_OK)
381 bitbang_interface = &parport_bitbang;
386 static int parport_quit(void)
388 if (parport_led(0) != ERROR_OK)
392 dataport_value = cable->PORT_EXIT;
393 parport_write_data();
398 parport_cable = NULL;
404 COMMAND_HANDLER(parport_handle_parport_port_command)
407 /* only if the port wasn't overwritten by cmdline */
408 if (parport_port == 0)
409 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], parport_port);
411 LOG_ERROR("The parport port was already configured!");
416 command_print(CMD_CTX, "parport port = 0x%" PRIx16 "", parport_port);
421 COMMAND_HANDLER(parport_handle_parport_cable_command)
426 /* only if the cable name wasn't overwritten by cmdline */
427 if (parport_cable == 0) {
428 /* REVISIT first verify that it's listed in cables[] ... */
429 parport_cable = malloc(strlen(CMD_ARGV[0]) + sizeof(char));
430 strcpy(parport_cable, CMD_ARGV[0]);
433 /* REVISIT it's probably worth returning the current value ... */
438 COMMAND_HANDLER(parport_handle_write_on_exit_command)
441 return ERROR_COMMAND_SYNTAX_ERROR;
443 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], parport_exit);
448 COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
452 int retval = parse_u32(CMD_ARGV[0], &ns);
454 if (ERROR_OK != retval)
458 LOG_ERROR("0 ns is not a valid parport toggling time");
462 parport_toggling_time_ns = ns;
463 retval = jtag_get_speed(&wait_states);
464 if (retval != ERROR_OK) {
465 /* if jtag_get_speed fails then the clock_mode
466 * has not been configured, this happens if parport_toggling_time is
467 * called before the adapter speed is set */
468 LOG_INFO("no parport speed set - defaulting to zero wait states");
473 command_print(CMD_CTX, "parport toggling time = %" PRIu32 " ns",
474 parport_toggling_time_ns);
479 static const struct command_registration parport_command_handlers[] = {
481 .name = "parport_port",
482 .handler = parport_handle_parport_port_command,
483 .mode = COMMAND_CONFIG,
484 .help = "Display the address of the I/O port (e.g. 0x378) "
485 "or the number of the '/dev/parport' device used. "
486 "If a parameter is provided, first change that port.",
487 .usage = "[port_number]",
490 .name = "parport_cable",
491 .handler = parport_handle_parport_cable_command,
492 .mode = COMMAND_CONFIG,
493 .help = "Set the layout of the parallel port cable "
494 "used to connect to the target.",
495 /* REVISIT there's no way to list layouts we know ... */
499 .name = "parport_write_on_exit",
500 .handler = parport_handle_write_on_exit_command,
501 .mode = COMMAND_CONFIG,
502 .help = "Configure the parallel driver to write "
503 "a known value to the parallel interface on exit.",
504 .usage = "('on'|'off')",
507 .name = "parport_toggling_time",
508 .handler = parport_handle_parport_toggling_time_command,
509 .mode = COMMAND_CONFIG,
510 .help = "Displays or assigns how many nanoseconds it "
511 "takes for the hardware to toggle TCK.",
512 .usage = "[nanoseconds]",
514 COMMAND_REGISTRATION_DONE
517 struct jtag_interface parport_interface = {
519 .supported = DEBUG_CAP_TMS_SEQ,
520 .commands = parport_command_handlers,
522 .init = parport_init,
523 .quit = parport_quit,
525 .speed_div = parport_speed_div,
526 .speed = parport_speed,
527 .execute_queue = bitbang_execute_queue,