tools/marvell/bin_hdr/platform/utils/setparams.c

/*******************************************************************************
Copyright (C) Marvell International Ltd. and its affiliates

This software file (the "File") is owned and distributed by Marvell
International Ltd. and/or its affiliates ("Marvell") under the following
alternative licensing terms.  Once you have made an election to distribute the
File under one of the following license alternatives, please (i) delete this
introductory statement regarding license alternatives, (ii) delete the two
license alternatives that you have not elected to use and (iii) preserve the
Marvell copyright notice above.

********************************************************************************
Marvell Commercial License Option

If you received this File from Marvell and you have entered into a commercial
license agreement (a "Commercial License") with Marvell, the File is licensed
to you under the terms of the applicable Commercial License.

********************************************************************************
Marvell GPL License Option

If you received this File from Marvell, you may opt to use, redistribute and/or
modify this File in accordance with the terms and conditions of the General
Public License Version 2, June 1991 (the "GPL License"), a copy of which is
available along with the File in the license.txt file or by writing to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or
on the worldwide web at http://www.gnu.org/licenses/gpl.txt.

THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
DISCLAIMED.  The GPL License provides additional details about this warranty
disclaimer.
********************************************************************************
Marvell BSD License Option

If you received this File from Marvell, you may opt to use, redistribute and/or
modify this File under the following licensing terms.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    *   Redistributions of source code must retain the above copyright notice,
	    this list of conditions and the following disclaimer.

    *   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.

    *   Neither the name of Marvell nor the names of its contributors may be
		used to endorse or promote products derived from this software without
		specific prior written permission.

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.

*******************************************************************************/

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "config_marvell.h"
#include "soc_spec.h"
#include "bootstrap_def.h"

#ifdef DEBUG
#define DB(x...)	printf(x)
#else
#define DB(x...)
#endif

/* Utility version */
#define VH	1
#define VL	0

#define  BUFSIZE	80

#ifndef ARRAY_SIZE
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
#endif

typedef struct _boardDef {
	char 	*bdName;
	char 	*memory;
	char 	*sections;
	MV_U32	memLen;

} boardDef;

static boardDef boards[] = {
	{ "gen",
		0,
			"\t. = %#08x;\n"
			"\t.text : { *(.text) }\n"
			"\t.data : { *(.data) }\n"
			"\t.bss : { *(.bss) }\n",
	},
	{ "a375_alp_zx",	/* Used for Zx revision */
		"\tram1 : ORIGIN = %#08x, LENGTH = %#x\n"
		"\tram2 : ORIGIN = 0x40008500, LENGTH = 0x47a0\n"
		"\tram3 : ORIGIN = 0x4000Cca0, LENGTH = 0x3780\n"
		"\tram4 : ORIGIN = 0x40010500, LENGTH = 0x8ac0\n",
			"\t. = %#08x;\n"
			"\t.text1 : {\n"
			"\t\tbin_entry.o (.text)\n"
			"\t\tddr3_hw_training*.o (.text)\n"
			"\t\tddr3_init*.o (.text)\n"
			"\t\tddr3_pbs*.o (.text)\n"
			"\t} > ram1 = 0x0\n\n"
			"\t.text3 : {\n"
			"\t\tmvHighSpeedEnvSpec*.o (.text)\n"
			"\t\tmv*.o (.text)\n"
			"\t} > ram3 = 0x0\n\n"
			"\t.text2 : {\n"
			"\t\t*.o (.text)\n"
			"\t} > ram4 = 0x0\n\n"
			"\t.data : {\n"
			"\t\t*(.data)\n"
			"\t} > ram2 = 0x0\n\n"
			"\t.bss : {\n"
			"\t\t*(.bss)\n"
			"\t} > ram2 = 0x0\n",
		0x8500
	},
	{ "tip_ld_100kb",
		"\tram1 : ORIGIN = %#08x, LENGTH = %#x\n"
		"\tram2 : ORIGIN = 0x40020000, LENGTH = 0x8000\n",
			"\t. = %#08x;\n"
			"\t.text1 : {\n"
			"\t\t*(.text)\n"
			"\t} > ram1 = 0x0\n\n"
			"\t.data : {\n"
			"\t\t*(.data)\n"
			"\t} > ram1 = 0x0\n\n"
			"\t.bss : {\n"
			"\t\t*(.bss)\n"
			"\t} > ram2 = 0x0\n",
		0x19000
	},
	{ "tip_ld_128kb",
		"\tram1 : ORIGIN = %#08x, LENGTH = %#x\n"
		"\tram2 : ORIGIN = 0x40020000, LENGTH = 0x8000\n",
			"\t. = %#08x;\n"
			"\t.text1 : {\n"
			"\t\t*(.text)\n"
			"\t} > ram1 = 0x0\n\n"
			"\t.data : {\n"
			"\t\t*(.data)\n"
			"\t} > ram1 = 0x0\n\n"
			"\t.bss : {\n"
			"\t\t*(.bss)\n"
			"\t} > ram2 = 0x0\n",
		0x20000
	},
};

