]> sigrok.org Git - libserialport.git/blobdiff - serialport.c
Cosmetics, whitespace, consistency fixes.
[libserialport.git] / serialport.c
index f95afd0cd0af8d537e6576433654ad0107ac3b87..9ef3cd3bd3eb8c9f701fccfda8f77c40fb8e840d 100644 (file)
@@ -46,7 +46,7 @@
 
 #include "libserialport.h"
 
-struct sp_port_data {
+struct port_data {
 #ifdef _WIN32
        DCB dcb;
 #else
@@ -77,13 +77,14 @@ const struct std_baudrate std_baudrates[] = {
         */
        BAUD(110), BAUD(300), BAUD(600), BAUD(1200), BAUD(2400), BAUD(4800),
        BAUD(9600), BAUD(14400), BAUD(19200), BAUD(38400), BAUD(57600),
-       BAUD(115200), BAUD(128000), BAUD(256000)
+       BAUD(115200), BAUD(128000), BAUD(256000),
 #else
-       BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200), BAUD(300),
-       BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800), BAUD(9600),
-       BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200), BAUD(230400),
+       BAUD(50), BAUD(75), BAUD(110), BAUD(134), BAUD(150), BAUD(200),
+       BAUD(300), BAUD(600), BAUD(1200), BAUD(1800), BAUD(2400), BAUD(4800),
+       BAUD(9600), BAUD(19200), BAUD(38400), BAUD(57600), BAUD(115200),
+       BAUD(230400),
 #if !defined(__APPLE__) && !defined(__OpenBSD__)
-       BAUD(460800)
+       BAUD(460800),
 #endif
 #endif
 };
@@ -91,11 +92,15 @@ const struct std_baudrate std_baudrates[] = {
 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
 #define NUM_STD_BAUDRATES ARRAY_SIZE(std_baudrates)
 
-/* Helper functions for configuring ports. */
-static int get_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config);
-static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config);
+/* Helper functions. */
+static enum sp_return validate_port(struct sp_port *port);
+static struct sp_port **list_append(struct sp_port **list, const char *portname);
+static enum sp_return get_config(struct sp_port *port, struct port_data *data,
+       struct sp_port_config *config);
+static enum sp_return set_config(struct sp_port *port, struct port_data *data,
+       const struct sp_port_config *config);
 
-int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
+enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
 {
        struct sp_port *port;
        int len;
@@ -113,20 +118,25 @@ int sp_get_port_by_name(const char *portname, struct sp_port **port_ptr)
 
        len = strlen(portname) + 1;
 
-       if (!(port->name = malloc(len)))
-       {
+       if (!(port->name = malloc(len))) {
                free(port);
                return SP_ERR_MEM;
        }
 
        memcpy(port->name, portname, len);
 
+#ifdef _WIN32
+       port->hdl = INVALID_HANDLE_VALUE;
+#else
+       port->fd = -1;
+#endif
+
        *port_ptr = port;
 
        return SP_OK;
 }
 
-int sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
+enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_ptr)
 {
        if (!copy_ptr)
                return SP_ERR_ARG;
@@ -150,7 +160,7 @@ void sp_free_port(struct sp_port *port)
        free(port);
 }
 
-static struct sp_port **sp_list_append(struct sp_port **list, const char *portname)
+static struct sp_port **list_append(struct sp_port **list, const char *portname)
 {
        void *tmp;
        unsigned int count;
@@ -169,7 +179,7 @@ fail:
        return NULL;
 }
 
