ARM: DT: Add DT entry for PWMs and Backlight
[linux-3.10.git] / Documentation / devicetree / bindings / video / backlight / pwm-backlight.txt
1 pwm-backlight bindings
2
3 Required properties:
4   - compatible: "pwm-backlight"
5   - pwms: OF device-tree PWM specification (see PWM binding[0])
6   - brightness-levels: Array of distinct brightness levels. Typically these
7       are in the range from 0 to 255, but any range starting at 0 will do.
8       The actual brightness level (PWM duty cycle) will be interpolated
9       from these values. 0 means a 0% duty cycle (darkest/off), while the
10       last value in the array represents a 100% duty cycle (brightest).
11   - default-brightness-level: the default brightness level (index into the
12       array defined by the "brightness-levels" property)
13
14    The following fields are mutually exclusive  with "brightness-levels"
15    and "default-brightness-level".It is used in case where levels are
16    not available on the backlight device and the device can interpolate
17    values.In this case the minium value that is considered is 0.
18
19   - max-brightness: the maximum brighness value that is allowed by the
20        backlight device.
21   - default-brightness: the default brighness value that is allowed by the
22        backlight device.
23
24 Optional properties:
25   - pwm-names: a list of names for the PWM devices specified in the
26                "pwms" property (see PWM binding[0])
27
28 [0]: Documentation/devicetree/bindings/pwm/pwm.txt
29
30 Examples:
31
32         backlight {
33                 compatible = "pwm-backlight";
34                 pwms = <&pwm 0 5000000>;
35
36                 brightness-levels = <0 4 8 16 32 64 128 255>;
37                 default-brightness-level = <6>;
38         };
39
40         backlight {
41                 compatible = "pwm-backlight";
42                 pwms = <&pwm 1 1000000>;
43                 max-brightness = <255>;
44                 default-brightness = <224>;
45         };