libdivecomputer/suunto_vyper.c

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

#include "suunto.h"
#include "serial.h"

#define MIN(a,b)	(((a) < (b)) ? (a) : (b))
#define MAX(a,b)	(((a) > (b)) ? (a) : (b))

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

#define EXITCODE(rc, n) \
( \
	rc == -1 ? \
	SUUNTO_VYPER_ERROR_IO : \
	(rc != n ? SUUNTO_VYPER_ERROR_TIMEOUT : SUUNTO_VYPER_ERROR_PROTOCOL) \
)


struct vyper {
	struct serial *port;
	int extraanswertime;
	int ifacealwaysechos;
	int breakprofreadearly;
};


int
suunto_vyper_open (vyper **out, const char* name)
{
	if (out == NULL)
		return SUUNTO_VYPER_ERROR;

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

	// Set the default values.
	device->port = NULL;
	device->extraanswertime = 0;
	device->ifacealwaysechos = 0;
	device->breakprofreadearly = 0;

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

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

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

	// Set the DTR line (power supply for the interface).
	if (serial_set_dtr (device->port, 1) == -1) {
		WARNING ("Failed to set the DTR line.");
		serial_close (device->port);
		free (device);
		return SUUNTO_VYPER_ERROR_IO;
	}

	// Give the interface 100 ms to settle and draw power up.
	serial_sleep (100);

	// Make sure everything is in a sane state.
	serial_flush (device->port, SERIAL_QUEUE_BOTH);

	*out = device;

	return SUUNTO_VYPER_SUCCESS;
}


int
suunto_vyper_close (vyper *device)
{
	if (device == NULL)
		return SUUNTO_VYPER_ERROR;

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

	// Free memory.	
	free (device);

	return SUUNTO_VYPER_SUCCESS;
}


static unsigned char
suunto_vyper_checksum (const unsigned char data[], unsigned int size, unsigned char init)
{
	unsigned char crc = init;
	for (unsigned int i = 0; i < size; ++i)
		crc ^= data[i];

	return crc;
}


static void
suunto_vyper_reverse (unsigned char data[], unsigned int size)
{
	for (unsigned int i = 0; i < size / 2; ++i) {
		unsigned char hlp = data[i];
		data[i] = data[size-1-i];
		data[size-1-i] = hlp;
	}
}


static int
suunto_vyper_send_testcmd (vyper *device, const unsigned char* data, unsigned int size)
{
	if (serial_write (device->port, data, size) != size) {
		WARNING ("Failed to send the test sequence.");
		return SUUNTO_VYPER_ERROR_IO;
	}
	serial_drain (device->port);
	return SUUNTO_VYPER_SUCCESS;
}


int
suunto_vyper_detect_interface (vyper *device)
{
	int rc, detectmode_worked = 1;
	unsigned char command[3] = {'A', 'T', '\r'}, reply[3] = {0}, extra = 0;

	if (device == NULL)
		return SUUNTO_VYPER_ERROR;

	// Make sure everything is in a sane state.
	serial_flush (device->port, SERIAL_QUEUE_BOTH);

	// Charge power supply?
	serial_set_rts (device->port, 1);
	serial_sleep (300);

	// Try detection mode first.

	serial_set_rts (device->port, 0);
	rc = suunto_vyper_send_testcmd (device, command, 3);
	if (rc != SUUNTO_VYPER_SUCCESS)
		return rc;
	rc = serial_read (device->port, reply, 3);
	if (rc != 3 || memcmp (command, reply, 3) != 0) {
		WARNING ("Interface not responding in probe mode.");
    	detectmode_worked = 0;
	}
	if (serial_read (device->port, &extra, 1) == 1) {
		WARNING ("Got an extraneous character in the detection phase. Maybe the line is connected to a modem?");
	}

	// Try transfer mode now.

	serial_set_rts (device->port, 1);
	rc = suunto_vyper_send_testcmd (device, command, 3);
	if (rc != SUUNTO_VYPER_SUCCESS)
		return rc;
	serial_set_rts (device->port, 0);
	rc = serial_read (device->port, reply, 3);
	if (rc == 0) {
		if (detectmode_worked) {
			WARNING ("Detected an original suunto interface with RTS-switching.");
		} else {
			WARNING ("Can't detect the interface. Hoping it's an original suunto interface with the DC already attached.");
		}
		device->ifacealwaysechos = 0;
		return SUUNTO_VYPER_SUCCESS;
	}
	if (rc != 3 || memcmp (command, reply, 3) != 0) {
		WARNING ("Interface not responding in transfer mode.");
	}
	if (serial_read (device->port, &extra, 1) == 1) {
		WARNING ("Got an extraneous character in the detection phase. Maybe the line is connected to a modem?");
	}
	WARNING ("Detected a clone interface without RTS-switching.");
	device->ifacealwaysechos = 1;
	return SUUNTO_VYPER_SUCCESS;
}


