X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fserial.c;h=b1e21eecbcbd69a3e21ffcd28620f76d122be444;hb=ad5aa993ae5f5277755ed9c6e99fd647f4fa0d7b;hp=3b1f4264ce714eee277d2bcabf7f17fe401e7585;hpb=ae4c1fb6375473169a92bd227aecfe88a311caa0;p=libsigrok.git diff --git a/src/serial.c b/src/serial.c index 3b1f4264..b1e21eec 100644 --- a/src/serial.c +++ b/src/serial.c @@ -25,7 +25,9 @@ #include #include #include +#ifdef HAVE_LIBSERIALPORT #include +#endif #include #include "libsigrok-internal.h" #ifdef _WIN32 @@ -50,6 +52,19 @@ * @{ */ +#ifdef HAVE_SERIAL_COMM + +/* See if a (assumed opened) serial port is of any supported type. */ +static int dev_is_supported(struct sr_serial_dev_inst *serial) +{ + if (!serial) + return 0; + if (!serial->lib_funcs) + return 0; + + return 1; +} + /** * Open the specified serial port. * @@ -76,7 +91,26 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags); - ret = sr_ser_libsp_open(serial, flags); + /* Default to the libserialport transport layer. */ + serial->lib_funcs = ser_lib_funcs_libsp; + if (!serial->lib_funcs) + return SR_ERR_NA; + + /* + * Note that use of the 'rcv_buffer' is optional, and the buffer's + * size heavily depends on the specific transport. That's why the + * buffer's content gets accessed and the buffer is released here in + * common code, but the buffer gets allocated in libraries' open() + * routines. + */ + + /* + * Run the transport's open routine. Setup the bitrate and the + * UART frame format. + */ + if (!serial->lib_funcs->open) + return SR_ERR_NA; + ret = serial->lib_funcs->open(serial, flags); if (ret != SR_OK) return ret; @@ -98,6 +132,8 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) */ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) { + int rc; + if (!serial) { sr_dbg("Invalid serial port."); return SR_ERR; @@ -105,7 +141,16 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial) sr_spew("Closing serial port %s.", serial->port); - return sr_ser_libsp_close(serial); + if (!serial->lib_funcs || !serial->lib_funcs->close) + return SR_ERR_NA; + + rc = serial->lib_funcs->close(serial); + if (rc == SR_OK && serial->rcv_buffer) { + g_string_free(serial->rcv_buffer, TRUE); + serial->rcv_buffer = NULL; + } + + return rc; } /** @@ -127,7 +172,12 @@ SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial) sr_spew("Flushing serial port %s.", serial->port); - return sr_ser_libsp_flush(serial); + sr_ser_discard_queued_data(serial); + + if (!serial->lib_funcs || !serial->lib_funcs->flush) + return SR_ERR_NA; + + return serial->lib_funcs->flush(serial); } /** @@ -149,7 +199,143 @@ SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial) sr_spew("Draining serial port %s.", serial->port); - return sr_ser_libsp_drain(serial); + if (!serial->lib_funcs || !serial->lib_funcs->drain) + return SR_ERR_NA; + + return serial->lib_funcs->drain(serial); +} + +/* + * Provide an internal RX data buffer for the serial port. This is not + * supposed to be used directly by applications. Instead optional and + * alternative transports for serial communication can use this buffer + * if their progress is driven from background activity, and is not + * (directly) driven by external API calls. + * + * BEWARE! This implementation assumes that data which gets communicated + * via UART can get stored in a GString (which is a char array). Since + * the API hides this detail, we can address this issue later when needed. + * Callers use the API which communicates bytes. + */ + +/** + * Discard previously queued RX data. Internal to the serial subsystem, + * coordination between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * + * @internal + */ +SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial) +{ + if (!serial) + return; + if (!serial->rcv_buffer) + return; + + g_string_truncate(serial->rcv_buffer, 0); +} + +/** + * Get amount of queued RX data. Internal to the serial subsystem, + * coordination between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * + * @internal + */ +SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial) +{ + if (!serial) + return 0; + if (!serial->rcv_buffer) + return 0; + + return serial->rcv_buffer->len; +} + +/** + * Queue received data. Internal to the serial subsystem, coordination + * between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * @param[in] data Pointer to data bytes to queue. + * @param[in] len Number of data bytes to queue. + * + * @internal + */ +SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial, + const uint8_t *data, size_t len) +{ + if (!serial) + return; + if (!data || !len) + return; + + if (serial->rcv_buffer) + g_string_append_len(serial->rcv_buffer, (const gchar *)data, len); +} + +/** + * Retrieve previously queued RX data. Internal to the serial subsystem, + * coordination between common and transport specific support code. + * + * @param[in] serial Previously opened serial port instance. + * @param[out] data Pointer to store retrieved data bytes into. + * @param[in] len Number of data bytes to retrieve. + * + * @internal + */ +SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial, + uint8_t *data, size_t len) +{ + size_t qlen; + GString *buf; + + if (!serial) + return 0; + if (!data || !len) + return 0; + + qlen = sr_ser_has_queued_data(serial); + if (!qlen) + return 0; + + buf = serial->rcv_buffer; + if (len > buf->len) + len = buf->len; + if (len) { + memcpy(data, buf->str, len); + g_string_erase(buf, 0, len); + } + + return len; +} + +/** + * Check for available receive data. + * + * @param[in] serial Previously opened serial port instance. + * + * @returns The number of (known) available RX data bytes. + * + * Returns 0 if no receive data is available, or if the amount of + * available receive data cannot get determined. + */ +SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial) +{ + size_t lib_count, buf_count; + + if (!serial) + return 0; + + lib_count = 0; + if (serial->lib_funcs && serial->lib_funcs->get_rx_avail) + lib_count = serial->lib_funcs->get_rx_avail(serial); + + buf_count = sr_ser_has_queued_data(serial); + + return lib_count + buf_count; } static int _serial_write(struct sr_serial_dev_inst *serial, @@ -163,7 +349,10 @@ static int _serial_write(struct sr_serial_dev_inst *serial, return SR_ERR; } - ret = sr_ser_libsp_write(serial, buf, count, nonblocking, timeout_ms); + if (!serial->lib_funcs || !serial->lib_funcs->write) + return SR_ERR_NA; + ret = serial->lib_funcs->write(serial, buf, count, + nonblocking, timeout_ms); sr_spew("Wrote %zd/%zu bytes.", ret, count); return ret; @@ -219,7 +408,10 @@ static int _serial_read(struct sr_serial_dev_inst *serial, return SR_ERR; } - ret = sr_ser_libsp_read(serial, buf, count, nonblocking, timeout_ms); + if (!serial->lib_funcs || !serial->lib_funcs->read) + return SR_ERR_NA; + ret = serial->lib_funcs->read(serial, buf, count, + nonblocking, timeout_ms); if (ret > 0) sr_spew("Read %zd/%zu bytes.", ret, count); @@ -298,8 +490,11 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, sr_spew("Setting serial parameters on port %s.", serial->port); - ret = sr_ser_libsp_set_params(serial, - baudrate, bits, parity, stopbits, flowcontrol, rts, dtr); + if (!serial->lib_funcs || !serial->lib_funcs->set_params) + return SR_ERR_NA; + ret = serial->lib_funcs->set_params(serial, + baudrate, bits, parity, stopbits, + flowcontrol, rts, dtr); if (ret == SR_OK) { serial->comm_params.bit_rate = baudrate; serial->comm_params.data_bits = bits; @@ -461,7 +656,7 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, return SR_ERR; } - if (!serial->sp_data) { + if (!dev_is_supported(serial)) { sr_dbg("Cannot use unopened serial port %s.", serial->port); return -1; } @@ -644,12 +839,15 @@ SR_PRIV int serial_source_add(struct sr_session *session, return SR_ERR_ARG; } - if (!serial->sp_data) { + if (!dev_is_supported(serial)) { sr_err("Invalid serial port."); return SR_ERR_ARG; } - return sr_ser_libsp_source_add(session, serial, + if (!serial->lib_funcs || !serial->lib_funcs->setup_source_add) + return SR_ERR_NA; + + return serial->lib_funcs->setup_source_add(session, serial, events, timeout, cb, cb_data); } @@ -657,12 +855,15 @@ SR_PRIV int serial_source_add(struct sr_session *session, SR_PRIV int serial_source_remove(struct sr_session *session, struct sr_serial_dev_inst *serial) { - if (!serial->sp_data) { + if (!dev_is_supported(serial)) { sr_err("Invalid serial port."); return SR_ERR_ARG; } - return sr_ser_libsp_source_remove(session, serial); + if (!serial->lib_funcs || !serial->lib_funcs->setup_source_remove) + return SR_ERR_NA; + + return serial->lib_funcs->setup_source_remove(session, serial); } /** @@ -719,12 +920,16 @@ static GSList *append_port_list(GSList *devs, const char *name, const char *desc SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver) { GSList *tty_devs; + GSList *(*list_func)(GSList *list, sr_ser_list_append_t append); /* Currently unused, but will be used by some drivers later on. */ (void)driver; tty_devs = NULL; - tty_devs = sr_ser_libsp_list(tty_devs, append_port_list); + if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->list) { + list_func = ser_lib_funcs_libsp->list; + tty_devs = list_func(tty_devs, append_port_list); + } return tty_devs; } @@ -752,10 +957,15 @@ static GSList *append_port_find(GSList *devs, const char *name) SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id) { GSList *tty_devs; + GSList *(*find_func)(GSList *list, sr_ser_find_append_t append, + uint16_t vid, uint16_t pid); tty_devs = NULL; - tty_devs = sr_ser_libsp_find_usb(tty_devs, append_port_find, - vendor_id, product_id); + if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->find_usb) { + find_func = ser_lib_funcs_libsp->find_usb; + tty_devs = find_func(tty_devs, append_port_find, + vendor_id, product_id); + } return tty_devs; } @@ -769,10 +979,11 @@ SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes) /* Get the bitrate and frame length. */ bits = baud = 0; - ret = sr_ser_libsp_get_frame_format(port, &baud, &bits); - if (ret != SR_OK) - bits = baud = 0; - if (!bits || !baud) { + if (port->lib_funcs && port->lib_funcs->get_frame_format) { + ret = port->lib_funcs->get_frame_format(port, &baud, &bits); + if (ret != SR_OK) + bits = baud = 0; + } else { baud = port->comm_params.bit_rate; bits = 1 + port->comm_params.data_bits + port->comm_params.parity_bits + @@ -790,4 +1001,10 @@ SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes) return timeout_ms; } +#else + +/* TODO Put fallback.c content here? */ + +#endif + /** @} */