ruby-amt 0.1.0

data/lib/amt/service/hardware_asset.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+
+require 'amt/service/basic'
+require 'amt/utility'
+
+module AMT
+
+  module Service
+
+    # AMT Service for retrieving information about the hardware assets of the AMT device.
+    class HardwareAsset < Basic
+
+      autoload :Asset, 'amt/service/hardware_asset/asset'
+      autoload :Bios, 'amt/service/hardware_asset/bios'
+      autoload :ComputerSystem, 'amt/service/hardware_asset/computer_system'
+      autoload :Baseboard, 'amt/service/hardware_asset/baseboard'
+      autoload :Processor, 'amt/service/hardware_asset/processor'
+      autoload :MemoryModule, 'amt/service/hardware_asset/memory_module'
+      autoload :MediaDevice, 'amt/service/hardware_asset/media_device'
+      autoload :PortableBattery, 'amt/service/hardware_asset/portable_battery'
+      autoload :VproVerificationTable, 'amt/service/hardware_asset/vpro_verification_table'
+      autoload :AmtInformationTable, 'amt/service/hardware_asset/amt_information_table'
+
+
+      # Available asset types.
+      class AssetType < AMT::Utility::Enum
+        multi_add(2 => :bios, 3 => :computer_system, 4 => :baseboard, 5 => :processor,
+                  6 => :memory_module, 7 => :fru, 8 => :media_device, 9 => :portable_battery,
+                  10 => :vpro_verification_table, 11 => :amt_information_table)
+      end
+
+
+      # Return an array of supported hardware asset type names.
+      #
+      # All API supported asset type names are available as values in the ASSET_TYPES hash.
+      #
+      # Supported by AMT 1.0 and later.
+      def enumerate_asset_types
+        soap_call("EnumerateAssetTypes", 'Status').process do |node|
+          node.xpath('./ns:AssetTypes/ns:AssetType/text()').collect {|at| AssetType.for(at.to_i)}
+        end
+      end
+
+
+      ASSET_TYPE_CLASS = {
+        2 => :Bios,
+        3 => :ComputerSystem,
+        4 => :Baseboard,
+        5 => :Processor,
+        6 => :MemoryModule,
+        7 => :FRU,
+        8 => :MediaDevice,
+        9 => :PortableBattery,
+        10 => :VproVerificationTable,
+        11 => :AmtInformationTable
+      } #:nodoc:
+
+      # Return an array of all hardware asset data identified by the asset type +asset_type+.
+      #
+      # [+asset_type+] Can either be the numerical asset type, an asset type name or an instance of
+      #                AssetType.
+      #
+      # The class of the returned values is different for every +asset_type+. See Bios,
+      # ComputerSystem, Baseboard, Processor, MemoryModule, FRU, MediaDevice, PortableBattery,
+      # VproVerificationTable and AmtInformationTable.
+      #
+      # Supported by AMT 1.0 and later.
+      def get_asset_data(asset_type)
+        soap_call("GetAssetData", 'Status') do |msg|
+          msg.add('ns:AssetType', AssetType.for(asset_type).value)
+        end.process do |node|
+          node.xpath('./ns:AssetData/ns:AssetData').collect do |anode|
+            data = anode.xpath('./ns:AssetData/text()').to_s.unpack('m*').first
+            self.class.const_get(ASSET_TYPE_CLASS[anode.xpath('./ns:AssetType/text()').to_i]).new(data)
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/amt/service/hardware_asset/amt_information_table.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+require 'amt/utility'
+require 'amt/service/hardware_asset'
+
+module AMT
+  module Service
+    class HardwareAsset
+
+
+      # Represents a structure with information about AMT capabilities.
+      #
+      # Available fields:
+      #
+      # [+amt_supported?+] +true+ if Intel AMT is supported.
+      # [+amt_enabled?+] +true+ if Intel AMT is enabled.
+      # [+ider_enabled?+] +true+ if IDE redirection is enabled.
+      # [+sol_enabled?+] +true+ if Serial Over Lan capability is enabled.
+      # [+network_enabled?+] +true+ if the network interface of the AMT device is enabled.
+      # [+extended_data+] OEM specific data.
+      # [+oem_capabilities+] OEM specific AMT capabilities (an instance of OemCapabilities).
+      class AmtInformationTable < Asset
+
+        # Defines a set of bit flags that indicate the features the AMT additional supports.
+        class OemCapabilities < AMT::Utility::BitStruct
+          boolean 24, :ider_supported,         'IDE Redirection Supported'
+          boolean 25, :sol_supported,          'Serial over LAN Supported'
+          boolean 26, :bios_reflash_supported, 'BIOS reflash supported'
+          boolean 27, :bios_setup_supported,   'BIOS boot into setup screen supported'
+          boolean 28, :bios_pause_supported,   'BIOS pause before booting operating system supported'
+          boolean 29, :no_floppy_boot,         'BIOS does not support boot from Floppy'
+          boolean 30, :no_cd_boot,             'BIOS does not support boot from CD device'
+        end
+
+        set_unpack_data "IC6Ix2", 16, [[:amt_supported, :boolean], [:amt_enabled, :boolean], [:ider_enabled, :boolean],
+                                       [:sol_enabled, :boolean], [:network_enabled, :boolean], :extended_data,
+                                       :oem_capabilities]
+
+        def init_data(data) #:nodoc:
+          super
+          @oem_capabilities = OemCapabilities.new(@oem_capabilities)
+        end
+        private :init_data
+
+      end
+
+    end
+  end
+end

