Class: Nl::Linux::Dpll::Notifications::PinCreateNtf

Inherits:

Genl::Message

• Object
• Raw::Message
• Genl::Message
• Nl::Linux::Dpll::Notifications::PinCreateNtf

Defined in:

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

Overview

Notification about pin appearing

Multicast group: monitor.

Constant Summary

TYPE =

10

FIXED_HEADER =

nil

ATTRIBUTE_SET =

AttributeSets::Pin

ATTRIBUTES =

Ractor.make_shareable(%i[id module_name clock_id board_label panel_label package_label type frequency frequency_supported capabilities parent_device parent_pin phase_adjust_min phase_adjust_max phase_adjust fractional_frequency_offset esync_frequency esync_frequency_supported esync_pulse reference_sync phase_adjust_gran fractional_frequency_offset_ppt measured_frequency])

Instance Attribute Summary

Attributes included from StructuredPayload

#attributes, #fixed_header

Instance Method Summary

• #board_label ⇒ String
• #capabilities ⇒ Integer

  Known flags are defined in Flags::PinCapabilities.

• #clock_id ⇒ Integer
• #esync_frequency ⇒ Integer

  Frequency of Embedded SYNC signal.

• #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.

• #esync_pulse ⇒ Integer

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

• #fractional_frequency_offset ⇒ Integer

  The FFO (Fractional Frequency Offset) of the pin.

• #fractional_frequency_offset_ppt ⇒ Integer

  The FFO (Fractional Frequency Offset) of the pin.

• #frequency ⇒ Integer
• #frequency_supported ⇒ Array<AttributeSets::FrequencyRange>
• #id ⇒ Integer
• #measured_frequency ⇒ Integer

  The measured frequency of the input pin in millihertz (mHz).

• #module_name ⇒ String
• #package_label ⇒ String
• #panel_label ⇒ String
• #parent_device ⇒ Array<AttributeSets::PinParentDevice>
• #parent_pin ⇒ Array<AttributeSets::PinParentPin>
• #phase_adjust ⇒ Integer
• #phase_adjust_gran ⇒ Integer

  Granularity of phase adjustment, in picoseconds.

• #phase_adjust_max ⇒ Integer
• #phase_adjust_min ⇒ Integer
• #reference_sync ⇒ Array<AttributeSets::ReferenceSync>

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

• #type ⇒ Integer

  Known enum values are defined in Enums::PinType.

Methods inherited from Genl::Message

decode

Methods inherited from Raw::Message

#append_attribute, decode, #initialize

Methods included from StructuredPayload

#encode, #initialize

Constructor Details

This class inherits a constructor from Nl::Raw::Message

Instance Method Details

#board_label ⇒ String

Returns:

• (String)

See Also:

• AttributeSets::Pin::BoardLabel

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

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

#capabilities ⇒ Integer

Known flags are defined in Flags::PinCapabilities.

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::Capabilities

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

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

#clock_id ⇒ Integer

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::ClockId

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

def clock_id; attributes[:"clock_id"]&.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:

• AttributeSets::Pin::EsyncFrequency

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

def esync_frequency; attributes[:"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:

• (Array<AttributeSets::FrequencyRange>)

See Also:

• AttributeSets::Pin::EsyncFrequencySupported

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

def esync_frequency_supported; attributes[:"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:

• AttributeSets::Pin::EsyncPulse

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

def esync_pulse; attributes[:"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:

• AttributeSets::Pin::FractionalFrequencyOffset

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

def fractional_frequency_offset; attributes[:"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:

• AttributeSets::Pin::FractionalFrequencyOffsetPpt

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

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

#frequency ⇒ Integer

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::Frequency

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

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

#frequency_supported ⇒ Array<AttributeSets::FrequencyRange>

Returns:

• (Array<AttributeSets::FrequencyRange>)

See Also:

• AttributeSets::Pin::FrequencySupported

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

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

#id ⇒ Integer

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::Id

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

def id; attributes[:"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:

• AttributeSets::Pin::MeasuredFrequency

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

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

#module_name ⇒ String

Returns:

• (String)

See Also:

• AttributeSets::Pin::ModuleName

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

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

#package_label ⇒ String

Returns:

• (String)

See Also:

• AttributeSets::Pin::PackageLabel

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

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

#panel_label ⇒ String

Returns:

• (String)

See Also:

• AttributeSets::Pin::PanelLabel

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

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

#parent_device ⇒ Array<AttributeSets::PinParentDevice>

Returns:

• (Array<AttributeSets::PinParentDevice>)

See Also:

• AttributeSets::Pin::ParentDevice

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

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

#parent_pin ⇒ Array<AttributeSets::PinParentPin>

Returns:

• (Array<AttributeSets::PinParentPin>)

See Also:

• AttributeSets::Pin::ParentPin

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

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

#phase_adjust ⇒ Integer

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::PhaseAdjust

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

def phase_adjust; attributes[:"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:

• AttributeSets::Pin::PhaseAdjustGran

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

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

#phase_adjust_max ⇒ Integer

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::PhaseAdjustMax

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

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

#phase_adjust_min ⇒ Integer

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::PhaseAdjustMin

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

def phase_adjust_min; attributes[:"phase_adjust_min"]&.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:

• (Array<AttributeSets::ReferenceSync>)

See Also:

• AttributeSets::Pin::ReferenceSync

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

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

#type ⇒ Integer

Known enum values are defined in Enums::PinType.

Returns:

• (Integer)

See Also:

• AttributeSets::Pin::Type

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

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