From: João Peixoto <joaopeixoto@osyx.tech>
This patch adds a Device Tree binding for the Bao IPC shared memory
device, which provides a standardized description of the hardware
interface used for inter-VM communication in Bao-based systems.
The binding documents the following properties:
- compatible: "bao,ipcshmem"
- reg: Memory region for the shared memory device
- id: Unique device identifier
- read-channel: [offset, size] for reading from the shared memory
- write-channel: [offset, size] for writing to the shared memory
- interrupts: Interrupts used by the device
This enables kernel drivers and userspace tools to correctly
instantiate and configure Bao IPC shared memory devices based
on the DT description, facilitating efficient communication
between VMs.
Signed-off-by: João Peixoto <joaopeixoto@osyx.tech>
---
.../devicetree/bindings/bao/ipcshmem.yaml | 99 +++++++++++++++++++
.../devicetree/bindings/vendor-prefixes.yaml | 2 +
2 files changed, 101 insertions(+)
create mode 100644 Documentation/devicetree/bindings/bao/ipcshmem.yaml
diff --git a/Documentation/devicetree/bindings/bao/ipcshmem.yaml b/Documentation/devicetree/bindings/bao/ipcshmem.yaml
new file mode 100644
index 000000000000..398ac610c29f
--- /dev/null
+++ b/Documentation/devicetree/bindings/bao/ipcshmem.yaml
@@ -0,0 +1,99 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/bao/ipcshmem.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Bao IPC Shared Memory Device
+
+maintainers:
+ - José Martins <jose@osyx.tech>
+ - David Cerdeira <davidmcerdeira@osyx.tech>
+ - João Peixoto <joaopeixoto@osyx.tech>
+
+description: |
+ Shared memory based communication device for Bao hypervisor guests.
+ It allows the kernel to interface with guests running under
+ the Bao hypervisor, providing a character device interface
+ for exchanging data through dedicated shared-memory regions.
+
+properties:
+ compatible:
+ const: "bao,ipcshmem"
+
+ reg:
+ description: |
+ Memory resource for the shared memory device.
+ maxItems: 4
+ type: array
+ items:
+ type: integer
+
+ id:
+ description: Driver instance ID
+ type: integer
+ minimum: 0
+
+ read-channel:
+ description: |
+ Defines the shared-memory region used by the guest → host data path.
+
+ The value is a 2-cell array describing a sub-region inside the main
+ `reg` area:
+ - The first cell is the byte offset from the beginning of the
+ shared-memory region specified in `reg`.
+ - The second cell is the size of the readable region in bytes.
+
+ The driver will only read data from this sub-region.
+ type: array
+ items:
+ type: integer
+ minItems: 2
+ maxItems: 2
+
+ write-channel:
+ description: |
+ Defines the shared-memory region used by the host → guest data path.
+
+ The value is a 2-cell array describing a sub-region inside the main
+ `reg` area:
+ - The first cell is the byte offset from the beginning of the
+ shared-memory region specified in `reg`.
+ - The second cell is the size of the writable region in bytes.
+
+ The driver will only write data into this sub-region.
+ type: array
+ items:
+ type: integer
+ minItems: 2
+ maxItems: 2
+
+ interrupts:
+ description: |
+ Interrupt specification for the device.
+ type: array
+ items:
+ type: integer
+ minItems: 3
+ maxItems: 3
+
+required:
+ - compatible
+ - reg
+ - id
+ - read-channel
+ - write-channel
+ - interrupts
+
+additionalProperties: false
+
+examples:
+ - |
+ bao-ipc@f0000000 {
+ compatible = "bao,ipcshmem";
+ reg = <0x0 0xf0000000 0x0 0x00010000>;
+ read-channel = <0x0 0x2000>;
+ write-channel = <0x2000 0x2000>;
+ interrupts = <0 52 1>;
+ id = <0>;
+ };
diff --git a/Documentation/devicetree/bindings/vendor-prefixes.yaml b/Documentation/devicetree/bindings/vendor-prefixes.yaml
index c7591b2aec2a..c047fbd6b91a 100644
--- a/Documentation/devicetree/bindings/vendor-prefixes.yaml
+++ b/Documentation/devicetree/bindings/vendor-prefixes.yaml
@@ -223,6 +223,8 @@ patternProperties:
description: Shenzhen AZW Technology Co., Ltd.
"^baikal,.*":
description: BAIKAL ELECTRONICS, JSC
+ "^bao,.*":
+ description: Bao Hypervisor
"^bananapi,.*":
description: BIPAI KEJI LIMITED
"^beacon,.*":
--
2.43.0
On Wed, Dec 24, 2025 at 01:52:13PM +0000, joaopeixoto@osyx.tech wrote: > From: João Peixoto <joaopeixoto@osyx.tech> > > This patch adds a Device Tree binding for the Bao IPC shared memory > device, which provides a standardized description of the hardware > interface used for inter-VM communication in Bao-based systems. > All you emails bounced as spam, so you need tofix your email setup. I found this only via lore. > The binding documents the following properties: > > - compatible: "bao,ipcshmem" > - reg: Memory region for the shared memory device > - id: Unique device identifier > - read-channel: [offset, size] for reading from the shared memory > - write-channel: [offset, size] for writing to the shared memory > - interrupts: Interrupts used by the device Irrelevant. Drop. > > This enables kernel drivers and userspace tools to correctly > instantiate and configure Bao IPC shared memory devices based > on the DT description, facilitating efficient communication > between VMs. > Irrelevant. Describe hardware. > Signed-off-by: João Peixoto <joaopeixoto@osyx.tech> > --- > .../devicetree/bindings/bao/ipcshmem.yaml | 99 +++++++++++++++++++ > .../devicetree/bindings/vendor-prefixes.yaml | 2 + > 2 files changed, 101 insertions(+) > create mode 100644 Documentation/devicetree/bindings/bao/ipcshmem.yaml Filename matching compatible. > > diff --git a/Documentation/devicetree/bindings/bao/ipcshmem.yaml b/Documentation/devicetree/bindings/bao/ipcshmem.yaml > new file mode 100644 > index 000000000000..398ac610c29f > --- /dev/null > +++ b/Documentation/devicetree/bindings/bao/ipcshmem.yaml > @@ -0,0 +1,99 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: "http://devicetree.org/schemas/bao/ipcshmem.yaml#" > +$schema: "http://devicetree.org/meta-schemas/core.yaml#" > + > +title: Bao IPC Shared Memory Device > + > +maintainers: > + - José Martins <jose@osyx.tech> > + - David Cerdeira <davidmcerdeira@osyx.tech> > + - João Peixoto <joaopeixoto@osyx.tech> > + > +description: | > + Shared memory based communication device for Bao hypervisor guests. > + It allows the kernel to interface with guests running under > + the Bao hypervisor, providing a character device interface > + for exchanging data through dedicated shared-memory regions. > + > +properties: > + compatible: > + const: "bao,ipcshmem" > + > + reg: > + description: | > + Memory resource for the shared memory device. > + maxItems: 4 > + type: array > + items: > + type: integer Don't send us LLM junk. Nothing here is even close to proper bindings, which means: 1. You did not write it yourself, because it is impossible to come with syntax like that (just does not exist), 2. Did not even bother to test it. Best regards, Krzysztof
On Wed, 24 Dec 2025 13:52:13 +0000, joaopeixoto@osyx.tech wrote: > From: João Peixoto <joaopeixoto@osyx.tech> > > This patch adds a Device Tree binding for the Bao IPC shared memory > device, which provides a standardized description of the hardware > interface used for inter-VM communication in Bao-based systems. > > The binding documents the following properties: > > - compatible: "bao,ipcshmem" > - reg: Memory region for the shared memory device > - id: Unique device identifier > - read-channel: [offset, size] for reading from the shared memory > - write-channel: [offset, size] for writing to the shared memory > - interrupts: Interrupts used by the device > > This enables kernel drivers and userspace tools to correctly > instantiate and configure Bao IPC shared memory devices based > on the DT description, facilitating efficient communication > between VMs. > > Signed-off-by: João Peixoto <joaopeixoto@osyx.tech> > --- > .../devicetree/bindings/bao/ipcshmem.yaml | 99 +++++++++++++++++++ > .../devicetree/bindings/vendor-prefixes.yaml | 2 + > 2 files changed, 101 insertions(+) > create mode 100644 Documentation/devicetree/bindings/bao/ipcshmem.yaml > My bot found errors running 'make dt_binding_check' on your patch: yamllint warnings/errors: dtschema/dtc warnings/errors: doc reference errors (make refcheckdocs): See https://patchwork.kernel.org/project/devicetree/patch/20251224135217.25350-2-joaopeixoto@osyx.tech The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.
© 2016 - 2026 Red Hat, Inc.