serial.c: Be more verbose about failing to parse parameter string

[libsigrok.git] / hardware / common / serial.c

diff --git a/hardware/common/serial.c b/hardware/common/serial.c
index b9ef46d4cda23960e2035a571d2296a687810db9..98b076109c0ffd2392fc1f5697c772cc67fdd108 100644 (file)
--- a/hardware/common/serial.c
+++ b/hardware/common/serial.c
@@ -305,7 +305,8 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
  * @return SR_OK upon success, SR_ERR upon failure.
  */
 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
-               int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr)
+                             int bits, int parity, int stopbits,
+                             int flowcontrol, int rts, int dtr)
 {
        if (!serial) {
                sr_dbg("Invalid serial port.");
@@ -314,51 +315,132 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 
        if (serial->fd == -1) {
                sr_dbg("Cannot configure unopened serial port %s (fd %d).",
-                               serial->port, serial->fd);
+                      serial->port, serial->fd);
                return SR_ERR;
        }
 
        sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
-                       serial->fd);
+               serial->fd);
 
 #ifdef _WIN32
        DCB dcb;
 
-       if (!GetCommState(hdl, &dcb))
+       if (!GetCommState(hdl, &dcb)) {
+               sr_err("Failed to get comm state on port %s (fd %d): %d.",
+                      serial->port, serial->fd, GetLastError());
                return SR_ERR;
+       }
 
        switch (baudrate) {
-       case 115200:
-               dcb.BaudRate = CBR_115200;
+       /*
+        * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
+        * have documented CBR_* macros.
+        */
+       case 110:
+               dcb.BaudRate = CBR_110;
                break;
-       case 57600:
-               dcb.BaudRate = CBR_57600;
+       case 300:
+               dcb.BaudRate = CBR_300;
                break;
-       case 38400:
-               dcb.BaudRate = CBR_38400;
+       case 600:
+               dcb.BaudRate = CBR_600;
                break;
-       case 19200:
-               dcb.BaudRate = CBR_19200;
+       case 1200:
+               dcb.BaudRate = CBR_1200;
                break;
-       case 9600:
-               dcb.BaudRate = CBR_9600;
+       case 2400:
+               dcb.BaudRate = CBR_2400;
                break;
        case 4800:
                dcb.BaudRate = CBR_4800;
                break;
-       case 2400:
-               dcb.BaudRate = CBR_2400;
+       case 9600:
+               dcb.BaudRate = CBR_9600;
+               break;
+       case 14400:
+               dcb.BaudRate = CBR_14400; /* Not available on Unix? */
+               break;
+       case 19200:
+               dcb.BaudRate = CBR_19200;
+               break;
+       case 38400:
+               dcb.BaudRate = CBR_38400;
+               break;
+       case 57600:
+               dcb.BaudRate = CBR_57600;
+               break;
+       case 115200:
+               dcb.BaudRate = CBR_115200;
+               break;
+       case 128000:
+               dcb.BaudRate = CBR_128000; /* Not available on Unix? */
+               break;
+       case 256000:
+               dcb.BaudRate = CBR_256000; /* Not available on Unix? */
                break;
        default:
-               sr_err("Unsupported baudrate %d.", baudrate);
+               sr_err("Unsupported baudrate: %d.", baudrate);
                return SR_ERR;
        }
+       sr_spew("Configuring baudrate to %d (%d).", baudrate, dcb.BaudRate);
+
+       sr_spew("Configuring %d data bits.", bits);
        dcb.ByteSize = bits;
-       dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
-       dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
 
-       if (!SetCommState(hdl, &dcb))
+       sr_spew("Configuring %d stop bits.", stopbits);
+       switch (stopbits) {
+       /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
+       case 1:
+               dcb.StopBits = ONESTOPBIT;
+               break;
+       case 2:
+               dcb.StopBits = TWOSTOPBITS;
+               break;
+       default:
+               sr_err("Unsupported stopbits number: %d.", stopbits);
                return SR_ERR;
+       }
+
+       switch (parity) {
+       /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
+       case SERIAL_PARITY_NONE:
+               sr_spew("Configuring no parity.");
+               dcb.Parity = NOPARITY;
+               break;
+       case SERIAL_PARITY_EVEN:
+               sr_spew("Configuring even parity.");
+               dcb.Parity = EVENPARITY;
+               break;
+       case SERIAL_PARITY_ODD:
+               sr_spew("Configuring odd parity.");
+               dcb.Parity = ODDPARITY;
+               break;
+       default:
+               sr_err("Unsupported parity setting: %d.", parity);
+               return SR_ERR;
+       }
+
+       if (rts != -1) {
+               sr_spew("Setting RTS %s.", rts ? "high" : "low");
+               if (rts)
+                       dcb.fRtsControl = RTS_CONTROL_ENABLE;
+               else
+                       dcb.fRtsControl = RTS_CONTROL_DISABLE;
+       }
+
+       if (dtr != -1) {
+               sr_spew("Setting DTR %s.", dtr ? "high" : "low");
+               if (rts)
+                       dcb.fDtrControl = DTR_CONTROL_ENABLE;
+               else
+                       dcb.fDtrControl = DTR_CONTROL_DISABLE;
+       }
+
+       if (!SetCommState(hdl, &dcb)) {
+               sr_err("Failed to set comm state on port %s (fd %d): %d.",
+                      serial->port, serial->fd, GetLastError());
+               return SR_ERR;
+       }
 #else
        struct termios term;
        speed_t baud;
@@ -431,7 +513,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
                break;
 #endif
        default:
-               sr_err("Unsupported baudrate %d.", baudrate);
+               sr_err("Unsupported baudrate: %d.", baudrate);
                return SR_ERR;
        }
 
@@ -573,6 +655,7 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 
        speed = databits = parity = stopbits = 0;
        rts = dtr = -1;
+       sr_spew("Parsing parameters from \"%s\".", paramstr);
        reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
        if (g_regex_match(reg, paramstr, 0, &match)) {
                if ((mstr = g_match_info_fetch(match, 1)))
@@ -636,11 +719,13 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
        g_match_info_unref(match);
        g_regex_unref(reg);
 
-       if (speed)
-               return serial_set_params(serial, speed, databits, parity, stopbits,
-                               0, rts, dtr);
-       else
+       if (speed) {
+               return serial_set_params(serial, speed, databits, parity,
+                                        stopbits, 0, rts, dtr);
+       } else {
+               sr_dbg("Could not infer speed from parameter string.");
                return SR_ERR_ARG;
+       }
 }
 
 /**