Documentation/driver-api/xilinx/eemi.rst

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