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, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
27 #include "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
60 /* parallel port cable description
62 typedef struct cable_s
65 uint8_t TDO_MASK; /* status port bit containing current TDO value */
66 uint8_t TRST_MASK; /* data port bit for TRST */
67 uint8_t TMS_MASK; /* data port bit for TMS */
68 uint8_t TCK_MASK; /* data port bit for TCK */
69 uint8_t TDI_MASK; /* data port bit for TDI */
70 uint8_t SRST_MASK; /* data port bit for SRST */
71 uint8_t OUTPUT_INVERT; /* data port bits that should be inverted */
72 uint8_t INPUT_INVERT; /* status port that should be inverted */
73 uint8_t PORT_INIT; /* initialize data port with this value */
74 uint8_t PORT_EXIT; /* de-initialize data port with this value */
75 uint8_t LED_MASK; /* data port bit for LED */
78 static cable_t cables[] =
80 /* name tdo trst tms tck tdi srst o_inv i_inv init exit led */
81 { "wiggler", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x80, 0x00 },
82 { "wiggler2", 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x00, 0x20 },
83 { "wiggler_ntrst_inverted",
84 0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x11, 0x80, 0x80, 0x80, 0x00 },
85 { "old_amt_wiggler", 0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x11, 0x80, 0x80, 0x80, 0x00 },
86 { "arm-jtag", 0x80, 0x01, 0x02, 0x04, 0x08, 0x10, 0x01, 0x80, 0x80, 0x80, 0x00 },
87 { "chameleon", 0x80, 0x00, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
88 { "dlc5", 0x10, 0x00, 0x04, 0x02, 0x01, 0x00, 0x00, 0x00, 0x10, 0x10, 0x00 },
89 { "triton", 0x80, 0x08, 0x04, 0x01, 0x02, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00 },
90 { "lattice", 0x40, 0x10, 0x04, 0x02, 0x01, 0x08, 0x00, 0x00, 0x18, 0x18, 0x00 },
91 { "flashlink", 0x20, 0x10, 0x02, 0x01, 0x04, 0x20, 0x30, 0x20, 0x00, 0x00, 0x00 },
92 /* Altium Universal JTAG cable. Set the cable to Xilinx Mode and wire to target as follows:
97 SOFT TCK - Target TRST
98 SOFT TDI - Target SRST
100 { "altium", 0x10, 0x20, 0x04, 0x02, 0x01, 0x80, 0x00, 0x00, 0x10, 0x00, 0x08 },
101 { NULL, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
105 static char* parport_cable = NULL;
106 static uint16_t parport_port;
107 static int parport_exit = 0;
108 static uint32_t parport_toggling_time_ns = 1000;
109 static int wait_states;
111 /* interface variables
113 static cable_t* cable;
114 static uint8_t dataport_value = 0x0;
116 #if PARPORT_USE_PPDEV == 1
117 static int device_handle;
119 static unsigned long dataport;
120 static unsigned long statusport;
123 static int parport_read(void)
127 #if PARPORT_USE_PPDEV == 1
128 ioctl(device_handle, PPRSTATUS, & data);
130 data = inb(statusport);
133 if ((data ^ cable->INPUT_INVERT) & cable->TDO_MASK)
139 static __inline__ void parport_write_data(void)
142 output = dataport_value ^ cable->OUTPUT_INVERT;
144 #if PARPORT_USE_PPDEV == 1
145 ioctl(device_handle, PPWDATA, &output);
147 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
148 outb(dataport, output);
150 outb(output, dataport);
155 static void parport_write(int tck, int tms, int tdi)
157 int i = wait_states + 1;
160 dataport_value |= cable->TCK_MASK;
162 dataport_value &= ~cable->TCK_MASK;
165 dataport_value |= cable->TMS_MASK;
167 dataport_value &= ~cable->TMS_MASK;
170 dataport_value |= cable->TDI_MASK;
172 dataport_value &= ~cable->TDI_MASK;
175 parport_write_data();
178 /* (1) assert or (0) deassert reset lines */
179 static void parport_reset(int trst, int srst)
181 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
184 dataport_value |= cable->TRST_MASK;
186 dataport_value &= ~cable->TRST_MASK;
189 dataport_value |= cable->SRST_MASK;
191 dataport_value &= ~cable->SRST_MASK;
193 parport_write_data();
196 /* turn LED on parport adapter on (1) or off (0) */
197 static void parport_led(int on)
200 dataport_value |= cable->LED_MASK;
202 dataport_value &= ~cable->LED_MASK;
204 parport_write_data();
207 static int parport_speed(int speed)
213 static int parport_khz(int khz, int* jtag_speed)
216 LOG_DEBUG("RCLK not supported");
220 *jtag_speed = 499999 / (khz * parport_toggling_time_ns);
224 static int parport_speed_div(int speed, int* khz)
226 uint32_t denominator = (speed + 1) * parport_toggling_time_ns;
228 *khz = (499999 + denominator) / denominator;
232 #if PARPORT_USE_GIVEIO == 1
233 static int parport_get_giveio_access(void)
236 OSVERSIONINFO version;
238 version.dwOSVersionInfoSize = sizeof version;
239 if (!GetVersionEx(&version)) {
243 if (version.dwPlatformId != VER_PLATFORM_WIN32_NT)
246 h = CreateFile("\\\\.\\giveio", GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
247 if (h == INVALID_HANDLE_VALUE) {
258 static struct bitbang_interface parport_bitbang = {
259 .read = &parport_read,
260 .write = &parport_write,
261 .reset = &parport_reset,
262 .blink = &parport_led,
265 static int parport_init(void)
268 #if PARPORT_USE_PPDEV == 1
275 if ((parport_cable == NULL) || (parport_cable[0] == 0))
277 parport_cable = "wiggler";
278 LOG_WARNING("No parport cable specified, using default 'wiggler'");
281 while (cur_cable->name)
283 if (strcmp(cur_cable->name, parport_cable) == 0)
293 LOG_ERROR("No matching cable found for %s", parport_cable);
294 return ERROR_JTAG_INIT_FAILED;
297 dataport_value = cable->PORT_INIT;
299 #if PARPORT_USE_PPDEV == 1
300 if (device_handle > 0)
302 LOG_ERROR("device is already opened");
303 return ERROR_JTAG_INIT_FAILED;
306 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
307 LOG_DEBUG("opening /dev/ppi%d...", parport_port);
309 snprintf(buffer, 256, "/dev/ppi%d", parport_port);
310 device_handle = open(buffer, O_WRONLY);
311 #else /* not __FreeBSD__, __FreeBSD_kernel__ */
312 LOG_DEBUG("opening /dev/parport%d...", parport_port);
314 snprintf(buffer, 256, "/dev/parport%d", parport_port);
315 device_handle = open(buffer, O_WRONLY);
316 #endif /* __FreeBSD__, __FreeBSD_kernel__ */
318 if (device_handle < 0)
321 LOG_ERROR("cannot open device. check it exists and that user read and write rights are set. errno=%d", err);
322 return ERROR_JTAG_INIT_FAILED;
325 LOG_DEBUG("...open");
327 #if !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
328 i = ioctl(device_handle, PPCLAIM);
331 LOG_ERROR("cannot claim device");
332 return ERROR_JTAG_INIT_FAILED;
335 i = PARPORT_MODE_COMPAT;
336 i= ioctl(device_handle, PPSETMODE, & i);
339 LOG_ERROR(" cannot set compatible mode to device");
340 return ERROR_JTAG_INIT_FAILED;
343 i = IEEE1284_MODE_COMPAT;
344 i = ioctl(device_handle, PPNEGOT, & i);
347 LOG_ERROR("cannot set compatible 1284 mode to device");
348 return ERROR_JTAG_INIT_FAILED;
350 #endif /* not __FreeBSD__, __FreeBSD_kernel__ */
352 #else /* not PARPORT_USE_PPDEV */
353 if (parport_port == 0)
355 parport_port = 0x378;
356 LOG_WARNING("No parport port specified, using default '0x378' (LPT1)");
359 dataport = parport_port;
360 statusport = parport_port + 1;
362 LOG_DEBUG("requesting privileges for parallel port 0x%lx...", dataport);
363 #if PARPORT_USE_GIVEIO == 1
364 if (parport_get_giveio_access() != 0)
365 #else /* PARPORT_USE_GIVEIO */
366 if (ioperm(dataport, 3, 1) != 0)
367 #endif /* PARPORT_USE_GIVEIO */
369 LOG_ERROR("missing privileges for direct i/o");
370 return ERROR_JTAG_INIT_FAILED;
372 LOG_DEBUG("...privileges granted");
374 /* make sure parallel port is in right mode (clear tristate and interrupt */
375 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
376 outb(parport_port + 2, 0x0);
378 outb(0x0, parport_port + 2);
381 #endif /* PARPORT_USE_PPDEV */
384 parport_write(0, 0, 0);
387 bitbang_interface = &parport_bitbang;
389 wait_states = jtag_get_speed();
394 static int parport_quit(void)
400 dataport_value = cable->PORT_EXIT;
401 parport_write_data();
407 parport_cable = NULL;
413 COMMAND_HANDLER(parport_handle_parport_port_command)
417 /* only if the port wasn't overwritten by cmdline */
418 if (parport_port == 0)
420 COMMAND_PARSE_NUMBER(u16, args[0], parport_port);
424 LOG_ERROR("The parport port was already configured!");
429 command_print(cmd_ctx, "parport port = %u", parport_port);
434 COMMAND_HANDLER(parport_handle_parport_cable_command)
439 /* only if the cable name wasn't overwritten by cmdline */
440 if (parport_cable == 0)
442 parport_cable = malloc(strlen(args[0]) + sizeof(char));
443 strcpy(parport_cable, args[0]);
449 COMMAND_HANDLER(parport_handle_write_on_exit_command)
453 command_print(cmd_ctx, "usage: parport_write_on_exit <on | off>");
457 if (strcmp(args[0], "on") == 0)
459 else if (strcmp(args[0], "off") == 0)
465 COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
469 int retval = parse_u32(args[0], &ns);
471 if (ERROR_OK != retval)
475 LOG_ERROR("0 ns is not a valid parport toggling time");
479 parport_toggling_time_ns = ns;
480 wait_states = jtag_get_speed();
483 command_print(cmd_ctx, "parport toggling time = %" PRIu32 " ns",
484 parport_toggling_time_ns);
489 static int parport_register_commands(struct command_context_s *cmd_ctx)
491 register_command(cmd_ctx, NULL, "parport_port",
492 parport_handle_parport_port_command, COMMAND_CONFIG,
493 "either the address of the I/O port "
494 "or the number of the '/dev/parport' device");
496 register_command(cmd_ctx, NULL, "parport_cable",
497 parport_handle_parport_cable_command, COMMAND_CONFIG,
498 "the layout of the parallel port cable "
499 "used to connect to the target");
501 register_command(cmd_ctx, NULL, "parport_write_on_exit",
502 parport_handle_write_on_exit_command, COMMAND_CONFIG,
503 "configure the parallel driver to write "
504 "a known value to the parallel interface");
506 register_command(cmd_ctx, NULL, "parport_toggling_time",
507 parport_handle_parport_toggling_time_command, COMMAND_ANY,
508 "time <ns> it takes for the hardware to toggle TCK");
513 struct jtag_interface parport_interface = {
515 .register_commands = parport_register_commands,
516 .init = parport_init,
517 .quit = parport_quit,
519 .speed_div = parport_speed_div,
520 .speed = parport_speed,
521 .execute_queue = bitbang_execute_queue,