xref: /drivers/peripheral/OAT.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Copyright (c) 2021-2022 Huawei Device Co., Ltd.

     HDF is dual licensed: you can use it either under the terms of
     the GPL, or the BSD license, at your option.
     See the LICENSE file in the root of this repository for complete details.
-->
<!-- OAT(OSS Audit Tool) configuration guide:
basedir: Root dir, the basedir + project path is the real source file location.
licensefile:
1.If the project don't have "LICENSE" in root dir, please define all the license files in this project in , OAT will check license files according to this rule.

tasklist(only for batch mode):
1. task: Define oat check thread, each task will start a new thread.
2. task name: Only an name, no practical effect.
3. task policy: Default policy for projects under this task, this field is required and the specified policy must defined in policylist.
4. task filter: Default filefilter for projects under this task, this field is required and the specified filefilter must defined in filefilterlist.
5. task project: Projects to be checked, the path field define the source root dir of the project.


policyList:
1. policy: All policyitems will be merged to default OAT.xml rules, the name of policy doesn't affect OAT check process.
2. policyitem: The fields type, name, path, desc is required, and the fields rule, group, filefilter is optional,the default value is:
<policyitem type="" name="" path="" desc="" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter"/>
3. policyitem type:
    "compatibility" is used to check license compatibility in the specified path;
    "license" is used to check source license header in the specified path;
    "copyright" is used to check source copyright header in the specified path;
    "import" is used to check source dependency in the specified path, such as import ... ,include ...
    "filetype" is used to check file type in the specified path, supported file types: archive, binary
    "filename" is used to check whether the specified file exists in the specified path(support projectroot in default OAT.xml), supported file names: LICENSE, README, README.OpenSource

4. policyitem name: This field is used for define the license, copyright, "*" means match all, the "!" prefix means could not match this value. For example, "!GPL" means can not use GPL license.
5. policyitem path: This field is used for define the source file scope to apply this policyitem, the "!" prefix means exclude the files. For example, "!.*/lib/.*" means files in lib dir will be exclude while process this policyitem.
6. policyitem rule and group: These two fields are used together to merge policy results. "may" policyitems in the same group means any one in this group passed, the result will be passed.
7. policyitem filefilter: Used to bind filefilter which define filter rules.
8. filefilter: Filter rules, the type filename is used to filter file name, the type filepath is used to filter file path.

Note:If the text contains special characters, please escape them according to the following rules:
" == &gt;
& == &gt;
' == &gt;
< == &gt;
> == &gt;
-->
<configuration>
    <oatconfig>
        <licensefile></licensefile>
        <policylist>
            <policy name="projectPolicy" desc="">
                <policyitem type="copyright" name="Huawei Technologies Co., Ltd." path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="Developed by Huawei Technologies"/>
                <policyitem type="copyright" name="Huawei Device Co., Ltd." path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="Developed by Huawei Device"/>
                <policyitem type="copyright" name="xu" path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="kernel ps driver codes"/>
                <policyitem type="copyright" name="Rockchip Electronics Co., Ltd." path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="Developed By Rockchip"/>
                <policyitem type="copyright" name="Shenzhen Kaihong DID Co., Ltd." path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="Developed by Shenzhen Kaihong DID"/>
                <policyitem type="license" name="GPL" path=".*" desc="linux kernel adapter codes"/>
                <policyitem type="license" name="BSD" path=".*" desc="huawei codes"/>
                <policyitem type="copyright" name="Chipsea Technologies (Shenzhen) Corp., Ltd." path=".*" rule="may" group="defaultGroup"/>
                <policyitem type="copyright" name="Nanjing Xiaoxiongpai Intelligent Technology Co., Ltd." path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="Developed By Xiaoxiongpai"/>
                <policyitem type="copyright" name="Archermind Technology (Nanjing) Co. Ltd." path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="Developed by Nanjing Archermind"/>
                <policyitem type="copyright" name="Bosch Sensortec GmbH. All rights reserved." path=".*" rule="may" group="defaultGroup" filefilter="copyrightPolicyFilter" desc="Developed by Bosch"/>
            </policy>
        </policylist>
        <filefilterlist>
            <filefilter name="defaultFilter" desc="Files not to check">
                <filteritem type="filename" name="*.lds|*.pod"/>
                <filteritem type="filename" name="*.a|*.d|*.o|*.so|*.cmd|*.hcb|*.swp"/>
                <filteritem type="filename" name="*.clang-format"/>
                <filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/>
            </filefilter>
            <filefilter name="defaultPolicyFilter" desc="Filters for compatibility，license header policies">
                <filteritem type="filename" name="README.OpenSource"/>
                <filteritem type="filename" name="README"/>
                <filteritem type="filename" name="BUILD.gn"/>
                <filteritem type="filename" name="*.gni"/>
                <filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/>
            </filefilter>
            <filefilter name="copyrightPolicyFilter" desc="Filters for copyright header policies" >
                <filteritem type="filename" name="README.OpenSource"/>
                <filteritem type="filename" name="README"/>
                <filteritem type="filename" name="BUILD.gn"/>
                <filteritem type="filename" name="*.gni"/>
                <filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/>
            </filefilter>
            <filefilter name="licenseFileNamePolicyFilter" desc="Filters for LICENSE file policies" >
                <filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/>
                <filteritem type="filename" name="BUILD.gn"/>
                <filteritem type="filename" name="*.gni"/>
            </filefilter>
            <filefilter name="readmeFileNamePolicyFilter" desc="Filters for README file policies" >
                <filteritem type="filepath" name="README.md" desc="Describe the reason for filtering scan results"/>
            </filefilter>
            <filefilter name="readmeOpenSourcefileNamePolicyFilter" desc="Filters for README.OpenSource file policies" >
                <filteritem type="filepath" name="dir name underproject/.*" desc="Describe the reason for filtering scan results"/>
            </filefilter>
            <filefilter name="binaryFileTypePolicyFilter" desc="Filters for binary file policies" >
                <filteritem type="filepath" name="audio/figures/.*.png" desc="audio architecture diagram"/>
                <filteritem type="filepath" name="display/figures/.*.png" desc="display architecture diagram"/>
                <filteritem type="filepath" name="input/figures/.*.png" desc="input architecture diagram"/>
                <filteritem type="filepath" name="sensor/figures/.*.png" desc="sensor architecture diagram"/>
                <filteritem type="filepath" name="wlan/figures/.*.png" desc="wlan architecture diagram"/>
                <filteritem type="filepath" name="camera/figures/.*.png" desc="camera architecture diagram"/>
                <filteritem type="filepath" name="usb/figures/.*.png" desc="usb architecture diagram"/>
                <filteritem type="filepath" name="display/test/resources/.*.bmp" desc="display test image"/>
                <filteritem type="filepath" name="battery/charger/resources/HarmonyOS_Sans_SC_Regular_Small.ttf" desc="charger font library"/>
                <filteritem type="filepath" name="motion/figures/.*.png" desc="motion architecture diagram"/>
                <filteritem type="filepath" name="audio/test/resource/.*.wav" desc="audio architecture audio"/>
                <filteritem type="filepath" name="ril/figures/.*.png" desc="ril architecture diagram"/>
                <filteritem type="filepath" name="vibrator/figures/.*.png" desc="vibrator architecture diagram"/>
                <filteritem type="filepath" name="light/figures/.*.png" desc="light architecture diagram"/>
            </filefilter>
        </filefilterlist>
    </oatconfig>
</configuration>