external plat: Add basic documentation.

Signed-off-by: Haibo Xu <haibo.xu@arm.com>
Reviewed-by: Felipe Huici <felipe.huici@neclab.eu>

diff --git a/CODING_STYLE.md b/CODING_STYLE.md
new file mode 100644 (file)
index 0000000..5730041
--- /dev/null
+++ b/CODING_STYLE.md
@@ -0,0 +1,4 @@
+Coding Style
+============
+
+Please refer to the `CODING_STYLE.md` file in the main Unikraft repository.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..5f55eca
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,4 @@
+Contributing to Unikraft
+=======================
+
+Please refer to the `CONTRIBUTING.md` file in the main Unikraft repository.

diff --git a/COPYING.md b/COPYING.md
new file mode 100644 (file)
index 0000000..cc7d888
--- /dev/null
+++ b/COPYING.md
@@ -0,0 +1,46 @@
+License
+=======
+
+Unikraft solo5 wrappers
+------------------------
+
+This repository contains wrapper code to build solo5 platform support in Unikraft.
+The code is published as a mixture of BSD and MIT licences; each C code file in
+this repository should declare who is the copyright owner and under which terms
+and conditions the code is licensed. If such a licence note is missing, the
+following copyright notice will apply:
+
+       Copyright (c) 2019, NEC Europe Ltd., NEC Corporation. All rights reserved.
+
+       Redistribution and use in source and binary forms, with or without
+       modification, are permitted provided that the following conditions
+       are met:
+
+       1. Redistributions of source code must retain the above copyright
+          notice, this list of conditions and the following disclaimer.
+       2. Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+       3. Neither the name of the copyright holder nor the names of its
+          contributors may be used to endorse or promote products derived from
+          this software without specific prior written permission.
+
+       THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+       ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+       INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+       CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+       POSSIBILITY OF SUCH DAMAGE.
+
+solo5 source code
+------------------
+
+During building, the build system will download the solo5 source code and build
+source code from the `libsolo5/` directories. The code in these directories has
+a variety of licences, the details of which are explained in the `LICENSE` file
+in the root directory of the solo5 code.

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
new file mode 100644 (file)
index 0000000..c798e64
--- /dev/null
+++ b/MAINTAINERS.md
@@ -0,0 +1,11 @@
+Maintainers List
+================
+
+For notes on how to read this information, please refer to `MAINTAINERS.md` in
+the main Unikraft repository.
+
+       SOLO5-UNIKRAFT
+       M:      Felipe Huici <felipe.huici@neclab.eu>
+       M:      Haibo Xu <haibo.xu@arm.com>
+       L:      minios-devel@lists.xen.org
+       F: *

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..a821729
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+solo5 for Unikraft
+===================
+
+Once the build process finished successfully, The solo5 monitor(**solo5-hvt**)
+as well as the corresponding app (for example, helloworld_solo5-x86_64) can be
+found in the `build` directory and run with: ::
+
+~/unikraft/apps/helloworld/build$ sudo ./solo5-hvt helloworld_solo5-x86_64
+solo5-hvt: helloworld_solo5-x86_64: Warning: phdr[0] requests WRITE and EXEC permissions
+            |      ___|
+  __|  _ \  |  _ \ __ \
+\__ \ (   | | (   |  ) |
+____/\___/ _|\___/____/
+Solo5: Memory map: 512 MB addressable:
+Solo5:     unused @ (0x0 - 0xfffff)
+Solo5:       text @ (0x100000 - 0x109f2e)
+Solo5:     rodata @ (0x109f2f - 0x10dd07)
+Solo5:       data @ (0x10dd08 - 0x112fff)
+Solo5:       heap >= 0x113000 < stack < 0x20000000
+Welcome to  _ __             _____
+ __ _____  (_) /__ _______ _/ _/ /_
+/ // / _ \/ /  '_// __/ _ `/ _/ __/
+\_,_/_//_/_/_/\_\/_/  \_,_/_/ \__/
+              Iapetus 0.3.1~798fdc8
+Hello world!
+Arguments:
+Solo5: solo5_exit(0) called
+~/unikraft/apps/helloworld/build$
+
+The syntax of the **solo5-hvt** command is listed below, and you can also refer to
+the solo5 project main page(https://github.com/Solo5/solo5) for more information ::
+
+usage: solo5-hvt [ CORE OPTIONS ] [ MODULE OPTIONS ] [ -- ] KERNEL [ ARGS ]
+KERNEL is the filename of the unikernel to run.
+ARGS are optional arguments passed to the unikernel.
+Core options:
+  [ --mem=512 ] (guest memory in MB)
+    --help (display this help)
+Compiled-in modules: core dumpcore blk net gdb
+Compiled-in module options:
+    --dumpcore (enable guest core dump on abort/trap)
+    --disk=IMAGE (file exposed to the unikernel as a raw block device)
+    --net=TAP (host tap device for guest network interface or @NN tap fd)
+    [ --net-mac=HWADDR ] (guest MAC address)
+    --gdb (optional flag for running in a gdb debug session)
+    [ --gdb-port=1234 ] (port to use)
+
+
+Please also refer to the `README.md` as well as the documentation in the `doc/`
+subdirectory of the main unikraft repository.
+