Convert our custom IO model to new libdivecomputer IO model

This converts our old custom IO model to the new model that
libdivecomputer introduced.  This is partly based on Jef's rough patch
to make things build, with further work by me.

The FTDI code is temporarily disabled here, because it will need to be
integrated with the new way of opening devices.

The ble_serial code goes away entirely, since now libdivecomputer knows
about BLE transport natively, and doesn't need to have any serial
wrapper around it.

Signed-off-by: Jef Driesen <jef@libdivecomputer.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Linus Torvalds 2018-04-16 18:14:59 -07:00 committed by Dirk Hohndel
parent c07faa90f3
commit 13f5c75ac4
9 changed files with 169 additions and 374 deletions

View file

@ -9,8 +9,7 @@
#include <libdivecomputer/version.h>
#include <libdivecomputer/context.h>
#if defined(SSRF_CUSTOM_IO)
#include <libdivecomputer/custom.h>
#if defined(Q_OS_WIN)
#include <winsock2.h>
@ -18,8 +17,6 @@
#include <ws2bth.h>
#endif
#include <libdivecomputer/custom_io.h>
#ifdef BLE_SUPPORT
# include "qt-ble.h"
#endif
@ -46,195 +43,8 @@ typedef struct qt_serial_t {
#ifdef BLE_SUPPORT
static dc_status_t ble_serial_open(dc_custom_io_t *io, dc_context_t *, const char* devaddr);
static dc_status_t ble_serial_close(dc_custom_io_t *io);
static dc_status_t ble_serial_read(dc_custom_io_t *io, void* data, size_t size, size_t *actual);
static dc_status_t ble_serial_write(dc_custom_io_t *io, const void* data, size_t size, size_t *actual);
static dc_status_t ble_serial_purge(dc_custom_io_t *io, dc_direction_t queue);
static dc_status_t ble_serial_get_available(dc_custom_io_t *io, size_t *available);
static dc_status_t ble_serial_set_timeout(dc_custom_io_t *io, long timeout);
static dc_custom_io_t ble_serial_ops = {
.userdata = NULL,
.user_device = NULL,
.serial_open = ble_serial_open,
.serial_close = ble_serial_close,
.serial_read = ble_serial_read,
.serial_write = ble_serial_write,
.serial_purge = ble_serial_purge,
.serial_get_available = ble_serial_get_available,
.serial_set_timeout = ble_serial_set_timeout,
// These doesn't make sense over bluetooth
// NULL means NOP
.serial_configure = NULL,
.serial_set_dtr = NULL,
.serial_set_rts = NULL,
.serial_set_break = NULL,
.packet_size = 20,
.packet_open = qt_ble_open,
.packet_close = qt_ble_close,
.packet_read = qt_ble_read,
.packet_write = qt_ble_write,
};
static dc_status_t ble_serial_open(dc_custom_io_t *io, dc_context_t *context, const char* devaddr)
static dc_status_t qt_serial_open(qt_serial_t **io, dc_context_t *context, const char* devaddr)
{
dc_context_set_custom_io(context, &ble_serial_ops, io->user_device);
return qt_ble_open(&ble_serial_ops, context, devaddr);
}
#define BT_BLE_BUFSIZE 4096
static struct {
unsigned int out_bytes, in_bytes, in_pos;
unsigned char in[BT_BLE_BUFSIZE];
unsigned char out[BT_BLE_BUFSIZE];
} buffer;
static dc_status_t ble_serial_flush_write(void)
{
int bytes = buffer.out_bytes;
if (!bytes)
return DC_STATUS_SUCCESS;
buffer.out_bytes = 0;
return ble_serial_ops.packet_write(&ble_serial_ops, buffer.out, bytes, NULL);
}
static dc_status_t ble_serial_flush_read(void)
{
buffer.in_bytes = buffer.in_pos = 0;
return DC_STATUS_SUCCESS;
}
static dc_status_t ble_serial_close(dc_custom_io_t *io)
{
ble_serial_flush_write();
io->userdata = NULL;
return qt_ble_close(&ble_serial_ops);
}
static dc_status_t ble_serial_read(dc_custom_io_t *io, void* data, size_t size, size_t *actual)
{
Q_UNUSED(io)
size_t len;
size_t received = 0;
if (buffer.in_pos >= buffer.in_bytes) {
ble_serial_flush_write();
}
/* There is still unused/unread data in the input steam.
* So preseve it at the start of a new read.
*/
if (buffer.in_pos > 0) {
len = buffer.in_bytes - buffer.in_pos;
memcpy(buffer.in, buffer.in + buffer.in_pos, len);
buffer.in_pos = 0;
buffer.in_bytes = len;
}
/* Read a long as requested in the size parameter */
while ((buffer.in_bytes - buffer.in_pos) < size) {
dc_status_t rc;
rc = ble_serial_ops.packet_read(&ble_serial_ops, buffer.in + buffer.in_bytes,
sizeof(buffer.in) - buffer.in_bytes, &received);
if (rc != DC_STATUS_SUCCESS)
return rc;
if (!received)
return DC_STATUS_IO;
buffer.in_bytes += received;
}
len = buffer.in_bytes - buffer.in_pos;
if (len > size)
len = size;
memcpy(data, buffer.in + buffer.in_pos, len);
buffer.in_pos += len;
if (actual)
*actual = len;
return DC_STATUS_SUCCESS;
}
static dc_status_t ble_serial_write(dc_custom_io_t *io, const void* data, size_t size, size_t *actual)
{
Q_UNUSED(io)
dc_status_t rc = DC_STATUS_SUCCESS;
size_t transferred = 0;
ble_serial_flush_read();
/*
* Most writes to a connected DC are small, typically some command bytes to get
* DC in download mode, or to set some parameter. All this just worked over BLE,
* however, sending a full firmware update (on an OSTC device) failed, as the
* underlying BLE interface can only handle small 20 byte BLE packets at once.
*
* So, send max ble->packet_size chuncks at once.
*/
while (size) {
size_t len = sizeof(buffer.out) - transferred;
if ((int)len > io->packet_size)
len = io->packet_size;
if (len > size)
len = size;
memcpy(buffer.out + buffer.out_bytes, data, len);
buffer.out_bytes += len;
if ((int)buffer.out_bytes <= io->packet_size || buffer.out_bytes == size) {
rc = ble_serial_flush_write();
if (rc != DC_STATUS_SUCCESS)
break;
}
transferred += len;
data = (const void *) (len + (const char *)data);
size -= len;
}
if (actual)
*actual = transferred;
return DC_STATUS_SUCCESS;
}
static dc_status_t ble_serial_purge(dc_custom_io_t *io, dc_direction_t queue)
{
Q_UNUSED(io)
Q_UNUSED(queue)
/* Do we care? */
return DC_STATUS_SUCCESS;
}
static dc_status_t ble_serial_get_available(dc_custom_io_t *io, size_t *available)
{
Q_UNUSED(io)
*available = buffer.in_bytes - buffer.in_pos;
return DC_STATUS_SUCCESS;
}
static dc_status_t ble_serial_set_timeout(dc_custom_io_t *io, long timeout)
{
Q_UNUSED(io)
Q_UNUSED(timeout)
/* Do we care? */
return DC_STATUS_SUCCESS;
}
#endif
static dc_status_t qt_serial_open(dc_custom_io_t *io, dc_context_t *context, const char* devaddr)
{
#ifdef BLE_SUPPORT
if (!strncmp(devaddr, "LE:", 3))
return ble_serial_open(io, context, devaddr);
#endif
// Allocate memory.
qt_serial_t *serial_port = (qt_serial_t *) malloc (sizeof (qt_serial_t));
if (serial_port == NULL) {
@ -377,14 +187,15 @@ static dc_status_t qt_serial_open(dc_custom_io_t *io, dc_context_t *context, con
}
}
#endif
io->userdata = serial_port;
*io = serial_port;
return DC_STATUS_SUCCESS;
}
static dc_status_t qt_serial_close(dc_custom_io_t *io)
static dc_status_t qt_serial_close(void *io)
{
qt_serial_t *device = (qt_serial_t*) io->userdata;
qt_serial_t *device = (qt_serial_t*) io;
if (device == NULL)
return DC_STATUS_SUCCESS;
@ -405,14 +216,12 @@ static dc_status_t qt_serial_close(dc_custom_io_t *io)
free(device);
#endif
io->userdata = NULL;
return DC_STATUS_SUCCESS;
}
static dc_status_t qt_serial_read(dc_custom_io_t *io, void* data, size_t size, size_t *actual)
static dc_status_t qt_serial_read(void *io, void* data, size_t size, size_t *actual)
{
qt_serial_t *device = (qt_serial_t*) io->userdata;
qt_serial_t *device = (qt_serial_t*) io;
#if defined(Q_OS_WIN)
if (device == NULL)
@ -471,9 +280,9 @@ static dc_status_t qt_serial_read(dc_custom_io_t *io, void* data, size_t size, s
return DC_STATUS_SUCCESS;
}
static dc_status_t qt_serial_write(dc_custom_io_t *io, const void* data, size_t size, size_t *actual)
static dc_status_t qt_serial_write(void *io, const void* data, size_t size, size_t *actual)
{
qt_serial_t *device = (qt_serial_t*) io->userdata;
qt_serial_t *device = (qt_serial_t*) io;
#if defined(Q_OS_WIN)
if (device == NULL)
@ -520,9 +329,9 @@ static dc_status_t qt_serial_write(dc_custom_io_t *io, const void* data, size_t
return DC_STATUS_SUCCESS;
}
static dc_status_t qt_serial_purge(dc_custom_io_t *io, dc_direction_t queue)
static dc_status_t qt_serial_purge(void *io, dc_direction_t queue)
{
qt_serial_t *device = (qt_serial_t*) io->userdata;
qt_serial_t *device = (qt_serial_t*) io;
(void)queue;
if (device == NULL)
@ -536,9 +345,9 @@ static dc_status_t qt_serial_purge(dc_custom_io_t *io, dc_direction_t queue)
return DC_STATUS_SUCCESS;
}
static dc_status_t qt_serial_get_available(dc_custom_io_t *io, size_t *available)
static dc_status_t qt_serial_get_available(void *io, size_t *available)
{
qt_serial_t *device = (qt_serial_t*) io->userdata;
qt_serial_t *device = (qt_serial_t*) io;
#if defined(Q_OS_WIN)
if (device == NULL)
@ -577,9 +386,9 @@ static int qt_serial_get_transmitted(qt_serial_t *device)
#endif
}
static dc_status_t qt_serial_set_timeout(dc_custom_io_t *io, long timeout)
static dc_status_t qt_serial_set_timeout(void *io, int timeout)
{
qt_serial_t *device = (qt_serial_t*) io->userdata;
qt_serial_t *device = (qt_serial_t*) io;
if (device == NULL)
return DC_STATUS_INVALIDARGS;
@ -589,35 +398,68 @@ static dc_status_t qt_serial_set_timeout(dc_custom_io_t *io, long timeout)
return DC_STATUS_SUCCESS;
}
dc_custom_io_t qt_serial_ops = {
.userdata = NULL,
.user_device = NULL,
.serial_open = qt_serial_open,
.serial_close = qt_serial_close,
.serial_read = qt_serial_read,
.serial_write = qt_serial_write,
.serial_purge = qt_serial_purge,
.serial_get_available = qt_serial_get_available,
.serial_set_timeout = qt_serial_set_timeout,
// These doesn't make sense over bluetooth
// NULL means NOP
.serial_configure = NULL,
.serial_set_dtr = NULL,
.serial_set_rts = NULL,
.serial_set_break = NULL,
#ifdef BLE_SUPPORT
.packet_size = 20,
.packet_open = qt_ble_open,
.packet_close = qt_ble_close,
.packet_read = qt_ble_read,
.packet_write = qt_ble_write,
#endif
};
dc_custom_io_t* get_qt_serial_ops() {
return (dc_custom_io_t*) &qt_serial_ops;
dc_status_t
ble_packet_open(dc_iostream_t **iostream, dc_context_t *context, const char* devaddr, void *userdata)
{
dc_status_t rc = DC_STATUS_SUCCESS;
void *io = NULL;
static const dc_custom_cbs_t callbacks = {
NULL, /* set_timeout */
NULL, /* set_latency */
NULL, /* set_break */
NULL, /* set_dtr */
NULL, /* set_rts */
NULL, /* get_lines */
NULL, /* get_received */
NULL, /* configure */
qt_ble_read, /* read */
qt_ble_write, /* write */
NULL, /* flush */
NULL, /* purge */
NULL, /* sleep */
qt_ble_close, /* close */
};
rc = qt_ble_open(&io, context, devaddr, (dc_user_device_t *) userdata);
if (rc != DC_STATUS_SUCCESS) {
return rc;
}
return dc_custom_open (iostream, context, DC_TRANSPORT_BLE, &callbacks, io);
}
dc_status_t
rfcomm_stream_open(dc_iostream_t **iostream, dc_context_t *context, const char* devaddr)
{
dc_status_t rc = DC_STATUS_SUCCESS;
qt_serial_t *io = NULL;
static const dc_custom_cbs_t callbacks = {
qt_serial_set_timeout, /* set_timeout */
NULL, /* set_latency */
NULL, /* set_break */
NULL, /* set_dtr */
NULL, /* set_rts */
NULL, /* get_lines */
qt_serial_get_available, /* get_received */
NULL, /* configure */
qt_serial_read, /* read */
qt_serial_write, /* write */
NULL, /* flush */
qt_serial_purge, /* purge */
NULL, /* sleep */
qt_serial_close, /* close */
};
rc = qt_serial_open(&io, context, devaddr);
if (rc != DC_STATUS_SUCCESS) {
return rc;
}
return dc_custom_open (iostream, context, DC_TRANSPORT_BLUETOOTH, &callbacks, io);
}
}
#endif