csu3_am335x/EVSE/GPL/plc-utils.LNX.2.1.20/source/nvm/chknvm.c

/*====================================================================*
*
*   Copyright (c) 2013 Qualcomm Atheros, Inc.
*
*   All rights reserved.
*
*====================================================================*/

/*====================================================================*
 *   system header files;
 *--------------------------------------------------------------------*/

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <memory.h>
#include <fcntl.h>
#include <errno.h>

/*====================================================================*
 *   custom header files;
 *--------------------------------------------------------------------*/

#include "../tools/getoptv.h"
#include "../tools/memory.h"
#include "../tools/flags.h"
#include "../tools/error.h"
#include "../tools/files.h"
#include "../ram/sdram.h"
#include "../nvm/nvm.h"

/*====================================================================*
 *   custom source files;
 *--------------------------------------------------------------------*/

#ifndef MAKEFILE
#include "../tools/getoptv.c"
#include "../tools/putoptv.c"
#include "../tools/version.c"
#include "../tools/checksum32.c"
#include "../tools/fdchecksum32.c"
#include "../tools/strfbits.c"
#include "../tools/error.c"
#endif

#ifndef MAKEFILE
#include "../ram/sdrampeek.c"
#endif

#ifndef MAKEFILE
#include "../nvm/nvm.c"
#include "../nvm/nvmpeek.c"
#include "../nvm/lightning_nvm_peek.c"
#include "../nvm/panther_nvm_peek.c"
#include "../nvm/panther_nvm_manifest.c"
#include "../nvm/panther_nvm_revision.c"
#include "../nvm/fdmanifest.c"
#include "../nvm/fdrevision.c"
#endif

/*====================================================================*
 *   program constants;
 *--------------------------------------------------------------------*/

#define HARDWARE 0
#define SOFTWARE 1
#define VER 2
#define REV 3
#define BUILD 6
#define DATE 7

/*====================================================================*
 *
 *   unsigned string2vector (char ** vector, length, char * string, char c);
 *
 *   convert string to a vector and return vector count; split string
 *   on characer (c);
 *   
 *   Contributor(s):
 *	Charles Maier <cmaier@qca.qualcomm.com>
 *
 *--------------------------------------------------------------------*/

static unsigned string2vector (char ** vector, char * string, char c) 

{ 
	char ** origin = vector; 
	for (* vector++ = string; * string; string++) 
	{ 
		if (* string == c) 
		{ 
			* string++ = (char) (0); 
			* vector++ = string--; 
		} 
	} 
	* vector = (char *) (0); 
	return ((unsigned) (vector - origin)); 
} 

/*====================================================================*
 *
 *   void lightning_nvm_revision (signed fd, char const * filename, unsigned module, unsigned offset, flag_t flags);
 *
 *   Contributor(s):
 *	Charles Maier <cmaier@qca.qualcomm.com>
 *
 *--------------------------------------------------------------------*/

static void lightning_nvm_revision (signed fd, char const * filename, unsigned module, unsigned offset, flag_t flags) 

{ 
	char memory [512]; 
	read (fd, memory, sizeof (memory)); 
	lseek (fd, (off_t) (0) - sizeof (memory), SEEK_CUR); 
	if (_anyset (flags, NVM_REVISION)) 
	{ 
		if (_anyset (flags, NVM_VERBOSE)) 
		{ 
			printf ("%s (%d) ", filename, module); 
		} 
		if ((* memory > 0x20) && (* memory < 0x7F)) 
		{ 
			printf ("%s\n", memory); 
		} 
		else 
		{ 
			printf ("%s\n", memory +  offset); 
		} 
	} 
	if (_anyset (flags, NVM_IDENTITY)) 
	{ 
		char * vector [16]; 
		char buffer [256]; 
		if ((* memory > 0x20) && (* memory < 0x7f)) 
		{ 
			strncpy (buffer, memory, sizeof (buffer)); 
		} 
		else 
		{ 
			strncpy (buffer, memory +  offset, sizeof (buffer)); 
		} 
		string2vector (vector, buffer, '-'); 
		printf ("%s ", vector [HARDWARE]); 
		printf ("%04d ", atoi (vector [BUILD])); 
		printf ("%s ", vector [DATE]); 
		printf ("%s.", vector [VER]); 
		printf ("%s ", vector [REV]); 
		printf ("%s (%d)\n", filename, module); 
		return; 
	} 
	return; 
} 

/*====================================================================*
 *
 *   signed lightning_nvm_chain (signed fd, char const * filename, flag_t flags);
 *
 *   validate a legcy PLC firmware file; return 0 on success or -1 on
 *   error;
 *
 *   keep as little information as possible in memory; this slows 
 *   validation but minimizes the resources needed at runtime so 
 *   that resource requirements do not grow with file size; 
 *
 *   the checksum of the entire header, including header checksum, is
 *   always 0 for valid headers; similarly, the checksum of the module
 *   and module checksum is always 0 for valid modules;
 *
 *   
 *   Contributor(s):
 *	Charles Maier <cmaier@qca.qualcomm.com>
 *
 *--------------------------------------------------------------------*/

