[文章]HarmonyOS HDF驱动框架---配置管理

配置概述

• 在弱性能环境中，转换为配置树源码，驱动可直接调用C代码获取配置。
• 在高性能环境中，转换为HCB(HDFConfiguration Binary)二进制文件，驱动可使用HDF框架提供的配置解析接口获取配置。
  

图1 配置使用流程图
配置语法关键字表1 HCS配置语法保留关键字[td]

关键字	用途	说明
root	配置根节点	-
include	引用其他HCS配置文件	-
delete	删除节点或属性	只能用于操作include导入的配置树
template	定义模板节点	-
match_attr	用于标记节点的匹配查找属性	解析配置时可以使用该属性的值查找到对应节点

基本结构

•   attribute_name = value;
  

• attribute_name 是字母、数字、下划线的组合且必须以字母或下划线开头，字母区分大小写。
• value的可用格式如下：
  
  
  • 数字常量，支持二进制、八进制、十进制、十六进制数，具体参考数据类型节。
  • 字符串，内容使用双引号("")引用。
  • 节点引用。
    
    
• attribute 必须以分号(;)结束且必须属于一个node。
  
  

•   node_name {
•       module = "sample";
•       ...
•   }
  

• node_name 是字母、数字、下划线的组合且必须以字母或下划线开头，字母区分大小写。
• 大括号后无需添加结束符“;”。
• root为保留关键字，用于声明配置表的根节点。每个配置表必须以root节点开始。
• root节点中必须包含module属性，其值应该为一个字符串，用于表征该配置所属模块。
• 节点中可以增加match_attr属性，其值为一个全局唯一的字符串。在解析配置时可以调用查找接口以该属性的值查找到包含该属性的节点。
  

数据类型整型长度自动推断，根据实际数据长度给与最小空间占用的类型。

• 二进制，0b前缀，示例：0b1010。
• 八进制，0前缀，示例：0664。
• 十进制 ，无前缀，且支持有符号与无符号，示例：1024，+1024均合法。负值在读取时注意使用有符号数读取接口。
• 十六进制，0x前缀，示例：0xff00、0xFF。
  
  

• attr_foo = [0x01, 0x02, 0x03, 0x04];
• attr_bar = ["hello", "world"];
  

预处理

• #include "foo.hcs"
• #include "../bar.hcs"
  

• 文件名必须使用双引号("")，不在同一目录使用相对路径引用。被include文件也必须是合法的HCS文件。
• 多个include，如果存在相同的节点，后者覆盖前者，其余的节点依次展开。
  

注释

• 单行注释。
  
  
  • // comment
    
• 多行注释。
  
  
  • /*
  • comment
  • */
    
  说明
  
  多行注释不支持嵌套。

引用修改

• node :& source_node
  

上述语句表示node中的内容是对source_node节点内容的修改。示例如下：

• root {
•     module = "sample";
•     foo {
•         foo_ :& root.bar{
•             attr = "foo";
•         }
•         foo1 :& foo2 {
•             attr = 0x2;
•         }
•         foo2 {
•             attr = 0x1;
•         }
•     }
•     bar {
•         attr = "bar";
•     }
• }
  

• root {
•     module = "sample";
•     foo {
•         foo2 {
•             attr = 0x2;
•         }
•     }
•     bar {
•         attr = "foo";
•     }
• }
  

• 引用同级node，可以直接使用node名称，否则被引用的节点必须使用绝对路径，节点间使用“.”分隔，root表示根节点，格式为root开始的节点路径序列，例如root.foo.bar即为一个合法的绝对路径。
• 如果出现修改冲突（即多处修改同一个属性），编译器将提示warning，因为这种情况下只会生效某一个修改而导致最终结果不确定。
  

节点复制

• node : source_node
  

• root {
•     module = "sample";
•     foo {
•         attr_0 = 0x0;
•     }
•     bar:foo {
•         attr_1 = 0x1;
•     }
• }
  

• root {
•     module = "sample";
•     foo {
•         attr_0 = 0x0;
•     }
•     bar {
•         attr_1 = 0x1;
•         attr_0 = 0x0;
•     }
• }
  

删除

• // sample2.hcs
• root {
•     attr_1 = 0x1;
•     attr_2 = 0x2;
•     foo_2 {
•         t = 0x1;
•     }
• }
• // sample1.hcs
• #include "sample2.hcs"
• root {
•     attr_2 = delete;
•     foo_2 : delete {
•     }
• }
  

• root {
•     attr_1 = 0x1;
• }
  

说明
属性引用

• attribute = &node；
  

• node1 {
•     attributes;
• }
• node2 {
•     attr_1 = &node1;
• }
  

模板

• root {
•     module = "sample";
•     template foo {
•         attr_1 = 0x1;
•         attr_2 = 0x2;
•     }
•     bar :: foo {
•     }
•     bar_1 :: foo {
•         attr_1 = 0x2;
•     }
• }
  

• root {
•     module = "sample";
•     bar {
•         attr_1 = 0x1;
•         attr_2 = 0x2;
•     }
•     bar_1 {
•         attr_1 = 0x2;
•         attr_2 = 0x2;
•     }
• }
  

配置生成hc-gen介绍

• Usage: hc-gen [Options] [File]
• options:
•   -o <file>   output file name, default same as input
•   -a          hcb align with four bytes
•   -b          output binary output, default enable
•   -t          output config in C language source file style
•   -i          output binary hex dump in C language source file style
•   -p <prefix> prefix of generated symbol name
•   -d          decompile hcb to hcs
•   -V          show verbose info
•   -v          show version
•   -h          show this help message
  

• hc-gen -o [OutputCFileName] -t [SourceHcsFileName]
  

• hc-gen -o [OutputHcbFileName] -b [SourceHcsFileName]
  

• hc-gen -o [OutputHcsFileName] -d [SourceHcbFileName]