timing.cli.align Namespace Reference

Functions
	align (obj)
	applydelay (ctx, obj, addr, cdelay, fdelay, mux, force)
	measuredelay (ctx, obj, addr, mux, sfp_control)
	toggletx (obj, addr, on)
	scanmux (obj)
	switchnlock (obj, mux)

Function Documentation

align()

timing.cli.align.align

(

obj

)

Definition at line 23 of file align.py.

def align(obj):
    lDevice = obj.mDevice
    lMaster = obj.mMaster
    obj.mGlobal = lMaster.getNode('global')
    #obj.mACmd = lMaster.getNode('acmd')
    #obj.mEcho = lMaster.getNode('echo')
    #bj.mIO = lDevice.getNode('io')
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@align.command('apply-delay', short_help="Send delay adjust command endpoint")
@click.argument('addr', type=toolbox.IntRange(0x0,0xffff))
@click.argument('cdelay', type=toolbox.IntRange(0x0,0xf))
@click.argument('fdelay', type=toolbox.IntRange(0x0,0xfff))
@click.option('--mux', '-m', type=click.IntRange(0,12), help='Mux select')
@click.option('--force', '-f', is_flag=True, default=False, help='Skip RTT measurement')
@click.pass_obj
@click.pass_context

applydelay()

timing.cli.align.applydelay	(		ctx,
			obj,
			addr,
			cdelay,
			fdelay,
			mux,
			force )

Definition at line 42 of file align.py.

def applydelay(ctx, obj, addr, cdelay, fdelay, mux, force):
 
    lDevice = obj.mDevice
    lBoardType = obj.mBoardType
    lTopDesign = obj.mTopDesign
 
    # Are we working with a board with a return path mux (i.e. a fanout board)?
    if lBoardType in [kBoardPC059, kBoardFIB]:
        if mux is None:
            if force == True:
                lTopDesign.apply_endpoint_delay(addr, cdelay, fdelay, 0, not force, True, 0)
            else:
                raise RuntimeError('MUX board: please supply an SFP mux channel')
        else:
            lTopDesign.apply_endpoint_delay(addr, cdelay, fdelay, 0, not force, True, mux)
            
    else:
        lTopDesign.apply_endpoint_delay(addr, cdelay, fdelay, 0, not force, True)
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@align.command('measure-delay', short_help="Measure endpoint round trip time")
@click.argument('addr', type=toolbox.IntRange(0x0,0xffff))
@click.option('--mux', '-m', type=click.IntRange(0,12), help='Mux select (fanout only)')
@click.option('--sfp-control/--no-sfp-control', default=True, help='Control SFP or not')
@click.pass_obj
@click.pass_context

measuredelay()

timing.cli.align.measuredelay	(		ctx,
			obj,
			addr,
			mux,
			sfp_control )

Definition at line 70 of file align.py.

def measuredelay(ctx, obj, addr, mux, sfp_control):
 
    lDevice = obj.mDevice
    lBoardType = obj.mBoardType
    lTopDesign = obj.mTopDesign
    
    # or a different type of fanout board
    if lBoardType in [kBoardPC059, kBoardFIB] and sfp_control == True:
        if mux is not None:
            echo("Endpoint (adr: {}, mux: {}) RTT: {}".format(addr,mux,lTopDesign.measure_endpoint_rtt(addr, sfp_control, mux)))
        else:
            raise RuntimeError('MUX board: please supply an SFP mux channel')
    else:
        echo("Endpoint (adr: {}) RTT: {}".format(addr,lTopDesign.measure_endpoint_rtt(addr, sfp_control)))
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@align.command('toggle-tx', short_help="Control the endpoint SFP Tx laser")
@click.argument('addr', type=toolbox.IntRange(0x0,0xffff))
@click.option('--on/--off', default=True, help='enable/disable tx')
@click.pass_obj

scanmux()

timing.cli.align.scanmux

(

obj

)

Definition at line 102 of file align.py.

def scanmux(obj):
 
    lDevice = obj.mDevice
    lTopDesign = obj.mTopDesign
    lBoardType = obj.mBoardType
 
    if lBoardType in [kBoardPC059, kBoardFIB]:
        lTopDesign.scan_sfp_mux()
    else:
        raise RuntimeError('Mux scan is only available on MUX boards')
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@align.command('switch-n-lock', short_help="Wait for RTT endpoint to become ready")
@click.option('--mux', '-m', type=click.IntRange(0,12), help='Mux select (fanout only)')
@click.pass_obj

switchnlock()

timing.cli.align.switchnlock	(		obj,
			mux )

Definition at line 119 of file align.py.

def switchnlock(obj, mux):
    
    lDevice = obj.mDevice
    lTopDesign = obj.mTopDesign
    lBoardType = obj.mBoardType
    lMaster = obj.mMaster
    
    # or a different type of fanout board
    if lBoardType in [kBoardPC059, kBoardFIB]: #TODO: don't include fib v2
        if mux is not None:
            lTopDesign.switch_mux(mux)
            lMaster.enable_upstream_endpoint()
        else:
            raise RuntimeError('MUX board: please supply an SFP mux channel')
    else:
        lMaster.enable_upstream_endpoint()
# ------------------------------------------------------------------------------

toggletx()

timing.cli.align.toggletx	(		obj,
			addr,
			on )

Definition at line 92 of file align.py.

def toggletx(obj, addr, on):
 
    lMaster = obj.mMaster
    lMaster.switch_endpoint_sfp(addr, on)
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@align.command('scan-mux', short_help="Scan SFP mux for transmitting SFPs")
@click.pass_obj