diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/rmc/README | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/documentation/rmc/README b/documentation/rmc/README index ba476b0e..c392eb2d 100644 --- a/documentation/rmc/README +++ b/documentation/rmc/README | |||
@@ -70,6 +70,7 @@ following this example, so that RMC recipes can pick up them correctly in build. | |||
70 | | |- board1.fp fingerprint file must be provided (NOTE 1) | 70 | | |- board1.fp fingerprint file must be provided (NOTE 1) |
71 | | |- BOOTENTRY.CONFIG optional config file for boot entries. (NOTE 2) | 71 | | |- BOOTENTRY.CONFIG optional config file for boot entries. (NOTE 2) |
72 | | |- INSTALLER.CONFIG optional config file for installer. (NOTE 3) | 72 | | |- INSTALLER.CONFIG optional config file for installer. (NOTE 3) |
73 | | |- POSTINSTALL.sh optional script hook for installer (NOTE 4) | ||
73 | | |- board_file_1 A file blob specific to the type of board | 74 | | |- board_file_1 A file blob specific to the type of board |
74 | | |- board_file_2 An another file specific to the type of board | 75 | | |- board_file_2 An another file specific to the type of board |
75 | | |- ...more files | 76 | | |- ...more files |
@@ -153,6 +154,13 @@ Installer simply ignores any errors in RMC deployment stage. | |||
153 | The name of this config file is what installer looks up first, so it must be | 154 | The name of this config file is what installer looks up first, so it must be |
154 | INSTALLER.CONFIG. | 155 | INSTALLER.CONFIG. |
155 | 156 | ||
157 | Note 4: | ||
158 | At the end of RMC deployment during installation, RMC installer queries a script | ||
159 | file POSTINSTALL.sh from RMC database file, and execute it when query is | ||
160 | successful on the running board. This hook provides developers almost ultimate | ||
161 | flexibility to retouch what have been deployed on the target. There are some | ||
162 | steps still can override results from this hook for boot entries and KBOOTPARAM. | ||
163 | |||
156 | 164 | ||
157 | 165 | ||
158 | Enable RMC Feature | 166 | Enable RMC Feature |
@@ -236,7 +244,8 @@ This is a combo example with all supported configuration data for NUC Gen 6 | |||
236 | product. It shows two boot entries in bootloader menu when you boot image on NUC | 244 | product. It shows two boot entries in bootloader menu when you boot image on NUC |
237 | Gen 6 product, with "NUC Gen6" in entry titles. There shall no any "console=" in | 245 | Gen 6 product, with "NUC Gen6" in entry titles. There shall no any "console=" in |
238 | /proc/cmdline when you boot with either of two "NUC Gen6"entries. We designed it | 246 | /proc/cmdline when you boot with either of two "NUC Gen6"entries. We designed it |
239 | this way because there is no accessible tty port on NUC Gen 6 with housing. | 247 | this way because there is no accessible tty port on NUC Gen 6 with housing. The |
248 | post-install hook is also provided in this example. | ||
240 | 249 | ||
241 | This example also includes a global kernel cmdline fragment KBOOTPARAM. Content | 250 | This example also includes a global kernel cmdline fragment KBOOTPARAM. Content |
242 | of KBOOTPARAM shall be at the end of /proc/cmdline no matter which boot entry | 251 | of KBOOTPARAM shall be at the end of /proc/cmdline no matter which boot entry |
@@ -256,6 +265,10 @@ A directory /etc/mylib/ is created and a file "mylib.conf" is there. The content | |||
256 | of that file shall be what we put in mylib.conf in | 265 | of that file shall be what we put in mylib.conf in |
257 | common/recipes-bsp/rmc/boards/nucgen6 | 266 | common/recipes-bsp/rmc/boards/nucgen6 |
258 | 267 | ||
268 | POSTINSTALL.sh shows how we get rid of an error message caused by no serial | ||
269 | console available on NUC Gen 6, without creating another static board | ||
270 | configuration. | ||
271 | |||
259 | EXAMPLE 4: For validation only | 272 | EXAMPLE 4: For validation only |
260 | T100 (32bit): | 273 | T100 (32bit): |
261 | common/recipes-bsp/rmc/boards/T100-32bit | 274 | common/recipes-bsp/rmc/boards/T100-32bit |