#include <glib.h>
#include <glib/gstdio.h>
#include <libserialport.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
+/** @cond PRIVATE */
#define LOG_PREFIX "serial"
+/** @endcond */
+
+/**
+ * @file
+ *
+ * Serial port handling.
+ */
+
+/**
+ * @defgroup grp_serial Serial port handling
+ *
+ * Serial port handling functions.
+ *
+ * @{
+ */
/**
* Open the specified serial port.
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
{
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
{
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
{
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
{
* @retval SR_ERR Other error.
* @retval other The number of bytes written. If this is less than the number
* specified in the call, the timeout was reached.
+ *
+ * @private
*/
SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
const void *buf, size_t count, unsigned int timeout_ms)
* @retval SR_ERR_ARG Invalid argument.
* @retval SR_ERR Other error.
* @retval other The number of bytes written.
-*/
+ *
+ * @private
+ */
SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
const void *buf, size_t count)
{
* @retval SR_ERR Other error.
* @retval other The number of bytes read. If this is less than the number
* requested, the timeout was reached.
+ *
+ * @private
*/
SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
size_t count, unsigned int timeout_ms)
* @retval SR_ERR_ARG Invalid argument.
* @retval SR_ERR Other error.
* @retval other The number of bytes read.
+ *
+ * @private
*/
SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
size_t count)
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
int bits, int parity, int stopbits,
* rts=0|1 Set RTS off resp. on.\n
* Please note that values and combinations of these parameters must be
* supported by the concrete serial interface hardware and the drivers for it.
+ *
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
const char *paramstr)
{
+/** @cond PRIVATE */
#define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
+/** @endcond */
GRegex *reg;
GMatchInfo *match;
*
* @retval SR_OK Success.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
int *buflen, gint64 timeout_ms)
maxlen = *buflen;
*buflen = len = 0;
- while(1) {
+ while (1) {
len = maxlen - *buflen - 1;
if (len < 1)
break;
*
* @retval SR_OK Valid packet was found within the given timeout.
* @retval SR_ERR Failure.
+ *
+ * @private
*/
SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
uint8_t *buf, size_t *buflen,
}
/* Assume 8n1 transmission. That is 10 bits for every byte. */
- byte_delay_us = 10 * (1000000 / baudrate);
+ byte_delay_us = 10 * ((1000 * 1000) / baudrate);
start = g_get_monotonic_time();
i = ibuf = len = 0;
* Extract the serial device and options from the options linked list.
*
* @param options List of options passed from the command line.
- * @param serial_device Pointer where to store the exctracted serial device.
+ * @param serial_device Pointer where to store the extracted serial device.
* @param serial_options Pointer where to store the optional extracted serial
* options.
*
* @return SR_OK if a serial_device is found, SR_ERR if no device is found. The
* returned string should not be freed by the caller.
+ *
+ * @private
*/
SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
const char **serial_options)
switch (src->key) {
case SR_CONF_CONN:
*serial_device = g_variant_get_string(src->data, NULL);
- sr_dbg("Parsed serial device: %s", *serial_device);
+ sr_dbg("Parsed serial device: %s.", *serial_device);
break;
-
case SR_CONF_SERIALCOMM:
*serial_options = g_variant_get_string(src->data, NULL);
- sr_dbg("Parsed serial options: %s", *serial_options);
+ sr_dbg("Parsed serial options: %s.", *serial_options);
break;
}
}
if (!*serial_device) {
- sr_dbg("No serial device specified");
+ sr_dbg("No serial device specified.");
return SR_ERR;
}
return SR_OK;
}
+/** @cond PRIVATE */
#ifdef _WIN32
typedef HANDLE event_handle;
#else
typedef int event_handle;
#endif
+/** @endcond */
+/** @private */
SR_PRIV int serial_source_add(struct sr_session *session,
struct sr_serial_dev_inst *serial, int events, int timeout,
sr_receive_data_callback cb, void *cb_data)
return SR_OK;
}
+/** @private */
SR_PRIV int serial_source_remove(struct sr_session *session,
struct sr_serial_dev_inst *serial)
{
unsigned int i;
+ if (!serial->event_set)
+ return SR_OK;
+
for (i = 0; i < serial->event_set->count; i++)
if (sr_session_source_remove_pollfd(session, &serial->pollfds[i]) != SR_OK)
return SR_ERR;
return SR_OK;
}
+/**
+ * Create/allocate a new sr_serial_port structure.
+ *
+ * @param name The OS dependent name of the serial port. Must not be NULL.
+ * @param description An end user friendly description for the serial port.
+ * Can be NULL (in that case the empty string is used
+ * as description).
+ *
+ * @return The newly allocated sr_serial_port struct.
+ */
static struct sr_serial_port *sr_serial_new(const char *name,
const char *description)
{
if (!name)
return NULL;
- serial = g_malloc(sizeof(*serial));
+ serial = g_malloc(sizeof(struct sr_serial_port));
serial->name = g_strdup(name);
serial->description = g_strdup(description ? description : "");
+
return serial;
}
+/**
+ * Free a previously allocated sr_serial_port structure.
+ *
+ * @param serial The sr_serial_port struct to free. Must not be NULL.
+ */
SR_API void sr_serial_free(struct sr_serial_port *serial)
{
- if (serial == NULL)
+ if (!serial)
return;
g_free(serial->name);
g_free(serial->description);
{
GSList *tty_devs = NULL;
struct sp_port **ports;
+ struct sr_serial_port *port;
int i;
+ /* Currently unused, but will be used by some drivers later on. */
(void)driver;
if (sp_list_ports(&ports) != SP_OK)
return NULL;
- for (i=0; ports[i]; i++) {
- struct sr_serial_port *port = sr_serial_new(sp_get_port_name(ports[i]),
- sp_get_port_description(ports[i]));
+ for (i = 0; ports[i]; i++) {
+ port = sr_serial_new(sp_get_port_name(ports[i]),
+ sp_get_port_description(ports[i]));
tty_devs = g_slist_append(tty_devs, port);
}
sp_free_port_list(ports);
+
return tty_devs;
}
* @return A GSList of strings containing the path of the serial device or
* NULL if no serial device is found. The returned list must be freed
* by the caller.
+ *
+ * @private
*/
SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
{
if (sp_list_ports(&ports) != SP_OK)
return NULL;
- for (i=0; ports[i]; i++)
+ for (i = 0; ports[i]; i++)
if (sp_get_port_transport(ports[i]) == SP_TRANSPORT_USB &&
sp_get_port_usb_vid_pid(ports[i], &vid, &pid) == SP_OK &&
- vid == vendor_id && pid == product_id)
+ vid == vendor_id && pid == product_id) {
tty_devs = g_slist_prepend(tty_devs,
- g_strdup(sp_get_port_name(ports[i])));
+ g_strdup(sp_get_port_name(ports[i])));
+ }
sp_free_port_list(ports);
+
return tty_devs;
}
+/** @private */
SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
{
struct sp_port_config *config;
return timeout_ms;
}
+
+/** @} */
projects / libsigrok.git / blobdiff