From: William Breathitt Gray <vilhelm.gray@gmail.com> To: Andrew Morton <akpm@linux-foundation.org> Cc: gregkh@linuxfoundation.org, jic23@kernel.org, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org, fabrice.gasnier@st.com, benjamin.gaignard@st.com, robh+dt@kernel.org, knaack.h@gmx.de, lars@metafoo.de, pmeerw@pmeerw.net, mark.rutland@arm.com Subject: Re: [PATCH v7 01/10] counter: Introduce the Generic Counter interface Date: Sat, 21 Jul 2018 12:26:10 -0400 [thread overview] Message-ID: <20180721162610.GA15622@sophia> (raw) In-Reply-To: <20180717204954.4b5e371603d0b40b2aaabbb8@linux-foundation.org> On Tue, Jul 17, 2018 at 08:49:54PM -0700, Andrew Morton wrote: >On Thu, 21 Jun 2018 17:07:08 -0400 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > >> This patch introduces the Generic Counter interface for supporting >> counter devices. >> > >+EXPORT_SYMBOL(count_direction_str); >+EXPORT_SYMBOL(count_mode_str); >+EXPORT_SYMBOL(counter_signal_enum_read); >+EXPORT_SYMBOL(counter_signal_enum_write); >+EXPORT_SYMBOL(counter_signal_enum_available_read); >+EXPORT_SYMBOL(counter_count_enum_read); >+EXPORT_SYMBOL(counter_count_enum_write); >+EXPORT_SYMBOL(counter_count_enum_available_read); >+EXPORT_SYMBOL(counter_device_enum_read); >+EXPORT_SYMBOL(counter_device_enum_write); >+EXPORT_SYMBOL(counter_device_enum_available_read); >+EXPORT_SYMBOL(signal_read_value_set); >+EXPORT_SYMBOL(count_read_value_set); >+EXPORT_SYMBOL(count_write_value_get); >+EXPORT_SYMBOL(counter_register); >+EXPORT_SYMBOL(counter_unregister); >+EXPORT_SYMBOL(devm_counter_register); >+EXPORT_SYMBOL(devm_counter_unregister); > >The naming is a bit chaotic. Most of the symbols start with counter_, >which is good. But a handful do not. I can prefix these exported symbols with "counter_" to help make it clear they all belong to the Generic Counter API. I'll keep the devm_* symbols the same to match the naming convention in the other subsystems I see (watchdog, IIO, GPIO, etc.). > >Also, symbols called signal_* make my head spin - Linux already has a >firmly ingrained notion of what a signal is, and this ain't it ;) >Although the kernel tends to use sig_ for signals-as-an-IPC-thing. > >Also, many many drivers deal with signals-as-an-electrical-thing - is >it appropriate for this particular driver to take that namespace? In the context of the Generic Counter paradigm, a "Signal" is an abstraction for the stream of data that is fed to the counter device for evaluation (triggering updates for the readable "Count"). In many cases a "Signal" correlates with a physical electrical line (for example the A and B electrical lines for a quadrature encoder), but this isn't a hard requirement as the paradigm permits more abstract data streams. I decided on "Signal" to match the naming convention that appears in the datasheets of many counter devices, but "Line" may be a decent alternative name we could use to indicate a counter device input data stream. I'd like to get some other opinions as well before I make a naming change to "Signal" -- whether to stay with "Signal," switch to "Line," or rename to something else. For what it's worth, I think it's unlikely for a counter device driver author to confuse a Counter Signal with the Linux OS signal within the context of the Generic Counter paradigm and their respective counter device datasheet. William Breathitt Gray
WARNING: multiple messages have this Message-ID (diff)
From: vilhelm.gray@gmail.com (William Breathitt Gray) To: linux-arm-kernel@lists.infradead.org Subject: [PATCH v7 01/10] counter: Introduce the Generic Counter interface Date: Sat, 21 Jul 2018 12:26:10 -0400 [thread overview] Message-ID: <20180721162610.GA15622@sophia> (raw) In-Reply-To: <20180717204954.4b5e371603d0b40b2aaabbb8@linux-foundation.org> On Tue, Jul 17, 2018 at 08:49:54PM -0700, Andrew Morton wrote: >On Thu, 21 Jun 2018 17:07:08 -0400 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > >> This patch introduces the Generic Counter interface for supporting >> counter devices. >> > >+EXPORT_SYMBOL(count_direction_str); >+EXPORT_SYMBOL(count_mode_str); >+EXPORT_SYMBOL(counter_signal_enum_read); >+EXPORT_SYMBOL(counter_signal_enum_write); >+EXPORT_SYMBOL(counter_signal_enum_available_read); >+EXPORT_SYMBOL(counter_count_enum_read); >+EXPORT_SYMBOL(counter_count_enum_write); >+EXPORT_SYMBOL(counter_count_enum_available_read); >+EXPORT_SYMBOL(counter_device_enum_read); >+EXPORT_SYMBOL(counter_device_enum_write); >+EXPORT_SYMBOL(counter_device_enum_available_read); >+EXPORT_SYMBOL(signal_read_value_set); >+EXPORT_SYMBOL(count_read_value_set); >+EXPORT_SYMBOL(count_write_value_get); >+EXPORT_SYMBOL(counter_register); >+EXPORT_SYMBOL(counter_unregister); >+EXPORT_SYMBOL(devm_counter_register); >+EXPORT_SYMBOL(devm_counter_unregister); > >The naming is a bit chaotic. Most of the symbols start with counter_, >which is good. But a handful do not. I can prefix these exported symbols with "counter_" to help make it clear they all belong to the Generic Counter API. I'll keep the devm_* symbols the same to match the naming convention in the other subsystems I see (watchdog, IIO, GPIO, etc.). > >Also, symbols called signal_* make my head spin - Linux already has a >firmly ingrained notion of what a signal is, and this ain't it ;) >Although the kernel tends to use sig_ for signals-as-an-IPC-thing. > >Also, many many drivers deal with signals-as-an-electrical-thing - is >it appropriate for this particular driver to take that namespace? In the context of the Generic Counter paradigm, a "Signal" is an abstraction for the stream of data that is fed to the counter device for evaluation (triggering updates for the readable "Count"). In many cases a "Signal" correlates with a physical electrical line (for example the A and B electrical lines for a quadrature encoder), but this isn't a hard requirement as the paradigm permits more abstract data streams. I decided on "Signal" to match the naming convention that appears in the datasheets of many counter devices, but "Line" may be a decent alternative name we could use to indicate a counter device input data stream. I'd like to get some other opinions as well before I make a naming change to "Signal" -- whether to stay with "Signal," switch to "Line," or rename to something else. For what it's worth, I think it's unlikely for a counter device driver author to confuse a Counter Signal with the Linux OS signal within the context of the Generic Counter paradigm and their respective counter device datasheet. William Breathitt Gray
next prev parent reply other threads:[~2018-07-21 16:26 UTC|newest] Thread overview: 95+ messages / expand[flat|nested] mbox.gz Atom feed top 2018-06-21 21:06 [PATCH v7 00/10] Introduce the Counter subsystem William Breathitt Gray 2018-06-21 21:06 ` William Breathitt Gray 2018-06-21 21:07 ` [PATCH v7 01/10] counter: Introduce the Generic Counter interface William Breathitt Gray 2018-06-21 21:07 ` William Breathitt Gray 2018-07-07 15:16 ` Greg KH 2018-07-07 15:16 ` Greg KH 2018-07-07 15:16 ` Greg KH 2018-07-09 17:40 ` William Breathitt Gray 2018-07-09 17:40 ` William Breathitt Gray 2018-07-09 17:40 ` William Breathitt Gray 2018-07-09 18:54 ` Greg KH 2018-07-09 18:54 ` Greg KH 2018-07-09 18:56 ` William Breathitt Gray 2018-07-09 18:56 ` William Breathitt Gray 2018-07-18 3:49 ` Andrew Morton 2018-07-18 3:49 ` Andrew Morton 2018-07-21 16:26 ` William Breathitt Gray [this message] 2018-07-21 16:26 ` William Breathitt Gray 2018-07-22 5:41 ` Andrew Morton 2018-07-22 5:41 ` Andrew Morton 2018-06-21 21:07 ` [PATCH v7 02/10] counter: Documentation: Add Generic Counter sysfs documentation William Breathitt Gray 2018-06-21 21:07 ` William Breathitt Gray 2018-07-02 19:11 ` [v7, " David Lechner 2018-07-02 19:11 ` David Lechner 2018-07-03 14:04 ` William Breathitt Gray 2018-07-03 14:04 ` William Breathitt Gray 2018-06-21 21:07 ` [PATCH v7 03/10] docs: Add Generic Counter interface documentation William Breathitt Gray 2018-06-21 21:07 ` William Breathitt Gray 2018-06-22 16:51 ` Jonathan Cameron 2018-06-22 16:51 ` Jonathan Cameron 2018-06-22 16:51 ` Jonathan Cameron 2018-07-02 19:37 ` [v7,03/10] " David Lechner 2018-07-02 19:37 ` David Lechner 2018-07-03 14:16 ` William Breathitt Gray 2018-07-03 14:16 ` William Breathitt Gray 2018-07-04 17:23 ` Linus Walleij 2018-07-04 17:23 ` Linus Walleij 2018-07-04 17:23 ` Linus Walleij 2018-07-06 17:15 ` Jonathan Cameron 2018-07-06 17:15 ` Jonathan Cameron 2018-07-06 17:15 ` Jonathan Cameron 2018-07-06 17:15 ` Jonathan Cameron 2018-07-06 18:25 ` David Lechner 2018-07-06 18:25 ` David Lechner 2018-07-06 18:25 ` David Lechner 2018-07-02 19:42 ` David Lechner 2018-07-02 19:42 ` David Lechner 2018-07-03 14:21 ` William Breathitt Gray 2018-07-03 14:21 ` William Breathitt Gray 2018-06-21 21:07 ` [PATCH v7 04/10] counter: 104-quad-8: Add Generic Counter interface support William Breathitt Gray 2018-06-21 21:07 ` William Breathitt Gray 2018-06-22 16:57 ` Jonathan Cameron 2018-06-22 16:57 ` Jonathan Cameron 2018-06-22 16:57 ` Jonathan Cameron 2018-06-21 21:08 ` [PATCH v7 05/10] counter: 104-quad-8: Documentation: Add Generic Counter sysfs documentation William Breathitt Gray 2018-06-21 21:08 ` William Breathitt Gray 2018-06-22 16:59 ` Jonathan Cameron 2018-06-22 16:59 ` Jonathan Cameron 2018-06-22 16:59 ` Jonathan Cameron 2018-06-21 21:08 ` [PATCH v7 06/10] counter: Add STM32 Timer quadrature encoder William Breathitt Gray 2018-06-21 21:08 ` William Breathitt Gray 2018-06-22 17:03 ` Jonathan Cameron 2018-06-22 17:03 ` Jonathan Cameron 2018-06-22 17:03 ` Jonathan Cameron 2018-06-21 21:08 ` [PATCH v7 07/10] dt-bindings: counter: Document stm32 " William Breathitt Gray 2018-06-21 21:08 ` William Breathitt Gray 2018-07-02 19:56 ` [v7,07/10] " David Lechner 2018-07-02 19:56 ` David Lechner 2018-07-05 21:13 ` [PATCH v7 07/10] " Rob Herring 2018-07-05 21:13 ` Rob Herring 2018-06-21 21:08 ` [PATCH v7 08/10] counter: stm32-lptimer: add counter device William Breathitt Gray 2018-06-21 21:08 ` William Breathitt Gray 2018-06-22 17:06 ` Jonathan Cameron 2018-06-22 17:06 ` Jonathan Cameron 2018-06-22 17:06 ` Jonathan Cameron 2018-06-21 21:08 ` [PATCH v7 09/10] dt-bindings: counter: Adjust dt-bindings for STM32 lptimer move William Breathitt Gray 2018-06-21 21:08 ` William Breathitt Gray 2018-07-05 21:13 ` Rob Herring 2018-07-05 21:13 ` Rob Herring 2018-06-21 21:09 ` [PATCH v7 10/10] iio: counter: Add deprecation markings for IIO Counter attributes William Breathitt Gray 2018-06-21 21:09 ` William Breathitt Gray 2018-06-22 17:10 ` [PATCH v7 00/10] Introduce the Counter subsystem Jonathan Cameron 2018-06-22 17:10 ` Jonathan Cameron 2018-06-22 17:10 ` Jonathan Cameron 2018-07-02 18:13 ` David Lechner 2018-07-02 18:13 ` David Lechner 2018-07-03 2:48 ` William Breathitt Gray 2018-07-03 2:48 ` William Breathitt Gray 2018-07-06 17:21 ` Jonathan Cameron 2018-07-06 17:21 ` Jonathan Cameron 2018-07-06 17:21 ` Jonathan Cameron 2018-07-06 18:22 ` David Lechner 2018-07-06 18:22 ` David Lechner 2018-07-06 19:20 ` William Breathitt Gray 2018-07-06 19:20 ` William Breathitt Gray
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=20180721162610.GA15622@sophia \ --to=vilhelm.gray@gmail.com \ --cc=akpm@linux-foundation.org \ --cc=benjamin.gaignard@st.com \ --cc=devicetree@vger.kernel.org \ --cc=fabrice.gasnier@st.com \ --cc=gregkh@linuxfoundation.org \ --cc=jic23@kernel.org \ --cc=knaack.h@gmx.de \ --cc=lars@metafoo.de \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-iio@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=mark.rutland@arm.com \ --cc=pmeerw@pmeerw.net \ --cc=robh+dt@kernel.org \ /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: linkBe 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.