timing.cli.master Namespace Reference

Functions
	master (obj, device)
	status (obj)
	synctime (obj, source)
	sendcmd (obj, cmd, chan, n)
	faketriggen (obj, cmd, chan, rate, poisson)
	faketrigclear (obj, chan)
	writeeptreg (obj, adr, reg, data, mode)
	readeptreg (obj, adr, reg, length, mode)
	transmitasyncpacket (obj, packet)
	resetcommandcounters (obj)
	controltimestampbroadcast (obj, on)
	partition (obj)
	partstatus (obj, watch, period)
	configure (obj)
	configureendpointcmddecoder (obj, addr, slot, cmd)

Function Documentation

configure()

timing.cli.master.configure

(

obj

)

Definition at line 285 of file master.py.

def configure(obj):
    pass
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('configure-endpoint-cmd-decoder', short_help='Configure a slot of endpoint command decoder.')
@click.pass_obj
@click.argument('addr', type=toolbox.IntRange(0x0,0xffff))
@click.argument('slot', type=toolbox.IntRange(0x0,0x7))
@click.argument('cmd', type=toolbox.IntRange(0x0,0xff))

configureendpointcmddecoder()

timing.cli.master.configureendpointcmddecoder	(		obj,
			addr,
			slot,
			cmd )

Configure endpoint command decoder

Definition at line 295 of file master.py.

def configureendpointcmddecoder(obj, addr, slot, cmd):
    '''
    Configure endpoint command decoder
    '''
 
    lMaster = obj.mMaster
    lMaster.configure_endpoint_command_decoder(addr,slot,cmd)
# ------------------------------------------------------------------------------

controltimestampbroadcast()

timing.cli.master.controltimestampbroadcast	(		obj,
			on )

Enable or disable timestamp broadcast

Definition at line 246 of file master.py.

def controltimestampbroadcast(obj, on):
    '''
    Enable or disable timestamp broadcast
    '''
    lMaster = obj.mMaster
    if on:
        lMaster.enable_timestamp_broadcast()
    else:
        lMaster.disable_timestamp_broadcast()
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.group('part', invoke_without_command=True)
@click.pass_obj

faketrigclear()

timing.cli.master.faketrigclear	(		obj,
			chan )

Clear the internal trigger generator.

Definition at line 172 of file master.py.

def faketrigclear(obj, chan):
    '''
    Clear the internal trigger generator.
    '''
    lMaster = obj.mMaster
    lMaster.disable_periodic_fl_cmd(chan)
    secho( "Fake triggers disabled; chan: {}".format(chan), fg='green')
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('write-ept-reg')
@click.pass_obj
@click.argument('adr', type=toolbox.IntRange(0x0,0xffff))
@click.argument('reg', type=toolbox.IntRange(0x0,0x7b))
@click.argument('data', callback=toolbox.split_ints)
@click.argument('mode', type=bool)

faketriggen()

timing.cli.master.faketriggen	(		obj,
			cmd,
			chan,
			rate,
			poisson )

\b
Enables the internal trigger generator.
Configures the internal command generator to produce triggers at a defined frequency.

Rate =  (50MHz / 2^(d+8)) / p where n in [0,15] and p in [1,256]
\b
DIVIDER (int): Frequency divider.

Definition at line 148 of file master.py.

def faketriggen(obj, cmd, chan, rate, poisson):
    '''
    \b
    Enables the internal trigger generator.
    Configures the internal command generator to produce triggers at a defined frequency.
    
    Rate =  (50MHz / 2^(d+8)) / p where n in [0,15] and p in [1,256]
    \b
    DIVIDER (int): Frequency divider.
    '''
 
    # The division from 50MHz to the desired rate is done in three steps:
    # a) A pre-division by 256
    # b) Division by a power of two set by n = 2 ^ rate_div_d (ranging from 2^0 -> 2^15)
    # c) 1-in-n prescaling set by n = rate_div_p
 
    lTopDesign = obj.mTopDesign
    lTopDesign.enable_periodic_fl_cmd(cmd,chan,rate,poisson)
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('faketrig-clear')
@click.pass_obj
@click.argument('chan', type=int)

