summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/qbt1000/qbt1000.txt
blob: 4a18b79e9ba1d35a502ed12a99504df182344cb3 (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
Qualcomm Technologies, Inc. QBT1000 Specific Bindings

QBT is a fingerprint sensor ASIC capable of performing fingerprint image scans
and detecting finger presence on the sensor using programmable firmware.

=======================
Required Node Structure
=======================

- compatible
  Usage:      required
  Value type: <string>
  Definition: "qcom,qbt1000".

- clock-names
  Usage:      required
  Value type: <stringlist>
  Definition: List of clock names that need to be voted on/off.

- clocks
  Usage:      required
  Value type: <prop_encoded-array>
  Definition: Property pair that represents the clock controller and the clock
		id. This in combination with the clock-name is used to obtain
		the handle for the clock that needs to be voted on/off.

- clock-frequency
  Usage:      required
  Value type: <u32>
  Definition: Frequency of clock in Hz.

- qcom,ipc-gpio
  Usage:      required
  Value type: <phandle>
  Definition: phandle for GPIO to be used for IPC.

- qcom,finger-detect-gpio
  Usage:      required
  Value type: <phandle>
  Definition: phandle for GPIO to be used for finger detect.

=======
Example
=======

qcom,qbt1000 {
	compatible = "qcom,qbt1000";
	clock-names = "core", "iface";
	clocks = <&clock_gcc clk_gcc_blsp2_qup6_spi_apps_clk>,
		<&clock_gcc clk_gcc_blsp2_ahb_clk>;
	clock-frequency = <15000000>;
	qcom,ipc-gpio = <&tlmm 121 0>;
	qcom,finger-detect-gpio = <&pm8998_gpios 2 0>;
};