HDF配置管理概述
HCS(HDF Configuration Source)是 HDF 驅(qū)動(dòng)框架的配置描述源碼,內(nèi)容以 Key-Value 為主要形式。它實(shí)現(xiàn)了配置代碼與驅(qū)動(dòng)代碼解耦,便于開(kāi)發(fā)者進(jìn)行配置管理。HC-GEN(HDF Configuration Generator)是 HCS 配置轉(zhuǎn)換工具,可以將 HDF 配置文件轉(zhuǎn)換為軟件可讀取的文件格式:
-
在弱性能環(huán)境中,轉(zhuǎn)換為配置樹(shù)源碼,驅(qū)動(dòng)可直接調(diào)用 C 代碼獲取配置。
-
在高性能環(huán)境中,轉(zhuǎn)換為 HCB(HDF Configuration Binary)二進(jìn)制文件,驅(qū)動(dòng)可使用 HDF 框架提供的配置解析接口獲取配置。
以下是使用 HCB 模式的典型應(yīng)用場(chǎng)景:
HCS 經(jīng)過(guò) HC-GEN 編譯生成 HCB 文件,HDF 驅(qū)動(dòng)框架中的 HCS Parser 模塊會(huì)從 HCB 文件中重建配置樹(shù),HDF 驅(qū)動(dòng)模塊使用 HCS Parser 提供的配置讀取接口獲取配置內(nèi)容。
圖2 HCS的架構(gòu)圖
HCS 文本更適合人類(lèi)閱讀,但是并不方便程序直接存取,所以經(jīng)過(guò) HC-GEN 編譯,輸出二進(jìn)制的 HCB 數(shù)據(jù)。HCB 在編譯后打包進(jìn)內(nèi)核鏡像的.rodata 只讀分區(qū),在啟動(dòng)加載時(shí),框架定位到 HCB 數(shù)據(jù)頭,再將二進(jìn)制數(shù)據(jù)重新構(gòu)造為樹(shù)形數(shù)據(jù)結(jié)構(gòu)供驅(qū)動(dòng)查詢和讀取。下面詳細(xì)分析 HC-GEN 實(shí)現(xiàn)。HCS源碼語(yǔ)法
HCS 的語(yǔ)法介紹如下: 關(guān)鍵字HCS 配置語(yǔ)法保留了以下關(guān)鍵字:
-
屬性
屬性即最小的配置單元,是一個(gè)獨(dú)立的配置項(xiàng)。語(yǔ)法如下:
attribute_name = value;
attribute_name 是字母、數(shù)字、下劃線的組合且必須以字母或下劃線開(kāi)頭,字母區(qū)分大小寫(xiě)。value 的可用格式如下:-
數(shù)字常量,支持二進(jìn)制、八進(jìn)制、十進(jìn)制、十六進(jìn)制數(shù),具體參考數(shù)據(jù)類(lèi)型節(jié)。
-
字符串,內(nèi)容使用雙引號(hào)("")引用。
-
節(jié)點(diǎn)引用。
-
attribute 必須以分號(hào)(;)結(jié)束且必須屬于一個(gè) node。
-
節(jié)點(diǎn)
節(jié)點(diǎn)是一組屬性的集合,語(yǔ)法如下:
1. node_name {
2. module = "sample";
3. ...
4.}
-
node_name 是字母、數(shù)字、下劃線的組合且必須以字母或下劃線開(kāi)頭,字母區(qū)分大小寫(xiě)。
-
大括號(hào)后無(wú)需添加結(jié)束符“;”。
-
root為保留關(guān)鍵字,用于聲明配置表的根節(jié)點(diǎn)。每個(gè)配置表必須以 root 節(jié)點(diǎn)開(kāi)始。
-
root 節(jié)點(diǎn)中必須包含 module 屬性,其值應(yīng)該為一個(gè)字符串,用于表征該配置所屬模塊。
-
節(jié)點(diǎn)中可以增加 match_attr 屬性,其值為一個(gè)全局唯一的字符串。在解析配置時(shí)可以調(diào)用查找接口以該屬性的值查找到包含該屬性的節(jié)點(diǎn)。
- 整型
整型長(zhǎng)度自動(dòng)推斷,根據(jù)實(shí)際數(shù)據(jù)長(zhǎng)度給與最小空間占用的類(lèi)型。
-
二進(jìn)制,0b 前綴,示例:0b1010。
-
八進(jìn)制,0 前綴,示例:0664。
- 十進(jìn)制 ,無(wú)前綴,且支持有符號(hào)與無(wú)符號(hào),示例:1024,+1024 均合法。負(fù)值在讀取時(shí)注意使用有符號(hào)數(shù)讀取接口。
-
十六進(jìn)制,0x 前綴,示例:0xff00、0xFF。
-
字符串
字符串使用雙引號(hào)("")表示。
-
數(shù)組
attr_foo = [0x01, 0x02, 0x03, 0x04];
attr_bar=["hello","world"];
-
bool類(lèi)型
1. // comment
多行注釋?zhuān)?/span>其他語(yǔ)法2. /*
3. comment
4.*/
- 模板
使用 template 關(guān)鍵字定義模板 node,子 node 通過(guò)雙冒號(hào)“::”聲明繼承關(guān)系。子節(jié)點(diǎn)可以改寫(xiě)但不能新增和刪除 template 中的屬性,子節(jié)點(diǎn)中沒(méi)有定義的屬性將使用 template 中的定義作為默認(rèn)值。示例如下:
生成配置樹(shù)如下:root {
module = "sample";
template foo {
attr_1 = 0x1;
attr_2 = 0x2;
}
bar :: foo {
}
bar_1 :: foo {
attr_1 = 0x2;
}
}
在上述示例中,bar 和 bar_1 節(jié)點(diǎn)繼承了 foo 節(jié)點(diǎn),生成配置樹(shù)節(jié)點(diǎn)結(jié)構(gòu)與 foo 保持了完全一致,只是屬性的值不同。root {
module = "sample";
bar {
attr_1 = 0x1;
attr_2 = 0x2;
}
bar_1 {
attr_1 = 0x2;
attr_2 = 0x2;
}
}
-
引用修改
node :& source_node
上述語(yǔ)句表示 node 中的內(nèi)容是對(duì) source_node 節(jié)點(diǎn)內(nèi)容的修改。示例如下:最終生成配置樹(shù)為:root {
module = "sample";
foo {
foo_ :& root.bar{
attr = "foo";
}
foo1 :& foo2 {
attr = 0x2;
}
foo2 {
attr = 0x1;
}
}
bar {
attr = "bar";
}
}
在以上示例中,可以看到 foo.foo_節(jié)點(diǎn)通過(guò)引用將 bar.attr 屬性的值修改為了"foo",foo.foo1 節(jié)點(diǎn)通過(guò)引用將 foo.foo2.attr 屬性的值修改為了 0x2。root {
module = "sample";
foo {
foo2 {
attr = 0x2;
}
}
bar {
attr = "foo";
}
}
foo.foo_以及 foo.foo1 節(jié)點(diǎn)表示對(duì)目標(biāo)節(jié)點(diǎn)內(nèi)容的修改,其自身并不會(huì)存在最終生成的配置樹(shù)中。
- 引用同級(jí) node,可以直接使用 node 名稱(chēng),否則被引用的節(jié)點(diǎn)必須使用絕對(duì)路徑,節(jié)點(diǎn)間使用“.”分隔,root 表示根節(jié)點(diǎn),格式為 root 開(kāi)始的節(jié)點(diǎn)路徑序列,例如 root.foo.bar 即為一個(gè)合法的絕對(duì)路徑。
- 如果出現(xiàn)修改沖突(即多處修改同一個(gè)屬性),編譯器將提示 warning,因?yàn)檫@種情況下只會(huì)生效某一個(gè)修改而導(dǎo)致最終結(jié)果不確定。
node : source_node
上述語(yǔ)句表示在定義"node"節(jié)點(diǎn)時(shí)將另一個(gè)節(jié)點(diǎn)"source_node"的屬性復(fù)制過(guò)來(lái)。示例如下:上述代碼的最終生成配置樹(shù)為:root {
module = "sample";
foo {
attr_0 = 0x0;
}
bar:foo {
attr_1 = 0x1;
}
}
在上述示例中,編譯后 bar 節(jié)點(diǎn)即包含 attr_0 屬性也包含 attr_1 屬性,在 bar 中對(duì) attr_0 的修改不會(huì)影響到 foo。在 foo 和 bar 在同級(jí) node 中可不指定 foo 的路徑,否則需要使用絕對(duì)路徑引用。root {
module = "sample";
foo {
attr_0 = 0x0;
}
bar {
attr_1 = 0x1;
attr_0 = 0x0;
}
}
刪除
要對(duì) include 導(dǎo)入的 base 配置樹(shù)中不需要的節(jié)點(diǎn)或?qū)傩赃M(jìn)行刪除,可以使用 delete 關(guān)鍵字。下面的舉例中 sample1.hcs 通過(guò) include 導(dǎo)入了 sample2.hcs 中的配置內(nèi)容,并使用 delete 刪除了 sample2.hcs 中的 attribute2 屬性和 foo_2 節(jié)點(diǎn),示例如下:屬性引用為了在解析配置時(shí)快速定位到關(guān)聯(lián)的節(jié)點(diǎn),可以把節(jié)點(diǎn)作為屬性的右值,通過(guò)讀取屬性查找到對(duì)應(yīng)節(jié)點(diǎn)。語(yǔ)法為:1. #include "sample1.hcs"
2. root {
3. attr_2 = delete;
4. foo_2 : delete {
5. }
6.}
1. attribute = &node;
HCB二進(jìn)制格式
HCB 為便于程序讀取的 HCS 的二進(jìn)制數(shù)據(jù)格式,按照下面的編碼表進(jìn)行數(shù)據(jù)組織:
以一個(gè)示例分析下 HCS 源碼和 HCB 的對(duì)應(yīng)關(guān)系:
上述 HCS 編譯后的 HCB 數(shù)據(jù)如下:root {
module = "sample";
gpio = [1, 2];
}
HC-GEN使用介紹
hc-gen 是 HCS 的編譯器,用于在編譯時(shí)將 HCS 轉(zhuǎn)化為 HCB,也可以將 HCB 反編譯為 HCS 以驗(yàn)證配置數(shù)據(jù)的正確性,這在驅(qū)動(dòng)調(diào)試時(shí)將很有幫助。hc-gen v0.7 之前版本作為 prebuilt 文件以二進(jìn)制下載方式提供。0.7 版本開(kāi)始,為了更好的支持多環(huán)境部署和版本管理,hc-gen 在編譯過(guò)程中從源碼構(gòu)建。如果調(diào)試需要,可以在 OpenHarmony 源碼的 drivers/framework/tools/hc-gen 下執(zhí)行 make 生成,生成產(chǎn)物在該目錄的 build 子目錄中。驅(qū)動(dòng)開(kāi)發(fā)過(guò)程中,在 hcs 配置文件修改后,可以手動(dòng)使用 hc-gen 快速驗(yàn)證配置的正確性,生成 HCB 配置文件方法:cd drivers/framework/tools/hc-gen
make
./build/hc-gen –v
>Hcscompiler0.7
hc-gen -o [OutputHcbFileName] -b [SourceHcsFileName]
在驅(qū)動(dòng)調(diào)試時(shí),可以使用 hc-gen 反編譯 HCB 文件獲得 HCS 源碼,進(jìn)行配置數(shù)據(jù)核對(duì)。反編譯 HCB 文件為 HCS 方法:
hc-gen -o [OutputHcsFileName] -d [SourceHcbFileName]
HCS文件編譯過(guò)程
在 linux 內(nèi)核中,HCS 編譯基于 KBuild 自定義規(guī)則實(shí)現(xiàn)自主的編譯過(guò)程,Makefile 入口在 drivers/adapter/khdf/linux/hcs/Makefile。在 HDF 適配其他平臺(tái)時(shí),可以復(fù)用該 Makefile,核心變化點(diǎn)在正確配置對(duì)應(yīng)平臺(tái)的 HCS 根路徑。HC_GEN_DIR := $(abspath $(SOURCE_ROOT)/drivers/framework/tools/hc-gen)
HC_GEN := $(HC_GEN_DIR)/build/hc-gen
LOCAL_HCS_ROOT := $(abspath $(dir $(realpath $(lastword $(MAKEFILE_LIST)))))
# LOCAL_HCS_ROOT為根據(jù)目標(biāo)平臺(tái)和產(chǎn)品拼接出的HCS路徑
HCS_DIR := $(LOCAL_HCS_ROOT)
HCB_FLAGS := -b -i -a
HCS_OBJ := hdf_hcs_hex.o
HCS_OBJ_SRC := $(subst .o,.c,$(notdir $(HCS_OBJ)))
CONFIG_GEN_HEX_SRC := $(addprefix $(LOCAL_HCS_ROOT)/, $(HCS_OBJ_SRC))
CONFIG_HCS_SRC := $(subst _hcs_hex.o,.hcs,$(addprefix $(HCS_DIR)/, $(HCS_OBJ)))
# 使用自定義的.o生成規(guī)則覆蓋KBbuild默認(rèn)規(guī)則
$(obj)/$(HCS_OBJ): $(CONFIG_GEN_HEX_SRC)
$(Q)$(CC) $(c_flags) -c -o $@ $<
$(Q)rm -f $<
# 將HCB文件生成后再轉(zhuǎn)換為.c文件中的hex數(shù)組,依賴目標(biāo)為hc-gen工具
$(CONFIG_GEN_HEX_SRC): $(LOCAL_HCS_ROOT)/%_hcs_hex.c: $(HCS_DIR)/%.hcs | $(HC_GEN)
$(Q)echo gen hdf built-in config
$(Q)if [ ! -d $(dir $@) ]; then mkdir -p $(dir $@); fi
$(Q)$(HC_GEN) $(HCB_FLAGS) -o $(subst _hex.c,,$(@)) $<
# 生成hc-gen工具
$(HC_GEN):
$(Q)make -C $(HC_GEN_DIR)
obj-$(CONFIG_DRIVERS_HDF)+=$(HCS_OBJ)
HCS配置使用
HCS配置讀取接口
在驅(qū)動(dòng)實(shí)現(xiàn)中,可以使用 device_resource_if.h 中定義的接口對(duì)配置進(jìn)行查詢和讀取。常用 API 介紹如下:
在 hi35xx_uart_config.hcs 中配置如下:device_uart :: device {
device0 :: deviceNode {
policy = 1;
priority = 40;
permission = 0644;
moduleName = "HDF_PLATFORM_UART";
serviceName = "HDF_PLATFORM_UART_0";
deviceMatchAttr = "hisilicon_hi35xx_uart_0";
}
}
注意到 UART 使用了 match_attr 特性,這樣驅(qū)動(dòng)框架在 device_uart 設(shè)備加載時(shí)將自動(dòng)將 device_uart_0x0000 節(jié)點(diǎn)關(guān)聯(lián)到該設(shè)備。UART 的配置解析代碼如下:root {
platform {
uart_config {
device_uart_0x0000 {
serviceName = "";
match_attr = "hisilicon_hi35xx_uart_0";
driver_name = "ttyAMA";
num = 0;
}
}
}
}
device_uart_0x0000 節(jié)點(diǎn)被自動(dòng)關(guān)聯(lián)到了 HdfDeviceObject 的 property 成員。使用 DeviceResourceGetIfaceInstance 接口獲取到 HCS 接口實(shí)例后調(diào)用其成員方法 GetUint32 讀取名為"num"的無(wú)符號(hào)值屬性,使用 GetString 接口讀取名為"driver_name"的字符串屬性。從配置中獲取到屬性值后,再根據(jù)配置值完成相關(guān)軟硬件的初始化。static int32_t HdfUartInit(struct HdfDeviceObject *obj)
{
int32_t ret;
struct DeviceResourceIface *iface = NULL;
…
devResourceIface = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE);
if (devResourceIface == NULL) {
HDF_LOGE("%s: face is invalid", __func__);
return HDF_FAILURE;
}
devResourceIface->GetUint32(obj->property, "num", &host->num, 0);
devResourceIface->GetString(obj->property, "driver_name", &drName, "ttyAMA");
……
ret = memcpy_s(g_driverName, UART_NAME_LEN - 1, drName, strlen(drName));
if (ret != EOK) {
return HDF_FAILURE;
}
host->method = &g_uartHostMethod;
return HDF_SUCCESS;
}
總結(jié)
本文從全景介紹了 HCS 配置管理方案,重點(diǎn)分析了 HC-GEN 的實(shí)現(xiàn)和 HCS 的編譯過(guò)程,希望對(duì)讀者理解 HCS 的原理和配置方法能有所幫助。關(guān)于 HDF 驅(qū)動(dòng)框架的更多分析,請(qǐng)關(guān)注后續(xù)文章。編輯:jq
-
數(shù)據(jù)
+關(guān)注
關(guān)注
8文章
7081瀏覽量
89178 -
二進(jìn)制
+關(guān)注
關(guān)注
2文章
795瀏覽量
41688 -
編譯器
+關(guān)注
關(guān)注
1文章
1636瀏覽量
49172 -
C代碼
+關(guān)注
關(guān)注
1文章
89瀏覽量
14321 -
驅(qū)動(dòng)框架
+關(guān)注
關(guān)注
0文章
14瀏覽量
4069 -
OpenHarmony
+關(guān)注
關(guān)注
25文章
3728瀏覽量
16398
原文標(biāo)題:OpenHarmony HDF 配置管理分析及使用
文章出處:【微信號(hào):HarmonyOS_Community,微信公眾號(hào):電子發(fā)燒友開(kāi)源社區(qū)】歡迎添加關(guān)注!文章轉(zhuǎn)載請(qǐng)注明出處。
發(fā)布評(píng)論請(qǐng)先 登錄
相關(guān)推薦
評(píng)論