data/lib/amt/service/hardware_asset/asset.rb

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+
+module AMT
+  module Service
+    class HardwareAsset
+
+      # Utility base class which provides methods for easily unpacking the byte stream returned by
+      # AMT::Service::HardwareAsset#get_asset_data.
+      #
+      # Each asset class is derived from this class.
+      class Asset
+
+        # Set the +code+ that is used to unpack the byte stream data. +size+ is the expected (and
+        # fixed) size of the byte stream. +repr+ is an array of fields (or arrays when you also want
+        # to specify the field type and optionally field data) and should be matched to the order of
+        # the unpacked data.
+        #
+        # If +repr+ is specified, an accessor method for each field is created.
+        def self.set_unpack_data(code, size, repr = nil)
+          @code = code
+          @size = size
+          @repr = repr
+          if !repr.nil?
+            repr.each do |field, repr, repr_data|
+              define_method(repr == :boolean ? field.to_s + "?" : field) { instance_variable_get("@#{field}".intern) }
+            end
+          end
+        end
+
+        # Return the byte stream unpack code for the specific asset class.
+        def self.unpack_code
+          @code
+        end
+
+        # Return the predetermined size of the byte stream for the specific asset class.
+        def self.unpack_size
+          @size
+        end
+
+        # Return the byte stream representation data if set.
+        def self.unpack_repr
+          @repr
+        end
+
+        # The version of the asset structure.
+        attr_reader :structure_version
+
+
+        # Use the data from the byte stream +stream+ to set all needed values.
+        def initialize(stream)
+          if stream.size != self.class.unpack_size
+            raise ArgumentError, "The given byte stream has invalid length (#{stream.size} != #{self.class.unpack_size})"
+          end
+          sv, *rest = *stream.unpack(self.class.unpack_code)
+          @structure_version = as_structure_version(sv)
+          if @structure_version != '1.0'
+            raise ArgumentError, "Only Asset structures with version 1.0 are supported (got #{@structure_version})"
+          end
+          init_data(rest)
+        end
+
+        private
+
+        # Initialize all fields specified in <tt>Asset.unpack_repr</tt> with the data from the
+        # stream.
+        def init_data(data)
+          self.class.unpack_repr.each_with_index do |(field, repr, repr_data), index|
+            value = if repr.nil? then (data[index].kind_of?(String) ? data[index].strip : data[index])
+                    elsif repr == :raw then data[index]
+                    elsif repr == :date then as_date(data[index])
+                    elsif repr == :uuid then as_uuid(data[index])
+                    elsif repr == :boolean then as_boolean(data[index])
+                    elsif repr == :enum then as_enum(data[index], repr_data)
+                    elsif repr == :struct then as_bit_struct(data[index], repr_data)
+                    elsif repr.kind_of?(Proc) then repr.call(data[index])
+                    else raise ArgumentError, "Unsupported asset field representation: #{repr}"
+                    end
+            instance_variable_set("@#{field}".intern, value)
+          end
+        end
+
+        # Treat +data+ as if it were a structure version field and extract the structure version.
+        def as_structure_version(data)
+          [data].pack('I').unpack("ss").join('.')
+        end
+
+        # Treat +data+ as if it were a string containing a date in the form mm/dd/yyyy and extract
+        # the date.
+        def as_date(data)
+          month, day, year = data.scan(/(\d\d)\/(\d\d)\/(\d\d\d\d)/).first
+          Date.new(year.to_i, month.to_i, day.to_i)
+        end
+
+        # Treat +data+ as boolean, ie. as value +true+ if it is +1+ and +false+ otherwise.
+        def as_boolean(data)
+          data.to_i == 1
+        end
+
+        # Treat +data+ as enumeration of type +enum_type+.
+        def as_enum(data, enum_type)
+          enum_type.for(data)
+        end
+
+        # Treat +data+ as BitStruct of type +bit_struct_type+.
+        def as_bit_struct(data, bit_struct_type)
+          bit_struct_type.new(data)
+        end
+
+        # Treat +data+ as an UUID.
+        def as_uuid(data)
+          AMT::Utility.binary_to_uuid(data)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/amt/service/hardware_asset/baseboard.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+require 'amt/service/hardware_asset'
+
+module AMT
+  module Service
+    class HardwareAsset
+
+      # Represents the baseboard of the computer system managed by the AMT device.
+      #
+      # There is at most one instance of this class in the hardware asset inventory of each AMT
+      # device.
+      #
+      # Available fields:
+      #
+      # [+manufacturer+] The name of the manufacturer of the baseboard.
+      # [+product+] The name of the baseboard.
+      # [+version+] The version of the baseboard.
+      # [+serial_number+] The serial number of the baseboard.
+      # [+asset_tag+] The asset tag string of the baseboard.
+      # [+replaceable?+] If the baseboard is replaceable, then +true+, else +false+.
+      class Baseboard < Asset
+
+        set_unpack_data "IZ65Z65Z65Z65Z65Cx2", 332, [:manufacturer, :product, :version, :serial_number,
+                                                     :asset_tag, [:replaceable, :boolean]]
+
+      end
+
+    end
+  end
+end

