OpenHarmony移植案例与原理：startup子系统之syspara_lite系统属性部件

转x33g5p2x  于2022-02-18 转载在 Harmony  
字(8.1k)|赞(0)|评价(0)|浏览(516)

**摘要：**本文介绍下移植开发板时如何适配系统属性部件syspara_lite，并介绍下相关的运行机制原理。

本文分享自华为云社区《openharmony移植案例与原理 - startup子系统之syspara_lite系统属性部件》，作者： zhushy 。

系统属性部件syspara_lite负责提供获取与设置操作系统相关的系统属性，包括默认系统属性、OEM厂商系统属性和自定义系统属性。为满足OpenHarmony产品兼容性规范，产品解决方案需要实现获取设备信息的接口，如：产品名、品牌名、厂家名等，同时提供设置/读取系统属性的接口。系统属性部件syspara_lite包含系统参数特性syspara_lite和token。系统属性部件syspara_lite定义在build\lite\components\startup.json。源代码目录如下：

  1. base/startup/syspara_lite/    # 系统属性部件
  2. ├── frameworks                # 系统属性部件源文件目录
  3. ├── hals                      # 系统属性部件硬件抽象层头文件目录
  4. └── interfaces                # 系统属性部件对外接口目录

系统参数syspara适配

适配启动恢复子系统startup的syspara_lite部件的一个实例vendor\bestechnic\display_demo\config.json的代码片段如下,⑴处的配置项enable_ohos_startup_syspara_lite_use_posix_file_api设置为true，下文通过分析syspara_lite部件的代码来解释。

  1. {
  2.   "product_name": "display_demo",
  3.     ......
  4.   "subsystems": [
  5.     {
  6.     ......
  7.     {
  8.       "subsystem": "startup",
  9.       "components": [
  10.         {
  11.           "component": "bootstrap_lite"
  12.         },
  13.         {
  14.           "component": "syspara_lite",
  15.           "features": [
  16. ⑴           "enable_ohos_startup_syspara_lite_use_posix_file_api = true"
  17.           ]
  18.         }
  19.       ]
  20.     },
  21.     ......
  22.   ],
  23.   "vendor_adapter_dir": "",
  24.   "product_adapter_dir": "//vendor/bestechnic/display_demo/hals",
  25.     ......
  26. }

我们知道，syspara_lite部件支持获取和设置操作系统的参数，当设置系统参数时，系统参数会最终写到文件中进行持久化保存。在轻量系统中，文件操作相关接口有POSIX接口与HalFiles接口这两套实现。POSIX文件系统接口代码位置kernel\liteos_m\kal\libc\musl\fs.c，HalFiles文件系统接口位置为utils\native\lite\file\src\file_impl_hal\file.c。当对接内核的文件系统，采用POSIX相关的接口时，需要在features字段中需要增加enable_ohos_startup_syspara_lite_use_posix_file_api = true。如果对接HalFiles相关的接口，则无须修改。enable_ohos_startup_syspara_lite_use_posix_file_api默认为false，定义在文件base\startup\syspara_lite\frameworks\parameter\config.gni。我们通过看下编译配置文件来了解下实现的原理机制，打开文件base\startup\syspara_lite\frameworks\parameter\src\BUILD.gn，片段如下。

⑴处解释了上文的配置参数enable_ohos_startup_syspara_lite_use_posix_file_api。⑵处依赖产品解决方案中的适配的sys_param实现代码。ohos_product_adapter_dir是产品解决方案config.json中的配置项，该配置项一遍设置为"hals"。sys_param实现代码文件的路径一遍为"hals/utils/sys_paramn/hal_sys_param.c"，并且同级目录的BUILD.gn文件中的静态库名称必须为hal_sysparam。⑶处表示如果需要使用安全函数，则需要配置项enable_ohos_startup_syspara_lite_use_thirdparty_mbedtls设置为true。⑷处设置一些配置项宏，这些属于构建类别的参数。

  1. if (ohos_kernel_type == "liteos_m") {
  2.   static_library("sysparam") {
  3.     include_dirs = [
  4.       "//base/startup/syspara_lite/interfaces/kits",
  5.       "//utils/native/lite/include",
  6.       "//base/startup/syspara_lite/frameworks/parameter/src",
  7.       "//base/startup/syspara_lite/hals",
  8.       "//third_party/mbedtls/include",
  9.     ]
  10.     sources = [ "parameter_common.c" ]
  11. ⑴  if (enable_ohos_startup_syspara_lite_use_posix_file_api) {
  12.       sources += [ "param_impl_posix/param_impl_posix.c" ]
  13.     } else {
  14.       sources += [ "param_impl_hal/param_impl_hal.c" ]
  15.     }
  17. ⑵  deps = [ "$ohos_product_adapter_dir/utils/sys_param:hal_sysparam" ]
  18. ⑶  if (enable_ohos_startup_syspara_lite_use_thirdparty_mbedtls) {
  19.       deps += [ "//third_party/mbedtls:mbedtls" ]
  20.     }
  22.     if (enable_ohos_startup_syspara_lite_use_posix_file_api) {
  23.       deps += [ "//third_party/bounds_checking_function:libsec_static" ]
  24.     }
  25.     defines = [
  26. ⑷    "INCREMENTAL_VERSION=\"${ohos_version}\"",
  27.       "BUILD_TYPE=\"${ohos_build_type}\"",
  28.       "BUILD_USER=\"${ohos_build_user}\"",
  29.       "BUILD_TIME=\"${ohos_build_time}\"",
  30.       "BUILD_HOST=\"${ohos_build_host}\"",
  31.       "BUILD_ROOTHASH=\"${ohos_build_roothash}\"",
  32.       "USE_MBEDTLS",
  33.       "DATA_PATH=\"${config_ohos_startup_syspara_lite_data_path}\"",
  34.     ]
  35.   }
  36. }

看个产品解决方案的实际例子，vendor\bestechnic\display_demo\hals\utils\sys_param\BUILD.gn的代码如下,⑴处的静态库的名字是不能随意更改的，见上文解释。

  1. ⑴  static_library("hal_sysparam") {
  2.     sources = [ "hal_sys_param.c" ]
  3.     include_dirs = [ "//base/startup/syspara_lite/hals" ]
  4.     defines = [
  5.         "INCREMENTAL_VERSION=\"${ohos_version}\"",
  6.         "BUILD_TYPE=\"${ohos_build_type}\"",
  7.         "BUILD_USER=\"${ohos_build_user}\"",
  8.         "BUILD_TIME=\"${ohos_build_time}\"",
  9.         "BUILD_HOST=\"${ohos_build_host}\"",
  10.         "BUILD_ROOTHASH=\"${ohos_build_roothash}\"",
  11.     ]
  12.     }

文件vendor\bestechnic\display_demo\hals\utils\sys_param\hal_sys_param.c实现接口文件base\startup\syspara_lite\hals\hal_sys_param.h中声明的函数，如下所示，主要包含设备厂商信息，软件版本信息，构建信息等。

  1. const char* HalGetDeviceType(void);
  2. const char* HalGetManufacture(void);
  3. const char* HalGetBrand(void);
  4. const char* HalGetMarketName(void);
  5. const char* HalGetProductSeries(void);
  6. const char* HalGetProductModel(void);
  7. const char* HalGetSoftwareModel(void);
  8. const char* HalGetHardwareModel(void);
  9. const char* HalGetHardwareProfile(void);
  10. const char* HalGetSerial(void);
  11. const char* HalGetBootloaderVersion(void);
  12. const char* HalGetAbiList(void);
  13. const char* HalGetDisplayVersion(void);
  14. const char* HalGetIncrementalVersion(void);
  15. const char* HalGetBuildType(void);
  16. const char* HalGetBuildUser(void);
  17. const char* HalGetBuildHost(void);
  18. const char* HalGetBuildTime(void);
  19. int HalGetFirstApiVersion(void);

在适配HalGetSerial接口时，开发板不像产线生产过程那样，会写入一个具体的序列号Serial Number，因而需要确定一个数据对开发板进行唯一标识。vendor\bestechnic\display_demo\hals\utils\sys_param\hal_sys_param.c中提供了一种方法，采用WiFi Mac地址进行适配。

  1. const char* HalGetSerial(void)
  2. {
  3.     char macAddr[ETH_ALEN];
  4.     // as devboard has no production serial number, we just
  5.     // use wifi mac address as device serial number.
  6.     if (serialNumber[0] == STR_END_FLAG) {
  7.         extern int bwifi_get_own_mac(u8 *addr);
  8.         bwifi_get_own_mac(macAddr);
  9.         int j = 0;
  10.         for (int i = 0; i < ETH_ALEN; i++) {
  11.             u8 lowFour, highFour;
  12.             highFour = (macAddr[i] & MAC_HIGH_MASK) >> MAC_BITS;
  13.             serialNumber[j] = Hex2Char(highFour);
  14.             j++;
  15.             lowFour = macAddr[i] & MAC_LOW_MASK;
  16.             serialNumber[j] = Hex2Char(lowFour);
  17.             j++;
  18.         }
  19.     }
  20.     return serialNumber;
  21. }

Token令牌适配

在文件base\startup\syspara_lite\hals\hal_token.h中定义令牌相关的接口声明，包含写令牌，获取AcKey，获取产品编码和产品键值。在移植开发板时，需要实现这些接口。

在base\startup\syspara_lite\frameworks\token\BUILD.gn文件中，查看令牌如何编译的，以LiteOS-M为例，片段为：
⑴处可以看出编译使用的源文件是"src/token_impl_hal/token.c"，对于linux和liteos-a内核使用的源文件是"src/token_impl_posix/token.c"。"token.c"文件代码很简单，判断下参数然后调用产品解决方案中的适配函数，比如函数ReadToken()会调用HalReadToken()函数。

⑵处需要注意，这里依赖的就是产品解决方案适配的token实现代码。ohos_product_adapter_dir是产品解决方案config.json中的配置项，该配置项一遍设置为"hals"。token实现代码文件的路径一遍为"hals/utils/token/hal_token.c"，并且同级目录的BUILD.gn文件中的静态库名称必须为hal_token_static。⑶处表示token部件由特性token_static组成。

  1. if (ohos_kernel_type == "liteos_m") {
  2.     static_library("token_static") {
  3. ⑴      sources = [ "src/token_impl_hal/token.c" ]
  5.         include_dirs = [
  6.         "//base/startup/syspara_lite/interfaces/kits",
  7.         "//utils/native/lite/include",
  8.         "//base/hiviewdfx/hilog_lite/interfaces/native/kits/hilog_lite",
  9.         "//base/startup/syspara_lite/hals",
  10.         ]
  12. ⑵      deps = [ "$ohos_product_adapter_dir/utils/token:hal_token_static" ]
  13.     }
  14.     }
  16.     lite_component("token") {
  17.     features = []
  18.     if (ohos_kernel_type == "liteos_a" || ohos_kernel_type == "linux") {
  19.         features += [ ":token_shared" ]
  20.     }
  21.     if (ohos_kernel_type == "liteos_m") {
  22. ⑶      features += [ ":token_static" ]
  23.     }
  24.     }

看个产品解决方案的实际例子，vendor\bestechnic\display_demo\hals\utils\token\BUILD.gn的代码如下,⑴处的静态库的名字是不能随意更改的，见上文解释。

  1. ⑴  static_library("hal_token_static") {
  2.     sources = [ "hal_token.c" ]
  4.     include_dirs = [
  5.         "//base/startup/syspara_lite/hals",
  6.         "//utils/native/lite/include",
  7.     ]
  8.     deps = []
  9.     }

文件vendor\bestechnic\display_demo\hals\utils\token\hal_token.c中的令牌实现代码片段如下，当前均为空实现，没有实际使用起来。

  1. static int OEMReadToken(char *token, unsigned int len)
  2. {
  3.     // OEM need add here, read token from device
  4.     (void)(token);
  5.     (void)(len);
  6.     return EC_SUCCESS;
  7. }
  8. ......
  9. int HalReadToken(char *token, unsigned int len)
  10. {
  11.     if (token == NULL) {
  12.         return EC_FAILURE;
  13.     }
  15.     return OEMReadToken(token, len);
  16. }

系统参数syspara_lite部件使用例子

下面是系统参数syspara_lite部件使用例子，来自https://gitee.com/openharmony/startup_syspara_lite。⑴处获取设备类型，⑵处获取厂商名称，⑶处获取品牌名称。其他系统属性接口调用的例子类似，详细的接口说明下文会提供。

  1. ⑴  char* value1 = GetDeviceType();
  2.     printf("Device type =%s\n", value1);
  3.     free(value1);
  4. ⑵  char* value2 = GetManufacture();
  5.     printf("Manufacture =%s\n", value2);
  6.     free(value2);
  7. ⑶  char* value3 = GetBrand();
  8.     printf("GetBrand =%s\n", value3);
  9.     free(value3);

系统参数syspara_lite部件接口信息

在文件base\startup\syspara_lite\interfaces\innerkits\native\syspara\include\parameter.h中定义了系统属性的接口。系统属性接口说明如下表所示：

参考站点

点击关注，第一时间了解华为云新鲜技术~

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://huaweicloud.blog.csdn.net/article/details/122998436

内容来源于网络，如有侵权，请联系作者删除！

tokenstartup开源社区移植

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com