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

max15301.rst (2410B)


      1.. SPDX-License-Identifier: GPL-2.0
      2
      3Kernel driver max15301
      4======================
      5
      6Supported chips:
      7
      8  * Maxim MAX15301
      9
     10    Prefix: 'max15301', 'bmr461'
     11
     12    Addresses scanned: -
     13
     14    Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX15301.pdf
     15
     16Author: Erik Rosen <erik.rosen@metormote.com>
     17
     18
     19Description
     20-----------
     21
     22This driver supports hardware monitoring for Maxim MAX15301 controller chip and
     23compatible modules.
     24
     25The driver is a client driver to the core PMBus driver. Please see
     26Documentation/hwmon/pmbus.rst and Documentation.hwmon/pmbus-core for details
     27on PMBus client drivers.
     28
     29
     30Usage Notes
     31-----------
     32
     33This driver does not auto-detect devices. You will have to instantiate the
     34devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
     35details.
     36
     37
     38Platform data support
     39---------------------
     40
     41The driver supports standard PMBus driver platform data.
     42
     43
     44Module parameters
     45-----------------
     46
     47delay
     48-----
     49
     50The controller requires a minimum interval between I2C bus accesses.
     51The default interval is set to 100 us. For manual override, the driver
     52provides a writeable module parameter, 'delay', which can be used to
     53set the interval to a value between 0 and 65,535 microseconds.
     54
     55
     56Sysfs entries
     57-------------
     58
     59The following attributes are supported. Limits are read-write; all other
     60attributes are read-only.
     61
     62======================= ========================================================
     63in1_label		"vin"
     64in1_input		Measured input voltage.
     65in1_lcrit		Critical minimum input voltage.
     66in1_crit		Critical maximum input voltage.
     67in1_lcrit_alarm		Input voltage critical low alarm.
     68in1_crit_alarm		Input voltage critical high alarm.
     69
     70in2_label		"vout1"
     71in2_input		Measured output voltage.
     72in2_lcrit		Critical minimum output Voltage.
     73in2_crit		Critical maximum output voltage.
     74in2_lcrit_alarm		Critical output voltage critical low alarm.
     75in2_crit_alarm		Critical output voltage critical high alarm.
     76
     77curr1_label		"iout1"
     78curr1_input		Measured output current.
     79curr1_crit		Critical maximum output current.
     80curr1_crit_alarm	Output current critical high alarm.
     81
     82temp1_input		Measured maximum temperature of all phases.
     83temp1_max		Maximum temperature limit.
     84temp1_max_alarm		High temperature alarm.
     85temp1_crit		Critical maximum temperature limit.
     86temp1_crit_alarm	Critical maximum temperature alarm.
     87======================= ========================================================