Files
linux/Documentation/devicetree/bindings/mtd/partitions/brcm,trx.yaml
Rob Herring (Arm) a1fa0f8ca1 dt-bindings: mtd: partitions: Convert brcm,trx to DT schema
Convert the brcm,trx partition binding to DT schema format.

As the "linksys,ns-firmware" compatible also uses "brcm,trx" as a
fallback, move it to the converted binding.

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@oss.qualcomm.com>
Signed-off-by: Rob Herring (Arm) <robh@kernel.org>
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
2026-01-22 15:08:08 +01:00

66 lines
2.0 KiB
YAML

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/mtd/partitions/brcm,trx.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: Broadcom TRX Container Partition
maintainers:
- Hauke Mehrtens <hauke@hauke-m.de>
- Rafał Miłecki <rafal@milecki.pl>
description: >
TRX is Broadcom's official firmware format for the BCM947xx boards. It's used by
most of the vendors building devices based on Broadcom's BCM47xx SoCs and is
supported by the CFE bootloader.
Design of the TRX format is very minimalistic. Its header contains
identification fields, CRC32 checksum and the locations of embedded partitions.
Its purpose is to store a few partitions in a format that can be distributed as
a standalone file and written in a flash memory.
Container can hold up to 4 partitions. The first partition has to contain a
device executable binary (e.g. a kernel) as it's what the CFE bootloader starts
executing. Other partitions can be used for operating system purposes. This is
useful for systems that keep kernel and rootfs separated.
TRX doesn't enforce any strict partition boundaries or size limits. All
partitions have to be less than the 4GiB max size limit.
There are two existing/known TRX variants:
1) v1 which contains 3 partitions
2) v2 which contains 4 partitions
There aren't separated compatible bindings for them as version can be trivially
detected by a software parsing TRX header.
properties:
compatible:
oneOf:
- items:
- const: linksys,ns-firmware
- const: brcm,trx
- const: brcm,trx
brcm,trx-magic:
description: TRX magic, if it is different from the default magic.
$ref: /schemas/types.yaml#/definitions/uint32
default: 0x30524448
required:
- compatible
allOf:
- $ref: partition.yaml#
unevaluatedProperties: false
examples:
- |
flash {
partitions {
compatible = "brcm,trx";
};
};