libdivecomputer/src/uwatec_memomouse.c

#include <string.h> // memcmp, memcpy
#include <stdlib.h> // malloc, free
#include <assert.h> // assert

#include "device-private.h"
#include "uwatec_memomouse.h"
#include "serial.h"
#include "checksum.h"
#include "array.h"
#include "utils.h"

#define WARNING(expr) \
{ \
	message ("%s:%d: %s\n", __FILE__, __LINE__, expr); \
}

#define EXITCODE(rc) \
( \
	rc == -1 ? DEVICE_STATUS_IO : DEVICE_STATUS_TIMEOUT \
)

#define ACK 0x60
#define NAK 0xA8

typedef struct uwatec_memomouse_device_t uwatec_memomouse_device_t;

struct uwatec_memomouse_device_t {
	device_t base;
	struct serial *port;
	unsigned int timestamp;
};

static const device_backend_t uwatec_memomouse_device_backend;

static int
device_is_uwatec_memomouse (device_t *abstract)
{
	if (abstract == NULL)
		return 0;

    return abstract->backend == &uwatec_memomouse_device_backend;
}


device_status_t
uwatec_memomouse_device_open (device_t **out, const char* name)
{
	if (out == NULL)
		return DEVICE_STATUS_ERROR;

	// Allocate memory.
	uwatec_memomouse_device_t *device = malloc (sizeof (uwatec_memomouse_device_t));
	if (device == NULL) {
		WARNING ("Failed to allocate memory.");
		return DEVICE_STATUS_MEMORY;
	}

	// Initialize the base class.
	device_init (&device->base, &uwatec_memomouse_device_backend);

	// Set the default values.
	device->port = NULL;
	device->timestamp = 0;

	// Open the device.
	int rc = serial_open (&device->port, name);
	if (rc == -1) {
		WARNING ("Failed to open the serial port.");
		free (device);
		return DEVICE_STATUS_IO;
	}

	// Set the serial communication protocol (9600 8N1).
	rc = serial_configure (device->port, 9600, 8, SERIAL_PARITY_NONE, 1, SERIAL_FLOWCONTROL_NONE);
	if (rc == -1) {
		WARNING ("Failed to set the terminal attributes.");
		serial_close (device->port);
		free (device);
		return DEVICE_STATUS_IO;
	}

	// Set the timeout for receiving data (60s).
	if (serial_set_timeout (device->port, 60000) == -1) {
		WARNING ("Failed to set the timeout.");
		serial_close (device->port);
		free (device);
		return DEVICE_STATUS_IO;
	}

	serial_sleep (200);

	serial_flush (device->port, SERIAL_QUEUE_BOTH);

	// Clear the RTS line and set the DTR line.
	if (serial_set_dtr (device->port, 1) == -1 ||
		serial_set_rts (device->port, 0) == -1) {
		WARNING ("Failed to set the DTR/RTS line.");
		serial_close (device->port);
		free (device);
		return DEVICE_STATUS_IO;
	}

	*out = (device_t*) device;

	return DEVICE_STATUS_SUCCESS;
}


static device_status_t
uwatec_memomouse_device_close (device_t *abstract)
{
	uwatec_memomouse_device_t *device = (uwatec_memomouse_device_t*) abstract;

	if (! device_is_uwatec_memomouse (abstract))
		return DEVICE_STATUS_TYPE_MISMATCH;

	// Close the device.
	if (serial_close (device->port) == -1) {
		free (device);
		return DEVICE_STATUS_IO;
	}

	// Free memory.	
	free (device);

	return DEVICE_STATUS_SUCCESS;
}


device_status_t
uwatec_memomouse_device_set_timestamp (device_t *abstract, unsigned int timestamp)
{
	uwatec_memomouse_device_t *device = (uwatec_memomouse_device_t*) abstract;

	if (! device_is_uwatec_memomouse (abstract))
		return DEVICE_STATUS_TYPE_MISMATCH;

	device->timestamp = timestamp;

	return DEVICE_STATUS_SUCCESS;
}


