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/adapter.h>
27 #include <jtag/interface.h>
30 /* -ino: 060521-1036 */
31 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
32 #include <machine/sysarch.h>
33 #include <machine/cpufunc.h>
34 #define ioperm(startport, length, enable)\
35 i386_set_ioperm((startport), (length), (enable))
36 #endif /* __FreeBSD__ */
38 #if PARPORT_USE_PPDEV == 1
39 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
40 #include <dev/ppbus/ppi.h>
41 #include <dev/ppbus/ppbconf.h>
42 #define PPRSTATUS PPIGSTATUS
43 #define PPWDATA PPISDATA
45 #include <linux/parport.h>
46 #include <linux/ppdev.h>
48 #include <sys/ioctl.h>
49 #else /* not PARPORT_USE_PPDEV */
55 #if PARPORT_USE_GIVEIO == 1 && IS_CYGWIN == 1
59 /* parallel port cable description
63 uint8_t TDO_MASK; /* status port bit containing current TDO value */
64 uint8_t TRST_MASK; /* data port bit for TRST */
65 uint8_t TMS_MASK; /* data port bit for TMS */
66 uint8_t TCK_MASK; /* data port bit for TCK */
67 uint8_t TDI_MASK; /* data port bit for TDI */
68 uint8_t SRST_MASK; /* data port bit for SRST */
69 uint8_t OUTPUT_INVERT; /* data port bits that should be inverted */
70 uint8_t INPUT_INVERT; /* status port that should be inverted */
71 uint8_t PORT_INIT; /* initialize data port with this value */
72 uint8_t PORT_EXIT; /* de-initialize data port with this value */
73 uint8_t LED_MASK; /* data port bit for LED */
76 static const struct cable cables[] = {
77 /* name tdo trst tms tck tdi srst o_inv i_inv init exit led */
78 { "wiggler", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x80, 0x00 },
79 { "wiggler2", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x00, 0x20 },
80 { "wiggler_ntrst_inverted", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x11, 0x80, 0x80, 0x80, 0x00 },
81 { "old_amt_wiggler", 0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x11, 0x80, 0x80, 0x80, 0x00 },
82 { "arm-jtag", 0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x01, 0x80, 0x80, 0x80, 0x00 },
83 { "chameleon", 0x80, 0x00, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
84 { "dlc5", 0x10, 0x00, 0x04, 0x02, 0x01, 0x00, 0x00, 0x00, 0x10, 0x10, 0x00 },
85 { "triton", 0x80, 0x08, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
86 { "lattice", 0x40, 0x10, 0x04, 0x02, 0x01, 0x08, 0x00, 0x00, 0x18, 0x18, 0x00 },
87 { "flashlink", 0x20, 0x10, 0x02, 0x01, 0x04, 0x20, 0x30, 0x20, 0x00, 0x00, 0x00 },
88 /* Altium Universal JTAG cable. Set the cable to Xilinx Mode and wire to target as follows:
93 SOFT TCK - Target TRST
94 SOFT TDI - Target SRST
96 { "altium", 0x10, 0x20, 0x04, 0x02, 0x01, 0x80, 0x00, 0x00, 0x10, 0x00, 0x08 },
97 { "aspo", 0x10, 0x01, 0x04, 0x08, 0x02, 0x10, 0x17, 0x00, 0x17, 0x17, 0x00 },
98 { NULL, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
102 static char *parport_cable;
103 static uint16_t parport_port;
104 static bool parport_exit;
105 static uint32_t parport_toggling_time_ns = 1000;
106 static int wait_states;
108 /* interface variables
110 static const struct cable *cable;
111 static uint8_t dataport_value;
113 #if PARPORT_USE_PPDEV == 1
114 static int device_handle;
116 static unsigned long dataport;
117 static unsigned long statusport;
120 static bb_value_t parport_read(void)
124 #if PARPORT_USE_PPDEV == 1
125 ioctl(device_handle, PPRSTATUS, &data);
127 data = inb(statusport);
130 if ((data ^ cable->INPUT_INVERT) & cable->TDO_MASK)
136 static inline void parport_write_data(void)
139 output = dataport_value ^ cable->OUTPUT_INVERT;
141 #if PARPORT_USE_PPDEV == 1
142 ioctl(device_handle, PPWDATA, &output);
144 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
145 outb(dataport, output);
147 outb(output, dataport);
152 static int parport_write(int tck, int tms, int tdi)
154 int i = wait_states + 1;
157 dataport_value |= cable->TCK_MASK;
159 dataport_value &= ~cable->TCK_MASK;
162 dataport_value |= cable->TMS_MASK;
164 dataport_value &= ~cable->TMS_MASK;
167 dataport_value |= cable->TDI_MASK;
169 dataport_value &= ~cable->TDI_MASK;
172 parport_write_data();
177 /* (1) assert or (0) deassert reset lines */
178 static int parport_reset(int trst, int srst)
180 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
183 dataport_value |= cable->TRST_MASK;
185 dataport_value &= ~cable->TRST_MASK;
188 dataport_value |= cable->SRST_MASK;
190 dataport_value &= ~cable->SRST_MASK;
192 parport_write_data();
197 /* turn LED on parport adapter on (1) or off (0) */
198 static int parport_led(int on)
201 dataport_value |= cable->LED_MASK;
203 dataport_value &= ~cable->LED_MASK;
205 parport_write_data();
210 static int parport_speed(int speed)
216 static int parport_khz(int khz, int *jtag_speed)
219 LOG_DEBUG("RCLK not supported");
223 *jtag_speed = 499999 / (khz * parport_toggling_time_ns);
227 static int parport_speed_div(int speed, int *khz)
229 uint32_t denominator = (speed + 1) * parport_toggling_time_ns;
231 *khz = (499999 + denominator) / denominator;
235 #if PARPORT_USE_GIVEIO == 1
236 static int parport_get_giveio_access(void)
239 OSVERSIONINFO version;
241 version.dwOSVersionInfoSize = sizeof(version);
242 if (!GetVersionEx(&version)) {
246 if (version.dwPlatformId != VER_PLATFORM_WIN32_NT)
249 h = CreateFile("\\\\.\\giveio", GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
250 if (h == INVALID_HANDLE_VALUE) {
261 static struct bitbang_interface parport_bitbang = {
262 .read = &parport_read,
263 .write = &parport_write,
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) {
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();
397 parport_cable = NULL;
402 COMMAND_HANDLER(parport_handle_parport_port_command)
405 /* only if the port wasn't overwritten by cmdline */
406 if (parport_port == 0)
407 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], parport_port);
409 LOG_ERROR("The parport port was already configured!");
414 command_print(CMD, "parport port = 0x%" PRIx16 "", parport_port);
419 COMMAND_HANDLER(parport_handle_parport_cable_command)
424 /* only if the cable name wasn't overwritten by cmdline */
425 if (parport_cable == 0) {
426 /* REVISIT first verify that it's listed in cables[] ... */
427 parport_cable = malloc(strlen(CMD_ARGV[0]) + sizeof(char));
428 strcpy(parport_cable, CMD_ARGV[0]);
431 /* REVISIT it's probably worth returning the current value ... */
436 COMMAND_HANDLER(parport_handle_write_on_exit_command)
439 return ERROR_COMMAND_SYNTAX_ERROR;
441 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], parport_exit);
446 COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
450 int retval = parse_u32(CMD_ARGV[0], &ns);
452 if (retval != ERROR_OK)
456 LOG_ERROR("0 ns is not a valid parport toggling time");
460 parport_toggling_time_ns = ns;
461 retval = adapter_get_speed(&wait_states);
462 if (retval != ERROR_OK) {
463 /* if adapter_get_speed fails then the clock_mode
464 * has not been configured, this happens if parport_toggling_time is
465 * called before the adapter speed is set */
466 LOG_INFO("no parport speed set - defaulting to zero wait states");
471 command_print(CMD, "parport toggling time = %" PRIu32 " ns",
472 parport_toggling_time_ns);
477 static const struct command_registration parport_subcommand_handlers[] = {
480 .handler = parport_handle_parport_port_command,
481 .mode = COMMAND_CONFIG,
482 .help = "Display the address of the I/O port (e.g. 0x378) "
483 "or the number of the '/dev/parport' device used. "
484 "If a parameter is provided, first change that port.",
485 .usage = "[port_number]",
489 .handler = parport_handle_parport_cable_command,
490 .mode = COMMAND_CONFIG,
491 .help = "Set the layout of the parallel port cable "
492 "used to connect to the target.",
493 /* REVISIT there's no way to list layouts we know ... */
497 .name = "write_on_exit",
498 .handler = parport_handle_write_on_exit_command,
499 .mode = COMMAND_CONFIG,
500 .help = "Configure the parallel driver to write "
501 "a known value to the parallel interface on exit.",
502 .usage = "('on'|'off')",
505 .name = "toggling_time",
506 .handler = parport_handle_parport_toggling_time_command,
507 .mode = COMMAND_CONFIG,
508 .help = "Displays or assigns how many nanoseconds it "
509 "takes for the hardware to toggle TCK.",
510 .usage = "[nanoseconds]",
512 COMMAND_REGISTRATION_DONE
515 static const struct command_registration parport_command_handlers[] = {
519 .help = "perform parport management",
520 .chain = parport_subcommand_handlers,
523 COMMAND_REGISTRATION_DONE
526 static struct jtag_interface parport_interface = {
527 .supported = DEBUG_CAP_TMS_SEQ,
528 .execute_queue = bitbang_execute_queue,
531 struct adapter_driver parport_adapter_driver = {
533 .transports = jtag_only,
534 .commands = parport_command_handlers,
536 .init = parport_init,
537 .quit = parport_quit,
538 .reset = parport_reset,
539 .speed = parport_speed,
541 .speed_div = parport_speed_div,
543 .jtag_ops = &parport_interface,