lkml.org 
[lkml]   [2020]   [May]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [Patch 1/2] dt-binbings: media: ti-vpe: Document the VIP driver
On Fri, May 22, 2020 at 05:54:11PM -0500, Benoit Parrot wrote:
> Device Tree bindings for the Video Input Port (VIP) driver.

Bindings document h/w, not drivers.

>
> Signed-off-by: Benoit Parrot <bparrot@ti.com>
> ---
> .../devicetree/bindings/media/ti,vip.yaml | 394 ++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 395 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/media/ti,vip.yaml
>
> diff --git a/Documentation/devicetree/bindings/media/ti,vip.yaml b/Documentation/devicetree/bindings/media/ti,vip.yaml
> new file mode 100644
> index 000000000000..8a9084e42329
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/ti,vip.yaml
> @@ -0,0 +1,394 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/media/ti,vip.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments DRA7x VIDEO INPUT PORT (VIP) Device Tree Bindings
> +
> +maintainers:
> + - Benoit Parrot <bparrot@ti.com>
> +
> +description: |-
> + The Video Input Port (VIP) is a key component for image capture
> + applications. The capture module provides the system interface and the
> + processing capability to connect parallel image-sensor as well as
> + BT.656/1120 capable encoder chip to DRA7x device.
> +
> + Each VIP instance supports 2 independently configurable external video
> + input capture slices (Slice 0 and Slice 1) each providing up to two video
> + input ports (Port A and Port B) where Port A can be configured as
> + 24/16/8-bit port and Port B is fixed as 8-bit port.
> + Here these ports a represented as follows
> + port@0 -> Slice 0 Port A
> + port@1 -> Slice 0 Port B
> + port@2 -> Slice 1 Port A
> + port@3 -> Slice 1 Port B
> +
> + Each camera port nodes should contain a 'port' child node with child
> + 'endpoint' node. Please refer to the bindings defined in
> + Documentation/devicetree/bindings/media/video-interfaces.txt.
> +
> +properties:
> + compatible:
> + const: ti,dra7-vip
> +
> + label:
> + description: Instance name

Kind of odd for this type of binding. Are there a define set or pattern
of values.

> +
> + reg:
> + items:
> + - description: The VIP main register region
> + - description: Video Data Parser (PARSER) register region for Slice0
> + - description: Color Space Conversion (CSC) register region for Slice0
> + - description: Scaler (SC) register region for Slice0
> + - description: Video Data Parser (PARSER) register region for Slice1
> + - description: Color Space Conversion (CSC) register region for Slice1
> + - description: Scaler (SC) register region for Slice1
> + - description: Video Port Direct Memory Access (VPDMA) register region
> +
> + reg-names:
> + items:
> + - const: vip
> + - const: parser0
> + - const: csc0
> + - const: sc0
> + - const: parser1
> + - const: csc1
> + - const: sc1
> + - const: vpdma
> +
> + interrupts:
> + minItems: 2
> + description:
> + IRQ index 0 is used for Slice0 interrupts
> + IRQ index 1 is used for Slice1 interrupts
> +
> + ti,vip-clk-polarity:
> + $ref: "/schemas/types.yaml#/definitions/phandle-array"
> + description:
> + phandle to the device control module. The 1st argument should
> + contain the register offset to the CTRL_CORE_SMA_SW_1 register.
> + 2nd argument contains the bit field to slice 0 port A,
> + 3rd argument contains the bit field to slice 0 port B,
> + 4th argument contains the bit field to slice 1 port A,
> + 5th argument contains the bit field to slice 1 port B.
> +
> + # See ./video-interfaces.txt for details
> + ports:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> + port@0:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + reg:
> + const: 0
> + description: Slice 0 Port A
> +
> + label:
> + description: Port name. Usually the pin group name
> +
> + patternProperties:
> + endpoint:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + hsync-active:
> + maxItems: 1

Not an array. Just:

hsync-active: true

> +
> + vsync-active:
> + maxItems: 1
> +
> + pclk-sample:
> + maxItems: 1
> +
> + bus-width:
> + maxItems: 1

Not an array. What subset of values are allowed?

