"""
#    TOP2049 Open Source programming suite
#
#    Universal device tester
#
#    Copyright (c) 2010 Michael Buesch <mb@bu3sch.de>
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License along
#    with this program; if not, write to the Free Software Foundation, Inc.,
#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""

from chip import *


class Chip_Unitest(Chip):
	def __init__(self):
		Chip.__init__(self)

	def initializeChip(self):
		self.printDebug("Initializing chip")
		self.__reset()

	def shutdownChip(self):
		self.printDebug("Shutdown chip")
		self.__reset()

	def __reset(self):
		self.top.queueCommand("\x0E\x28\x00\x00")
		self.top.vccx.setLayoutPins( [] )
		self.vccxMask = 0
		self.top.vpp.setLayoutPins( [] )
		self.vppMask = 0
		self.top.gnd.setLayoutPins( [] )
		self.gndMask = 0
		self.top.cmdSetVCCXVoltage(5)
		self.top.cmdSetVPPVoltage(0)
		self.top.cmdSetVPPVoltage(5)
		self.oscMask = 0
		self.setOutputEnableMask(0)
		self.setOutputs(0)
		self.setOscMask(0)

	def setVCCX(self, voltage, layout):
		self.vccxMask = self.top.vccx.ID2mask(layout)
		self.__updateOutEn()
		self.top.cmdSetVCCXVoltage(0)
		self.top.cmdSetVCCXVoltage(voltage)
		self.top.vccx.setLayoutID(layout)
		self.top.flushCommands()

	def setVPP(self, voltage, layouts):
		self.vppMask = 0
		for layout in layouts:
			self.vppMask |= self.top.vpp.ID2mask(layout)
		self.__updateOutEn()
		self.top.cmdSetVPPVoltage(0)
		self.top.cmdSetVPPVoltage(voltage)
		self.top.vpp.setLayoutMask(0)
		for layout in layouts:
			self.top.vpp.setLayoutID(layout)
		self.top.flushCommands()

	def setGND(self, layout):
		self.gndMask = self.top.gnd.ID2mask(layout)
		self.__updateOutEn()
		self.top.gnd.setLayoutID(0)
		self.top.flushCommands()

	def __updateOutEn(self):
		mask = self.desiredOutEnMask
		mask &= ~self.gndMask
		mask &= ~self.vccxMask
		mask &= ~self.vppMask
		mask |= self.oscMask
		self.top.cmdFPGAWrite(0x50, mask & 0xFF)
		self.top.cmdFPGAWrite(0x51, (mask >> 8) & 0xFF)
		self.top.cmdFPGAWrite(0x52, (mask >> 16) & 0xFF)
		self.top.cmdFPGAWrite(0x53, (mask >> 24) & 0xFF)
		self.top.cmdFPGAWrite(0x54, (mask >> 32) & 0xFF)
		self.top.cmdFPGAWrite(0x55, (mask >> 40) & 0xFF)
		self.top.flushCommands()

	def setOutputEnableMask(self, mask):
		self.desiredOutEnMask = mask
		self.__updateOutEn()

	def __updateOut(self):
		mask = self.desiredOutMask
		mask &= ~self.oscMask
		self.top.cmdFPGAWrite(0x70, mask & 0xFF)
		self.top.cmdFPGAWrite(0x71, (mask >> 8) & 0xFF)
		self.top.cmdFPGAWrite(0x72, (mask >> 16) & 0xFF)
		self.top.cmdFPGAWrite(0x73, (mask >> 24) & 0xFF)
		self.top.cmdFPGAWrite(0x74, (mask >> 32) & 0xFF)
		self.top.cmdFPGAWrite(0x75, (mask >> 40) & 0xFF)
		self.top.flushCommands()

	def setOutputs(self, mask):
		self.desiredOutMask = mask
		self.__updateOut()

	def getInputs(self):
		self.top.cmdFPGAReadRaw(0x30)
		self.top.cmdFPGAReadRaw(0x31)
		self.top.cmdFPGAReadRaw(0x32)
		self.top.cmdFPGAReadRaw(0x33)
		self.top.cmdFPGAReadRaw(0x34)
		self.top.cmdFPGAReadRaw(0x35)
		inputs = self.top.cmdReadBufferReg48()
		return inputs

	def setOscDivider(self, div):
		self.top.cmdFPGAWrite(0x12, div & 0xFF)
		self.top.cmdFPGAWrite(0x13, (div >> 8) & 0xFF)
		self.top.cmdFPGAWrite(0x14, (div >> 16) & 0xFF)
		self.top.cmdFPGAWrite(0x15, (div >> 24) & 0xFF)
		self.top.flushCommands()

	def setOscMask(self, mask):
		self.oscMask = mask
		self.top.cmdFPGAWrite(0x30, mask & 0xFF)
		self.top.cmdFPGAWrite(0x31, (mask >> 8) & 0xFF)
		self.top.cmdFPGAWrite(0x32, (mask >> 16) & 0xFF)
		self.top.cmdFPGAWrite(0x33, (mask >> 24) & 0xFF)
		self.top.cmdFPGAWrite(0x34, (mask >> 32) & 0xFF)
		self.top.cmdFPGAWrite(0x35, (mask >> 40) & 0xFF)
		self.__updateOutEn()
		self.__updateOut()
		self.top.flushCommands()

ChipDescription(
	Chip_Unitest,
	bitfile = "unitest",
	runtimeID = (0x0008, 0x01),
	description = "Universal device tester",
	internal = True,
)