mirror of
https://github.com/openharmony/developtools_syscap_codec.git
synced 2026-08-27 02:11:19 -04:00
openharmony_sig_ci
@@ -0,0 +1,177 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
Regular → Executable
+70
-25
@@ -1,36 +1,81 @@
|
||||
# developtools_syscap_codec
|
||||
# System Capability Encoder and Decoder Tools
|
||||
|
||||
#### Description
|
||||
{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**}
|
||||
SysCap(SystemCapability) encoder and decoder tools common usage scenarios as follow：
|
||||
|
||||
#### Software Architecture
|
||||
Software architecture description
|
||||
1.Device development: After deivce developer assembling components completed, building system will generate SysCap list and collect vendor ID, API version as PCID encoder inputs.
|
||||
|
||||
#### Installation
|
||||
2.APP development: IDE collect APP required SysCap and API verssion as in RPCID encoder input. And IDE will decode PCID to device SysCap list when it imported.
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
3.APP distribution: RPCID/PCID decoder used for APP distribution procedure, APP store will check whether device's SysCap satisfy APP required SysCap.
|
||||
|
||||
#### Instructions
|
||||
4.APP installation: Bundle tools used RPCID decoder to decode APP required SysCap list.
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
## Architecture
|
||||
|
||||
#### Contribution
|
||||
SysCap codec tools has two components：
|
||||
|
||||
1. Fork the repository
|
||||
2. Create Feat_xxx branch
|
||||
3. Commit your code
|
||||
4. Create Pull Request
|
||||
1. syscap_tool：Binary used for APP developing, IDE invoker RPCID encoder and PCID decoder when APP compiling and PCID importing.
|
||||
|
||||
2. syscap_tool_shared：Shared library used for device developing and APP installing.
|
||||
|
||||
#### Gitee Feature
|
||||
## File Structure
|
||||
|
||||
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
|
||||
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
|
||||
4. The most valuable open source project [GVP](https://gitee.com/gvp)
|
||||
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
|
||||
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||||
```
|
||||
/developtools
|
||||
├── syscap_codec # root directory
|
||||
│ ├── include
|
||||
│ │ └── syscap_tool.h # interfaces
|
||||
│ └── src
|
||||
│ ├── endian_internel.h # internal big/little endian conversion headers(common for win、mac、linux)
|
||||
│ ├── endian_internel.c # big/little endian conversion implement
|
||||
│ ├── main.c # command line implement
|
||||
│ └── syscap_tool.c # codec implement
|
||||
```
|
||||
|
||||
### API
|
||||
|
||||
PC tools, no API provided.
|
||||
|
||||
### Building Manually
|
||||
|
||||
syscap_tool binary building steps as follow：
|
||||
|
||||
1. Build commands：SysCap tools binary building and installation will be tiggered by SDK compiling procedure. How to build SDK please refer to https://gitee.com/openharmony/build/blob/master/README_zh.md.
|
||||
|
||||
2. Building cmd should be adjust for host platform as same as SDK compiling, the archive will in corresponding platform directoty. Note: Ubuntu host only avaiable for windows/linux building, MacOs binary should building on MacOs host.
|
||||
|
||||
### Downloading Binary
|
||||
|
||||
[1.Downlaod SDK(recommonded))]
|
||||
|
||||
Download daily builds(http://ci.openharmony.cn/dailybuilds) which included SDK.
|
||||
|
||||
[3.Supported Host]
|
||||
|
||||
Windows x86_64/Linux x86_64/Darwin x86_64
|
||||
|
||||
### Help
|
||||
|
||||
SysCap tools usually integrate to IDE, APP store and bundle tools. Follow instructions for debugging manually:
|
||||
|
||||
./syscap_tool -h or ./syscap_tool --help：
|
||||
|
||||
./syscap_tool -R/P -e/d -i filepath [-o outpath]
|
||||
|
||||
-h, --help : how to use
|
||||
|
||||
-R, --RPCID : encode or decode RPCID
|
||||
|
||||
-P, --PCID : encode or decode PCID
|
||||
|
||||
-e, --encode : to encode
|
||||
|
||||
-d, --encode : to decode
|
||||
|
||||
-i filepath, --input filepath : input file
|
||||
|
||||
-o outpath, --input outpath : output path
|
||||
|
||||
### Release Note
|
||||
|
||||
v1.0.0 2022-3-8 first release, SysCap codec supported for Windows/Linux/Mac host.
|
||||
@@ -1,18 +1,8 @@
|
||||
# SysCap编解码工具<a name="ZH-CN_TOPIC_0000001149090043"></a>
|
||||
# 系统能力编解码工具
|
||||
|
||||
- [SysCap编解码工具<a name="ZH-CN_TOPIC_0000001149090043"></a>](#)
|
||||
- [简介<a name="section662115419449"></a>](#简介)
|
||||
- [架构<a name="section15908143623714"></a>](#架构)
|
||||
- [目录<a name="section161941989596"></a>](#目录)
|
||||
- [pc端编译说明<a name="section129654513262"></a>](#pc端编译说明)
|
||||
- [pc端获取说明<a name="section129654513263"></a>](#pc端获取说明)
|
||||
- [命令帮助<a name="section129654513265"></a>](#命令帮助)
|
||||
系统能力(SystemCapability, 本文中使用SysCap缩写)编解码工具的应用场景：
|
||||
|
||||
## 简介<a name="section662115419449"></a>
|
||||
|
||||
SysCap编解码工具的应用场景：
|
||||
|
||||
1.设备开发时，设备厂商对OS不见进行拼装后，编译构建生成Syscap列表，厂商ID和API版本信息作为Syscap编解码工具的输入，生成PCID。
|
||||
1.设备开发时，设备厂商对OS部件进行拼装后，编译构建生成Syscap列表，厂商ID和API版本信息作为Syscap编解码工具的输入，生成PCID。
|
||||
|
||||
2.应用开发时，IDE根据应用配置的Syscap和API版本生成RPCID。开发者导入PCID时，使用Syscap编解码工具解码出设备的Syscap集合。
|
||||
|
||||
@@ -20,7 +10,7 @@ SysCap编解码工具的应用场景：
|
||||
|
||||
4.应用安装时，包管理使用Syscap工具解码应用需要的Syscap集合。
|
||||
|
||||
## 架构<a name="section15908143623714"></a>
|
||||
## 架构
|
||||
|
||||
SysCap编解码工具主要有两部分组成：
|
||||
|
||||
@@ -28,7 +18,7 @@ SysCap编解码工具主要有两部分组成：
|
||||
|
||||
2. syscap_tool_shared部分：用于设备开发、应用安装等场景，完成RPCID和PCID的编解码。
|
||||
|
||||
## 目录<a name="section161941989596"></a>
|
||||
## 目录
|
||||
|
||||
```
|
||||
/developtools
|
||||
@@ -42,7 +32,11 @@ SysCap编解码工具主要有两部分组成：
|
||||
│ └── syscap_tool.c # syscap_tool编解码接口的实现
|
||||
```
|
||||
|
||||
### pc端编译说明<a name="section129654513262"></a>
|
||||
### API
|
||||
|
||||
PC端工具，不对外提供API。
|
||||
|
||||
### pc端编译说明
|
||||
|
||||
|
||||
syscap_tool pc端可执行文件编译步骤：
|
||||
@@ -51,23 +45,24 @@ syscap_tool pc端可执行文件编译步骤：
|
||||
|
||||
2. 编译：在目标开发机上运行上面调整好的sdk编译命令， 正常编译syscap_tool会输出到sdk平台相关目录下； 注意： ubuntu环境下只能编译windows/linux版本工具，mac版需要在macos开发机上编译。
|
||||
|
||||
### pc端获取说明<a name="section129654513263"></a>
|
||||
### pc端获取说明
|
||||
|
||||
[1.下载sdk获取(建议)](#section161941989591)
|
||||
```
|
||||
通过访问本社区网站下载dailybuilds或正式发布的sdk压缩包，从中根据自己平台到相应的目录toolchain下解压提取
|
||||
```
|
||||
|
||||
通过访问本社区网站下载dailybuilds或正式发布的sdk压缩包，从中根据自己平台到相应的目录toolchain下解压提取。
|
||||
|
||||
|
||||
[2.自行编译](#section161941989592)
|
||||
|
||||
编译请参考上面单独小节，本项目仓prebuilt目录下不再提供预制
|
||||
|
||||
编译请参考上面单独小节，本项目仓prebuilt目录下不再提供预制。
|
||||
|
||||
[3.支持运行环境](#section161941989593)
|
||||
|
||||
linux版本建议ubuntu 18.04以上 64位，其他相近版本也可。
|
||||
Windows x86_64/Linux x86_64/Darwin x86_64
|
||||
|
||||
### 命令帮助<a name="section129654513265"></a>
|
||||
### 命令帮助
|
||||
|
||||
本工具一般被IDE、应用市场和包管理器集成，手工调试时可参考以下说明。
|
||||
|
||||
使用./syscap_tool -h或者./syscap_tool --help查看：
|
||||
|
||||
@@ -87,3 +82,6 @@ linux版本建议ubuntu 18.04以上 64位，其他相近版本也可。
|
||||
|
||||
-o outpath, --input outpath : output path
|
||||
|
||||
### Release Note
|
||||
|
||||
v1.0.0 2022-3-8 首版本，提供Windows/Linux/Mac平台的系统能力编解码。
|
||||
Executable
+1
@@ -0,0 +1 @@
|
||||
v1.0.0 first release.
|
||||
Reference in New Issue
Block a user