1 Generic hwlock bindings 1 Generic hwlock bindings
2 ======================= 2 =======================
3 3
4 Generic bindings that are common to all the hw 4 Generic bindings that are common to all the hwlock platform specific driver
5 implementations. 5 implementations.
6 6
7 Please also look through the individual platfo 7 Please also look through the individual platform specific hwlock binding
8 documentations for identifying any additional 8 documentations for identifying any additional properties specific to that
9 platform. 9 platform.
10 10
11 hwlock providers: 11 hwlock providers:
12 ================= 12 =================
13 13
14 Required properties: 14 Required properties:
15 - #hwlock-cells: Specifies the number o 15 - #hwlock-cells: Specifies the number of cells needed to represent a
16 specific lock. 16 specific lock.
17 17
18 hwlock users: 18 hwlock users:
19 ============= 19 =============
20 20
21 Consumers that require specific hwlock(s) shou 21 Consumers that require specific hwlock(s) should specify them using the
22 property "hwlocks", and an optional "hwlock-na 22 property "hwlocks", and an optional "hwlock-names" property.
23 23
24 Required properties: 24 Required properties:
25 - hwlocks: List of phandle to a h 25 - hwlocks: List of phandle to a hwlock provider node and an
26 associated hwlock args 26 associated hwlock args specifier as indicated by
27 #hwlock-cells. The lis 27 #hwlock-cells. The list can have just a single hwlock
28 or multiple hwlocks, w 28 or multiple hwlocks, with each hwlock represented by
29 a phandle and a corres 29 a phandle and a corresponding args specifier.
30 30
31 Optional properties: 31 Optional properties:
32 - hwlock-names: List of hwlock name st 32 - hwlock-names: List of hwlock name strings defined in the same order
33 as the hwlocks, with o 33 as the hwlocks, with one name per hwlock. Consumers can
34 use the hwlock-names t 34 use the hwlock-names to match and get a specific hwlock.
35 35
36 36
37 1. Example of a node using a single specific h 37 1. Example of a node using a single specific hwlock:
38 38
39 The following example has a node requesting a 39 The following example has a node requesting a hwlock in the bank defined by
40 the node hwlock1. hwlock1 is a hwlock provider 40 the node hwlock1. hwlock1 is a hwlock provider with an argument specifier
41 of length 1. 41 of length 1.
42 42
43 node { 43 node {
44 ... 44 ...
45 hwlocks = <&hwlock1 2>; 45 hwlocks = <&hwlock1 2>;
46 ... 46 ...
47 }; 47 };
48 48
49 2. Example of a node using multiple specific h 49 2. Example of a node using multiple specific hwlocks:
50 50
51 The following example has a node requesting tw 51 The following example has a node requesting two hwlocks, a hwlock within
52 the hwlock device node 'hwlock1' with #hwlock- 52 the hwlock device node 'hwlock1' with #hwlock-cells value of 1, and another
53 hwlock within the hwlock device node 'hwlock2' 53 hwlock within the hwlock device node 'hwlock2' with #hwlock-cells value of 2.
54 54
55 node { 55 node {
56 ... 56 ...
57 hwlocks = <&hwlock1 2>, <&hwlo 57 hwlocks = <&hwlock1 2>, <&hwlock2 0 3>;
58 ... 58 ...
59 }; 59 };
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.