dts/bindings/memory-controllers/nxp,flexram.yaml

# Copyright 2023 NXP
# SPDX-License-Identifier: Apache-2.0

title: NXP FlexRAM on-chip RAM controller

description: |
  If the flexram,bank-spec property is specified, then the flexram will be
  dynamically reconfigured to the configuration specified at runtime. An
  example to configure the flexram dynamically using the
  flexram,bank-spec property for rt1060 is as follows:

  &itcm {
          reg = < 0x0 DT_SIZE_K(64) >;
  };
  &dtcm {
          reg = < 0x20000000 DT_SIZE_K(384) >;
  };
  &ocram {
          reg = < 0x20280000 DT_SIZE_K(64) >;
  };
  &flexram {
          flexram,bank-spec = <FLEXRAM_OCRAM>,
                              <FLEXRAM_OCRAM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_ITCM>,
                              <FLEXRAM_ITCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>,
                              <FLEXRAM_DTCM>;
  };

  This will configure the flexram for 384K of DTCM, 64K of ITCM,
  and 64K of OCRAM.


include: base.yaml

compatible: "nxp,flexram"

properties:
  reg:
    required: true

  interrupts:
    required: true

  flexram,has-magic-addr:
    type: boolean
    description: |
      Whether or not the flexram on the SOC has the
      magic address feature, which allows for an interrupt
      on arbitrary address access in any on chip RAM region.

  flexram,num-ram-banks:
    type: int
    required: true
    description: |
      Number of RAM banks in the SOC ram array

  flexram,bank-size:
    type: int
    required: true
    description: |
      Size of each RAM bank in KB

  flexram,bank-spec:
    type: array
    description: |
      Custom mapping of runtime RAM bank partitions. If this
      property is present, then it will be used. If this
      property is not present, then the fusemap configuration
      will be used.

  flexram,tcm-read-wait-mode:
    type: boolean
    description: |
      TCM RAM read will finish in 2 cycles instead of 1.

  flexram,tcm-write-wait-mode:
    type: boolean
    description: |
      TCM RAM write will finish in 2 cycles instead of 1.