static device_status_t
uwatec_memomouse_confirm (uwatec_memomouse_device_t *device, unsigned char value)
{
	// Send the value to the device.
	int rc = serial_write (device->port, &value, 1);
	if (rc != 1) {
		WARNING ("Failed to send the value.");
		return EXITCODE (rc);
	}

	serial_drain (device->port);

	return DEVICE_STATUS_SUCCESS;
}


static device_status_t
uwatec_memomouse_read_packet (uwatec_memomouse_device_t *device, unsigned char data[], unsigned int size)
{
	assert (size >= 126 + 2);

	// Receive the header of the package.
	int rc = serial_read (device->port, data, 1);
	if (rc != 1) {
		WARNING ("Failed to receive the answer.");
		return EXITCODE (rc);
	}

	// Reverse the bits.
	array_reverse_bits (data, 1);

	// Verify the header of the package.
	unsigned int len = data[0];
	if (len > 126) {
		WARNING ("Unexpected answer start byte(s).");
		return DEVICE_STATUS_PROTOCOL;
	}

	// Receive the remaining part of the package.
	rc = serial_read (device->port, data + 1, len + 1);
	if (rc != len + 1) {
		WARNING ("Failed to receive the answer.");
		return EXITCODE (rc);
	}

	// Reverse the bits.
	array_reverse_bits (data + 1, len + 1);

	// Verify the checksum of the package.
	unsigned char crc = data[len + 1];
	unsigned char ccrc = checksum_xor_uint8 (data, len + 1, 0x00);
	if (crc != ccrc) {
		WARNING ("Unexpected answer CRC.");
		return DEVICE_STATUS_PROTOCOL;
	}

	return len;
}


static device_status_t
uwatec_memomouse_read_packet_outer (uwatec_memomouse_device_t *device, unsigned char data[], unsigned int size)
{
	int rc = 0;
	unsigned char package[126 + 2] = {0};
	while ((rc = uwatec_memomouse_read_packet (device, package, sizeof (package))) < 0) {
		// Automatically discard a corrupted packet, 
		// and request a new one.
		if (rc != DEVICE_STATUS_PROTOCOL)
			return rc;	

		// Flush the input buffer.
		serial_flush (device->port, SERIAL_QUEUE_INPUT);

		// Reject the packet.
		rc = uwatec_memomouse_confirm (device, NAK);
		if (rc != DEVICE_STATUS_SUCCESS)
			return rc;
	}

#ifndef NDEBUG
	message ("package(%i)=\"", rc);
	for (unsigned int i = 0; i < rc; ++i) {
		message ("%02x", package[i + 1]);
	}
	message ("\"\n");
#endif

	if (size >= rc) {
		memcpy (data, package + 1, rc);
	} else {
		WARNING ("Insufficient buffer space available.");
		return DEVICE_STATUS_MEMORY;
	}

	return rc;
}


