/*
 * Copyright (c) 2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 Texas Instruments Incorporated 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.
 *
 */

debugSessionDAP = ds.openSession("*","CS_DAP_DebugSS");
debugSessionDAP.target.connect();

/* Check ID_CODE register (address 0x4AE0C204) to determine which
   AM57xx variant is being used */
try {
	id_code = debugSessionDAP.memory.readWord(0,0x4AE0C204,false);
} catch(ex) {
	print("\n Trouble reading ID_CODE.\n");
}

print("ID_CODE = 0x" + d2h(id_code));

// Check STD_FUSE_ID_2 register (address 0x4AE0C20C) for package type
try {
	fuse_id_2 = debugSessionDAP.memory.readWord(0,0x4AE0C20C,false);
} catch(ex) {
	print("\n Trouble reading STD_FUSE_ID_2.\n");
}
pkg_type = (fuse_id_2 & 0x00030000) >> 16;  // FUSE_ID_2[17:16] = pkg_type

switch(id_code) {
	case 0x0B9BC02F:
		print("AM571x SR1.0 detected.\n");
		device_type = 571;
		break;
	case 0x1B9BC02F:
		if(pkg_type == 1) {
			print("AM570x SR2.0 detected.\n");
			device_type = 570;
		} else if(pkg_type == 2) {
			print("AM571x SR2.0 detected.\n");
			device_type = 571;
		} else
			print("AM571x/AM570x SR2.0 unrecognized package type\n")
		break;
	case 0x2B9BC02F:
		if(pkg_type == 1) {
			print("AM570x SR2.1 detected.\n");
			device_type = 570;
		} else if(pkg_type == 2) {
			print("AM571x SR2.1 detected.\n");
			device_type = 571;
		} else
			print("AM571x/AM570x SR2.1 unrecognized package type\n")
		break;
	case 0x0B99002F:
		print("AM572x SR1.0 detected.\n");
		device_type = 572;
		break;
	case 0x1B99002F:
		print("AM572x SR1.1 detected.\n");
		device_type = 572;
		break;
	case 0x2B99002F:
		print("AM572x SR2.0 detected.\n");
		device_type = 572;
		break;
	case 0x0BB5002F:
		print("AM574x SR1.0 detected.\n");
		device_type = 574;
		break;
	default:
		print("Unable to identify which AM57xx variant.\n");
		debugSessionDAP.target.disconnect();
		throw("Terminating script.\n")
		break;
}

//Build a filename that includes date/time
var today = new Date();
var year4digit = today.getFullYear();
var month2digit = ("0" + (today.getMonth()+1)).slice(-2);
var day2digit = ("0" + today.getDate()).slice(-2);
var hour2digit = ("0" + today.getHours()).slice(-2);
var minutes2digit = ("0" + today.getMinutes()).slice(-2);
var seconds2digit = ("0" + today.getSeconds()).slice(-2);
var filename_date = '_' + year4digit + '-' + month2digit + '-' + day2digit + '_' + hour2digit + minutes2digit + seconds2digit;
var userHomeFolder = System.getProperty("user.home");
var filename = userHomeFolder + '/Desktop/' + 'am57xx-ddr' + filename_date + '.txt';

file = new java.io.FileWriter(filename);

if (device_type == 570) {
	num_emifs = 1;
} else if (device_type == 571) {
	num_emifs = 1;
} else if (device_type == 572) {
	num_emifs = 2;
} else if (device_type == 574) {
	num_emifs = 2;
} else {
	throw("Error -- code shouldn't get here.")
}

// helper function to create 8-digit hex numbers in ascii format
function d2h(d) {return ("00000000" + (+d).toString(16)).slice(-8);}

var newline = "\n";

file.write("********************** EMIF1 **********************" + newline + newline);

// CTRL_CORE_CONTROL_DDRCACH1_0
reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRCACH1_0", 0x4A002E30);
file.write("ddr1_casn, ddr1_rasn, ddr1_rst, ddr1_wen, ddr1_csn[0], ddr1_cke, ddr1_odt[0]" + newline);
InterpretDdrByte(reg_val, 3, 0);
file.write("ddr1_a[15:0]" + newline);
InterpretDdrByte(reg_val, 2, 0);
file.write("ddr1_ba[0], ddr1_ba[1], ddr1_ba[2]" + newline);
InterpretDdrByte(reg_val, 1, 0);
file.write("ddr1_ck, ddr1_nck" + newline);
InterpretDdrByte(reg_val, 0, 1);
file.write(newline);

// CTRL_CORE_CONTROL_DDRCH1_0
reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRCH1_0", 0x4A002E38);
file.write("ddr1_d[7:0], ddr1_dqm[0]" + newline);
InterpretDdrByte(reg_val, 3, 0);
file.write("ddr1_dqs[0], ddr1_dqsn[0]" + newline);
InterpretDdrByte(reg_val, 2, 1);
file.write("ddr1_d[15:8], ddr1_dqm[1]" + newline);
InterpretDdrByte(reg_val, 1, 0);
file.write("ddr1_dqs[1], ddr1_dqsn[1]" + newline);
InterpretDdrByte(reg_val, 0, 1);
file.write(newline);

