OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/dts/bindings/led/pwm-leds.yaml

29 lines
570 B
YAML
Raw Normal View History

dts/bindings: Add binding for pwm-leds Add a binding file to descript an LED connected via a PWM. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2018-11-02 04:58:36 +08:00
#
# Copyright (c) 2018, Linaro Limited
#
# SPDX-License-Identifier: Apache-2.0
#
yaml: Remove redundant document separators YAML document separators are needed e.g. when doing $ cat doc1.yaml doc2.yaml | <parser> For the bindings, we never parse concatenated documents. Assume we don't for any other .yaml files either. Having document separators in e.g. base.yaml makes !include a bit confusing, since the !included files are merged and not separate documents (the merging is done in Python code though, so it makes no difference for behavior). The replacement was done with $ git ls-files '*.yaml' | \ xargs sed -i -e '${/\s*\.\.\.\s*/d;}' -e 's/^\s*---\s*$//' First pattern removes ... at the end of files, second pattern clears a line with a lone --- on it. Some redundant blank lines at the end of files were cleared with $ git ls-files '*.yaml' | xargs sed -i '${/^\s*$/d}' This is more about making sure people can understand why every part of a binding is there than about removing some text. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-06-19 06:03:49 +08:00
dts/bindings: Add binding for pwm-leds Add a binding file to descript an LED connected via a PWM. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2018-11-02 04:58:36 +08:00
title: PWM LED
description: >
This is a representation of the PWM GPIO nodes
properties:
compatible:
constraint: "pwm-leds"
dts: Add concept of sub-nodes to YAML and generator Several bindings have an expectation of sub-nodes that describe the actual infomation. The sub-nodes don't have any compatiable so we can't key on that. So we can add the concept of a sub-node to the YAML to handle cases like 'gpio-keys', 'gpio-leds', 'pwm-leds', etc.. The sub-node in the YAML is effective the "binding" params that describe what properties should exist in the sub-node. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-06-21 14:29:57 +08:00
type: string-array
dts/bindings: Add binding for pwm-leds Add a binding file to descript an LED connected via a PWM. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2018-11-02 04:58:36 +08:00
category: required
dts: Add concept of sub-nodes to YAML and generator Several bindings have an expectation of sub-nodes that describe the actual infomation. The sub-nodes don't have any compatiable so we can't key on that. So we can add the concept of a sub-node to the YAML to handle cases like 'gpio-keys', 'gpio-leds', 'pwm-leds', etc.. The sub-node in the YAML is effective the "binding" params that describe what properties should exist in the sub-node. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-06-21 14:29:57 +08:00
description: compatible strings
dts/bindings: Add binding for pwm-leds Add a binding file to descript an LED connected via a PWM. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2018-11-02 04:58:36 +08:00
dts: Add concept of sub-nodes to YAML and generator Several bindings have an expectation of sub-nodes that describe the actual infomation. The sub-nodes don't have any compatiable so we can't key on that. So we can add the concept of a sub-node to the YAML to handle cases like 'gpio-keys', 'gpio-leds', 'pwm-leds', etc.. The sub-node in the YAML is effective the "binding" params that describe what properties should exist in the sub-node. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-06-21 14:29:57 +08:00
sub-node:
properties:
pwms:
type: compound
category: required
label:
dts/bindings: Make pwm-leds label optional The label property in the pwm-leds sub-node is optional, so mark it as such. Fixes: #17665 Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-07-23 07:38:34 +08:00
category: optional
dts: Add concept of sub-nodes to YAML and generator Several bindings have an expectation of sub-nodes that describe the actual infomation. The sub-nodes don't have any compatiable so we can't key on that. So we can add the concept of a sub-node to the YAML to handle cases like 'gpio-keys', 'gpio-leds', 'pwm-leds', etc.. The sub-node in the YAML is effective the "binding" params that describe what properties should exist in the sub-node. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-06-21 14:29:57 +08:00
type: string
description: Human readable string describing the device (used by Zephyr for API name)