> +
> + ti,vip-pixel-mux:
> + type: boolean
> + description:
> + In BT656/1120 mode, this enable pixel-muxing if
> + the number of channels is either 1, 2 or 4. If this
> + property is present then pixel-muxing is enabled
> + otherwise it will use line-muxing.
> +
> + ti,vip-channels:
> + $ref: "/schemas/types.yaml#definitions/uint8-array"
> + minItems: 1
> + maxItems: 16
> + description: |-
> + In BT656/1120 mode, list of channel ids to be captured.
> + If the property is not present then 1 channel is assumed.
> +
> + remote-endpoint: true
> +
> + required:
> + - reg
> + - label
> +
> + port@1:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + reg:
> + const: 1
> + description: Slice 0 Port B
> +
> + label:
> + description: Port name. Usually the pin group name
> +
> + patternProperties:
> + endpoint:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + hsync-active:
> + maxItems: 1
> +
> + vsync-active:
> + maxItems: 1
> +
> + pclk-sample:
> + maxItems: 1
> +
> + bus-width:
> + maxItems: 1
> +
> + ti,vip-pixel-mux:
> + type: boolean
> + description:
> + In BT656/1120 mode, this enable pixel-muxing if
> + the number of channels is either 1, 2 or 4. If this
> + property is present then pixel-muxing is enabled
> + otherwise it will use line-muxing.
> +
> + ti,vip-channels:
> + $ref: "/schemas/types.yaml#definitions/uint8-array"
> + minItems: 1
> + maxItems: 16
> + description:
> + In BT656/1120 mode, list of channel ids to be captured.
> + If the property is not present then 1 channel is assumed.
> +
> + remote-endpoint: true
> +
> + required:
> + - reg
> + - label
> +
> + port@2:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + reg:
> + const: 2
> + description: Slice 1 Port A
> +
> + label:
> + description: Port name. Usually the pin group name
> +
> + patternProperties:
> + endpoint:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + hsync-active:
> + maxItems: 1
> +
> + vsync-active:
> + maxItems: 1
> +
> + pclk-sample:
> + maxItems: 1
> +
> + bus-width:
> + maxItems: 1
> +
> + ti,vip-pixel-mux:
> + type: boolean
> + description:
> + In BT656/1120 mode, this enable pixel-muxing if
> + the number of channels is either 1, 2 or 4. If this
> + property is present then pixel-muxing is enabled
> + otherwise it will use line-muxing.
> +
> + ti,vip-channels:
> + $ref: "/schemas/types.yaml#definitions/uint8-array"
> + minItems: 1
> + maxItems: 16
> + description:
> + In BT656/1120 mode, list of channel ids to be captured.
> + If the property is not present then 1 channel is assumed.
> +
> + remote-endpoint: true
> +
> + required:
> + - reg
> + - label
> +
> + port@3:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + reg:
> + const: 3
> + description: Slice 1 Port B
> +
> + label:
> + description: Port name. Usually the pin group name
> +
> + patternProperties:
> + endpoint:
> + type: object
> + additionalProperties: false
> +
> + properties:
> + hsync-active:
> + maxItems: 1
> +
> + vsync-active:
> + maxItems: 1
> +
> + pclk-sample:
> + maxItems: 1
> +
> + bus-width:
> + maxItems: 1
> +
> + ti,vip-pixel-mux:
> + type: boolean
> + description:
> + In BT656/1120 mode, this enable pixel-muxing if
> + the number of channels is either 1, 2 or 4. If this
> + property is present then pixel-muxing is enabled
> + otherwise it will use line-muxing.
> +
> + ti,vip-channels:
> + $ref: "/schemas/types.yaml#definitions/uint8-array"
> + minItems: 1
> + maxItems: 16
> + description:
> + In BT656/1120 mode, list of channel ids to be captured.
> + If the property is not present then 1 channel is assumed.
> +
> + remote-endpoint: true

If all the properties are the same across ports, then do a
patternProperties with '^port@' and define them there. You'll still need
'port@0', etc. to define what each port is.

> +
> + required:
> + - reg
> + - label
> +
> + required:
> + - "#address-cells"
> + - "#size-cells"
> + - port@0
> +
> +required:
> + - compatible
> + - label
> + - reg
> + - reg-names
> + - interrupts
> + - ti,vip-clk-polarity
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> + vip1: vip@48970000 {
> + compatible = "ti,dra7-vip";
> + label = "vip1";
> + reg = <0x48970000 0x114>,
> + <0x48975500 0xD8>,
> + <0x48975700 0x18>,
> + <0x48975800 0x80>,
> + <0x48975a00 0xD8>,
> + <0x48975c00 0x18>,
> + <0x48975d00 0x80>,
> + <0x4897d000 0x400>;
> + reg-names = "vip",
> + "parser0",
> + "csc0",
> + "sc0",
> + "parser1",
> + "csc1",
> + "sc1",
> + "vpdma";
> + interrupts = <GIC_SPI 351 IRQ_TYPE_LEVEL_HIGH>,
> + <GIC_SPI 392 IRQ_TYPE_LEVEL_HIGH>;
> + ti,vip-clk-polarity = <&scm_conf 0x534 0x1 0x4 0x2 0x8>;
> +
> + ports {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + vin1a: port@0 {
> + reg = <0>;
> + label = "vin1a";
> +
> + vin1a_ep: endpoint {
> + remote-endpoint = <&camera1>;
> + hsync-active = <1>;
> + vsync-active = <1>;
> + pclk-sample = <0>;
> + bus-width = <8>;
> + };
> + };
> + vin1b: port@1 {
> + reg = <1>;
> + label = "vin1b";
> + };
> + vin2a: port@2 {
> + reg = <2>;
> + label = "vin2a";
> + };
> + vin2b: port@3 {
> + reg = <3>;
> + label = "vin2b";
> + };
> + };
> + };
> +
> + i2c {
> + clock-frequency = <400000>;
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + camera@37 {
> + compatible = "ovti,ov10633";
> + reg = <0x37>;
> +
> + clocks = <&fixed_clock>;
> + clocks-names = "xvclk";
> +
> + port {
> + camera1: endpoint {
> + remote-endpoint = <&vin1a_ep>;
> + hsync-active = <1>;
> + vsync-active = <1>;
> + pclk-sample = <0>;
> + bus-width = <8>;
> + };
> + };
> + };
> + };
> +
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 2e9a5f6e4ff7..06856d05b53b 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -16947,6 +16947,7 @@ S: Maintained
> W: http://linuxtv.org/
> Q: http://patchwork.linuxtv.org/project/linux-media/list/
> F: Documentation/devicetree/bindings/media/ti,cal.yaml
> +F: Documentation/devicetree/bindings/media/ti,vip.yaml
> F: Documentation/devicetree/bindings/media/ti,vpe.yaml
> F: drivers/media/platform/ti-vpe/
>
> --
> 2.17.1
>

\
 
 \ /
  Last update: 2020-05-29 01:40    [W:0.105 / U:0.600 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site