[mirror_ubuntu-artful-kernel.git] / Documentation / hwmon / vexpress

Kernel driver vexpress
======================

Supported systems:
  * ARM Ltd. Versatile Express platform
    Prefix: 'vexpress'
    Datasheets:
      * "Hardware Description" sections of the Technical Reference Manuals
        for the Versatile Express boards:
        http://infocenter.arm.com/help/topic/com.arm.doc.subset.boards.express/index.html
      * Section "4.4.14. System Configuration registers" of the V2M-P1 TRM:
        http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0447-/index.html

Author: Pawel Moll

Description
-----------

Versatile Express platform (http://www.arm.com/versatileexpress/) is a
reference & prototyping system for ARM Ltd. processors. It can be set up
from a wide range of boards, each of them containing (apart of the main
chip/FPGA) a number of microcontrollers responsible for platform
configuration and control. Theses microcontrollers can also monitor the
board and its environment by a number of internal and external sensors,
providing information about power lines voltages and currents, board
temperature and power usage. Some of them also calculate consumed energy
and provide a cumulative use counter.

The configuration devices are _not_ memory mapped and must be accessed
via a custom interface, abstracted by the "vexpress_config" API.

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