[PATCH v2 1/4] arm64: dts: qcom: SMxxxx: drop msg-size property from ramoops

[PATCH v2 1/4] arm64: dts: qcom: SMxxxx: drop msg-size property from ramoops

[David Heidelberg]

Invalid property, not supported by ramoops node.

Reviewed-by: Konrad Dybcio <konrad.dybcio@somainline.org>
Signed-off-by: David Heidelberg <david@ixit.cz>
---
 arch/arm64/boot/dts/qcom/sm6125-sony-xperia-seine-pdx201.dts | 1 -
 arch/arm64/boot/dts/qcom/sm6350.dtsi                         | 1 -
 arch/arm64/boot/dts/qcom/sm8150-sony-xperia-kumano.dtsi      | 1 -
 arch/arm64/boot/dts/qcom/sm8250-sony-xperia-edo.dtsi         | 1 -
 4 files changed, 4 deletions(-)

diff --git a/arch/arm64/boot/dts/qcom/sm6125-sony-xperia-seine-pdx201.dts b/arch/arm64/boot/dts/qcom/sm6125-sony-xperia-seine-pdx201.dts
index 58b6b2742d3f..64f1eab99d5e 100644
--- a/arch/arm64/boot/dts/qcom/sm6125-sony-xperia-seine-pdx201.dts
+++ b/arch/arm64/boot/dts/qcom/sm6125-sony-xperia-seine-pdx201.dts
@@ -74,7 +74,6 @@ pstore_mem: ramoops@ffc00000 {
 			reg = <0x0 0xffc40000 0x0 0xc0000>;
 			record-size = <0x1000>;
 			console-size = <0x40000>;
-			msg-size = <0x20000 0x20000>;
 		};
 
 		cmdline_mem: memory@ffd00000 {
diff --git a/arch/arm64/boot/dts/qcom/sm6350.dtsi b/arch/arm64/boot/dts/qcom/sm6350.dtsi
index 926d30c57add..513c27895dd5 100644
--- a/arch/arm64/boot/dts/qcom/sm6350.dtsi
+++ b/arch/arm64/boot/dts/qcom/sm6350.dtsi
@@ -344,7 +344,6 @@ ramoops: ramoops@ffc00000 {
 			record-size = <0x1000>;
 			console-size = <0x40000>;
 			ftrace-size = <0x0>;
-			msg-size = <0x20000 0x20000>;
 			cc-size = <0x0>;
 			no-map;
 		};
diff --git a/arch/arm64/boot/dts/qcom/sm8150-sony-xperia-kumano.dtsi b/arch/arm64/boot/dts/qcom/sm8150-sony-xperia-kumano.dtsi
index 014fe3a31548..a7eb084932ab 100644
--- a/arch/arm64/boot/dts/qcom/sm8150-sony-xperia-kumano.dtsi
+++ b/arch/arm64/boot/dts/qcom/sm8150-sony-xperia-kumano.dtsi
@@ -126,7 +126,6 @@ ramoops@ffc00000 {
 			reg = <0x0 0xffc00000 0x0 0x100000>;
 			record-size = <0x1000>;
 			console-size = <0x40000>;
-			msg-size = <0x20000 0x20000>;
 			ecc-size = <16>;
 			no-map;
 		};
diff --git a/arch/arm64/boot/dts/qcom/sm8250-sony-xperia-edo.dtsi b/arch/arm64/boot/dts/qcom/sm8250-sony-xperia-edo.dtsi
index d63f7a9bc4e9..34cfb8d8d1ad 100644
--- a/arch/arm64/boot/dts/qcom/sm8250-sony-xperia-edo.dtsi
+++ b/arch/arm64/boot/dts/qcom/sm8250-sony-xperia-edo.dtsi
@@ -111,7 +111,6 @@ ramoops@ffc00000 {
 			reg = <0x0 0xffc00000 0x0 0x100000>;
 			record-size = <0x1000>;
 			console-size = <0x40000>;
-			msg-size = <0x20000 0x20000>;
 			ecc-size = <16>;
 			no-map;
 		};
-- 
2.33.0

[PATCH v2 2/4] arm64: dts: qcom: sm6350: fix typo in ecc-size property

[David Heidelberg]

Typo, default value is 0, but since we won't break backwards
compatibility (this change is still inside -rc) lets change it to 16.

Reviewed-by: Konrad Dybcio <konrad.dybcio@somainline.org>
Signed-off-by: David Heidelberg <david@ixit.cz>
---
 arch/arm64/boot/dts/qcom/sm6350.dtsi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm64/boot/dts/qcom/sm6350.dtsi b/arch/arm64/boot/dts/qcom/sm6350.dtsi
index 513c27895dd5..db405a6175c0 100644
--- a/arch/arm64/boot/dts/qcom/sm6350.dtsi
+++ b/arch/arm64/boot/dts/qcom/sm6350.dtsi
@@ -344,7 +344,7 @@ ramoops: ramoops@ffc00000 {
 			record-size = <0x1000>;
 			console-size = <0x40000>;
 			ftrace-size = <0x0>;
-			cc-size = <0x0>;
+			ecc-size = <16>;
 			no-map;
 		};
 
-- 
2.33.0

[PATCH v2 3/4] arm64: dts: qcom: sm6350: remove compatible leftover from ramoops node

[David Heidelberg]

This was leftover. No functional change.

Reviewed-by: Konrad Dybcio <konrad.dybcio@somainline.org>
Signed-off-by: David Heidelberg <david@ixit.cz>
---
 arch/arm64/boot/dts/qcom/sm6350.dtsi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/arm64/boot/dts/qcom/sm6350.dtsi b/arch/arm64/boot/dts/qcom/sm6350.dtsi
index db405a6175c0..961af2cdd23b 100644
--- a/arch/arm64/boot/dts/qcom/sm6350.dtsi
+++ b/arch/arm64/boot/dts/qcom/sm6350.dtsi
@@ -339,7 +339,7 @@ last_log_region: memory@ffbc0000 {
 		};
 
 		ramoops: ramoops@ffc00000 {
-			compatible = "removed-dma-pool", "ramoops";
+			compatible = "ramoops";
 			reg = <0 0xffc00000 0 0x00100000>;
 			record-size = <0x1000>;
 			console-size = <0x40000>;
-- 
2.33.0

[PATCH v2 4/4] dt-bindings: reserved-memory: ramoops: Convert txt bindings to yaml

[David Heidelberg]

Convert ramoops driver to the YAML syntax.

v2:
 - inherit reserved-memory properties
 - switch to unevaluatedProperties

Signed-off-by: David Heidelberg <david@ixit.cz>
---
 .../bindings/reserved-memory/ramoops.txt      |  66 ---------
 .../bindings/reserved-memory/ramoops.yaml     | 129 ++++++++++++++++++
 2 files changed, 129 insertions(+), 66 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/reserved-memory/ramoops.txt
 create mode 100644 Documentation/devicetree/bindings/reserved-memory/ramoops.yaml

diff --git a/Documentation/devicetree/bindings/reserved-memory/ramoops.txt b/Documentation/devicetree/bindings/reserved-memory/ramoops.txt
deleted file mode 100644
index b571ef6dab0f..000000000000
--- a/Documentation/devicetree/bindings/reserved-memory/ramoops.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-Ramoops oops/panic logger
-=========================
-
-ramoops provides persistent RAM storage for oops and panics, so they can be
-recovered after a reboot. This is a child-node of "/reserved-memory", and
-is named "ramoops" after the backend, rather than "pstore" which is the
-subsystem.
-
-Parts of this storage may be set aside for other persistent log buffers, such
-as kernel log messages, or for optional ECC error-correction data.  The total
-size of these optional buffers must fit in the reserved region.
-
-Any remaining space will be used for a circular buffer of oops and panic
-records.  These records have a configurable size, with a size of 0 indicating
-that they should be disabled.
-
-At least one of "record-size", "console-size", "ftrace-size", or "pmsg-size"
-must be set non-zero, but are otherwise optional as listed below.
-
-
-Required properties:
-
-- compatible: must be "ramoops"
-
-- reg: region of memory that is preserved between reboots
-
-
-Optional properties:
-
-- ecc-size: enables ECC support and specifies ECC buffer size in bytes
-  (defaults to 0: no ECC)
-
-- record-size: maximum size in bytes of each kmsg dump.
-  (defaults to 0: disabled)
-
-- console-size: size in bytes of log buffer reserved for kernel messages
-  (defaults to 0: disabled)
-
-- ftrace-size: size in bytes of log buffer reserved for function tracing and
-  profiling (defaults to 0: disabled)
-
-- pmsg-size: size in bytes of log buffer reserved for userspace messages
-  (defaults to 0: disabled)
-
-- mem-type: if present, sets the type of mapping is to be used to map the
-  reserved region. mem-type: 0 = write-combined (default), 1 = unbuffered,
-  2 = cached.
-
-- unbuffered: deprecated, use mem_type instead. If present, and mem_type is
-  not specified, it is equivalent to mem_type = 1 and uses unbuffered mappings
-  to map the reserved region (defaults to buffered mappings mem_type = 0). If
-  both are specified -- "mem_type" overrides "unbuffered".
-
-- max-reason: if present, sets maximum type of kmsg dump reasons to store
-  (defaults to 2: log Oopses and Panics). This can be set to INT_MAX to
-  store all kmsg dumps. See include/linux/kmsg_dump.h KMSG_DUMP_* for other
-  kmsg dump reason values. Setting this to 0 (KMSG_DUMP_UNDEF), means the
-  reason filtering will be controlled by the printk.always_kmsg_dump boot
-  param: if unset, it will be KMSG_DUMP_OOPS, otherwise KMSG_DUMP_MAX.
-
-- no-dump-oops: deprecated, use max_reason instead. If present, and
-  max_reason is not specified, it is equivalent to max_reason = 1
-  (KMSG_DUMP_PANIC).
-
-- flags: if present, pass ramoops behavioral flags (defaults to 0,
-  see include/linux/pstore_ram.h RAMOOPS_FLAG_* for flag values).
diff --git a/Documentation/devicetree/bindings/reserved-memory/ramoops.yaml b/Documentation/devicetree/bindings/reserved-memory/ramoops.yaml
new file mode 100644
index 000000000000..a21a27e84a6d
--- /dev/null
+++ b/Documentation/devicetree/bindings/reserved-memory/ramoops.yaml
@@ -0,0 +1,129 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/reserved-memory/ramoops.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Ramoops oops/panic logger
+
+description: |
+  ramoops provides persistent RAM storage for oops and panics, so they can be
+  recovered after a reboot. This is a child-node of "/reserved-memory", and
+  is named "ramoops" after the backend, rather than "pstore" which is the
+  subsystem.
+
+  Parts of this storage may be set aside for other persistent log buffers, such
+  as kernel log messages, or for optional ECC error-correction data.  The total
+  size of these optional buffers must fit in the reserved region.
+
+  Any remaining space will be used for a circular buffer of oops and panic
+  records.  These records have a configurable size, with a size of 0 indicating
+  that they should be disabled.
+
+  At least one of "record-size", "console-size", "ftrace-size", or "pmsg-size"
+  must be set non-zero, but are otherwise optional as listed below.
+
+maintainers:
+  - Kees Cook <keescook@chromium.org>
+
+allOf:
+  - $ref: "reserved-memory.yaml"
+
+properties:
+  compatible:
+    const: ramoops
+
+  reg:
+    description: region of memory that is preserved between reboots
+
+  ecc-size:
+    description: enables ECC support and specifies ECC buffer size in bytes
+    default: 0 # no ECC
+
+  record-size:
+    description: maximum size in bytes of each kmsg dump
+    default: 0
+
+  console-size:
+    description: size in bytes of log buffer reserved for kernel messages
+    default: 0
+
+  ftrace-size:
+    description: size in bytes of log buffer reserved for function tracing and profiling
+    default: 0
+
+  pmsg-size:
+    description: size in bytes of log buffer reserved for userspace messages
+    default: 0
+
+  mem-type:
+    description: if present, sets the type of mapping is to be used to map the reserved region.
+    default: 0
+    enum:
+      - const: 0
+        description: write-combined
+      - const: 1
+        description: unbuffered
+      - const: 2
+        description: cached
+
+  unbuffered:
+    deprecated: true
+    description: |
+      use mem_type instead. If present, and mem_type is not specified,
+      it is equivalent to mem_type = 1 and uses unbuffered mappings to map
+      the reserved region (defaults to buffered mappings mem_type = 0).
+      If both are specified -- "mem_type" overrides "unbuffered".
+
+  max-reason:
+    default: 2 # log oopses and panics
+    description: |
+      If present, sets maximum type of kmsg dump reasons to store.
+      This can be set to INT_MAX to store all kmsg dumps.
+      See include/linux/kmsg_dump.h KMSG_DUMP_* for other
+      kmsg dump reason values. Setting this to 0 (KMSG_DUMP_UNDEF), means the
+      reason filtering will be controlled by the printk.always_kmsg_dump boot
+
+  param:
+    description: if unset, it will be KMSG_DUMP_OOPS, otherwise KMSG_DUMP_MAX.
+
+  no-dump-oops:
+    deprecated: true
+    description: |
+      Use max_reason instead. If present, and max_reason is not specified,
+      it is equivalent to max_reason = 1 (KMSG_DUMP_PANIC).
+
+  flags:
+    default: 0
+    description: |
+      If present, pass ramoops behavioral flags
+      (see include/linux/pstore_ram.h RAMOOPS_FLAG_* for flag values).
+
+unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+
+anyOf:
+  - required: [record-size]
+  - required: [console-size]
+  - required: [ftrace-size]
+  - required: [pmsg-size]
+
+examples:
+  - |
+    reserved-memory {
+      #address-cells = <1>;
+      #size-cells = <1>;
+      ranges;
+
+      ramoops@bfdf0000 {
+        compatible = "ramoops";
+        reg = <0xbfdf0000 0x10000>; /* 64kB */
+        console-size = <0x8000>;    /* 32kB */
+        record-size = <0x400>;      /*  1kB */
+        ecc-size = <16>;
+      };
+    };
+
-- 
2.33.0

Re: [PATCH v2 4/4] dt-bindings: reserved-memory: ramoops: Convert txt bindings to yaml

[Rob Herring]

On Tue, Oct 12, 2021 at 3:39 PM David Heidelberg <david@ixit.cz> wrote:
>
> Convert ramoops driver to the YAML syntax.

I don't have the rest of the series except patch 1 and neither does
lore it seems. The dependency for this is in my tree.

> v2:
>  - inherit reserved-memory properties
>  - switch to unevaluatedProperties
>
> Signed-off-by: David Heidelberg <david@ixit.cz>
> ---
>  .../bindings/reserved-memory/ramoops.txt      |  66 ---------
>  .../bindings/reserved-memory/ramoops.yaml     | 129 ++++++++++++++++++
>  2 files changed, 129 insertions(+), 66 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/reserved-memory/ramoops.txt
>  create mode 100644 Documentation/devicetree/bindings/reserved-memory/ramoops.yaml
>
> diff --git a/Documentation/devicetree/bindings/reserved-memory/ramoops.txt b/Documentation/devicetree/bindings/reserved-memory/ramoops.txt
> deleted file mode 100644
> index b571ef6dab0f..000000000000
> --- a/Documentation/devicetree/bindings/reserved-memory/ramoops.txt
> +++ /dev/null
> @@ -1,66 +0,0 @@
> -Ramoops oops/panic logger
> -=========================
> -
> -ramoops provides persistent RAM storage for oops and panics, so they can be
> -recovered after a reboot. This is a child-node of "/reserved-memory", and
> -is named "ramoops" after the backend, rather than "pstore" which is the
> -subsystem.
> -
> -Parts of this storage may be set aside for other persistent log buffers, such
> -as kernel log messages, or for optional ECC error-correction data.  The total
> -size of these optional buffers must fit in the reserved region.
> -
> -Any remaining space will be used for a circular buffer of oops and panic
> -records.  These records have a configurable size, with a size of 0 indicating
> -that they should be disabled.
> -
> -At least one of "record-size", "console-size", "ftrace-size", or "pmsg-size"
> -must be set non-zero, but are otherwise optional as listed below.
> -
> -
> -Required properties:
> -
> -- compatible: must be "ramoops"
> -
> -- reg: region of memory that is preserved between reboots
> -
> -
> -Optional properties:
> -
> -- ecc-size: enables ECC support and specifies ECC buffer size in bytes
> -  (defaults to 0: no ECC)
> -
> -- record-size: maximum size in bytes of each kmsg dump.
> -  (defaults to 0: disabled)
> -
> -- console-size: size in bytes of log buffer reserved for kernel messages
> -  (defaults to 0: disabled)
> -
> -- ftrace-size: size in bytes of log buffer reserved for function tracing and
> -  profiling (defaults to 0: disabled)
> -
> -- pmsg-size: size in bytes of log buffer reserved for userspace messages
> -  (defaults to 0: disabled)
> -
> -- mem-type: if present, sets the type of mapping is to be used to map the
> -  reserved region. mem-type: 0 = write-combined (default), 1 = unbuffered,
> -  2 = cached.
> -
> -- unbuffered: deprecated, use mem_type instead. If present, and mem_type is
> -  not specified, it is equivalent to mem_type = 1 and uses unbuffered mappings
> -  to map the reserved region (defaults to buffered mappings mem_type = 0). If
> -  both are specified -- "mem_type" overrides "unbuffered".
> -
> -- max-reason: if present, sets maximum type of kmsg dump reasons to store
> -  (defaults to 2: log Oopses and Panics). This can be set to INT_MAX to
> -  store all kmsg dumps. See include/linux/kmsg_dump.h KMSG_DUMP_* for other
> -  kmsg dump reason values. Setting this to 0 (KMSG_DUMP_UNDEF), means the
> -  reason filtering will be controlled by the printk.always_kmsg_dump boot
> -  param: if unset, it will be KMSG_DUMP_OOPS, otherwise KMSG_DUMP_MAX.
> -
> -- no-dump-oops: deprecated, use max_reason instead. If present, and
> -  max_reason is not specified, it is equivalent to max_reason = 1
> -  (KMSG_DUMP_PANIC).
> -
> -- flags: if present, pass ramoops behavioral flags (defaults to 0,
> -  see include/linux/pstore_ram.h RAMOOPS_FLAG_* for flag values).
> diff --git a/Documentation/devicetree/bindings/reserved-memory/ramoops.yaml b/Documentation/devicetree/bindings/reserved-memory/ramoops.yaml
> new file mode 100644
> index 000000000000..a21a27e84a6d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/reserved-memory/ramoops.yaml
> @@ -0,0 +1,129 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/reserved-memory/ramoops.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Ramoops oops/panic logger
> +
> +description: |
> +  ramoops provides persistent RAM storage for oops and panics, so they can be
> +  recovered after a reboot. This is a child-node of "/reserved-memory", and
> +  is named "ramoops" after the backend, rather than "pstore" which is the
> +  subsystem.
> +
> +  Parts of this storage may be set aside for other persistent log buffers, such
> +  as kernel log messages, or for optional ECC error-correction data.  The total
> +  size of these optional buffers must fit in the reserved region.
> +
> +  Any remaining space will be used for a circular buffer of oops and panic
> +  records.  These records have a configurable size, with a size of 0 indicating
> +  that they should be disabled.
> +
> +  At least one of "record-size", "console-size", "ftrace-size", or "pmsg-size"
> +  must be set non-zero, but are otherwise optional as listed below.
> +
> +maintainers:
> +  - Kees Cook <keescook@chromium.org>
> +
> +allOf:
> +  - $ref: "reserved-memory.yaml"
> +
> +properties:
> +  compatible:
> +    const: ramoops
> +
> +  reg:
> +    description: region of memory that is preserved between reboots
> +
> +  ecc-size:

These all need a type reference.

> +    description: enables ECC support and specifies ECC buffer size in bytes
> +    default: 0 # no ECC
> +
> +  record-size:
> +    description: maximum size in bytes of each kmsg dump
> +    default: 0
> +
> +  console-size:
> +    description: size in bytes of log buffer reserved for kernel messages
> +    default: 0
> +
> +  ftrace-size:
> +    description: size in bytes of log buffer reserved for function tracing and profiling
> +    default: 0
> +
> +  pmsg-size:
> +    description: size in bytes of log buffer reserved for userspace messages
> +    default: 0
> +
> +  mem-type:
> +    description: if present, sets the type of mapping is to be used to map the reserved region.
> +    default: 0
> +    enum:

s/enum/oneOf/

Or drop 'const' below and make the descriptions comments.

> +      - const: 0
> +        description: write-combined
> +      - const: 1
> +        description: unbuffered
> +      - const: 2
> +        description: cached
> +
> +  unbuffered:
> +    deprecated: true
> +    description: |
> +      use mem_type instead. If present, and mem_type is not specified,
> +      it is equivalent to mem_type = 1 and uses unbuffered mappings to map
> +      the reserved region (defaults to buffered mappings mem_type = 0).
> +      If both are specified -- "mem_type" overrides "unbuffered".
> +
> +  max-reason:
> +    default: 2 # log oopses and panics
> +    description: |
> +      If present, sets maximum type of kmsg dump reasons to store.
> +      This can be set to INT_MAX to store all kmsg dumps.

maximum: 0x7fffffff

> +      See include/linux/kmsg_dump.h KMSG_DUMP_* for other
> +      kmsg dump reason values. Setting this to 0 (KMSG_DUMP_UNDEF), means the
> +      reason filtering will be controlled by the printk.always_kmsg_dump boot
> +
> +  param:
> +    description: if unset, it will be KMSG_DUMP_OOPS, otherwise KMSG_DUMP_MAX.

Define names are nice, but not helpful for defining constraints.

> +
> +  no-dump-oops:
> +    deprecated: true
> +    description: |
> +      Use max_reason instead. If present, and max_reason is not specified,
> +      it is equivalent to max_reason = 1 (KMSG_DUMP_PANIC).
> +
> +  flags:
> +    default: 0
> +    description: |
> +      If present, pass ramoops behavioral flags
> +      (see include/linux/pstore_ram.h RAMOOPS_FLAG_* for flag values).
> +
> +unevaluatedProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +
> +anyOf:
> +  - required: [record-size]
> +  - required: [console-size]
> +  - required: [ftrace-size]
> +  - required: [pmsg-size]
> +
> +examples:
> +  - |

Add '/ { ' so the example is created at the root node.

> +    reserved-memory {
> +      #address-cells = <1>;
> +      #size-cells = <1>;
> +      ranges;
> +
> +      ramoops@bfdf0000 {
> +        compatible = "ramoops";
> +        reg = <0xbfdf0000 0x10000>; /* 64kB */
> +        console-size = <0x8000>;    /* 32kB */
> +        record-size = <0x400>;      /*  1kB */
> +        ecc-size = <16>;
> +      };
> +    };
> +
> --
> 2.33.0
>