main.c

/* siitool
 *
 * Simple program to print the values of the SII EEPROM content. It reads the
 * raw binaries.
 *
 * Frank Jeschke <fjeschke@synapticon.de>
 */

/*
 *       Copyright (c) 2013, Synapticon GmbH
 *       All rights reserved.
 *
 *       Redistribution and use in source and binary forms, with or without
 *       modification, are permitted provided that the following conditions are met:
 *
 *       1. Redistributions of source code must retain the above copyright notice, this
 *          list of conditions and the following disclaimer.
 *       2. Redistributions in binary form must reproduce the above copyright notice,
 *          this list of conditions and the following disclaimer in the documentation
 *          and/or other materials provided with the distribution.
 *       3. Execution of this software or parts of it exclusively takes place on hardware
 *          produced by Synapticon GmbH.
 *
 *       THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *       ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *       DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 *       ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *       (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *       LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 *       ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *       (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 *       SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *       The views and conclusions contained in the software and documentation are those
 *       of the authors and should not be interpreted as representing official policies,
 *       either expressed or implied, of the Synapticon GmbH.
 */

#include "sii.h"
#include "esi.h"
#include "esifile.h"

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <stdlib.h>
#include <errno.h>

#define MAX_BUFFER_SIZE    (2*1000*1000)
#define MAX_FILENAME_SIZE  (256)

enum eInputFileType {
	UNDEFINED = 0
	,ESIXML
	,SIIEEPROM
};

//static int g_print_offsets = 0;
static int g_print_content = 0;
static unsigned int g_add_pdo_mapping = 0;
static unsigned int g_add_dc_section = 0;

static const char *base(const char *prog)
{
	const char *p = prog;

	while (*p != '\0') {
		if (*p == '/')
			prog = ++p;
		else
			p++;
	}

	return prog;
}

static char *get_suffix(const char *filename)
{
	char *suffix = (char *)(filename+strlen(filename));

	while (suffix != filename) {
		if (*suffix == '.')
			return (suffix+1);

		suffix--;
	}

	return NULL; /* file doesn't have a valid suffix */
}

static enum eInputFileType check_file_suffix(const char *filename)
{
	enum eInputFileType type = UNDEFINED;

	char *suffix = get_suffix(filename);

	if (suffix == NULL)
		type = UNDEFINED;
	else {
		if (strncmp(suffix, "bin", strlen(suffix)) == 0)
			type = SIIEEPROM;
		else if (strncmp(suffix, "sii", strlen(suffix)) == 0)
			type = SIIEEPROM;
		else if (strncmp(suffix, "xml", strlen(suffix)) == 0)
			type = ESIXML;
		else {
			fprintf(stderr, "Warning, unrecognized suffix: '%s'\n", suffix);
			type = UNDEFINED;
		}
	}

	return type;
}

static enum eInputFileType check_first_bytes(unsigned char *buffer)
{
	enum eInputFileType type = UNDEFINED;
	unsigned char *head = buffer;

	if ((*(int *)head & 0xffffff) == 0xbfbbef) {
		head += 3;
	}

	if (strncmp((char *)head, "<?xml", 5) == 0)
		type = ESIXML;
	else
		type = SIIEEPROM; /* educated guess: if it's not XML it must be SII */

	return type;
}

static enum eInputFileType file_type(const char *filename, unsigned char *buffer)
{
	enum eInputFileType inputtype1 = UNDEFINED;
	if (filename != NULL)
		inputtype1 = check_file_suffix(filename);

	enum eInputFileType inputtype2 = UNDEFINED;
	inputtype2 = check_first_bytes(buffer);

	if (inputtype1 == UNDEFINED)
		return inputtype2;

	if ((inputtype1 == ESIXML) && (inputtype1 != inputtype2)) {
		fprintf(stderr, "Error, file suffix and content of file doesn't match!\n");
		return UNDEFINED;
	}

	return inputtype1;
}

static void printhelp(const char *prog)
{
	printf("Usage: %s [-h] [-v] [-p] [-o outfile] [filename]\n", prog);
	printf("  -h         print this help and exit\n");
	printf("  -v         print version an exit\n");
	printf("  -m         write pdo mapping to SII file\n");
	printf("  -c         write DC configuration to SII file\n");
	printf("  -o <name>  write output to file <name>\n");
	printf("  -p         print content human readable\n");
	printf("  -d <num>   select device number <num>, default <num> = 0\n");
	printf("  filename   path to eeprom file, if missing read from stdin\n");
	printf("\nRecognized file types: SII and ESI/XML.\n");
}

