New sphinx-based documentation was added for the vcan driver.

This is a port of the old texinfo documentation. Most of the texts were taken
without any changes of the content.

MultiCAN/src/drivers/vcan/doc/Makefile

+# 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) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(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/vcan.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/vcan.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/vcan"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/vcan"
+	@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."

MultiCAN/src/drivers/vcan/doc/README

+This is the source of the vcan documentation. It uses the "sphinx" tool.
+
+Build the documentation with:
+
+  make html
+
+Install the documentation on www-csr.bessy.de with:
+
+  . ./doc-to-wwwcsr.sh

MultiCAN/src/drivers/vcan/doc/VCAN4_DEVICE_NAME.rst

+VCAN4_DEVICE_NAME
+=================
+
+Here is the definition::
+
+  #define VCAN4_DEVICE_NAME "/dev/vcan4"
+
+This is the devicename that must be used to open the driver.

MultiCAN/src/drivers/vcan/doc/VCAN_DEVICE_NAME.rst

+VCAN_DEVICE_NAME
+================
+
+Here is the definition::
+
+  #define VCAN_DEVICE_NAME "/dev/vcan"
+
+This is the devicename that must be used to open the driver.

MultiCAN/src/drivers/vcan/doc/VCAN_MAJOR_VERSION.rst

+VCAN_MAJOR_VERSION
+==================
+
+Here is the definition::
+
+  #define VCAN_MAJOR_VERSION 1
+
+This is the major version number of the vcan driver, which is the version
+number before the period, e.g. version 1.3 has a major version number of 1.
+Note that this version-number is defined in the driver's header-file vcan.h,
+but in order to test whether the version of the currently used driver is the
+same you should use ``VCAN_IOCTL_VERSION`` function.

MultiCAN/src/drivers/vcan/doc/VCAN_MAX_DATASIZE.rst

+VCAN_MAX_DATASIZE
+=================
+
+Here is the definition::
+
+  #define VCAN_MAX_DATASIZE 8
+
+This constant defines the maximum number of data bytes that can be
+transferred in one frame by the CAN bus. It is always 8 since this is
+compliant to the CAN specification.

MultiCAN/src/drivers/vcan/doc/VCAN_MAX_READ_OBJECTS.rst

+VCAN_MAX_READ_OBJECTS
+=====================
+
+Here is the definition::
+
+  #define VCAN_MAX_READ_OBJECTS 20
+
+This constant defines the maximum number of objects that the
+``VCAN_READ_MANY`` function can handle in one call. This is also a provision
+against usage errors since an undefined array of object-id's given to the
+``VCAN_READ_MANY`` function will probably exceed ``VCAN_MAX_READ_OBJECTS``
+in it's length.

MultiCAN/src/drivers/vcan/doc/VCAN_MINOR_VERSION.rst

+VCAN_MINOR_VERSION
+==================
+
+Here is the definition::
+
+  #define VCAN_MINOR_VERSION 7
+
+This is the major version number of the vcan driver, which is the version
+number before the period, e.g. version 1.3 has a minor version number of 3.
+See also ``VCAN_MAJOR_VERSION``.

MultiCAN/src/drivers/vcan/doc/VCAN_MIN_DATASIZE.rst

+VCAN_MIN_DATASIZE
+=================
+
+Here is the definition::
+
+  #define VCAN_MIN_DATASIZE 0
+
+This constant defines the minimal number of data bytes that can be
+transferred in one frame by the CAN bus. It is always 0 since this is
+compliant to the CAN specification.

MultiCAN/src/drivers/vcan/doc/_templates/impressum_link.html

+<h5><a href="http://www.helmholtz-berlin.de/impressum_de.html" >Imprint<br>Impressum</a></h5>
+

MultiCAN/src/drivers/vcan/doc/addresses_and_configuration.rst

+Adresses and card configuration
+===============================
+
+The drive supports 4 VME-CAN2 or 4 VME-CAN4 cards at a time. Each card has
+to be configured differenty in order to avoid interrupt or address conflicts
+with the other VME cards. Click on the following links for further
+information:
+
+.. toctree::
+   :maxdepth: 2
+
+   VME-CAN2 addresses <vme-can2-addresses>
+   VME-CAN2 configuration <vme-can2-configuration>
+   VME-CAN4 addresses <vme-can4-addresses>
+   VME-CAN4 configuration <vme-can4-configuration>

MultiCAN/src/drivers/vcan/doc/conf.py

