xref: /OK3568_Linux_fs/kernel/Documentation/driver-api/xilinx/eemi.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun====================================
2*4882a593SmuzhiyunXilinx Zynq MPSoC EEMI Documentation
3*4882a593Smuzhiyun====================================
4*4882a593Smuzhiyun
5*4882a593SmuzhiyunXilinx Zynq MPSoC Firmware Interface
6*4882a593Smuzhiyun-------------------------------------
7*4882a593SmuzhiyunThe zynqmp-firmware node describes the interface to platform firmware.
8*4882a593SmuzhiyunZynqMP has an interface to communicate with secure firmware. Firmware
9*4882a593Smuzhiyundriver provides an interface to firmware APIs. Interface APIs can be
10*4882a593Smuzhiyunused by any driver to communicate with PMC(Platform Management Controller).
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunEmbedded Energy Management Interface (EEMI)
13*4882a593Smuzhiyun----------------------------------------------
14*4882a593SmuzhiyunThe embedded energy management interface is used to allow software
15*4882a593Smuzhiyuncomponents running across different processing clusters on a chip or
16*4882a593Smuzhiyundevice to communicate with a power management controller (PMC) on a
17*4882a593Smuzhiyundevice to issue or respond to power management requests.
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunAny driver who wants to communicate with PMC using EEMI APIs use the
20*4882a593Smuzhiyunfunctions provided for each function.
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunIOCTL
23*4882a593Smuzhiyun------
24*4882a593SmuzhiyunIOCTL API is for device control and configuration. It is not a system
25*4882a593SmuzhiyunIOCTL but it is an EEMI API. This API can be used by master to control
26*4882a593Smuzhiyunany device specific configuration. IOCTL definitions can be platform
27*4882a593Smuzhiyunspecific. This API also manage shared device configuration.
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunThe following IOCTL IDs are valid for device control:
30*4882a593Smuzhiyun- IOCTL_SET_PLL_FRAC_MODE	8
31*4882a593Smuzhiyun- IOCTL_GET_PLL_FRAC_MODE	9
32*4882a593Smuzhiyun- IOCTL_SET_PLL_FRAC_DATA	10
33*4882a593Smuzhiyun- IOCTL_GET_PLL_FRAC_DATA	11
34*4882a593Smuzhiyun
35*4882a593SmuzhiyunRefer EEMI API guide [0] for IOCTL specific parameters and other EEMI APIs.
36*4882a593Smuzhiyun
37*4882a593SmuzhiyunReferences
38*4882a593Smuzhiyun----------
39*4882a593Smuzhiyun[0] Embedded Energy Management Interface (EEMI) API guide:
40*4882a593Smuzhiyun    https://www.xilinx.com/support/documentation/user_guides/ug1200-eemi-api.pdf
41