Documentation/devicetree/bindings/iio/adc/xilinx-ams.txt

   1 Xilinx AMS device driver
   2
   3 The AMS includes an ADC as well as on-chip sensors that can be used to
   4 sample external voltages and monitor on-die operating conditions, such as
   5 temperature and supply voltage levels. The AMS has two SYSMON blocks.
   6 PL-SYSMON block is capable of monitoring off chip voltage and temperature.
   7 PL-SYSMON block has DRP, JTAG and I2C interface to enable monitoring from
   8 external master. Out of this interface currenlty only DRP is supported.
   9 Other block PS-SYSMON is memory mapped to PS. Both of block has built-in
  10 alarm generation logic that is used to interrupt the processor based on
  11 condition set.
  12
  13 All designs should have AMS register, but PS and PL are optional depending on
  14 the design. The driver can work with only PS, only PL and both PS and PL
  15 configurations. Please specify registers according to your design. DTS file
  16 should always have AMS module property. Providing PS & PL module is optional.
  17
  18 Required properties:
  19         - compatible: Should be "xlnx,zynqmp-ams"
  20         - reg:  Should specify AMS register space
  21         - interrupts: Interrupt number for the AMS control interface
  22         - interrupt-names: Interrupt name, must be "ams-irq"
  23         - clocks: Should contain a clock specifier for the device
  24         - ranges: keep the property empty to map child address space
  25                   (for PS and/or PL) nodes 1:1 onto the parent address
  26                   space
  27
  28 AMS device tree subnode:
  29         - compatible: Should be "xlnx,zynqmp-ams-ps" or "xlnx,zynqmp-ams-pl"
  30         - reg:  Register space for PS or PL
  31
  32 Optional properties:
  33
  34 Following optional property only valid for PL.
  35         - xlnx,ext-channels: List of external channels that are connected to the
  36                              AMS PL module.
  37
  38           The child nodes of this node represent the external channels which are
  39           connected to the AMS Module. If the property is not present
  40           no external channels will be assumed to be connected.
  41
  42           Each child node represents one channel and has the following
  43           properties:
  44                 Required properties:
  45                         * reg: Pair of pins the channel is connected to.
  46                                 0: VP/VN
  47                                 1: VUSER0
  48                                 2: VUSER1
  49                                 3: VUSER3
  50                                 4: VUSER4
  51                                 5: VAUXP[0]/VAUXN[0]
  52                                 6: VAUXP[1]/VAUXN[1]
  53                                 ...
  54                                 20: VAUXP[15]/VAUXN[15]
  55                           Note each channel number should only be used at most
  56                           once.
  57                 Optional properties:
  58                         * xlnx,bipolar: If set the channel is used in bipolar
  59                           mode.
  60
  61
  62 Example:
  63         xilinx_ams: ams@ffa50000 {
  64                 compatible = "xlnx,zynqmp-ams";
  65                 interrupt-parent = <&gic>;
  66                 interrupts = <0 56 4>;
  67                 interrupt-names = "ams-irq";
  68                 clocks = <&clkc 70>;
  69                 reg = <0x0 0xffa50000 0x0 0x800>;
  70                 reg-names = "ams-base";
  71                 #address-cells = <2>;
  72                 #size-cells = <2>;
  73                 ranges;
  74
  75                 ams_ps: ams_ps@ffa50800 {
  76                         compatible = "xlnx,zynqmp-ams-ps";
  77                         reg = <0x0 0xffa50800 0x0 0x400>;
  78                 };
  79
  80                 ams_pl: ams_pl@ffa50c00 {
  81                         compatible = "xlnx,zynqmp-ams-pl";
  82                         reg = <0x0 0xffa50c00 0x0 0x400>;
  83                         xlnx,ext-channels {
  84                                 #address-cells = <1>;
  85                                 #size-cells = <0>;
  86                                 channel@0 {
  87                                         reg = <0>;
  88                                         xlnx,bipolar;
  89                                 };
  90                                 channel@1 {
  91                                         reg = <1>;
  92                                 };
  93                                 channel@8 {
  94                                         reg = <8>;
  95                                         xlnx,bipolar;
  96                                 };
  97                         };
  98                 };
  99         };
 100
 101 AMS Channels Details:
 102
 103 Sysmon Block    |Channel|                       Details                                 |Measurement
 104                  Number                                                                  Type
 105 ---------------------------------------------------------------------------------------------------------
 106 AMS CTRL        |0      |System PLLs voltage measurement, VCC_PSPLL.                    |Voltage
 107                 |1      |Battery voltage measurement, VCC_PSBATT.                       |Voltage
 108                 |2      |PL Internal voltage measurement, VCCINT.                       |Voltage
 109                 |3      |Block RAM voltage measurement, VCCBRAM.                        |Voltage
 110                 |4      |PL Aux voltage measurement, VCCAUX.                            |Voltage
 111                 |5      |Voltage measurement for six DDR I/O PLLs, VCC_PSDDR_PLL.       |Voltage
 112                 |6      |VCC_PSINTFP_DDR voltage measurement.                           |Voltage
 113 ---------------------------------------------------------------------------------------------------------
 114 PS Sysmon       |7      |LPD temperature measurement.                                   |Temperature
 115                 |8      |FPD Temperature Measurment (REMOTE).                           |Temperature
 116                 |9      |VCC PS LPD voltage measurement (supply1).                      |Voltage
 117                 |10     |VCC PS FPD voltage measurement (supply2).                      |Voltage
 118                 |11     |PS Aux voltage reference (supply3).                            |Voltage
 119                 |12     |DDR I/O VCC voltage measurement.                               |Voltage
 120                 |13     |PS IO Bank 503 voltage measurement (supply5).                  |Voltage
 121                 |14     |PS IO Bank 500 voltage measurement (supply6).                  |Voltage
 122                 |15     |VCCO_PSIO1 voltage measurement.                                |Voltage
 123                 |16     |VCCO_PSIO2 voltage measurement.                                |Voltage
 124                 |17     |VCC_PS_GTR voltage measurement (VPS_MGTRAVCC).                 |Voltage
 125                 |18     |VTT_PS_GTR voltage measurement (VPS_MGTRAVTT).                 |Voltage
 126                 |19     |VCC_PSADC voltage measurement.                                 |Voltage
 127 ---------------------------------------------------------------------------------------------------------
 128 PL Sysmon       |20     |PL Temperature measurement.                                    |Temperature
 129                 |21     |PL Internal Voltage Voltage measurement, VCCINT.               |Voltage
 130                 |22     |PL Auxiliary Voltage measurement, VCCAUX.                      |Voltage
 131                 |23     |ADC Reference P+ Voltage measurement.                          |Voltage
 132                 |24     |ADC Reference N- Voltage measurement.                          |Voltage
 133                 |25     |PL Block RAM Voltage measurement, VCCBRAM.                     |Voltage
 134                 |26     |LPD Internal Voltage measurement, VCC_PSINTLP (supply4).       |Voltage
 135                 |27     |FPD Internal Voltage measurement, VCC_PSINTFP (supply5).       |Voltage
 136                 |28     |PS Auxiliary Voltage measurement (supply6).                    |Voltage
 137                 |29     |PL VCCADC Voltage measurement (vccams).                        |Voltage
 138                 |30     |Differencial analog input signal Voltage measurment.           |Voltage
 139                 |31     |VUser0 Voltage measurement (supply7).                          |Voltage
 140                 |32     |VUser1 Voltage measurement (supply8).                          |Voltage
 141                 |33     |VUser2 Voltage measurement (supply9).                          |Voltage
 142                 |34     |VUser3 Voltage measurement (supply10).                         |Voltage
 143                 |35     |Auxiliary ch 0 Voltage measurement (VAux0).                    |Voltage
 144                 |36     |Auxiliary ch 1 Voltage measurement (VAux1).                    |Voltage
 145                 |37     |Auxiliary ch 2 Voltage measurement (VAux2).                    |Voltage
 146                 |38     |Auxiliary ch 3 Voltage measurement (VAux3).                    |Voltage
 147                 |39     |Auxiliary ch 4 Voltage measurement (VAux4).                    |Voltage
 148                 |40     |Auxiliary ch 5 Voltage measurement (VAux5).                    |Voltage
 149                 |41     |Auxiliary ch 6 Voltage measurement (VAux6).                    |Voltage
 150                 |42     |Auxiliary ch 7 Voltage measurement (VAux7).                    |Voltage
 151                 |43     |Auxiliary ch 8 Voltage measurement (VAux8).                    |Voltage
 152                 |44     |Auxiliary ch 9 Voltage measurement (VAux9).                    |Voltage
 153                 |45     |Auxiliary ch 10 Voltage measurement (VAux10).                  |Voltage
 154                 |46     |Auxiliary ch 11 Voltage measurement (VAux11).                  |Voltage
 155                 |47     |Auxiliary ch 12 Voltage measurement (VAux12).                  |Voltage
 156                 |48     |Auxiliary ch 13 Voltage measurement (VAux13).                  |Voltage
 157                 |49     |Auxiliary ch 14 Voltage measurement (VAux14).                  |Voltage
 158                 |50     |Auxiliary ch 15 Voltage measurement (VAux15).                  |Voltage
 159 ---------------------------------------------------------------------------------------------------------