Class: Nl::Linux::Dpll::AttributeSets::Pin

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

Defined Under Namespace

Classes: Attribute, BoardLabel, Capabilities, ClockId, Direction, EsyncFrequency, EsyncFrequencySupported, EsyncPulse, FractionalFrequencyOffset, FractionalFrequencyOffsetPpt, Frequency, FrequencyMax, FrequencyMin, FrequencySupported, Id, MeasuredFrequency, ModuleName, Operstate, PackageLabel, Pad, PanelLabel, ParentDevice, ParentId, ParentPin, PhaseAdjust, PhaseAdjustGran, PhaseAdjustMax, PhaseAdjustMin, PhaseOffset, Prio, ReferenceSync, State, Type

Constant Summary

Constants inherited from AttributeSet

AttributeSet::SELECTOR_NAMES

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AttributeSet

#<<, #[], build_attributes, decode, #encode, #initialize

Constructor Details

This class inherits a constructor from Nl::AttributeSet

Class Method Details

.by_name(name) ⇒ Attribute

Looks up Attribute class by name.

Parameters:

  • name (Symbol)

Returns:



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

def by_name(name); BY_NAME.fetch(name); end

.by_type(type) ⇒ Attribute

Looks up Attribute class by type value.

Parameters:

  • type (Integer)

Returns:



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

def by_type(type); BY_TYPE.fetch(type); end

Instance Method Details

#board_label ⇒ String

Returns:

  • (String)

See Also:



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

def board_label; self[:"board_label"]&.value; end

#capabilities ⇒ Integer

Known flags are defined in Flags::PinCapabilities.

Returns:

  • (Integer)

See Also:



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

def capabilities; self[:"capabilities"]&.value; end

#clock_id ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def clock_id; self[:"clock_id"]&.value; end

#direction ⇒ Integer

Known enum values are defined in Enums::PinDirection.

Returns:

  • (Integer)

See Also:



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

def direction; self[:"direction"]&.value; end

#esync_frequency ⇒ Integer

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

Returns:

  • (Integer)

See Also:



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

def esync_frequency; self[:"esync_frequency"]&.value; end

#esync_frequency_supported ⇒ Array<AttributeSets::FrequencyRange>

If provided a pin is capable of embedding a SYNC signal (within given range) into its base frequency signal.

Returns:

See Also:



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

def esync_frequency_supported; self[:"esync_frequency_supported"].map(&:value); end

#esync_pulse ⇒ Integer

A ratio of high to low state of a SYNC signal pulse embedded into base clock frequency. Value is in percents.

Returns:

  • (Integer)

See Also:



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

def esync_pulse; self[:"esync_pulse"]&.value; end

#fractional_frequency_offset ⇒ Integer

The FFO (Fractional Frequency Offset) of the pin. At top level this represents the RX vs TX symbol rate offset on the media associated with the pin. Inside the pin-parent-device nest it represents the frequency offset between the pin and its parent DPLL device. Value is in PPM (parts per million). This is a lower-precision version of fractional-frequency-offset-ppt.

Returns:

  • (Integer)

See Also:



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

def fractional_frequency_offset; self[:"fractional_frequency_offset"]&.value; end

#fractional_frequency_offset_ppt ⇒ Integer

The FFO (Fractional Frequency Offset) of the pin. At top level this represents the RX vs TX symbol rate offset on the media associated with the pin. Inside the pin-parent-device nest it represents the frequency offset between the pin and its parent DPLL device. Value is in PPT (parts per trillion, 10^-12). This is a higher-precision version of fractional-frequency-offset.

Returns:

  • (Integer)

See Also:



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

def fractional_frequency_offset_ppt; self[:"fractional_frequency_offset_ppt"]&.value; end

#frequency ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def frequency; self[:"frequency"]&.value; end

#frequency_max ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def frequency_max; self[:"frequency_max"]&.value; end

#frequency_min ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def frequency_min; self[:"frequency_min"]&.value; end

#frequency_supported ⇒ Array<AttributeSets::FrequencyRange>

Returns:

See Also:



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

def frequency_supported; self[:"frequency_supported"].map(&:value); end

#id ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def id; self[:"id"]&.value; end

#measured_frequency ⇒ Integer

The measured frequency of the input pin in millihertz (mHz). Value of (DPLL_A_PIN_MEASURED_FREQUENCY / DPLL_PIN_MEASURED_FREQUENCY_DIVIDER) is an integer part (Hz) of a measured frequency value. Value of (DPLL_A_PIN_MEASURED_FREQUENCY % DPLL_PIN_MEASURED_FREQUENCY_DIVIDER) is a fractional part of a measured frequency value.

Returns:

  • (Integer)

See Also:



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

def measured_frequency; self[:"measured_frequency"]&.value; end

#module_name ⇒ String

Returns:

  • (String)

See Also:



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

def module_name; self[:"module_name"]&.value; end

#operstate ⇒ Integer

Operational state of the pin with respect to its parent DPLL device. Unlike state (which reflects the administrative intent), operstate reflects the actual hardware status.

Known enum values are defined in Enums::PinOperstate.

Returns:

  • (Integer)

See Also:



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

def operstate; self[:"operstate"]&.value; end

#package_label ⇒ String

Returns:

  • (String)

See Also:



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

def package_label; self[:"package_label"]&.value; end

#panel_label ⇒ String

Returns:

  • (String)

See Also:



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

def panel_label; self[:"panel_label"]&.value; end

#parent_device ⇒ Array<AttributeSets::PinParentDevice>

Returns:

See Also:



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

def parent_device; self[:"parent_device"].map(&:value); end

#parent_id ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def parent_id; self[:"parent_id"]&.value; end

#parent_pin ⇒ Array<AttributeSets::PinParentPin>

Returns:

See Also:



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

def parent_pin; self[:"parent_pin"].map(&:value); end

#phase_adjust ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def phase_adjust; self[:"phase_adjust"]&.value; end

#phase_adjust_gran ⇒ Integer

Granularity of phase adjustment, in picoseconds. The value of phase adjustment must be a multiple of this granularity.

Returns:

  • (Integer)

See Also:



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

def phase_adjust_gran; self[:"phase_adjust_gran"]&.value; end

#phase_adjust_max ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def phase_adjust_max; self[:"phase_adjust_max"]&.value; end

#phase_adjust_min ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def phase_adjust_min; self[:"phase_adjust_min"]&.value; end

#phase_offset ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def phase_offset; self[:"phase_offset"]&.value; end

#prio ⇒ Integer

Returns:

  • (Integer)

See Also:



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

def prio; self[:"prio"]&.value; end

#reference_sync ⇒ Array<AttributeSets::ReferenceSync>

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

Returns:

See Also:



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

def reference_sync; self[:"reference_sync"].map(&:value); end

#state ⇒ Integer

Known enum values are defined in Enums::PinState.

Returns:

  • (Integer)

See Also:



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

def state; self[:"state"]&.value; end

#type ⇒ Integer

Known enum values are defined in Enums::PinType.

Returns:

  • (Integer)

See Also:



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

def type; self[:"type"]&.value; end