// CTRL_CORE_CONTROL_DDRCH1_1
reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRCH1_1", 0x4A002E3C);
file.write("ddr1_d[23:16], ddr1_dqm[2]" + newline);
InterpretDdrByte(reg_val, 3, 0);
file.write("ddr1_dqs[2], ddr1_dqsn[2]" + newline);
InterpretDdrByte(reg_val, 2, 1);
file.write("ddr1_d[31:24], ddr1_dqm[3]" + newline);
InterpretDdrByte(reg_val, 1, 0);
file.write("ddr1_dqs[3], ddr1_dqsn[3]" + newline);
InterpretDdrByte(reg_val, 0, 1);
file.write(newline);

// CTRL_CORE_CONTROL_DDRCH1_2
reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRCH1_2", 0x4A002E48);
file.write("ddr1_ecc_d[7:0], ddr1_dqm_ecc" + newline);
InterpretDdrByte(reg_val, 2, 0);
file.write("ddr1_dqs_ecc, ddr1_dqsn_ecc" + newline);
InterpretDdrByte(reg_val, 1, 1);
file.write(newline);

// CTRL_CORE_CONTROL_DDRIO_0
reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRIO_0", 0x4A002E50);
file.write("ddr1_d[7:0], ddr1_d[15:8]" + newline);
InterpretDdrVref(reg_val, 15);
file.write("ddr1_d[23:16], ddr1_d[31:24], ddr1_ecc_d[7:0]" + newline);
InterpretDdrVref(reg_val, 10);
file.write(newline);

// If EMIF1 clock is enabled, print the registers
reg_val = debugSessionDAP.memory.readWord(0,0x4A008B30,false);
reg_val = reg_val >> 16;  // Check IDLEST (bits 17:16)
if (reg_val == 3)
	file.write("EMIF1 is disabled." + newline);
else
	printEmifRegs(0x4C000000);

if (num_emifs == 2)
{
	file.write("********************** EMIF2 **********************" + newline + newline);

	// CTRL_CORE_CONTROL_DDRCACH2_0
	reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRCACH2_0", 0x4A002E34);
	file.write("ddr2_casn, ddr2_rasn, ddr2_rst, ddr2_wen, ddr2_csn[0], ddr2_cke, ddr2_odt[0]" + newline);
	InterpretDdrByte(reg_val, 3, 0);
	file.write("ddr2_a[15:0]" + newline);
	InterpretDdrByte(reg_val, 2, 0);
	file.write("ddr2_ba[0], ddr2_ba[1], ddr2_ba[2]" + newline);
	InterpretDdrByte(reg_val, 1, 0);
	file.write("ddr2_ck, ddr2_nck" + newline);
	InterpretDdrByte(reg_val, 0, 1);
	file.write(newline);

	// CTRL_CORE_CONTROL_DDRCH2_0
	reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRCH2_0", 0x4A002E40);
	file.write("ddr2_d[7:0], ddr2_dqm[0]" + newline);
	InterpretDdrByte(reg_val, 3, 0);
	file.write("ddr2_dqs[0], ddr2_dqsn[0]" + newline);
	InterpretDdrByte(reg_val, 2, 1);
	file.write("ddr2_d[15:8], ddr2_dqm[1]" + newline);
	InterpretDdrByte(reg_val, 1, 0);
	file.write("ddr2_dqs[1], ddr2_dqsn[1]" + newline);
	InterpretDdrByte(reg_val, 0, 1);
	file.write(newline);

	// CTRL_CORE_CONTROL_DDRCH2_1
	reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRCH2_1", 0x4A002E44);
	file.write("ddr2_d[23:16], ddr2_dqm[2]" + newline);
	InterpretDdrByte(reg_val, 3, 0);
	file.write("ddr2_dqs[2], ddr2_dqsn[2]" + newline);
	InterpretDdrByte(reg_val, 2, 1);
	file.write("ddr2_d[31:24], ddr2_dqm[3]" + newline);
	InterpretDdrByte(reg_val, 1, 0);
	file.write("ddr2_dqs[3], ddr2_dqsn[3]" + newline);
	InterpretDdrByte(reg_val, 0, 1);
	file.write(newline);

	// CTRL_CORE_CONTROL_DDRIO_1
	reg_val = printRegisterValue(debugSessionDAP, "CTRL_CORE_CONTROL_DDRIO_1", 0x4A002E54);
	file.write("ddr2_d[7:0], ddr2_d[15:8]" + newline);
	InterpretDdrVref(reg_val, 22);
	file.write("ddr2_d[23:16], ddr2_d[31:24]" + newline);
	InterpretDdrVref(reg_val, 17);
	file.write(newline);

	// If EMIF2 clock is enabled, print the registers
	reg_val = debugSessionDAP.memory.readWord(0,0x4A008B38,false);
	reg_val = reg_val >> 16;  // Check IDLEST (bits 17:16)
	if (reg_val == 3)
		file.write("EMIF2 is disabled." + newline);
	else
		printEmifRegs(0x4D000000);

}

