path: root/documentation
diff options
authorJianxun Zhang <>2017-01-06 00:15:35 (GMT)
committerCalifornia Sullivan <>2017-01-09 20:53:33 (GMT)
commit368673eab1344fee79932e2dd96289fa6748d8be (patch)
treecb0a2830796ca8fc37e5e7fa104af2a0c6a8fae0 /documentation
parent499b251ce6b52fbc81cfb97b4aee73329bcc1255 (diff)
rmc: Extend usages of RMC_BOARD_DATA_DIRS to specify board data
Use the variable RMC_BOARD_DATA_DIRS, to disable, append to, or override the default board data in meta-intel with boards' data provided by users. Ideally, users should get the updated database in the new built image after an incremental build. Examples of RMC database output (db): RMC_BOARD_DATA_DIRS = "" (disable db generation) RMC_BOARD_DATA_DIRS_append = " top_dir" (db of defaults & user's) RMC_BOARD_DATA_DIRS = "top_dir" (db for user's , no defaults) RMC_BOARD_DATA_DIRS = " " (same as "") Signed-off-by: Jianxun Zhang <> Signed-off-by: California Sullivan <>
Diffstat (limited to 'documentation')
1 files changed, 25 insertions, 16 deletions
diff --git a/documentation/rmc/README b/documentation/rmc/README
index dbee6b6..eaa763e 100644
--- a/documentation/rmc/README
+++ b/documentation/rmc/README
@@ -82,15 +82,31 @@ following this example, so that RMC recipes can pick up them correctly in build.
82 |- ...more files 82 |- ...more files
83 83
84Note 0: 84Note 0:
85To add your boards into RMC feature, simply put this line in your 85Developers are expected to use variable RMC_BOARD_DATA_DIRS to specify data of
86rmc-db.bbappend: 86boards packed into RMC database file generated in a build. The default value of
87the variable in meta-intel specifies a group of boards. They work as examples
88and necessary quirks for these boards to function properly. Developers can
89override, append to the default boards with data of their own boards in the
90database file, or even disable the generation of the database file.
87 91
88RMC_BOARD_DATA_DIRS_append := " ${THISDIR}/my_top_dir" 92For example, in your local.conf file:
89 93
90RMC db recipe takes all top directories specified in RMC_BOARD_DATA_DIRS to 94This line adds your boards along with the default boards into RMC database file,
91construct and deploy a central RMC database inside image. The bbclass of the 95assuming you have a directory named "rmc" which has a subdirectory for each
92bare RMC project also provide function for other components to construct their 96board:
93own RMC database file. Please refer to rmc-db.bbclass for more information. 97
98RMC_BOARD_DATA_DIRS_append = " /path_of/rmc"
100This line directs RMC to pack data of your boards only, without data of the
101default boards in meta-intel:
103RMC_BOARD_DATA_DIRS = "/path_of/rmc"
105And this line disables database generation:
109Please also refer to the "Example 1" in this document.
94 110
95Subdirectory is not supported in a board's directory. 111Subdirectory is not supported in a board's directory.
96 112
@@ -175,15 +191,8 @@ bootloader please overwrite the RMC_BOOTLOADER variable in your local.conf
175 191
176Note: 192Note:
177Image could be still bootable if you only have either of two lines, but RMC 193Image could be still bootable if you only have either of two lines, but RMC
178feature won't be fully functional. 194feature could not be fully functional, depending on the availability of the
179 195database file, installer and the rmc tool.
180To install only the RMC client with the systemd-boot bootloader without
181including a default RMC database file, add the following lines to your
184EFI_PROVIDER = "systemd-boot"
185IMAGE_INSTALL_append = " rmc"
187 196
188Examples 197Examples
189-------------------------------------------------------------------------------- 198--------------------------------------------------------------------------------