Add support for the Seac Tablet

The Seac Tablet uses almost the same protocol as the Seac Screen and
Action, but with a few small differences:

 - A slightly different set of commands, but with exactly the same
   functionality.
 - The new variant of the READ command does no longer pad the response
   packet to 2048 bytes.
 - The profile area starts at address 0x0A0000 instead of 0x010000.

The Seac Tablet also support tank pressure transmitters.

Author: jefdriesen

src/descriptor.c

@@ -484,6 +484,7 @@ static const dc_descriptor_t g_descriptors[] = {
 	/* Seac Screen */
 	{"Seac", "Action", DC_FAMILY_SEAC_SCREEN, 0x01, DC_TRANSPORT_SERIAL, NULL},
 	{"Seac", "Screen", DC_FAMILY_SEAC_SCREEN, 0x02, DC_TRANSPORT_SERIAL, NULL},
+	{"Seac", "Tablet", DC_FAMILY_SEAC_SCREEN, 0x10, DC_TRANSPORT_SERIAL, NULL},
 	/* Deepblu Cosmiq */
 	{"Deepblu", "Cosmiq+", DC_FAMILY_DEEPBLU_COSMIQ, 0, DC_TRANSPORT_BLE, dc_filter_deepblu},
 	/* Oceans S1 */

src/halcyon_symbios_parser.c

@@ -80,7 +80,7 @@ typedef struct halcyon_symbios_tank_t {
 	unsigned int beginpressure;
 	unsigned int endpressure;
 	unsigned int gasmix;
-	dc_usage_t usage;
+	dc_tank_usage_t usage;
 } halcyon_symbios_tank_t;
 
 typedef struct halcyon_symbios_parser_t {
@@ -156,7 +156,7 @@ halcyon_symbios_parser_create (dc_parser_t **out, dc_context_t *context, const u
 		parser->tank[i].beginpressure = 0;
 		parser->tank[i].endpressure = 0;
 		parser->tank[i].gasmix = DC_GASMIX_UNKNOWN;
-		parser->tank[i].usage = DC_USAGE_NONE;
+		parser->tank[i].usage = DC_TANK_USAGE_NONE;
 	}
 
 	*out = (dc_parser_t *) parser;
@@ -440,7 +440,7 @@ halcyon_symbios_parser_samples_foreach (dc_parser_t *abstract, dc_sample_callbac
 			unsigned int DC_ATTR_UNUSED battery = array_uint16_le (data + offset + 4);
 			unsigned int pressure = array_uint16_le (data + offset + 6);
 			unsigned int transmitter = array_uint16_le (data + offset + 8);
-			dc_usage_t usage = DC_USAGE_NONE;
+			dc_tank_usage_t usage = DC_TANK_USAGE_NONE;
 
 			if (have_gasmix && gasmix_id_previous != gas_id) {
 				unsigned int idx = 0;
@@ -561,7 +561,7 @@ halcyon_symbios_parser_samples_foreach (dc_parser_t *abstract, dc_sample_callbac
 			}
 			unsigned int pressure = array_uint16_le (data + offset + 8);
 			unsigned int serial   = array_uint16_le (data + offset + 10);
-			dc_usage_t usage = DC_USAGE_OXYGEN;
+			dc_tank_usage_t usage = DC_TANK_USAGE_NONE;
 
 			if (tank_id_previous != serial ||
 				tank_usage_previous != usage) {
@@ -642,7 +642,7 @@ halcyon_symbios_parser_samples_foreach (dc_parser_t *abstract, dc_sample_callbac
 			unsigned int id = data[offset + 2] | TRANSMITTER_ID;
 			unsigned int DC_ATTR_UNUSED battery = array_uint16_le (data + offset + 4);
 			unsigned int pressure = array_uint16_le (data + offset + 6) / 10;
-			dc_usage_t usage = DC_USAGE_NONE;
+			dc_tank_usage_t usage = DC_TANK_USAGE_NONE;
 
 			if (tank_id_previous != id ||
 				tank_usage_previous != usage) {

src/parser.c

@@ -198,7 +198,7 @@ dc_parser_new_internal (dc_parser_t **out, dc_context_t *context, const unsigned
 		rc = deepsix_excursion_parser_create (&parser, context, data, size);
 		break;
 	case DC_FAMILY_SEAC_SCREEN:
-		rc = seac_screen_parser_create (&parser, context, data, size);
+		rc = seac_screen_parser_create (&parser, context, data, size, model);
 		break;
 	case DC_FAMILY_DEEPBLU_COSMIQ:
 		rc = deepblu_cosmiq_parser_create (&parser, context, data, size);

src/seac_screen.c

@@ -49,9 +49,16 @@
 
 #define CMD_HWINFO  0x1833
 #define CMD_SWINFO  0x1834
-#define CMD_RANGE   0x1840
-#define CMD_ADDRESS 0x1841
-#define CMD_READ    0x1842
+
+// Screen
+#define CMD_SCREEN_RANGE   0x1840
+#define CMD_SCREEN_ADDRESS 0x1841
+#define CMD_SCREEN_READ    0x1842
+
+// Tablet
+#define CMD_TABLET_RANGE   0x1850
+#define CMD_TABLET_ADDRESS 0x1851
+#define CMD_TABLET_READ    0x1852
 
 #define SZ_HWINFO  256
 #define SZ_SWINFO  256
@@ -65,15 +72,29 @@
 #define FP_OFFSET   0x0A
 #define FP_SIZE     7
 
-#define RB_PROFILE_BEGIN         0x010000
-#define RB_PROFILE_END           0x200000
-#define RB_PROFILE_SIZE          (RB_PROFILE_END - RB_PROFILE_BEGIN)
-#define RB_PROFILE_DISTANCE(a,b) ringbuffer_distance (a, b, DC_RINGBUFFER_FULL, RB_PROFILE_BEGIN, RB_PROFILE_END)
-#define RB_PROFILE_INCR(a,d)     ringbuffer_increment (a, d, RB_PROFILE_BEGIN, RB_PROFILE_END)
+#define RB_PROFILE_DISTANCE(a,b,l) ringbuffer_distance (a, b, DC_RINGBUFFER_FULL, l->rb_profile_begin, l->rb_profile_end)
+#define RB_PROFILE_INCR(a,b,l)     ringbuffer_increment (a, b, l->rb_profile_begin, l->rb_profile_end)
+
+#define ACTION 0x01
+#define SCREEN 0x02
+#define TABLET 0x10
+
+typedef struct seac_screen_commands_t {
+	unsigned short range;
+	unsigned short address;
+	unsigned short read;
+} seac_screen_commands_t;
+
+typedef struct seac_screen_layout_t {
+	unsigned int rb_profile_begin;
+	unsigned int rb_profile_end;
+} seac_screen_layout_t;
 
 typedef struct seac_screen_device_t {
 	dc_device_t base;
 	dc_iostream_t *iostream;
+	const seac_screen_commands_t *cmds;
+	const seac_screen_layout_t *layout;
 	unsigned char info[SZ_HWINFO + SZ_SWINFO];
 	unsigned char fingerprint[FP_SIZE];
 } seac_screen_device_t;
@@ -100,6 +121,28 @@ static const dc_device_vtable_t seac_screen_device_vtable = {
 	NULL, /* close */
 };
 
+static const seac_screen_commands_t cmds_screen = {
+	CMD_SCREEN_RANGE,
+	CMD_SCREEN_ADDRESS,
+	CMD_SCREEN_READ,
+};
+
+static const seac_screen_commands_t cmds_tablet = {
+	CMD_TABLET_RANGE,
+	CMD_TABLET_ADDRESS,
+	CMD_TABLET_READ,
+};
+
+static const seac_screen_layout_t layout_screen = {
+	0x010000, /* rb_profile_begin */
+	0x200000, /* rb_profile_end */
+};
+
+static const seac_screen_layout_t layout_tablet = {
+	0x0A0000, /* rb_profile_begin */
+	0x200000, /* rb_profile_end */
+};
+
 static dc_status_t
 seac_screen_send (seac_screen_device_t *device, unsigned short cmd, const unsigned char data[], size_t size)
 {
@@ -284,6 +327,8 @@ seac_screen_device_open (dc_device_t **out, dc_context_t *context, dc_iostream_t
 
 	// Set the default values.
 	device->iostream = iostream;
+	device->cmds = NULL;
+	device->layout = NULL;
 	memset (device->info, 0, sizeof (device->info));
 	memset (device->fingerprint, 0, sizeof (device->fingerprint));
 
@@ -327,6 +372,15 @@ seac_screen_device_open (dc_device_t **out, dc_context_t *context, dc_iostream_t
 
 	HEXDUMP (context, DC_LOGLEVEL_DEBUG, "Software", device->info + SZ_HWINFO, SZ_SWINFO);
 
+	unsigned int model = array_uint32_le (device->info + 4);
+	if (model == TABLET) {
+		device->cmds = &cmds_tablet;
+		device->layout = &layout_tablet;
+	} else {
+		device->cmds = &cmds_screen;
+		device->layout = &layout_screen;
+	}
+
 	*out = (dc_device_t *) device;
 
 	return DC_STATUS_SUCCESS;
@@ -379,7 +433,8 @@ seac_screen_device_read (dc_device_t *abstract, unsigned int address, unsigned c
 			(len      ) & 0xFF,
 		};
 		unsigned char packet[SZ_READ] = {0};
-		status = seac_screen_transfer (device, CMD_READ, params, sizeof(params), packet, sizeof(packet));
+		const unsigned int packetsize = device->cmds->read == CMD_TABLET_READ ? len : sizeof(packet);
+		status = seac_screen_transfer (device, device->cmds->read, params, sizeof(params), packet, packetsize);
 		if (status != DC_STATUS_SUCCESS) {
 			ERROR (abstract->context, "Failed to send the read command.");
 			return status;
@@ -400,11 +455,16 @@ static dc_status_t
 seac_screen_device_dump (dc_device_t *abstract, dc_buffer_t *buffer)
 {
 	seac_screen_device_t *device = (seac_screen_device_t *) abstract;
+	const seac_screen_layout_t *layout = device->layout;
 
 	// Emit a device info event.
 	dc_event_devinfo_t devinfo;
 	devinfo.model = array_uint32_le (device->info + 4);
-	devinfo.firmware = array_uint32_le (device->info + 0x11C);
+	if (devinfo.model == TABLET) {
+		devinfo.firmware = array_uint32_le (device->info + 0x114);
+	} else {
+		devinfo.firmware = array_uint32_le (device->info + 0x11C);
+	}
 	devinfo.serial = array_uint32_le (device->info + 0x10);
 	device_event_emit (abstract, DC_EVENT_DEVINFO, &devinfo);
 
@@ -415,12 +475,12 @@ seac_screen_device_dump (dc_device_t *abstract, dc_buffer_t *buffer)
 	device_event_emit (abstract, DC_EVENT_VENDOR, &vendor);
 
 	// Allocate the required amount of memory.
-	if (!dc_buffer_resize (buffer, RB_PROFILE_SIZE)) {
+	if (!dc_buffer_resize (buffer, layout->rb_profile_end - layout->rb_profile_begin)) {
 		ERROR (abstract->context, "Insufficient buffer space available.");
 		return DC_STATUS_NOMEMORY;
 	}
 
-	return device_dump_read (abstract, RB_PROFILE_BEGIN, dc_buffer_get_data (buffer),
+	return device_dump_read (abstract, layout->rb_profile_begin, dc_buffer_get_data (buffer),
 		dc_buffer_get_size (buffer), SZ_READ);
 }
 
@@ -429,16 +489,21 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 {
 	dc_status_t status = DC_STATUS_SUCCESS;
 	seac_screen_device_t *device = (seac_screen_device_t *) abstract;
+	const seac_screen_layout_t *layout = device->layout;
 
 	// Enable progress notifications.
 	dc_event_progress_t progress = EVENT_PROGRESS_INITIALIZER;
-	progress.maximum = RB_PROFILE_SIZE;
+	progress.maximum = layout->rb_profile_end - layout->rb_profile_begin;
 	device_event_emit (abstract, DC_EVENT_PROGRESS, &progress);
 
 	// Emit a device info event.
 	dc_event_devinfo_t devinfo;
 	devinfo.model = array_uint32_le (device->info + 4);
-	devinfo.firmware = array_uint32_le (device->info + 0x11C);
+	if (devinfo.model == TABLET) {
+		devinfo.firmware = array_uint32_le (device->info + 0x114);
+	} else {
+		devinfo.firmware = array_uint32_le (device->info + 0x11C);
+	}
 	devinfo.serial = array_uint32_le (device->info + 0x010);
 	device_event_emit (abstract, DC_EVENT_DEVINFO, &devinfo);
 
@@ -450,7 +515,7 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 
 	// Read the range of the available dive numbers.
 	unsigned char range[SZ_RANGE] = {0};
-	status = seac_screen_transfer (device, CMD_RANGE, NULL, 0, range, sizeof(range));
+	status = seac_screen_transfer (device, device->cmds->range, NULL, 0, range, sizeof(range));
 	if (status != DC_STATUS_SUCCESS) {
 		ERROR (abstract->context, "Failed to send the range command.");
 		goto error_exit;
@@ -486,7 +551,7 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 	unsigned int count = 0;
 	unsigned int skip = 0;
 	unsigned int rb_profile_size = 0;
-	unsigned int remaining = RB_PROFILE_SIZE;
+	unsigned int remaining = layout->rb_profile_end - layout->rb_profile_begin;
 	for (unsigned int i = 0; i < ndives; ++i) {
 		unsigned int number = last - i;
 
@@ -498,15 +563,15 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 			(number      ) & 0xFF,
 		};
 		unsigned char rsp_address[SZ_ADDRESS] = {0};
-		status = seac_screen_transfer (device, CMD_ADDRESS, cmd_address, sizeof(cmd_address), rsp_address, sizeof(rsp_address));
+		status = seac_screen_transfer (device, device->cmds->address, cmd_address, sizeof(cmd_address), rsp_address, sizeof(rsp_address));
 		if (status != DC_STATUS_SUCCESS) {
 			ERROR (abstract->context, "Failed to read the dive address.");
 			goto error_free_logbook;
 		}
 
 		// Get the dive address.
 		logbook[i].address = array_uint32_be (rsp_address);
-		if (logbook[i].address < RB_PROFILE_BEGIN || logbook[i].address >= RB_PROFILE_END) {
+		if (logbook[i].address < layout->rb_profile_begin || logbook[i].address >= layout->rb_profile_end) {
 			ERROR (abstract->context, "Invalid ringbuffer pointer (0x%08x).", logbook[i].address);
 			status = DC_STATUS_DATAFORMAT;
 			goto error_free_logbook;
@@ -543,11 +608,11 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 
 		// Get the end-of-profile pointer.
 		if (eop == 0) {
-			eop = previous = RB_PROFILE_INCR (logbook[i].address, nbytes);
+			eop = previous = RB_PROFILE_INCR (logbook[i].address, nbytes, layout);
 		}
 
 		// Calculate the length.
-		unsigned int length = RB_PROFILE_DISTANCE (logbook[i].address, previous);
+		unsigned int length = RB_PROFILE_DISTANCE (logbook[i].address, previous, layout);
 
 		// Check for the end of the ringbuffer.
 		if (length > remaining) {
@@ -567,7 +632,7 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 
 	// Update and emit a progress event.
 	progress.maximum -= (ndives - count - skip) * (SZ_ADDRESS + SZ_HEADER) +
-		(RB_PROFILE_SIZE - rb_profile_size);
+		((layout->rb_profile_end - layout->rb_profile_begin) - rb_profile_size);
 	device_event_emit (abstract, DC_EVENT_PROGRESS, &progress);
 
 	// Exit if no dives to download.
@@ -584,7 +649,7 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 
 	// Create the ringbuffer stream.
 	dc_rbstream_t *rbstream = NULL;
-	status = dc_rbstream_new (&rbstream, abstract, SZ_READ, SZ_READ, RB_PROFILE_BEGIN, RB_PROFILE_END, eop, DC_RBSTREAM_BACKWARD);
+	status = dc_rbstream_new (&rbstream, abstract, SZ_READ, SZ_READ, layout->rb_profile_begin, layout->rb_profile_end, eop, DC_RBSTREAM_BACKWARD);
 	if (status != DC_STATUS_SUCCESS) {
 		ERROR (abstract->context, "Failed to create the ringbuffer stream.");
 		goto error_free_profile;
@@ -594,7 +659,7 @@ seac_screen_device_foreach (dc_device_t *abstract, dc_dive_callback_t callback,
 	unsigned int offset = rb_profile_size;
 	for (unsigned int i = 0; i < count; ++i) {
 		// Calculate the length.
-		unsigned int length = RB_PROFILE_DISTANCE (logbook[i].address, previous);
+		unsigned int length = RB_PROFILE_DISTANCE (logbook[i].address, previous, layout);
 
 		// Move to the start of the current dive.
 		offset -= length;

src/seac_screen.h

@@ -35,7 +35,7 @@ dc_status_t
 seac_screen_device_open (dc_device_t **device, dc_context_t *context, dc_iostream_t *iostream);
 
 dc_status_t
-seac_screen_parser_create (dc_parser_t **parser, dc_context_t *context, const unsigned char data[], size_t size);
+seac_screen_parser_create (dc_parser_t **parser, dc_context_t *context, const unsigned char data[], size_t size, unsigned int model);
 
 #ifdef __cplusplus
 }

src/seac_screen_parser.c

@@ -36,10 +36,15 @@
 
 #define INVALID 0xFFFFFFFF
 
+#define ACTION 0x01
+#define SCREEN 0x02
+#define TABLET 0x10
+
 typedef struct seac_screen_parser_t seac_screen_parser_t;
 
 struct seac_screen_parser_t {
 	dc_parser_t base;
+	unsigned int model;
 	// Cached fields.
 	unsigned int cached;
 	unsigned int ngasmixes;
@@ -65,7 +70,7 @@ static const dc_parser_vtable_t seac_screen_parser_vtable = {
 };
 
 dc_status_t
-seac_screen_parser_create (dc_parser_t **out, dc_context_t *context, const unsigned char data[], size_t size)
+seac_screen_parser_create (dc_parser_t **out, dc_context_t *context, const unsigned char data[], size_t size, unsigned int model)
 {
 	seac_screen_parser_t *parser = NULL;
 
@@ -80,6 +85,7 @@ seac_screen_parser_create (dc_parser_t **out, dc_context_t *context, const unsig
 	}
 
 	// Set the default values.
+	parser->model = model;
 	parser->cached = 0;
 	parser->ngasmixes = 0;
 	for (unsigned int i = 0; i < NGASMIXES; ++i) {
@@ -298,6 +304,7 @@ seac_screen_parser_samples_foreach (dc_parser_t *abstract, dc_sample_callback_t
 		unsigned int decodepth   = array_uint16_le (data + offset + 0x0E);
 		unsigned int decotime    = array_uint16_le (data + offset + 0x10);
 		unsigned int ndl_tts     = array_uint16_le (data + offset + 0x12);
+		unsigned int pressure    = array_uint16_le (data + offset + 0x14);
 		unsigned int cns         = array_uint16_le (data + offset + 0x16);
 		unsigned int gf_hi       = data[offset + 0x3B];
 		unsigned int gf_lo       = data[offset + 0x3C];
@@ -366,6 +373,13 @@ seac_screen_parser_samples_foreach (dc_parser_t *abstract, dc_sample_callback_t
 		sample.cns = cns / 100.0;
 		if (callback) callback (DC_SAMPLE_CNS, &sample, userdata);
 
+		// Tank pressure
+		if (pressure && parser->model == TABLET) {
+			sample.pressure.tank = 0;
+			sample.pressure.value = pressure;
+			if (callback) callback (DC_SAMPLE_PRESSURE, &sample, userdata);
+		}
+
 		// Deco model
 		if (gf_low == 0 && gf_high == 0) {
 			gf_low = gf_lo;

src/shearwater_predator_parser.c

@@ -598,7 +598,7 @@ shearwater_predator_parser_cache (shearwater_predator_parser_t *parser)
 								tank[id].endpressure = pressure;
 							}
 							tank[id].endpressure = pressure;
-							tank[id].battery = 0;
+							tank[id].battery |= battery;
 						}
 					}
 				}