summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOla Redell <ola.redell@retotech.se>2017-12-17 22:39:33 +0100
committerOla Redell <ola.redell@retotech.se>2017-12-17 22:39:33 +0100
commit6c9981b7a368cf047ce98bc49e2beb74c58d4775 (patch)
treea4f3bdd02e89f1ba469cf39167235dc279c8c0f3
parente6918ce8cdff0884169f2548cf793c781333d4b9 (diff)
downloadmeta-jailhouse-6c9981b7a368cf047ce98bc49e2beb74c58d4775.tar.gz
README.md: updated to cover example image and MACHINE
-rw-r--r--README.md47
1 files changed, 30 insertions, 17 deletions
diff --git a/README.md b/README.md
index 59c0f0e..b336987 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,10 @@ This layer depends on:
17 layers: meta 17 layers: meta
18 branch: master 18 branch: master
19 19
20 URI: https://github.com/linux-sunxi/meta-sunxi
21 branch: master
22 tested with 7f88e6c78e7014960654c8f4b3bb0c4e188f0f43
23
20 24
21Maintainers 25Maintainers
22=========== 26===========
@@ -35,6 +39,7 @@ Tested with
35* Yocto 2.2 39* Yocto 2.2
36* This layer has been developed for and tested with Bananapi M1 as target. 40* This layer has been developed for and tested with Bananapi M1 as target.
37No other targets have been used thus far. 41No other targets have been used thus far.
42* meta-sunxi, 7f88e6c78e7014960654c8f4b3bb0c4e188f0f43
38 43
39 44
40Adding the jailhouse layer to your build 45Adding the jailhouse layer to your build
@@ -114,23 +119,6 @@ Using this class and variables ensures that the file designated by the
114`CELLCONFIG` variable is pulled into the jailhouse build such that 119`CELLCONFIG` variable is pulled into the jailhouse build such that
115a corresponding *.cell file is created. 120a corresponding *.cell file is created.
116 121
117Example cell
118------------
119
120An example cell recipe for the freertos-cell from Siemens is available
121under `recipes-jailhouse/freertos-cell`. To use this, set the
122`CELLS` variable accordingly as described above.
123
124Test the cell by executing the following sequence once booted.
125
126 export JAILHOUSE_DIR=/usr/share/jailhouse
127 jailhouse enable ${JAILHOUSE_DIR}/cells/bananapi.cell
128 jailhouse cell create ${JAILHOUSE_DIR}/cells/freertos-cell.cell
129 jailhouse cell load FreeRTOS ${JAILHOUSE_DIR}/inmates/freertos-demo.bin
130 jailhouse cell start FreeRTOS
131
132You should see output on the serial port used by the FreeRTOS inmate.
133
134Important Variables 122Important Variables
135=================== 123===================
136 124
@@ -168,3 +156,28 @@ are installed. This defaults to ${JH_DATADIR}/cells.
168 156
169`INMATES_DIR` Target directory into which inmate binaries (.bin) are installed. 157`INMATES_DIR` Target directory into which inmate binaries (.bin) are installed.
170Defaults to ${JH_DATADIR}/inmates. 158Defaults to ${JH_DATADIR}/inmates.
159
160Example image
161=============
162
163Build the example image `jailhouse-image` using the included machine
164configuration `jailhouse-bpi` together with the provided kernel recipe:
165
166 MACHINE=jailhouse-bpi bitbake jailhouse-image
167
168Example cell
169------------
170
171An example cell recipe for the freertos-cell from Siemens is available
172under `recipes-jailhouse/freertos-cell`. To use this, set the
173`CELLS` variable accordingly as described above.
174
175Test the cell by executing the following sequence once booted.
176
177 export JAILHOUSE_DIR=/usr/share/jailhouse
178 jailhouse enable ${JAILHOUSE_DIR}/cells/bananapi.cell
179 jailhouse cell create ${JAILHOUSE_DIR}/cells/freertos-cell.cell
180 jailhouse cell load FreeRTOS ${JAILHOUSE_DIR}/inmates/freertos-demo.bin
181 jailhouse cell start FreeRTOS
182
183You should see output on the serial port used by the FreeRTOS inmate.