ose: Create OSE application

Create an specific OSE application that mainly contains documentation
around the OSE specific part of Erlang/OTP.

10 files changed, 682 insertions, 0 deletions

diff --git a/lib/ose/doc/src/.gitignore b/lib/ose/doc/src/.gitignore
new file mode 100644
index 0000000000..860e9e703e
--- /dev/null
+++ b/lib/ose/doc/src/.gitignore
@@ -0,0 +1 @@
+ose.xml
diff --git a/lib/ose/doc/src/Makefile b/lib/ose/doc/src/Makefile
new file mode 100644
index 0000000000..dd58029064
--- /dev/null
+++ b/lib/ose/doc/src/Makefile
@@ -0,0 +1,132 @@
+#
+# %CopyrightBegin%
+#
+# Copyright Ericsson AB 1997-2012. All Rights Reserved.
+#
+# The contents of this file are subject to the Erlang Public License,
+# Version 1.1, (the "License"); you may not use this file except in
+# compliance with the License. You should have received a copy of the
+# Erlang Public License along with this software. If not, it can be
+# retrieved online at http://www.erlang.org/.
+#
+# Software distributed under the License is distributed on an "AS IS"
+# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+# the License for the specific language governing rights and limitations
+# under the License.
+#
+# %CopyrightEnd%
+#
+include $(ERL_TOP)/make/target.mk
+include $(ERL_TOP)/make/$(TARGET)/otp.mk
+
+# ----------------------------------------------------
+# Application version
+# ----------------------------------------------------
+include ../../vsn.mk
+VSN=$(OSE_VSN)
+APPLICATION=ose
+
+# ----------------------------------------------------
+# Release directory specification
+# ----------------------------------------------------
+RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
+
+# ----------------------------------------------------
+# Help application directory specification
+# ----------------------------------------------------
+EDOC_DIR = $(ERL_TOP)/lib/edoc
+SYNTAX_TOOLS_DIR = $(ERL_TOP)/lib/syntax_tools
+
+# ----------------------------------------------------
+# Target Specs
+# ----------------------------------------------------
+XML_APPLICATION_FILES = ref_man.xml
+
+XML_REF3_FILES = \
+	ose.xml \
+	ose_erl_driver.xml
+
+XML_REF6_FILES = ose_app.xml
+
+XML_PART_FILES = part.xml
+XML_CHAPTER_FILES = notes.xml ose_intro.xml ose_signals_chapter.xml
+
+BOOK_FILES = book.xml
+
+XML_FILES = \
+	$(BOOK_FILES) $(XML_CHAPTER_FILES) \
+	$(XML_PART_FILES) $(XML_REF3_FILES) $(XML_REF6_FILES) \
+	$(XML_APPLICATION_FILES)
+
+# ----------------------------------------------------
+
+HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \
+	$(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html)
+
+INFO_FILE = ../../info
+
+MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3)
+MAN6_FILES = $(XML_REF6_FILES:%_app.xml=$(MAN6DIR)/%.6)
+
+HTML_REF_MAN_FILE = $(HTMLDIR)/index.html
+
+TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf
+
+SPECS_FILES =
+
+TOP_SPECS_FILE =
+
+# ----------------------------------------------------
+# FLAGS
+# ----------------------------------------------------
+XML_FLAGS +=
+
+SPECS_FLAGS = -I../../include -I../../../kernel/include
+
+OSE_SRC_DIR = ../../src
+
+# ----------------------------------------------------
+# Targets
+# ----------------------------------------------------
+docs: man pdf html
+
+$(TOP_PDF_FILE): $(XML_FILES)
+
+pdf: $(TOP_PDF_FILE)
+
+html: $(HTML_REF_MAN_FILE)
+
+man: $(MAN3_FILES) $(MAN6_FILES)
+
+ose.xml: $(OSE_SRC_DIR)/ose.erl
+	escript $(DOCGEN)/priv/bin/xml_from_edoc.escript\
+	 $(OSE_SRC_DIR)/$(@:%.xml=%.erl)
+
+debug opt:
+
+clean clean_docs:
+	rm -rf $(HTMLDIR)/*
+	rm -f $(MAN3DIR)/*
+	rm -f $(MAN6DIR)/*
+	rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo)
+	rm -f $(SPECDIR)/*
+	rm -f errs core *~
+
+# ----------------------------------------------------
+# Release Target
+# ----------------------------------------------------
+include $(ERL_TOP)/make/otp_release_targets.mk
+
+release_docs_spec: docs
+	$(INSTALL_DIR) "$(RELSYSDIR)/doc/pdf"
+	$(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELSYSDIR)/doc/pdf"
+	$(INSTALL_DIR) "$(RELSYSDIR)/doc/html"
+	$(INSTALL_DATA) $(HTMLDIR)/* \
+		"$(RELSYSDIR)/doc/html"
+	$(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)"
+	$(INSTALL_DIR) "$(RELEASE_PATH)/man/man3"
+	$(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3"
+	$(INSTALL_DIR) "$(RELEASE_PATH)/man/man6"
+	$(INSTALL_DATA) $(MAN6_FILES) "$(RELEASE_PATH)/man/man6"
+
+release_spec:
diff --git a/lib/ose/doc/src/book.xml b/lib/ose/doc/src/book.xml
new file mode 100644
index 0000000000..485806e05b
--- /dev/null
+++ b/lib/ose/doc/src/book.xml
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE book SYSTEM "book.dtd">
+
+<book xmlns:xi="http://www.w3.org/2001/XInclude">
+  <header titlestyle="normal">
+    <copyright>
+      <year>2014</year><year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>OSE</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2014-01-08</date>
+    <rev>1.0</rev>
+    <file>book.xml</file>
+  </header>
+  <insidecover>
+  </insidecover>
+  <pagetext>OSE</pagetext>
+  <preamble>
+    <contents level="2"></contents>
+  </preamble>
+  <parts>
+    <xi:include href="part.xml"/>
+  </parts>
+  <applications>
+    <xi:include href="ref_man.xml"/>
+  </applications>
+  <releasenotes>
+    <xi:include href="notes.xml"/>
+  </releasenotes>
+  <listofterms></listofterms>
+  <index></index>
+</book>
diff --git a/lib/ose/doc/src/notes.xml b/lib/ose/doc/src/notes.xml
new file mode 100644
index 0000000000..760b92feed
--- /dev/null
+++ b/lib/ose/doc/src/notes.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE chapter SYSTEM "chapter.dtd">
+
+<chapter>
+  <header>
+    <copyright>
+      <year>2014</year><year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>OSE Release Notes</title>
+    <prepared></prepared>
+    <docno></docno>
+    <date></date>
+    <rev></rev>
+    <file>notes.xml</file>
+  </header>
+  <p>This document describes the changes made to the OSE application.</p>
+
+</chapter>
diff --git a/lib/ose/doc/src/ose_app.xml b/lib/ose/doc/src/ose_app.xml
new file mode 100644
index 0000000000..e40656fd7b
--- /dev/null
+++ b/lib/ose/doc/src/ose_app.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE appref SYSTEM "appref.dtd">
+
+<appref>
+  <header>
+    <copyright>
+      <year>2014</year><year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>Enea OSE</title>
+    <prepared></prepared>
+    <docno></docno>
+    <date></date>
+    <rev></rev>
+  </header>
+  <app>ose</app>
+  <appsummary>The OSE Application</appsummary>
+  <description>
+    <p>The OSE application contains modules and documentation that only
+    applies when running Erlang/OTP on Enea OSE.</p>
+  </description>
+
+</appref>
diff --git a/lib/ose/doc/src/ose_erl_driver.xml b/lib/ose/doc/src/ose_erl_driver.xml
new file mode 100644
index 0000000000..6687d78087
--- /dev/null
+++ b/lib/ose/doc/src/ose_erl_driver.xml
@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE cref SYSTEM "cref.dtd">
+
+<cref>
+  <header>
+    <copyright>
+      <year>2013</year><year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>erl_driver for Enea OSE</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2014-01-08</date>
+    <rev>A</rev>
+    <file>ose_erl_driver.xml</file>
+  </header>
+  <lib>ose_erl_driver</lib>
+  <libsummary>Linked-in drivers in Enea OSE</libsummary>
+  <description>
+    <p>Writing Linked-in drivers that also work on Enea OSE is very similar for
+    how you would do it for Unix. The difference from Unix is that
+    driver_select, ready_input and ready_output all work with signals
+    instead of file descriptors. This means that the driver_select is
+    used to specify which type of signal should trigger calls to
+    ready_input/ready_output. The functions described below are available
+    to driver programmers on Enea OSE to facilitate this.
+    </p>
+  </description>
+  <section>
+    <title>DATA TYPES</title>
+
+    <taglist>
+      <tag><marker id="union_SIGNAL"/>union SIGNAL</tag>
+      <item>See the Enea OSE SPI documentation for a description.</item>
+      <tag><marker id="SIGSELECT"/>SIGSELECT</tag>
+      <item>See the Enea OSE SPI documentation for a description.</item>
+      <tag><marker id="ErlDrvEvent"/>ErlDrvEvent</tag>
+      <item>The <c>ErlDrvEvent</c> is a handle to a signal number and id combination. It is passed to <seealso marker="erts:erl_driver#driver_select">driver_select(3)</seealso>.</item>
+      <tag><marker id="ErlDrvOseEventId"/>ErlDrvOseEventId</tag>
+      <item>This is the id used to associate a specific signal to a
+      certain driver instance. </item>
+    </taglist>
+  </section>
+  <funcs>
+    <func>
+      <name><ret>union SIGNAL *</ret><nametext>erl_drv_ose_get_signal(ErlDrvEvent drv_event)</nametext></name>
+      <desc>
+        <marker id="erl_drv_ose_get_signal"></marker>
+        <p>Fetch the next signal associated with <c>drv_event</c>.
+	Signals will be returned in the order which they were received and
+	when no more signals are available <c>NULL</c> will be returned.
+	Use this function in the ready_input/ready_output callbacks
+	to get signals.</p>
+      </desc>
+    </func>
+    <func>
+      <name><ret>ErlDrvEvent</ret><nametext>erl_drv_ose_event_alloc(SIGSELECT signo, ErlDrvOseEventId id, ErlDrvOseEventId (*resolve_signal)(union SIGNAL* sig))</nametext></name>
+      <desc>
+        <marker id="erl_drv_ose_event_alloc"></marker>
+        <p>Create a new <c>ErlDrvEvent</c> associated with <c>signo</c>,
+	<c>id</c> and uses the <c>resolve_signal</c> function to extract
+	the <c>id</c> from a signal with <c>signo</c>. See
+	<seealso marker="ose_erl_driver_chapter#driver">
+	Signals in a Linked-in driver</seealso> in the OSE User's Guide.
+      </p>
+      </desc>
+    </func>
+    <func>
+      <name><ret>void</ret><nametext>erl_drv_ose_event_free(ErlDrvEvent drv_event)</nametext></name>
+      <desc>
+        <marker id="erl_drv_ose_event_free"></marker>
+        <p>Free a <c>ErlDrvEvent</c>. This should always be done in the
+	<seealso marker="erts:driver_entry#stop_select">stop_select</seealso>
+	callback when the event is no longer being used.</p>
+      </desc>
+    </func>
+    <func>
+      <name><ret>void</ret><nametext>erl_drv_ose_event_fetch(ErlDrvEvent drv_event, SIGSELECT *signo, int *id)</nametext></name>
+      <desc>
+        <marker id="erl_drv_ose_event_fetch"></marker>
+        <p>Write the signal number and id associated with <c>drv_event</c>
+	into <c>*signo</c> and <c>*id</c> respectively. <c>NULL</c> can be
+	also passed as <c>signo</c> or <c>id</c> in order to ignore that field.
+	</p>
+      </desc>
+    </func>
+  </funcs>
+  <section>
+    <title>SEE ALSO</title>
+    <p>
+      <seealso marker="erts:driver_entry">driver_entry(3)</seealso>,
+      <seealso marker="erts:erl_driver">erl_driver(3)</seealso>
+    </p>
+  </section>
+</cref>
diff --git a/lib/ose/doc/src/ose_intro.xml b/lib/ose/doc/src/ose_intro.xml
new file mode 100644
index 0000000000..3bab325289
--- /dev/null
+++ b/lib/ose/doc/src/ose_intro.xml
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE chapter SYSTEM "chapter.dtd">
+
+<chapter>
+  <header>
+    <copyright>
+      <year>2013</year><year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>Introduction</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2014-01-08</date>
+    <rev>A</rev>
+    <file>ose_intro.xml</file>
+  </header>
+
+  <section>
+    <title>Features</title>
+  </section>
+
+  <section>
+    <title>run_erl and to_erl</title>
+    <p>
+      In OSE run_erl and to_erl are combined into a single load module called
+      run_erl_lm. Installing and starting the load module will add two new
+      shell commands called run_erl and to_erl. They work in exactly the same
+      way as the unix variants of run_erl and to_erl, except that the read
+      and write pipes have to be placed under the /pipe vm. See also
+      <seealso marker="erts:run_erl">run_erl</seealso> for more details.
+    </p>
+  </section>
+
+</chapter>
diff --git a/lib/ose/doc/src/ose_signals_chapter.xml b/lib/ose/doc/src/ose_signals_chapter.xml
new file mode 100644
index 0000000000..2a6ddb5765
--- /dev/null
+++ b/lib/ose/doc/src/ose_signals_chapter.xml
@@ -0,0 +1,197 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE chapter SYSTEM "chapter.dtd">
+
+<chapter>
+  <header>
+    <copyright>
+      <year>2013</year><year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>Interacting with Enea OSE</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2014-01-08</date>
+    <rev>A</rev>
+    <file>ose_signals_chapter.xml</file>
+  </header>
+
+  <marker id="introduction"></marker>
+  <section>
+    <title>Introduction</title>
+    <p>The main way which programs on Enea OSE interact is through the
+    usage of message passing, much the same way as Erlang processes
+    communicate. There are two ways in which an Erlang programmer can
+    interact with the signals sent from other Enea OSE processes; either
+    through the provided <c>ose</c> module, or by writing a custom linked-in
+    driver. This User's Guide describes and provides examples for both
+    approaches.
+    </p>
+  </section>
+
+  <marker id="erlang"></marker>
+  <section>
+    <title>Signals in Erlang</title>
+  </section>
+
+  <marker id="driver"></marker>
+  <section>
+    <title>Signals in a Linked-in driver</title>
+    <p>
+      Writing Linked-in drivers for OSE is very similar to how it is done
+      for Unix/Windows. It is only the way in which the driver subscribes
+      and consumed external events that is different. In Unix (and Windows)
+      file descriptiors (and Event Objects) are used to select on. On OSE
+      we use signals to deliver the same functionality. There are two large
+      differences between a signal and an fd.
+    </p>
+    <p>
+      In OSE it is not possible for a signal number to be a unique identifier
+      for a resource in the same way as an fd is. For example; let's say we
+      implement a driver that does an asynchronous hunt that uses signal
+      number 1234 as the hunt_sig. If we want to be able to have multiple
+      hunt ports running at the same time we have to have someway of routing
+      the signal to the correct port. This is achieved by supplying a secondary
+      id that can be retrieved through the meta-data or payload of the signal,
+      e.g:
+      <code>ErlDrvEvent event = erl_drv_ose_event_alloc(1234,port,resolver);</code>
+      The event you get back from
+      <seealso marker="ose_erl_driver#erl_drv_ose_event_alloc">
+      erl_drv_ose_event_alloc</seealso> can then be used by
+      <seealso marker="erts:erl_driver#driver_select">driver_select</seealso>
+      to subscribe to signals. The first argument is just the signal number
+      that we are interested in. The second is the id that we choose to use,
+      in this case the port id that we got in the
+      <seealso marker="erts:driver_entry#start">start</seealso> callback is
+      used. The third argument is a function pointer to a function that can
+      be used to figure out the id from a given signal. There is a complete
+      example of what this could look like in
+      <seealso marker="example">the next section</seealso>.
+      <note>It is very important to issue the driver_select call before
+      any of the signals you are interested in are sent. If driver_select
+      is called after the signal is sent, there is a high probability that it
+      will be lost.</note>
+    </p>
+    <p>
+      The other difference from unix is that in OSE the payload of the event
+      (i.e. the signal data) is already received when the ready_output/input
+      callbacks are called. This means that you access the data of a signal
+      by calling <seealso marker="ose_erl_driver#erl_drv_ose_get_signal">
+      erl_drv_ose_get_signal</seealso>. Additionally multiple signals might be
+      associated with the event, so you should call
+      <seealso marker="ose_erl_driver#erl_drv_ose_get_signal">
+      erl_drv_ose_get_signal</seealso> until <c>NULL</c> is returned.
+    </p>
+  </section>
+
+  <marker id="example"></marker>
+  <section>
+    <title>Example Linked-in driver</title>
+<code>#include "erl_driver.h"
+#include "ose.h"
+
+struct huntsig {
+  SIGSELECT signo;
+  ErlDrvPort port;
+};
+
+union SIGNAL {
+  SIGSELECT signo;
+  struct huntsig;
+}
+
+/* Here we have to get the id from the signal. In this case we use the
+   port id since we have control over the data structure of the signal.
+   It is however possible to use anything in here. The only restriction
+   is that the same id has to be used for all signals of the same number.*/
+ErlDrvOseEventId resolver(union SIGNAL *sig) {
+  return (ErlDrvOseEventId)sig->huntsig.port;
+}
+
+static int drv_init(void) { return 0; };
+
+static ErlDrvData drv_start(ErlDrvPort port, char *command) {
+  return (ErlDrvData)port;
+}
+
+static ErlDrvSSizeT control(ErlDrvData driver_data, unsigned int cmd,
+                            char *buf, ErlDrvSizeT len,
+                            char **rbuf, ErlDrvSizeT rlen) {
+  ErlDrvPort port = (ErlDrvPort)driver_data;
+
+  /* Create a new event to select on */
+  ErlDrvOseEvent evt = erl_drv_ose_event_alloc(1234,port,resolver);
+
+  /* Make sure to do the select call _BEFORE_ the signal arrives.
+     The signal might get lost if the hunt call is done before the
+     select. */
+  driver_select(port,evt,ERL_DRV_READ|ERL_DRV_USE,1);
+
+  union SIGNAL *sig = alloc(sizeof(union SIGNAL),1234);
+  sig->huntsig.port = port;
+  hunt("testprocess",0,NULL,&amp;sig);
+  return 0;
+}
+
+static void ready_input(ErlDrvData driver_data, ErlDrvEvent evt) {
+  /* Get the first signal payload from the event */
+  union SIGNAL *sig = erl_drv_ose_get_signal(evt);
+  ErlDrvPort port = (ErlDrvPort)driver_data;
+  while (sig != NULL) {
+    if (sig->signo == 1234) {
+      /* If it is our signal we send a message with the sender of the signal
+         to the controlling erlang process */
+      ErlDrvTermData reply[] = { ERL_DRV_UINT, (ErlDrvUInt)sender(&amp;sig) };
+      erl_drv_send_term(port,reply,sizeof(reply) / sizeof(reply[0]));
+    }
+
+    /* Cleanup the signal and deselect on the event.
+       Note that the event itself has to be free'd in the stop_select
+       callback. */
+    free_buf(&amp;sig);
+    driver_select(port,evt,ERL_DRV_READ|ERL_DRV_USE,0);
+
+    /* There could be more than one signal waiting in this event, so
+       we have to loop until sig == NULL */
+    sig = erl_drv_ose_get_signal(evt);
+  }
+}
+
+static void stop_select(ErlDrvEvent event, void *reserved)
+{
+  erl_drv_ose_event_free(event);
+}
+
+/**
+ * Setup the driver entry for the Erlang runtime
+ **/
+ErlDrvEntry ose_signal_driver_entry = {
+  .init                         = drv_init,
+  .start                        = drv_start,
+  .stop                         = drv_stop,
+  .ready_input                  = ready_input,
+  .driver_name                  = DRIVER_NAME,
+  .control                      = control,
+  .extended_marker              = ERL_DRV_EXTENDED_MARKER,
+  .major_version                = ERL_DRV_EXTENDED_MAJOR_VERSION,
+  .minor_version                = ERL_DRV_EXTENDED_MINOR_VERSION,
+  .driver_flags                 = ERL_DRV_FLAG_USE_PORT_LOCKING,
+  .stop_select                  = stop_select
+};
+</code>
+  </section>
+
+</chapter>
diff --git a/lib/ose/doc/src/part.xml b/lib/ose/doc/src/part.xml
new file mode 100644
index 0000000000..250bb11f96
--- /dev/null
+++ b/lib/ose/doc/src/part.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE part SYSTEM "part.dtd">
+
+<part xmlns:xi="http://www.w3.org/2001/XInclude">
+  <header>
+    <copyright>
+      <year>2014</year>
+      <year>2014</year>
+      <holder>Ericsson AB, All Rights Reserved</holder>
+    </copyright>
+    <legalnotice>
+  The contents of this file are subject to the Erlang Public License,
+  Version 1.1, (the "License"); you may not use this file except in
+  compliance with the License. You should have received a copy of the
+  Erlang Public License along with this software. If not, it can be
+  retrieved online at http://www.erlang.org/.
+
+  Software distributed under the License is distributed on an "AS IS"
+  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+  the License for the specific language governing rights and limitations
+  under the License.
+
+  The Initial Developer of the Original Code is Ericsson AB.
+    </legalnotice>
+
+    <title>OSE User's Guide</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2014-01-08</date>
+    <rev>1.0</rev>
+    <file>part.xml</file>
+  </header>
+  <description>
+    <p><em>OSE</em>.</p>
+  </description>
+  <xi:include href="ose_intro.xml"/>
+  <xi:include href="ose_signals_chapter.xml"/>
+</part>
diff --git a/lib/ose/doc/src/ref_man.xml b/lib/ose/doc/src/ref_man.xml
new file mode 100644
index 0000000000..54c1182fcb
--- /dev/null
+++ b/lib/ose/doc/src/ref_man.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE application SYSTEM "application.dtd">
+
+<application xmlns:xi="http://www.w3.org/2001/XInclude">
+  <header>
+    <copyright>
+      <year>2014</year><year>2014</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      The contents of this file are subject to the Erlang Public License,
+      Version 1.1, (the "License"); you may not use this file except in
+      compliance with the License. You should have received a copy of the
+      Erlang Public License along with this software. If not, it can be
+      retrieved online at http://www.erlang.org/.
+
+      Software distributed under the License is distributed on an "AS IS"
+      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+      the License for the specific language governing rights and limitations
+      under the License.
+
+    </legalnotice>
+
+    <title>OSE Reference Manual</title>
+    <prepared>Lukas Larsson</prepared>
+    <docno></docno>
+    <date>2014-01-08</date>
+    <rev>1.0</rev>
+    <file>ref_man.xml</file>
+  </header>
+  <description>
+    <p>The Standard Erlang Libraries application, <em>STDLIB</em>,
+      contains modules for manipulating lists, strings and files etc.</p>
+    <br></br>
+  </description>
+  <xi:include href="ose_app.xml"/>
+  <xi:include href="ose.xml"/>
+  <xi:include href="ose_erl_driver.xml"/>
+</application>