static signed lightning_nvm_chain (signed fd, char const * filename, flag_t flags) 

{ 
	struct lightning_nvm_header header; 
	struct config_ram config_ram; 
	unsigned module = 0; 
	do 
	{ 
		if (read (fd, & header, sizeof (header)) != sizeof (header)) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_CANTREAD, filename, module); 
			} 
			return (- 1); 
		} 
		if (LE32TOH (header.HEADERVERSION) != 0x60000000) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_VERSION, filename, module); 
			} 
			return (- 1); 
		} 
		if (checksum32 (& header, sizeof (header), 0)) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_CHECKSUM, filename, module); 
			} 
			return (- 1); 
		} 
		if (_anyset (flags, NVM_VERBOSE)) 
		{ 
			printf ("------- %s (%d) -------\n", filename, module); 
			lightning_nvm_peek (& header); 
		} 
		if (header.HEADERMINORVERSION) 
		{ 
			if (LE32TOH (header.IMAGETYPE) == NVM_IMAGE_CONFIG_SYNOPSIS) 
			{ 
				if (_anyset (flags, NVM_SDRAM)) 
				{ 
					printf ("------- %s (%d) -------\n", filename, module); 
					read (fd, & config_ram, sizeof (config_ram)); 
					lseek (fd, (off_t) (0) - sizeof (config_ram), SEEK_CUR); 
					sdrampeek (& config_ram); 
				} 
			} 
			else if (LE32TOH (header.IMAGETYPE) == NVM_IMAGE_FIRMWARE) 
			{ 
				lightning_nvm_revision (fd, filename, module, 0x70, flags); 
			} 
		} 
		else if (! module) 
		{ 
			if (_anyset (flags, NVM_SDRAM)) 
			{ 
				printf ("------- %s (%d) -------\n", filename, module); 
				read (fd, & config_ram, sizeof (config_ram)); 
				lseek (fd, (off_t) (0) - sizeof (config_ram), SEEK_CUR); 
				sdrampeek (& config_ram); 
			} 
		} 
		else if (! header.NEXTHEADER) 
		{ 
			lightning_nvm_revision (fd, filename, module, 0x00, flags); 
		} 
		if (fdchecksum32 (fd, LE32TOH (header.IMAGELENGTH), header.IMAGECHECKSUM)) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_IMG_CHECKSUM, filename, module); 
			} 
			return (- 1); 
		} 
		module++; 
	} 
	while (header.NEXTHEADER); 
	if (lseek (fd, 0, SEEK_CUR) != lseek (fd, 0, SEEK_END)) 
	{ 
		if (_allclr (flags, NVM_SILENCE)) 
		{ 
			error (0, errno, NVM_HDR_LINK, filename, module); 
		} 
		return (- 1); 
	} 
	return (0); 
} 

/*====================================================================*
 *
 *   signed panther_nvm_chain (signed fd, char const * filename, flag_t flags);
 *
 *   validate a PLC image file; return 0 on success or -1 on error;
 *
 *   keep as little information as possible in memory; this slows 
 *   validation but minimizes the resources needed at runtime so 
 *   that resource requirements do not grow with file size;
 *
 *   the checksum of the entire header, including header checksum, is
 *   always 0 for valid headers; similarly, the checksum of the module
 *   and module checksum is always 0 for valid modules;
 *
 *   
 *   Contributor(s):
 *	Charles Maier <cmaier@qca.qualcomm.com>
 *
 *--------------------------------------------------------------------*/

static signed panther_nvm_chain (signed fd, char const * filename, flag_t flags) 

{ 
	struct panther_nvm_header header; 
	unsigned module = 0; 
	uint32_t origin = ~ 0; 
	uint32_t offset = 0; 
	do 
	{ 
		if (read (fd, & header, sizeof (header)) != sizeof (header)) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_CANTREAD, filename, module); 
			} 
			return (- 1); 
		} 
		if (LE16TOH (header.MajorVersion) != 1) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_VERSION, filename, module); 
			} 
			return (- 1); 
		} 
		if (LE16TOH (header.MinorVersion) != 1) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_VERSION, filename, module); 
			} 
			return (- 1); 
		} 
		if (checksum32 (& header, sizeof (header), 0)) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_CHECKSUM, filename, module); 
			} 
			return (- 1); 
		} 
		if (LE32TOH (header.PrevHeader) != origin) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_HDR_LINK, filename, module); 
			} 
			return (- 1); 
		} 
		if (_anyset (flags, NVM_VERBOSE)) 
		{ 
			printf ("------- %s (%d) -------\n", filename, module); 
			panther_nvm_peek (& header); 
		} 
		if (LE32TOH (header.ImageType) == NVM_IMAGE_MANIFEST) 
		{ 
			if (_anyset (flags, NVM_MANIFEST)) 
			{ 
				printf ("------- %s (%d) -------\n", filename, module); 
				fdmanifest (fd, filename, & header); 
				return (0); 
			} 
			if (_anyset (flags, NVM_REVISION)) 
			{ 
				fdrevision (fd, filename, & header); 
				return (0); 
			} 
		} 
		if (fdchecksum32 (fd, LE32TOH (header.ImageLength), header.ImageChecksum)) 
		{ 
			if (_allclr (flags, NVM_SILENCE)) 
			{ 
				error (0, errno, NVM_IMG_CHECKSUM, filename, module); 
			} 
			return (- 1); 
		} 
		origin = offset; 
		offset = LE32TOH (header.NextHeader); 
		module++; 
	} 
	while (~ header.NextHeader);
