[thirdparty/linux.git] / Documentation / devicetree / bindings / media / amlogic,meson-gx-ao-cec.yaml

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
# Copyright 2019 BayLibre, SAS
%YAML 1.2
---
$id: "http://devicetree.org/schemas/media/amlogic,meson-gx-ao-cec.yaml#"
$schema: "http://devicetree.org/meta-schemas/core.yaml#"

title: Amlogic Meson AO-CEC Controller

maintainers:
  - Neil Armstrong <neil.armstrong@linaro.org>

description: |
  The Amlogic Meson AO-CEC module is present is Amlogic SoCs and its purpose is
  to handle communication between HDMI connected devices over the CEC bus.

properties:
  compatible:
    enum:
      - amlogic,meson-gx-ao-cec # GXBB, GXL, GXM, G12A and SM1 AO_CEC_A module
      - amlogic,meson-g12a-ao-cec # G12A AO_CEC_B module
      - amlogic,meson-sm1-ao-cec # SM1 AO_CEC_B module

  reg:
    maxItems: 1

  clocks:
    maxItems: 1

  clock-names:
    maxItems: 1

  interrupts:
    maxItems: 1

  hdmi-phandle:
    description: phandle to the HDMI controller
    $ref: /schemas/types.yaml#/definitions/phandle

allOf:
  - if:
      properties:
        compatible:
          contains:
            enum:
              - amlogic,meson-gx-ao-cec

    then:
      properties:
        clocks:
          items:
            - description: AO-CEC clock

        clock-names:
          items:
            - const: core

  - if:
      properties:
        compatible:
          contains:
            enum:
              - amlogic,meson-g12a-ao-cec
              - amlogic,meson-sm1-ao-cec

    then:
      properties:
        clocks:
          items:
            - description: AO-CEC clock generator source

        clock-names:
          items:
            - const: oscin

required:
  - compatible
  - reg
  - interrupts
  - hdmi-phandle
  - clocks
  - clock-names

additionalProperties: false

examples:
  - |
    cec_AO: cec@100 {
        compatible = "amlogic,meson-gx-ao-cec";
        reg = <0x00100 0x14>;
        interrupts = <199>;
        clocks = <&clkc_cec>;
        clock-names = "core";
        hdmi-phandle = <&hdmi_tx>;
    };
Commit	Line	Data
cf4ef3a8 NA	1	# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
	2	# Copyright 2019 BayLibre, SAS
	3	%YAML 1.2
	4	---
	5	$id: "http://devicetree.org/schemas/media/amlogic,meson-gx-ao-cec.yaml#"
	6	$schema: "http://devicetree.org/meta-schemas/core.yaml#"
	7
	8	title: Amlogic Meson AO-CEC Controller
	9
	10	maintainers:
c6a43fb3	11	- Neil Armstrong <neil.armstrong@linaro.org>
cf4ef3a8 NA	12
	13	description: \|
	14	The Amlogic Meson AO-CEC module is present is Amlogic SoCs and its purpose is
	15	to handle communication between HDMI connected devices over the CEC bus.
	16
	17	properties:
	18	compatible:
	19	enum:
	20	- amlogic,meson-gx-ao-cec # GXBB, GXL, GXM, G12A and SM1 AO_CEC_A module
	21	- amlogic,meson-g12a-ao-cec # G12A AO_CEC_B module
	22	- amlogic,meson-sm1-ao-cec # SM1 AO_CEC_B module
	23
	24	reg:
	25	maxItems: 1
	26
0d9a302d RH	27	clocks:
	28	maxItems: 1
	29
	30	clock-names:
	31	maxItems: 1
	32
cf4ef3a8 NA	33	interrupts:
	34	maxItems: 1
	35
	36	hdmi-phandle:
	37	description: phandle to the HDMI controller
3d21a460	38	$ref: /schemas/types.yaml#/definitions/phandle
cf4ef3a8 NA	39
	40	allOf:
	41	- if:
	42	properties:
	43	compatible:
	44	contains:
	45	enum:
	46	- amlogic,meson-gx-ao-cec
	47
	48	then:
	49	properties:
	50	clocks:
	51	items:
	52	- description: AO-CEC clock
	53
	54	clock-names:
cf4ef3a8 NA	55	items:
	56	- const: core
	57
	58	- if:
	59	properties:
	60	compatible:
	61	contains:
	62	enum:
	63	- amlogic,meson-g12a-ao-cec
	64	- amlogic,meson-sm1-ao-cec
	65
	66	then:
	67	properties:
	68	clocks:
	69	items:
	70	- description: AO-CEC clock generator source
	71
	72	clock-names:
cf4ef3a8 NA	73	items:
	74	- const: oscin
	75
	76	required:
	77	- compatible
	78	- reg
	79	- interrupts
	80	- hdmi-phandle
	81	- clocks
	82	- clock-names
	83
7f464532 RH	84	additionalProperties: false
7f464532 RH	85
cf4ef3a8 NA	86	examples:
	87	- \|
	88	cec_AO: cec@100 {
	89	compatible = "amlogic,meson-gx-ao-cec";
fba56184	90	reg = <0x00100 0x14>;
cf4ef3a8 NA	91	interrupts = <199>;
	92	clocks = <&clkc_cec>;
	93	clock-names = "core";
	94	hdmi-phandle = <&hdmi_tx>;
	95	};