static unsigned char * read_input(FILE *f, unsigned char *bufptr, size_t *size)
{
	size_t capacity = *size;
	size_t count = 0;
	int input;
	unsigned char *buffer = NULL;

	if (bufptr == NULL) {
		buffer = malloc(capacity);
	}

	while ((input=fgetc(f)) != EOF) {
		buffer[count++] = (unsigned char)(input&0xff);

		if (count >= (capacity - 1)) {
			capacity += (capacity / 2);
			buffer = realloc(buffer, capacity);

			if (buffer == NULL) {
				fprintf(stderr, "Realloc failed! Out of memory?\n");
				*size = 0;
				return NULL;
			}
		}
	}

	/* Fill the last part of the buffer capacity with zero */
	memset((buffer+count), 0, capacity-count);
	*size = capacity;

	return buffer;
}

static int parse_xml_input(const unsigned char *buffer, size_t length, unsigned int device, const char *output)
{
	EsiData *esi = esi_init_string(buffer, length);
	//esi_print_xml(esi);

	int include_pdo_strings = g_add_pdo_mapping || g_print_content;
	if (esi_parse(esi, device, include_pdo_strings)) {
		fprintf(stderr, "Error something went wrong in XML parsing\n");
		esi_release(esi);
		return -1;
	}

	SiiInfo *sii = esi_get_sii(esi);
	sii_cat_sort(sii);
	if (g_print_content) {
		sii_print(sii);
	} else {
		sii_generate(sii, g_add_pdo_mapping, g_add_dc_section);
		int ret = sii_write_bin(sii, output);
		if (ret < 0) {
			fprintf(stderr, "Error, couldn't write output file\n");
			esi_release(esi);
			return -1;
		}

		printf("= %s generated\n", output);
	}

	esi_release(esi);

	return 0;
}

static int parse_sii_input(const unsigned char *buffer, const char *output)
{
	SiiInfo *sii = sii_init_string(buffer, 1024);
	//alternative: SiiInfo *sii = sii_init_file(filename) */

	if (g_print_content)
		sii_print(sii);
	else {
		sii_generate(sii, g_add_pdo_mapping, g_add_dc_section);
		int ret = sii_write_bin(sii, output);
		if (ret < 0) {
			fprintf(stderr, "Error, couldn't write output file\n");
			return -1;
		}

		printf("= %s generated\n", output);
	}

	sii_release(sii);

	return 0;
}

int main(int argc, char *argv[])
{
	FILE *f;
	unsigned char *eeprom = NULL;
	size_t eeprom_length = MAX_BUFFER_SIZE;
	char *filename = NULL;
	char *output = NULL;
	int ret = -1;
	unsigned int device = 0;

	/* FIXME rewrite using getopt() */
	for (int i=1; i<argc; i++) {
		switch (argv[i][0]) {
		case '-':
			if (argv[i][1] == 'h') {
				printhelp(base(argv[0]));
				return 0;
			} else if (argv[i][1] == 'v') {
				printf("%s %s\n",
					base(argv[0]),
					VERSION);
				return 0;
			} else if (argv[i][1] == 'o') {
				i++;
				output = malloc(strlen(argv[i])+1);
				memmove(output, argv[i], strlen(argv[i])+1);
			} else if (argv[i][1] == 'p') {
				g_print_content = 1;
			} else if (argv[i][1] == 'm') {
				g_add_pdo_mapping = 1;
			} else if (argv[i][1] == 'c') {
				g_add_dc_section = 1;
			} else if (argv[i][1] == 'd') {
				sscanf(argv[i+1], "%d", &device);
			} else if (argv[i][1] == '\0') { /* read from stdin (default) */
				filename = NULL;
			} else {
				fprintf(stderr, "Invalid argument\n");
				printhelp(base(argv[0]));
				return 0;
			}
			break;

		default:
			/* asuming file name */
			filename = argv[i];
			break;
		}
	}

	if (filename == NULL)
		eeprom = read_input(stdin, eeprom, &eeprom_length);
	else {
		f = fopen(filename, "r");
		if (f == NULL) {
			perror("Error open input file");
			ret = -1;
			goto finish;
		}

#if DEBUG == 1
		printf("Start reading contents of file %s\n", filename);
#endif

		eeprom = read_input(f, eeprom,  &eeprom_length);
		fclose(f);
	}

	if (eeprom == NULL) {
		goto finish;
	}

	/* recognize input */
	enum eInputFileType filetype = file_type(filename, eeprom);
	unsigned char *xml_start = eeprom;
	switch (filetype) {
	case ESIXML:
#if DEBUG == 1
		printf("Processing ESI/XML file\n");
#endif
		/* Start XML processing at the first '<' character to avoid strange behavior when parsing. */
		while (*xml_start != '<')
			xml_start++;

		ret = parse_xml_input(xml_start, eeprom_length, device, output);
		break;

	case SIIEEPROM:
#if DEBUG == 1
		printf("Processing SII/EEPROM file\n");
#endif
		ret = parse_sii_input(eeprom, output);
		break;

	case UNDEFINED:
	default:
		ret = -1;
		goto finish;
	}

finish:
	if (eeprom)
		free(eeprom);

	if (output)
		free(output);

	return ret;
}