diff --git a/uwatec.h b/uwatec.h index 49413fa..f8b0a1c 100644 --- a/uwatec.h +++ b/uwatec.h @@ -9,5 +9,6 @@ #define UWATEC_ERROR_TIMEOUT -5 #include "uwatec_aladin.h" +#include "uwatec_memomouse.h" #endif /* UWATEC_H */ diff --git a/uwatec_memomouse.c b/uwatec_memomouse.c new file mode 100644 index 0000000..dd98c79 --- /dev/null +++ b/uwatec_memomouse.c @@ -0,0 +1,349 @@ +#include // memcmp, memcpy +#include // malloc, free + +#include "uwatec.h" +#include "serial.h" +#include "utils.h" + +#define WARNING(expr) \ +{ \ + message ("%s:%d: %s\n", __FILE__, __LINE__, expr); \ +} + +#define EXITCODE(rc, n) \ +( \ + rc == -1 ? \ + UWATEC_ERROR_IO : \ + (rc != n ? UWATEC_ERROR_TIMEOUT : UWATEC_ERROR_PROTOCOL) \ +) + +struct memomouse { + struct serial *port; +}; + + +static const unsigned char ack = 0x60, nak = 0xA8; + + +int +uwatec_memomouse_open (memomouse **out, const char* name) +{ + if (out == NULL) + return UWATEC_ERROR; + + // Allocate memory. + struct memomouse *device = malloc (sizeof (struct memomouse)); + if (device == NULL) { + WARNING ("Failed to allocate memory."); + return UWATEC_ERROR_MEMORY; + } + + // Set the default values. + device->port = NULL; + + // Open the device. + int rc = serial_open (&device->port, name); + if (rc == -1) { + WARNING ("Failed to open the serial port."); + free (device); + return UWATEC_ERROR_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 UWATEC_ERROR_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 UWATEC_ERROR_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 UWATEC_ERROR_IO; + } + + *out = device; + + return UWATEC_SUCCESS; +} + + +int +uwatec_memomouse_close (memomouse *device) +{ + if (device == NULL) + return UWATEC_SUCCESS; + + // Close the device. + if (serial_close (device->port) == -1) { + free (device); + return UWATEC_ERROR_IO; + } + + // Free memory. + free (device); + + return UWATEC_SUCCESS; +} + + +static void +uwatec_memomouse_reverse (unsigned char data[], unsigned int size) +{ + for (unsigned int i = 0; i < size; ++i) { + unsigned char j = 0; + j = (data[i] & 0x01) << 7; + j += (data[i] & 0x02) << 5; + j += (data[i] & 0x04) << 3; + j += (data[i] & 0x08) << 1; + j += (data[i] & 0x10) >> 1; + j += (data[i] & 0x20) >> 3; + j += (data[i] & 0x40) >> 5; + j += (data[i] & 0x80) >> 7; + data[i] = j; + } +} + + +static unsigned char +uwatec_memomouse_checksum (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 int +serial_read_uwatec (serial *device, unsigned char data[], unsigned int size) +{ + int rc = serial_read (device, data, size); + + if (rc > 0) + uwatec_memomouse_reverse (data, rc); + + return rc; +} + + +static int +serial_write_uwatec (serial *device, const unsigned char data[], unsigned int size) +{ + int rc = serial_write (device, data, size); + + serial_drain (device); + + return rc; +} + + +static int +uwatec_memomouse_read_packet_outer (memomouse *device, unsigned char data[], unsigned int size) +{ + // Initial checksum value. + unsigned char ccrc = 0x00; + + // Receive the header of the package. + unsigned char len = 0x00; + int rc = serial_read_uwatec (device->port, &len, 1); + if (rc != 1 || len > size) { + WARNING ("Unexpected answer start byte(s)."); + return EXITCODE (rc, 1); + } + // Update the checksum. + ccrc = uwatec_memomouse_checksum (&len, 1, ccrc); + + // Receive the contents of the package. + rc = serial_read_uwatec (device->port, data, len); + if (rc != len) { + WARNING ("Unexpected EOF in answer."); + return EXITCODE (rc, len); + } + // Update the checksum. + ccrc = uwatec_memomouse_checksum (data, len, ccrc); + + // Receive (and verify) the checksum of the package. + unsigned char crc = 0x00; + rc = serial_read_uwatec (device->port, &crc, 1); + if (rc != 1 || ccrc != crc) { + WARNING ("Unexpected answer CRC."); + return EXITCODE (rc, 1); + } + +#ifndef NDEBUG + message ("package(%i)=\"", len); + for (unsigned int i = 0; i < len; ++i) { + message ("%02x", data[i]); + } + message ("\"\n"); +#endif + + return len; +} + +static int +uwatec_memomouse_read_packet_inner (memomouse *device, unsigned char data[], unsigned int msize) +{ + // Initial checksum value. + unsigned char ccrc = 0x00; + + // Read the first package. + int rc = 0; + unsigned char package[128 - 2] = {0}; + for (;;) { + rc = uwatec_memomouse_read_packet_outer (device, package, sizeof (package)); + if (rc < 0) { + message ("Didn't got expected packet, sending NAK\n"); + serial_flush (device->port, SERIAL_QUEUE_INPUT); + serial_write_uwatec (device->port, &nak, 1); + message ("Package: nbytes=%u, rc=%i\n", 0, rc); + } else { + message ("Got expected packet, sending ACK\n"); + serial_write_uwatec (device->port, &ack, 1); + break; + } + } + + if (rc < 2) { + message ("Package too small.\n"); + return UWATEC_ERROR; + } + + // Calculate the total size of the inner package. + unsigned int size = package[0] + (package[1] << 8) + 3; + message ("Package: size=%u\n", size); + + // Calculate the size of the data in current package + // (excluding the checksum). + unsigned int len = (rc >= size ? size - 1 : rc); + message ("Package: nbytes=%u, rc=%i, len=%u\n", 0, rc, len); + + // Update the checksum. + ccrc = uwatec_memomouse_checksum (package, len, ccrc); + + // Append the data package to the output buffer. + if (len - 2 <= msize) + memcpy (data, package + 2, len - 2); + else + message ("Insufficient buffer space available.\n"); + + unsigned int nbytes = rc; + while (nbytes < size) { + rc = uwatec_memomouse_read_packet_outer (device, package, sizeof (package)); + if (rc < 0) { + message ("Didn't got expected packet, sending NAK\n"); + serial_flush (device->port, SERIAL_QUEUE_INPUT); + serial_write_uwatec (device->port, &nak, 1); + message ("Package: nbytes=%u, rc=%i\n", nbytes, rc); + } else { + message ("Got expected packet, sending ACK\n"); + serial_write_uwatec (device->port, &ack, 1); + + // Calculate the size of the data in current package + // (excluding the checksum). + len = (nbytes + rc >= size ? size - nbytes - 1 : rc); + message ("Package: nbytes=%u, rc=%u, len=%u\n", nbytes, rc, len); + + // Update the checksum. + ccrc = uwatec_memomouse_checksum (package, len, ccrc); + + // Append the data package to the output buffer. + if (nbytes + len - 2 <= msize) + memcpy (data + nbytes - 2, package, len); + else + message ("Insufficient buffer space available.\n"); + + nbytes += rc; + } + } + + message ("Package: nbytes=%i\n", nbytes); + + // Verify the checksum. + unsigned char crc = package[len]; + if (crc != ccrc) + return UWATEC_ERROR; + + return UWATEC_SUCCESS; +} + +int +uwatec_memomouse_read (memomouse *device, unsigned char data[], unsigned int size) +{ + if (device == NULL) + return UWATEC_ERROR; + + // Waiting for greeting message. + while (serial_get_received (device->port) == 0) { + message ("No greeting yet, sending NAK\n"); + serial_flush (device->port, SERIAL_QUEUE_INPUT); + serial_write_uwatec (device->port, &nak, 1); + serial_sleep (300); + } + + // Read the ID string. + unsigned char id[7] = {0}; + int rc = uwatec_memomouse_read_packet_inner (device, id, sizeof (id)); + if (rc != UWATEC_SUCCESS) + return UWATEC_ERROR; + + // Prepare the command. + unsigned char command [9] = { + 0x07, // Outer packet size. + 0x05, 0x00, // Inner packet size. + 0x55, // Command byte. + 0x00, 0x00, 0x00, 0x00, // Timestamp. + 0x00}; // Outer packet checksum. + command[8] = uwatec_memomouse_checksum (command, 8, 0x00); + uwatec_memomouse_reverse (command, sizeof (command)); + + // Send upload command, until getting ACK. + unsigned char answer = nak; + while (answer != ack) { + message ("Sending command\n"); + serial_flush (device->port, SERIAL_QUEUE_INPUT); + rc = serial_write (device->port, command, sizeof (command)); + if (rc != sizeof (command)) { + WARNING ("Failed to send command"); + return EXITCODE (rc, sizeof (command)); + } + + rc = serial_read (device->port, &answer, 1); + if (rc != 1) { + WARNING ("Failed to recieve ACK"); + return EXITCODE (rc, 1); + } + + if (answer != ack) + message ("No ACK, got (0x%x)\n", answer); + else + message ("Received ACK\n"); + } + + // Wait for the transfer and read the data. + message ("Waiting for transfer, access the log in your Aladin\n"); + rc = uwatec_memomouse_read_packet_inner (device, data, size); + if (rc != UWATEC_SUCCESS) + return UWATEC_ERROR; + + return UWATEC_SUCCESS; +} diff --git a/uwatec_memomouse.h b/uwatec_memomouse.h new file mode 100644 index 0000000..99f2692 --- /dev/null +++ b/uwatec_memomouse.h @@ -0,0 +1,21 @@ +#ifndef UWATEC_MEMOMOUSE_H +#define UWATEC_MEMOMOUSE_H + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +typedef struct memomouse memomouse; + +#define UWATEC_MEMOMOUSE_MEMORY_SIZE 0x8000 + +int uwatec_memomouse_open (memomouse **device, const char* name); + +int uwatec_memomouse_close (memomouse *device); + +int uwatec_memomouse_read (memomouse *device, unsigned char data[], unsigned int size); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ +#endif /* UWATEC_MEMOMOUSE_H */ diff --git a/uwatec_memomouse_test.c b/uwatec_memomouse_test.c new file mode 100644 index 0000000..ed6ab11 --- /dev/null +++ b/uwatec_memomouse_test.c @@ -0,0 +1,94 @@ +#include // fopen, fwrite, fclose + +#include "uwatec.h" +#include "utils.h" + +#define WARNING(expr) \ +{ \ + message ("%s:%d: %s\n", __FILE__, __LINE__, expr); \ +} + + +int test_dump_memory (const char* name, const char* filename) +{ + memomouse *device = NULL; + unsigned char data[UWATEC_MEMOMOUSE_MEMORY_SIZE] = {0}; + + message ("uwatec_memomouse_open\n"); + int rc = uwatec_memomouse_open (&device, name); + if (rc != UWATEC_SUCCESS) { + WARNING ("Error opening serial port."); + return rc; + } + + message ("uwatec_memomouse_read\n"); + rc = uwatec_memomouse_read (device, data, sizeof (data)); + if (rc != UWATEC_SUCCESS) { + WARNING ("Cannot read memory."); + uwatec_memomouse_close (device); + return rc; + } + + message ("Dumping data\n"); + FILE* fp = fopen (filename, "wb"); + if (fp != NULL) { + fwrite (data, sizeof (unsigned char), sizeof (data), fp); + fclose (fp); + } + + message ("uwatec_memomouse_close\n"); + rc = uwatec_memomouse_close (device); + if (rc != UWATEC_SUCCESS) { + WARNING ("Cannot close device."); + return rc; + } + + return UWATEC_SUCCESS; +} + + +const char* errmsg (int rc) +{ + switch (rc) { + case UWATEC_SUCCESS: + return "Success"; + case UWATEC_ERROR: + return "Generic error"; + case UWATEC_ERROR_IO: + return "Input/output error"; + case UWATEC_ERROR_MEMORY: + return "Memory error"; + case UWATEC_ERROR_PROTOCOL: + return "Protocol error"; + case UWATEC_ERROR_TIMEOUT: + return "Timeout"; + default: + return "Unknown error"; + } +} + + +int main(int argc, char *argv[]) +{ + message_set_logfile ("MEMOMOUSE.LOG"); + +#ifdef _WIN32 + const char* name = "COM1"; +#else + const char* name = "/dev/ttyS0"; +#endif + + if (argc > 1) { + name = argv[1]; + } + + int a = test_dump_memory (name, "MEMOMOUSE.DMP"); + + message ("\nSUMMARY\n"); + message ("-------\n"); + message ("test_dump_memory: %s\n", errmsg (a)); + + message_set_logfile (NULL); + + return 0; +}