# Copyright (c) 2020, The ZMK Contributors
# SPDX-License-Identifier: MIT

description: ISSI IS31FL3743A LED Matrix driver

compatible: "issi,is31fl3743a"

include: i2c-device.yaml

properties:
  sw-setting:
    type: int
    required: false
    enum:
      - 0x00
      - 0x01
      - 0x02
      - 0x03
      - 0x04
      - 0x05
      - 0x06
      - 0x07
      - 0x08
      - 0x09
      - 0x0a
    default: 0x00
    description: |
      SW setting used to control the matrix size by turning off SWx pins
      as described in the datasheet.

  map:
    type: array
    required: true
    description: |
      Configure how RGB pixels are mapped to individual pixel registers.

  r-ext:
    type: int
    required: true
    description: Rext resistor value in kiloohms.

  led-max-current:
    type: int
    required: true
    description: Maximum current for each LED in mA. The chip supports up to 34mA.

  sync:
    type: int
    enum:
      - 0x00
      - 0x10
      - 0x11
    required: false
    default: 0x00
    description: |
      Controls the SYNC function. Set to 0x11 to set the device as main or 0x10 for secondary. 0x00 for 'off'.

  sdb-gpios:
    type: phandle-array
    required: false
    description: |
      GPIO pin for hardware shutdown functionality.

  chain-length:
    type: int
    required: true
    description: |
      How many RGB LEDs are driven by the IC.

  scaling-red:
    type: int
    required: false
    default: 255
    description: |
      Current scaling factor for red channel LEDs on a scale of 0-255.
      This setting adjusts the brightness of red pixels relative to other channels by scaling
      the amount of current flowing through them. 255 equals led-max-current.

  scaling-green:
    type: int
    required: false
    default: 255
    description: |
      Current scaling factor for green channel LEDs on a scale of 0-255.
      This setting adjusts the brightness of green pixels relative to other channels by scaling
      the amount of current flowing through them. 255 equals led-max-current.

  scaling-blue:
    type: int
    required: false
    default: 255
    description: |
      Current scaling factor for blue channel LEDs on a scale of 0-255.
      This setting adjusts the brightness of blue pixels relative to other channels by scaling
      the amount of current flowing through them. 255 equals led-max-current.

  gamma:
    type: array
    required: false
    description: |
      Gamma correction lookup values.
      The gamma values make the LED brightness seem more linear to human eyes.
      Default values match the recommendation from the IC datasheet but note that this may
      or may not apply for your particular LEDs.
    default:
      [
        0,
        0,
        0,
        0,
        1,
        1,
        1,
        1,
        2,
        2,
        2,
        2,
        3,
        3,
        3,
        3,
        4,
        4,
        4,
        4,
        5,
        5,
        5,
        5,
        6,
        6,
        6,
        6,
        7,
        7,
        7,
        7,
        8,
        8,
        8,
        8,
        10,
        10,
        10,
        10,
        12,
        12,
        12,
        12,
        14,
        14,
        14,
        14,
        16,
        16,
        16,
        16,
        18,
        18,
        18,
        18,
        20,
        20,
        20,
        20,
        22,
        22,
        22,
        22,
        24,
        24,
        24,
        24,
        26,
        26,
        26,
        26,
        29,
        29,
        29,
        29,
        32,
        32,
        32,
        32,
        35,
        35,
        35,
        35,
        38,
        38,
        38,
        38,
        41,
        41,
        41,
        41,
        44,
        44,
        44,
        44,
        47,
        47,
        47,
        47,
        50,
        50,
        50,
        50,
        53,
        53,
        53,
        53,
        57,
        57,
        57,
        57,
        61,
        61,
        61,
        61,
        65,
        65,
        65,
        65,
        69,
        69,
        69,
        69,
        73,
        73,
        73,
        73,
        77,
        77,
        77,
        77,
        81,
        81,
        81,
        81,
        85,
        85,
        85,
        85,
        89,
        89,
        89,
        89,
        94,
        94,
        94,
        94,
        99,
        99,
        99,
        99,
        104,
        104,
        104,
        104,
        109,
        109,
        109,
        109,
        114,
        114,
        114,
        114,
        119,
        119,
        119,
        119,
        124,
        124,
        124,
        124,
        129,
        129,
        129,
        129,
        134,
        134,
        134,
        134,
        140,
        140,
        140,
        140,
        146,
        146,
        146,
        146,
        152,
        152,
        152,
        152,
        158,
        158,
        158,
        158,
        164,
        164,
        164,
        164,
        170,
        170,
        170,
        170,
        176,
        176,
        176,
        176,
        182,
        182,
        182,
        182,
        188,
        188,
        188,
        188,
        195,
        195,
        195,
        195,
        202,
        202,
        202,
        202,
        209,
        209,
        209,
        209,
        216,
        216,
        216,
        216,
        223,
        223,
        223,
        223,
        230,
        230,
        230,
        230,
        237,
        237,
        237,
        237,
        244,
        244,
        244,
        244,
        251,
        251,
        251,
        251,
        255,
        255,
        255,
        255,
      ]