Support more debugger protocol in IoT.js (#1876)

Adding new options to select serial protocol and rawpacket communcation channel.

IoT.js-DCO-1.0-Signed-off-by: Robert Sipka rsipka.uszeged@partner.samsung.com

Author: robertsipka

docs/devs/Use-JerryScript-Debugger.md

@@ -23,12 +23,26 @@ The file argument is ignored in this case, therefore doesn't need to be specifie
 thus, there's no need to restart the environment if the remote source is changed.
 **Important note**: Remote sources must be sent in correct order! IoT.js compiles them in the order they are received, so file(s) used with `require` should be sent first, and the file(s) using them after.
 
+#### Select Channel and Protocol
+
+There are two available extension-provided channels, websocket and rawpacket, and two protocols, tcp and serial. Each initializes the debugger and blocks until a client connects. If you want to specify the debugger channel (default: websocket) or protocol (default: tcp) over the communication you can do with the `--debug-channel [websocket|rawpacket]` and `--debug-protocol [tcp|serial]` options:
+
+`<iotjs binary> --start-debug-server --debugger-channel rawpacket --debug-protocol tcp test.js`
+
 #### Setting the debugger port
 
-If you want to specify the port number of the debugger-server (default: 5001),
+If you want to specify the port number of the debugger-server with tcp connection (default: 5001),
 you can do so with the `--debugger-port <PORT>` option:
+
 `<iotjs binary> --start-debug-server --debugger-port 8080 test.js`
 
+#### Configure the serial port
+
+If you want to configure parameters for serial port (default: /dev/ttyS0,115200,8,N,1), you can do with `--debug-serial-config CONFIG` option:
+
+`<iotjs binary> --start-debug-server --debug-channel rawpacket --debug-protocol serial --debug-serial-config "/dev/ttyUSB0,115200,8,N,1" test.js`
+
+
 #### Available Clients
 
 * [JerryScript console debugger client](https://github.com/pando-project/jerryscript/blob/master/jerry-debugger/jerry-client-ws.py)

src/iotjs.c

@@ -57,9 +57,27 @@ static bool jerry_initialize(iotjs_environment_t* env) {
 
 #ifdef JERRY_DEBUGGER
   if (iotjs_environment_config(env)->debugger != NULL) {
-    uint16_t port = iotjs_environment_config(env)->debugger->port;
-    jerryx_debugger_after_connect(jerryx_debugger_tcp_create(port) &&
-                                  jerryx_debugger_ws_create());
+    bool protocol_created = false;
+    char* debug_protocol = iotjs_environment_config(env)->debugger->protocol;
+    char* debug_channel = iotjs_environment_config(env)->debugger->channel;
+
+    if (!strcmp(debug_protocol, "tcp")) {
+      uint16_t port = iotjs_environment_config(env)->debugger->port;
+      protocol_created = jerryx_debugger_tcp_create(port);
+    } else {
+      IOTJS_ASSERT(!strcmp(debug_protocol, "serial"));
+      char* config = iotjs_environment_config(env)->debugger->serial_config;
+      protocol_created = jerryx_debugger_serial_create(config);
+    }
+
+    if (!strcmp(debug_channel, "rawpacket")) {
+      jerryx_debugger_after_connect(protocol_created &&
+                                    jerryx_debugger_rp_create());
+    } else {
+      IOTJS_ASSERT(!strcmp(debug_channel, "websocket"));
+      jerryx_debugger_after_connect(protocol_created &&
+                                    jerryx_debugger_ws_create());
+    }
 
     if (!jerry_debugger_is_connected()) {
       DLOG("jerry debugger connection failed");

src/iotjs_env.c

@@ -28,6 +28,9 @@ typedef enum {
   OPT_DEBUG_SERVER,
   OPT_DEBUGGER_WAIT_SOURCE,
   OPT_DEBUG_PORT,
+  OPT_DEBUG_CHANNEL,
+  OPT_DEBUG_PROTOCOL,
+  OPT_DEBUG_SERIAL_CONFIG,
 #endif
   NUM_OF_OPTIONS
 } cli_option_id_t;
@@ -133,6 +136,24 @@ bool iotjs_environment_parse_command_line_arguments(iotjs_environment_t* env,
         .more = 1,
         .help = "debug server port (default: 5001)",
     },
+    {
+        .id = OPT_DEBUG_CHANNEL,
+        .longopt = "debug-channel",
+        .help = "specify the debugger transmission channel"
+                " (default: websocket)",
+    },
+    {
+        .id = OPT_DEBUG_PROTOCOL,
+        .longopt = "debug-protocol",
+        .help = "Specify the transmission protocol over the communication"
+                " channel (default: tcp)",
+    },
+    {
+        .id = OPT_DEBUG_SERIAL_CONFIG,
+        .longopt = "debug-serial-config",
+        .help = "configure parameters for serial port"
+                " (default: /dev/ttyS0,115200,8,N,1)",
+    },
 #endif
   };
 
@@ -187,12 +208,67 @@ bool iotjs_environment_parse_command_line_arguments(iotjs_environment_t* env,
         env->config.debugger->context_reset = false;
         env->config.debugger->wait_source =
             cur_opt->id == OPT_DEBUGGER_WAIT_SOURCE;
+        char default_channel[] = "websocket";
+        char default_protocol[] = "tcp";
+        char default_serial_config[] = "/dev/ttyS0,115200,8,N,1";
+        memcpy(env->config.debugger->channel, default_channel,
+               strlen(default_channel) + 1);
+        memcpy(env->config.debugger->protocol, default_protocol,
+               strlen(default_protocol) + 1);
+        memcpy(env->config.debugger->serial_config, default_serial_config,
+               strlen(default_serial_config) + 1);
       } break;
       case OPT_DEBUG_PORT: {
         if (env->config.debugger) {
           char* pos = NULL;
           env->config.debugger->port = (uint16_t)strtoul(argv[i + 1], &pos, 10);
         }
+        i++;
+      } break;
+      case OPT_DEBUG_CHANNEL: {
+        if (env->config.debugger) {
+          memset(env->config.debugger->channel, 0,
+                 strlen(env->config.debugger->channel) + 1);
+          memcpy(env->config.debugger->channel, argv[i + 1],
+                 strlen(argv[i + 1]) + 1);
+
+          if (strcmp(env->config.debugger->channel, "websocket") &&
+              strcmp(env->config.debugger->channel, "rawpacket")) {
+            fprintf(stderr,
+                    "Debug channel %s is not supported."
+                    " Only websocket or rawpacket is allowed\n",
+                    env->config.debugger->channel);
+            return false;
+          }
+        }
+        i++;
+      } break;
+      case OPT_DEBUG_PROTOCOL: {
+        if (env->config.debugger) {
+          memset(env->config.debugger->protocol, 0,
+                 strlen(env->config.debugger->protocol) + 1);
+          memcpy(env->config.debugger->protocol, argv[i + 1],
+                 strlen(argv[i + 1]) + 1);
+
+          if (strcmp(env->config.debugger->protocol, "tcp") &&
+              strcmp(env->config.debugger->protocol, "serial")) {
+            fprintf(stderr,
+                    "Debug protocol %s is not supported."
+                    " Only tcp or serial is allowed\n",
+                    env->config.debugger->protocol);
+            return false;
+          }
+        }
+        i++;
+      } break;
+      case OPT_DEBUG_SERIAL_CONFIG: {
+        if (env->config.debugger) {
+          memset(env->config.debugger->serial_config, 0,
+                 strlen(env->config.debugger->serial_config) + 1);
+          memcpy(env->config.debugger->serial_config, argv[i + 1],
+                 strlen(argv[i + 1]) + 1);
+        }
+        i++;
       } break;
 #endif
       default:

src/iotjs_env.h

@@ -23,6 +23,9 @@ typedef struct {
   bool wait_source;
   bool context_reset;
   uint16_t port;
+  char channel[16];
+  char protocol[16];
+  char serial_config[64];
 } DebuggerConfig;
 #endif