Hardware: Created documentation

7 files changed, 725 insertions, 0 deletions

diff --git a/src/hardware/doc/Makefile b/src/hardware/doc/Makefile
new file mode 100644
index 0000000..09b395e
--- /dev/null
+++ b/src/hardware/doc/Makefile
@@ -0,0 +1,159 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext mof
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+mof:
+	make -C source/mof
+
+mof-clean:
+	make -C source/mof clean
+
+clean: mof-clean
+	-rm -rf $(BUILDDIR)/*
+
+html: mof
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLMIHardware.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLMIHardware.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLMIHardware"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLMIHardware"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/src/hardware/doc/source/conf.py b/src/hardware/doc/source/conf.py
new file mode 100644
index 0000000..4b492f6
--- /dev/null
+++ b/src/hardware/doc/source/conf.py
@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+#
+# OpenLMI Account documentation build configuration file, created by
+# sphinx-quickstart on Wed Aug 21 16:15:23 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+def setup(app):
+    # Register new option to include class list and class tree in index.rst
+    app.add_config_value('includeClasses', 'True', True)
+includeClasses = True
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.ifconfig', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'OpenLMI Hardware'
+copyright = u'2012-2013, Red Hat Inc.'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.3.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.3.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'openlmitheme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['../../../../tools/']
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenLMIHardwaredoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'OpenLMIHardware.tex', u'OpenLMI Hardware Documentation',
+   u'Peter Schiffer', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'openlmihardware', u'OpenLMI Hardware Documentation',
+     [u'Peter Schiffer'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'OpenLMIHardware', u'OpenLMI Hardware Documentation',
+   u'Peter Schiffer', 'OpenLMIHardware', 'Hardware information.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/src/hardware/doc/source/dmtf-profiles.rst b/src/hardware/doc/source/dmtf-profiles.rst
new file mode 100644
index 0000000..7f38a2f
--- /dev/null
+++ b/src/hardware/doc/source/dmtf-profiles.rst
@@ -0,0 +1,135 @@
+.. _dmtf-profiles:
+
+DMTF profiles
+=============
+The provider is partially implementing DMTF's
+`Computer System Profile <http://www.dmtf.org/sites/default/files/standards/documents/DSP1052_1.0.2.pdf>`_,
+version 1.0.2, with addition of multiple hardware related profiles. Complete list
+of implemented profiles can be found below.
+
+CPU Profile
+-----------
+`CPU DMTF Profile <http://www.dmtf.org/sites/default/files/standards/documents/DSP1022_1.0.1.pdf>`_,
+version 1.0.1.
+
+Classes
+^^^^^^^
+Implemented DMTF classes:
+
+.. generated by for file in *Provider.c; do prov="${file%%Provider.c}"; printf '* :ref:`%s <%s>`\n\n' "$prov" "${prov/_/-}"; done
+
+* :ref:`LMI_Processor <LMI-Processor>`
+
+* :ref:`LMI_ProcessorCapabilities <LMI-ProcessorCapabilities>`
+
+* :ref:`LMI_ProcessorElementCapabilities <LMI-ProcessorElementCapabilities>`
+
+* :ref:`LMI_ProcessorCacheMemory <LMI-ProcessorCacheMemory>`
+
+* :ref:`LMI_AssociatedProcessorCacheMemory <LMI-AssociatedProcessorCacheMemory>`
+
+* :ref:`LMI_ProcessorChip <LMI-ProcessorChip>`
+
+* :ref:`LMI_ProcessorChipRealizes <LMI-ProcessorChipRealizes>`
+
+* :ref:`LMI_ProcessorChipContainer <LMI-ProcessorChipContainer>`
+
+* :ref:`LMI_ProcessorSystemDevice <LMI-ProcessorSystemDevice>`
+
+System Memory Profile
+---------------------
+`System Memory DMTF Profile <http://www.dmtf.org/sites/default/files/standards/documents/DSP1026_1.0.1.pdf>`_,
+version 1.0.1.
+
+Classes
+^^^^^^^
+Implemented DMTF classes:
+
+.. generated by for file in *Provider.c; do prov="${file%%Provider.c}"; printf '* :ref:`%s <%s>`\n\n' "$prov" "${prov/_/-}"; done
+
+* :ref:`LMI_Memory <LMI-Memory>`
+
+* :ref:`LMI_MemoryPhysicalPackage <LMI-MemoryPhysicalPackage>`
+
+* :ref:`LMI_PhysicalMemory <LMI-PhysicalMemory>`
+
+* :ref:`LMI_PhysicalMemoryRealizes <LMI-PhysicalMemoryRealizes>`
+
+* :ref:`LMI_PhysicalMemoryContainer <LMI-PhysicalMemoryContainer>`
+
+* :ref:`LMI_MemorySlot <LMI-MemorySlot>`
+
+* :ref:`LMI_MemorySlotContainer <LMI-MemorySlotContainer>`
+
+* :ref:`LMI_MemoryPhysicalPackageInConnector <LMI-MemoryPhysicalPackageInConnector>`
+
+* :ref:`LMI_MemorySystemDevice <LMI-MemorySystemDevice>`
+
+Physical Asset Profile
+----------------------
+`Physical Asset DMTF Profile <http://www.dmtf.org/sites/default/files/standards/documents/DSP1011_1.0.2.pdf>`_,
+version 1.0.2.
+
+Classes
+^^^^^^^
+Implemented DMTF classes:
+
+.. generated by for file in *Provider.c; do prov="${file%%Provider.c}"; printf '* :ref:`%s <%s>`\n\n' "$prov" "${prov/_/-}"; done
+
+* :ref:`LMI_Chassis <LMI-Chassis>`
+
+* :ref:`LMI_Baseboard <LMI-Baseboard>`
+
+* :ref:`LMI_BaseboardContainer <LMI-BaseboardContainer>`
+
+* :ref:`LMI_PointingDevice <LMI-PointingDevice>`
+
+* :ref:`LMI_PortPhysicalConnector <LMI-PortPhysicalConnector>`
+
+* :ref:`LMI_PortPhysicalConnectorContainer <LMI-PortPhysicalConnectorContainer>`
+
+* :ref:`LMI_SystemSlot <LMI-SystemSlot>`
+
+* :ref:`LMI_SystemSlotContainer <LMI-SystemSlotContainer>`
+
+* :ref:`LMI_ChassisComputerSystemPackage <LMI-ChassisComputerSystemPackage>`
+
+Battery Profile
+---------------
+`Battery DMTF Profile <http://www.dmtf.org/sites/default/files/standards/documents/DSP1030_1.0.0.pdf>`_,
+version 1.0.0.
+
+Classes
+^^^^^^^
+Implemented DMTF classes:
+
+.. generated by for file in *Provider.c; do prov="${file%%Provider.c}"; printf '* :ref:`%s <%s>`\n\n' "$prov" "${prov/_/-}"; done
+
+* :ref:`LMI_Battery <LMI-Battery>`
+
+* :ref:`LMI_BatteryPhysicalPackage <LMI-BatteryPhysicalPackage>`
+
+* :ref:`LMI_PhysicalBatteryContainer <LMI-PhysicalBatteryContainer>`
+
+* :ref:`LMI_PhysicalBatteryRealizes <LMI-PhysicalBatteryRealizes>`
+
+* :ref:`LMI_BatterySystemDevice <LMI-BatterySystemDevice>`
+
+PCI Device Profile
+------------------
+`PCI Device DMTF Profile <http://www.dmtf.org/sites/default/files/standards/documents/DSP1075_1.0.0.pdf>`_,
+version 1.0.0.
+
+Classes
+^^^^^^^
+Implemented DMTF classes:
+
+.. generated by for file in *Provider.c; do prov="${file%%Provider.c}"; printf '* :ref:`%s <%s>`\n\n' "$prov" "${prov/_/-}"; done
+
+* :ref:`LMI_PCIDevice <LMI-PCIDevice>`
+
+* :ref:`LMI_PCIDeviceSystemDevice <LMI-PCIDeviceSystemDevice>`
+
+* :ref:`LMI_PCIBridge <LMI-PCIBridge>`
+
+* :ref:`LMI_PCIBridgeSystemDevice <LMI-PCIBridgeSystemDevice>`
diff --git a/src/hardware/doc/source/index.rst b/src/hardware/doc/source/index.rst
new file mode 100644
index 0000000..6913b46
--- /dev/null
+++ b/src/hardware/doc/source/index.rst
@@ -0,0 +1,27 @@
+.. OpenLMI Hardware documentation
+
+OpenLMI Hardware Provider documentation
+=======================================
+OpenLMI Hardware is CIM provider which can provide hardware information.
+
+The provider is partially implementing DMTF Computer System Profile with
+addition of multiple hardware related profiles. For more information see
+:ref:`DMTF profiles <dmtf-profiles>`.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   dmtf-profiles
+   info
+
+.. ifconfig:: includeClasses
+
+   OpenLMI Hardware CIM Classes:
+
+   .. toctree::
+      :maxdepth: 1
+
+      mof/tree
+      mof/index
diff --git a/src/hardware/doc/source/info.rst b/src/hardware/doc/source/info.rst
new file mode 100644
index 0000000..3dfa91e
--- /dev/null
+++ b/src/hardware/doc/source/info.rst
@@ -0,0 +1,142 @@
+.. _info:
+
+OpenLMI Hardware information
+============================
+OpenLMI Hardware provider contains hardware information, it does not
+implement any methods. List of provided information divided by DMTF profiles
+can be found below.
+
+CPU Profile
+-----------
+CPU Profile provides information about CPU and associated cache:
+
+* Processor
+
+  - Number of CPUs, cores, threads
+  - Model
+  - Clock and FSB speeds
+  - Data and Address width
+  - Architecture
+  - Flags
+  - Family
+  - Stepping
+  - FRU data (Manufacturer, Model, Serial Number, Part Number)
+
+* Processor Cache
+
+  - Level
+  - Size
+  - Type (Data / Instruction / Unified)
+
+Used Resources
+^^^^^^^^^^^^^^
+* dmidecode program *[from dmidecode package]*
+* lscpu program *[from util-linux package]*
+* /proc/cpuinfo file
+* /sys/devices/system/cpu/* files
+
+System Memory Profile
+---------------------
+System Memory Profile provides information about system memory and slots:
+
+* Memory
+
+  - Size
+  - Speed (in both MHz and ns)
+  - Size of standard memory page
+  - All supported sizes of huge pages
+  - Current state of transparent huge pages [Unsupported, Never, Madvise, Always]
+  - Detection of NUMA layout
+
+* Memory slots + modules
+
+  - Number of slots and modules
+  - In which slots are modules plugged in
+  - Size of modules
+  - Speed of modules
+  - Data and Total width
+  - Module type and form factor
+  - FRU data
+
+Used Resources
+^^^^^^^^^^^^^^
+* dmidecode program *[from dmidecode package]*
+* /proc/meminfo file
+* /sys/devices/system/node/* files
+* /sys/kernel/mm/hugepages/* files
+* /sys/kernel/mm/transparent_hugepage/* files
+
+Physical Asset Profile
+----------------------
+Physical Asset Profile provides basic information about physical assets
+in system, usually with FRU data, currently for following hardware
+(with associations):
+
+* System chassis
+* Baseboard (motherboard)
+* Chassis ports (USB, LAN, VGA..)
+* Chassis slots (Media card slot, Express card slot..)
+* Pointing devices on chassis (Touch pad, Track point..)
+
+Used Resources
+^^^^^^^^^^^^^^
+* dmidecode program *[from dmidecode package]*
+
+Battery Profile
+---------------
+Battery Profile provides basic information about battery:
+
+* Capacity
+* Voltage
+* Chemistry
+* FRU data
+
+Used Resources
+^^^^^^^^^^^^^^
+* dmidecode program *[from dmidecode package]*
+
+PCI Device Profile
+------------------
+PCI Device Profile provides information about PCI devices:
+
+* PCI Devices:
+
+  - Bus Number
+  - Device Number
+  - Function Number
+  - PCI Device ID
+  - PCI Device Name
+  - Vendor ID
+  - Vendor Name
+  - Subsystem ID
+  - Subsystem Name
+  - Subsystem Vendor ID
+  - Subsystem Vendor Name
+  - Revision ID
+  - Base Address
+  - Cache Line Size
+  - Capabilities
+  - Class Code
+  - Command Register
+  - Device Select Timing
+  - Interrupt Pin
+  - Latency Timer
+  - Expansion ROM Base Address
+
+* PCI Bridges (all of the above, plus):
+
+  - Bridge Type
+  - Primary Bus Number
+  - Secondary Bus Number
+  - Subordinate Bus Number
+  - Secondary Latency Timer
+  - IO Base
+  - IO Limit
+  - Memory Base
+  - Memory Limit
+  - Prefetch Memory Base
+  - Prefetch Memory Limit
+
+Used Resources
+^^^^^^^^^^^^^^
+* libpci library *[from pciutils package, pci/pci.h header file]*
diff --git a/src/hardware/doc/source/mof/Makefile b/src/hardware/doc/source/mof/Makefile
new file mode 100644
index 0000000..39aae6c
--- /dev/null
+++ b/src/hardware/doc/source/mof/Makefile
@@ -0,0 +1,13 @@
+all: index.rst
+
+TOPDIR=../../../../..
+MOFS=$(TOPDIR)/mof/60_LMI_Hardware.mof
+
+clean:
+	rm -f *.rst
+
+index.rst: $(MOFS)
+	$(TOPDIR)/tools/openlmi-doc-class2rst -H header.txt -M `echo $(MOFS) | sed 's/ / -M /g'` \
+		-S /usr/share/mof/cim-current/CIM_Schema.mof \
+		`cat $(MOFS) | grep "^class" | cut -d ' ' -f 2 | sed 's/://'`
+
diff --git a/src/hardware/doc/source/mof/header.txt b/src/hardware/doc/source/mof/header.txt
new file mode 100644
index 0000000..cc06402
--- /dev/null
+++ b/src/hardware/doc/source/mof/header.txt
@@ -0,0 +1,2 @@
+Class reference
+===============