master()

timing.cli.master.master	(		obj,
			device )

Timing master commands.

DEVICE: uhal device identifier

Definition at line 41 of file master.py.

def master(obj, device):
    '''
    Timing master commands.
 
    DEVICE: uhal device identifier
    '''
    lDevice = obj.mConnectionManager.getDevice(str(device))
    if obj.mTimeout:
        lDevice.setTimeoutPeriod(obj.mTimeout)
        
    echo('Created device ' + click.style(lDevice.id(), fg='blue'))
 
    lTopDesign = lDevice.getNode('')
    
    lMaster = lDevice.getNode('master')    
    lBoardInfo = toolbox.readSubNodes(lDevice.getNode('io.config'), False)
    lNCmdchannels = lMaster.getNode('global.config.n_chan').read()
    lDevice.dispatch()
 
    echo("Design '{}' on board '{}' on carrier '{}' with frequency {} MHz".format(
        style(kDesignNameMap[lBoardInfo['design_type'].value()], fg='blue'),
        style(kBoardNameMap[lBoardInfo['board_type'].value()], fg='blue'),
        style(kCarrierNameMap[lBoardInfo['carrier_type'].value()], fg='blue'),
        style(str(lBoardInfo['clock_frequency'].value()/1e6), fg='blue')
    ))
 
    if lBoardInfo['board_type'].value() in kLibrarySupportedBoards and lBoardInfo['design_type'].value() in kLibrarySupportedDesigns:
        lVersion = lTopDesign.read_firmware_version()
        lTopDesign.validate_firmware_version()
 
        try:
            echo(lDevice.getNode('io').get_hardware_info())
        except:
            secho("Failed to retrieve hardware information! I2C issue? Initial board reset needed?", fg='yellow')
            e = sys.exc_info()[0]
            secho("Error: {}".format(e), fg='red')
    else:
        lVersion = lMaster.getNode('global.version').read()
        lDevice.dispatch()
 
    echo("Master FW rev: {}, channels: {}".format(
        style(format_firmware_version(lVersion), fg='cyan'),
        style(str(lNCmdchannels), fg='cyan'),
    ))
 
    obj.mDevice = lDevice
    obj.mTopDesign = lTopDesign
    obj.mMaster = lMaster
    obj.mIO = lDevice.getNode('io')
 
    obj.mVersion = lVersion
    obj.mBoardType = lBoardInfo['board_type'].value()
    obj.mCarrierType = lBoardInfo['carrier_type'].value()
    obj.mDesignType = lBoardInfo['design_type'].value()
 
    # only overlord has ext trig ept
    if obj.mDesignType == kDesignOverlord:
        obj.mExtTrig = obj.mTopDesign.get_external_triggers_endpoint_node()
    
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('status', short_help="Print master status")
@click.pass_obj

partition()

timing.cli.master.partition

(

obj

)

Partition specific commands

Definition at line 260 of file master.py.

def partition(obj):
    """
    Partition specific commands
    """
    secho("New partition concept not yet supported", fg='yellow')
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@partition.command('status', short_help='Display the status of the timing master.')
@click.pass_obj
@click.option('--watch', '-w', is_flag=True, default=False, help='Turn on automatic refresh')
@click.option('--period','-p', type=click.IntRange(0, 10), default=2, help='Automatic refresh period')

partstatus()

timing.cli.master.partstatus	(		obj,
			watch,
			period )

Display the master status, accepted and rejected command counters

Definition at line 273 of file master.py.

def partstatus(obj, watch, period):
    '''
    Display the master status, accepted and rejected command counters
    '''
 
    # lDevice = obj.mDevice
    pass
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@partition.command('configure', short_help='Prepares partition for data taking.')
@click.pass_obj

readeptreg()

timing.cli.master.readeptreg	(		obj,
			adr,
			reg,
			length,
			mode )

Read data from endpoint

Definition at line 204 of file master.py.

