target/linux/bcm27xx/patches-5.15/950-0892-docs-hwmon-add-emc2305.rst-to-docs.patch

   1 From 653ef165247824be27e900ab28d1f8aa74c09604 Mon Sep 17 00:00:00 2001
   2 From: Michael Shych <michaelsh@nvidia.com>
   3 Date: Sat, 30 Apr 2022 14:49:05 +0300
   4 Subject: [PATCH] docs: hwmon: add emc2305.rst to docs
   5
   6 Submitted to linux-hwmon mailing list at
   7 https://patchwork.kernel.org/project/linux-hwmon/patch/20220430114905.53448-4-michaelsh@nvidia.com/
   8
   9 Add description of emc2305 driver.
  10
  11 Signed-off-by: Michael Shych <michaelsh@nvidia.com>
  12 Reviewed-by: Vadim Pasternak <vadimp@nvidia.com>
  13 ---
  14  Documentation/hwmon/emc2305.rst | 40 +++++++++++++++++++++++++++++++++
  15  1 file changed, 40 insertions(+)
  16  create mode 100644 Documentation/hwmon/emc2305.rst
  17
  18 --- /dev/null
  19 +++ b/Documentation/hwmon/emc2305.rst
  20 @@ -0,0 +1,40 @@
  21 +.. SPDX-License-Identifier: GPL-2.0
  22 +
  23 +Kernel driver emc2305
  24 +=====================
  25 +
  26 +Supported chips:
  27 +   Microchip EMC2305, EMC2303, EMC2302, EMC2301
  28 +
  29 +   Addresses scanned: I2C 0x27, 0x2c, 0x2d, 0x2e, 0x2f, 0x4c, 0x4d
  30 +   Prefixes: 'emc2305'
  31 +
  32 +   Datasheet: Publicly available at the Microchip website :
  33 +      https://www.microchip.com/en-us/product/EMC2305
  34 +
  35 +Description:
  36 +-----------
  37 +This driver implements support for Microchip EMC2301/2/3/5 RPM-based PWM Fan Controller.
  38 +The EMC2305 Fan Controller supports up to 5 independently controlled PWM fan drives.
  39 +Fan rotation speeds are reported in RPM.
  40 +The driver supports the RPM-based PWM control to keep a fan at the desired speed.
  41 +The driver provides the possibility to have one common PWM interface for all FANs
  42 +or up to the maximum available or configured independent PWMs.
  43 +
  44 +The driver provides the following sysfs interfaces in hwmon subsystem:
  45 +
  46 +================= == ===================================================
  47 +fan[1-5]_fault    RO files for tachometers TACH1-TACH5 fault indication
  48 +fan[1-5]_input    RO files for tachometers TACH1-TACH5 input (in RPM)
  49 +pwm[1-5]          RW file for fan[1-5] target duty cycle (0..255)
  50 +================= == ===================================================
  51 +
  52 +sysfs interfaces in thermal subsystem:
  53 +
  54 +================= == ========================================================================
  55 +cur_state         RW file for the current cooling state of the cooling device (0..max_state)
  56 +max_state         RO file for the maximum cooling state of the cooling device
  57 +================= == ========================================================================
  58 +
  59 +Configuration is possible via device tree:
  60 +Documentation/devicetree/bindings/hwmon/microchip,emc2305.yaml