timing.cli.design Namespace Reference

Functions
	design (obj, device)
	status (obj)
	cdrswitch (obj, mux)
	cdrstatus (ctx, obj, id)
	cdrresync (ctx, obj, id)
	configure (obj, clock_source, ts_source, timebase)

Function Documentation

cdrresync()

timing.cli.design.cdrresync	(		ctx,
			obj,
			id )

Definition at line 131 of file design.py.

def cdrresync(ctx, obj, id):
 
    if id is None:
        cdr_node = obj.mDevice.getNode('cdr')
    else:
        cdr_node = obj.mDevice.getNode(f"cdr{id}")
 
    cdr_node.resync()
 
    time.sleep(0.5)
 
    ctx.forward(cdrstatus)
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@design.command('switch-timing-source-mux', short_help="switch timing source mux (no pll input re-config)")
@click.argument('source', type=int)
@click.pass_obj

cdrstatus()

timing.cli.design.cdrstatus	(		ctx,
			obj,
			id )

Definition at line 116 of file design.py.

def cdrstatus(ctx, obj, id):
 
    if id is None:
        cdr_node = obj.mDevice.getNode('cdr')
    else:
        cdr_node = obj.mDevice.getNode(f"cdr{id}")
 
    echo(cdr_node.get_status())
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@design.command('cdr-resync', short_help="Resync upstream CDR")
@click.option('--id', type=int)
@click.pass_obj
@click.pass_context

cdrswitch()

timing.cli.design.cdrswitch	(		obj,
			mux )

Definition at line 102 of file design.py.

def cdrswitch(obj, mux):
 
    lTopDesign = obj.mTopDesign
    lTopDesign.switch_mux(mux)
    active_mux=lTopDesign.read_active_mux()
 
    echo(f"cdr mux set to {active_mux}")
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@design.command('cdr-status', short_help="Print upstream CDR status")
@click.option('--id', type=int)
@click.pass_obj
@click.pass_context

configure()

timing.cli.design.configure	(		obj,
			clock_source,
			ts_source,
			timebase )

Definition at line 175 of file design.py.

def configure(obj, clock_source, ts_source, timebase):
 
    lTopDesign = obj.mTopDesign
    lDesignType = obj.mDesignType
    lDesignName=kDesignNameMap[lDesignType]
 
    # user convenience
    if clock_source is None:
        if lDesignType in [kDesignMaster, kDesignBoreas, kDesignOuroboros, kDesignOuroborosSim]:
            lClockSource=kFreeRun
            lTimestampSource=kSoftware
        elif lDesignType in [kDesignEndpoint, kDesignChronos, kDesignFanout]:
            lClockSource=kInput1
        elif lDesignType in [kDesignGaia, kDesignKerberos]:
            lClockSource=kInput0
            lTimestampSource=kUpstream
        else:
            secho("Unable to match a default clock source for design {}.\nConfigure failed!".format(lDesignName), fg='red')
            return
    else:
        lClockSource=ClockSource.__members__[clock_source]
 
    if ts_source is None:
        if lDesignType in [kDesignMaster, kDesignBoreas, kDesignOuroboros, kDesignOuroborosSim]:
            lTimestampSource=kSoftware
        elif lDesignType in [kDesignGaia, kDesignKerberos]:
            lTimestampSource=kUpstream
        elif lDesignType not in [kDesignEndpoint, kDesignChronos, kDesignFanout]:
            secho("Unable to match a default timestamp source for design {}.\nConfigure failed!".format(lDesignName), fg='red')
            return
    else:
        lTimestampSource=TimestampSource.__members__[ts_source]
 
    if lDesignType in [kDesignMaster, kDesignBoreas, kDesignGaia, kDesignKerberos]:
        if lDesignType == kDesignGaia:
            if timebase is not None:
                lTimebase=TimestampTimebase.__members__[timebase]
                lTopDesign.configure(lClockSource, lTimestampSource, lTimebase)
            else:
                secho("Supply ts timebase option for design Gaia!", fg='red')
        else:
            lTopDesign.configure(lClockSource, lTimestampSource)
    elif lDesignType in [kDesignEndpoint, kDesignChronos, kDesignFanout]:
        lTopDesign.configure(lClockSource)
    else:
        secho("Configure not supported for design {}.\nConfigure failed!".format(lDesignName), fg='red')
# ------------------------------------------------------------------------------

design()

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

Timing master commands.

DEVICE: uhal device identifier

Definition at line 42 of file design.py.

def design(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('')
    
    lBoardInfo = toolbox.readSubNodes(lDevice.getNode('io.config'), False)
    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')
 
    echo("FW rev: {}".format(
        style(format_firmware_version(lVersion), fg='cyan'),
    ))
 
    obj.mDevice = lDevice
    obj.mTopDesign = lTopDesign
 
    obj.mBoardType = lBoardInfo['board_type'].value()
    obj.mCarrierType = lBoardInfo['carrier_type'].value()
    obj.mDesignType = lBoardInfo['design_type'].value()    
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@design.command('status', short_help="Print master status")
@click.pass_obj

status()

timing.cli.design.status

(

obj

)

Definition at line 92 of file design.py.

def status(obj):
    
    lTopDesign = obj.mTopDesign
    echo(lTopDesign.get_status())
# ------------------------------------------------------------------------------
 
# ------------------------------------------------------------------------------
@design.command('cdr-switch', short_help="switch upstream CDR")
@click.argument('mux', type=int)
@click.pass_obj