Signed-off-by: Yoshinori Sato <[email protected]>
---
.../bindings/display/smi,sm501.yaml | 417 ++++++++++++++++++
1 file changed, 417 insertions(+)
create mode 100644 Documentation/devicetree/bindings/display/smi,sm501.yaml
diff --git a/Documentation/devicetree/bindings/display/smi,sm501.yaml b/Documentation/devicetree/bindings/display/smi,sm501.yaml
new file mode 100644
index 000000000000..8f2767bf2193
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/smi,sm501.yaml
@@ -0,0 +1,417 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/smi,sm501.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Silicon Motion SM501 Mobile Multimedia Companion Chip
+
+maintainers:
+ - Yoshinori Sato <[email protected]>
+
+description: |
+ These DT bindings describe the SM501.
+
+properties:
+ compatible:
+ const:
+ smi,sm501
+
+ reg:
+ maxItems: 2
+ description: |
+ First entry: System Configuration register
+ Second entry: IO space (Display Controller register)
+
+ interrupts:
+ description: SM501 interrupt to the cpu should be described here.
+
+ mode:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: select a video mode
+
+ edid:
+ description: |
+ verbatim EDID data block describing attached display.
+ Data from the detailed timing descriptor will be used to
+ program the display controller.
+
+ little-endian:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: available on big endian systems, to set different foreign endian.
+ big-endian:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: available on little endian systems, to set different foreign endian.
+
+ swap-fb-endian:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: swap framebuffer byteorder.
+
+ route-crt-panel:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: Panel output merge to CRT.
+
+ crt:
+ type: object
+ description: CRT output control
+ properties:
+ edid:
+ $ref: /schemas/types.yaml#/definitions/uint8-array
+ description: |
+ verbatim EDID data block describing attached display.
+ Data from the detailed timing descriptor will be used to
+ program the display controller.
+
+ smi,flags:
+ $ref: /schemas/types.yaml#/definitions/string-array
+ description: Display control flags.
+ items:
+ anyOf:
+ - const: use-init-done
+ - const: disable-at-exit
+ - const: use-hwcursor
+ - const: use-hwaccel
+ - const: panel-no-fpen
+ - const: panel-no-vbiasen
+ - const: panel-inv-fpen
+ - const: panel-inv-vbiasen
+ maxItems: 8
+
+ bpp:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Color depth
+
+ panel:
+ type: object
+ description: Panel output control
+ properties:
+ edid:
+ $ref: /schemas/types.yaml#/definitions/uint8-array
+ description: |
+ verbatim EDID data block describing attached display.
+ Data from the detailed timing descriptor will be used to
+ program the display controller.
+
+ smi,flags:
+ $ref: /schemas/types.yaml#/definitions/string-array
+ description: Display control flags.
+ items:
+ anyOf:
+ - const: use-init-done
+ - const: disable-at-exit
+ - const: use-hwcursor
+ - const: use-hwaccel
+ - const: panel-no-fpen
+ - const: panel-no-vbiasen
+ - const: panel-inv-fpen
+ - const: panel-inv-vbiasen
+ maxItems: 8
+
+ bpp:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Color depth
+
+ smi,devices:
+ $ref: /schemas/types.yaml#/definitions/string-array
+ description: Select SM501 device functions.
+ items:
+ anyOf:
+ - const: usb-host
+ - const: usb-slave
+ - const: ssp0
+ - const: ssp1
+ - const: uart0
+ - const: uart1
+ - const: fbaccel
+ - const: ac97
+ - const: i2s
+ - const: gpio
+ minItems: 1
+ maxItems: 10
+
+ smi,mclk:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: mclk frequency.
+
+ smi,m1xclk:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: m1xclk frequency.
+
+ misc-timing:
+ type: object
+ description: Miscellaneous Timing register values.
+ properties:
+ ex:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Extend bus holding time.
+ enum: [0, 16, 32, 48, 64, 80, 96, 112, 128, 144, 160, 176, 192, 208, 224, 240]
+
+ xc:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: Xscale clock input select.
+ items:
+ enum:
+ - internal-pll
+ - hclk
+ - gpio33
+
+ us:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: USB host current detection.
+ items:
+ enum:
+ - disable
+ - enable
+
+ ssm1:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: SDRAM clock select for PW mode 1.
+ items:
+ enum:
+ - 288mhz
+ - div
+
+ sm1:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: SDRAM clock divider for PW mode 1.
+ enum: [1, 2, 3, 4, 6, 8, 12, 16, 24, 32, 48, 64, 96, 128, 192, 384]
+
+ ssm0:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: SDRAM clock select for PW mode 0.
+ items:
+ enum:
+ - 288mhz
+ - div
+
+ sm0:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: SDRAM clock divider for PW mode 0.
+ enum: [1, 2, 3, 4, 6, 8, 12, 16, 24, 32, 48, 64, 96, 128, 192, 384]
+
+ deb:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: 96MHz PLL debug control.
+ items:
+ enum:
+ - input-reference
+ - output
+
+ acpi:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: ACPI control.
+ items:
+ enum:
+ - disable
+ - enable
+
+ divider:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Second PLL output frequency.
+ enum: [336, 288, 240, 192]
+
+ usb-mode:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: USB Host mode.
+ items:
+ enum:
+ - normal
+ - simulation
+
+ delay:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Delay time to latch read data. Set the value to 10x.
+ enum: [5, 10, 15, 20, 25]
+
+ misc-control:
+ type: object
+ description: Miscellaneous Control register values.
+ properties:
+ pad:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: PCI Pad drive strength.
+ enum: [24, 12, 8]
+
+ usbclk:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: USB Clcok Select.
+ items:
+ enum:
+ - crystal
+ - 96mhz
+ - 48mhz
+
+ uart-ssp:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: UART1/SSP1 select.
+ items:
+ enum:
+ - uart1
+ - ssp1
+
+ lat:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: 8051 Latch enable.
+ items:
+ enum:
+ - disable
+ - enable
+
+ fp:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Flat Panel data select.
+ enum: [18, 24]
+
+ freq:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Frequency select.
+ enum: [24, 12]
+
+ refresh:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: Internal memory refresh timing.
+ enum: [8, 16, 32, 64]
+
+ hold:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: BUS Hold time.
+ enum: [0, 8, 16, 24, 32]
+
+ sh:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: SuperH ready polarity.
+ items:
+ enum:
+ - active-low
+ - active-high
+
+ ii:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: Interrupt Inverting.
+ items:
+ enum:
+ - normal
+ - invert
+
+ pll:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: PLL clock count.
+ items:
+ enum:
+ - disable
+ - enable
+
+ gap:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: DAC Band GAP control.
+ items:
+ const: default
+
+ dac:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: DAC Power control.
+ items:
+ enum:
+ - disable
+ - enable
+
+ mc:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: USB slave controller.
+ items:
+ enum:
+ - cpu
+ - '8051'
+
+ bl:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: CPU Master burst length.
+ enum: [8, 1]
+
+ usb:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: USB port select.
+ items:
+ enum:
+ - master
+ - slave
+
+ lb:
+ $ref: /schemas/types.yaml#/definitions/string
+ description: USB loop-back select.
+ items:
+ enum:
+ - normal
+ - loopback
+ vr:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: NEC VR Memory map select.
+ enum: [30, 62]
+
+ gpio-pin-control:
+ type: object
+ description: GPIO control configuration.
+ properties:
+ pin:
+ type: object
+ properties:
+ gpio:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: pin in/out use GPIO.
+ function:
+ $ref: /schemas/types.yaml#/definitions/flag
+ description: pin in/out use function.
+
+ gpio-i2c:
+ type: object
+ description: GPIO I2C definition.
+ properties:
+ i2c:
+ type: object
+ properties:
+ bus:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: I2C bus number.
+
+ sda:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: I2C SDA pin port number.
+
+ scl:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: I2C SCL pin port number.
+
+ delay:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: bit transmission delay.
+
+ timeout:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: transmission timeout.
+
+additionalProperties: false
+
+required:
+ - compatible
+ - reg
+ - interrupts
+
+
+examples:
+ # MPC5200
+ - |
+ display@1,0 {
+ compatible = "smi,sm501";
+ reg = <0x00000000 0x00800000
+ 0x03e00000 0x00200000>;
+ interrupts = <1 1 3>;
+ mode = "640x480-32@60";
+ edid = [00 ff ff ff ff ff ff 00 00 00 00 00 00 00 00 00
+ 00 00 01 04 00 00 00 00 00 00 00 00 00 00 00 00
+ 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+ 00 00 00 00 00 00 f0 0a 80 fb 20 e0 25 10 32 60
+ 02 00 00 00 00 00 00 06 00 00 00 00 00 00 00 00
+ 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+ 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+ 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 bd];
+ };
--
2.39.2
Hi Sato-san,
On Tue, Jan 9, 2024 at 9:24 AM Yoshinori Sato
<[email protected]> wrote:
> Signed-off-by: Yoshinori Sato <[email protected]>
Thanks for your patch!
> ---
> .../bindings/display/smi,sm501.yaml | 417 ++++++++++++++++++
> 1 file changed, 417 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/display/smi,sm501.yaml
Surely Documentation/devicetree/bindings/display/sm501fb.txt should
be removed, too?
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/smi,sm501.yaml
> + crt:
> + type: object
> + description: CRT output control
> + properties:
> + edid:
> + $ref: /schemas/types.yaml#/definitions/uint8-array
> + description: |
> + verbatim EDID data block describing attached display.
> + Data from the detailed timing descriptor will be used to
> + program the display controller.
> +
> + smi,flags:
> + $ref: /schemas/types.yaml#/definitions/string-array
> + description: Display control flags.
> + items:
> + anyOf:
> + - const: use-init-done
> + - const: disable-at-exit
> + - const: use-hwcursor
> + - const: use-hwaccel
The "use-*" flags look like software policy, not hardware description,
and thus do not belong in DT?
> + - const: panel-no-fpen
> + - const: panel-no-vbiasen
> + - const: panel-inv-fpen
> + - const: panel-inv-vbiasen
> + maxItems: 8
> +
> + bpp:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: Color depth
> +
> + panel:
> + type: object
> + description: Panel output control
> + properties:
> + edid:
> + $ref: /schemas/types.yaml#/definitions/uint8-array
> + description: |
> + verbatim EDID data block describing attached display.
> + Data from the detailed timing descriptor will be used to
> + program the display controller.
> +
> + smi,flags:
> + $ref: /schemas/types.yaml#/definitions/string-array
> + description: Display control flags.
> + items:
> + anyOf:
> + - const: use-init-done
> + - const: disable-at-exit
> + - const: use-hwcursor
> + - const: use-hwaccel
The "use-*" flags look like software policy, not hardware description,
and thus do not belong in DT?
> + - const: panel-no-fpen
> + - const: panel-no-vbiasen
> + - const: panel-inv-fpen
> + - const: panel-inv-vbiasen
> + maxItems: 8
> +
> + bpp:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: Color depth
> +
> + smi,devices:
> + $ref: /schemas/types.yaml#/definitions/string-array
> + description: Select SM501 device functions.
> + items:
> + anyOf:
> + - const: usb-host
> + - const: usb-slave
> + - const: ssp0
> + - const: ssp1
> + - const: uart0
> + - const: uart1
> + - const: fbaccel
> + - const: ac97
> + - const: i2s
> + - const: gpio
> + minItems: 1
> + maxItems: 10
I think it would be better to have individual subnodes for the sub devices,
with status = "ok"/"disabled".
If you go that route, you do need some fallback code to handle the lack
of subnodes in the existing user in arch/powerpc/boot/dts/charon.dts.
BTW, why can sm501_pci_initdata get away with setting ".devices
= SM501_USE_ALL"? Or, would it hurt to enable all subdevices
unconditionally?
> +
> + smi,mclk:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: mclk frequency.
> +
> + smi,m1xclk:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: m1xclk frequency.
These two should be clock specifiers (i.e. phandles pointing to clock
nodes + optional clock indices).
> +
> + misc-timing:
> + type: object
> + description: Miscellaneous Timing register values.
> + properties:
> + ex:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: Extend bus holding time.
> + enum: [0, 16, 32, 48, 64, 80, 96, 112, 128, 144, 160, 176, 192, 208, 224, 240]
> +
> + xc:
> + $ref: /schemas/types.yaml#/definitions/string
> + description: Xscale clock input select.
> + items:
> + enum:
> + - internal-pll
> + - hclk
> + - gpio33
Software policy instead of hardware description again?
I am not familiar with how the SM501 works, so I cannot comment on
the other properties, but several of them look like they need rework.
Gr{oetje,eeting}s,
Geert
--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68korg
In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds