Received-SPF: pass (google.com: domain of linux-kernel+bounces-186260-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Message-ID: <1c1519649f9c99ad73854b70efe286d68d200029.camel@gmail.com>
Subject: Re: [PATCH 2/2] drivers: hwmon: max31827: Add debugfs support
From: Nuno =?ISO-8859-1?Q?S=E1?= <noname.nuno@gmail.com>
To: Radu Sabau <radu.sabau@analog.com>, Jean Delvare <jdelvare@suse.com>, 
 Guenter Roeck <linux@roeck-us.net>, Jonathan Corbet <corbet@lwn.net>,
 linux-hwmon@vger.kernel.org,  linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org
Date: Wed, 22 May 2024 15:10:51 +0200
In-Reply-To: <20240522123923.22320-3-radu.sabau@analog.com>
References: <20240522123923.22320-1-radu.sabau@analog.com>
	 <20240522123923.22320-3-radu.sabau@analog.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.50.4 (3.50.4-1.fc39) 
Precedence: bulk
MIME-Version: 1.0

On Wed, 2024-05-22 at 15:39 +0300, Radu Sabau wrote:
> Add debugfs support by creating directory in sys-fs which includes
> debugfs specific files used for configuring the device by
> preference.
>=20
> Signed-off-b: Radu Sabau <radu.sabau@analog.com>
> ---
> =C2=A0Documentation/hwmon/max31827.rst |=C2=A0 25 ++++
> =C2=A0drivers/hwmon/max31827.c=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0 | 202 ++++++++++++++++++++++++++++++-
> =C2=A02 files changed, 225 insertions(+), 2 deletions(-)
>=20
> diff --git a/Documentation/hwmon/max31827.rst b/Documentation/hwmon/max31=
827.rst
> index 9c11a9518c67..940310be6075 100644
> --- a/Documentation/hwmon/max31827.rst
> +++ b/Documentation/hwmon/max31827.rst
> @@ -142,3 +142,28 @@ usage (+33% for both write and reads) in normal cond=
itions.
> =C2=A0Since this operation implies there will be an extra delay to each
> =C2=A0transaction, PEC can be disabled or enabled through sysfs.
> =C2=A0Just write 1=C2=A0 to the "pec" file for enabling PEC and 0 for dis=
abling it.
> +
> +DebugFs entries
> +---------------
> +
> +The chip also has a configuration register where each bit stands for a s=
pecific
> +functionality to be configured. Hence as one would like to have access t=
o these
> +features, we give access to them in debugfs.
> +
> +.. warning:: The debugfs interface is subject to change without notice
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
 and is only available when the kernel is compiled with
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
 ``CONFIG_DEBUG_FS`` defined.
> +
> +``/sys/kernel/debug/max31827/``
> +contains the following attributes:
> +
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=C2=A0 =3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D
> +alarm_polarity=C2=A0 Write 1 for ALARM pin active state is low, 0 otherw=
ise
> +comp_int=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 Set to 1 if OT and UT=
 status bits are in interrupt mode
> +fault_queue=C2=A0=C2=A0=C2=A0=C2=A0 Number of consecutive temperature fa=
ults until OT and UT faults
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0 are indicated in status bits
> +pec_error=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 Set to 1 if PEC Enable bit=
 is set, 0 otherwise
> +resolution=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 2-bit value that select the con=
version resolution, please see
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0 datasheet for corresponding values
> +timeout=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 Write 1 do disab=
le bus timeout, 0 otherwise

From the description, the above really don't look like they belong into a d=
ebug
interface...

- Nuno S=C3=A1
>=20