Documentation/devicetree/bindings/auxdisplay/holtek,ht16k33.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/auxdisplay/holtek,ht16k33.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Holtek HT16K33 RAM mapping 16*8 LED controller with keyscan
   8
   9 maintainers:
  10   - Robin van der Gracht <robin@protonic.nl>
  11
  12 allOf:
  13   - $ref: /schemas/input/matrix-keymap.yaml#
  14
  15 properties:
  16   compatible:
  17     oneOf:
  18       - items:
  19           - enum:
  20               - adafruit,3108  # 0.56" 4-Digit 7-Segment FeatherWing Display (Red)
  21               - adafruit,3130  # 0.54" Quad Alphanumeric FeatherWing Display (Red)
  22           - const: holtek,ht16k33
  23
  24       - const: holtek,ht16k33     # Generic 16*8 LED controller with dot-matrix display
  25
  26   reg:
  27     maxItems: 1
  28
  29   refresh-rate-hz:
  30     maxItems: 1
  31     description: Display update interval in Hertz for dot-matrix displays
  32
  33   interrupts:
  34     maxItems: 1
  35
  36   debounce-delay-ms:
  37     maxItems: 1
  38     description: Debouncing interval time in milliseconds
  39
  40   linux,keymap: true
  41
  42   linux,no-autorepeat:
  43     type: boolean
  44     description: Disable keyrepeat
  45
  46   default-brightness-level:
  47     minimum: 1
  48     maximum: 16
  49     default: 16
  50     description: Initial brightness level
  51
  52   led:
  53     type: object
  54     $ref: /schemas/leds/common.yaml#
  55     unevaluatedProperties: false
  56
  57 required:
  58   - compatible
  59   - reg
  60
  61 if:
  62   properties:
  63     compatible:
  64       const: holtek,ht16k33
  65 then:
  66   required:
  67     - refresh-rate-hz
  68
  69 additionalProperties: false
  70
  71 examples:
  72   - |
  73     #include <dt-bindings/interrupt-controller/irq.h>
  74     #include <dt-bindings/input/input.h>
  75     #include <dt-bindings/leds/common.h>
  76     i2c {
  77             #address-cells = <1>;
  78             #size-cells = <0>;
  79
  80             ht16k33: ht16k33@70 {
  81                     compatible = "holtek,ht16k33";
  82                     reg = <0x70>;
  83                     refresh-rate-hz = <20>;
  84                     interrupt-parent = <&gpio4>;
  85                     interrupts = <5 (IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_EDGE_RISING)>;
  86                     debounce-delay-ms = <50>;
  87                     linux,keymap = <MATRIX_KEY(2, 0, KEY_F6)>,
  88                                    <MATRIX_KEY(3, 0, KEY_F8)>,
  89                                    <MATRIX_KEY(4, 0, KEY_F10)>,
  90                                    <MATRIX_KEY(5, 0, KEY_F4)>,
  91                                    <MATRIX_KEY(6, 0, KEY_F2)>,
  92                                    <MATRIX_KEY(2, 1, KEY_F5)>,
  93                                    <MATRIX_KEY(3, 1, KEY_F7)>,
  94                                    <MATRIX_KEY(4, 1, KEY_F9)>,
  95                                    <MATRIX_KEY(5, 1, KEY_F3)>,
  96                                    <MATRIX_KEY(6, 1, KEY_F1)>;
  97
  98                     led {
  99                             color = <LED_COLOR_ID_RED>;
 100                             function = LED_FUNCTION_BACKLIGHT;
 101                             linux,default-trigger = "backlight";
 102                     };
 103             };
 104       };