+# -*- coding: utf-8 -*-
+#
+# vcan documentation build configuration file, created by
+# sphinx-quickstart on Thu Jul 11 12:38:05 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
+
+# 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 = []
+
+# 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'vcan'
+copyright = u'2013, Helmholtz-Zentrum Berlin GmbH'
+show_authors= True
+
+# 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 = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# 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 = ['_build']
+
+# 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 = 'default'
+
+# 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 = []
+
+# 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 = "logo_hzb_big.png"
+
+# 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 = {"**":['localtoc.html', 'relations.html', 
+                       'sourcelink.html', 'searchbox.html',
+                       'impressum_link.html']}
+
+
+# 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 = 'vcandoc'
+
+
+# -- 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', 'vcan.tex', u'vcan Documentation',
+   u'Goetz Pfeiffer \\textless{}Goetz.Pfeiffer@helmholtz-berlin.de\\textgreater{}', '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', 'vcan', u'vcan Documentation',
+     [u'Goetz Pfeiffer <Goetz.Pfeiffer@helmholtz-berlin.de>'], 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', 'vcan', u'vcan Documentation',
+   u'Goetz Pfeiffer <Goetz.Pfeiffer@helmholtz-berlin.de>', 'vcan', 'One line description of project.',
+   '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'

MultiCAN/src/drivers/vcan/doc/doc-to-wwwcsr.sh

+#!/bin/sh
+
+make html
+
+scp -r _build/html/* wwwcsr@www-csr.bessy.de:/home/wwwcsr/www/control/vcan

MultiCAN/src/drivers/vcan/doc/examples.rst

+Examples
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   open and close the driver <open-close-example>
+   define a CAN object <object-definition-example>
+   read data from a CAN object <read-example>
+   write data from a CAN object <write-example>

MultiCAN/src/drivers/vcan/doc/functions.rst

+Functions
+=========
+
+This is the list of functions:
+
+.. toctree::
+   :maxdepth: 2
+
+   vcanDrv/vcan4Drv: standard driver initialization <vcanDrv>
+   vcanDrvp/vcan4Drvp: parameterized driver initialization <vcanDrvp>
+   vcanDrvpar/vcan4Drvpar: even more parameterized driver initialization <vcanDrvpar>

MultiCAN/src/drivers/vcan/doc/index.rst

+.. vcan documentation master file, created by
+   sphinx-quickstart on Thu Jul 11 12:38:05 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+================================
+Welcome to vcan's documentation!
+================================
+
+This is a driver for the CAN interface cards VME-CAN2 and VME-CAN4 for the
+VxWorks operating system.
+
+:Author: Goetz Pfeiffer <Goetz.Pfeiffer@helmholtz-berlin.de>
+
+Documentation
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   introduction
+   macros
+   types
+   functions
+   examples
+   addresses_and_configuration
+
+License
+=======
+
+This software of this project can be used unter the HZB :doc:`license`.
+
+Indices and tables
+==================
+
+* :ref:`search`
+

MultiCAN/src/drivers/vcan/doc/introduction.rst

+Introduction
+============
+
+This is the documentation for the vcan CAN-Bus driver for the VxWorks
+operating system developed at Helmholtz-Zentrum Berlin. This documentation
+describes basic concepts of the driver and the types and constants defined
+vcan.h. The driver is accessed with the usual io-functions such as ``read``,
+``write`` and ``ioctl`` that are part of the operating system. For these
+reasons, vcan.h defines almost no functions but only types and constants
+that have to be used with the operating system-functions.
+
+Although the driver has one set of source files compiling it creates two
+binaries, "vcan.o" and "vcan4.o". "vcan.o" is the driver version for the
+VME-CAN2 card while "vcan4.o" is the driver version for the VME-CAN4 card.
+Both can co-exist on an IOC meaning that both object files can be loaded
+without conflicts with respect to exported symbols. "vcan.o" creates a
+driver with the device filename "/dev/vcan" while "vcan4.o" creates a driver
+with the device filename "/dev/vcan4". Note that although both drivers may
+be loaded on one IOC the IOC can only have one kind of CAN bus cards, either
+all VME-CAN2 or all VME-CAN4.
+
+Here are some explanations of terms used in this document:
+
+Frame
+  This is a single CAN message. Logically, a frame consists of the
+  CAN-Object Id and 0 up to 8 data bytes. The actual bits that make up a
+  frame on the CAN bus are a few more, consisting of a 16 Bit CRC, sync.
+  bits and some other informations. As a rule of thumb, the data bits
+  (except the CAN Id) make up only half of the bits of the whole frame.
+
+CAN Id
+  This is the Id of the data frame. This is also called CAN-object Id or
+  object-Id for short. CAN Id's can range from 0 to 2047.
+
+Object
+  Since CAN can only transfer broadcast messages, in principle each CAN
+  device receives all CAN frames that are sent. However, in order to filter