Skip to content

Commit

Permalink
doc: add documentation for rohm,bd65b60 bindings
Browse files Browse the repository at this point in the history
Added documentation of the devicetree bindings for the rohm,bd65b60
led driver.

Signed-off-by: Bogdan Ionescu <[email protected]>
  • Loading branch information
BogdanTheGeek committed Mar 8, 2023
1 parent 0c27ee5 commit e24caf6
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 0 deletions.
77 changes: 77 additions & 0 deletions Documentation/devicetree/bindings/leds/rohm,bd65b60-leds.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/leds/rohm,bd65b60-leds.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: ROHM BD65B60 device tree bindings

maintainers:
- Bogdan Ionescu <[email protected]>

description: |
BD65B60 is a white LED driver IC that integrates PWM
step-up DC/DC converter with boost-capability of up to
maximum 28.5V and current driver with drive capability of up
to 25mA(Typ.) maximum setting. Precise brightness can be
controlled at wide ranges through the external PWM pulse
input.
properties:
compatible:
const: rohm,bd65b60

reg:
maxItems: 1

led:
type: object
$ref: common.yaml#
unevaluatedProperties: false

properties:
rohm,enable-outputs:
description:
Select which leds are being controlled.
Values defined in <dt-bindings/leds/leds-bd65b60.h>
$ref: "/schemas/types.yaml#/definitions/uint32"
enum: [ 0, 1, 4, 5 ]

rohm,ovp:
description:
Select Over-Voltage-Portection level.
Values defined in <dt-bindings/leds/leds-bd65b60.h>
$ref: "/schemas/types.yaml#/definitions/uint32"
enum: [ 0, 8, 16 ]
default: 16

required:
- rohm,enable-outputs

required:
- compatible
- reg
additionalProperties: false

examples:
- |
#include <dt-bindings/leds/common.h>
#include <dt-bindings/leds/leds-bd65b60.h>
i2c {
led_controler@64 {
compatible = "rohm,bd65b60";
reg = <0x64>;
backlight_led: led {
function = LED_FUNCTION_BACKLIGHT;
color = <LED_COLOR_ID_WHITE>;
rohm,enable-outputs = <BD65B60_ENABLE_LED1>;
default-state = "keep";
linux,default-trigger = "backlight";
};
};
};
...
21 changes: 21 additions & 0 deletions include/dt-bindings/leds/leds-bd65b60.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
/*
* This header provides macros for the ROHM BD65B60 device tree bindings.
*
* Copyright (C) 2023 Bogdan Ionescu <[email protected]>
*/

#ifndef _DT_BINDINGS_LEDS_BD65B60_H
#define _DT_BINDINGS_LEDS_BD65B60_H


#define BD65B60_ENABLE_NONE 0
#define BD65B60_ENABLE_LED1 1
#define BD65B60_ENABLE_LED2 4
#define BD65B60_ENABLE_BOTH (BD65B60_ENABLE_LED1 | BD65B60_ENABLE_LED2)

#define BD65B60_OVP_25V 0
#define BD65B60_OVP_30V 0x08
#define BD65B60_OVP_35V 0x10

#endif /* _DT_BINDINGS_LEDS_BD65B60_H */

0 comments on commit e24caf6

Please sign in to comment.