use COMMAND_PARSE_ON_OFF where appropriate
[fw/openocd] / src / jtag / parport.c
index cd8e8e8b28c4ea0fbf380b8f90a3039afb06ffa1..b80626f57d5dcd518f85830303ab83a95a368052 100644 (file)
@@ -59,8 +59,7 @@
 
 /* parallel port cable description
  */
-typedef struct cable_s
-{
+struct cable {
        char* name;
        uint8_t TDO_MASK;       /* status port bit containing current TDO value */
        uint8_t TRST_MASK;      /* data port bit for TRST */
@@ -73,9 +72,9 @@ typedef struct cable_s
        uint8_t PORT_INIT;      /* initialize data port with this value */
        uint8_t PORT_EXIT;      /* de-initialize data port with this value */
        uint8_t LED_MASK;       /* data port bit for LED */
-} cable_t;
+};
 
-static cable_t cables[] =
+static struct cable cables[] =
 {
        /* name                                 tdo   trst  tms   tck   tdi   srst  o_inv i_inv init  exit  led */
        { "wiggler",                    0x80, 0x10, 0x02, 0x04, 0x08, 0x01, 0x01, 0x80, 0x80, 0x80, 0x00 },
@@ -103,12 +102,14 @@ static cable_t cables[] =
 
 /* configuration */
 static char* parport_cable = NULL;
-static u16 parport_port;
-static int parport_exit = 0;
+static uint16_t parport_port;
+static bool parport_exit = 0;
+static uint32_t parport_toggling_time_ns = 1000;
+static int wait_states;
 
 /* interface variables
  */
-static cable_t* cable;
+static struct cable* cable;
 static uint8_t dataport_value = 0x0;
 
 #if PARPORT_USE_PPDEV == 1
@@ -118,43 +119,6 @@ static unsigned long dataport;
 static unsigned long statusport;
 #endif
 
-/* low level command set
- */
-static int parport_read(void);
-static void parport_write(int tck, int tms, int tdi);
-static void parport_reset(int trst, int srst);
-static void parport_led(int on);
-
-static int parport_speed(int speed);
-static int parport_register_commands(struct command_context_s *cmd_ctx);
-static int parport_init(void);
-static int parport_quit(void);
-
-/* interface commands */
-static int parport_handle_parport_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int parport_handle_parport_cable_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int parport_handle_write_on_exit_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-
-jtag_interface_t parport_interface =
-{
-       .name = "parport",
-
-       .execute_queue = bitbang_execute_queue,
-
-       .speed = parport_speed,
-       .register_commands = parport_register_commands,
-       .init = parport_init,
-       .quit = parport_quit,
-};
-
-static bitbang_interface_t parport_bitbang =
-{
-       .read = parport_read,
-       .write = parport_write,
-       .reset = parport_reset,
-       .blink = parport_led
-};
-
 static int parport_read(void)
 {
        int data = 0;
@@ -189,7 +153,7 @@ static __inline__ void parport_write_data(void)
 
 static void parport_write(int tck, int tms, int tdi)
 {
-       int i = jtag_get_speed() + 1;
+       int i = wait_states + 1;
 
        if (tck)
                dataport_value |= cable->TCK_MASK;
@@ -241,18 +205,26 @@ static void parport_led(int on)
 
 static int parport_speed(int speed)
 {
+       wait_states = speed;
        return ERROR_OK;
 }
 
-static int parport_register_commands(struct command_context_s *cmd_ctx)
+static int parport_khz(int khz, int* jtag_speed)
 {
-       register_command(cmd_ctx, NULL, "parport_port", parport_handle_parport_port_command,
-               COMMAND_CONFIG, "either the address of the I/O port or the number of the \91/dev/parport\92 device");
-       register_command(cmd_ctx, NULL, "parport_cable", parport_handle_parport_cable_command,
-               COMMAND_CONFIG, "the layout of the parallel port cable used to connect to the target");
-       register_command(cmd_ctx, NULL, "parport_write_on_exit", parport_handle_write_on_exit_command,
-               COMMAND_CONFIG, "configure the parallel driver to write a known value to the parallel interface");
+       if (khz == 0) {
+               LOG_DEBUG("RCLK not supported");
+               return ERROR_FAIL;
+       }
+
+       *jtag_speed = 499999 / (khz * parport_toggling_time_ns);
+       return ERROR_OK;
+}
+
+static int parport_speed_div(int speed, int* khz)
+{
+       uint32_t denominator = (speed + 1) * parport_toggling_time_ns;
 
+       *khz = (499999 + denominator) / denominator;
        return ERROR_OK;
 }
 
@@ -263,28 +235,35 @@ static int parport_get_giveio_access(void)
        OSVERSIONINFO version;
 
        version.dwOSVersionInfoSize = sizeof version;
-       if (!GetVersionEx( &version )) {
+       if (!GetVersionEx(&version)) {
                errno = EINVAL;
                return -1;
        }
        if (version.dwPlatformId != VER_PLATFORM_WIN32_NT)
                return 0;
 
-       h = CreateFile( "\\\\.\\giveio", GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL );
+       h = CreateFile("\\\\.\\giveio", GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
        if (h == INVALID_HANDLE_VALUE) {
                errno = ENODEV;
                return -1;
        }
 
-       CloseHandle( h );
+       CloseHandle(h);
 
        return 0;
 }
 #endif
 
+static struct bitbang_interface parport_bitbang = {
+               .read = &parport_read,
+               .write = &parport_write,
+               .reset = &parport_reset,
+               .blink = &parport_led,
+       };
+
 static int parport_init(void)
 {
-       cable_t *cur_cable;
+       struct cable *cur_cable;
 #if PARPORT_USE_PPDEV == 1
        char buffer[256];
        int i = 0;
@@ -337,15 +316,16 @@ static int parport_init(void)
 
        if (device_handle < 0)
        {
-               LOG_ERROR("cannot open device. check it exists and that user read and write rights are set");
+               int err = errno;
+               LOG_ERROR("cannot open device. check it exists and that user read and write rights are set. errno=%d", err);
                return ERROR_JTAG_INIT_FAILED;
        }
 
        LOG_DEBUG("...open");
 
 #if !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__)
-       i=ioctl(device_handle, PPCLAIM);
-       if (i<0)
+       i = ioctl(device_handle, PPCLAIM);
+       if (i < 0)
        {
                LOG_ERROR("cannot claim device");
                return ERROR_JTAG_INIT_FAILED;
@@ -353,7 +333,7 @@ static int parport_init(void)
 
        i = PARPORT_MODE_COMPAT;
        i= ioctl(device_handle, PPSETMODE, & i);
-       if (i<0)
+       if (i < 0)
        {
                LOG_ERROR(" cannot set compatible mode to device");
                return ERROR_JTAG_INIT_FAILED;
@@ -361,7 +341,7 @@ static int parport_init(void)
 
        i = IEEE1284_MODE_COMPAT;
        i = ioctl(device_handle, PPNEGOT, & i);
-       if (i<0)
+       if (i < 0)
        {
                LOG_ERROR("cannot set compatible 1284 mode to device");
                return ERROR_JTAG_INIT_FAILED;
@@ -405,6 +385,8 @@ static int parport_init(void)
 
        bitbang_interface = &parport_bitbang;
 
+       wait_states = jtag_get_speed();
+
        return ERROR_OK;
 }
 
@@ -427,16 +409,14 @@ static int parport_quit(void)
        return ERROR_OK;
 }
 
-static int parport_handle_parport_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(parport_handle_parport_port_command)
 {
-       if (argc == 1)
+       if (CMD_ARGC == 1)
        {
                /* only if the port wasn't overwritten by cmdline */
                if (parport_port == 0)
                {
-                       int retval = parse_u16(args[0], &parport_port);
-                       if (ERROR_OK != retval)
-                               return retval;
+                       COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], parport_port);
                }
                else
                {
@@ -445,38 +425,94 @@ static int parport_handle_parport_port_command(struct command_context_s *cmd_ctx
                }
        }
 
-       command_print(cmd_ctx, "parport port = %u", parport_port);
+       command_print(CMD_CTX, "parport port = %u", parport_port);
 
        return ERROR_OK;
 }
 
-static int parport_handle_parport_cable_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(parport_handle_parport_cable_command)
 {
-       if (argc == 0)
+       if (CMD_ARGC == 0)
                return ERROR_OK;
 
        /* only if the cable name wasn't overwritten by cmdline */
        if (parport_cable == 0)
        {
-               parport_cable = malloc(strlen(args[0]) + sizeof(char));
-               strcpy(parport_cable, args[0]);
+               parport_cable = malloc(strlen(CMD_ARGV[0]) + sizeof(char));
+               strcpy(parport_cable, CMD_ARGV[0]);
        }
 
        return ERROR_OK;
 }
 
-static int parport_handle_write_on_exit_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(parport_handle_write_on_exit_command)
 {
-       if (argc != 1)
+       if (CMD_ARGC != 1)
        {
-               command_print(cmd_ctx, "usage: parport_write_on_exit <on|off>");
+               command_print(CMD_CTX, "usage: parport_write_on_exit <on | off>");
                return ERROR_OK;
        }
 
-       if (strcmp(args[0], "on") == 0)
-               parport_exit = 1;
-       else if (strcmp(args[0], "off") == 0)
-               parport_exit = 0;
+       COMMAND_PARSE_ON_OFF(CMD_ARGV[0], parport_exit);
 
        return ERROR_OK;
 }
+
+COMMAND_HANDLER(parport_handle_parport_toggling_time_command)
+{
+       if (CMD_ARGC == 1) {
+               uint32_t ns;
+               int retval = parse_u32(CMD_ARGV[0], &ns);
+
+               if (ERROR_OK != retval)
+                       return retval;
+
+               if (ns == 0) {
+                       LOG_ERROR("0 ns is not a valid parport toggling time");
+                       return ERROR_FAIL;
+               }
+
+               parport_toggling_time_ns = ns;
+               wait_states = jtag_get_speed();
+       }
+
+       command_print(CMD_CTX, "parport toggling time = %" PRIu32 " ns",
+                       parport_toggling_time_ns);
+
+       return ERROR_OK;
+}
+
+static int parport_register_commands(struct command_context *cmd_ctx)
+{
+       register_command(cmd_ctx, NULL, "parport_port",
+                       parport_handle_parport_port_command, COMMAND_CONFIG,
+                       "either the address of the I/O port "
+                       "or the number of the '/dev/parport' device");
+
+       register_command(cmd_ctx, NULL, "parport_cable",
+                       parport_handle_parport_cable_command, COMMAND_CONFIG,
+                       "the layout of the parallel port cable "
+                       "used to connect to the target");
+
+       register_command(cmd_ctx, NULL, "parport_write_on_exit",
+                       parport_handle_write_on_exit_command, COMMAND_CONFIG,
+                       "configure the parallel driver to write "
+                       "a known value to the parallel interface");
+
+       register_command(cmd_ctx, NULL, "parport_toggling_time",
+                       parport_handle_parport_toggling_time_command, COMMAND_ANY,
+                       "time <ns> it takes for the hardware to toggle TCK");
+
+       return ERROR_OK;
+}
+
+struct jtag_interface parport_interface = {
+       .name =                 "parport",
+       .register_commands =    parport_register_commands,
+       .init =                 parport_init,
+       .quit =                 parport_quit,
+       .khz =                  parport_khz,
+       .speed_div =            parport_speed_div,
+       .speed =                parport_speed,
+       .execute_queue =        bitbang_execute_queue,
+};