void printusage(char *name)
{
	printf("Marvell utility for BIN header preparation (parameters and linker script). Version %d.%d:\n", VH, VL);
	printf("%s [options] <parameters output file name> <linker script output file name>\n", name);
	printf("Options:\n");
	printf("-S		Secure mode (secure header is included in the boot image)\n");
	printf("-R <reg file>	REG header is present and produced from \"reg file\" content\n");
	printf("-P <par file>	Text file with BIN header parameters. The text file contains\n");
	printf("		one parametes per line, up to 256 lines total. Each parameter is\n");
	printf("		a hexadecimal number in range of 0 to 2^32.\n");
	printf("-B <board_type>	The target board type. Supported bards: \n");
	printf("-		gen - generic board, used also if the requested board is not known\n");
	printf("-		alp  - Avanta LP.\n");
	printf("-		a375 - Armada 375.\n");
	printf("-		tip_ld_100k - TIP devices family which are limited to 100KB in SRAM.\n");
	printf("-		tip_ld_128k - TIP devices family which are limited to 128KB in SRAM.\n");
	printf("-d yes	Build the bin_hdr.elf using default linker.scr \n");
}

int main(int argc, char **argv)
{

	int		err = -1;
	int		secure = 0;
	char		buf[BUFSIZE];
	unsigned long	args[256] = {0};
	unsigned long	offset, argsnum = 0, reghdr_argsnum = 0;
	unsigned long	memalign;
	FILE		*f_outparm = NULL, *f_outlink = NULL;
	FILE		*f_reg = NULL, *f_param = NULL;
	char		*board_name = NULL;
	char		*temp_board_name = NULL;
	int 		optch; /* command-line option char */
	static char	optstring[] = "SR:P:B:d:";
	int		bIdx;
	int debug_mode_flag = 0;

	offset  = HDR_BLK_OFFSET;

	while ((optch = getopt(argc, argv, optstring)) != -1) {
		switch (optch) {
		case 'S': /* secure mode */
			secure = 1;
			break;

		case 'R': /* Register config file */
			f_reg = fopen(optarg, "r");
			if (f_reg == NULL) {
				printf("Error opening register config. file %s!\n", optarg);
				goto parse_error;
			}
			break;

		case 'P': /* Parameters file */
			f_param = fopen(optarg, "r");
			if (f_param == NULL) {
				printf("Error opening input parameters file %s!\n", optarg);
				goto parse_error;
			}
			break;

		case 'B': /* Board type */
			board_name = optarg;
			break;

		case 'd': /* Debug Mode */
			if(!strcmp(optarg,"yes")){
				debug_mode_flag = 1;
			}
			break;

		default:
			goto parse_error;
		}
	}

	printf("Building linker script for board %s", board_name);
#ifdef CONFIG_ALP_A375_ZX_REV
	board_name = "a375_alp_zx";
	printf("-Zx");
#endif

#if defined(TIP_BUILD_LD_100KB)
	/* build linker script for 100KB size limitation of bin header */
	temp_board_name = "tip_ld_100kb";
#elif defined(TIP_BUILD_LD_128KB)
	/* build linker script for 128KB size limitation of bin header */
	temp_board_name = "tip_ld_128kb";
#else
	/* build linker script for 'legacy' (DDR wise) devices
	   where there are not limitation on the image structure */
	temp_board_name = board_name;
#endif


	printf(", %s mode\n", secure == 1 ? "Secure" : "Non-secure");
	f_outparm = fopen(argv[optind], "w");
	if (f_outparm == NULL) {
		printf("Error opening output parameters file - %s!\n", argv[optind]);
		goto parse_error;
	}

	optind++;
	f_outlink = fopen(argv[optind], "w");
	if (f_outlink == NULL) {
		printf("Error opening output linker script file -- %s!\n", argv[optind]);
		goto parse_error;
	}

	/* Count number of REG header parameters */
	if (f_reg != NULL) {
		while (1) {
			int addr, val;

			if (fscanf(f_reg, "%x %x\n", (unsigned int *)&addr, (unsigned int *)&val) == EOF)
				break;
			else if ((addr == 0x0) && (val == 0x0))
				break;
			else
				reghdr_argsnum++;
		}
	}

	/* Count number of BIN header parameters */
	if (f_param != NULL) {
		while (fgets(buf, BUFSIZE-2, f_param) != NULL) {
			if (strncmp(buf, "0x", 2) != 0)
				continue;

			args[argsnum] = strtoul(buf, 0, 16);
			argsnum++;
		}
	}
	DB("Supplied %ld parameters in TXT file\n", argsnum);

	/* main and secure headers */
	offset += sizeof(BHR_t) + secure * sizeof(secExtBHR_t);
	/* register header */
	if (reghdr_argsnum != 0) {
		offset += EXT_HDR_BASE_SIZE + reghdr_argsnum * 8;
		DB("The REG configuration consists %ld (ADDR,VAL) pairs\n", reghdr_argsnum);
	}
	/* binary header - one additional word is for number of arguments field */
	offset += sizeof(headExtBHR_t) + 4 + argsnum * 4;
	DB("Offset before alignment is %#08lx \n", offset + RAM_TOP);

	/* The start address of executable code should be aligned to 128bit boundary using dumb arguments
	   Otherwise the linker will silently align it and the execution will start at the wrong place */
	memalign = offset & 0xF;
	if (memalign != 0) {
		argsnum += (0x10 - memalign) / 4;
		offset = (offset & 0xFFFFFFF0UL) + 0x10;
		DB("Code section aligned with %ld empty parameters added to BIN header\n", (0x10 - memalign) / 4);
	} else
		DB("No alignment is needed\n");

	/* Number of arguments field always presents in BIN header */
	fwrite(&argsnum, 4, 1, f_outparm);
	if (argsnum != 0)
		fwrite(args, 4, argsnum, f_outparm);

	/* Seek for the board in parameters array */
	for (bIdx = 0; bIdx < ARRAY_SIZE(boards); bIdx++) {
		if(debug_mode_flag == 1)
			break; /*Use generic linker.scr anyway*/
		if ((strcmp(boards[bIdx].bdName, temp_board_name) == 0) ||
		     /* alp should use the same parameters as a375 */
		    ((strcmp(boards[bIdx].bdName, "a375") == 0) && (strcmp(temp_board_name, "alp") == 0)))
			break;
	}
	/* Select generic linker script for unknown board */
	if (bIdx == ARRAY_SIZE(boards)) {
		DB("Board %s was not found in database, using generic script\n", board_name);
		bIdx = 0;
	}

	fprintf(f_outlink, "OUTPUT_FORMAT(\"elf32-littlearm\", \"elf32-bigarm\", \"elf32-littlearm\")\n");
	fprintf(f_outlink, "OUTPUT_ARCH(arm)\n\n");
	if (boards[bIdx].memory != 0) {
		fprintf(f_outlink, "MEMORY\n{\n");
		fprintf(f_outlink, boards[bIdx].memory, offset + RAM_TOP, boards[bIdx].memLen - offset);
		fprintf(f_outlink, "}\n");
	}
	fprintf(f_outlink, "SECTIONS\n{\n");
	fprintf(f_outlink, boards[bIdx].sections, offset + RAM_TOP);
	fprintf(f_outlink, "}\n");

	err = 0;

parse_error:
	if (f_reg)
		fclose(f_reg);
	if (f_param)
		fclose(f_param);
	if (f_outparm)
		fclose(f_outparm);
	if (f_outlink)
		fclose(f_outlink);
	if (err != 0)
		printusage(argv[0]);

	return err;
}