#if 0
	if (lseek (fd, 0, SEEK_CUR) != lseek (fd, 0, SEEK_END)) 
	{ 
		if (_allclr (flags, NVM_SILENCE)) 
		{ 
			error (0, errno, NVM_HDR_LINK, filename, module); 
		} 
		return (- 1); 
	}
#endif
    
	return (0); 
} 

/*====================================================================*
 *
 *   signed chknvm (char const * filename, flag_t flags);
 *
 *   validate a PLC firmware module file; keep as little information 
 *   as possible in memory; this slows validation but minimizes the 
 *   resources needed at runtime; resource requirements do not grow
 *   with file size;
 *
 *   determine file format based on module header version then rewind
 *   the file and call the appropriate chknvm; 
 *
 *   
 *   Contributor(s):
 *	Charles Maier <cmaier@qca.qualcomm.com>
 *
 *--------------------------------------------------------------------*/

static signed chknvm (char const * filename, flag_t flags) 

{ 
	uint32_t version; 
	signed status; 
	signed fd; 
	if ((fd = open (filename, O_BINARY | O_RDONLY)) == - 1) 
	{ 
		if (_allclr (flags, NVM_SILENCE)) 
		{ 
			error (0, errno, FILE_CANTOPEN, filename); 
		} 
		return (- 1); 
	} 
	if (read (fd, & version, sizeof (version)) != sizeof (version)) 
	{ 
		if (_allclr (flags, NVM_SILENCE)) 
		{ 
			error (0, errno, FILE_CANTREAD, filename); 
		} 
		return (- 1); 
	} 
	if (lseek (fd, 0, SEEK_SET)) 
	{ 
		if (_allclr (flags, NVM_SILENCE)) 
		{ 
			error (0, errno, FILE_CANTHOME, filename); 
		} 
		return (- 1); 
	} 
	if (LE32TOH (version) == 0x60000000) 
	{ 
		status = lightning_nvm_chain (fd, filename, flags); 
	} 
	else 
	{ 
		status = panther_nvm_chain (fd, filename, flags); 
	} 
	close (fd); 
	return (status); 
} 

/*====================================================================*
 *   
 *   int main (int argc, char const * argv []);
 *
 *   validate a PLC firmware image file; keep as little information 
 *   as possible in memory; this slows validation but minimizes the 
 *   resources needed at runtime; resource requirements do not grow
 *   with file size;
 *
 *   
 *   Contributor(s):
 *	Charles Maier <cmaier@qca.qualcomm.com>
 *
 *--------------------------------------------------------------------*/

int main (int argc, char const * argv []) 

{ 
	static char const * optv [] = 
	{ 
		"imqrsv", 
		"file [file] [...]", 
		"Qualcomm Atheros PLC Image File Validator", 
		"i\tprint firmware identity string", 
		"m\tdisplay manifest", 
		"q\tsuppress messages", 
		"r\tprint firmware revision string", 
		"s\tprint SDRAM configuration blocks", 
		"v\tverbose messages", 
		(char const *) (0)
	}; 
	signed state = 0; 
	flag_t flags = (flag_t) (0); 
	signed c; 
	optind = 1; 
	while (~ (c = getoptv (argc, argv, optv))) 
	{ 
		switch ((char) (c)) 
		{ 
		case 'i': 
			_setbits (flags, NVM_IDENTITY); 
			break; 
		case 'r': 
			_setbits (flags, NVM_REVISION); 
			break; 
		case 'm': 
			_setbits (flags, NVM_MANIFEST); 
			break; 
		case 's': 
			_setbits (flags, NVM_SDRAM); 
			break; 
		case 'q': 
			_setbits (flags, NVM_SILENCE); 
			break; 
		case 'v': 
			_setbits (flags, NVM_VERBOSE); 
			break; 
		default: 
			break; 
		} 
	} 
	argc -= optind; 
	argv += optind; 
	while ((argc) && (* argv)) 
	{ 
		if (chknvm (* argv, flags)) 
		{ 
			state = 1; 
		} 
		else if (_allclr (flags, (NVM_VERBOSE | NVM_SILENCE | NVM_MANIFEST | NVM_REVISION | NVM_IDENTITY | NVM_SDRAM))) 
		{ 
			printf ("file %s looks good\n", * argv); 
		} 
		argc--; 
		argv++; 
	} 
	return (state); 
}