static int
suunto_vyper_send_command (vyper *device, const unsigned char* data, unsigned int size)
{
	serial_sleep (500);

	// Set RTS to send the command.
	serial_set_rts (device->port, 1);

	// Send the command to the dive computer and 
	// wait until all data has been transmitted.
	serial_write (device->port, data, size);
	serial_drain (device->port);

	// If the interface sends an echo back (which is the case for many clone 
	// interfaces), this echo should be removed from the input queue before 
	// attempting to read the real reply from the dive computer. Otherwise, 
	// the data transfer will fail. Timing is also critical here! We have to 
	// wait at least until the echo appears (40ms), but not until the reply 
	// from the dive computer appears (600ms).
	// The original suunto interface does not have this problem, because it
	// does not send an echo and the RTS switching makes it impossible to
	// receive the reply too early here.
	serial_sleep (200);
	serial_flush (device->port, SERIAL_QUEUE_INPUT);

	// Clear RTS to receive the reply.
	serial_set_rts (device->port, 0);

	return SUUNTO_VYPER_SUCCESS;
}


static int
suunto_vyper_read_memory_package (vyper *device, unsigned int address, unsigned char data[], unsigned int size)
{
	// Prepare the command.
	unsigned char command[5] = {0x05,
			(address >> 8) & 0xFF, // high
			(address     ) & 0xFF, // low
			size, // count
			0x00};  // CRC
	command[4] = suunto_vyper_checksum (command, 4, 0x00);

	// Send the command to the dive computer.
	int rc = suunto_vyper_send_command (device, command, 5);
	if (rc != SUUNTO_VYPER_SUCCESS) {
		WARNING ("Failed to send the command.");
		return rc;
	}

	// FIXME: Give the DC extra answer time to send its first byte, 
	//        then let the standard timeout apply.

	// Receive the header of the package.
	unsigned char reply[4] = {0, 0, 0, 0};
	rc = serial_read (device->port, reply, 4);
	if (rc != 4 || memcmp (command, reply, 4) != 0) {
		WARNING ("Unexpected answer start byte(s).");
		if (rc == 0) {
			WARNING ("Interface present, but the DC does not answer. Check the connection.");
		}
		return EXITCODE (rc, 4);
	}

	// Receive the contents of the package.
	rc = serial_read (device->port, data, size);
	if (rc != size) {
		WARNING ("Unexpected EOF in answer.");
		return EXITCODE (rc, size);
	}

	// Calculate the checksum.
	unsigned char ccrc = 0x00;
	ccrc = suunto_vyper_checksum (reply, 4, ccrc);
	ccrc = suunto_vyper_checksum (data, size, ccrc);

	// Receive (and verify) the checksum of the package.
	unsigned char crc = 0x00;
	rc = serial_read (device->port, &crc, 1);
	if (rc != 1 || ccrc != crc) {
		WARNING ("Unexpected answer CRC.");
		return EXITCODE (rc, 1);
	}

#ifndef NDEBUG
	printf ("VyperRead(0x%04x,%d)=\"", (command[1] << 8) | command[2], command[3]);
	for (unsigned int i = 0; i < size; ++i) {
		printf("%02x",data[i]);
	}
	printf("\"\n");
#endif

	return SUUNTO_VYPER_SUCCESS;
}