static device_status_t
uwatec_memomouse_read_packet_inner (uwatec_memomouse_device_t *device, unsigned char *data[], unsigned int *size)
{
	// Read the first package.
	unsigned char package[126] = {0};
	int rca = uwatec_memomouse_read_packet_outer (device, package, sizeof (package));
	if (rca < 0)
		return rca;

	// Accept the package.
	int rcb = uwatec_memomouse_confirm (device, ACK);
	if (rcb != DEVICE_STATUS_SUCCESS)
		return rcb;

	// Verify the first package contains at least 
	// the size of the inner package.
	if (rca < 2) {
		WARNING ("First package is too small.");
		return DEVICE_STATUS_PROTOCOL;
	}

	// Calculate the total size of the inner package.
	unsigned int total = package[0] + (package[1] << 8) + 3;

	// Allocate memory for the entire package.
	unsigned char *buffer = malloc (total * sizeof (unsigned char));
	if (package == NULL) {
		WARNING ("Memory allocation error.");
		return DEVICE_STATUS_MEMORY;
	}

	// Copy the first package to the new memory buffer.
	memcpy (buffer, package, rca);

	// Read the remaining packages.
	unsigned int nbytes = rca;
	while (nbytes < total) {
		// Read the package.
		rca = uwatec_memomouse_read_packet_outer (device, buffer + nbytes, total - nbytes);
		if (rca < 0) {
			free (buffer);
			return rca;
		}

		// Accept the package.
		rcb = uwatec_memomouse_confirm (device, ACK);
		if (rcb != DEVICE_STATUS_SUCCESS) {
			free (buffer);
			return rcb;
		}

		nbytes += rca;
	}

	// Verify the checksum.
	unsigned char crc = buffer[total - 1];
	unsigned char ccrc = checksum_xor_uint8 (buffer, total - 1, 0x00);
	if (crc != ccrc) {
		free (buffer);
		return DEVICE_STATUS_PROTOCOL;
	}

	*data = buffer;
	*size = total;

	return DEVICE_STATUS_SUCCESS;
}


static device_status_t
uwatec_memomouse_dump (uwatec_memomouse_device_t *device, unsigned char *data[], unsigned int *size)
{
	// Waiting for greeting message.
	while (serial_get_received (device->port) == 0) {
		// Flush the input buffer.
		serial_flush (device->port, SERIAL_QUEUE_INPUT);

		// Reject the packet.
		int rc = uwatec_memomouse_confirm (device, NAK);
		if (rc != DEVICE_STATUS_SUCCESS)
			return rc;

		serial_sleep (300);
	}

	// Read the ID string.
	unsigned int id_length = 0;
	unsigned char *id_buffer = NULL;
	int rc = uwatec_memomouse_read_packet_inner (device, &id_buffer, &id_length);
	if (rc != DEVICE_STATUS_SUCCESS)
		return rc;

	free (id_buffer);

	// Prepare the command.
	unsigned char command [9] = {
		0x07, 					// Outer packet size.
		0x05, 0x00, 			// Inner packet size.
		0x55, 					// Command byte.
		(device->timestamp      ) & 0xFF,
		(device->timestamp >>  8) & 0xFF,
		(device->timestamp >> 16) & 0xFF,
		(device->timestamp >> 24) & 0xFF,
		0x00}; 					// Outer packet checksum.
	command[8] = checksum_xor_uint8 (command, 8, 0x00);
	array_reverse_bits (command, sizeof (command));

	// Wait a small amount of time before sending the command.
	// Without this delay, the transfer will fail most of the time.
	serial_sleep (50);

	// Keep send the command to the device, 
	// until the ACK answer is received.
	unsigned char answer = NAK;
	while (answer == NAK) {
		// Flush the input buffer.
		serial_flush (device->port, SERIAL_QUEUE_INPUT);
		
		// Send the command to the device.
		rc = serial_write (device->port, command, sizeof (command));
		if (rc != sizeof (command)) {
			WARNING ("Failed to send the command.");
			return EXITCODE (rc);
		}

		serial_drain (device->port);

		// Wait for the answer (ACK).
		rc = serial_read (device->port, &answer, 1);
		if (rc != 1) {
			WARNING ("Failed to recieve the answer.");
			return EXITCODE (rc);
		}

#ifndef NDEBUG
		if (answer != ACK)
			message ("Received unexpected response (%02x).\n", answer);
#endif
	}

	// Verify the answer.
	if (answer != ACK) {
		WARNING ("Unexpected answer start byte(s).");
		return DEVICE_STATUS_PROTOCOL;
	}

	// Wait for the transfer and read the data.
	return uwatec_memomouse_read_packet_inner (device, data, size);
}