data/lib/amt/service/hardware_asset/bios.rb

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+
+require 'amt/utility'
+require 'amt/service/hardware_asset'
+
+module AMT
+  module Service
+    class HardwareAsset
+
+      # Represents the BIOS of the AMT device.
+      #
+      # There is at most one instance of this class in the hardware asset inventory of each AMT
+      # device.
+      #
+      # Available fields:
+      #
+      # [+vendor+] The name of the BIOS vendor.
+      # [+version+] The version of the system BIOS image.
+      # [+release_date+] The release date of the system BIOS image.
+      # [+characteristics+] Defines which functions the BIOS supports (an instance of
+      #                     Characteristics).
+      class Bios < Asset
+
+        # Defines a set of bit flags that indicate the features the BIOS supports.
+        class Characteristics < AMT::Utility::BitStruct
+          boolean 2,  :unknown,                                'Unknown'
+          boolean 3,  :bios_characteristics_not_supported,     'BIOS Characteristics Not Supported'
+          boolean 4,  :isa_supported,                          'ISA is supported'
+          boolean 5,  :mca_supported,                          'MCA is supported'
+          boolean 6,  :eisa_supported,                         'EISA is supported'
+          boolean 7,  :pci_supported,                          'PCI is supported'
+          boolean 8,  :pc_card_supported,                      'PC Card (PCMCIA) is supported'
+          boolean 9,  :pnp_supported,                          'Plug and Play is supported'
+          boolean 10, :apm_supported,                          'APM is supported'
+          boolean 11, :bios_upgradeable,                       'BIOS is Upgradeable (Flash)'
+          boolean 12, :bios_shadowing_allowed,                 'BIOS shadowing is allowed'
+          boolean 13, :vl_vesa_supported,                      'VL-VESA is supported'
+          boolean 14, :escd_supported,                         'ESCD support is available'
+          boolean 15, :boot_from_CD_supported,                 'Boot from CD is supported'
+          boolean 16, :selectable_boot_supported,              'Selectable Boot is supported'
+          boolean 17, :bios_rom_socketed,                      'BIOS ROM is socketed '
+          boolean 18, :boot_from_PC_card_supported,            'Boot From PC Card (PCMCIA) is supported'
+          boolean 19, :edd_spec_supported,                     'EDD (Enhanced Disk Drive) Specification is supported'
+          boolean 20, :int13h_floppy_for_NEC_9800_supported,   'Int 13h - Japanese Floppy for NEC 9800 1.2mb (3.5", 1k Bytes/Sector, 360 RPM) is supported'
+          boolean 21, :int13h_floppy_for_Toshiba_supported,    'Int 13h - Japanese Floppy for Toshiba 1.2mb (3.5", 360 RPM) is supported'
+          boolean 22, :int13h_5_25_in_360_kb_floppy_supported, 'Int 13h - 5.25" / 360 KB Floppy Services are supported'
+          boolean 23, :int13h_5_25_in_1_2_mb_floppy_supported, 'Int 13h - 5.25" /1.2MB Floppy Services are supported'
+          boolean 24, :int13h_3_5_in_720_kb_floppy_supported,  'Int 13h - 3.5" / 720 KB Floppy Services are supported'
+          boolean 25, :int13h_3_5_in_2_88_mb_floppy_supported, 'Int 13h - 3.5" / 2.88 MB Floppy Services are supported'
+          boolean 26, :int5h_print_screen_services_supported,  'Int 5h, Print Screen Service is supported'
+          boolean 27, :int9h_8042_keyboard_services_supported, 'Int 9h, 8042 Keyboard services are supported'
+          boolean 28, :int14h_serial_services_supported,       'Int 14h, Serial Services are supported'
+          boolean 29, :int17h_printer_services_supported,      'Int 17h, Printer Services are supported'
+          boolean 30, :int10h_CGA_and_mono_video_supported,    'Int 10h, CGA/Mono Video Services are supported'
+          boolean 31, :nec_pc_98,                              'NEC PC-98'
+        end
+
+        set_unpack_data "IZ65Z65Z65xI", 204, [:vendor, :version, [:release_date, :date],
+                                             [:characteristics, :struct, Characteristics]]
+
+      end
+
+    end
+  end
+end

