linux/Documentation/devicetree/bindings/input/apple,dockchannel-hid.yaml at a8a69b12a2d4ac24a3ab6ebc7c6147c88527eccb · IntegralPilot/linux · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/input/apple,dockchannel-hid.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Apple DockChannel HID Transport

maintainers:
  - Michael Reeves <[email protected]>

description: |
  Transport layer for HID devices (keyboard, trackpad) connected via the
  DockChannel FIFO interface on Apple Silicon SoCs. Contains a minimal
  coprocessor called the MTP (Multi-Touch Coprocessor) which assists with
  this and must be booted for it to work.

properties:
  compatible:
    oneOf:
      - items:
          - const: apple,t8112-dockchannel-hid
      - items:
          - const: apple,t6020-dockchannel-hid
          - const: apple,t8112-dockchannel-hid

  reg:
    items:
      - description: Config interface registers
      - description: Data interface registers
      - description: Coprocessor ASC registers
      - description: Coprocessor SRAM/mailbox registers

  reg-names:
    items:
      - const: config
      - const: data
      - const: coproc-asc
      - const: coproc-sram

  interrupts:
    items:
      - description: TX interrupt
      - description: RX interrupt

  interrupt-names:
    items:
      - const: tx
      - const: rx

  mboxes:
    maxItems: 1

  iommus:
    maxItems: 1

  keyboard:
    type: object
    description: |
      Optional properties for the internal keyboard.
    properties:
      hid-country-code:
        $ref: /schemas/types.yaml#/definitions/uint32
        description: The USB HID country code for the keyboard layout.
    additionalProperties: false

required:
  - compatible
  - reg
  - reg-names
  - interrupts
  - interrupt-names
  - mboxes
  - iommus

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>

    soc {
        #address-cells = <2>;
        #size-cells = <2>;

        input@8000 {
            compatible = "apple,t8112-dockchannel-hid";
            reg = <0x2 0xfab30000 0x0 0x4000>,
                  <0x2 0xfab34000 0x0 0x4000>,
                  <0x2 0xfa400000 0x0 0x4000>,
                  <0x2 0xfa050000 0x0 0x100000>;
            reg-names = "config", "data", "coproc-asc", "coproc-sram";
            mboxes = <&mtp_mbox>;
            iommus = <&mtp_dart 1>;
            interrupts = <2 IRQ_TYPE_LEVEL_HIGH>, <3 IRQ_TYPE_LEVEL_HIGH>;
            interrupt-names = "tx", "rx";

            keyboard {
                hid-country-code = <0>;
            };
        };
    };