static int
suunto_vyper_write_memory_prepare (vyper *device)
{
	// Prepare the commmand.
	unsigned char command[3] = {0x07, 0xA5, 0x00};
	command[2] = suunto_vyper_checksum (command, 2, 0x00);

	// Send the command to the dive computer.
	int rc = suunto_vyper_send_command (device, command, 3);
	if (rc != SUUNTO_VYPER_SUCCESS) {
		WARNING ("Failed to send the command.");
		return rc;
	}

	// FIXME: Give the DC extra answer time to send its first byte, 
	//        then let the standard timeout apply.

	// Receive the header of the package.
	unsigned char reply[3] = {0, 0, 0};
	rc = serial_read (device->port, reply, 3);
	if (rc != 3 || memcmp (command, reply, 3) != 0) {
		WARNING ("Unexpected answer start byte(s).");
		if (rc == 0) {
			WARNING ("Interface present, but the DC does not answer. Check the connection.");
		}
		return EXITCODE (rc, 3);
	}

#ifndef NDEBUG
	printf("VyperPrepareWrite();\n");
#endif

	return SUUNTO_VYPER_SUCCESS;
}


static int
suunto_vyper_write_memory_package (vyper *device, int address, const unsigned char data[], unsigned int size)
{
	// Prepare the command.
	unsigned char command[SUUNTO_VYPER_PACKET_SIZE + 5] = {0x06,
			(address >> 8) & 0xFF, // high
			(address     ) & 0xFF, // low
			size, // count
			0x00};  // data + CRC
	memcpy (command + 4, data, size);
	command[size + 4] = suunto_vyper_checksum (command, size + 4, 0x00);

	// Send the command to the dive computer.
	int rc = suunto_vyper_send_command (device, command, size + 5);
	if (rc != SUUNTO_VYPER_SUCCESS) {
		WARNING ("Failed to send the command.");
		return rc;
	}

	// FIXME: Give the DC extra answer time to send its first byte, 
	//        then let the standard timeout apply.

	// Receive the header of the package.
	unsigned char reply[4] = {0, 0, 0, 0};
	rc = serial_read (device->port, reply, 4);
	if (rc != 4 || memcmp (command, reply, 4) != 0) {
		WARNING ("Unexpected answer start byte(s).");
		if (rc == 0) {
			WARNING ("Interface present, but the DC does not answer. Check the connection.");
		}
		return EXITCODE (rc, 4);
	}

	// Calculate the checksum.
	unsigned char ccrc = 0x00;
	ccrc = suunto_vyper_checksum (reply, 4, ccrc);

	// Receive (and verify) the checksum of the package.
	unsigned char crc = 0x00;
	rc = serial_read (device->port, &crc, 1);
	if (rc != 1 || ccrc != crc) {
		WARNING ("Unexpected answer CRC.");
		return EXITCODE (rc, 1);
	}

#ifndef NDEBUG
	printf ("VyperWrite(0x%04x,%d,\"", (command[1] << 8) | command[2], command[3]);
	for (unsigned int i = 0; i < size; ++i) {
		printf ("%02x", command[i + 4]);
	}
	printf ("\");\n");
#endif

	return SUUNTO_VYPER_SUCCESS;
}


int
suunto_vyper_read_memory (vyper *device, unsigned int address, unsigned char data[], unsigned int size)
{
	if (device == NULL)
		return SUUNTO_VYPER_ERROR;

	// The data transmission is split in packages
	// of maximum $SUUNTO_VYPER_PACKET_SIZE bytes.

	unsigned int nbytes = 0;
	while (nbytes < size) {
		// Calculate the package size.
		unsigned int len = MIN (size - nbytes, SUUNTO_VYPER_PACKET_SIZE);

		// Read the package.
		int rc = suunto_vyper_read_memory_package (device, address + nbytes, data + nbytes, len);
		if (rc != SUUNTO_VYPER_SUCCESS)
			return rc;

		// Increment the total number of bytes read.
		nbytes += len;
	}

	return SUUNTO_VYPER_SUCCESS;
}


int
suunto_vyper_write_memory (vyper *device, unsigned int address, const unsigned char data[], unsigned int size)
{
	if (device == NULL)
		return SUUNTO_VYPER_ERROR;

	// The data transmission is split in packages
	// of maximum $SUUNTO_VYPER_PACKET_SIZE bytes.

	unsigned int nbytes = 0;
	while (nbytes < size) {
		// Calculate the package size.
		unsigned int len = MIN (size - nbytes, SUUNTO_VYPER_PACKET_SIZE);

		// Prepare to write the package.
		int rc = suunto_vyper_write_memory_prepare (device);
		if (rc != SUUNTO_VYPER_SUCCESS)
			return rc;

		// Write the package.
		rc = suunto_vyper_write_memory_package (device, address + nbytes, data + nbytes, len);
		if (rc != SUUNTO_VYPER_SUCCESS)
			return rc;

		// Increment the total number of bytes written.
		nbytes += len;
	}

	return SUUNTO_VYPER_SUCCESS;
}