print("Data collection complete.");

file.close();
debugSessionDAP.target.disconnect();
print("Created file " + filename);

/* value is the contents read from the register
   byte should be 0-3 where 0 is LSB and 3 is MSB
*/
function InterpretDdrByte(value, byte_num, is_differential)
{
	value = value >> (8*byte_num);
	value = value & 0xFF;

	weak_driver = value & 3;		// Bits 1:0
	slew_rate = (value >> 2) & 7;	// Bits 4:2
	impedance = (value >> 5) & 7;	// Bits 7:5

	if(is_differential)
	{
		switch (weak_driver) {
			case 0:
				file.write("  * Pull logic is disabled" + newline);
				break;
			case 1:
				file.write("  * Pull-up selected for padp, pull-down selected for padn" + newline);
				break;
			case 2:
				file.write("  * Pull-down selected for padp, pull-up selected for padn" + newline);
				break;
			case 3:
				file.write("  * Maintain the previous output value" + newline);
				break;
		}
	} else
	{
		switch (weak_driver) {
			case 0:
				file.write("  * Pull logic is disabled" + newline);
				break;
			case 1:
				file.write("  * Pull-up selected" + newline);
				break;
			case 2:
				file.write("  * Pull-down selected" + newline);
				break;
			case 3:
				file.write("  * Maintain the previous output value" + newline);
				break;
		}
	}
	file.write("  * Slew rate is " + slew_rate + ", where 0=fastest and 7=slowest" + newline);

		switch (impedance) {
		case 0:
			file.write("  * Output Impedance = 80 Ohms" + newline);
			break;
		case 1:
			file.write("  * Output Impedance = 60 Ohms" + newline);
			break;
		case 2:
			file.write("  * Output Impedance = 48 Ohms" + newline);
			break;
		case 3:
			file.write("  * Output Impedance = 40 Ohms" + newline);
			break;
		case 4:
			file.write("  * Output Impedance = 34 Ohms" + newline);
			break;
		default:
			file.write("  * Output Impedance = Reserved" + newline);
			break;
	}
}

function InterpretDdrVref(value, start_bit)
{
	value = value >> start_bit;
	value = value & 0x1F;

	if (value & 1)
	{
		file.write("  * Internal VREF enabled" + newline);
		if (value & 0x10) file.write("  * Capacitor between Vbias and ground" + newline);
		if (value & 0x08) file.write("  * Capacitor between Vbias and vdds_ddr" + newline);
		tap0 = (value >> 2) & 1;
		tap1 = (value >> 1) & 1;
		ddr_tap = (tap1 << 1) | tap0;

		switch(ddr_tap) {
			case 0:
				file.write("  * 2-uA VREF output drive capability" + newline);
				break;
			case 1:
				file.write("  * 4-uA VREF output drive capability" + newline);
				break;
			case 2:
				file.write("  * 8-uA VREF output drive capability" + newline);
				break;
			case 3:
				file.write("  * 32-uA VREF output drive capability" + newline);
				break;
		}
	}
	else
		file.write("  * Internal VREF disabled" + newline);
}

function printEmifRegs(baseaddr)
{
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_STATUS", baseaddr + 0x04);
	file.write(newline);

	reg_val = printRegisterValue(debugSessionDAP, "EMIF_SDRAM_CONFIG", baseaddr + 0x08);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_SDRAM_CONFIG_2", baseaddr + 0x0C);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_SDRAM_REFRESH_CONTROL", baseaddr + 0x10);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_SDRAM_TIMING_1", baseaddr + 0x18);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_SDRAM_TIMING_2", baseaddr + 0x20);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_SDRAM_TIMING_3", baseaddr + 0x28);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_READ_WRITE_LEVELING_RAMP_WINDOW", baseaddr + 0xD4);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_READ_WRITE_LEVELING_RAMP_CONTROL", baseaddr + 0xD8);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_READ_WRITE_LEVELING_CONTROL", baseaddr + 0xDC);
	reg_val = printRegisterValue(debugSessionDAP, "EMIF_DDR_PHY_CONTROL_1", baseaddr + 0xE4);

	file.write(newline);
}

function printRegisterValue(ds, name, addr)
{
	value = ds.memory.readWord(0,addr,false);
	value_string = d2h(value);
	file.write(name + " = 0x" + value_string + newline);
	return value; // return the register value for interrogation
}