firmware_tools/utilities/seq.py
2018-05-08 15:05:50 +01:00

221 lines
No EOL
8.5 KiB
Python

import math
import xml.etree.ElementTree as ET
class genWavSeq :
# ---------------------------------------------------------------
# ---------------------------------------------------------------
def __init__ (self) :
self.SLEW_RATE_V_US = 50
self.TIME_UNIT_NS = 10
self.QUIESCENT_VOLTAGE = -2
self.V_AMP_N = -36
self.VEC_UP = '4'
self.VEC_DN = '5'
self.VEC_SET = '3'
self.TRIG_WAIT = '2'
self.TRIG_SEL_0 = '0'
self.VHDL_HEX_PREFIX = '32x'
self.index = 0
# ---------------------------------------------------------------
# ---------------------------------------------------------------
def calcNumSteps(self, voltChange, slewRate) :
basicSteps = (voltChange * (1000 / self.TIME_UNIT_NS)) / slewRate
stepsFloored = math.floor(basicSteps)
return stepsFloored
# ---------------------------------------------------------------
# ---------------------------------------------------------------
def calcDac(self, tgtVolts, quiesVolts, vAmpN) :
return int(round(16383.0 * ((tgtVolts + quiesVolts) - vAmpN)/40))
# ---------------------------------------------------------------
# ---------------------------------------------------------------
def calcStepSize (self, startVolts, endVolts) :
numSteps = self.calcNumSteps(abs(startVolts-endVolts), self.SLEW_RATE_V_US)
dacValNow = self.calcDac(startVolts, self.QUIESCENT_VOLTAGE, self.V_AMP_N)
dacValTgt = self.calcDac(endVolts, self.QUIESCENT_VOLTAGE, self.V_AMP_N)
dacDiff = abs(dacValNow - dacValTgt)
stepSize = int(math.floor(float(dacDiff) / float(numSteps)))
dacValTgtQuantDiff = dacDiff - (stepSize * numSteps)
return stepSize, numSteps, dacValTgtQuantDiff, dacValTgt
# ---------------------------------------------------------------
# ---------------------------------------------------------------
def vecSetStr(self, val, latch = False, all_on = False) :
val = val & ((1 << 14)-1)
if latch :
val = val + (1 << 15)
if all_on :
val = val + (1 << 16)
return self.VEC_SET + format(val, '07x')
# ---------------------------------------------------------------
# ---------------------------------------------------------------
def calcDelay(self, specVal, rampCycles, isHeadSeg = True) :
if isHeadSeg :
adjust = 9
else :
adjust = 17
segWait = specVal/self.TIME_UNIT_NS - rampCycles - adjust
return int(segWait) & 0xfff
# ---------------------------------------------------------------
# ---------------------------------------------------------------
def genPulse (self, headSegDly_ns, tailSegDly_ns, hiVolt, loVolt, isFirstPulse = False, isLastPulse = False) :
# --------------------
# Preliminaries
if isFirstPulse :
# Assume starting position is at the high voltage
startVolt = self.calcDac(hiVolt, self.QUIESCENT_VOLTAGE, self.V_AMP_N)
print(' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + '10000001", -- TRIG_MASK set mask for trigger 0 (clock ticks)'); self.index+=1
print(' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + format(startVolt + 0x30018000, '08x') + '", -- VEC_SET latch = 1, all_on = 1'); self.index+=1
print(' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + '00000000", -- NOP'); self.index+=1
print(' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + format(startVolt + 0x30000000, '08x') + '", -- VEC_SET latch = 0, all_on = 0'); self.index+=1
print(' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + '20000018", -- TRIG_WAIT : wait for 11 cycles for tDRIVE_HD = 105.3 + a bit'); self.index+=1
# --------------------
# Head segment
specDelay_ns = headSegDly_ns
stpSize, numSteps, remain, final = self.calcStepSize(hiVolt, loVolt)
rampDnStr = self.VHDL_HEX_PREFIX + '"' + self.VEC_DN + self.TRIG_SEL_0 + format(stpSize, '03x') + format(numSteps, '03x') + '", -- VEC_RAMP_UP'
vecFinalStr = self.VHDL_HEX_PREFIX + '"' + self.vecSetStr(final) + '", -- VEC_SET'
segWait = self.calcDelay(specDelay_ns, numSteps, True)
segWaitStr = self.VHDL_HEX_PREFIX + '"' + self.TRIG_WAIT + self.TRIG_SEL_0 + '000' + format(segWait, '03x') + '", -- TRIG_WAIT'
print (' ' + format(self.index, '02d') + ' => ' + rampDnStr); self.index+=1
print (' ' + format(self.index, '02d') + ' => ' + vecFinalStr); self.index+=1
print (' ' + format(self.index, '02d') + ' => ' + segWaitStr); self.index+=1
# --------------------
# Tail segment
specDelay_ns = tailSegDly_ns
stpSize, numSteps, remain, final = self.calcStepSize(loVolt, hiVolt)
rampUpStr = rampDnStr[:4] + self.VEC_UP + rampDnStr[5:-2] + 'DN'
vecFinalStr = self.VHDL_HEX_PREFIX + '"' + self.vecSetStr(final) + '", -- VEC_SET'
segWait = self.calcDelay(specDelay_ns, numSteps, False)
if isLastPulse :
segWait += 9
segWaitStr = self.VHDL_HEX_PREFIX + '"' + self.TRIG_WAIT + self.TRIG_SEL_0 + '000' + format(segWait, '03x') + '", -- TRIG_WAIT'
print (' ' + format(self.index, '02d') + ' => ' + rampUpStr); self.index+=1
print (' ' + format(self.index, '02d') + ' => ' + vecFinalStr); self.index+=1
print (' ' + format(self.index, '02d') + ' => ' + segWaitStr); self.index+=1
if isLastPulse :
print (' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + self.vecSetStr(final, False, True) + '", -- VEC_SET latch = 0 all_on = 1'); self.index+=1
print (' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + 'f0000000", -- END'); self.index+=1
else :
print (' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + self.vecSetStr(final, True, False) + '", -- VEC_SET latch = 1 all_on = 0'); self.index+=1
print (' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + '00000000", -- NOP'); self.index+=1
print (' ' + format(self.index, '02d') + ' => ' + self.VHDL_HEX_PREFIX + '"' + self.vecSetStr(final, False, False) + '", -- VEC_SET latch = 0 all_on = 0'); self.index+=1
# ###############################################################
# Only run if not imported
#
def printSeq(self, xmlFname) :
# Initialise variables
headSegDly_us = 0
headTgtVolt = 0
tailSegDly_us = 0
tailTgtVolt = 0
first = True
idx = 1
# Get XML definition
tree = ET.parse(xmlFname)
root = tree.getroot()
self.SLEW_RATE_V_US = float(root.attrib['SlewRate']);
auxDacValue = int(round((self.V_AMP_N - 0.9002)/-0.0627))
# Preliminaries
print('-- Slew rate = %.2f V/us' % self.SLEW_RATE_V_US)
print('-- Quiescent Voltage = %.2f V' % self.QUIESCENT_VOLTAGE)
print('-- V_AMP_N = %.2f V (aux DAC = %d)' % (self.V_AMP_N, auxDacValue))
print('-- CLK Frequency = %d MHz' % (1000 / self.TIME_UNIT_NS))
print('constant WSEQ_PATTERN1 : mem_t :=\n (')
# Find the pulse manager
for element in root :
if element.tag == 'PulseManager' :
# Loop through the pulses
for pulse in element :
# Loop through the pulse segments
for segment in pulse :
segDict = segment.attrib
if segDict['Name'] == 'Head segment' :
headSegDly_us = segDict['SegmentTime']
headTgtVolt = -1 * float(segDict['TargetVoltage'])
else :
tailSegDly_us = segDict['SegmentTime']
tailTgtVolt = -1 * float(segDict['TargetVoltage'])
headSegDly_ns = int(round(float(headSegDly_us) * 1000))
tailSegDly_ns = int(round(float(tailSegDly_us) * 1000))
self.genPulse(headSegDly_ns, tailSegDly_ns, tailTgtVolt, headTgtVolt, first, idx == len(element))
#print(headSegDly_ns, tailSegDly_ns, tailTgtVolt, headTgtVolt)
first = False
idx += 1
# Finish off
print(' others => 32x"0");')
# ###############################################################
# Only run if not imported
#
if __name__ == '__main__':
gw = genWavSeq()
gw.printSeq('wavespec.xml')