int
suunto_vyper_read_dive (vyper *device, unsigned char data[], unsigned int size, int init)
{
	if (device == NULL)
		return SUUNTO_VYPER_ERROR;

	// Prepare the command.
	unsigned char command[3] = {init ? 0x08 : 0x09, 0xA5, 0x00};
	command[2] = suunto_vyper_checksum (command, 2, 0x00);

	// Send the command to the dive computer.
	int rc = suunto_vyper_send_command (device, command, 3);
	if (rc != SUUNTO_VYPER_SUCCESS) {
		WARNING ("Failed to send the command.");
		return rc;
	}

	// FIXME: Give the DC extra answer time to send its first byte, 
	//        then let the standard timeout apply.

	// The data transmission is split in packages
	// of maximum $SUUNTO_VYPER_PACKET_SIZE bytes.

	unsigned int nbytes = 0;
	for (;;) {
		// Receive the header of the package.
		unsigned char reply = 0;
		rc = serial_read (device->port, &reply, 1);
		if (rc != 1 || memcmp (command, &reply, 1) != 0) {
			// If no data is received at this point (a timeout occured), 
			// we assume the last package was already received and the 
			// transmission should be finished. This is not 100% reliable, 
			// because there is always a small chance that more data will 
			// arrive later (especially with a short timeout). But I'm not 
			// aware of a better method to detect the end of the transmission. 
			// Only for the very first package, we can be sure there was
			// an error, because it makes no sense to end the transmission 
			// if no data was received so far.
			if (rc == 0 && nbytes != 0)
				break;
			WARNING ("Unexpected answer start byte(s).");
			return EXITCODE (rc, 1);
		}

		// Receive the size of the package.
		unsigned char len = 0;
		rc = serial_read (device->port, &len, 1);
		if (rc != 1 || len > SUUNTO_VYPER_PACKET_SIZE) {
			WARNING ("Unexpected answer length.");
			return EXITCODE (rc, 1);
		}

		// Receive the contents of the package.
		unsigned char package[SUUNTO_VYPER_PACKET_SIZE] = {0};
		rc = serial_read (device->port, package, len);
		if (rc != len) {
			WARNING ("Unexpected EOF in answer.");
			return EXITCODE (rc, len);
		}

		// Calculate the checksum.
		unsigned char ccrc = 0x00;
		ccrc = suunto_vyper_checksum (&reply, 1, ccrc);
		ccrc = suunto_vyper_checksum (&len, 1, ccrc);
		ccrc = suunto_vyper_checksum (package, len, ccrc);

		// Receive (and verify) the checksum of the package.
		unsigned char crc = 0x00;
		rc = serial_read (device->port, &crc, 1);
		if (rc != 1 || ccrc != crc) {
			WARNING ("Unexpected answer CRC.");
			return EXITCODE (rc, 1);
		}

		// Append the package to the output buffer.
		if (nbytes + len <= size) {
			memcpy (data + nbytes, package, len);
			nbytes += len;
		} else {
			WARNING ("Insufficient buffer space available.");
			return SUUNTO_VYPER_ERROR_MEMORY;
		}

		// A null package (length zero) indicates the DC reached the end of 
		// its internal ring buffer and the transmission should be aborted. 
		// The remaining data of the current dive is overwritten with newer 
		// data and thus not transmitted by the DC. Therefore, the data that 
		// was already received is discarded.
		if (len == 0)
			return 0;

		// If a package is smaller than $SUUNTO_VYPER_PACKET_SIZE bytes, 
		// we assume it's the last packet and the transmission can be 
		// finished early. However, this approach does not work if the 
		// last packet is exactly $SUUNTO_VYPER_PACKET_SIZE bytes long!
		if (device->breakprofreadearly && len != SUUNTO_VYPER_PACKET_SIZE) 
			break;
	}

	// The DC traverses the internal ring buffer backwards while sending. 
	// Therefore, we restore the original order before returning the 
	// data to the application.
	suunto_vyper_reverse (data, nbytes);

#ifndef NDEBUG
	printf ("Vyper%sProfile=\"", command[0] == 0x08 ? "First" : "");
	for (unsigned int i = 0; i < nbytes; ++i) {
		printf("%02x", data[i]);
	}
	printf("\"\n");
#endif

	return nbytes;
}