nl-linux 0.2.4 → 0.4.1

data/sig/generated/nl/linux/drm_ras.rbs

@@ -0,0 +1,553 @@
+# Generated from generated/nl/linux/drm_ras.rb with RBS::Inline
+
+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::Genl::Family
+      NAME: ::String
+
+      VERSION: ::Integer
+
+      # @rbs (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+      # @rbs | [R] (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) { (instance) -> R } -> R
+      # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+      #   @param [#call] resolver
+      #   @param [Symbol, nil] executor
+      #   @param [Integer, nil] notification_capacity
+      #   @return [DrmRas]
+      # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+      #   @param [#call] resolver
+      #   @param [Symbol, nil] executor
+      #   @param [Integer, nil] notification_capacity
+      #   @yieldparam [DrmRas] family
+      #   @return [Object] the result of the block
+      def self.open: (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+
+      # @private
+      MCAST_GROUPS: Hash[::Symbol, ::Nl::McastGroup]
+
+      module Enums
+        # Type of the node. Currently, only error-counter nodes are supported, which expose reliability counters for a hardware/software component.
+        module NodeType
+          ErrorCounter: ::Integer
+        end
+      end
+
+      module Structs
+      end
+
+      module AttributeSets
+        class NodeAttrs < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # Unique identifier for the node. Assigned dynamically by the DRM RAS core upon registration.
+          class NodeId < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Device name chosen by the driver at registration. Can be a PCI BDF, UUID, or module name if unique.
+          class DeviceName < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Node name chosen by the driver at registration. Can be an IP block name, or any name that identifies the RAS node inside the device.
+          class NodeName < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Type of this node, identifying its function.
+          #
+          # Known enum values are defined in {Enums::NodeType}.
+          class NodeType < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # Unique identifier for the node. Assigned dynamically by the DRM RAS core upon registration.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see NodeId
+          def node_id: () -> ::Integer
+
+          # Device name chosen by the driver at registration. Can be a PCI BDF, UUID, or module name if unique.
+          # @rbs return: ::String
+          # @return [String]
+          # @see DeviceName
+          def device_name: () -> ::String
+
+          # Node name chosen by the driver at registration. Can be an IP block name, or any name that identifies the RAS node inside the device.
+          # @rbs return: ::String
+          # @return [String]
+          # @see NodeName
+          def node_name: () -> ::String
+
+          # Type of this node, identifying its function.
+          #
+          # Known enum values are defined in {Enums::NodeType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see NodeType
+          def node_type: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class ErrorCounterAttrs < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # Node ID targeted by this error counter operation.
+          class NodeId < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Unique identifier for a specific error counter within an node.
+          class ErrorId < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Name of the error.
+          class ErrorName < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Current value of the requested error counter.
+          class ErrorValue < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # Node ID targeted by this error counter operation.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see NodeId
+          def node_id: () -> ::Integer
+
+          # Unique identifier for a specific error counter within an node.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see ErrorId
+          def error_id: () -> ::Integer
+
+          # Name of the error.
+          # @rbs return: ::String
+          # @return [String]
+          # @see ErrorName
+          def error_name: () -> ::String
+
+          # Current value of the requested error counter.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see ErrorValue
+          def error_value: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        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::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+        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::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Unique identifier for the node. Assigned dynamically by the DRM RAS core upon registration.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::NodeAttrs::NodeId
+          def node_id: () -> ::Integer
+
+          # Device name chosen by the driver at registration. Can be a PCI BDF, UUID, or module name if unique.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::NodeAttrs::DeviceName
+          def device_name: () -> ::String
+
+          # Node name chosen by the driver at registration. Can be an IP block name, or any name that identifies the RAS node inside the device.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::NodeAttrs::NodeName
+          def node_name: () -> ::String
+
+          # Type of this node, identifying its function.
+          #
+          # Known enum values are defined in {Enums::NodeType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::NodeAttrs::NodeType
+          def node_type: () -> ::Integer
+        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::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Node ID targeted by this error counter operation.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::NodeId
+          def node_id: () -> ::Integer
+
+          # Unique identifier for a specific error counter within an node.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorId
+          def error_id: () -> ::Integer
+        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::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Unique identifier for a specific error counter within an node.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorId
+          def error_id: () -> ::Integer
+
+          # Name of the error.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorName
+          def error_name: () -> ::String
+
+          # Current value of the requested error counter.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorValue
+          def error_value: () -> ::Integer
+        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::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Node ID targeted by this error counter operation.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::NodeId
+          def node_id: () -> ::Integer
+        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::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Unique identifier for a specific error counter within an node.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorId
+          def error_id: () -> ::Integer
+
+          # Name of the error.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorName
+          def error_name: () -> ::String
+
+          # Current value of the requested error counter.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorValue
+          def error_value: () -> ::Integer
+        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::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Node ID targeted by this error counter operation.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::NodeId
+          def node_id: () -> ::Integer
+
+          # Unique identifier for a specific error counter within an node.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::ErrorCounterAttrs::ErrorId
+          def error_id: () -> ::Integer
+        end
+      end
+
+      module Notifications
+      end
+
+      # @private
+      NOTIFICATIONS: 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 () -> Array[Messages::DumpListNodesReply]
+      #   | () { (Messages::DumpListNodesReply) -> void } -> void
+      # @overload dump_list_nodes(**args)
+      #   Returns an array when no block is given.
+      #   @param [Hash] args
+      #   @return [Array<Messages::DumpListNodesReply>]
+      # @overload dump_list_nodes(**args, &block)
+      #   Yields each reply when a block is given.
+      #   @param [Hash] args
+      #   @yieldparam [Messages::DumpListNodesReply] reply
+      #   @return [void]
+      # @see Messages::DumpListNodesRequest
+      def dump_list_nodes: () -> Array[Messages::DumpListNodesReply]
+                         | () { (Messages::DumpListNodesReply) -> void } -> void
+
+      # 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
+      # @param [Hash] args
+      # @option args [Integer] node_id Node ID targeted by this error counter operation.
+      # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+      # @return [Messages::DoGetErrorCounterReply]
+      # @see Messages::DoGetErrorCounterRequest
+      def do_get_error_counter: (?node_id: ::Integer, ?error_id: ::Integer) -> Messages::DoGetErrorCounterReply
+
+      # 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) -> Array[Messages::DumpGetErrorCounterReply]
+      #   | (?node_id: ::Integer) { (Messages::DumpGetErrorCounterReply) -> void } -> void
+      # @overload dump_get_error_counter(**args)
+      #   Returns an array when no block is given.
+      #   @param [Hash] args
+      #   @option args [Integer] node_id Node ID targeted by this error counter operation.
+      #   @return [Array<Messages::DumpGetErrorCounterReply>]
+      # @overload dump_get_error_counter(**args, &block)
+      #   Yields each reply when a block is given.
+      #   @param [Hash] args
+      #   @option args [Integer] node_id Node ID targeted by this error counter operation.
+      #   @yieldparam [Messages::DumpGetErrorCounterReply] reply
+      #   @return [void]
+      # @see Messages::DumpGetErrorCounterRequest
+      def dump_get_error_counter: (?node_id: ::Integer) -> Array[Messages::DumpGetErrorCounterReply]
+                                | (?node_id: ::Integer) { (Messages::DumpGetErrorCounterReply) -> void } -> void
+
+      # 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
+      # @param [Hash] args
+      # @option args [Integer] node_id Node ID targeted by this error counter operation.
+      # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+      # @return [void]
+      # @see Messages::DoClearErrorCounterRequest
+      def do_clear_error_counter: (?node_id: ::Integer, ?error_id: ::Integer) -> void
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # 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]
+        # @param [Hash] args
+        # @return [Nl::Async::Stream<Messages::DumpListNodesReply>]
+        # @see Messages::DumpListNodesRequest
+        def dump_list_nodes: () -> ::Nl::Async::Stream[Messages::DumpListNodesReply]
+
+        # 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]
+        # @param [Hash] args
+        # @option args [Integer] node_id Node ID targeted by this error counter operation.
+        # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+        # @return [Nl::Async::Future<Messages::DoGetErrorCounterReply>]
+        # @see Messages::DoGetErrorCounterRequest
+        def do_get_error_counter: (?node_id: ::Integer, ?error_id: ::Integer) -> ::Nl::Async::Future[Messages::DoGetErrorCounterReply]
+
+        # 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]
+        # @param [Hash] args
+        # @option args [Integer] node_id Node ID targeted by this error counter operation.
+        # @return [Nl::Async::Stream<Messages::DumpGetErrorCounterReply>]
+        # @see Messages::DumpGetErrorCounterRequest
+        def dump_get_error_counter: (?node_id: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetErrorCounterReply]
+
+        # 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]
+        # @param [Hash] args
+        # @option args [Integer] node_id Node ID targeted by this error counter operation.
+        # @option args [Integer] error_id Unique identifier for a specific error counter within an node.
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoClearErrorCounterRequest
+        def do_clear_error_counter: (?node_id: ::Integer, ?error_id: ::Integer) -> ::Nl::Async::Future[void]
+      end
+
+      # Returns the asynchronous operation facade for this family.
+      # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+      # @param [::Integer, nil] stream_capacity
+      # @return [AsyncOperations]
+      def async: (?stream_capacity: ::Integer?) -> AsyncOperations
+    end
+  end
+end