static device_status_t
uwatec_memomouse_device_dump (device_t *abstract, unsigned char data[], unsigned int size)
{
	uwatec_memomouse_device_t *device = (uwatec_memomouse_device_t*) abstract;

	if (! device_is_uwatec_memomouse (abstract))
		return DEVICE_STATUS_TYPE_MISMATCH;

	unsigned int length = 0;
	unsigned char *buffer = NULL;
	int rc = uwatec_memomouse_dump (device, &buffer, &length);
	if (rc != DEVICE_STATUS_SUCCESS)
		return rc;

	if (length - 3 <= size) {
		memcpy (data, buffer + 2, length - 3);
	} else {
		WARNING ("Insufficient buffer space available.");
		free (buffer); 
		return DEVICE_STATUS_MEMORY;
	}

	free (buffer);

	return length - 3;
}


static device_status_t
uwatec_memomouse_device_foreach (device_t *abstract, dive_callback_t callback, void *userdata)
{
	uwatec_memomouse_device_t *device = (uwatec_memomouse_device_t*) abstract;

	if (! device_is_uwatec_memomouse (abstract))
		return DEVICE_STATUS_TYPE_MISMATCH;

	unsigned int length = 0;
	unsigned char *buffer = NULL;
	int rc = uwatec_memomouse_dump (device, &buffer, &length);
	if (rc != DEVICE_STATUS_SUCCESS)
		return rc;

	rc = uwatec_memomouse_extract_dives (buffer + 2, length - 3, callback, userdata);
	if (rc != DEVICE_STATUS_SUCCESS) {
		free (buffer);
		return rc;
	}

	free (buffer);

	return DEVICE_STATUS_SUCCESS;
}


device_status_t
uwatec_memomouse_extract_dives (const unsigned char data[], unsigned int size, dive_callback_t callback, void *userdata)
{
	// Parse the data stream to find the total number of dives.
	unsigned int ndives = 0;
	unsigned int previous = 0;
	unsigned int current = 5;
	while (current + 18 <= size) {
		// Memomouse sends all the data twice. The first time, it sends 
		// the data starting from the oldest dive towards the newest dive. 
		// Next, it send the same data in reverse order (newest to oldest).
		// We abort the parsing once we detect the first duplicate dive.
		// The second data stream contains always exactly 37 dives, and not
		// all dives have profile data, so it's probably data from the
		// connected Uwatec Aladin (converted to the memomouse format).
		if (previous && memcmp (data + previous, data + current, 18) == 0)
			break;

		// Get the length of the profile data.
		unsigned int len = data[current + 16] + (data[current + 17] << 8);

		// Check for a buffer overflow.
		if (current + len + 18 > size)
			return DEVICE_STATUS_ERROR;

		// Move to the next dive.
		previous = current;
		current += len + 18;
		ndives++;
	}

	// Parse the data stream again to return each dive in reverse order
	// (newest dive first). This is less efficient, since the data stream
	// needs to be scanned multiple times, but it makes the behaviour
	// consistent with the equivalent function for the Uwatec Aladin.
	for (unsigned int i = 0; i < ndives; ++i) {
		// Skip the older dives.
		unsigned int offset = 5;
		unsigned int skip = ndives - i - 1;
		while (skip) {
			// Get the length of the profile data.
			unsigned int len = data[offset + 16] + (data[offset + 17] << 8);
			// Move to the next dive.
			offset += len + 18;
			skip--;
		}

		// Get the length of the profile data.
		unsigned int length = data[offset + 16] + (data[offset + 17] << 8);

		if (callback && !callback (data + offset, length + 18, userdata))
			return DEVICE_STATUS_SUCCESS;
	}

	return DEVICE_STATUS_SUCCESS;
}


static const device_backend_t uwatec_memomouse_device_backend = {
	DEVICE_TYPE_UWATEC_MEMOMOUSE,
	NULL, /* handshake */
	NULL, /* version */
	NULL, /* read */
	NULL, /* write */
	uwatec_memomouse_device_dump, /* dump */
	uwatec_memomouse_device_foreach, /* foreach */
	uwatec_memomouse_device_close /* close */
};