summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/barebox/barebox,environment.rst
blob: 12b103be10fdb01a88c3db55db816de8646c821d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
barebox environment
===================

This driver provides an environment for barebox from the devicetree.

Required properties:

* ``compatible``: should be ``barebox,environment``
* ``device-path``: path to the device environment is on

Optional properties:
* ``file-path``: path to a file in the device named by device-path

The device-path is a multistring property. The first string should contain
a nodepath to the node containing the physical device of the environment or
a nodepath to a partition described by the OF partition binding.
The subsequent strings are of the form <type>:<options> to further describe
the path to the environment. Supported values for <type>:

``partname``:<partname>
  This describes a partition on a device. <partname> can
  be the label for MTD partitions, the number for DOS
  partitions (beginning with 0) or the name for GPT partitions.

The file-path is the name of a file located in a FAT filesystem on the
device named in device-path.  This filesystem will be mounted and the
environment loaded from the file's location in the directory tree.

Example::

  environment@0 {
  	compatible = "barebox,environment";
  	device-path = &flash, "partname:barebox-environment";
  };

  environment@1 {
  	compatible = "barebox,environment";
  	device-path = &mmc, "partname:1";
  	file-path = "barebox.env";
  };