Class: Nl::Linux::Dpll

Inherits:

Genl::Family

• Object
• Family
• Genl::Family
• Nl::Linux::Dpll

Defined in:

nl-linux/generated/nl/linux/dpll.rb

Overview

DPLL subsystem.

Defined Under Namespace

Modules: AttributeSets, Constants, Enums, Flags, Messages, Notifications, Structs Classes: AsyncOperations

Constant Summary

NAME =

"dpll"

VERSION =

1

Class Method Summary

• .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Object

Instance Method Summary

• #async(stream_capacity: nil) ⇒ AsyncOperations

  Returns the asynchronous operation facade for this family.

• #do_device_get(**args) ⇒ Messages::DoDeviceGetReply

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

• #do_device_id_get(**args) ⇒ Messages::DoDeviceIdGetReply

  Get id of dpll device that matches given attributes.

• #do_device_set(**args) ⇒ void

  Set attributes for a DPLL device.

• #do_pin_get(**args) ⇒ Messages::DoPinGetReply

  Get list of pins and its attributes.

• #do_pin_id_get(**args) ⇒ Messages::DoPinIdGetReply

  Get id of a pin that matches given attributes.

• #do_pin_set(**args) ⇒ void

  Set attributes of a target pin.

• #dump_device_get(**args, &block) ⇒ Object

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

• #dump_pin_get(**args, &block) ⇒ Object

  Get list of pins and its attributes.

• #subscribe(*groups) ⇒ self
• #unsubscribe(*groups) ⇒ self

Methods inherited from Genl::Family

version

Class Method Details

.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Dpll .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

Overloads:

• .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Dpll

  Parameters:

  • resolver (#call) (defaults to: ::Nl::Linux::DEFAULT_RESOLVER)
  • executor (Symbol, nil) (defaults to: nil)
  • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

  Returns:

  • (Dpll)
• .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

  Returns the result of the block.

  Parameters:

  • resolver (#call) (defaults to: ::Nl::Linux::DEFAULT_RESOLVER)
  • executor (Symbol, nil) (defaults to: nil)
  • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

  Yield Parameters:

  • family (Dpll)

  Returns:

  • (Object) —

    the result of the block

# File 'nl-linux/generated/nl/linux/dpll.rb', line 26

def self.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
  super
end

Instance Method Details

#async(stream_capacity: nil) ⇒ AsyncOperations

Returns the asynchronous operation facade for this family.

Parameters:

• stream_capacity (::Integer, nil) (defaults to: nil)

Returns:

• (AsyncOperations)

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2824

def async(stream_capacity: nil)
  return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
  build_async_facade(AsyncOperations, stream_capacity:)
end

#do_device_get(**args) ⇒ 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:

• (Messages::DoDeviceGetReply)

See Also:

• Nl::Linux::Dpll::Messages::DoDeviceGetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2558

def do_device_get(**args)
  exchange_message(:"do", Messages::DoDeviceGetRequest, Messages::DoDeviceGetReply, args)
end

#do_device_id_get(**args) ⇒ 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 Nl::Linux::Dpll::Enums::Type.

Returns:

• (Messages::DoDeviceIdGetReply)

See Also:

• Nl::Linux::Dpll::Messages::DoDeviceIdGetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2546

def do_device_id_get(**args)
  exchange_message(:"do", Messages::DoDeviceIdGetRequest, Messages::DoDeviceIdGetReply, args)
end

#do_device_set(**args) ⇒ void

This method returns an undefined value.

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 Nl::Linux::Dpll::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 Nl::Linux::Dpll::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 Nl::Linux::Dpll::Enums::FeatureState.

See Also:

• Nl::Linux::Dpll::Messages::DoDeviceSetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2596

def do_device_set(**args)
  exchange_message(:"do", Messages::DoDeviceSetRequest, nil, args)
end

#do_pin_get(**args) ⇒ 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:

• (Messages::DoPinGetReply)

See Also:

• Nl::Linux::Dpll::Messages::DoPinGetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2631

def do_pin_get(**args)
  exchange_message(:"do", Messages::DoPinGetRequest, Messages::DoPinGetReply, args)
end

#do_pin_id_get(**args) ⇒ 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 Nl::Linux::Dpll::Enums::PinType.

Returns:

• (Messages::DoPinIdGetReply)

See Also:

• Nl::Linux::Dpll::Messages::DoPinIdGetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2613

def do_pin_id_get(**args)
  exchange_message(:"do", Messages::DoPinIdGetRequest, Messages::DoPinIdGetReply, args)
end

#do_pin_set(**args) ⇒ void

This method returns an undefined value.

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 Nl::Linux::Dpll::Enums::PinDirection.

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

  Known enum values are defined in Nl::Linux::Dpll::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.

See Also:

• Nl::Linux::Dpll::Messages::DoPinSetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2680

def do_pin_set(**args)
  exchange_message(:"do", Messages::DoPinSetRequest, nil, args)
end

#dump_device_get(**args) ⇒ Array<Messages::DumpDeviceGetReply> #dump_device_get(**args) {|reply| ... } ⇒ void

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

Requires CAP_NET_ADMIN in the initial user namespace.

Overloads:

• #dump_device_get(**args) ⇒ Array<Messages::DumpDeviceGetReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Returns:

  • (Array<Messages::DumpDeviceGetReply>)
• #dump_device_get(**args) {|reply| ... } ⇒ void

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Yield Parameters:

  • reply (Messages::DumpDeviceGetReply)

See Also:

• Nl::Linux::Dpll::Messages::DumpDeviceGetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2577

def dump_device_get(**args, &block)
  exchange_message(:"dump", Messages::DumpDeviceGetRequest, Messages::DumpDeviceGetReply, args, &block)
end

#dump_pin_get(**args) ⇒ Array<Messages::DumpPinGetReply> #dump_pin_get(**args) {|reply| ... } ⇒ void

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.

Overloads:

• #dump_pin_get(**args) ⇒ Array<Messages::DumpPinGetReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • id (Integer)

  Returns:

  • (Array<Messages::DumpPinGetReply>)
• #dump_pin_get(**args) {|reply| ... } ⇒ void

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • id (Integer)

  Yield Parameters:

  • reply (Messages::DumpPinGetReply)

See Also:

• Nl::Linux::Dpll::Messages::DumpPinGetRequest

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2658

def dump_pin_get(**args, &block)
  exchange_message(:"dump", Messages::DumpPinGetRequest, Messages::DumpPinGetReply, args, &block)
end

#subscribe(*groups) ⇒ self

Parameters:

• groups (Array<:monitor>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2831

def subscribe(*groups) = super
# @rbs (*(:monitor) groups) -> self
# @param [Array<:monitor>] groups
# @return [self]

#unsubscribe(*groups) ⇒ self

Parameters:

• groups (Array<:monitor>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/dpll.rb', line 2835

def unsubscribe(*groups) = super