From 368673eab1344fee79932e2dd96289fa6748d8be Mon Sep 17 00:00:00 2001 From: Jianxun Zhang Date: Thu, 5 Jan 2017 16:15:35 -0800 Subject: 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 --- documentation/rmc/README | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) (limited to 'documentation') diff --git a/documentation/rmc/README b/documentation/rmc/README index dbee6b6d..eaa763e1 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. |- ...more files Note 0: -To add your boards into RMC feature, simply put this line in your -rmc-db.bbappend: +Developers are expected to use variable RMC_BOARD_DATA_DIRS to specify data of +boards packed into RMC database file generated in a build. The default value of +the variable in meta-intel specifies a group of boards. They work as examples +and necessary quirks for these boards to function properly. Developers can +override, append to the default boards with data of their own boards in the +database file, or even disable the generation of the database file. -RMC_BOARD_DATA_DIRS_append := " ${THISDIR}/my_top_dir" +For example, in your local.conf file: -RMC db recipe takes all top directories specified in RMC_BOARD_DATA_DIRS to -construct and deploy a central RMC database inside image. The bbclass of the -bare RMC project also provide function for other components to construct their -own RMC database file. Please refer to rmc-db.bbclass for more information. +This line adds your boards along with the default boards into RMC database file, +assuming you have a directory named "rmc" which has a subdirectory for each +board: + +RMC_BOARD_DATA_DIRS_append = " /path_of/rmc" + +This line directs RMC to pack data of your boards only, without data of the +default boards in meta-intel: + +RMC_BOARD_DATA_DIRS = "/path_of/rmc" + +And this line disables database generation: + +RMC_BOARD_DATA_DIRS = "" + +Please also refer to the "Example 1" in this document. Subdirectory is not supported in a board's directory. @@ -175,15 +191,8 @@ bootloader please overwrite the RMC_BOOTLOADER variable in your local.conf Note: Image could be still bootable if you only have either of two lines, but RMC -feature won't be fully functional. - -To install only the RMC client with the systemd-boot bootloader without -including a default RMC database file, add the following lines to your -local.conf: - -EFI_PROVIDER = "systemd-boot" -IMAGE_INSTALL_append = " rmc" - +feature could not be fully functional, depending on the availability of the +database file, installer and the rmc tool. Examples -------------------------------------------------------------------------------- -- cgit v1.2.3-54-g00ecf