nl-linux 0.2.0 → 0.2.1

data/generated/nl/linux/psp.rb

@@ -0,0 +1,461 @@
+# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#--
+# frozen_string_literal: true
+# rbs_inline: enabled
+# This code is generated by Ynl::Generator. DO NOT EDIT.
+require 'nl'
+# PSP Security Protocol Generic Netlink family.
+class Nl::Linux::Psp < ::Nl::Family
+  NAME = "psp"
+  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("psp"))
+  module Structs
+  end
+  module AttributeSets
+    class Dev < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Id < Attribute
+        TYPE = 1
+        NAME = :"id"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: -> { raise ArgumentError, "Value #{it.inspect} is less than minimum 1" unless it >= 1 })
+      end
+      class Ifindex < Attribute
+        TYPE = 2
+        NAME = :"ifindex"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class PspVersionsCap < Attribute
+        TYPE = 3
+        NAME = :"psp_versions_cap"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class PspVersionsEna < Attribute
+        TYPE = 4
+        NAME = :"psp_versions_ena"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"id" => Id, :"ifindex" => Ifindex, :"psp_versions_cap" => PspVersionsCap, :"psp_versions_ena" => PspVersionsEna}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => Id, 2 => Ifindex, 3 => PspVersionsCap, 4 => PspVersionsEna}) #: Hash[::Integer, Attribute]
+      class << self
+        # Looks up Attribute class by name.
+        #--
+        # @rbs name: Symbol
+        # @rbs return: Attribute
+        def by_name(name); BY_NAME.fetch(name); end
+        # Looks up Attribute class by type value.
+        #--
+        # @rbs type: Integer
+        # @rbs return: Attribute
+        def by_type(type); BY_TYPE.fetch(type); end
+      end
+    end
+    class Assoc < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class DevId < Attribute
+        TYPE = 1
+        NAME = :"dev_id"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: -> { raise ArgumentError, "Value #{it.inspect} is less than minimum 1" unless it >= 1 })
+      end
+      class Version < Attribute
+        TYPE = 2
+        NAME = :"version"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class RxKey < Attribute
+        TYPE = 3
+        NAME = :"rx_key"
+      end
+      class TxKey < Attribute
+        TYPE = 4
+        NAME = :"tx_key"
+      end
+      class SockFd < Attribute
+        TYPE = 5
+        NAME = :"sock_fd"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"dev_id" => DevId, :"version" => Version, :"rx_key" => RxKey, :"tx_key" => TxKey, :"sock_fd" => SockFd}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => DevId, 2 => Version, 3 => RxKey, 4 => TxKey, 5 => SockFd}) #: Hash[::Integer, Attribute]
+      class << self
+        # Looks up Attribute class by name.
+        #--
+        # @rbs name: Symbol
+        # @rbs return: Attribute
+        def by_name(name); BY_NAME.fetch(name); end
+        # Looks up Attribute class by type value.
+        #--
+        # @rbs type: Integer
+        # @rbs return: Attribute
+        def by_type(type); BY_TYPE.fetch(type); end
+      end
+    end
+    class Keys < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Key < Attribute
+        TYPE = 1
+        NAME = :"key"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+      end
+      class Spi < Attribute
+        TYPE = 2
+        NAME = :"spi"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"key" => Key, :"spi" => Spi}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => Key, 2 => Spi}) #: Hash[::Integer, Attribute]
+      class << self
+        # Looks up Attribute class by name.
+        #--
+        # @rbs name: Symbol
+        # @rbs return: Attribute
+        def by_name(name); BY_NAME.fetch(name); end
+        # Looks up Attribute class by type value.
+        #--
+        # @rbs type: Integer
+        # @rbs return: Attribute
+        def by_type(type); BY_TYPE.fetch(type); end
+      end
+    end
+    class Stats < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class DevId < Attribute
+        TYPE = 1
+        NAME = :"dev_id"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: -> { raise ArgumentError, "Value #{it.inspect} is less than minimum 1" unless it >= 1 })
+      end
+      class KeyRotations < Attribute
+        TYPE = 2
+        NAME = :"key_rotations"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class StaleEvents < Attribute
+        TYPE = 3
+        NAME = :"stale_events"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class RxPackets < Attribute
+        TYPE = 4
+        NAME = :"rx_packets"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class RxBytes < Attribute
+        TYPE = 5
+        NAME = :"rx_bytes"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class RxAuthFail < Attribute
+        TYPE = 6
+        NAME = :"rx_auth_fail"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class RxError < Attribute
+        TYPE = 7
+        NAME = :"rx_error"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class RxBad < Attribute
+        TYPE = 8
+        NAME = :"rx_bad"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class TxPackets < Attribute
+        TYPE = 9
+        NAME = :"tx_packets"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class TxBytes < Attribute
+        TYPE = 10
+        NAME = :"tx_bytes"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      class TxError < Attribute
+        TYPE = 11
+        NAME = :"tx_error"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::UINT, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"dev_id" => DevId, :"key_rotations" => KeyRotations, :"stale_events" => StaleEvents, :"rx_packets" => RxPackets, :"rx_bytes" => RxBytes, :"rx_auth_fail" => RxAuthFail, :"rx_error" => RxError, :"rx_bad" => RxBad, :"tx_packets" => TxPackets, :"tx_bytes" => TxBytes, :"tx_error" => TxError}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => DevId, 2 => KeyRotations, 3 => StaleEvents, 4 => RxPackets, 5 => RxBytes, 6 => RxAuthFail, 7 => RxError, 8 => RxBad, 9 => TxPackets, 10 => TxBytes, 11 => TxError}) #: Hash[::Integer, Attribute]
+      class << self
+        # Looks up Attribute class by name.
+        #--
+        # @rbs name: Symbol
+        # @rbs return: Attribute
+        def by_name(name); BY_NAME.fetch(name); end
+        # Looks up Attribute class by type value.
+        #--
+        # @rbs type: Integer
+        # @rbs return: Attribute
+        def by_type(type); BY_TYPE.fetch(type); end
+      end
+    end
+    Assoc::RxKey::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(Keys)
+    Assoc::TxKey::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(Keys)
+  end
+  module Messages
+    # Get / dump information about PSP capable devices on the system.
+    class DoDevGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[id])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+    end
+    # Get / dump information about PSP capable devices on the system.
+    class DoDevGetReply < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[id ifindex psp_versions_cap psp_versions_ena])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `psp-versions-cap` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def psp_versions_cap; attributes[:"psp_versions_cap"]&.value; end
+      # Gets the value of `psp-versions-ena` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def psp_versions_ena; attributes[:"psp_versions_ena"]&.value; end
+    end
+    # Get / dump information about PSP capable devices on the system.
+    class DumpDevGetReply < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[id ifindex psp_versions_cap psp_versions_ena])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `psp-versions-cap` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def psp_versions_cap; attributes[:"psp_versions_cap"]&.value; end
+      # Gets the value of `psp-versions-ena` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def psp_versions_ena; attributes[:"psp_versions_ena"]&.value; end
+    end
+    # Set the configuration of a PSP device.
+    class DoDevSetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 4
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[id psp_versions_ena])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+      # Gets the value of `psp-versions-ena` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def psp_versions_ena; attributes[:"psp_versions_ena"]&.value; end
+    end
+    # Set the configuration of a PSP device.
+    class DoDevSetReply < ::Nl::Protocols::Genl::Message
+      TYPE = 4
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Rotate the device key.
+    class DoKeyRotateRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 6
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[id])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+    end
+    # Rotate the device key.
+    class DoKeyRotateReply < ::Nl::Protocols::Genl::Message
+      TYPE = 6
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[id])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+    end
+    # Allocate a new Rx key + SPI pair, associate it with a socket.
+    class DoRxAssocRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 8
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Assoc
+      ATTRIBUTES = Ractor.make_shareable(%i[dev_id version sock_fd])
+      # Gets the value of `dev-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dev_id; attributes[:"dev_id"]&.value; end
+      # Gets the value of `version` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def version; attributes[:"version"]&.value; end
+      # Gets the value of `sock-fd` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def sock_fd; attributes[:"sock_fd"]&.value; end
+    end
+    # Allocate a new Rx key + SPI pair, associate it with a socket.
+    class DoRxAssocReply < ::Nl::Protocols::Genl::Message
+      TYPE = 8
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Assoc
+      ATTRIBUTES = Ractor.make_shareable(%i[dev_id rx_key])
+      # Gets the value of `dev-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dev_id; attributes[:"dev_id"]&.value; end
+      # Gets the value of `rx-key` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::Keys
+      def rx_key; attributes[:"rx_key"]&.value; end
+    end
+    # Add a PSP Tx association.
+    class DoTxAssocRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 9
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Assoc
+      ATTRIBUTES = Ractor.make_shareable(%i[dev_id version tx_key sock_fd])
+      # Gets the value of `dev-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dev_id; attributes[:"dev_id"]&.value; end
+      # Gets the value of `version` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def version; attributes[:"version"]&.value; end
+      # Gets the value of `tx-key` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::Keys
+      def tx_key; attributes[:"tx_key"]&.value; end
+      # Gets the value of `sock-fd` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def sock_fd; attributes[:"sock_fd"]&.value; end
+    end
+    # Add a PSP Tx association.
+    class DoTxAssocReply < ::Nl::Protocols::Genl::Message
+      TYPE = 9
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Assoc
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Get device statistics.
+    class DoGetStatsRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 10
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Stats
+      ATTRIBUTES = Ractor.make_shareable(%i[dev_id])
+      # Gets the value of `dev-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dev_id; attributes[:"dev_id"]&.value; end
+    end
+    # Get device statistics.
+    class DoGetStatsReply < ::Nl::Protocols::Genl::Message
+      TYPE = 10
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Stats
+      ATTRIBUTES = Ractor.make_shareable(%i[dev_id key_rotations stale_events])
+      # Gets the value of `dev-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dev_id; attributes[:"dev_id"]&.value; end
+      # Gets the value of `key-rotations` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def key_rotations; attributes[:"key_rotations"]&.value; end
+      # Gets the value of `stale-events` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def stale_events; attributes[:"stale_events"]&.value; end
+    end
+    # Get device statistics.
+    class DumpGetStatsReply < ::Nl::Protocols::Genl::Message
+      TYPE = 10
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Stats
+      ATTRIBUTES = Ractor.make_shareable(%i[dev_id key_rotations stale_events])
+      # Gets the value of `dev-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dev_id; attributes[:"dev_id"]&.value; end
+      # Gets the value of `key-rotations` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def key_rotations; attributes[:"key_rotations"]&.value; end
+      # Gets the value of `stale-events` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def stale_events; attributes[:"stale_events"]&.value; end
+    end
+  end
+  # Get / dump information about PSP capable devices on the system.
+  #--
+  # @rbs (?id: ::Integer) -> Messages::DoDevGetReply
+  def do_dev_get(**args)
+    exchange_message(:"do", Messages::DoDevGetRequest, Messages::DoDevGetReply, args)
+  end
+  # Set the configuration of a PSP device.
+  #--
+  # @rbs (?id: ::Integer, ?psp_versions_ena: ::Integer) -> Messages::DoDevSetReply
+  def do_dev_set(**args)
+    exchange_message(:"do", Messages::DoDevSetRequest, Messages::DoDevSetReply, args)
+  end
+  # Rotate the device key.
+  #--
+  # @rbs (?id: ::Integer) -> Messages::DoKeyRotateReply
+  def do_key_rotate(**args)
+    exchange_message(:"do", Messages::DoKeyRotateRequest, Messages::DoKeyRotateReply, args)
+  end
+  # Allocate a new Rx key + SPI pair, associate it with a socket.
+  #--
+  # @rbs (?dev_id: ::Integer, ?version: ::Integer, ?sock_fd: ::Integer) -> Messages::DoRxAssocReply
+  def do_rx_assoc(**args)
+    exchange_message(:"do", Messages::DoRxAssocRequest, Messages::DoRxAssocReply, args)
+  end
+  # Add a PSP Tx association.
+  #--
+  # @rbs (?dev_id: ::Integer, ?version: ::Integer, ?tx_key: AttributeSets::Keys, ?sock_fd: ::Integer) -> Messages::DoTxAssocReply
+  def do_tx_assoc(**args)
+    exchange_message(:"do", Messages::DoTxAssocRequest, Messages::DoTxAssocReply, args)
+  end
+  # Get device statistics.
+  #--
+  # @rbs (?dev_id: ::Integer) -> Messages::DoGetStatsReply
+  def do_get_stats(**args)
+    exchange_message(:"do", Messages::DoGetStatsRequest, Messages::DoGetStatsReply, args)
+  end
+end