1# SPDX-License-Identifier: Apache-2.0
2#
3# Copyright The Zephyr Project Contributors
4
5# A pykwalify schema for basic validation of the structure of a shield metadata YAML file.
6#
7# The shield.yml file can contain either a single shield definition or a list of shields.
8
9schema;shield-schema:
10  type: map
11  mapping:
12    name:
13      required: true
14      type: str
15      desc: Name of the shield (used in Kconfig and build system)
16    full_name:
17      required: true
18      type: str
19      desc: Full name of the shield (typically the commercial name)
20    vendor:
21      required: true
22      type: str
23      desc: Manufacturer/vendor of the shield
24    supported_features:
25      required: false
26      sequence:
27        - type: str
28          desc: A hardware feature the shield supports (see dts/bindings/binding-types.txt)
29
30type: map
31range:
32  min: 1
33  max: 1
34mapping:
35  shield:
36    include: shield-schema
37  shields:
38    type: seq
39    sequence:
40      - include: shield-schema
41