-int sp_list_ports(struct sp_port ***list_ptr)
+enum sp_return sp_list_ports(struct sp_port ***list_ptr)
 {
        struct sp_port **list;
        int ret = SP_OK;
@@ -189,25 +199,21 @@ int sp_list_ports(struct sp_port ***list_ptr)
        int name_len;
 
        if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T("HARDWARE\\DEVICEMAP\\SERIALCOMM"),
-                       0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS)
-       {
+                       0, KEY_QUERY_VALUE, &key) != ERROR_SUCCESS) {
                ret = SP_ERR_FAIL;
                goto out_done;
        }
        if (RegQueryInfoKey(key, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
-                               &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS)
-       {
+                               &max_value_len, &max_data_size, NULL, NULL) != ERROR_SUCCESS) {
                ret = SP_ERR_FAIL;
                goto out_close;
        }
        max_data_len = max_data_size / sizeof(TCHAR);
-       if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR))))
-       {
+       if (!(value = malloc((max_value_len + 1) * sizeof(TCHAR)))) {
                ret = SP_ERR_MEM;
                goto out_close;
        }
-       if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR))))
-       {
+       if (!(data = malloc((max_data_len + 1) * sizeof(TCHAR)))) {
                ret = SP_ERR_MEM;
                goto out_free_value;
        }
@@ -224,8 +230,7 @@ int sp_list_ports(struct sp_port ***list_ptr)
 #else
                name_len = data_len + 1;
 #endif
-               if (!(name = malloc(name_len)))
-               {
+               if (!(name = malloc(name_len))) {
                        ret = SP_ERR_MEM;
                        goto out;
                }
@@ -234,8 +239,7 @@ int sp_list_ports(struct sp_port ***list_ptr)
 #else
                strcpy(name, data);
 #endif
-               if (type == REG_SZ && !(list = sp_list_append(list, name)))
-               {
+               if (type == REG_SZ && !(list = list_append(list, name))) {
                        ret = SP_ERR_MEM;
                        goto out;
                }
@@ -258,14 +262,12 @@ out_done:
        CFTypeRef cf_path;
        Boolean result;
 
-       if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS)
-       {
+       if (IOMasterPort(MACH_PORT_NULL, &master) != KERN_SUCCESS) {
                ret = SP_ERR_FAIL;
                goto out_done;
        }
 
-       if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue)))
-       {
+       if (!(classes = IOServiceMatching(kIOSerialBSDServiceValue))) {
                ret = SP_ERR_FAIL;
                goto out_done;
        }
@@ -273,14 +275,12 @@ out_done:
        CFDictionarySetValue(classes,
                        CFSTR(kIOSerialBSDTypeKey), CFSTR(kIOSerialBSDAllTypes));
 
-       if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS)
-       {
+       if (IOServiceGetMatchingServices(master, classes, &iter) != KERN_SUCCESS) {
                ret = SP_ERR_FAIL;
                goto out_done;
        }
 
-       if (!(path = malloc(PATH_MAX)))
-       {
+       if (!(path = malloc(PATH_MAX))) {
                ret = SP_ERR_MEM;
                goto out_release;
        }
@@ -292,8 +292,7 @@ out_done:
                        result = CFStringGetCString(cf_path,
                                        path, PATH_MAX, kCFStringEncodingASCII);
                        CFRelease(cf_path);
-                       if (result && !(list = sp_list_append(list, path)))
-                       {
+                       if (result && !(list = list_append(list, path))) {
                                ret = SP_ERR_MEM;
                                IOObjectRelease(port);
                                goto out;
@@ -324,14 +323,12 @@ out_done:
        udev_enumerate_add_match_subsystem(ud_enumerate, "tty");
        udev_enumerate_scan_devices(ud_enumerate);
        ud_list = udev_enumerate_get_list_entry(ud_enumerate);
-       udev_list_entry_foreach(ud_entry, ud_list)
-       {
+       udev_list_entry_foreach(ud_entry, ud_list) {
                path = udev_list_entry_get_name(ud_entry);
                ud_dev = udev_device_new_from_syspath(ud, path);
                /* If there is no parent device, this is a virtual tty. */
                ud_parent = udev_device_get_parent(ud_dev);
-               if (ud_parent == NULL)
-               {
+               if (ud_parent == NULL) {
                        udev_device_unref(ud_dev);
                        continue;
                }
@@ -340,8 +337,7 @@ out_done:
                 * The only way to tell which actually exist on a given system
                 * is to try to open them and make an ioctl call. */
                driver = udev_device_get_driver(ud_parent);
-               if (driver && !strcmp(driver, "serial8250"))
-               {
+               if (driver && !strcmp(driver, "serial8250")) {
                        if ((fd = open(name, O_RDWR | O_NONBLOCK | O_NOCTTY)) < 0)
                                goto skip;
                        ioctl_result = ioctl(fd, TIOCGSERIAL, &serial_info);
@@ -351,11 +347,10 @@ out_done:
                        if (serial_info.type == PORT_UNKNOWN)
                                goto skip;
                }
-               list = sp_list_append(list, name);
+               list = list_append(list, name);
 skip:
                udev_device_unref(ud_dev);
-               if (!list)
-               {
+               if (!list) {
                        ret = SP_ERR_MEM;
                        goto out;
                }
@@ -365,15 +360,11 @@ out:
        udev_unref(ud);
 #endif
 
-       if (ret == SP_OK)
-       {
+       if (ret == SP_OK) {
                *list_ptr = list;
-       }
-       else
-       {
+       } else {
                if (list)
                        sp_free_port_list(list);
-
                *list_ptr = NULL;
        }
 
@@ -389,7 +380,7 @@ void sp_free_port_list(struct sp_port **list)
        free(list);
 }
 
-static int sp_validate_port(struct sp_port *port)
+static enum sp_return validate_port(struct sp_port *port)
 {
        if (port == NULL)
                return 0;
@@ -403,9 +394,9 @@ static int sp_validate_port(struct sp_port *port)
        return 1;
 }
 
-#define CHECK_PORT() do { if (!sp_validate_port(port)) return SP_ERR_ARG; } while (0)
+#define CHECK_PORT() do { if (!validate_port(port)) return SP_ERR_ARG; } while (0)
 
-int sp_open(struct sp_port *port, int flags)
+enum sp_return sp_open(struct sp_port *port, enum sp_mode flags)
 {
        if (!port)
                return SP_ERR_ARG;
@@ -436,7 +427,7 @@ int sp_open(struct sp_port *port, int flags)
                return SP_ERR_FAIL;
 #else
        int flags_local = 0;
-       struct sp_port_data data;
+       struct port_data data;
        struct sp_port_config config;
        int ret;
 
@@ -453,8 +444,7 @@ int sp_open(struct sp_port *port, int flags)
 
        ret = get_config(port, &data, &config);
 
-       if (ret < 0)
-       {
+       if (ret < 0) {
                sp_close(port);
                return ret;
        }
@@ -473,8 +463,7 @@ int sp_open(struct sp_port *port, int flags)
 
        ret = set_config(port, &data, &config);
 
-       if (ret < 0)
-       {
+       if (ret < 0) {
                sp_close(port);
                return ret;
        }
@@ -483,7 +472,7 @@ int sp_open(struct sp_port *port, int flags)
        return SP_OK;
 }
 
-int sp_close(struct sp_port *port)
+enum sp_return sp_close(struct sp_port *port)
 {
        CHECK_PORT();
 
@@ -491,16 +480,18 @@ int sp_close(struct sp_port *port)
        /* Returns non-zero upon success, 0 upon failure. */
        if (CloseHandle(port->hdl) == 0)
                return SP_ERR_FAIL;
+       port->hdl = INVALID_HANDLE_VALUE;
 #else
        /* Returns 0 upon success, -1 upon failure. */
        if (close(port->fd) == -1)
                return SP_ERR_FAIL;
+       port->fd = -1;
 #endif
 
        return SP_OK;
 }
 
-int sp_flush(struct sp_port *port)
+enum sp_return sp_flush(struct sp_port *port)
 {
        CHECK_PORT();
 
@@ -516,7 +507,7 @@ int sp_flush(struct sp_port *port)
        return SP_OK;
 }
 
-int sp_write(struct sp_port *port, const void *buf, size_t count)
+enum sp_return sp_write(struct sp_port *port, const void *buf, size_t count)
 {
        CHECK_PORT();
 
@@ -541,7 +532,7 @@ int sp_write(struct sp_port *port, const void *buf, size_t count)
 #endif
 }
 
-int sp_read(struct sp_port *port, void *buf, size_t count)
+enum sp_return sp_read(struct sp_port *port, void *buf, size_t count)
 {
        CHECK_PORT();
 
@@ -565,7 +556,8 @@ int sp_read(struct sp_port *port, void *buf, size_t count)
 #endif
 }
 
-static int get_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config)
+static enum sp_return get_config(struct sp_port *port, struct port_data *data,
+       struct sp_port_config *config)
 {
        unsigned int i;
 
@@ -615,33 +607,33 @@ static int get_config(struct sp_port *port, struct sp_port_data *data, struct sp
        }
 
        switch (data->dcb.fRtsControl) {
-               case RTS_CONTROL_DISABLE:
-                       config->rts = SP_RTS_OFF;
-                       break;
-               case RTS_CONTROL_ENABLE:
-                       config->rts = SP_RTS_ON;
-                       break;
-               case RTS_CONTROL_HANDSHAKE:
-                       config->rts = SP_RTS_FLOW_CONTROL;
-                       break;
-               default:
-                       config->rts = -1;
+       case RTS_CONTROL_DISABLE:
+               config->rts = SP_RTS_OFF;
+               break;
+       case RTS_CONTROL_ENABLE:
+               config->rts = SP_RTS_ON;
+               break;
+       case RTS_CONTROL_HANDSHAKE:
+               config->rts = SP_RTS_FLOW_CONTROL;
+               break;
+       default:
+               config->rts = -1;
        }
 
        config->cts = data->dcb.fOutxCtsFlow ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE;
 
        switch (data->dcb.fDtrControl) {
-               case DTR_CONTROL_DISABLE:
-                       config->dtr = SP_DTR_OFF;
-                       break;
-               case DTR_CONTROL_ENABLE:
-                       config->dtr = SP_DTR_ON;
-                       break;
-               case DTR_CONTROL_HANDSHAKE:
-                       config->dtr = SP_DTR_FLOW_CONTROL;
-                       break;
-               default:
-                       config->dtr = -1;
+       case DTR_CONTROL_DISABLE:
+               config->dtr = SP_DTR_OFF;
+               break;
+       case DTR_CONTROL_ENABLE:
+               config->dtr = SP_DTR_ON;
+               break;
+       case DTR_CONTROL_HANDSHAKE:
+               config->dtr = SP_DTR_FLOW_CONTROL;
+               break;
+       default:
+               config->dtr = -1;
        }
 
        config->dsr = data->dcb.fOutxDsrFlow ? SP_DSR_FLOW_CONTROL : SP_DSR_IGNORE;
@@ -711,18 +703,21 @@ static int get_config(struct sp_port *port, struct sp_port_data *data, struct sp
 
        config->dtr = (data->controlbits & TIOCM_DTR) ? SP_DTR_ON : SP_DTR_OFF;
        config->dsr = SP_DSR_IGNORE;
+
+       /* FIXME: Set config->xon_xoff properly, depending on data->term. */
+       config->xon_xoff = SP_XONXOFF_DISABLED;
 #endif
 
        return SP_OK;
 }
 
-static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp_port_config *config)
+static enum sp_return set_config(struct sp_port *port, struct port_data *data, 
+       const struct sp_port_config *config)
 {
        unsigned int i;
 
 #ifdef _WIN32
-       if (config->baudrate >= 0)
-       {
+       if (config->baudrate >= 0) {
                for (i = 0; i < NUM_STD_BAUDRATES; i++) {
                        if (config->baudrate == std_baudrates[i].value) {
                                data->dcb.BaudRate = std_baudrates[i].index;
@@ -854,8 +849,7 @@ static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp
 
 #else // !_WIN32
 
-       if (config->baudrate >= 0)
-       {
+       if (config->baudrate >= 0) {
                for (i = 0; i < NUM_STD_BAUDRATES; i++) {
                        if (config->baudrate == std_baudrates[i].value) {
                                if (cfsetospeed(&data->term, std_baudrates[i].index) < 0)
@@ -883,6 +877,9 @@ static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp
                case 6:
                        data->term.c_cflag |= CS6;
                        break;
+               case 5:
+                       data->term.c_cflag |= CS5;
+                       break;
                default:
                        return SP_ERR_ARG;
                }
@@ -920,8 +917,7 @@ static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp
                }
        }
 
-       if (config->rts >= 0 || config->cts >= 0)
-       {
+       if (config->rts >= 0 || config->cts >= 0) {
                /* Asymmetric use of RTS/CTS not supported yet. */
 
                if (data->term.c_iflag & CRTSCTS) {
@@ -953,8 +949,7 @@ static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp
                }
        }
 
-       if (config->dtr >= 0 || config->dsr >= 0)
-       {
+       if (config->dtr >= 0 || config->dsr >= 0) {
                /* DTR/DSR flow control not supported yet. */
                if (config->dtr == SP_DTR_FLOW_CONTROL || config->dsr == SP_DSR_FLOW_CONTROL)
                        return SP_ERR_ARG;
@@ -995,41 +990,49 @@ static int set_config(struct sp_port *port, struct sp_port_data *data, struct sp
 
 #define TRY(x) do { int ret = x; if (ret != SP_OK) return ret; } while (0)
 
-int sp_set_config(struct sp_port *port, struct sp_port_config *config)
+enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *config)
 {
-       struct sp_port_data data;
+       struct port_data data;
        struct sp_port_config prev_config;
 
+       CHECK_PORT();
+
+       if (!config)
+               return SP_ERR_ARG;
+
        TRY(get_config(port, &data, &prev_config));
        TRY(set_config(port, &data, config));
 
        return SP_OK;
 }
 
-#define CREATE_SETTER(x) int sp_set_##x(struct sp_port *port, int x) { \
-       struct sp_port_data data; \
+#define CREATE_SETTER(x, type) int sp_set_##x(struct sp_port *port, type x) { \
+       struct port_data data; \
        struct sp_port_config config; \
+       CHECK_PORT(); \
        TRY(get_config(port, &data, &config)); \
        config.x = x; \
        TRY(set_config(port, &data, &config)); \
        return SP_OK; \
 }
 
-CREATE_SETTER(baudrate)
-CREATE_SETTER(bits)
-CREATE_SETTER(parity)
-CREATE_SETTER(stopbits)
-CREATE_SETTER(rts)
-CREATE_SETTER(cts)
-CREATE_SETTER(dtr)
-CREATE_SETTER(dsr)
-CREATE_SETTER(xon_xoff)
-
-int sp_set_flowcontrol(struct sp_port *port, int flowcontrol)
+CREATE_SETTER(baudrate, int)
+CREATE_SETTER(bits, int)
+CREATE_SETTER(parity, enum sp_parity)
+CREATE_SETTER(stopbits, int)
+CREATE_SETTER(rts, enum sp_rts)
+CREATE_SETTER(cts, enum sp_cts)
+CREATE_SETTER(dtr, enum sp_dtr)
+CREATE_SETTER(dsr, enum sp_dsr)
+CREATE_SETTER(xon_xoff, enum sp_xonxoff)
+
+enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flowcontrol)
 {
-       struct sp_port_data data;
+       struct port_data data;
        struct sp_port_config config;
 
+       CHECK_PORT();
+
        TRY(get_config(port, &data, &config));
 
        if (flowcontrol == SP_FLOWCONTROL_XONXOFF)