data/lib/amt/service/hardware_asset/computer_system.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+require 'amt/service/hardware_asset'
+
+module AMT
+  module Service
+    class HardwareAsset
+
+      # Represents the computer system that is managed by AMT device.
+      #
+      # There is at most one instance of this class in the hardware asset inventory of each AMT
+      # device.
+      #
+      # Available fields:
+      #
+      # [+manufacturer+] The name of the system manufacturer.
+      # [+product+] The name of the system product.
+      # [+version+] The version of the system product.
+      # [+serial_number+] The serial number of the system.
+      # [+uuid+] The UUID (Universal Unique ID) of the system. If it contains only +ff+, then the
+      #          UUID is not present but setable. If it contains only +00+, then it is not present.
+      class ComputerSystem < Asset
+
+        set_unpack_data "IZ65Z65Z65Z65H32", 280, [:manufacturer, :product, :version, :serial_number, [:uuid, :uuid]]
+
+      end
+
+    end
+  end
+end

data/lib/amt/service/hardware_asset/fru.rb

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+require 'amt/service/hardware_asset'
+
+module AMT
+  module Service
+    class HardwareAsset
+
+      # Represents a PCI/AGP add-in device of the system managed by the AMT device.
+      #
+      # There is at most one instance of this class for every PCI or AGP FRU in the hardware asset
+      # inventory of each AMT device.
+      #
+      # Available fields:
+      #
+      # [+vendor_id+] The value in the Vendor ID configuration space register.
+      # [+device_id+] The value in the Device ID configuration space register.
+      # [+revision_id+] The value in the Revision ID configuration space register.
+      # [+prog_if+] The value in the Programming Interface byte in the Class Code configuration
+      #             space register
+      # [+subclass+] The value in the Subclass byte in the Class Code configuration space register.
+      # [+base_class+] The value in the Base Class byte in the Class Code configuration space
+      #                register.
+      # [+subvendor_id+] The value in the Subvendor ID configuration space register.
+      # [+subsystem_id+] The value in the Subsystem ID configuration space register.
+      # [+device_location+] The bus and slot number where the device is installed.
+      class FRU < Asset
+
+        set_unpack_data "ISSCCCCSSSx2", 20, [:vendor_id, :device_id, :revision_id, :prog_if, :subclass, :base_class,
+                                            :subvendor_id, :subsystem_id, :device_location]
+
+      end
+
+    end
+  end
+end
+

