xref: /freebsd/sys/contrib/device-tree/Bindings/rng/timeriomem_rng.yaml (revision fe75646a0234a261c0013bf1840fdac4acaf0cec)
1# SPDX-License-Identifier: GPL-2.0-only
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/rng/timeriomem_rng.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: TimerIO Random Number Generator
8
9maintainers:
10  - Krzysztof Kozlowski <krzk@kernel.org>
11
12properties:
13  compatible:
14    const: timeriomem_rng
15
16  period:
17    $ref: /schemas/types.yaml#/definitions/uint32
18    description: wait time in microseconds to use between samples
19
20  quality:
21    $ref: /schemas/types.yaml#/definitions/uint32
22    default: 0
23    description:
24      Estimated number of bits of true entropy per 1024 bits read from the rng.
25      Defaults to zero which causes the kernel's default quality to be used
26      instead.  Note that the default quality is usually zero which disables
27      using this rng to automatically fill the kernel's entropy pool.
28
29  reg:
30    maxItems: 1
31    description:
32      Base address to sample from. Currently 'reg' must be at least four bytes
33      wide and 32-bit aligned.
34
35required:
36  - compatible
37  - period
38  - reg
39
40additionalProperties: false
41
42examples:
43  - |
44    rng@44 {
45        compatible = "timeriomem_rng";
46        reg = <0x44 0x04>;
47        period = <1000000>;
48    };
49