nl-linux 0.2.3 → 0.3.0

data/generated/nl/linux/drm_ras.rb

@@ -0,0 +1,309 @@
+# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#
+# This file is based on Documentation/netlink/specs/drm_ras.yaml from Linux v7.2.
+#--
+# frozen_string_literal: true
+# rbs_inline: enabled
+# This code is generated by Ynl::Generator. DO NOT EDIT.
+require 'nl'
+module Nl; module Linux
+# DRM RAS (Reliability, Availability, Serviceability) over Generic Netlink. Provides a standardized mechanism for DRM drivers to register "nodes" representing hardware/software components capable of reporting error counters. Userspace tools can query the list of nodes or individual error counters via the Generic Netlink interface.
+class DrmRas < ::Nl::Family
+  NAME = "drm-ras"
+  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("drm-ras"))
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Structs
+  end
+  module AttributeSets
+    class NodeAttrs < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class NodeId < Attribute
+        TYPE = 1
+        NAME = :"node_id"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class DeviceName < Attribute
+        TYPE = 2
+        NAME = :"device_name"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+      end
+      class NodeName < Attribute
+        TYPE = 3
+        NAME = :"node_name"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+      end
+      class NodeType < Attribute
+        TYPE = 4
+        NAME = :"node_type"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"node_id" => NodeId, :"device_name" => DeviceName, :"node_name" => NodeName, :"node_type" => NodeType}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => NodeId, 2 => DeviceName, 3 => NodeName, 4 => NodeType}) #: 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 ErrorCounterAttrs < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class NodeId < Attribute
+        TYPE = 1
+        NAME = :"node_id"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class ErrorId < Attribute
+        TYPE = 2
+        NAME = :"error_id"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class ErrorName < Attribute
+        TYPE = 3
+        NAME = :"error_name"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+      end
+      class ErrorValue < Attribute
+        TYPE = 4
+        NAME = :"error_value"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"node_id" => NodeId, :"error_id" => ErrorId, :"error_name" => ErrorName, :"error_value" => ErrorValue}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => NodeId, 2 => ErrorId, 3 => ErrorName, 4 => ErrorValue}) #: 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
+  end
+  module Messages
+    # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpListNodesRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::NodeAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpListNodesReply < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::NodeAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[node_id device_name node_name node_type])
+      # Gets the value of `node-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def node_id; attributes[:"node_id"]&.value; end
+      # Gets the value of `device-name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def device_name; attributes[:"device_name"]&.value; end
+      # Gets the value of `node-name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def node_name; attributes[:"node_name"]&.value; end
+      # Gets the value of `node-type` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def node_type; attributes[:"node_type"]&.value; end
+    end
+    # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DoGetErrorCounterRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[node_id error_id])
+      # Gets the value of `node-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def node_id; attributes[:"node_id"]&.value; end
+      # Gets the value of `error-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def error_id; attributes[:"error_id"]&.value; end
+    end
+    # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DoGetErrorCounterReply < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[error_id error_name error_value])
+      # Gets the value of `error-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def error_id; attributes[:"error_id"]&.value; end
+      # Gets the value of `error-name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def error_name; attributes[:"error_name"]&.value; end
+      # Gets the value of `error-value` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def error_value; attributes[:"error_value"]&.value; end
+    end
+    # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpGetErrorCounterRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[node_id])
+      # Gets the value of `node-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def node_id; attributes[:"node_id"]&.value; end
+    end
+    # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpGetErrorCounterReply < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[error_id error_name error_value])
+      # Gets the value of `error-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def error_id; attributes[:"error_id"]&.value; end
+      # Gets the value of `error-name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def error_name; attributes[:"error_name"]&.value; end
+      # Gets the value of `error-value` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def error_value; attributes[:"error_value"]&.value; end
+    end
+    # Clear error counter for a given node. The request includes the error-id and node-id of the counter to be cleared.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DoClearErrorCounterRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ErrorCounterAttrs
+      ATTRIBUTES = Ractor.make_shareable(%i[node_id error_id])
+      # Gets the value of `node-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def node_id; attributes[:"node_id"]&.value; end
+      # Gets the value of `error-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def error_id; attributes[:"error_id"]&.value; end
+    end
+  end
+  module Notifications
+  end
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
+  # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs () -> Enumerable[Messages::DumpListNodesReply]
+  #   | () { (Messages::DumpListNodesReply) -> void } -> void
+  def dump_list_nodes(**args, &block)
+    exchange_message(:"dump", Messages::DumpListNodesRequest, Messages::DumpListNodesReply, args, &block)
+  end
+  # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> Messages::DoGetErrorCounterReply
+  def do_get_error_counter(**args)
+    exchange_message(:"do", Messages::DoGetErrorCounterRequest, Messages::DoGetErrorCounterReply, args)
+  end
+  # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs (?node_id: ::Integer) -> Enumerable[Messages::DumpGetErrorCounterReply]
+  #   | (?node_id: ::Integer) { (Messages::DumpGetErrorCounterReply) -> void } -> void
+  def dump_get_error_counter(**args, &block)
+    exchange_message(:"dump", Messages::DumpGetErrorCounterRequest, Messages::DumpGetErrorCounterReply, args, &block)
+  end
+  # Clear error counter for a given node. The request includes the error-id and node-id of the counter to be cleared.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> void
+  def do_clear_error_counter(**args)
+    exchange_message(:"do", Messages::DoClearErrorCounterRequest, nil, args)
+  end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Retrieve the full list of currently registered DRM RAS nodes. Each node includes its dynamically assigned ID, name, and type. **Important:** User space must call this operation first to obtain the node IDs. These IDs are required for all subsequent operations on nodes, such as querying error counters.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpListNodesReply]
+    def dump_list_nodes(**args)
+      @exchange.call(:"dump", Messages::DumpListNodesRequest, Messages::DumpListNodesReply, args)
+    end
+    # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetErrorCounterReply]
+    def do_get_error_counter(**args)
+      @exchange.call(:"do", Messages::DoGetErrorCounterRequest, Messages::DoGetErrorCounterReply, args)
+    end
+    # Retrieve error counter for a given node. The response includes the id, the name, and even the current value of each counter.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?node_id: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetErrorCounterReply]
+    def dump_get_error_counter(**args)
+      @exchange.call(:"dump", Messages::DumpGetErrorCounterRequest, Messages::DumpGetErrorCounterReply, args)
+    end
+    # Clear error counter for a given node. The request includes the error-id and node-id of the counter to be cleared.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?node_id: ::Integer, ?error_id: ::Integer) -> ::Nl::Async::Future[void]
+    def do_clear_error_counter(**args)
+      @exchange.call(:"do", Messages::DoClearErrorCounterRequest, nil, args)
+    end
+  end
+  # Returns the asynchronous operation facade for this family.
+  #--
+  # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  def async(stream_capacity: nil)
+    return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
+    build_async_facade(AsyncOperations, stream_capacity:)
+  end
+end
+end; end