From: Jonathan Cameron <jic23@kernel.org>
To: David Lechner <dlechner@baylibre.com>
Cc: linux-iio@vger.kernel.org, linux-staging@lists.linux.dev,
"Michael Hennerich" <Michael.Hennerich@analog.com>,
"Nuno Sá" <nuno.sa@analog.com>,
"Axel Haslam" <ahaslam@baylibre.com>,
"Philip Molloy" <pmolloy@baylibre.com>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v4 14/17] staging: iio: resolver: ad2s1210: add register/fault support summary
Date: Tue, 10 Oct 2023 17:07:27 +0100 [thread overview]
Message-ID: <20231010170727.524a5820@jic23-huawei> (raw)
In-Reply-To: <20231005-ad2s1210-mainline-v4-14-ec00746840fc@baylibre.com>
On Thu, 5 Oct 2023 19:50:31 -0500
David Lechner <dlechner@baylibre.com> wrote:
> The ad2s1210 driver shoe-horns the register and fault support into IIO
> events. The mapping between the registers/faults and the events is not
> obvious. To save users from having to read the entire driver to figure
> out how to use it, add a summary of the register/fault support to the
> top of the file.
>
> Signed-off-by: David Lechner <dlechner@baylibre.com>
This is indeed useful to have.
Applied.
Thanks,
Jonathan
> ---
>
> v4 changes: New patch in v4.
>
> drivers/staging/iio/resolver/ad2s1210.c | 40 +++++++++++++++++++++++++++++++++
> 1 file changed, 40 insertions(+)
>
> diff --git a/drivers/staging/iio/resolver/ad2s1210.c b/drivers/staging/iio/resolver/ad2s1210.c
> index d9d51bbbade8..51490fea1647 100644
> --- a/drivers/staging/iio/resolver/ad2s1210.c
> +++ b/drivers/staging/iio/resolver/ad2s1210.c
> @@ -4,7 +4,47 @@
> *
> * Copyright (c) 2010-2010 Analog Devices Inc.
> * Copyright (c) 2023 BayLibre, SAS
> + *
> + * Device register to IIO ABI mapping:
> + *
> + * Register | Addr | IIO ABI (sysfs)
> + * ----------------------------|------|-------------------------------------------
> + * DOS Overrange Threshold | 0x89 | events/in_altvoltage0_thresh_rising_value
> + * DOS Mismatch Threshold | 0x8A | events/in_altvoltage0_mag_rising_value
> + * DOS Reset Maximum Threshold | 0x8B | events/in_altvoltage0_mag_rising_reset_max
> + * DOS Reset Minimum Threshold | 0x8C | events/in_altvoltage0_mag_rising_reset_min
> + * LOT High Threshold | 0x8D | events/in_angl1_thresh_rising_value
> + * LOT Low Threshold [1] | 0x8E | events/in_angl1_thresh_rising_hysteresis
> + * Excitation Frequency | 0x91 | out_altvoltage0_frequency
> + * Control | 0x92 | *as bit fields*
> + * Phase lock range | D5 | events/in_phase0_mag_rising_value
> + * Hysteresis | D4 | in_angl0_hysteresis
> + * Encoder resolution | D3:2 | *not implemented*
> + * Resolution | D1:0 | *device tree: assigned-resolution-bits*
> + * Soft Reset | 0xF0 | [2]
> + * Fault | 0xFF | *not implemented*
> + *
> + * [1]: The value written to the LOT low register is high value minus the
> + * hysteresis.
> + * [2]: Soft reset is performed when `out_altvoltage0_frequency` is written.
> + *
> + * Fault to event mapping:
> + *
> + * Fault | | Channel | Type | Direction
> + * ----------------------------------------|----|---------------------------------
> + * Sine/cosine inputs clipped [3] | D7 | altvoltage1 | mag | either
> + * Sine/cosine inputs below LOS | D6 | altvoltage0 | thresh | falling
> + * Sine/cosine inputs exceed DOS overrange | D5 | altvoltage0 | thresh | rising
> + * Sine/cosine inputs exceed DOS mismatch | D4 | altvoltage0 | mag | rising
> + * Tracking error exceeds LOT | D3 | angl1 | thresh | rising
> + * Velocity exceeds maximum tracking rate | D2 | anglvel0 | mag | rising
> + * Phase error exceeds phase lock range | D1 | phase0 | mag | rising
> + * Configuration parity error | D0 | *writes to kernel log*
> + *
> + * [3]: The chip does not differentiate between fault on sine vs. cosine so
> + * there will also be an event on the altvoltage2 channel.
> */
> +
> #include <linux/bitfield.h>
> #include <linux/bits.h>
> #include <linux/clk.h>
>
next prev parent reply other threads:[~2023-10-10 16:07 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-06 0:50 [PATCH v4 00/17] iio: resolver: move ad2s1210 out of staging David Lechner
2023-10-06 0:50 ` [PATCH v4 01/17] staging: iio: resolver: ad2s1210: do not use fault register for dummy read David Lechner
2023-10-10 15:38 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 02/17] staging: iio: resolver: ad2s1210: implement hysteresis as channel attr David Lechner
2023-10-10 15:40 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 03/17] staging: iio: resolver: ad2s1210: convert fexcit to channel attribute David Lechner
2023-10-10 15:41 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 04/17] staging: iio: resolver: ad2s1210: convert resolution to devicetree property David Lechner
2023-10-10 15:43 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 05/17] staging: iio: resolver: ad2s1210: add phase lock range support David Lechner
2023-10-10 15:46 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 06/17] staging: iio: resolver: ad2s1210: add triggered buffer support David Lechner
2023-10-10 15:47 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 07/17] staging: iio: resolver: ad2s1210: convert LOT threshold attrs to event attrs David Lechner
2023-10-10 15:54 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 08/17] staging: iio: resolver: ad2s1210: convert LOS threshold to event attr David Lechner
2023-10-10 15:52 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 09/17] staging: iio: resolver: ad2s1210: convert DOS overrange " David Lechner
2023-10-10 15:55 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 10/17] staging: iio: resolver: ad2s1210: convert DOS mismatch " David Lechner
2023-10-10 15:56 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 11/17] staging: iio: resolver: ad2s1210: rename DOS reset min/max attrs David Lechner
2023-10-10 15:57 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 12/17] iio: event: add optional event label support David Lechner
2023-10-10 15:59 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 13/17] staging: iio: resolver: ad2s1210: implement fault events David Lechner
2023-10-10 16:05 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 14/17] staging: iio: resolver: ad2s1210: add register/fault support summary David Lechner
2023-10-10 16:07 ` Jonathan Cameron [this message]
2023-10-06 0:50 ` [PATCH v4 15/17] staging: iio: resolver: ad2s1210: add label attribute support David Lechner
2023-10-10 16:08 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 16/17] staging: iio: resolver: ad2s1210: remove fault attribute David Lechner
2023-10-10 16:09 ` Jonathan Cameron
2023-10-06 0:50 ` [PATCH v4 17/17] staging: iio: resolver: ad2s1210: simplify code with guard(mutex) David Lechner
2023-10-10 16:17 ` Jonathan Cameron
2023-10-10 17:40 ` David Lechner
2023-10-10 17:46 ` Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231010170727.524a5820@jic23-huawei \
--to=jic23@kernel.org \
--cc=Michael.Hennerich@analog.com \
--cc=ahaslam@baylibre.com \
--cc=dlechner@baylibre.com \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=nuno.sa@analog.com \
--cc=pmolloy@baylibre.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.