data/lib/amt/service/hardware_asset/media_device.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+require 'amt/utility'
+require 'amt/service/hardware_asset'
+
+module AMT
+  module Service
+    class HardwareAsset
+
+      # Represents an IDE/SATA device of the system managed by the AMT device.
+      #
+      # There is at most one instance of this class for every physical media device in the hardware
+      # asset inventory of each AMT device.
+      #
+      # Available fields:
+      #
+      # [+model_number+] The model number of the media device.
+      # [+serial_number+] The serial number of the media device.
+      # [+capabilities+] The capabilities of the media device (an instance of Capabilities).
+      # [+max_media_size+] The maximum size in bytes of supported media.
+      class MediaDevice < Asset
+
+        # The capabilities of a media device.
+        class Capabilities < AMT::Utility::BitStruct
+          boolean 0,  :smart_fs_supported,               'SMART feature set supported'
+          boolean 1,  :security_mode_fs_supporte,        'Security Mode feature set supported'
+          boolean 2,  :removable_media_fs_supported,     'Removable Media feature set supported'
+          boolean 3,  :power_management_fs_supported,    'Power Management feature set supported'
+          boolean 4,  :packet_command_fs_supported,      'PACKET Command feature set supported'
+          boolean 5,  :write_cache_supported,            'write cache supported'
+          boolean 6,  :look_ahead_supported,             'look-ahead supported'
+          boolean 7,  :release_interrupt_supported,      'release interrupt supported'
+          boolean 8,  :service_interrupt_supported,      'SERVICE interrupt supported'
+          boolean 9,  :device_reset_command_supported,   'DEVICE RESET command supported'
+          boolean 10, :host_protected_area_fs_supported, 'Host Protected Area feature set supported'
+          boolean 12, :write_buffer_command_supported,   'WRITE BUFFER command supported'
+          boolean 13, :read_buffer_command_supported,    'READ BUFFER command supported'
+          boolean 15, :nop_command_supported,            'NOP command supported'
+          boolean 16, :download_microcode_command_supported, 'DOWNLOAD MICROCODE command supported'
+          boolean 17, :read_write_dma_queued_supported,      'READ/WRITE DMA QUEUED supported'
+          boolean 18, :cfa_fs_supported,                     'CFA feature set supported'
+          boolean 19, :advanced_power_management_fs_supported, 'Advanced Power Management feature set supported'
+          boolean 20, :remove_media_status_notification_fs_supported, 'Removable Media Status Notification feature set supported'
+        end
+
+        set_unpack_data "IA40A20a6a8x2", 80, [:model_number, :serial_number, [:capabilities, :raw],
+                                              [:max_media_size, lambda {|d|
+                                                 low, high = d.unpack("II")
+                                                 (high << 32) + low
+                                               }]]
+
+        def init_data(data) # :nodoc:
+          super
+          first, second, last = *@capabilities.unpack("SSS")
+          @capabilities = Capabilities.new((first << 32) + (second << 16) + last)
+        end
+        private :init_data
+
+      end
+
+    end
+  end
+end