def readeptreg(obj, adr, reg, length, mode):
    '''
    Read data from endpoint
    '''
    lMaster = obj.mMaster
    rx_data = lMaster.read_endpoint_data(adr, reg, length, mode)
    secho( f"Data from endpoint {adr}, reg {reg} and length {length}: {rx_data}", fg='green')
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('transmit-async-packet')
@click.pass_obj
@click.option('--packet', '-p', callback=toolbox.split_ints)

resetcommandcounters()

timing.cli.master.resetcommandcounters

(

obj

)

Transmit already formed packet

Definition at line 234 of file master.py.

def resetcommandcounters(obj):
    '''
    Transmit already formed packet
    '''
    lMaster = obj.mMaster
    lMaster.reset_command_counters()
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('control-timestamp-broadcast')
@click.option('--on/--off', default=True, help='enable/disable ts broadcast')
@click.pass_obj

sendcmd()

timing.cli.master.sendcmd	(		obj,
			cmd,
			chan,
			n )

Inject a single command.

Definition at line 132 of file master.py.

def sendcmd(obj, cmd, chan, n):
    '''
    Inject a single command.
    '''
 
    lMaster = obj.mMaster
    lMaster.send_fl_cmd(cmd,chan,n)
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('faketrig-conf')
@click.pass_obj
@click.argument('cmd', type=toolbox.IntRange(0x0,0xff))
@click.argument('chan', type=int)
@click.argument('rate', type=float)
@click.option('--poisson', is_flag=True, default=False, help="Randomize time interval between consecutive triggers.")

status()

timing.cli.master.status

(

obj

)

Definition at line 105 of file master.py.

def status(obj):
    
    lMaster = obj.mMaster
    lIO = obj.mIO
    firmware_clock_frequency_hz = lIO.read_firmware_frequency()
 
    echo(lMaster.get_status_with_date(firmware_clock_frequency_hz))
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('synctime', help="Sync timestamp, and enable broadcast. kMixed: TS value from SW, strobe from external")
@click.pass_obj
@click.argument('source', type=click.Choice(TimestampSource.__members__.keys()))

synctime()

timing.cli.master.synctime	(		obj,
			source )

Definition at line 118 of file master.py.

def synctime(obj, source):
 
    lDesign = obj.mTopDesign
    lMaster = obj.mMaster
    lSource=TimestampSource.__members__[source]
    lMaster.sync_timestamp(lSource)
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('send-cmd', short_help='Inject a single command.')
@click.pass_obj
@click.argument('cmd', type=toolbox.IntRange(0x0,0xff))
@click.argument('chan', type=int)
@click.option('-n', type=int, default=1)

transmitasyncpacket()

timing.cli.master.transmitasyncpacket	(		obj,
			packet )

Transmit already formed packet

Definition at line 217 of file master.py.

def transmitasyncpacket(obj, packet):
    '''
    Transmit already formed packet
    '''
    lMaster = obj.mMaster
    if len(packet) == 0:
        # make a random packet
        packet = [0x0, 0x0] + random.sample(range(256),random.randint(5, 20)) + [0x1aa]
    
    rx_packet = lMaster.transmit_async_packet(packet)
    secho( f"tx packet: {packet}", fg='green')
    secho( f"rx packet: {rx_packet}", fg='green')
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('reset-command-counters')
@click.pass_obj

writeeptreg()

timing.cli.master.writeeptreg	(		obj,
			adr,
			reg,
			data,
			mode )

Write data from endpoint

Definition at line 188 of file master.py.

def writeeptreg(obj, adr, reg, data, mode):
    '''
    Write data from endpoint
    '''
    lMaster = obj.mMaster
    rx_data = lMaster.write_endpoint_data(adr, reg, data, mode)
    #secho( "Fake triggers disabled; chan: {}".format(chan), fg='green')
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@master.command('read-ept-reg')
@click.pass_obj
@click.argument('adr', type=toolbox.IntRange(0x0,0xffff))
@click.argument('reg', type=toolbox.IntRange(0x0,0x7b))
@click.argument('length', type=int)
@click.argument('mode', type=bool)