timing.cli.endpoint Namespace Reference

Functions
	endpoint (obj, id, device)
	freq (obj)
	enable (ctx, obj, action, address)
	status (obj, watch, period)
	readback (obj, readall)

Function Documentation

enable()

timing.cli.endpoint.enable	(		ctx,
			obj,
			action,
			address )

Activate timing endpoint wrapper block.

Definition at line 87 of file endpoint.py.

def enable(ctx, obj, action, address):
    '''
    Activate timing endpoint wrapper block.
    '''
 
    lEndPointNode = obj.mEndpoint
    if action == 'off':
        lEndPointNode.disable()
    elif action == 'on':
        lEndPointNode.enable(address)
    elif action == 'reset':
        lEndPointNode.reset(address)
 
    time.sleep(1)
    ctx.invoke(status)
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@endpoint.command('status', short_help='Display the status of timing endpoint.')
@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, 240), default=2, help='Period of automatic refresh')

endpoint()

timing.cli.endpoint.endpoint	(		obj,
			id,
			device )

Endpoint master commands.

\b
DEVICE: uhal device identifier

Definition at line 24 of file endpoint.py.

def endpoint(obj, id, device):
    '''
    Endpoint master commands.
 
    \b
    DEVICE: uhal device identifier
    '''
 
    lDevice = obj.mConnectionManager.getDevice(str(device))
    if obj.mTimeout:
        lDevice.setTimeoutPeriod(obj.mTimeout)
 
    echo('Created endpoint device ' + style(lDevice.id(), fg='blue'))
    lTopDesign = lDevice.getNode('')
 
    lBoardInfo = toolbox.readSubNodes(lDevice.getNode('io.config'), False)
    lDevice.dispatch()
 
    if lBoardInfo['board_type'].value() in kLibrarySupportedBoards and lBoardInfo['design_type'].value() in kLibrarySupportedDesigns:
        
        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')
 
    # Ensure that target endpoint exists
    lEPNames = lDevice.getNodes(f"endpoint{id}")
 
    if len(lEPNames) == 0:
        raise click.ClickException(f"Endpoint {id} does not exist")
    elif len(lEPNames) > 1:
        raise click.ClickException(f"Multiple endpoint {id} matches")
 
    obj.mDevice = lDevice
    obj.mEndpoint = lDevice.getNode(f"endpoint{id}")
    obj.mIO = lDevice.getNode('io')
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@endpoint.command('freq', short_help="Measure some frequencies.")
@click.pass_obj

freq()

timing.cli.endpoint.freq

(

obj

)

Definition at line 70 of file endpoint.py.

def freq(obj):
    lEndPointNode = obj.mEndpoint
 
    secho("Endpoint frequency measurement:", fg='cyan')
    # Measure the generated clock frequency
    freq = ep.read_clock_frequency()
 
    echo( "Endpoint freq MHz : {}".format(freq) )
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@endpoint.command('enable')
@click.argument('action', default='on', type=click.Choice(['on', 'off', 'reset']))
@click.option('--address', '-a', type=toolbox.IntRange(0x0,0xffff), help='Address', default=0)
@click.pass_obj
@click.pass_context

readback()

timing.cli.endpoint.readback	(		obj,
			readall )

Read the content of the endpoint master readout buffer.

Definition at line 136 of file endpoint.py.

def readback(obj, readall):
    '''
    Read the content of the endpoint master readout buffer.
    '''
    lDevice = obj.mDevice
    lEndPointNode = obj.mEndpoint
    
    echo(lEndPointNode.get_data_buffer_table(readall))
# ------------------------------------------------------------------------------

status()

timing.cli.endpoint.status	(		obj,
			watch,
			period )

Display the endpoint status, accepted and rejected command counters

Definition at line 110 of file endpoint.py.

def status(obj, watch, period):
    '''
    Display the endpoint status, accepted and rejected command counters
    '''
    lNumCtrs = 0x10
 
    lDevice = obj.mDevice
    lEndPointNode = obj.mEndpoint
 
    while(True):
        if watch:
            click.clear()
        
        echo ( lEndPointNode.get_status() )
 
        if watch:
            time.sleep(period)
        else:
            break
# ------------------------------------------------------------------------------
 
 
# ------------------------------------------------------------------------------
@endpoint.command('readback', short_help='Read the content of the endpoint master readout buffer.')
@click.pass_obj
@click.option('--all/--events', '-a/ ', 'readall', default=False, help="Buffer readout mode.\n- events: only completed events are readout.\n- all: the content of the buffer is fully read-out.")