cachepc-linux

Fork of AMDESE/linux with modifications for CachePC side-channel attack
git clone https://git.sinitax.com/sinitax/cachepc-linux
Log | Files | Refs | README | LICENSE | sfeed.txt

adm1275.rst (4470B)


      1Kernel driver adm1275
      2=====================
      3
      4Supported chips:
      5
      6  * Analog Devices ADM1075
      7
      8    Prefix: 'adm1075'
      9
     10    Addresses scanned: -
     11
     12    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1075.pdf
     13
     14  * Analog Devices ADM1272
     15
     16    Prefix: 'adm1272'
     17
     18    Addresses scanned: -
     19
     20    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1272.pdf
     21
     22  * Analog Devices ADM1275
     23
     24    Prefix: 'adm1275'
     25
     26    Addresses scanned: -
     27
     28    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1275.pdf
     29
     30  * Analog Devices ADM1276
     31
     32    Prefix: 'adm1276'
     33
     34    Addresses scanned: -
     35
     36    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1276.pdf
     37
     38  * Analog Devices ADM1278
     39
     40    Prefix: 'adm1278'
     41
     42    Addresses scanned: -
     43
     44    Datasheet: www.analog.com/static/imported-files/data_sheets/ADM1278.pdf
     45
     46  * Analog Devices ADM1293/ADM1294
     47
     48    Prefix: 'adm1293', 'adm1294'
     49
     50    Addresses scanned: -
     51
     52    Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/ADM1293_1294.pdf
     53
     54Author: Guenter Roeck <linux@roeck-us.net>
     55
     56
     57Description
     58-----------
     59
     60This driver supports hardware monitoring for Analog Devices ADM1075, ADM1272,
     61ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 Hot-Swap Controller and
     62Digital Power Monitors.
     63
     64ADM1075, ADM1272, ADM1275, ADM1276, ADM1278, ADM1293, and ADM1294 are hot-swap
     65controllers that allow a circuit board to be removed from or inserted into
     66a live backplane. They also feature current and voltage readback via an
     67integrated 12 bit analog-to-digital converter (ADC), accessed using a
     68PMBus interface.
     69
     70The driver is a client driver to the core PMBus driver. Please see
     71Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
     72
     73
     74Usage Notes
     75-----------
     76
     77This driver does not auto-detect devices. You will have to instantiate the
     78devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
     79details.
     80
     81The ADM1075, unlike many other PMBus devices, does not support internal voltage
     82or current scaling. Reported voltages, currents, and power are raw measurements,
     83and will typically have to be scaled.
     84
     85The shunt value in micro-ohms can be set via device tree at compile-time. Please
     86refer to the Documentation/devicetree/bindings/hwmon/adi,adm1275.yaml for bindings
     87if the device tree is used.
     88
     89Platform data support
     90---------------------
     91
     92The driver supports standard PMBus driver platform data. Please see
     93Documentation/hwmon/pmbus.rst for details.
     94
     95
     96Sysfs entries
     97-------------
     98
     99The following attributes are supported. Limits are read-write, history reset
    100attributes are write-only, all other attributes are read-only.
    101
    102======================= =======================================================
    103inX_label		"vin1" or "vout1" depending on chip variant and
    104			configuration. On ADM1075, ADM1293, and ADM1294,
    105			vout1 reports the voltage on the VAUX pin.
    106inX_input		Measured voltage.
    107inX_min			Minimum Voltage.
    108inX_max			Maximum voltage.
    109inX_min_alarm		Voltage low alarm.
    110inX_max_alarm		Voltage high alarm.
    111inX_highest		Historical maximum voltage.
    112inX_reset_history	Write any value to reset history.
    113
    114curr1_label		"iout1"
    115curr1_input		Measured current.
    116curr1_max		Maximum current.
    117curr1_max_alarm		Current high alarm.
    118curr1_lcrit		Critical minimum current. Depending on the chip
    119			configuration, either curr1_lcrit or curr1_crit is
    120			supported, but not both.
    121curr1_lcrit_alarm	Critical current low alarm.
    122curr1_crit		Critical maximum current. Depending on the chip
    123			configuration, either curr1_lcrit or curr1_crit is
    124			supported, but not both.
    125curr1_crit_alarm	Critical current high alarm.
    126curr1_highest		Historical maximum current.
    127curr1_reset_history	Write any value to reset history.
    128
    129power1_label		"pin1"
    130power1_input		Input power.
    131power1_input_lowest	Lowest observed input power. ADM1293 and ADM1294 only.
    132power1_input_highest	Highest observed input power.
    133power1_reset_history	Write any value to reset history.
    134
    135			Power attributes are supported on ADM1075, ADM1272,
    136			ADM1276, ADM1293, and ADM1294.
    137
    138temp1_input		Chip temperature.
    139temp1_max		Maximum chip temperature.
    140temp1_max_alarm		Temperature alarm.
    141temp1_crit		Critical chip temperature.
    142temp1_crit_alarm	Critical temperature high alarm.
    143temp1_highest		Highest observed temperature.
    144temp1_reset_history	Write any value to reset history.
    145
    146			Temperature attributes are supported on ADM1272 and
    147			ADM1278.
    148======================= =======================================================