README.md
1# hispark\_aries<a name="EN-US_TOPIC_0000001083397464"></a>
2
3- [Introduction](#section11660541593)
4- [Directory Structure](#section161941989596)
5- [Constraints](#section119744591305)
6- [Compilation and Building](#section137768191623)
7- [hispark\_aries License Agreement](#section1312121216216)
8 - [third\_party License Notice](#section129654513264)
9
10- [Repositories Involved](#section1371113476307)
11
12## Introduction<a name="section11660541593"></a>
13
14The media software development kit from HiSilicon \(Shanghai\) can adapt to complex underlying layers of different chips. It also provides basic multimedia processing functions for the multimedia subsystem, including audio/video collection, audio/video encoding and decoding, audio/video output, video pre-processing, encapsulation, decapsulation, file management, storage management, and log system. The multimedia subsystem architecture is shown as [Figure 1](#fig4460722185514)
15
16**Figure 1** Multimedia subsystem architecture<a name="fig4460722185514"></a>
17
18
19
20
21## Directory Structure<a name="section161941989596"></a>
22
23```
24/device/hisilicon/hispark_aries/sdk_liteos
25├── config # Hi3518E V300 device configuration information
26├── mpp
27│ ├── lib # Media library files and license files of Hi3518E V300
28│ └── module_init # Libraries and license files of corresponding media module drivers of Hi3518E V300
29└── uboot
30 ├── out # U-Boot compiled using third_party\uboot\u-boot-2020.01
31 ├── reg # U-Boot configuration files and license files
32 ├── secureboot_ohos # Compilation scripts for secure booting
33 └── secureboot_release # Source code and license files for generating the secure U-Boot
34```
35
36## Constraints<a name="section119744591305"></a>
37
38Currently, the Hi3518E V300 chip is supported.
39
40## Compilation and Building<a name="section137768191623"></a>
41
42- Compiling the U-Boot
43
441. Download the GCC toolchain from [https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). Currently, the toolchain version for compiling U-Boot is **gcc-arm-none-eabi-7-2017-q4-major-linux.tar.bz2**. You can also select other GCC versions.
452. Copy the GCC toolchain to the **prebuilts** directory and decompress it.
463. Go to the **hispark\_aries\\sdk\_liteos\\uboot\\out\\boot** directory and modify the path of the toolchain defined by **OSDRV\_CROSS** in the **makefile** of the directory.
474. Run the **make clean;make all;** command to compile the U-Boot.
48
49The generated U-Boot is stored in the **hispark\_aries\\sdk\_liteos\\uboot\\out\\boot** directory.
50
51## hispark\_aries License Agreement <a name="section1312121216216"></a>
52
53- The **hispark\_aries\\sdk\_liteos\\mpp\\module\_init\\lib** and **hispark\_aries\\sdk\_liteos\\mpp\\lib** directories store the HiSilicon-developed libraries, which comply with the license of HiSilicon \(Shanghai\). You can see the following license and copyright information at the end of license files that are stored in the two directories:
54
55 ```
56 Copyright (C) 2020 Hisilicon (Shanghai) Technologies Co., Ltd. All rights reserved.
57 ```
58
59- The **hispark\_aries\\sdk\_liteos\\mpp\\module\_init\\src** directory stores the HiSilicon-developed code, which complies with the HiSilicon \(Shanghai\) copyright statement based on the Apache License Version 2.0. You can see the following license and copyright information at the beginning of a license file that is stored in this directory:
60
61 ```
62 / *Copyright (c) 2020 HiSilicon (Shanghai) Technologies CO., LIMITED. Licensed under the Apache License,* ... * /
63 ```
64
65- The **hispark\_aries\\sdk\_liteos\\uboot\\reg** directory stores a binary file, which complies with the license of HiSilicon \(Shanghai\). You can see the following copyright information at the end of a license file that is stored in this directory:
66
67 ```
68 Copyright (C) 2020 Hisilicon (Shanghai) Technologies Co., Ltd. All rights reserved.
69 ```
70
71- The **hispark\_aries\\sdk\_liteos\\uboot\\out\\boot** directory stores a binary U-Boot file compiled using **u-boot-2020.01** and **reg\_info\_hi3518ev300.bin** and following the **u-boot-2020.01** protocol. For details, see the readme files in the **third\_party\\uboot\\u-boot-2020.01\\Licenses** directory.
72- The **hispark\_aries\\sdk\_liteos\\uboot\\secureboot\_release** directory stores the open-source code of the secure U-Boot, in which the HiSilicon-developed code complies with the HiSilicon \(Shanghai\) copyright statement based on the GPL license. You can see the following license and copyright information at the beginning of a license file that is stored in this directory:
73
74 ```
75 / *Copyright (c) 2020 HiSilicon (Shanghai) Technologies CO., LIMITED.
76 *
77 * This program is free software; you can redistribute it and/or modify it
78 * under the terms of the GNU General Public License as published by the
79 * Free Software Foundation; either version 2 of the License, or (at your
80 * option) any later version.
81 * ... * /
82 ```
83
84- The notice file stored in the **hispark\_aries** directory describes three open-source software, namely **Das U-Boot 2020.01**, **mbed TLS 2.16.6**, and **fdk-aac v2.0.1**.
85
86### third\_party License Notice<a name="section129654513264"></a>
87
88The **third\_party\\ffmpeg\\ffmpeg-y** directory stores the open-source code of **ffmpeg**, in which the code complies with the open-source license notice of its own software version. For details, see the readme files in the **third\_party\\ffmpeg\\ffmpeg-y** directory.
89
90The **third\_party\\uboot\\u-boot-2020.01** directory stores the open-source code of U-Boot, which complies with the open-source license notice of its own software version. For details, see the readme files in the **third\_party\\uboot\\u-boot-2020.01\\Licenses** directory.
91
92## Repositories Involved<a name="section1371113476307"></a>
93
94device/hisilicon/build
95
96device/hisilicon/drivers
97
98device/hisilicon/hardware
99
100**device/hisilicon/hispark\_aries**
101
102device/hisilicon/modules
103
104device/hisilicon/third\_party/ffmpeg
105
106device/hisilicon/third\_party/uboot
107
108vendor/hisilicon
109
110
README_zh.md
1# HiSpark\_aries介绍<a name="ZH-CN_TOPIC_0000001083397464"></a>
2
3- [简介](#section11660541593)
4- [目录](#section161941989596)
5- [约束](#section119744591305)
6- [编译构建](#section137768191623)
7- [hispark\_aries协议说明](#section1312121216216)
8 - [third\_party许可说明](#section129654513264)
9
10- [相关仓](#section1371113476307)
11
12## 简介<a name="section11660541593"></a>
13
14上海海思媒体软件开发包用于适配不同芯片复杂的底层处理，为“媒体子系统”提供基础的多媒体处理功能。主要功能有：音视频采集、音视频编解码、音视频输出、视频前处理、封装、解封装、文件管理、存储管理、日志系统等。该软件包功能对应"媒体子系统"框架中红色框标注部分，如图1所示。
15
16**图 1** 多媒体子系统架构图<a name="fig4460722185514"></a>
17
18
19
20
21## 目录<a name="section161941989596"></a>
22
23```
24/device/hisilicon/hispark_aries/sdk_liteos
25├── config # Hi3518EV300设备配置信息
26├── mpp
27│ ├── lib # Hi3518EV300芯片的媒体库文件、LICENSE文件
28│ └── module_init # Hi3518EV300芯片媒体各模块驱动对应的库、LICENSE文件
29└── uboot
30 ├── out # 采用third_party\uboot\u-boot-2020.01编译成的uboot
31 ├── reg # uboot配置文件、LICENSE文件
32 ├── secureboot_ohos # 安全启动相关的编译脚本
33 └── secureboot_release # 生成安全uboot的源代码、License目录
34```
35
36## 约束<a name="section119744591305"></a>
37
38当前支持Hi3518EV300芯片。
39
40## 编译构建<a name="section137768191623"></a>
41
42- 编译uboot
43
441. 从开源社区\(https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads\)下载GCC工具链，当前用于编译uboot的工具链版本为gcc-arm-none-eabi-7-2017-q4-major-linux.tar.bz2，也可以选择其他的GCC版本。
452. 将GCC工具链拷贝到prebuilts目录，并解压。
463. 进入hispark\_aries\\sdk\_liteos\\uboot\\out\\boot目录，修改该目录下的Makefile中的OSDRV\_CROSS所定义的工具链的路径。
474. 编译uboot，命令：make clean;make all;
48
49生成的uboot存放在hispark\_aries\\sdk\_liteos\\uboot\\out\\boot目录下。
50
51## hispark\_aries协议说明<a name="section1312121216216"></a>
52
53- hispark\_aries\\sdk\_liteos\\mpp\\module\_init\\lib和hispark\_aries\\sdk\_liteos\\mpp\\lib里面为上海海思的自研库，遵循上海海思的LICENSE，这两个目录下均有LICENSE文件，LICENSE文件结尾可以看到版权信息：
54
55 ```
56 Copyright (C) 2020 Hisilicon (Shanghai) Technologies Co., Ltd. All rights reserved.
57 ```
58
59- hispark\_aries\\sdk\_liteos\\mpp\\module\_init\\src目录下为上海海思自研代码，使用基于Apache License Version 2.0许可的Hisilicon \(Shanghai\) 版权声明，在该目录下有Apache License Version 2.0的LICENSE文件，许可信息和版权信息通常可以在文件开头看到：
60
61 ```
62 / *Copyright (c) 2020 HiSilicon (Shanghai) Technologies CO., LIMITED. Licensed under the Apache License,* ... * /
63 ```
64
65- hispark\_aries\\sdk\_liteos\\uboot\\reg为上海海思的二进制文件，遵循上海海思的LICENSE，该目录下有LICENSE文件，LICENSE文件结尾可以看到：
66
67 ```
68 Copyright (C) 2020 Hisilicon (Shanghai) Technologies Co., Ltd. All rights reserved.
69 ```
70
71- hispark\_aries\\sdk\_liteos\\uboot\\out\\boot是由u-boot-2020.01和reg\_info\_hi3518ev300.bin编译成的uboot二进制文件，完全遵从u-boot-2020.01的整体协议，具体请参看third\_party\\uboot\\u-boot-2020.01\\Licenses目录下的README。
72- hispark\_aries\\sdk\_liteos\\uboot\\secureboot\_release为安全uboot的开源代码，其中自研的部分使用基于GPL许可的Hisilicon \(Shanghai\) 版权声明，在该目录下有License目录，许可信息和版权信息通常可以在文件开头看到：
73
74 ```
75 / *Copyright (c) 2020 HiSilicon (Shanghai) Technologies CO., LIMITED.
76 *
77 * This program is free software; you can redistribute it and/or modify it
78 * under the terms of the GNU General Public License as published by the
79 * Free Software Foundation; either version 2 of the License, or (at your
80 * option) any later version.
81 * ... * /
82 ```
83
84- hispark\_aries\\NOTICE文件描述了使用到的三款开源软件：Das U-Boot 2020.01、mbed TLS 2.16.6、fdk-aac v2.0.1。
85
86### third\_party许可说明<a name="section129654513264"></a>
87
88third\_party\\ffmpeg\\ffmpeg-y为ffmpeg开源代码，遵循软件版本自带的开源许可声明，具体请参看third\_party\\ffmpeg\\ffmpeg-y目录下的README。
89
90third\_party\\uboot\\u-boot-2020.01为uboot开源代码，遵循软件版本自带的开源许可声明，具体请参看third\_party\\uboot\\u-boot-2020.01\\Licenses目录下的README。
91
92## 相关仓<a name="section1371113476307"></a>
93
94device/hisilicon/build
95
96device/hisilicon/drivers
97
98device/hisilicon/hardware
99
100**device/hisilicon/hispark\_aries**
101
102device/hisilicon/modules
103
104device/hisilicon/third\_party/ffmpeg
105
106device/hisilicon/third\_party/uboot
107
108vendor/hisilicon
109
110
