Merge tag 'armsoc-dt' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / hwmon / vexpress.rst
1 Kernel driver vexpress
2 ======================
3
4 Supported systems:
5
6   * ARM Ltd. Versatile Express platform
7
8     Prefix: 'vexpress'
9
10     Datasheets:
11
12       * "Hardware Description" sections of the Technical Reference Manuals
13         for the Versatile Express boards:
14
15         - http://infocenter.arm.com/help/topic/com.arm.doc.subset.boards.express/index.html
16
17       * Section "4.4.14. System Configuration registers" of the V2M-P1 TRM:
18
19         - http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0447-/index.html
20
21 Author: Pawel Moll
22
23 Description
24 -----------
25
26 Versatile Express platform (http://www.arm.com/versatileexpress/) is a
27 reference & prototyping system for ARM Ltd. processors. It can be set up
28 from a wide range of boards, each of them containing (apart of the main
29 chip/FPGA) a number of microcontrollers responsible for platform
30 configuration and control. Theses microcontrollers can also monitor the
31 board and its environment by a number of internal and external sensors,
32 providing information about power lines voltages and currents, board
33 temperature and power usage. Some of them also calculate consumed energy
34 and provide a cumulative use counter.
35
36 The configuration devices are _not_ memory mapped and must be accessed
37 via a custom interface, abstracted by the "vexpress_config" API.
38
39 As these devices are non-discoverable, they must be described in a Device
40 Tree passed to the kernel. Details of the DT binding for them can be found
41 in Documentation/devicetree/bindings/hwmon/vexpress.txt.