Class: Nl::Linux::Dpll::AsyncOperations

Inherits:
Object
  • Object
show all
Defined in:
nl-linux/generated/nl/linux/dpll.rb

Instance Method Summary collapse

Instance Method Details

#do_device_get(**args) ⇒ Nl::Async::Future<Messages::DoDeviceGetReply>

Get list of DPLL devices (dump) or attributes of a single dpll device

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • id (Integer)

Returns:

See Also:



2711
2712
2713
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2711

def do_device_get(**args)
  @exchange.call(:"do", Messages::DoDeviceGetRequest, Messages::DoDeviceGetReply, args)
end

#do_device_id_get(**args) ⇒ Nl::Async::Future<Messages::DoDeviceIdGetReply>

Get id of dpll device that matches given attributes

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • module_name (String)
  • clock_id (Integer)
  • type (Integer) —

    Known enum values are defined in Enums::Type.

Returns:

See Also:



2699
2700
2701
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2699

def do_device_id_get(**args)
  @exchange.call(:"do", Messages::DoDeviceIdGetRequest, Messages::DoDeviceIdGetReply, args)
end

#do_device_set(**args) ⇒ Nl::Async::Future<void>

Set attributes for a DPLL device

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • id (Integer)
  • mode (Integer) —

    Known enum values are defined in Enums::Mode.

  • phase_offset_monitor (Integer) —

    Receive or request state of phase offset monitor feature. If enabled, dpll device shall monitor and notify all currently available inputs for changes of their phase offset against the dpll device.

    Known enum values are defined in Enums::FeatureState.

  • phase_offset_avg_factor (Integer) —

    Averaging factor applied to calculation of reported phase offset.

  • frequency_monitor (Integer) —

    Current or desired state of the frequency monitor feature. If enabled, dpll device shall measure all currently available inputs for their actual input frequency.

    Known enum values are defined in Enums::FeatureState.

Returns:

See Also:



2741
2742
2743
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2741

def do_device_set(**args)
  @exchange.call(:"do", Messages::DoDeviceSetRequest, nil, args)
end

#do_pin_get(**args) ⇒ Nl::Async::Future<Messages::DoPinGetReply>

Get list of pins and its attributes.

  • dump request without any attributes given - list all the pins in the system
  • dump request with target dpll - list all the pins registered with a given dpll device
  • do request with target dpll and target pin - single pin attributes

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • id (Integer)

Returns:

See Also:



2776
2777
2778
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2776

def do_pin_get(**args)
  @exchange.call(:"do", Messages::DoPinGetRequest, Messages::DoPinGetReply, args)
end

#do_pin_id_get(**args) ⇒ Nl::Async::Future<Messages::DoPinIdGetReply>

Get id of a pin that matches given attributes

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • module_name (String)
  • clock_id (Integer)
  • board_label (String)
  • panel_label (String)
  • package_label (String)
  • type (Integer) —

    Known enum values are defined in Enums::PinType.

Returns:

See Also:



2758
2759
2760
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2758

def do_pin_id_get(**args)
  @exchange.call(:"do", Messages::DoPinIdGetRequest, Messages::DoPinIdGetReply, args)
end

#do_pin_set(**args) ⇒ Nl::Async::Future<void>

Set attributes of a target pin

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • id (Integer)
  • direction (Integer) —

    Known enum values are defined in Enums::PinDirection.

  • frequency (Integer)
  • prio (Integer)
  • state (Integer) —

    Known enum values are defined in Enums::PinState.

  • parent_device (Array<AttributeSets::PinParentDevice, Hash<Symbol, Object>>)
  • parent_pin (Array<AttributeSets::PinParentPin, Hash<Symbol, Object>>)
  • phase_adjust (Integer)
  • esync_frequency (Integer) —

    Frequency of Embedded SYNC signal. If provided, the pin is configured with a SYNC signal embedded into its base clock frequency.

  • reference_sync (Array<AttributeSets::ReferenceSync, Hash<Symbol, Object>>) —

    Capable pin provides list of pins that can be bound to create a reference-sync pin pair.

Returns:

See Also:



2816
2817
2818
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2816

def do_pin_set(**args)
  @exchange.call(:"do", Messages::DoPinSetRequest, nil, args)
end

#dump_device_get(**args) ⇒ Nl::Async::Stream<Messages::DumpDeviceGetReply>

Get list of DPLL devices (dump) or attributes of a single dpll device

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Returns:

See Also:



2722
2723
2724
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2722

def dump_device_get(**args)
  @exchange.call(:"dump", Messages::DumpDeviceGetRequest, Messages::DumpDeviceGetReply, args)
end

#dump_pin_get(**args) ⇒ Nl::Async::Stream<Messages::DumpPinGetReply>

Get list of pins and its attributes.

  • dump request without any attributes given - list all the pins in the system
  • dump request with target dpll - list all the pins registered with a given dpll device
  • do request with target dpll and target pin - single pin attributes

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • id (Integer)

Returns:

See Also:



2794
2795
2796
 
# File 'nl-linux/generated/nl/linux/dpll.rb', line 2794

def dump_pin_get(**args)
  @exchange.call(:"dump", Messages::DumpPinGetRequest, Messages::DumpPinGetReply, args)
end