* [PATCH v7 0/5] Introduce the Counter character device interface @ 2020-12-26 0:15 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, William Breathitt Gray Changes in v7: - Implemented u32 enums; enum types can now be used directly for callbacks and values - Fixed refcount underflow bug - Refactored all err check to check for err < 0; this should help prevent future oversights on valid positive return valids - Use mutex instead of raw_spin_lock in counter_chrdev_read(); kifo_to_user() can now safely sleep - Renamed COUNTER_COMPONENT_DUMMY to COUNTER_COMPONENT_NONE to make purpose more obvious - Introduced a watch_validate() callback - Consolidated the functionality to clear the watches to the counter_clear_watches() function - Reimplemented counter_push_event() as a void function; on error, errno is returned via struct counter_event so that it can be handled by userspace (because interrupt handlers can't do much for this) - Renamed the events_config() callback to events_configure(); "events_config" could be confused as a read callback when this is actually intended to configure the device for the requested events - Reimplemented 104-QUAD-8 driver to use events_configure() and watch_validate() callbacks; irq_trigger_enable sysfs attribute removed because events_configure() now serves this purpose The changes for this revision were much simpler compared to the previous revisions. I don't have any further questions for this patchset, so it's really just a search for possible bugs or regressions now. Please test and verify this patchset on your systems, and ACK appropriately. To summarize the main points: there are no changes to the existing Counter sysfs userspace interface; a Counter character device interface is introduced that allows Counter events and associated data to be read() by userspace; the events_configure() and watch_validate() driver callbacks are introduced to support Counter events; and IRQ support is added to the 104-QUAD-8 driver, serving as an example of how to support the new Counter events functionality. William Breathitt Gray (5): counter: Internalize sysfs interface code docs: counter: Update to reflect sysfs internalization counter: Add character device interface docs: counter: Document character device interface counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 Documentation/ABI/testing/sysfs-bus-counter | 18 +- .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 + Documentation/driver-api/generic-counter.rst | 416 ++++- .../userspace-api/ioctl/ioctl-number.rst | 1 + MAINTAINERS | 2 +- drivers/counter/104-quad-8.c | 799 +++++---- drivers/counter/Kconfig | 6 +- drivers/counter/Makefile | 1 + drivers/counter/counter-chrdev.c | 490 ++++++ drivers/counter/counter-chrdev.h | 16 + drivers/counter/counter-core.c | 182 ++ drivers/counter/counter-sysfs.c | 868 ++++++++++ drivers/counter/counter-sysfs.h | 13 + drivers/counter/counter.c | 1496 ----------------- drivers/counter/ftm-quaddec.c | 61 +- drivers/counter/microchip-tcb-capture.c | 103 +- drivers/counter/stm32-lptimer-cnt.c | 181 +- drivers/counter/stm32-timer-cnt.c | 149 +- drivers/counter/ti-eqep.c | 224 +-- include/linux/counter.h | 716 ++++---- include/linux/counter_enum.h | 45 - include/uapi/linux/counter.h | 123 ++ 22 files changed, 3259 insertions(+), 2676 deletions(-) create mode 100644 drivers/counter/counter-chrdev.c create mode 100644 drivers/counter/counter-chrdev.h create mode 100644 drivers/counter/counter-core.c create mode 100644 drivers/counter/counter-sysfs.c create mode 100644 drivers/counter/counter-sysfs.h delete mode 100644 drivers/counter/counter.c delete mode 100644 include/linux/counter_enum.h create mode 100644 include/uapi/linux/counter.h -- 2.29.2 ^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH v7 0/5] Introduce the Counter character device interface @ 2020-12-26 0:15 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, William Breathitt Gray, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue Changes in v7: - Implemented u32 enums; enum types can now be used directly for callbacks and values - Fixed refcount underflow bug - Refactored all err check to check for err < 0; this should help prevent future oversights on valid positive return valids - Use mutex instead of raw_spin_lock in counter_chrdev_read(); kifo_to_user() can now safely sleep - Renamed COUNTER_COMPONENT_DUMMY to COUNTER_COMPONENT_NONE to make purpose more obvious - Introduced a watch_validate() callback - Consolidated the functionality to clear the watches to the counter_clear_watches() function - Reimplemented counter_push_event() as a void function; on error, errno is returned via struct counter_event so that it can be handled by userspace (because interrupt handlers can't do much for this) - Renamed the events_config() callback to events_configure(); "events_config" could be confused as a read callback when this is actually intended to configure the device for the requested events - Reimplemented 104-QUAD-8 driver to use events_configure() and watch_validate() callbacks; irq_trigger_enable sysfs attribute removed because events_configure() now serves this purpose The changes for this revision were much simpler compared to the previous revisions. I don't have any further questions for this patchset, so it's really just a search for possible bugs or regressions now. Please test and verify this patchset on your systems, and ACK appropriately. To summarize the main points: there are no changes to the existing Counter sysfs userspace interface; a Counter character device interface is introduced that allows Counter events and associated data to be read() by userspace; the events_configure() and watch_validate() driver callbacks are introduced to support Counter events; and IRQ support is added to the 104-QUAD-8 driver, serving as an example of how to support the new Counter events functionality. William Breathitt Gray (5): counter: Internalize sysfs interface code docs: counter: Update to reflect sysfs internalization counter: Add character device interface docs: counter: Document character device interface counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 Documentation/ABI/testing/sysfs-bus-counter | 18 +- .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 + Documentation/driver-api/generic-counter.rst | 416 ++++- .../userspace-api/ioctl/ioctl-number.rst | 1 + MAINTAINERS | 2 +- drivers/counter/104-quad-8.c | 799 +++++---- drivers/counter/Kconfig | 6 +- drivers/counter/Makefile | 1 + drivers/counter/counter-chrdev.c | 490 ++++++ drivers/counter/counter-chrdev.h | 16 + drivers/counter/counter-core.c | 182 ++ drivers/counter/counter-sysfs.c | 868 ++++++++++ drivers/counter/counter-sysfs.h | 13 + drivers/counter/counter.c | 1496 ----------------- drivers/counter/ftm-quaddec.c | 61 +- drivers/counter/microchip-tcb-capture.c | 103 +- drivers/counter/stm32-lptimer-cnt.c | 181 +- drivers/counter/stm32-timer-cnt.c | 149 +- drivers/counter/ti-eqep.c | 224 +-- include/linux/counter.h | 716 ++++---- include/linux/counter_enum.h | 45 - include/uapi/linux/counter.h | 123 ++ 22 files changed, 3259 insertions(+), 2676 deletions(-) create mode 100644 drivers/counter/counter-chrdev.c create mode 100644 drivers/counter/counter-chrdev.h create mode 100644 drivers/counter/counter-core.c create mode 100644 drivers/counter/counter-sysfs.c create mode 100644 drivers/counter/counter-sysfs.h delete mode 100644 drivers/counter/counter.c delete mode 100644 include/linux/counter_enum.h create mode 100644 include/uapi/linux/counter.h -- 2.29.2 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH v7 1/5] counter: Internalize sysfs interface code 2020-12-26 0:15 ` William Breathitt Gray (?) @ 2020-12-26 0:15 ` William Breathitt Gray 2020-12-30 14:37 ` Jonathan Cameron 2020-12-30 23:24 ` David Lechner -1 siblings, 2 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, William Breathitt Gray, Dan Carpenter This is a reimplementation of the Generic Counter driver interface. There are no modifications to the Counter subsystem userspace interface, so existing userspace applications should continue to run seamlessly. Overview ======== The purpose of this patch is to internalize the sysfs interface code among the various counter drivers into a shared module. Counter drivers pass and take data natively (i.e. u8, u64, etc.) and the shared counter module handles the translation between the sysfs interface. This guarantees a standard userspace interface for all counter drivers, and helps generalize the Generic Counter driver ABI in order to support the Generic Counter chrdev interface (introduced in a subsequent patch) without significant changes to the existing counter drivers. A high-level view of how a count value is passed down from a counter driver is exemplified by the following. The driver callbacks are first registered to the Counter core component for use by the Counter userspace interface components: +----------------------------+ | Counter device driver | +----------------------------+ | Processes data from device | +----------------------------+ | ------------------- / driver callbacks / ------------------- | V +----------------------+ | Counter core | +----------------------+ | Routes device driver | | callbacks to the | | userspace interfaces | +----------------------+ | ------------------- / driver callbacks / ------------------- | +---------------+ | V +--------------------+ | Counter sysfs | +--------------------+ | Translates to the | | standard Counter | | sysfs output | +--------------------+ Thereafter, data can be transferred directly between the Counter device driver and Counter userspace interface: ---------------------- / Counter device \ +----------------------+ | Count register: 0x28 | +----------------------+ | ----------------- / raw count data / ----------------- | V +----------------------------+ | Counter device driver | +----------------------------+ | Processes data from device | |----------------------------| | Type: u64 | | Value: 42 | +----------------------------+ | ---------- / u64 / ---------- | +---------------+ | V +--------------------+ | Counter sysfs | +--------------------+ | Translates to the | | standard Counter | | sysfs output | |--------------------| | Type: const char * | | Value: "42" | +--------------------+ | --------------- / const char * / --------------- | V +--------------------------------------------------+ | `/sys/bus/counter/devices/counterX/countY/count` | +--------------------------------------------------+ \ Count: "42" / -------------------------------------------------- There are three primary components involved: Counter device driver --------------------- Communicates with the hardware device to read/write data; e.g. counter drivers for quadrature encoders, timers, etc. Counter core ------------ Registers the counter device driver to the system so that the respective callbacks are called during userspace interaction. Counter sysfs ------------- Translates counter data to the standard Counter sysfs interface format and vice versa. Driver ABI ========== This reimplementation entails several changes to the driver ABI. In particular, the device driver callbacks are now expected to handle standard C datatypes rather than translating the sysfs I/O directly. To that end, the struct counter_comp structure is introduced to establish counter extensions for Signals, Synapses, and Counts. The "type" member specifies the type of high-level data (e.g. BOOL, COUNT_DIRECTION, etc.) handled by this extension. The "*_read" and "*_write" members can then be set by the counter device driver with callbacks to handle that data using native C data types (i.e. u8, u64, etc.). Convenience macros such as COUNTER_COMP_COUNT_U64 are provided for use by driver authors. In particular, driver authors are expected to use the provided macros for standard Counter subsystem attributes in order to maintain a consistent interface for userspace. For example, a counter device driver may define several standard attributes like so: struct counter_comp count_ext[] = { COUNTER_COMP_DIRECTION(count_direction_read), COUNTER_COMP_ENABLE(count_enable_read, count_enable_write), COUNTER_COMP_CEILING(count_ceiling_read, count_ceiling_write), }; This makes it simple to see, add, and modify the attributes that are supported by this driver ("direction", "enable", and "ceiling") and to maintain this code without getting lost in a web of struct braces. Callbacks must match the function type expected for the respective component or extension. These function types are defined in the struct counter_comp structure as the "*_read" and "*_write" union members. The corresponding callback prototypes for the extensions above would be: int count_direction_read(struct counter_device *counter, struct counter_count *count, u8 *direction); int count_enable_read(struct counter_device *counter, struct counter_count *count, u8 *enable); int count_enable_write(struct counter_device *counter, struct counter_count *count, u8 enable); int count_ceiling_read(struct counter_device *counter, struct counter_count *count, u64 *ceiling); int count_ceiling_write(struct counter_device *counter, struct counter_count *count, u64 ceiling); In this way, driver authors no longer need to mess with sysfs strings and are instead able to focus on what they actually care about doing -- getting data to/from the devices -- while the Generic Counter interface handles the translation of that data for them between the various userspace interfaces (e.g. sysfs and chardev). Architecture ============ Counter device registration is the same as before: drivers populate a struct counter_device with components and callbacks, then pass the structure to the devm_counter_register function. However, what's different now is how the Counter subsystem code handles this registration internally. Whereas before callbacks would interact directly with sysfs data, this interaction is now abstracted and instead callbacks interact with native C data types. The counter_comp structure forms the basis for Counter extensions. The counter-sysfs.c file contains the code to parse through the counter_device structure and register the requested components and extensions. Attributes are created and populated based on type, with respective translation functions to handle the mapping between sysfs and the counter driver callbacks. The translation performed for each attribute is straightforward: the attribute type and data is parsed from the counter_attribute structure, the respective counter driver read/write callback is called, and sysfs I/O is handled before or after the driver read/write function is called. Cc: Syed Nayyar Waris <syednwaris@gmail.com> Cc: Patrick Havelange <patrick.havelange@essensium.com> Cc: Kamel Bouhara <kamel.bouhara@bootlin.com> Cc: Fabrice Gasnier <fabrice.gasnier@st.com> Cc: Maxime Coquelin <mcoquelin.stm32@gmail.com> Cc: Alexandre Torgue <alexandre.torgue@st.com> Cc: David Lechner <david@lechnology.com> Cc: Dan Carpenter <dan.carpenter@oracle.com> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- MAINTAINERS | 1 - drivers/counter/104-quad-8.c | 489 ++++---- drivers/counter/Makefile | 1 + drivers/counter/counter-core.c | 153 +++ drivers/counter/counter-sysfs.c | 837 +++++++++++++ drivers/counter/counter-sysfs.h | 13 + drivers/counter/counter.c | 1496 ----------------------- drivers/counter/ftm-quaddec.c | 61 +- drivers/counter/microchip-tcb-capture.c | 103 +- drivers/counter/stm32-lptimer-cnt.c | 181 +-- drivers/counter/stm32-timer-cnt.c | 149 +-- drivers/counter/ti-eqep.c | 224 ++-- include/linux/counter.h | 707 +++++------ include/linux/counter_enum.h | 45 - 14 files changed, 1932 insertions(+), 2528 deletions(-) create mode 100644 drivers/counter/counter-core.c create mode 100644 drivers/counter/counter-sysfs.c create mode 100644 drivers/counter/counter-sysfs.h delete mode 100644 drivers/counter/counter.c delete mode 100644 include/linux/counter_enum.h diff --git a/MAINTAINERS b/MAINTAINERS index 2ac5688db43a..b64fa49d5796 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4494,7 +4494,6 @@ F: Documentation/ABI/testing/sysfs-bus-counter* F: Documentation/driver-api/generic-counter.rst F: drivers/counter/ F: include/linux/counter.h -F: include/linux/counter_enum.h CPMAC ETHERNET DRIVER M: Florian Fainelli <f.fainelli@gmail.com> diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c index 78766b6ec271..f4fb36b751c4 100644 --- a/drivers/counter/104-quad-8.c +++ b/drivers/counter/104-quad-8.c @@ -621,7 +621,8 @@ static const struct iio_chan_spec quad8_channels[] = { }; static int quad8_signal_read(struct counter_device *counter, - struct counter_signal *signal, enum counter_signal_value *val) + struct counter_signal *signal, + enum counter_signal_level *level) { const struct quad8_iio *const priv = counter->priv; unsigned int state; @@ -633,13 +634,13 @@ static int quad8_signal_read(struct counter_device *counter, state = inb(priv->base + QUAD8_REG_INDEX_INPUT_LEVELS) & BIT(signal->id - 16); - *val = (state) ? COUNTER_SIGNAL_HIGH : COUNTER_SIGNAL_LOW; + *level = (state) ? COUNTER_SIGNAL_LEVEL_HIGH : COUNTER_SIGNAL_LEVEL_LOW; return 0; } static int quad8_count_read(struct counter_device *counter, - struct counter_count *count, unsigned long *val) + struct counter_count *count, u64 *val) { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id; @@ -670,7 +671,7 @@ static int quad8_count_read(struct counter_device *counter, } static int quad8_count_write(struct counter_device *counter, - struct counter_count *count, unsigned long val) + struct counter_count *count, u64 val) { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id; @@ -710,22 +711,17 @@ static int quad8_count_write(struct counter_device *counter, return 0; } -enum quad8_count_function { - QUAD8_COUNT_FUNCTION_PULSE_DIRECTION = 0, - QUAD8_COUNT_FUNCTION_QUADRATURE_X1, - QUAD8_COUNT_FUNCTION_QUADRATURE_X2, - QUAD8_COUNT_FUNCTION_QUADRATURE_X4 -}; -static enum counter_count_function quad8_count_functions_list[] = { - [QUAD8_COUNT_FUNCTION_PULSE_DIRECTION] = COUNTER_COUNT_FUNCTION_PULSE_DIRECTION, - [QUAD8_COUNT_FUNCTION_QUADRATURE_X1] = COUNTER_COUNT_FUNCTION_QUADRATURE_X1_A, - [QUAD8_COUNT_FUNCTION_QUADRATURE_X2] = COUNTER_COUNT_FUNCTION_QUADRATURE_X2_A, - [QUAD8_COUNT_FUNCTION_QUADRATURE_X4] = COUNTER_COUNT_FUNCTION_QUADRATURE_X4 +static const enum counter_function quad8_functions_list[] = { + COUNTER_FUNCTION_PULSE_DIRECTION, + COUNTER_FUNCTION_QUADRATURE_X1_A, + COUNTER_FUNCTION_QUADRATURE_X2_A, + COUNTER_FUNCTION_QUADRATURE_X4, }; -static int quad8_function_get(struct counter_device *counter, - struct counter_count *count, size_t *function) +static int quad8_function_read(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function) { struct quad8_iio *const priv = counter->priv; const int id = count->id; @@ -735,25 +731,26 @@ static int quad8_function_get(struct counter_device *counter, if (priv->quadrature_mode[id]) switch (priv->quadrature_scale[id]) { case 0: - *function = QUAD8_COUNT_FUNCTION_QUADRATURE_X1; + *function = COUNTER_FUNCTION_QUADRATURE_X1_A; break; case 1: - *function = QUAD8_COUNT_FUNCTION_QUADRATURE_X2; + *function = COUNTER_FUNCTION_QUADRATURE_X2_A; break; case 2: - *function = QUAD8_COUNT_FUNCTION_QUADRATURE_X4; + *function = COUNTER_FUNCTION_QUADRATURE_X4; break; } else - *function = QUAD8_COUNT_FUNCTION_PULSE_DIRECTION; + *function = COUNTER_FUNCTION_PULSE_DIRECTION; mutex_unlock(&priv->lock); return 0; } -static int quad8_function_set(struct counter_device *counter, - struct counter_count *count, size_t function) +static int quad8_function_write(struct counter_device *counter, + struct counter_count *count, + enum counter_function function) { struct quad8_iio *const priv = counter->priv; const int id = count->id; @@ -769,7 +766,7 @@ static int quad8_function_set(struct counter_device *counter, mode_cfg = priv->count_mode[id] << 1; idr_cfg = priv->index_polarity[id] << 1; - if (function == QUAD8_COUNT_FUNCTION_PULSE_DIRECTION) { + if (function == COUNTER_FUNCTION_PULSE_DIRECTION) { *quadrature_mode = 0; /* Quadrature scaling only available in quadrature mode */ @@ -785,18 +782,21 @@ static int quad8_function_set(struct counter_device *counter, *quadrature_mode = 1; switch (function) { - case QUAD8_COUNT_FUNCTION_QUADRATURE_X1: + case COUNTER_FUNCTION_QUADRATURE_X1_A: *scale = 0; mode_cfg |= QUAD8_CMR_QUADRATURE_X1; break; - case QUAD8_COUNT_FUNCTION_QUADRATURE_X2: + case COUNTER_FUNCTION_QUADRATURE_X2_A: *scale = 1; mode_cfg |= QUAD8_CMR_QUADRATURE_X2; break; - case QUAD8_COUNT_FUNCTION_QUADRATURE_X4: + case COUNTER_FUNCTION_QUADRATURE_X4: *scale = 2; mode_cfg |= QUAD8_CMR_QUADRATURE_X4; break; + default: + mutex_unlock(&priv->lock); + return -EINVAL; } } @@ -808,8 +808,9 @@ static int quad8_function_set(struct counter_device *counter, return 0; } -static void quad8_direction_get(struct counter_device *counter, - struct counter_count *count, enum counter_count_direction *direction) +static int quad8_direction_read(struct counter_device *counter, + struct counter_count *count, + enum counter_count_direction *direction) { const struct quad8_iio *const priv = counter->priv; unsigned int ud_flag; @@ -820,77 +821,78 @@ static void quad8_direction_get(struct counter_device *counter, *direction = (ud_flag) ? COUNTER_COUNT_DIRECTION_FORWARD : COUNTER_COUNT_DIRECTION_BACKWARD; -} -enum quad8_synapse_action { - QUAD8_SYNAPSE_ACTION_NONE = 0, - QUAD8_SYNAPSE_ACTION_RISING_EDGE, - QUAD8_SYNAPSE_ACTION_FALLING_EDGE, - QUAD8_SYNAPSE_ACTION_BOTH_EDGES -}; + return 0; +} -static enum counter_synapse_action quad8_index_actions_list[] = { - [QUAD8_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, - [QUAD8_SYNAPSE_ACTION_RISING_EDGE] = COUNTER_SYNAPSE_ACTION_RISING_EDGE +static const enum counter_synapse_action quad8_index_actions_list[] = { + COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, }; -static enum counter_synapse_action quad8_synapse_actions_list[] = { - [QUAD8_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, - [QUAD8_SYNAPSE_ACTION_RISING_EDGE] = COUNTER_SYNAPSE_ACTION_RISING_EDGE, - [QUAD8_SYNAPSE_ACTION_FALLING_EDGE] = COUNTER_SYNAPSE_ACTION_FALLING_EDGE, - [QUAD8_SYNAPSE_ACTION_BOTH_EDGES] = COUNTER_SYNAPSE_ACTION_BOTH_EDGES +static const enum counter_synapse_action quad8_synapse_actions_list[] = { + COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, }; -static int quad8_action_get(struct counter_device *counter, - struct counter_count *count, struct counter_synapse *synapse, - size_t *action) +static int quad8_action_read(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action *action) { struct quad8_iio *const priv = counter->priv; int err; - size_t function = 0; + enum counter_function function; const size_t signal_a_id = count->synapses[0].signal->id; enum counter_count_direction direction; /* Handle Index signals */ if (synapse->signal->id >= 16) { if (priv->preset_enable[count->id]) - *action = QUAD8_SYNAPSE_ACTION_RISING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; else - *action = QUAD8_SYNAPSE_ACTION_NONE; + *action = COUNTER_SYNAPSE_ACTION_NONE; return 0; } - err = quad8_function_get(counter, count, &function); + err = quad8_function_read(counter, count, &function); if (err) return err; /* Default action mode */ - *action = QUAD8_SYNAPSE_ACTION_NONE; + *action = COUNTER_SYNAPSE_ACTION_NONE; /* Determine action mode based on current count function mode */ switch (function) { - case QUAD8_COUNT_FUNCTION_PULSE_DIRECTION: + case COUNTER_FUNCTION_PULSE_DIRECTION: if (synapse->signal->id == signal_a_id) - *action = QUAD8_SYNAPSE_ACTION_RISING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; break; - case QUAD8_COUNT_FUNCTION_QUADRATURE_X1: + case COUNTER_FUNCTION_QUADRATURE_X1_A: if (synapse->signal->id == signal_a_id) { - quad8_direction_get(counter, count, &direction); + err = quad8_direction_read(counter, count, &direction); + if (err) + return err; if (direction == COUNTER_COUNT_DIRECTION_FORWARD) - *action = QUAD8_SYNAPSE_ACTION_RISING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; else - *action = QUAD8_SYNAPSE_ACTION_FALLING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_FALLING_EDGE; } break; - case QUAD8_COUNT_FUNCTION_QUADRATURE_X2: + case COUNTER_FUNCTION_QUADRATURE_X2_A: if (synapse->signal->id == signal_a_id) - *action = QUAD8_SYNAPSE_ACTION_BOTH_EDGES; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; break; - case QUAD8_COUNT_FUNCTION_QUADRATURE_X4: - *action = QUAD8_SYNAPSE_ACTION_BOTH_EDGES; + case COUNTER_FUNCTION_QUADRATURE_X4: + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; break; + default: + /* should never reach this path */ + return -EINVAL; } return 0; @@ -900,13 +902,14 @@ static const struct counter_ops quad8_ops = { .signal_read = quad8_signal_read, .count_read = quad8_count_read, .count_write = quad8_count_write, - .function_get = quad8_function_get, - .function_set = quad8_function_set, - .action_get = quad8_action_get + .function_read = quad8_function_read, + .function_write = quad8_function_write, + .action_read = quad8_action_read }; static int quad8_index_polarity_get(struct counter_device *counter, - struct counter_signal *signal, size_t *index_polarity) + struct counter_signal *signal, + u32 *index_polarity) { const struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; @@ -917,7 +920,8 @@ static int quad8_index_polarity_get(struct counter_device *counter, } static int quad8_index_polarity_set(struct counter_device *counter, - struct counter_signal *signal, size_t index_polarity) + struct counter_signal *signal, + u32 index_polarity) { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; @@ -938,15 +942,9 @@ static int quad8_index_polarity_set(struct counter_device *counter, return 0; } -static struct counter_signal_enum_ext quad8_index_pol_enum = { - .items = quad8_index_polarity_modes, - .num_items = ARRAY_SIZE(quad8_index_polarity_modes), - .get = quad8_index_polarity_get, - .set = quad8_index_polarity_set -}; - static int quad8_synchronous_mode_get(struct counter_device *counter, - struct counter_signal *signal, size_t *synchronous_mode) + struct counter_signal *signal, + u32 *synchronous_mode) { const struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; @@ -957,7 +955,8 @@ static int quad8_synchronous_mode_get(struct counter_device *counter, } static int quad8_synchronous_mode_set(struct counter_device *counter, - struct counter_signal *signal, size_t synchronous_mode) + struct counter_signal *signal, + u32 synchronous_mode) { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; @@ -984,22 +983,18 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, return 0; } -static struct counter_signal_enum_ext quad8_syn_mode_enum = { - .items = quad8_synchronous_modes, - .num_items = ARRAY_SIZE(quad8_synchronous_modes), - .get = quad8_synchronous_mode_get, - .set = quad8_synchronous_mode_set -}; - -static ssize_t quad8_count_floor_read(struct counter_device *counter, - struct counter_count *count, void *private, char *buf) +static int quad8_count_floor_read(struct counter_device *counter, + struct counter_count *count, u64 *floor) { /* Only a floor of 0 is supported */ - return sprintf(buf, "0\n"); + *floor = 0; + + return 0; } -static int quad8_count_mode_get(struct counter_device *counter, - struct counter_count *count, size_t *cnt_mode) +static int quad8_count_mode_read(struct counter_device *counter, + struct counter_count *count, + enum counter_count_mode *cnt_mode) { const struct quad8_iio *const priv = counter->priv; @@ -1022,35 +1017,39 @@ static int quad8_count_mode_get(struct counter_device *counter, return 0; } -static int quad8_count_mode_set(struct counter_device *counter, - struct counter_count *count, size_t cnt_mode) +static int quad8_count_mode_write(struct counter_device *counter, + struct counter_count *count, + enum counter_count_mode cnt_mode) { struct quad8_iio *const priv = counter->priv; + unsigned int count_mode; unsigned int mode_cfg; const int base_offset = priv->base + 2 * count->id + 1; /* Map Generic Counter count mode to 104-QUAD-8 count mode */ switch (cnt_mode) { case COUNTER_COUNT_MODE_NORMAL: - cnt_mode = 0; + count_mode = 0; break; case COUNTER_COUNT_MODE_RANGE_LIMIT: - cnt_mode = 1; + count_mode = 1; break; case COUNTER_COUNT_MODE_NON_RECYCLE: - cnt_mode = 2; + count_mode = 2; break; case COUNTER_COUNT_MODE_MODULO_N: - cnt_mode = 3; + count_mode = 3; break; + default: + return -EINVAL; } mutex_lock(&priv->lock); - priv->count_mode[count->id] = cnt_mode; + priv->count_mode[count->id] = count_mode; /* Set count mode configuration value */ - mode_cfg = cnt_mode << 1; + mode_cfg = count_mode << 1; /* Add quadrature mode configuration */ if (priv->quadrature_mode[count->id]) @@ -1064,60 +1063,39 @@ static int quad8_count_mode_set(struct counter_device *counter, return 0; } -static struct counter_count_enum_ext quad8_cnt_mode_enum = { - .items = counter_count_mode_str, - .num_items = ARRAY_SIZE(counter_count_mode_str), - .get = quad8_count_mode_get, - .set = quad8_count_mode_set -}; - -static ssize_t quad8_count_direction_read(struct counter_device *counter, - struct counter_count *count, void *priv, char *buf) -{ - enum counter_count_direction dir; - - quad8_direction_get(counter, count, &dir); - - return sprintf(buf, "%s\n", counter_count_direction_str[dir]); -} - -static ssize_t quad8_count_enable_read(struct counter_device *counter, - struct counter_count *count, void *private, char *buf) +static int quad8_count_enable_read(struct counter_device *counter, + struct counter_count *count, u8 *enable) { const struct quad8_iio *const priv = counter->priv; - return sprintf(buf, "%u\n", priv->ab_enable[count->id]); + *enable = priv->ab_enable[count->id]; + + return 0; } -static ssize_t quad8_count_enable_write(struct counter_device *counter, - struct counter_count *count, void *private, const char *buf, size_t len) +static int quad8_count_enable_write(struct counter_device *counter, + struct counter_count *count, u8 enable) { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id; - int err; - bool ab_enable; unsigned int ior_cfg; - err = kstrtobool(buf, &ab_enable); - if (err) - return err; - mutex_lock(&priv->lock); - priv->ab_enable[count->id] = ab_enable; + priv->ab_enable[count->id] = enable; - ior_cfg = ab_enable | priv->preset_enable[count->id] << 1; + ior_cfg = enable | priv->preset_enable[count->id] << 1; /* Load I/O control configuration */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); mutex_unlock(&priv->lock); - return len; + return 0; } static int quad8_error_noise_get(struct counter_device *counter, - struct counter_count *count, size_t *noise_error) + struct counter_count *count, u32 *noise_error) { const struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id + 1; @@ -1127,22 +1105,18 @@ static int quad8_error_noise_get(struct counter_device *counter, return 0; } -static struct counter_count_enum_ext quad8_error_noise_enum = { - .items = quad8_noise_error_states, - .num_items = ARRAY_SIZE(quad8_noise_error_states), - .get = quad8_error_noise_get -}; - -static ssize_t quad8_count_preset_read(struct counter_device *counter, - struct counter_count *count, void *private, char *buf) +static int quad8_count_preset_read(struct counter_device *counter, + struct counter_count *count, u64 *preset) { const struct quad8_iio *const priv = counter->priv; - return sprintf(buf, "%u\n", priv->preset[count->id]); + *preset = priv->preset[count->id]; + + return 0; } -static void quad8_preset_register_set(struct quad8_iio *quad8iio, int id, - unsigned int preset) +static void quad8_preset_register_set(struct quad8_iio *const quad8iio, + const int id, const u64 preset) { const unsigned int base_offset = quad8iio->base + 2 * id; int i; @@ -1157,16 +1131,10 @@ static void quad8_preset_register_set(struct quad8_iio *quad8iio, int id, outb(preset >> (8 * i), base_offset); } -static ssize_t quad8_count_preset_write(struct counter_device *counter, - struct counter_count *count, void *private, const char *buf, size_t len) +static int quad8_count_preset_write(struct counter_device *counter, + struct counter_count *count, u64 preset) { struct quad8_iio *const priv = counter->priv; - unsigned int preset; - int ret; - - ret = kstrtouint(buf, 0, &preset); - if (ret) - return ret; /* Only 24-bit values are supported */ if (preset > 0xFFFFFF) @@ -1178,11 +1146,11 @@ static ssize_t quad8_count_preset_write(struct counter_device *counter, mutex_unlock(&priv->lock); - return len; + return 0; } -static ssize_t quad8_count_ceiling_read(struct counter_device *counter, - struct counter_count *count, void *private, char *buf) +static int quad8_count_ceiling_read(struct counter_device *counter, + struct counter_count *count, u64 *ceiling) { struct quad8_iio *const priv = counter->priv; @@ -1192,26 +1160,23 @@ static ssize_t quad8_count_ceiling_read(struct counter_device *counter, switch (priv->count_mode[count->id]) { case 1: case 3: - mutex_unlock(&priv->lock); - return sprintf(buf, "%u\n", priv->preset[count->id]); + *ceiling = priv->preset[count->id]; + break; + default: + /* By default 0x1FFFFFF (25 bits unsigned) is maximum count */ + *ceiling = 0x1FFFFFF; + break; } mutex_unlock(&priv->lock); - /* By default 0x1FFFFFF (25 bits unsigned) is maximum count */ - return sprintf(buf, "33554431\n"); + return 0; } -static ssize_t quad8_count_ceiling_write(struct counter_device *counter, - struct counter_count *count, void *private, const char *buf, size_t len) +static int quad8_count_ceiling_write(struct counter_device *counter, + struct counter_count *count, u64 ceiling) { struct quad8_iio *const priv = counter->priv; - unsigned int ceiling; - int ret; - - ret = kstrtouint(buf, 0, &ceiling); - if (ret) - return ret; /* Only 24-bit values are supported */ if (ceiling > 0xFFFFFF) @@ -1229,30 +1194,28 @@ static ssize_t quad8_count_ceiling_write(struct counter_device *counter, mutex_unlock(&priv->lock); - return len; + return -EINVAL; } -static ssize_t quad8_count_preset_enable_read(struct counter_device *counter, - struct counter_count *count, void *private, char *buf) +static int quad8_count_preset_enable_read(struct counter_device *counter, + struct counter_count *count, + u8 *preset_enable) { const struct quad8_iio *const priv = counter->priv; - return sprintf(buf, "%u\n", !priv->preset_enable[count->id]); + *preset_enable = !priv->preset_enable[count->id]; + + return 0; } -static ssize_t quad8_count_preset_enable_write(struct counter_device *counter, - struct counter_count *count, void *private, const char *buf, size_t len) +static int quad8_count_preset_enable_write(struct counter_device *counter, + struct counter_count *count, + u8 preset_enable) { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id + 1; - bool preset_enable; - int ret; unsigned int ior_cfg; - ret = kstrtobool(buf, &preset_enable); - if (ret) - return ret; - /* Preset enable is active low in Input/Output Control register */ preset_enable = !preset_enable; @@ -1260,25 +1223,24 @@ static ssize_t quad8_count_preset_enable_write(struct counter_device *counter, priv->preset_enable[count->id] = preset_enable; - ior_cfg = priv->ab_enable[count->id] | (unsigned int)preset_enable << 1; + ior_cfg = priv->ab_enable[count->id] | preset_enable << 1; /* Load I/O control configuration to Input / Output Control Register */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset); mutex_unlock(&priv->lock); - return len; + return 0; } -static ssize_t quad8_signal_cable_fault_read(struct counter_device *counter, - struct counter_signal *signal, - void *private, char *buf) +static int quad8_signal_cable_fault_read(struct counter_device *counter, + struct counter_signal *signal, + u8 *cable_fault) { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; bool disabled; unsigned int status; - unsigned int fault; mutex_lock(&priv->lock); @@ -1295,36 +1257,31 @@ static ssize_t quad8_signal_cable_fault_read(struct counter_device *counter, mutex_unlock(&priv->lock); /* Mask respective channel and invert logic */ - fault = !(status & BIT(channel_id)); + *cable_fault = !(status & BIT(channel_id)); - return sprintf(buf, "%u\n", fault); + return 0; } -static ssize_t quad8_signal_cable_fault_enable_read( - struct counter_device *counter, struct counter_signal *signal, - void *private, char *buf) +static int quad8_signal_cable_fault_enable_read(struct counter_device *counter, + struct counter_signal *signal, + u8 *enable) { const struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; - const unsigned int enb = !!(priv->cable_fault_enable & BIT(channel_id)); - return sprintf(buf, "%u\n", enb); + *enable = !!(priv->cable_fault_enable & BIT(channel_id)); + + return 0; } -static ssize_t quad8_signal_cable_fault_enable_write( - struct counter_device *counter, struct counter_signal *signal, - void *private, const char *buf, size_t len) +static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, + struct counter_signal *signal, + u8 enable) { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; - bool enable; - int ret; unsigned int cable_fault_enable; - ret = kstrtobool(buf, &enable); - if (ret) - return ret; - mutex_lock(&priv->lock); if (enable) @@ -1339,31 +1296,27 @@ static ssize_t quad8_signal_cable_fault_enable_write( mutex_unlock(&priv->lock); - return len; + return 0; } -static ssize_t quad8_signal_fck_prescaler_read(struct counter_device *counter, - struct counter_signal *signal, void *private, char *buf) +static int quad8_signal_fck_prescaler_read(struct counter_device *counter, + struct counter_signal *signal, + u8 *prescaler) { const struct quad8_iio *const priv = counter->priv; - const size_t channel_id = signal->id / 2; - return sprintf(buf, "%u\n", priv->fck_prescaler[channel_id]); + *prescaler = priv->fck_prescaler[signal->id / 2]; + + return 0; } -static ssize_t quad8_signal_fck_prescaler_write(struct counter_device *counter, - struct counter_signal *signal, void *private, const char *buf, - size_t len) +static int quad8_signal_fck_prescaler_write(struct counter_device *counter, + struct counter_signal *signal, + u8 prescaler) { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; const int base_offset = priv->base + 2 * channel_id; - u8 prescaler; - int ret; - - ret = kstrtou8(buf, 0, &prescaler); - if (ret) - return ret; mutex_lock(&priv->lock); @@ -1379,31 +1332,30 @@ static ssize_t quad8_signal_fck_prescaler_write(struct counter_device *counter, mutex_unlock(&priv->lock); - return len; + return 0; } -static const struct counter_signal_ext quad8_signal_ext[] = { - { - .name = "cable_fault", - .read = quad8_signal_cable_fault_read - }, - { - .name = "cable_fault_enable", - .read = quad8_signal_cable_fault_enable_read, - .write = quad8_signal_cable_fault_enable_write - }, - { - .name = "filter_clock_prescaler", - .read = quad8_signal_fck_prescaler_read, - .write = quad8_signal_fck_prescaler_write - } +static struct counter_comp quad8_signal_ext[] = { + COUNTER_COMP_SIGNAL_BOOL("cable_fault", quad8_signal_cable_fault_read, + NULL), + COUNTER_COMP_SIGNAL_BOOL("cable_fault_enable", + quad8_signal_cable_fault_enable_read, + quad8_signal_cable_fault_enable_write), + COUNTER_COMP_SIGNAL_U8("filter_clock_prescaler", + quad8_signal_fck_prescaler_read, + quad8_signal_fck_prescaler_write) }; -static const struct counter_signal_ext quad8_index_ext[] = { - COUNTER_SIGNAL_ENUM("index_polarity", &quad8_index_pol_enum), - COUNTER_SIGNAL_ENUM_AVAILABLE("index_polarity", &quad8_index_pol_enum), - COUNTER_SIGNAL_ENUM("synchronous_mode", &quad8_syn_mode_enum), - COUNTER_SIGNAL_ENUM_AVAILABLE("synchronous_mode", &quad8_syn_mode_enum) +static DEFINE_COUNTER_ENUM(quad8_index_pol_enum, quad8_index_polarity_modes); +static DEFINE_COUNTER_ENUM(quad8_synch_mode_enum, quad8_synchronous_modes); + +static struct counter_comp quad8_index_ext[] = { + COUNTER_COMP_SIGNAL_ENUM("index_polarity", quad8_index_polarity_get, + quad8_index_polarity_set, + quad8_index_pol_enum), + COUNTER_COMP_SIGNAL_ENUM("synchronous_mode", quad8_synchronous_mode_get, + quad8_synchronous_mode_set, + quad8_synch_mode_enum), }; #define QUAD8_QUAD_SIGNAL(_id, _name) { \ @@ -1472,50 +1424,41 @@ static struct counter_synapse quad8_count_synapses[][3] = { QUAD8_COUNT_SYNAPSES(6), QUAD8_COUNT_SYNAPSES(7) }; -static const struct counter_count_ext quad8_count_ext[] = { - { - .name = "ceiling", - .read = quad8_count_ceiling_read, - .write = quad8_count_ceiling_write - }, - { - .name = "floor", - .read = quad8_count_floor_read - }, - COUNTER_COUNT_ENUM("count_mode", &quad8_cnt_mode_enum), - COUNTER_COUNT_ENUM_AVAILABLE("count_mode", &quad8_cnt_mode_enum), - { - .name = "direction", - .read = quad8_count_direction_read - }, - { - .name = "enable", - .read = quad8_count_enable_read, - .write = quad8_count_enable_write - }, - COUNTER_COUNT_ENUM("error_noise", &quad8_error_noise_enum), - COUNTER_COUNT_ENUM_AVAILABLE("error_noise", &quad8_error_noise_enum), - { - .name = "preset", - .read = quad8_count_preset_read, - .write = quad8_count_preset_write - }, - { - .name = "preset_enable", - .read = quad8_count_preset_enable_read, - .write = quad8_count_preset_enable_write - } +static const enum counter_count_mode quad8_cnt_modes[] = { + COUNTER_COUNT_MODE_NORMAL, + COUNTER_COUNT_MODE_RANGE_LIMIT, + COUNTER_COUNT_MODE_NON_RECYCLE, + COUNTER_COUNT_MODE_MODULO_N, +}; + +static DEFINE_COUNTER_AVAILABLE(quad8_count_mode_available, quad8_cnt_modes); + +static DEFINE_COUNTER_ENUM(quad8_error_noise_enum, quad8_noise_error_states); + +static struct counter_comp quad8_count_ext[] = { + COUNTER_COMP_CEILING(quad8_count_ceiling_read, + quad8_count_ceiling_write), + COUNTER_COMP_FLOOR(quad8_count_floor_read, NULL), + COUNTER_COMP_COUNT_MODE(quad8_count_mode_read, quad8_count_mode_write, + quad8_count_mode_available), + COUNTER_COMP_DIRECTION(quad8_direction_read), + COUNTER_COMP_ENABLE(quad8_count_enable_read, quad8_count_enable_write), + COUNTER_COMP_COUNT_ENUM("error_noise", quad8_error_noise_get, NULL, + quad8_error_noise_enum), + COUNTER_COMP_PRESET(quad8_count_preset_read, quad8_count_preset_write), + COUNTER_COMP_PRESET_ENABLE(quad8_count_preset_enable_read, + quad8_count_preset_enable_write), }; -#define QUAD8_COUNT(_id, _cntname) { \ - .id = (_id), \ - .name = (_cntname), \ - .functions_list = quad8_count_functions_list, \ - .num_functions = ARRAY_SIZE(quad8_count_functions_list), \ - .synapses = quad8_count_synapses[(_id)], \ - .num_synapses = 2, \ - .ext = quad8_count_ext, \ - .num_ext = ARRAY_SIZE(quad8_count_ext) \ +#define QUAD8_COUNT(_id, _cntname) { \ + .id = (_id), \ + .name = (_cntname), \ + .functions_list = quad8_functions_list, \ + .num_functions = ARRAY_SIZE(quad8_functions_list), \ + .synapses = quad8_count_synapses[(_id)], \ + .num_synapses = 2, \ + .ext = quad8_count_ext, \ + .num_ext = ARRAY_SIZE(quad8_count_ext) \ } static struct counter_count quad8_counts[] = { diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile index 0a393f71e481..cbe1d06af6a9 100644 --- a/drivers/counter/Makefile +++ b/drivers/counter/Makefile @@ -4,6 +4,7 @@ # obj-$(CONFIG_COUNTER) += counter.o +counter-y := counter-core.o counter-sysfs.o obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c new file mode 100644 index 000000000000..78e07588717b --- /dev/null +++ b/drivers/counter/counter-core.c @@ -0,0 +1,153 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Generic Counter interface + * Copyright (C) 2020 William Breathitt Gray + */ +#include <linux/counter.h> +#include <linux/device.h> +#include <linux/export.h> +#include <linux/gfp.h> +#include <linux/idr.h> +#include <linux/init.h> +#include <linux/module.h> + +#include "counter-sysfs.h" + +/* Provides a unique ID for each counter device */ +static DEFINE_IDA(counter_ida); + +static void counter_device_release(struct device *dev) +{ + struct counter_device *const counter = dev_get_drvdata(dev); + + counter_chrdev_remove(counter); + ida_simple_remove(&counter_ida, counter->id); +} + +static struct device_type counter_device_type = { + .name = "counter_device", + .release = counter_device_release +}; + +static struct bus_type counter_bus_type = { + .name = "counter" +}; + +/** + * counter_register - register Counter to the system + * @counter: pointer to Counter to register + * + * This function registers a Counter to the system. A sysfs "counter" directory + * will be created and populated with sysfs attributes correlating with the + * Counter Signals, Synapses, and Counts respectively. + */ +int counter_register(struct counter_device *const counter) +{ + struct device *const dev = &counter->dev; + int err; + + /* Acquire unique ID */ + counter->id = ida_simple_get(&counter_ida, 0, 0, GFP_KERNEL); + if (counter->id < 0) + return counter->id; + + /* Configure device structure for Counter */ + dev->type = &counter_device_type; + dev->bus = &counter_bus_type; + if (counter->parent) { + dev->parent = counter->parent; + dev->of_node = counter->parent->of_node; + } + dev_set_name(dev, "counter%d", counter->id); + device_initialize(dev); + dev_set_drvdata(dev, counter); + + /* Add Counter sysfs attributes */ + err = counter_sysfs_add(counter); + if (err < 0) + goto err_free_id; + + /* Add device to system */ + err = device_add(dev); + if (err < 0) + goto err_free_id; + + return 0; + +err_free_id: + put_device(dev); + return err; +} +EXPORT_SYMBOL_GPL(counter_register); + +/** + * counter_unregister - unregister Counter from the system + * @counter: pointer to Counter to unregister + * + * The Counter is unregistered from the system; all allocated memory is freed. + */ +void counter_unregister(struct counter_device *const counter) +{ + if (!counter) + return; + + device_unregister(&counter->dev); +} +EXPORT_SYMBOL_GPL(counter_unregister); + +static void devm_counter_unregister(struct device *dev, void *res) +{ + counter_unregister(*(struct counter_device **)res); +} + +/** + * devm_counter_register - Resource-managed counter_register + * @dev: device to allocate counter_device for + * @counter: pointer to Counter to register + * + * Managed counter_register. The Counter registered with this function is + * automatically unregistered on driver detach. This function calls + * counter_register internally. Refer to that function for more information. + * + * RETURNS: + * 0 on success, negative error number on failure. + */ +int devm_counter_register(struct device *dev, + struct counter_device *const counter) +{ + struct counter_device **ptr; + int err; + + ptr = devres_alloc(devm_counter_unregister, sizeof(*ptr), GFP_KERNEL); + if (!ptr) + return -ENOMEM; + + err = counter_register(counter); + if (err < 0) { + devres_free(ptr); + return err; + } + + *ptr = counter; + devres_add(dev, ptr); + + return 0; +} +EXPORT_SYMBOL_GPL(devm_counter_register); + +static int __init counter_init(void) +{ + return bus_register(&counter_bus_type); +} + +static void __exit counter_exit(void) +{ + bus_unregister(&counter_bus_type); +} + +subsys_initcall(counter_init); +module_exit(counter_exit); + +MODULE_AUTHOR("William Breathitt Gray <vilhelm.gray@gmail.com>"); +MODULE_DESCRIPTION("Generic Counter interface"); +MODULE_LICENSE("GPL v2"); diff --git a/drivers/counter/counter-sysfs.c b/drivers/counter/counter-sysfs.c new file mode 100644 index 000000000000..654afa91ae9f --- /dev/null +++ b/drivers/counter/counter-sysfs.c @@ -0,0 +1,837 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Generic Counter sysfs interface + * Copyright (C) 2020 William Breathitt Gray + */ +#include <linux/counter.h> +#include <linux/device.h> +#include <linux/err.h> +#include <linux/gfp.h> +#include <linux/kernel.h> +#include <linux/list.h> +#include <linux/string.h> +#include <linux/sysfs.h> +#include <linux/types.h> + +#include "counter-sysfs.h" + +/** + * struct counter_attribute - Counter sysfs attribute + * @dev_attr: device attribute for sysfs + * @l: node to add Counter attribute to attribute group list + * @comp: Counter component callbacks and data + * @scope: Counter scope of the attribute + * @parent: pointer to the parent component + */ +struct counter_attribute { + struct device_attribute dev_attr; + struct list_head l; + + struct counter_comp comp; + __u8 scope; + void *parent; +}; + +#define to_counter_attribute(_dev_attr) \ + container_of(_dev_attr, struct counter_attribute, dev_attr) + +/** + * struct counter_attribute_group - container for attribute group + * @name: name of the attribute group + * @attr_list: list to keep track of created attributes + * @num_attr: number of attributes + */ +struct counter_attribute_group { + const char *name; + struct list_head attr_list; + size_t num_attr; +}; + +static const char *const counter_function_str[] = { + [COUNTER_FUNCTION_INCREASE] = "increase", + [COUNTER_FUNCTION_DECREASE] = "decrease", + [COUNTER_FUNCTION_PULSE_DIRECTION] = "pulse-direction", + [COUNTER_FUNCTION_QUADRATURE_X1_A] = "quadrature x1 a", + [COUNTER_FUNCTION_QUADRATURE_X1_B] = "quadrature x1 b", + [COUNTER_FUNCTION_QUADRATURE_X2_A] = "quadrature x2 a", + [COUNTER_FUNCTION_QUADRATURE_X2_B] = "quadrature x2 b", + [COUNTER_FUNCTION_QUADRATURE_X4] = "quadrature x4" +}; + +static const char *const counter_signal_value_str[] = { + [COUNTER_SIGNAL_LEVEL_LOW] = "low", + [COUNTER_SIGNAL_LEVEL_HIGH] = "high" +}; + +static const char *const counter_synapse_action_str[] = { + [COUNTER_SYNAPSE_ACTION_NONE] = "none", + [COUNTER_SYNAPSE_ACTION_RISING_EDGE] = "rising edge", + [COUNTER_SYNAPSE_ACTION_FALLING_EDGE] = "falling edge", + [COUNTER_SYNAPSE_ACTION_BOTH_EDGES] = "both edges" +}; + +static const char *const counter_count_direction_str[] = { + [COUNTER_COUNT_DIRECTION_FORWARD] = "forward", + [COUNTER_COUNT_DIRECTION_BACKWARD] = "backward" +}; + +static const char *const counter_count_mode_str[] = { + [COUNTER_COUNT_MODE_NORMAL] = "normal", + [COUNTER_COUNT_MODE_RANGE_LIMIT] = "range limit", + [COUNTER_COUNT_MODE_NON_RECYCLE] = "non-recycle", + [COUNTER_COUNT_MODE_MODULO_N] = "modulo-n" +}; + +static ssize_t counter_comp_u8_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + const struct counter_attribute *const a = to_counter_attribute(attr); + struct counter_device *const counter = dev_get_drvdata(dev); + int err; + u8 data = 0; + + switch (a->scope) { + case COUNTER_SCOPE_DEVICE: + err = a->comp.device_u8_read(counter, &data); + break; + case COUNTER_SCOPE_SIGNAL: + err = a->comp.signal_u8_read(counter, a->parent, &data); + break; + case COUNTER_SCOPE_COUNT: + err = a->comp.count_u8_read(counter, a->parent, &data); + break; + } + if (err < 0) + return err; + + if (a->comp.type == COUNTER_COMP_BOOL) + data = !!data; + + return sprintf(buf, "%u\n", (unsigned int)data); +} + +static ssize_t counter_comp_u8_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t len) +{ + const struct counter_attribute *const a = to_counter_attribute(attr); + struct counter_device *const counter = dev_get_drvdata(dev); + int err; + bool bool_data = 0; + u8 data = 0; + + if (a->comp.type == COUNTER_COMP_BOOL) { + err = kstrtobool(buf, &bool_data); + data = bool_data; + } else + err = kstrtou8(buf, 0, &data); + if (err < 0) + return err; + + switch (a->scope) { + case COUNTER_SCOPE_DEVICE: + err = a->comp.device_u8_write(counter, data); + break; + case COUNTER_SCOPE_SIGNAL: + err = a->comp.signal_u8_write(counter, a->parent, data); + break; + case COUNTER_SCOPE_COUNT: + err = a->comp.count_u8_write(counter, a->parent, data); + break; + } + if (err < 0) + return err; + + return len; +} + +static ssize_t counter_comp_u32_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + const struct counter_attribute *const a = to_counter_attribute(attr); + struct counter_device *const counter = dev_get_drvdata(dev); + const struct counter_available *const avail = a->comp.priv; + int err; + u32 data = 0; + + switch (a->scope) { + case COUNTER_SCOPE_DEVICE: + err = a->comp.device_u32_read(counter, &data); + break; + case COUNTER_SCOPE_SIGNAL: + err = a->comp.signal_u32_read(counter, a->parent, &data); + break; + case COUNTER_SCOPE_COUNT: + if (a->comp.type == COUNTER_COMP_SYNAPSE_ACTION) + err = a->comp.action_read(counter, a->parent, + a->comp.priv, &data); + else + err = a->comp.count_u32_read(counter, a->parent, &data); + break; + } + if (err < 0) + return err; + + switch (a->comp.type) { + case COUNTER_COMP_FUNCTION: + return sprintf(buf, "%s\n", counter_function_str[data]); + case COUNTER_COMP_SIGNAL_LEVEL: + return sprintf(buf, "%s\n", counter_signal_value_str[data]); + case COUNTER_COMP_SYNAPSE_ACTION: + return sprintf(buf, "%s\n", counter_synapse_action_str[data]); + case COUNTER_COMP_ENUM: + return sprintf(buf, "%s\n", avail->strs[data]); + case COUNTER_COMP_COUNT_DIRECTION: + return sprintf(buf, "%s\n", counter_count_direction_str[data]); + case COUNTER_COMP_COUNT_MODE: + return sprintf(buf, "%s\n", counter_count_mode_str[data]); + default: + break; + } + + return sprintf(buf, "%u\n", (unsigned int)data); +} + +static int find_in_string_array(u32 *const enum_item, const u32 *const enums, + const size_t num_enums, const char *const buf, + const char *const string_array[]) +{ + size_t index; + + for (index = 0; index < num_enums; index++) { + *enum_item = enums[index]; + if (sysfs_streq(buf, string_array[*enum_item])) + return 0; + } + + return -EINVAL; +} + +static ssize_t counter_comp_u32_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t len) +{ + const struct counter_attribute *const a = to_counter_attribute(attr); + struct counter_device *const counter = dev_get_drvdata(dev); + struct counter_count *const count = a->parent; + struct counter_synapse *const synapse = a->comp.priv; + const struct counter_available *const avail = a->comp.priv; + int err; + u32 data = 0; + + switch (a->comp.type) { + case COUNTER_COMP_FUNCTION: + err = find_in_string_array(&data, count->functions_list, + count->num_functions, buf, + counter_function_str); + break; + case COUNTER_COMP_SYNAPSE_ACTION: + err = find_in_string_array(&data, synapse->actions_list, + synapse->num_actions, buf, + counter_synapse_action_str); + break; + case COUNTER_COMP_ENUM: + err = __sysfs_match_string(avail->strs, avail->num_items, buf); + data = err; + break; + case COUNTER_COMP_COUNT_MODE: + err = find_in_string_array(&data, avail->enums, + avail->num_items, buf, + counter_count_mode_str); + break; + default: + err = kstrtou32(buf, 0, &data); + break; + } + if (err < 0) + return err; + + switch (a->scope) { + case COUNTER_SCOPE_DEVICE: + err = a->comp.device_u32_write(counter, data); + break; + case COUNTER_SCOPE_SIGNAL: + err = a->comp.signal_u32_write(counter, a->parent, data); + break; + case COUNTER_SCOPE_COUNT: + if (a->comp.type == COUNTER_COMP_SYNAPSE_ACTION) + err = a->comp.action_write(counter, count, synapse, + data); + else + err = a->comp.count_u32_write(counter, count, data); + break; + } + if (err < 0) + return err; + + return len; +} + +static ssize_t counter_comp_u64_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + const struct counter_attribute *const a = to_counter_attribute(attr); + struct counter_device *const counter = dev_get_drvdata(dev); + int err; + u64 data = 0; + + switch (a->scope) { + case COUNTER_SCOPE_DEVICE: + err = a->comp.device_u64_read(counter, &data); + break; + case COUNTER_SCOPE_SIGNAL: + err = a->comp.signal_u64_read(counter, a->parent, &data); + break; + case COUNTER_SCOPE_COUNT: + err = a->comp.count_u64_read(counter, a->parent, &data); + break; + } + if (err < 0) + return err; + + return sprintf(buf, "%llu\n", (unsigned long long)data); +} + +static ssize_t counter_comp_u64_store(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t len) +{ + const struct counter_attribute *const a = to_counter_attribute(attr); + struct counter_device *const counter = dev_get_drvdata(dev); + int err; + u64 data = 0; + + err = kstrtou64(buf, 0, &data); + if (err < 0) + return err; + + switch (a->scope) { + case COUNTER_SCOPE_DEVICE: + err = a->comp.device_u64_write(counter, data); + break; + case COUNTER_SCOPE_SIGNAL: + err = a->comp.signal_u64_write(counter, a->parent, data); + break; + case COUNTER_SCOPE_COUNT: + err = a->comp.count_u64_write(counter, a->parent, data); + break; + } + if (err < 0) + return err; + + return len; +} + +static ssize_t enums_available_show(const u32 *const enums, + const size_t num_enums, + const char *const strs[], char *buf) +{ + size_t len = 0; + size_t index; + + for (index = 0; index < num_enums; index++) + len += sprintf(buf + len, "%s\n", strs[enums[index]]); + + return len; +} + +static ssize_t strs_available_show(const struct counter_available *const avail, + char *buf) +{ + size_t len = 0; + size_t index; + + for (index = 0; index < avail->num_items; index++) + len += sprintf(buf + len, "%s\n", avail->strs[index]); + + return len; +} + +static ssize_t counter_comp_available_show(struct device *dev, + struct device_attribute *attr, + char *buf) +{ + const struct counter_attribute *const a = to_counter_attribute(attr); + const struct counter_count *const count = a->parent; + const struct counter_synapse *const synapse = a->comp.priv; + const struct counter_available *const avail = a->comp.priv; + + switch (a->comp.type) { + case COUNTER_COMP_FUNCTION: + return enums_available_show(count->functions_list, + count->num_functions, + counter_function_str, buf); + case COUNTER_COMP_SYNAPSE_ACTION: + return enums_available_show(synapse->actions_list, + synapse->num_actions, + counter_synapse_action_str, buf); + case COUNTER_COMP_ENUM: + return strs_available_show(avail, buf); + case COUNTER_COMP_COUNT_MODE: + return enums_available_show(avail->enums, avail->num_items, + counter_count_mode_str, buf); + default: + break; + } + + return -EINVAL; +} + +static int counter_avail_attr_create(struct device *const dev, + struct counter_attribute_group *const group, + const struct counter_comp *const comp, void *const parent) +{ + struct counter_attribute *counter_attr; + struct device_attribute *dev_attr; + + /* Allocate Counter attribute */ + counter_attr = devm_kzalloc(dev, sizeof(*counter_attr), GFP_KERNEL); + if (!counter_attr) + return -ENOMEM; + + /* Configure Counter attribute */ + counter_attr->comp.type = comp->type; + counter_attr->comp.priv = comp->priv; + counter_attr->parent = parent; + + /* Initialize sysfs attribute */ + dev_attr = &counter_attr->dev_attr; + sysfs_attr_init(&dev_attr->attr); + + /* Configure device attribute */ + dev_attr->attr.name = devm_kasprintf(dev, GFP_KERNEL, "%s_available", + comp->name); + if (!dev_attr->attr.name) + return -ENOMEM; + dev_attr->attr.mode = 0444; + dev_attr->show = counter_comp_available_show; + + /* Store list node */ + list_add(&counter_attr->l, &group->attr_list); + group->num_attr++; + + return 0; +} + +static int counter_attr_create(struct device *const dev, + struct counter_attribute_group *const group, + const struct counter_comp *const comp, + const __u8 scope, void *const parent) +{ + struct counter_attribute *counter_attr; + struct device_attribute *dev_attr; + + /* Allocate Counter attribute */ + counter_attr = devm_kzalloc(dev, sizeof(*counter_attr), GFP_KERNEL); + if (!counter_attr) + return -ENOMEM; + + /* Configure Counter attribute */ + counter_attr->comp = *comp; + counter_attr->scope = scope; + counter_attr->parent = parent; + + /* Configure device attribute */ + dev_attr = &counter_attr->dev_attr; + sysfs_attr_init(&dev_attr->attr); + dev_attr->attr.name = comp->name; + switch (comp->type) { + case COUNTER_COMP_U8: + case COUNTER_COMP_BOOL: + if (comp->device_u8_read) { + dev_attr->attr.mode |= 0444; + dev_attr->show = counter_comp_u8_show; + } + if (comp->device_u8_write) { + dev_attr->attr.mode |= 0200; + dev_attr->store = counter_comp_u8_store; + } + break; + case COUNTER_COMP_SIGNAL_LEVEL: + case COUNTER_COMP_FUNCTION: + case COUNTER_COMP_SYNAPSE_ACTION: + case COUNTER_COMP_ENUM: + case COUNTER_COMP_COUNT_DIRECTION: + case COUNTER_COMP_COUNT_MODE: + if (comp->device_u32_read) { + dev_attr->attr.mode |= 0444; + dev_attr->show = counter_comp_u32_show; + } + if (comp->device_u32_write) { + dev_attr->attr.mode |= 0200; + dev_attr->store = counter_comp_u32_store; + } + break; + case COUNTER_COMP_U64: + if (comp->device_u64_read) { + dev_attr->attr.mode |= 0444; + dev_attr->show = counter_comp_u64_show; + } + if (comp->device_u64_write) { + dev_attr->attr.mode |= 0200; + dev_attr->store = counter_comp_u64_store; + } + break; + } + + /* Store list node */ + list_add(&counter_attr->l, &group->attr_list); + group->num_attr++; + + switch (comp->type) { + case COUNTER_COMP_FUNCTION: + case COUNTER_COMP_SYNAPSE_ACTION: + case COUNTER_COMP_ENUM: + case COUNTER_COMP_COUNT_MODE: + return counter_avail_attr_create(dev, group, comp, parent); + default: + break; + } + + return 0; +} + +static ssize_t counter_comp_name_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + return sprintf(buf, "%s\n", to_counter_attribute(attr)->comp.name); +} + +static int counter_name_attr_create(struct device *const dev, + struct counter_attribute_group *const group, + const char *const name) +{ + struct counter_attribute *counter_attr; + + /* Allocate Counter attribute */ + counter_attr = devm_kzalloc(dev, sizeof(*counter_attr), GFP_KERNEL); + if (!counter_attr) + return -ENOMEM; + + /* Configure Counter attribute */ + counter_attr->comp.name = name; + + /* Configure device attribute */ + sysfs_attr_init(&counter_attr->dev_attr.attr); + counter_attr->dev_attr.attr.name = "name"; + counter_attr->dev_attr.attr.mode = 0444; + counter_attr->dev_attr.show = counter_comp_name_show; + + /* Store list node */ + list_add(&counter_attr->l, &group->attr_list); + group->num_attr++; + + return 0; +} + + +static struct counter_comp counter_signal_comp = { + .type = COUNTER_COMP_SIGNAL_LEVEL, + .name = "signal", +}; + +static int counter_signal_attrs_create(struct counter_device *const counter, + struct counter_attribute_group *const group, + struct counter_signal *const signal) +{ + const __u8 scope = COUNTER_SCOPE_SIGNAL; + struct device *const dev = &counter->dev; + int err; + struct counter_comp comp; + size_t i; + + /* Create main Signal attribute */ + comp = counter_signal_comp; + comp.signal_u32_read = counter->ops->signal_read; + err = counter_attr_create(dev, group, &comp, scope, signal); + if (err < 0) + return err; + + /* Create Signal name attribute */ + err = counter_name_attr_create(dev, group, signal->name); + if (err < 0) + return err; + + /* Create an attribute for each extension */ + for (i = 0; i < signal->num_ext; i++) { + err = counter_attr_create(dev, group, signal->ext + i, scope, + signal); + if (err < 0) + return err; + } + + return 0; +} + +static int counter_sysfs_signals_add(struct counter_device *const counter, + struct counter_attribute_group *const groups) +{ + size_t i; + int err; + + /* Add each Signal */ + for (i = 0; i < counter->num_signals; i++) { + /* Generate Signal attribute directory name */ + groups[i].name = devm_kasprintf(&counter->dev, GFP_KERNEL, + "signal%zu", i); + if (!groups[i].name) + return -ENOMEM; + + /* Create all attributes associated with Signal */ + err = counter_signal_attrs_create(counter, groups + i, + counter->signals + i); + if (err < 0) + return err; + } + + return 0; +} + +static int counter_sysfs_synapses_add(struct counter_device *const counter, + struct counter_attribute_group *const group, + struct counter_count *const count) +{ + const __u8 scope = COUNTER_SCOPE_COUNT; + struct device *const dev = &counter->dev; + size_t i; + struct counter_synapse *synapse; + size_t id; + struct counter_comp comp; + int err; + + /* Add each Synapse */ + for (i = 0; i < count->num_synapses; i++) { + synapse = count->synapses + i; + + /* Generate Synapse action name */ + id = synapse->signal - counter->signals; + comp.name = devm_kasprintf(dev, GFP_KERNEL, "signal%zu_action", + id); + if (!comp.name) + return -ENOMEM; + + /* Create action attribute */ + comp.type = COUNTER_COMP_SYNAPSE_ACTION; + comp.action_read = counter->ops->action_read; + comp.action_write = counter->ops->action_write; + comp.priv = synapse; + err = counter_attr_create(dev, group, &comp, scope, count); + if (err < 0) + return err; + } + + return 0; +} + +static struct counter_comp counter_count_comp = + COUNTER_COMP_COUNT_U64("count", NULL, NULL); + +static struct counter_comp counter_function_comp = { + .type = COUNTER_COMP_FUNCTION, + .name = "function", +}; + +static int counter_count_attrs_create(struct counter_device *const counter, + struct counter_attribute_group *const group, + struct counter_count *const count) +{ + const __u8 scope = COUNTER_SCOPE_COUNT; + struct device *const dev = &counter->dev; + int err; + struct counter_comp comp; + size_t i; + + /* Create main Count attribute */ + comp = counter_count_comp; + comp.count_u64_read = counter->ops->count_read; + comp.count_u64_write = counter->ops->count_write; + err = counter_attr_create(dev, group, &comp, scope, count); + if (err < 0) + return err; + + /* Create Count name attribute */ + err = counter_name_attr_create(dev, group, count->name); + if (err < 0) + return err; + + /* Create Count function attribute */ + comp = counter_function_comp; + comp.count_u32_read = counter->ops->function_read; + comp.count_u32_write = counter->ops->function_write; + err = counter_attr_create(dev, group, &comp, scope, count); + if (err < 0) + return err; + + /* Create an attribute for each extension */ + for (i = 0; i < count->num_ext; i++) { + err = counter_attr_create(dev, group, count->ext + i, scope, + count); + if (err < 0) + return err; + } + + return 0; +} + +static int counter_sysfs_counts_add(struct counter_device *const counter, + struct counter_attribute_group *const groups) +{ + size_t i; + struct counter_count *count; + int err; + + /* Add each Count */ + for (i = 0; i < counter->num_counts; i++) { + count = counter->counts + i; + + /* Generate Count attribute directory name */ + groups[i].name = devm_kasprintf(&counter->dev, GFP_KERNEL, + "count%zu", i); + if (!groups[i].name) + return -ENOMEM; + + /* Add sysfs attributes of the Synapses */ + err = counter_sysfs_synapses_add(counter, groups + i, count); + if (err < 0) + return err; + + /* Create all attributes associated with Count */ + err = counter_count_attrs_create(counter, groups + i, count); + if (err < 0) + return err; + } + + return 0; +} + +static int counter_num_signals_read(struct counter_device *counter, u8 *val) +{ + *val = counter->num_signals; + return 0; +} + +static int counter_num_counts_read(struct counter_device *counter, u8 *val) +{ + *val = counter->num_counts; + return 0; +} + +static struct counter_comp counter_num_signals_comp = + COUNTER_COMP_DEVICE_U8("num_signals", counter_num_signals_read, NULL); + +static struct counter_comp counter_num_counts_comp = + COUNTER_COMP_DEVICE_U8("num_counts", counter_num_counts_read, NULL); + +static int counter_sysfs_attr_add(struct counter_device *const counter, + struct counter_attribute_group *group) +{ + const __u8 scope = COUNTER_SCOPE_DEVICE; + struct device *const dev = &counter->dev; + int err; + size_t i; + + /* Add Signals sysfs attributes */ + err = counter_sysfs_signals_add(counter, group); + if (err < 0) + return err; + group += counter->num_signals; + + /* Add Counts sysfs attributes */ + err = counter_sysfs_counts_add(counter, group); + if (err < 0) + return err; + group += counter->num_counts; + + /* Create name attribute */ + err = counter_name_attr_create(dev, group, counter->name); + if (err < 0) + return err; + + /* Create num_signals attribute */ + err = counter_attr_create(dev, group, &counter_num_signals_comp, scope, + NULL); + if (err < 0) + return err; + + /* Create num_counts attribute */ + err = counter_attr_create(dev, group, &counter_num_counts_comp, scope, + NULL); + if (err < 0) + return err; + + /* Create an attribute for each extension */ + for (i = 0; i < counter->num_ext; i++) { + err = counter_attr_create(dev, group, counter->ext + i, scope, + NULL); + if (err < 0) + return err; + } + + return 0; +} + +/** + * counter_sysfs_add - Adds Counter sysfs attributes to the device structure + * @counter: Pointer to the Counter device structure + * + * Counter sysfs attributes are created and added to the respective device + * structure for later registration to the system. Resource-managed memory + * allocation is performed by this function, and this memory should be freed + * when no longer needed (automatically by a device_unregister call, or + * manually by a devres_release_all call). + */ +int counter_sysfs_add(struct counter_device *const counter) +{ + struct device *const dev = &counter->dev; + const size_t num_groups = counter->num_signals + counter->num_counts + 1; + struct counter_attribute_group *groups; + size_t i, j; + int err; + struct attribute_group *group; + struct counter_attribute *p; + + /* Allocate space for attribute groups (signals, counts, and ext) */ + groups = devm_kcalloc(dev, num_groups, sizeof(*groups), GFP_KERNEL); + if (!groups) + return -ENOMEM; + + /* Initialize attribute lists */ + for (i = 0; i < num_groups; i++) + INIT_LIST_HEAD(&groups[i].attr_list); + + /* Add Counter device sysfs attributes */ + err = counter_sysfs_attr_add(counter, groups); + if (err < 0) + return err; + + /* Allocate attribute groups for association with device */ + dev->groups = devm_kcalloc(dev, num_groups + 1, sizeof(*dev->groups), + GFP_KERNEL); + if (!dev->groups) + return -ENOMEM; + + /* Prepare each group of attributes for association */ + for (i = 0; i < num_groups; i++) { + /* Allocate space for attribute group */ + group = devm_kzalloc(dev, sizeof(*group), GFP_KERNEL); + if (!group) + return -ENOMEM; + group->name = groups[i].name; + + /* Allocate space for attribute pointers */ + group->attrs = devm_kcalloc(dev, groups[i].num_attr + 1, + sizeof(*group->attrs), GFP_KERNEL); + if (!group->attrs) + return -ENOMEM; + + /* Add attribute pointers to attribute group */ + j = 0; + list_for_each_entry(p, &groups[i].attr_list, l) + group->attrs[j++] = &p->dev_attr.attr; + + /* Associate attribute group */ + dev->groups[i] = group; + } + + return 0; +} diff --git a/drivers/counter/counter-sysfs.h b/drivers/counter/counter-sysfs.h new file mode 100644 index 000000000000..14fe566aca0e --- /dev/null +++ b/drivers/counter/counter-sysfs.h @@ -0,0 +1,13 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * Counter sysfs interface + * Copyright (C) 2020 William Breathitt Gray + */ +#ifndef _COUNTER_SYSFS_H_ +#define _COUNTER_SYSFS_H_ + +#include <linux/counter.h> + +int counter_sysfs_add(struct counter_device *const counter); + +#endif /* _COUNTER_SYSFS_H_ */ diff --git a/drivers/counter/counter.c b/drivers/counter/counter.c deleted file mode 100644 index 6a683d086008..000000000000 --- a/drivers/counter/counter.c +++ /dev/null @@ -1,1496 +0,0 @@ -// SPDX-License-Identifier: GPL-2.0 -/* - * Generic Counter interface - * Copyright (C) 2018 William Breathitt Gray - */ -#include <linux/counter.h> -#include <linux/device.h> -#include <linux/err.h> -#include <linux/export.h> -#include <linux/fs.h> -#include <linux/gfp.h> -#include <linux/idr.h> -#include <linux/init.h> -#include <linux/kernel.h> -#include <linux/list.h> -#include <linux/module.h> -#include <linux/printk.h> -#include <linux/slab.h> -#include <linux/string.h> -#include <linux/sysfs.h> -#include <linux/types.h> - -const char *const counter_count_direction_str[2] = { - [COUNTER_COUNT_DIRECTION_FORWARD] = "forward", - [COUNTER_COUNT_DIRECTION_BACKWARD] = "backward" -}; -EXPORT_SYMBOL_GPL(counter_count_direction_str); - -const char *const counter_count_mode_str[4] = { - [COUNTER_COUNT_MODE_NORMAL] = "normal", - [COUNTER_COUNT_MODE_RANGE_LIMIT] = "range limit", - [COUNTER_COUNT_MODE_NON_RECYCLE] = "non-recycle", - [COUNTER_COUNT_MODE_MODULO_N] = "modulo-n" -}; -EXPORT_SYMBOL_GPL(counter_count_mode_str); - -ssize_t counter_signal_enum_read(struct counter_device *counter, - struct counter_signal *signal, void *priv, - char *buf) -{ - const struct counter_signal_enum_ext *const e = priv; - int err; - size_t index; - - if (!e->get) - return -EINVAL; - - err = e->get(counter, signal, &index); - if (err) - return err; - - if (index >= e->num_items) - return -EINVAL; - - return sprintf(buf, "%s\n", e->items[index]); -} -EXPORT_SYMBOL_GPL(counter_signal_enum_read); - -ssize_t counter_signal_enum_write(struct counter_device *counter, - struct counter_signal *signal, void *priv, - const char *buf, size_t len) -{ - const struct counter_signal_enum_ext *const e = priv; - ssize_t index; - int err; - - if (!e->set) - return -EINVAL; - - index = __sysfs_match_string(e->items, e->num_items, buf); - if (index < 0) - return index; - - err = e->set(counter, signal, index); - if (err) - return err; - - return len; -} -EXPORT_SYMBOL_GPL(counter_signal_enum_write); - -ssize_t counter_signal_enum_available_read(struct counter_device *counter, - struct counter_signal *signal, - void *priv, char *buf) -{ - const struct counter_signal_enum_ext *const e = priv; - size_t i; - size_t len = 0; - - if (!e->num_items) - return 0; - - for (i = 0; i < e->num_items; i++) - len += sprintf(buf + len, "%s\n", e->items[i]); - - return len; -} -EXPORT_SYMBOL_GPL(counter_signal_enum_available_read); - -ssize_t counter_count_enum_read(struct counter_device *counter, - struct counter_count *count, void *priv, - char *buf) -{ - const struct counter_count_enum_ext *const e = priv; - int err; - size_t index; - - if (!e->get) - return -EINVAL; - - err = e->get(counter, count, &index); - if (err) - return err; - - if (index >= e->num_items) - return -EINVAL; - - return sprintf(buf, "%s\n", e->items[index]); -} -EXPORT_SYMBOL_GPL(counter_count_enum_read); - -ssize_t counter_count_enum_write(struct counter_device *counter, - struct counter_count *count, void *priv, - const char *buf, size_t len) -{ - const struct counter_count_enum_ext *const e = priv; - ssize_t index; - int err; - - if (!e->set) - return -EINVAL; - - index = __sysfs_match_string(e->items, e->num_items, buf); - if (index < 0) - return index; - - err = e->set(counter, count, index); - if (err) - return err; - - return len; -} -EXPORT_SYMBOL_GPL(counter_count_enum_write); - -ssize_t counter_count_enum_available_read(struct counter_device *counter, - struct counter_count *count, - void *priv, char *buf) -{ - const struct counter_count_enum_ext *const e = priv; - size_t i; - size_t len = 0; - - if (!e->num_items) - return 0; - - for (i = 0; i < e->num_items; i++) - len += sprintf(buf + len, "%s\n", e->items[i]); - - return len; -} -EXPORT_SYMBOL_GPL(counter_count_enum_available_read); - -ssize_t counter_device_enum_read(struct counter_device *counter, void *priv, - char *buf) -{ - const struct counter_device_enum_ext *const e = priv; - int err; - size_t index; - - if (!e->get) - return -EINVAL; - - err = e->get(counter, &index); - if (err) - return err; - - if (index >= e->num_items) - return -EINVAL; - - return sprintf(buf, "%s\n", e->items[index]); -} -EXPORT_SYMBOL_GPL(counter_device_enum_read); - -ssize_t counter_device_enum_write(struct counter_device *counter, void *priv, - const char *buf, size_t len) -{ - const struct counter_device_enum_ext *const e = priv; - ssize_t index; - int err; - - if (!e->set) - return -EINVAL; - - index = __sysfs_match_string(e->items, e->num_items, buf); - if (index < 0) - return index; - - err = e->set(counter, index); - if (err) - return err; - - return len; -} -EXPORT_SYMBOL_GPL(counter_device_enum_write); - -ssize_t counter_device_enum_available_read(struct counter_device *counter, - void *priv, char *buf) -{ - const struct counter_device_enum_ext *const e = priv; - size_t i; - size_t len = 0; - - if (!e->num_items) - return 0; - - for (i = 0; i < e->num_items; i++) - len += sprintf(buf + len, "%s\n", e->items[i]); - - return len; -} -EXPORT_SYMBOL_GPL(counter_device_enum_available_read); - -struct counter_attr_parm { - struct counter_device_attr_group *group; - const char *prefix; - const char *name; - ssize_t (*show)(struct device *dev, struct device_attribute *attr, - char *buf); - ssize_t (*store)(struct device *dev, struct device_attribute *attr, - const char *buf, size_t len); - void *component; -}; - -struct counter_device_attr { - struct device_attribute dev_attr; - struct list_head l; - void *component; -}; - -static int counter_attribute_create(const struct counter_attr_parm *const parm) -{ - struct counter_device_attr *counter_attr; - struct device_attribute *dev_attr; - int err; - struct list_head *const attr_list = &parm->group->attr_list; - - /* Allocate a Counter device attribute */ - counter_attr = kzalloc(sizeof(*counter_attr), GFP_KERNEL); - if (!counter_attr) - return -ENOMEM; - dev_attr = &counter_attr->dev_attr; - - sysfs_attr_init(&dev_attr->attr); - - /* Configure device attribute */ - dev_attr->attr.name = kasprintf(GFP_KERNEL, "%s%s", parm->prefix, - parm->name); - if (!dev_attr->attr.name) { - err = -ENOMEM; - goto err_free_counter_attr; - } - if (parm->show) { - dev_attr->attr.mode |= 0444; - dev_attr->show = parm->show; - } - if (parm->store) { - dev_attr->attr.mode |= 0200; - dev_attr->store = parm->store; - } - - /* Store associated Counter component with attribute */ - counter_attr->component = parm->component; - - /* Keep track of the attribute for later cleanup */ - list_add(&counter_attr->l, attr_list); - parm->group->num_attr++; - - return 0; - -err_free_counter_attr: - kfree(counter_attr); - return err; -} - -#define to_counter_attr(_dev_attr) \ - container_of(_dev_attr, struct counter_device_attr, dev_attr) - -struct counter_signal_unit { - struct counter_signal *signal; -}; - -static const char *const counter_signal_value_str[] = { - [COUNTER_SIGNAL_LOW] = "low", - [COUNTER_SIGNAL_HIGH] = "high" -}; - -static ssize_t counter_signal_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - struct counter_device *const counter = dev_get_drvdata(dev); - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_signal_unit *const component = devattr->component; - struct counter_signal *const signal = component->signal; - int err; - enum counter_signal_value val; - - err = counter->ops->signal_read(counter, signal, &val); - if (err) - return err; - - return sprintf(buf, "%s\n", counter_signal_value_str[val]); -} - -struct counter_name_unit { - const char *name; -}; - -static ssize_t counter_device_attr_name_show(struct device *dev, - struct device_attribute *attr, - char *buf) -{ - const struct counter_name_unit *const comp = to_counter_attr(attr)->component; - - return sprintf(buf, "%s\n", comp->name); -} - -static int counter_name_attribute_create( - struct counter_device_attr_group *const group, - const char *const name) -{ - struct counter_name_unit *name_comp; - struct counter_attr_parm parm; - int err; - - /* Skip if no name */ - if (!name) - return 0; - - /* Allocate name attribute component */ - name_comp = kmalloc(sizeof(*name_comp), GFP_KERNEL); - if (!name_comp) - return -ENOMEM; - name_comp->name = name; - - /* Allocate Signal name attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = "name"; - parm.show = counter_device_attr_name_show; - parm.store = NULL; - parm.component = name_comp; - err = counter_attribute_create(&parm); - if (err) - goto err_free_name_comp; - - return 0; - -err_free_name_comp: - kfree(name_comp); - return err; -} - -struct counter_signal_ext_unit { - struct counter_signal *signal; - const struct counter_signal_ext *ext; -}; - -static ssize_t counter_signal_ext_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_signal_ext_unit *const comp = devattr->component; - const struct counter_signal_ext *const ext = comp->ext; - - return ext->read(dev_get_drvdata(dev), comp->signal, ext->priv, buf); -} - -static ssize_t counter_signal_ext_store(struct device *dev, - struct device_attribute *attr, - const char *buf, size_t len) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_signal_ext_unit *const comp = devattr->component; - const struct counter_signal_ext *const ext = comp->ext; - - return ext->write(dev_get_drvdata(dev), comp->signal, ext->priv, buf, - len); -} - -static void counter_device_attr_list_free(struct list_head *attr_list) -{ - struct counter_device_attr *p, *n; - - list_for_each_entry_safe(p, n, attr_list, l) { - /* free attribute name and associated component memory */ - kfree(p->dev_attr.attr.name); - kfree(p->component); - list_del(&p->l); - kfree(p); - } -} - -static int counter_signal_ext_register( - struct counter_device_attr_group *const group, - struct counter_signal *const signal) -{ - const size_t num_ext = signal->num_ext; - size_t i; - const struct counter_signal_ext *ext; - struct counter_signal_ext_unit *signal_ext_comp; - struct counter_attr_parm parm; - int err; - - /* Create an attribute for each extension */ - for (i = 0 ; i < num_ext; i++) { - ext = signal->ext + i; - - /* Allocate signal_ext attribute component */ - signal_ext_comp = kmalloc(sizeof(*signal_ext_comp), GFP_KERNEL); - if (!signal_ext_comp) { - err = -ENOMEM; - goto err_free_attr_list; - } - signal_ext_comp->signal = signal; - signal_ext_comp->ext = ext; - - /* Allocate a Counter device attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = ext->name; - parm.show = (ext->read) ? counter_signal_ext_show : NULL; - parm.store = (ext->write) ? counter_signal_ext_store : NULL; - parm.component = signal_ext_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(signal_ext_comp); - goto err_free_attr_list; - } - } - - return 0; - -err_free_attr_list: - counter_device_attr_list_free(&group->attr_list); - return err; -} - -static int counter_signal_attributes_create( - struct counter_device_attr_group *const group, - const struct counter_device *const counter, - struct counter_signal *const signal) -{ - struct counter_signal_unit *signal_comp; - struct counter_attr_parm parm; - int err; - - /* Allocate Signal attribute component */ - signal_comp = kmalloc(sizeof(*signal_comp), GFP_KERNEL); - if (!signal_comp) - return -ENOMEM; - signal_comp->signal = signal; - - /* Create main Signal attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = "signal"; - parm.show = (counter->ops->signal_read) ? counter_signal_show : NULL; - parm.store = NULL; - parm.component = signal_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(signal_comp); - return err; - } - - /* Create Signal name attribute */ - err = counter_name_attribute_create(group, signal->name); - if (err) - goto err_free_attr_list; - - /* Register Signal extension attributes */ - err = counter_signal_ext_register(group, signal); - if (err) - goto err_free_attr_list; - - return 0; - -err_free_attr_list: - counter_device_attr_list_free(&group->attr_list); - return err; -} - -static int counter_signals_register( - struct counter_device_attr_group *const groups_list, - const struct counter_device *const counter) -{ - const size_t num_signals = counter->num_signals; - size_t i; - struct counter_signal *signal; - const char *name; - int err; - - /* Register each Signal */ - for (i = 0; i < num_signals; i++) { - signal = counter->signals + i; - - /* Generate Signal attribute directory name */ - name = kasprintf(GFP_KERNEL, "signal%d", signal->id); - if (!name) { - err = -ENOMEM; - goto err_free_attr_groups; - } - groups_list[i].attr_group.name = name; - - /* Create all attributes associated with Signal */ - err = counter_signal_attributes_create(groups_list + i, counter, - signal); - if (err) - goto err_free_attr_groups; - } - - return 0; - -err_free_attr_groups: - do { - kfree(groups_list[i].attr_group.name); - counter_device_attr_list_free(&groups_list[i].attr_list); - } while (i--); - return err; -} - -static const char *const counter_synapse_action_str[] = { - [COUNTER_SYNAPSE_ACTION_NONE] = "none", - [COUNTER_SYNAPSE_ACTION_RISING_EDGE] = "rising edge", - [COUNTER_SYNAPSE_ACTION_FALLING_EDGE] = "falling edge", - [COUNTER_SYNAPSE_ACTION_BOTH_EDGES] = "both edges" -}; - -struct counter_action_unit { - struct counter_synapse *synapse; - struct counter_count *count; -}; - -static ssize_t counter_action_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - int err; - struct counter_device *const counter = dev_get_drvdata(dev); - const struct counter_action_unit *const component = devattr->component; - struct counter_count *const count = component->count; - struct counter_synapse *const synapse = component->synapse; - size_t action_index; - enum counter_synapse_action action; - - err = counter->ops->action_get(counter, count, synapse, &action_index); - if (err) - return err; - - synapse->action = action_index; - - action = synapse->actions_list[action_index]; - return sprintf(buf, "%s\n", counter_synapse_action_str[action]); -} - -static ssize_t counter_action_store(struct device *dev, - struct device_attribute *attr, - const char *buf, size_t len) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_action_unit *const component = devattr->component; - struct counter_synapse *const synapse = component->synapse; - size_t action_index; - const size_t num_actions = synapse->num_actions; - enum counter_synapse_action action; - int err; - struct counter_device *const counter = dev_get_drvdata(dev); - struct counter_count *const count = component->count; - - /* Find requested action mode */ - for (action_index = 0; action_index < num_actions; action_index++) { - action = synapse->actions_list[action_index]; - if (sysfs_streq(buf, counter_synapse_action_str[action])) - break; - } - /* If requested action mode not found */ - if (action_index >= num_actions) - return -EINVAL; - - err = counter->ops->action_set(counter, count, synapse, action_index); - if (err) - return err; - - synapse->action = action_index; - - return len; -} - -struct counter_action_avail_unit { - const enum counter_synapse_action *actions_list; - size_t num_actions; -}; - -static ssize_t counter_synapse_action_available_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_action_avail_unit *const component = devattr->component; - size_t i; - enum counter_synapse_action action; - ssize_t len = 0; - - for (i = 0; i < component->num_actions; i++) { - action = component->actions_list[i]; - len += sprintf(buf + len, "%s\n", - counter_synapse_action_str[action]); - } - - return len; -} - -static int counter_synapses_register( - struct counter_device_attr_group *const group, - const struct counter_device *const counter, - struct counter_count *const count, const char *const count_attr_name) -{ - size_t i; - struct counter_synapse *synapse; - const char *prefix; - struct counter_action_unit *action_comp; - struct counter_attr_parm parm; - int err; - struct counter_action_avail_unit *avail_comp; - - /* Register each Synapse */ - for (i = 0; i < count->num_synapses; i++) { - synapse = count->synapses + i; - - /* Generate attribute prefix */ - prefix = kasprintf(GFP_KERNEL, "signal%d_", - synapse->signal->id); - if (!prefix) { - err = -ENOMEM; - goto err_free_attr_list; - } - - /* Allocate action attribute component */ - action_comp = kmalloc(sizeof(*action_comp), GFP_KERNEL); - if (!action_comp) { - err = -ENOMEM; - goto err_free_prefix; - } - action_comp->synapse = synapse; - action_comp->count = count; - - /* Create action attribute */ - parm.group = group; - parm.prefix = prefix; - parm.name = "action"; - parm.show = (counter->ops->action_get) ? counter_action_show : NULL; - parm.store = (counter->ops->action_set) ? counter_action_store : NULL; - parm.component = action_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(action_comp); - goto err_free_prefix; - } - - /* Allocate action available attribute component */ - avail_comp = kmalloc(sizeof(*avail_comp), GFP_KERNEL); - if (!avail_comp) { - err = -ENOMEM; - goto err_free_prefix; - } - avail_comp->actions_list = synapse->actions_list; - avail_comp->num_actions = synapse->num_actions; - - /* Create action_available attribute */ - parm.group = group; - parm.prefix = prefix; - parm.name = "action_available"; - parm.show = counter_synapse_action_available_show; - parm.store = NULL; - parm.component = avail_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(avail_comp); - goto err_free_prefix; - } - - kfree(prefix); - } - - return 0; - -err_free_prefix: - kfree(prefix); -err_free_attr_list: - counter_device_attr_list_free(&group->attr_list); - return err; -} - -struct counter_count_unit { - struct counter_count *count; -}; - -static ssize_t counter_count_show(struct device *dev, - struct device_attribute *attr, - char *buf) -{ - struct counter_device *const counter = dev_get_drvdata(dev); - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_count_unit *const component = devattr->component; - struct counter_count *const count = component->count; - int err; - unsigned long val; - - err = counter->ops->count_read(counter, count, &val); - if (err) - return err; - - return sprintf(buf, "%lu\n", val); -} - -static ssize_t counter_count_store(struct device *dev, - struct device_attribute *attr, - const char *buf, size_t len) -{ - struct counter_device *const counter = dev_get_drvdata(dev); - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_count_unit *const component = devattr->component; - struct counter_count *const count = component->count; - int err; - unsigned long val; - - err = kstrtoul(buf, 0, &val); - if (err) - return err; - - err = counter->ops->count_write(counter, count, val); - if (err) - return err; - - return len; -} - -static const char *const counter_count_function_str[] = { - [COUNTER_COUNT_FUNCTION_INCREASE] = "increase", - [COUNTER_COUNT_FUNCTION_DECREASE] = "decrease", - [COUNTER_COUNT_FUNCTION_PULSE_DIRECTION] = "pulse-direction", - [COUNTER_COUNT_FUNCTION_QUADRATURE_X1_A] = "quadrature x1 a", - [COUNTER_COUNT_FUNCTION_QUADRATURE_X1_B] = "quadrature x1 b", - [COUNTER_COUNT_FUNCTION_QUADRATURE_X2_A] = "quadrature x2 a", - [COUNTER_COUNT_FUNCTION_QUADRATURE_X2_B] = "quadrature x2 b", - [COUNTER_COUNT_FUNCTION_QUADRATURE_X4] = "quadrature x4" -}; - -static ssize_t counter_function_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - int err; - struct counter_device *const counter = dev_get_drvdata(dev); - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_count_unit *const component = devattr->component; - struct counter_count *const count = component->count; - size_t func_index; - enum counter_count_function function; - - err = counter->ops->function_get(counter, count, &func_index); - if (err) - return err; - - count->function = func_index; - - function = count->functions_list[func_index]; - return sprintf(buf, "%s\n", counter_count_function_str[function]); -} - -static ssize_t counter_function_store(struct device *dev, - struct device_attribute *attr, - const char *buf, size_t len) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_count_unit *const component = devattr->component; - struct counter_count *const count = component->count; - const size_t num_functions = count->num_functions; - size_t func_index; - enum counter_count_function function; - int err; - struct counter_device *const counter = dev_get_drvdata(dev); - - /* Find requested Count function mode */ - for (func_index = 0; func_index < num_functions; func_index++) { - function = count->functions_list[func_index]; - if (sysfs_streq(buf, counter_count_function_str[function])) - break; - } - /* Return error if requested Count function mode not found */ - if (func_index >= num_functions) - return -EINVAL; - - err = counter->ops->function_set(counter, count, func_index); - if (err) - return err; - - count->function = func_index; - - return len; -} - -struct counter_count_ext_unit { - struct counter_count *count; - const struct counter_count_ext *ext; -}; - -static ssize_t counter_count_ext_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_count_ext_unit *const comp = devattr->component; - const struct counter_count_ext *const ext = comp->ext; - - return ext->read(dev_get_drvdata(dev), comp->count, ext->priv, buf); -} - -static ssize_t counter_count_ext_store(struct device *dev, - struct device_attribute *attr, - const char *buf, size_t len) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_count_ext_unit *const comp = devattr->component; - const struct counter_count_ext *const ext = comp->ext; - - return ext->write(dev_get_drvdata(dev), comp->count, ext->priv, buf, - len); -} - -static int counter_count_ext_register( - struct counter_device_attr_group *const group, - struct counter_count *const count) -{ - size_t i; - const struct counter_count_ext *ext; - struct counter_count_ext_unit *count_ext_comp; - struct counter_attr_parm parm; - int err; - - /* Create an attribute for each extension */ - for (i = 0 ; i < count->num_ext; i++) { - ext = count->ext + i; - - /* Allocate count_ext attribute component */ - count_ext_comp = kmalloc(sizeof(*count_ext_comp), GFP_KERNEL); - if (!count_ext_comp) { - err = -ENOMEM; - goto err_free_attr_list; - } - count_ext_comp->count = count; - count_ext_comp->ext = ext; - - /* Allocate count_ext attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = ext->name; - parm.show = (ext->read) ? counter_count_ext_show : NULL; - parm.store = (ext->write) ? counter_count_ext_store : NULL; - parm.component = count_ext_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(count_ext_comp); - goto err_free_attr_list; - } - } - - return 0; - -err_free_attr_list: - counter_device_attr_list_free(&group->attr_list); - return err; -} - -struct counter_func_avail_unit { - const enum counter_count_function *functions_list; - size_t num_functions; -}; - -static ssize_t counter_count_function_available_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_func_avail_unit *const component = devattr->component; - const enum counter_count_function *const func_list = component->functions_list; - const size_t num_functions = component->num_functions; - size_t i; - enum counter_count_function function; - ssize_t len = 0; - - for (i = 0; i < num_functions; i++) { - function = func_list[i]; - len += sprintf(buf + len, "%s\n", - counter_count_function_str[function]); - } - - return len; -} - -static int counter_count_attributes_create( - struct counter_device_attr_group *const group, - const struct counter_device *const counter, - struct counter_count *const count) -{ - struct counter_count_unit *count_comp; - struct counter_attr_parm parm; - int err; - struct counter_count_unit *func_comp; - struct counter_func_avail_unit *avail_comp; - - /* Allocate count attribute component */ - count_comp = kmalloc(sizeof(*count_comp), GFP_KERNEL); - if (!count_comp) - return -ENOMEM; - count_comp->count = count; - - /* Create main Count attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = "count"; - parm.show = (counter->ops->count_read) ? counter_count_show : NULL; - parm.store = (counter->ops->count_write) ? counter_count_store : NULL; - parm.component = count_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(count_comp); - return err; - } - - /* Allocate function attribute component */ - func_comp = kmalloc(sizeof(*func_comp), GFP_KERNEL); - if (!func_comp) { - err = -ENOMEM; - goto err_free_attr_list; - } - func_comp->count = count; - - /* Create Count function attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = "function"; - parm.show = (counter->ops->function_get) ? counter_function_show : NULL; - parm.store = (counter->ops->function_set) ? counter_function_store : NULL; - parm.component = func_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(func_comp); - goto err_free_attr_list; - } - - /* Allocate function available attribute component */ - avail_comp = kmalloc(sizeof(*avail_comp), GFP_KERNEL); - if (!avail_comp) { - err = -ENOMEM; - goto err_free_attr_list; - } - avail_comp->functions_list = count->functions_list; - avail_comp->num_functions = count->num_functions; - - /* Create Count function_available attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = "function_available"; - parm.show = counter_count_function_available_show; - parm.store = NULL; - parm.component = avail_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(avail_comp); - goto err_free_attr_list; - } - - /* Create Count name attribute */ - err = counter_name_attribute_create(group, count->name); - if (err) - goto err_free_attr_list; - - /* Register Count extension attributes */ - err = counter_count_ext_register(group, count); - if (err) - goto err_free_attr_list; - - return 0; - -err_free_attr_list: - counter_device_attr_list_free(&group->attr_list); - return err; -} - -static int counter_counts_register( - struct counter_device_attr_group *const groups_list, - const struct counter_device *const counter) -{ - size_t i; - struct counter_count *count; - const char *name; - int err; - - /* Register each Count */ - for (i = 0; i < counter->num_counts; i++) { - count = counter->counts + i; - - /* Generate Count attribute directory name */ - name = kasprintf(GFP_KERNEL, "count%d", count->id); - if (!name) { - err = -ENOMEM; - goto err_free_attr_groups; - } - groups_list[i].attr_group.name = name; - - /* Register the Synapses associated with each Count */ - err = counter_synapses_register(groups_list + i, counter, count, - name); - if (err) - goto err_free_attr_groups; - - /* Create all attributes associated with Count */ - err = counter_count_attributes_create(groups_list + i, counter, - count); - if (err) - goto err_free_attr_groups; - } - - return 0; - -err_free_attr_groups: - do { - kfree(groups_list[i].attr_group.name); - counter_device_attr_list_free(&groups_list[i].attr_list); - } while (i--); - return err; -} - -struct counter_size_unit { - size_t size; -}; - -static ssize_t counter_device_attr_size_show(struct device *dev, - struct device_attribute *attr, - char *buf) -{ - const struct counter_size_unit *const comp = to_counter_attr(attr)->component; - - return sprintf(buf, "%zu\n", comp->size); -} - -static int counter_size_attribute_create( - struct counter_device_attr_group *const group, - const size_t size, const char *const name) -{ - struct counter_size_unit *size_comp; - struct counter_attr_parm parm; - int err; - - /* Allocate size attribute component */ - size_comp = kmalloc(sizeof(*size_comp), GFP_KERNEL); - if (!size_comp) - return -ENOMEM; - size_comp->size = size; - - parm.group = group; - parm.prefix = ""; - parm.name = name; - parm.show = counter_device_attr_size_show; - parm.store = NULL; - parm.component = size_comp; - err = counter_attribute_create(&parm); - if (err) - goto err_free_size_comp; - - return 0; - -err_free_size_comp: - kfree(size_comp); - return err; -} - -struct counter_ext_unit { - const struct counter_device_ext *ext; -}; - -static ssize_t counter_device_ext_show(struct device *dev, - struct device_attribute *attr, char *buf) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_ext_unit *const component = devattr->component; - const struct counter_device_ext *const ext = component->ext; - - return ext->read(dev_get_drvdata(dev), ext->priv, buf); -} - -static ssize_t counter_device_ext_store(struct device *dev, - struct device_attribute *attr, - const char *buf, size_t len) -{ - const struct counter_device_attr *const devattr = to_counter_attr(attr); - const struct counter_ext_unit *const component = devattr->component; - const struct counter_device_ext *const ext = component->ext; - - return ext->write(dev_get_drvdata(dev), ext->priv, buf, len); -} - -static int counter_device_ext_register( - struct counter_device_attr_group *const group, - struct counter_device *const counter) -{ - size_t i; - struct counter_ext_unit *ext_comp; - struct counter_attr_parm parm; - int err; - - /* Create an attribute for each extension */ - for (i = 0 ; i < counter->num_ext; i++) { - /* Allocate extension attribute component */ - ext_comp = kmalloc(sizeof(*ext_comp), GFP_KERNEL); - if (!ext_comp) { - err = -ENOMEM; - goto err_free_attr_list; - } - - ext_comp->ext = counter->ext + i; - - /* Allocate extension attribute */ - parm.group = group; - parm.prefix = ""; - parm.name = counter->ext[i].name; - parm.show = (counter->ext[i].read) ? counter_device_ext_show : NULL; - parm.store = (counter->ext[i].write) ? counter_device_ext_store : NULL; - parm.component = ext_comp; - err = counter_attribute_create(&parm); - if (err) { - kfree(ext_comp); - goto err_free_attr_list; - } - } - - return 0; - -err_free_attr_list: - counter_device_attr_list_free(&group->attr_list); - return err; -} - -static int counter_global_attr_register( - struct counter_device_attr_group *const group, - struct counter_device *const counter) -{ - int err; - - /* Create name attribute */ - err = counter_name_attribute_create(group, counter->name); - if (err) - return err; - - /* Create num_counts attribute */ - err = counter_size_attribute_create(group, counter->num_counts, - "num_counts"); - if (err) - goto err_free_attr_list; - - /* Create num_signals attribute */ - err = counter_size_attribute_create(group, counter->num_signals, - "num_signals"); - if (err) - goto err_free_attr_list; - - /* Register Counter device extension attributes */ - err = counter_device_ext_register(group, counter); - if (err) - goto err_free_attr_list; - - return 0; - -err_free_attr_list: - counter_device_attr_list_free(&group->attr_list); - return err; -} - -static void counter_device_groups_list_free( - struct counter_device_attr_group *const groups_list, - const size_t num_groups) -{ - struct counter_device_attr_group *group; - size_t i; - - /* loop through all attribute groups (signals, counts, global, etc.) */ - for (i = 0; i < num_groups; i++) { - group = groups_list + i; - - /* free all attribute group and associated attributes memory */ - kfree(group->attr_group.name); - kfree(group->attr_group.attrs); - counter_device_attr_list_free(&group->attr_list); - } - - kfree(groups_list); -} - -static int counter_device_groups_list_prepare( - struct counter_device *const counter) -{ - const size_t total_num_groups = - counter->num_signals + counter->num_counts + 1; - struct counter_device_attr_group *groups_list; - size_t i; - int err; - size_t num_groups = 0; - - /* Allocate space for attribute groups (signals, counts, and ext) */ - groups_list = kcalloc(total_num_groups, sizeof(*groups_list), - GFP_KERNEL); - if (!groups_list) - return -ENOMEM; - - /* Initialize attribute lists */ - for (i = 0; i < total_num_groups; i++) - INIT_LIST_HEAD(&groups_list[i].attr_list); - - /* Register Signals */ - err = counter_signals_register(groups_list, counter); - if (err) - goto err_free_groups_list; - num_groups += counter->num_signals; - - /* Register Counts and respective Synapses */ - err = counter_counts_register(groups_list + num_groups, counter); - if (err) - goto err_free_groups_list; - num_groups += counter->num_counts; - - /* Register Counter global attributes */ - err = counter_global_attr_register(groups_list + num_groups, counter); - if (err) - goto err_free_groups_list; - num_groups++; - - /* Store groups_list in device_state */ - counter->device_state->groups_list = groups_list; - counter->device_state->num_groups = num_groups; - - return 0; - -err_free_groups_list: - counter_device_groups_list_free(groups_list, num_groups); - return err; -} - -static int counter_device_groups_prepare( - struct counter_device_state *const device_state) -{ - size_t i, j; - struct counter_device_attr_group *group; - int err; - struct counter_device_attr *p; - - /* Allocate attribute groups for association with device */ - device_state->groups = kcalloc(device_state->num_groups + 1, - sizeof(*device_state->groups), - GFP_KERNEL); - if (!device_state->groups) - return -ENOMEM; - - /* Prepare each group of attributes for association */ - for (i = 0; i < device_state->num_groups; i++) { - group = device_state->groups_list + i; - - /* Allocate space for attribute pointers in attribute group */ - group->attr_group.attrs = kcalloc(group->num_attr + 1, - sizeof(*group->attr_group.attrs), GFP_KERNEL); - if (!group->attr_group.attrs) { - err = -ENOMEM; - goto err_free_groups; - } - - /* Add attribute pointers to attribute group */ - j = 0; - list_for_each_entry(p, &group->attr_list, l) - group->attr_group.attrs[j++] = &p->dev_attr.attr; - - /* Group attributes in attribute group */ - device_state->groups[i] = &group->attr_group; - } - /* Associate attributes with device */ - device_state->dev.groups = device_state->groups; - - return 0; - -err_free_groups: - do { - group = device_state->groups_list + i; - kfree(group->attr_group.attrs); - group->attr_group.attrs = NULL; - } while (i--); - kfree(device_state->groups); - return err; -} - -/* Provides a unique ID for each counter device */ -static DEFINE_IDA(counter_ida); - -static void counter_device_release(struct device *dev) -{ - struct counter_device *const counter = dev_get_drvdata(dev); - struct counter_device_state *const device_state = counter->device_state; - - kfree(device_state->groups); - counter_device_groups_list_free(device_state->groups_list, - device_state->num_groups); - ida_simple_remove(&counter_ida, device_state->id); - kfree(device_state); -} - -static struct device_type counter_device_type = { - .name = "counter_device", - .release = counter_device_release -}; - -static struct bus_type counter_bus_type = { - .name = "counter" -}; - -/** - * counter_register - register Counter to the system - * @counter: pointer to Counter to register - * - * This function registers a Counter to the system. A sysfs "counter" directory - * will be created and populated with sysfs attributes correlating with the - * Counter Signals, Synapses, and Counts respectively. - */ -int counter_register(struct counter_device *const counter) -{ - struct counter_device_state *device_state; - int err; - - /* Allocate internal state container for Counter device */ - device_state = kzalloc(sizeof(*device_state), GFP_KERNEL); - if (!device_state) - return -ENOMEM; - counter->device_state = device_state; - - /* Acquire unique ID */ - device_state->id = ida_simple_get(&counter_ida, 0, 0, GFP_KERNEL); - if (device_state->id < 0) { - err = device_state->id; - goto err_free_device_state; - } - - /* Configure device structure for Counter */ - device_state->dev.type = &counter_device_type; - device_state->dev.bus = &counter_bus_type; - if (counter->parent) { - device_state->dev.parent = counter->parent; - device_state->dev.of_node = counter->parent->of_node; - } - dev_set_name(&device_state->dev, "counter%d", device_state->id); - device_initialize(&device_state->dev); - dev_set_drvdata(&device_state->dev, counter); - - /* Prepare device attributes */ - err = counter_device_groups_list_prepare(counter); - if (err) - goto err_free_id; - - /* Organize device attributes to groups and match to device */ - err = counter_device_groups_prepare(device_state); - if (err) - goto err_free_groups_list; - - /* Add device to system */ - err = device_add(&device_state->dev); - if (err) - goto err_free_groups; - - return 0; - -err_free_groups: - kfree(device_state->groups); -err_free_groups_list: - counter_device_groups_list_free(device_state->groups_list, - device_state->num_groups); -err_free_id: - ida_simple_remove(&counter_ida, device_state->id); -err_free_device_state: - kfree(device_state); - return err; -} -EXPORT_SYMBOL_GPL(counter_register); - -/** - * counter_unregister - unregister Counter from the system - * @counter: pointer to Counter to unregister - * - * The Counter is unregistered from the system; all allocated memory is freed. - */ -void counter_unregister(struct counter_device *const counter) -{ - if (counter) - device_del(&counter->device_state->dev); -} -EXPORT_SYMBOL_GPL(counter_unregister); - -static void devm_counter_unreg(struct device *dev, void *res) -{ - counter_unregister(*(struct counter_device **)res); -} - -/** - * devm_counter_register - Resource-managed counter_register - * @dev: device to allocate counter_device for - * @counter: pointer to Counter to register - * - * Managed counter_register. The Counter registered with this function is - * automatically unregistered on driver detach. This function calls - * counter_register internally. Refer to that function for more information. - * - * If an Counter registered with this function needs to be unregistered - * separately, devm_counter_unregister must be used. - * - * RETURNS: - * 0 on success, negative error number on failure. - */ -int devm_counter_register(struct device *dev, - struct counter_device *const counter) -{ - struct counter_device **ptr; - int ret; - - ptr = devres_alloc(devm_counter_unreg, sizeof(*ptr), GFP_KERNEL); - if (!ptr) - return -ENOMEM; - - ret = counter_register(counter); - if (!ret) { - *ptr = counter; - devres_add(dev, ptr); - } else { - devres_free(ptr); - } - - return ret; -} -EXPORT_SYMBOL_GPL(devm_counter_register); - -static int devm_counter_match(struct device *dev, void *res, void *data) -{ - struct counter_device **r = res; - - if (!r || !*r) { - WARN_ON(!r || !*r); - return 0; - } - - return *r == data; -} - -/** - * devm_counter_unregister - Resource-managed counter_unregister - * @dev: device this counter_device belongs to - * @counter: pointer to Counter associated with the device - * - * Unregister Counter registered with devm_counter_register. - */ -void devm_counter_unregister(struct device *dev, - struct counter_device *const counter) -{ - int rc; - - rc = devres_release(dev, devm_counter_unreg, devm_counter_match, - counter); - WARN_ON(rc); -} -EXPORT_SYMBOL_GPL(devm_counter_unregister); - -static int __init counter_init(void) -{ - return bus_register(&counter_bus_type); -} - -static void __exit counter_exit(void) -{ - bus_unregister(&counter_bus_type); -} - -subsys_initcall(counter_init); -module_exit(counter_exit); - -MODULE_AUTHOR("William Breathitt Gray <vilhelm.gray@gmail.com>"); -MODULE_DESCRIPTION("Generic Counter interface"); -MODULE_LICENSE("GPL v2"); diff --git a/drivers/counter/ftm-quaddec.c b/drivers/counter/ftm-quaddec.c index c2b3fdfd8b77..f297b7636e71 100644 --- a/drivers/counter/ftm-quaddec.c +++ b/drivers/counter/ftm-quaddec.c @@ -14,6 +14,7 @@ #include <linux/mutex.h> #include <linux/counter.h> #include <linux/bitfield.h> +#include <linux/types.h> #define FTM_FIELD_UPDATE(ftm, offset, mask, val) \ ({ \ @@ -115,8 +116,7 @@ static void ftm_quaddec_disable(void *ftm) } static int ftm_quaddec_get_prescaler(struct counter_device *counter, - struct counter_count *count, - size_t *cnt_mode) + struct counter_count *count, u32 *cnt_mode) { struct ftm_quaddec *ftm = counter->priv; uint32_t scflags; @@ -129,8 +129,7 @@ static int ftm_quaddec_get_prescaler(struct counter_device *counter, } static int ftm_quaddec_set_prescaler(struct counter_device *counter, - struct counter_count *count, - size_t cnt_mode) + struct counter_count *count, u32 cnt_mode) { struct ftm_quaddec *ftm = counter->priv; @@ -151,34 +150,21 @@ static const char * const ftm_quaddec_prescaler[] = { "1", "2", "4", "8", "16", "32", "64", "128" }; -static struct counter_count_enum_ext ftm_quaddec_prescaler_enum = { - .items = ftm_quaddec_prescaler, - .num_items = ARRAY_SIZE(ftm_quaddec_prescaler), - .get = ftm_quaddec_get_prescaler, - .set = ftm_quaddec_set_prescaler -}; - -enum ftm_quaddec_synapse_action { - FTM_QUADDEC_SYNAPSE_ACTION_BOTH_EDGES, -}; - -static enum counter_synapse_action ftm_quaddec_synapse_actions[] = { - [FTM_QUADDEC_SYNAPSE_ACTION_BOTH_EDGES] = +static const enum counter_synapse_action ftm_quaddec_synapse_actions[] = { COUNTER_SYNAPSE_ACTION_BOTH_EDGES }; -enum ftm_quaddec_count_function { - FTM_QUADDEC_COUNT_ENCODER_MODE_1, +enum ftm_quaddec_function { + FTM_QUADDEC_COUNT_ENCODER_MODE_1 = COUNTER_FUNCTION_QUADRATURE_X4, }; -static const enum counter_count_function ftm_quaddec_count_functions[] = { - [FTM_QUADDEC_COUNT_ENCODER_MODE_1] = - COUNTER_COUNT_FUNCTION_QUADRATURE_X4 +static const enum counter_function ftm_quaddec_functions[] = { + FTM_QUADDEC_COUNT_ENCODER_MODE_1 }; static int ftm_quaddec_count_read(struct counter_device *counter, struct counter_count *count, - unsigned long *val) + u64 *val) { struct ftm_quaddec *const ftm = counter->priv; uint32_t cntval; @@ -192,7 +178,7 @@ static int ftm_quaddec_count_read(struct counter_device *counter, static int ftm_quaddec_count_write(struct counter_device *counter, struct counter_count *count, - const unsigned long val) + const u64 val) { struct ftm_quaddec *const ftm = counter->priv; @@ -206,9 +192,9 @@ static int ftm_quaddec_count_write(struct counter_device *counter, return 0; } -static int ftm_quaddec_count_function_get(struct counter_device *counter, - struct counter_count *count, - size_t *function) +static int ftm_quaddec_function_read(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function) { *function = FTM_QUADDEC_COUNT_ENCODER_MODE_1; @@ -218,9 +204,9 @@ static int ftm_quaddec_count_function_get(struct counter_device *counter, static int ftm_quaddec_action_get(struct counter_device *counter, struct counter_count *count, struct counter_synapse *synapse, - size_t *action) + enum counter_synapse_action *action) { - *action = FTM_QUADDEC_SYNAPSE_ACTION_BOTH_EDGES; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; return 0; } @@ -228,8 +214,8 @@ static int ftm_quaddec_action_get(struct counter_device *counter, static const struct counter_ops ftm_quaddec_cnt_ops = { .count_read = ftm_quaddec_count_read, .count_write = ftm_quaddec_count_write, - .function_get = ftm_quaddec_count_function_get, - .action_get = ftm_quaddec_action_get, + .function_read = ftm_quaddec_function_read, + .action_read = ftm_quaddec_action_get, }; static struct counter_signal ftm_quaddec_signals[] = { @@ -256,16 +242,19 @@ static struct counter_synapse ftm_quaddec_count_synapses[] = { } }; -static const struct counter_count_ext ftm_quaddec_count_ext[] = { - COUNTER_COUNT_ENUM("prescaler", &ftm_quaddec_prescaler_enum), - COUNTER_COUNT_ENUM_AVAILABLE("prescaler", &ftm_quaddec_prescaler_enum), +static DEFINE_COUNTER_ENUM(ftm_quaddec_prescaler_enum, ftm_quaddec_prescaler); + +static struct counter_comp ftm_quaddec_count_ext[] = { + COUNTER_COMP_COUNT_ENUM("prescaler", ftm_quaddec_get_prescaler, + ftm_quaddec_set_prescaler, + ftm_quaddec_prescaler_enum), }; static struct counter_count ftm_quaddec_counts = { .id = 0, .name = "Channel 1 Count", - .functions_list = ftm_quaddec_count_functions, - .num_functions = ARRAY_SIZE(ftm_quaddec_count_functions), + .functions_list = ftm_quaddec_functions, + .num_functions = ARRAY_SIZE(ftm_quaddec_functions), .synapses = ftm_quaddec_count_synapses, .num_synapses = ARRAY_SIZE(ftm_quaddec_count_synapses), .ext = ftm_quaddec_count_ext, diff --git a/drivers/counter/microchip-tcb-capture.c b/drivers/counter/microchip-tcb-capture.c index 710acc0a3704..b1bc654dd624 100644 --- a/drivers/counter/microchip-tcb-capture.c +++ b/drivers/counter/microchip-tcb-capture.c @@ -32,28 +32,16 @@ struct mchp_tc_data { bool trig_inverted; }; -enum mchp_tc_count_function { - MCHP_TC_FUNCTION_INCREASE, - MCHP_TC_FUNCTION_QUADRATURE, +static const enum counter_function mchp_tc_functions[] = { + COUNTER_FUNCTION_INCREASE, + COUNTER_FUNCTION_QUADRATURE_X4, }; -static enum counter_count_function mchp_tc_count_functions[] = { - [MCHP_TC_FUNCTION_INCREASE] = COUNTER_COUNT_FUNCTION_INCREASE, - [MCHP_TC_FUNCTION_QUADRATURE] = COUNTER_COUNT_FUNCTION_QUADRATURE_X4, -}; - -enum mchp_tc_synapse_action { - MCHP_TC_SYNAPSE_ACTION_NONE = 0, - MCHP_TC_SYNAPSE_ACTION_RISING_EDGE, - MCHP_TC_SYNAPSE_ACTION_FALLING_EDGE, - MCHP_TC_SYNAPSE_ACTION_BOTH_EDGE -}; - -static enum counter_synapse_action mchp_tc_synapse_actions[] = { - [MCHP_TC_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, - [MCHP_TC_SYNAPSE_ACTION_RISING_EDGE] = COUNTER_SYNAPSE_ACTION_RISING_EDGE, - [MCHP_TC_SYNAPSE_ACTION_FALLING_EDGE] = COUNTER_SYNAPSE_ACTION_FALLING_EDGE, - [MCHP_TC_SYNAPSE_ACTION_BOTH_EDGE] = COUNTER_SYNAPSE_ACTION_BOTH_EDGES, +static const enum counter_synapse_action mchp_tc_synapse_actions[] = { + COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, }; static struct counter_signal mchp_tc_count_signals[] = { @@ -80,23 +68,23 @@ static struct counter_synapse mchp_tc_count_synapses[] = { } }; -static int mchp_tc_count_function_get(struct counter_device *counter, - struct counter_count *count, - size_t *function) +static int mchp_tc_function_read(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function) { struct mchp_tc_data *const priv = counter->priv; if (priv->qdec_mode) - *function = MCHP_TC_FUNCTION_QUADRATURE; + *function = COUNTER_FUNCTION_QUADRATURE_X4; else - *function = MCHP_TC_FUNCTION_INCREASE; + *function = COUNTER_FUNCTION_INCREASE; return 0; } -static int mchp_tc_count_function_set(struct counter_device *counter, - struct counter_count *count, - size_t function) +static int mchp_tc_function_write(struct counter_device *counter, + struct counter_count *count, + enum counter_function function) { struct mchp_tc_data *const priv = counter->priv; u32 bmr, cmr; @@ -108,7 +96,7 @@ static int mchp_tc_count_function_set(struct counter_device *counter, cmr &= ~ATMEL_TC_WAVE; switch (function) { - case MCHP_TC_FUNCTION_INCREASE: + case COUNTER_FUNCTION_INCREASE: priv->qdec_mode = 0; /* Set highest rate based on whether soc has gclk or not */ bmr &= ~(ATMEL_TC_QDEN | ATMEL_TC_POSEN); @@ -120,7 +108,7 @@ static int mchp_tc_count_function_set(struct counter_device *counter, cmr |= ATMEL_TC_CMR_MASK; cmr &= ~(ATMEL_TC_ABETRG | ATMEL_TC_XC0); break; - case MCHP_TC_FUNCTION_QUADRATURE: + case COUNTER_FUNCTION_QUADRATURE_X4: if (!priv->tc_cfg->has_qdec) return -EINVAL; /* In QDEC mode settings both channels 0 and 1 are required */ @@ -133,6 +121,8 @@ static int mchp_tc_count_function_set(struct counter_device *counter, bmr |= ATMEL_TC_QDEN | ATMEL_TC_POSEN; cmr |= ATMEL_TC_ETRGEDG_RISING | ATMEL_TC_ABETRG | ATMEL_TC_XC0; break; + default: + return -EINVAL; } regmap_write(priv->regmap, ATMEL_TC_BMR, bmr); @@ -155,7 +145,7 @@ static int mchp_tc_count_function_set(struct counter_device *counter, static int mchp_tc_count_signal_read(struct counter_device *counter, struct counter_signal *signal, - enum counter_signal_value *val) + enum counter_signal_level *lvl) { struct mchp_tc_data *const priv = counter->priv; bool sigstatus; @@ -168,15 +158,15 @@ static int mchp_tc_count_signal_read(struct counter_device *counter, else sigstatus = (sr & ATMEL_TC_MTIOA); - *val = sigstatus ? COUNTER_SIGNAL_HIGH : COUNTER_SIGNAL_LOW; + *lvl = sigstatus ? COUNTER_SIGNAL_LEVEL_HIGH : COUNTER_SIGNAL_LEVEL_LOW; return 0; } -static int mchp_tc_count_action_get(struct counter_device *counter, - struct counter_count *count, - struct counter_synapse *synapse, - size_t *action) +static int mchp_tc_count_action_read(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action *action) { struct mchp_tc_data *const priv = counter->priv; u32 cmr; @@ -185,26 +175,26 @@ static int mchp_tc_count_action_get(struct counter_device *counter, switch (cmr & ATMEL_TC_ETRGEDG) { default: - *action = MCHP_TC_SYNAPSE_ACTION_NONE; + *action = COUNTER_SYNAPSE_ACTION_NONE; break; case ATMEL_TC_ETRGEDG_RISING: - *action = MCHP_TC_SYNAPSE_ACTION_RISING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; break; case ATMEL_TC_ETRGEDG_FALLING: - *action = MCHP_TC_SYNAPSE_ACTION_FALLING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_FALLING_EDGE; break; case ATMEL_TC_ETRGEDG_BOTH: - *action = MCHP_TC_SYNAPSE_ACTION_BOTH_EDGE; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; break; } return 0; } -static int mchp_tc_count_action_set(struct counter_device *counter, - struct counter_count *count, - struct counter_synapse *synapse, - size_t action) +static int mchp_tc_count_action_write(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action action) { struct mchp_tc_data *const priv = counter->priv; u32 edge = ATMEL_TC_ETRGEDG_NONE; @@ -214,18 +204,20 @@ static int mchp_tc_count_action_set(struct counter_device *counter, return -EINVAL; switch (action) { - case MCHP_TC_SYNAPSE_ACTION_NONE: + case COUNTER_SYNAPSE_ACTION_NONE: edge = ATMEL_TC_ETRGEDG_NONE; break; - case MCHP_TC_SYNAPSE_ACTION_RISING_EDGE: + case COUNTER_SYNAPSE_ACTION_RISING_EDGE: edge = ATMEL_TC_ETRGEDG_RISING; break; - case MCHP_TC_SYNAPSE_ACTION_FALLING_EDGE: + case COUNTER_SYNAPSE_ACTION_FALLING_EDGE: edge = ATMEL_TC_ETRGEDG_FALLING; break; - case MCHP_TC_SYNAPSE_ACTION_BOTH_EDGE: + case COUNTER_SYNAPSE_ACTION_BOTH_EDGES: edge = ATMEL_TC_ETRGEDG_BOTH; break; + default: + return -EINVAL; } return regmap_write_bits(priv->regmap, @@ -234,8 +226,7 @@ static int mchp_tc_count_action_set(struct counter_device *counter, } static int mchp_tc_count_read(struct counter_device *counter, - struct counter_count *count, - unsigned long *val) + struct counter_count *count, u64 *val) { struct mchp_tc_data *const priv = counter->priv; u32 cnt; @@ -250,8 +241,8 @@ static struct counter_count mchp_tc_counts[] = { { .id = 0, .name = "Timer Counter", - .functions_list = mchp_tc_count_functions, - .num_functions = ARRAY_SIZE(mchp_tc_count_functions), + .functions_list = mchp_tc_functions, + .num_functions = ARRAY_SIZE(mchp_tc_functions), .synapses = mchp_tc_count_synapses, .num_synapses = ARRAY_SIZE(mchp_tc_count_synapses), }, @@ -260,10 +251,10 @@ static struct counter_count mchp_tc_counts[] = { static const struct counter_ops mchp_tc_ops = { .signal_read = mchp_tc_count_signal_read, .count_read = mchp_tc_count_read, - .function_get = mchp_tc_count_function_get, - .function_set = mchp_tc_count_function_set, - .action_get = mchp_tc_count_action_get, - .action_set = mchp_tc_count_action_set + .function_read = mchp_tc_function_read, + .function_write = mchp_tc_function_write, + .action_read = mchp_tc_count_action_read, + .action_write = mchp_tc_count_action_write }; static const struct atmel_tcb_config tcb_rm9200_config = { diff --git a/drivers/counter/stm32-lptimer-cnt.c b/drivers/counter/stm32-lptimer-cnt.c index fd6828e2d34f..76431386c919 100644 --- a/drivers/counter/stm32-lptimer-cnt.c +++ b/drivers/counter/stm32-lptimer-cnt.c @@ -17,6 +17,7 @@ #include <linux/module.h> #include <linux/pinctrl/consumer.h> #include <linux/platform_device.h> +#include <linux/types.h> struct stm32_lptim_cnt { struct counter_device counter; @@ -347,37 +348,51 @@ static const struct iio_chan_spec stm32_lptim_cnt_channels = { }; /** - * enum stm32_lptim_cnt_function - enumerates LPTimer counter & encoder modes + * enum stm32_lptim_function - enumerates LPTimer counter & encoder modes * @STM32_LPTIM_COUNTER_INCREASE: up count on IN1 rising, falling or both edges * @STM32_LPTIM_ENCODER_BOTH_EDGE: count on both edges (IN1 & IN2 quadrature) */ -enum stm32_lptim_cnt_function { - STM32_LPTIM_COUNTER_INCREASE, - STM32_LPTIM_ENCODER_BOTH_EDGE, +enum stm32_lptim_function { + STM32_LPTIM_COUNTER_INCREASE = COUNTER_FUNCTION_INCREASE, + STM32_LPTIM_ENCODER_BOTH_EDGE = COUNTER_FUNCTION_QUADRATURE_X4, }; -static enum counter_count_function stm32_lptim_cnt_functions[] = { - [STM32_LPTIM_COUNTER_INCREASE] = COUNTER_COUNT_FUNCTION_INCREASE, - [STM32_LPTIM_ENCODER_BOTH_EDGE] = COUNTER_COUNT_FUNCTION_QUADRATURE_X4, +static const enum counter_function stm32_lptim_functions[] = { + STM32_LPTIM_COUNTER_INCREASE, + STM32_LPTIM_ENCODER_BOTH_EDGE, }; enum stm32_lptim_synapse_action { + /* Index must match with stm32_lptim_cnt_polarity[] (priv->polarity) */ STM32_LPTIM_SYNAPSE_ACTION_RISING_EDGE, STM32_LPTIM_SYNAPSE_ACTION_FALLING_EDGE, STM32_LPTIM_SYNAPSE_ACTION_BOTH_EDGES, STM32_LPTIM_SYNAPSE_ACTION_NONE, }; -static enum counter_synapse_action stm32_lptim_cnt_synapse_actions[] = { - /* Index must match with stm32_lptim_cnt_polarity[] (priv->polarity) */ +static const enum stm32_lptim_synapse_action stm32_lptim_c2l_actions_map[] = { + [COUNTER_SYNAPSE_ACTION_RISING_EDGE] = STM32_LPTIM_SYNAPSE_ACTION_RISING_EDGE, + [COUNTER_SYNAPSE_ACTION_FALLING_EDGE] = STM32_LPTIM_SYNAPSE_ACTION_FALLING_EDGE, + [COUNTER_SYNAPSE_ACTION_BOTH_EDGES] = STM32_LPTIM_SYNAPSE_ACTION_BOTH_EDGES, + [COUNTER_SYNAPSE_ACTION_NONE] = STM32_LPTIM_SYNAPSE_ACTION_NONE, +}; + +static const enum counter_synapse_action stm32_lptim_l2c_actions_map[] = { [STM32_LPTIM_SYNAPSE_ACTION_RISING_EDGE] = COUNTER_SYNAPSE_ACTION_RISING_EDGE, [STM32_LPTIM_SYNAPSE_ACTION_FALLING_EDGE] = COUNTER_SYNAPSE_ACTION_FALLING_EDGE, [STM32_LPTIM_SYNAPSE_ACTION_BOTH_EDGES] = COUNTER_SYNAPSE_ACTION_BOTH_EDGES, [STM32_LPTIM_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, }; +static const enum counter_synapse_action stm32_lptim_cnt_synapse_actions[] = { + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, + COUNTER_SYNAPSE_ACTION_NONE, +}; + static int stm32_lptim_cnt_read(struct counter_device *counter, - struct counter_count *count, unsigned long *val) + struct counter_count *count, u64 *val) { struct stm32_lptim_cnt *const priv = counter->priv; u32 cnt; @@ -392,9 +407,9 @@ static int stm32_lptim_cnt_read(struct counter_device *counter, return 0; } -static int stm32_lptim_cnt_function_get(struct counter_device *counter, - struct counter_count *count, - size_t *function) +static int stm32_lptim_function_read(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function) { struct stm32_lptim_cnt *const priv = counter->priv; @@ -411,9 +426,9 @@ static int stm32_lptim_cnt_function_get(struct counter_device *counter, return -EINVAL; } -static int stm32_lptim_cnt_function_set(struct counter_device *counter, - struct counter_count *count, - size_t function) +static int stm32_lptim_function_write(struct counter_device *counter, + struct counter_count *count, + enum counter_function function) { struct stm32_lptim_cnt *const priv = counter->priv; @@ -423,19 +438,21 @@ static int stm32_lptim_cnt_function_set(struct counter_device *counter, switch (function) { case STM32_LPTIM_COUNTER_INCREASE: priv->quadrature_mode = 0; - return 0; + break; case STM32_LPTIM_ENCODER_BOTH_EDGE: priv->quadrature_mode = 1; priv->polarity = STM32_LPTIM_SYNAPSE_ACTION_BOTH_EDGES; - return 0; + break; + default: + return -EINVAL; } - return -EINVAL; + return 0; } -static ssize_t stm32_lptim_cnt_enable_read(struct counter_device *counter, - struct counter_count *count, - void *private, char *buf) +static int stm32_lptim_cnt_enable_read(struct counter_device *counter, + struct counter_count *count, + u8 *enable) { struct stm32_lptim_cnt *const priv = counter->priv; int ret; @@ -444,22 +461,18 @@ static ssize_t stm32_lptim_cnt_enable_read(struct counter_device *counter, if (ret < 0) return ret; - return scnprintf(buf, PAGE_SIZE, "%u\n", ret); + *enable = ret; + + return 0; } -static ssize_t stm32_lptim_cnt_enable_write(struct counter_device *counter, - struct counter_count *count, - void *private, - const char *buf, size_t len) +static int stm32_lptim_cnt_enable_write(struct counter_device *counter, + struct counter_count *count, + u8 enable) { struct stm32_lptim_cnt *const priv = counter->priv; - bool enable; int ret; - ret = kstrtobool(buf, &enable); - if (ret) - return ret; - /* Check nobody uses the timer, or already disabled/enabled */ ret = stm32_lptim_is_enabled(priv); if ((ret < 0) || (!ret && !enable)) @@ -475,51 +488,54 @@ static ssize_t stm32_lptim_cnt_enable_write(struct counter_device *counter, if (ret) return ret; - return len; + return 0; } -static ssize_t stm32_lptim_cnt_ceiling_read(struct counter_device *counter, - struct counter_count *count, - void *private, char *buf) +static int stm32_lptim_cnt_ceiling_read(struct counter_device *counter, + struct counter_count *count, + u64 *ceiling) { struct stm32_lptim_cnt *const priv = counter->priv; - return stm32_lptim_cnt_get_ceiling(priv, buf); + *ceiling = priv->ceiling; + + return 0; } -static ssize_t stm32_lptim_cnt_ceiling_write(struct counter_device *counter, - struct counter_count *count, - void *private, - const char *buf, size_t len) +static int stm32_lptim_cnt_ceiling_write(struct counter_device *counter, + struct counter_count *count, + u64 ceiling) { struct stm32_lptim_cnt *const priv = counter->priv; - return stm32_lptim_cnt_set_ceiling(priv, buf, len); + if (ceiling > STM32_LPTIM_MAX_ARR) + return -EINVAL; + + if (stm32_lptim_is_enabled(priv)) + return -EBUSY; + + priv->ceiling = ceiling; + + return 0; } -static const struct counter_count_ext stm32_lptim_cnt_ext[] = { - { - .name = "enable", - .read = stm32_lptim_cnt_enable_read, - .write = stm32_lptim_cnt_enable_write - }, - { - .name = "ceiling", - .read = stm32_lptim_cnt_ceiling_read, - .write = stm32_lptim_cnt_ceiling_write - }, +static struct counter_comp stm32_lptim_cnt_ext[] = { + COUNTER_COMP_ENABLE(stm32_lptim_cnt_enable_read, + stm32_lptim_cnt_enable_write), + COUNTER_COMP_CEILING(stm32_lptim_cnt_ceiling_read, + stm32_lptim_cnt_ceiling_write), }; static int stm32_lptim_cnt_action_get(struct counter_device *counter, struct counter_count *count, struct counter_synapse *synapse, - size_t *action) + enum counter_synapse_action *action) { struct stm32_lptim_cnt *const priv = counter->priv; - size_t function; + enum counter_function function; int err; - err = stm32_lptim_cnt_function_get(counter, count, &function); + err = stm32_lptim_function_read(counter, count, &function); if (err) return err; @@ -527,55 +543,54 @@ static int stm32_lptim_cnt_action_get(struct counter_device *counter, case STM32_LPTIM_COUNTER_INCREASE: /* LP Timer acts as up-counter on input 1 */ if (synapse->signal->id == count->synapses[0].signal->id) - *action = priv->polarity; + *action = stm32_lptim_l2c_actions_map[priv->polarity]; else - *action = STM32_LPTIM_SYNAPSE_ACTION_NONE; - return 0; + *action = COUNTER_SYNAPSE_ACTION_NONE; + break; case STM32_LPTIM_ENCODER_BOTH_EDGE: - *action = priv->polarity; - return 0; + *action = stm32_lptim_l2c_actions_map[priv->polarity]; + break; + default: + /* should never reach this path */ + return -EINVAL; } - return -EINVAL; + return 0; } static int stm32_lptim_cnt_action_set(struct counter_device *counter, struct counter_count *count, struct counter_synapse *synapse, - size_t action) + enum counter_synapse_action action) { struct stm32_lptim_cnt *const priv = counter->priv; - size_t function; + enum counter_function function; int err; if (stm32_lptim_is_enabled(priv)) return -EBUSY; - err = stm32_lptim_cnt_function_get(counter, count, &function); + err = stm32_lptim_function_read(counter, count, &function); if (err) return err; /* only set polarity when in counter mode (on input 1) */ - if (function == STM32_LPTIM_COUNTER_INCREASE - && synapse->signal->id == count->synapses[0].signal->id) { - switch (action) { - case STM32_LPTIM_SYNAPSE_ACTION_RISING_EDGE: - case STM32_LPTIM_SYNAPSE_ACTION_FALLING_EDGE: - case STM32_LPTIM_SYNAPSE_ACTION_BOTH_EDGES: - priv->polarity = action; - return 0; - } - } + if ((enum stm32_lptim_function)function != STM32_LPTIM_COUNTER_INCREASE + || synapse->signal->id != count->synapses[0].signal->id + || action == COUNTER_SYNAPSE_ACTION_NONE) + return -EINVAL; - return -EINVAL; + priv->polarity = stm32_lptim_c2l_actions_map[action]; + + return 0; } static const struct counter_ops stm32_lptim_cnt_ops = { .count_read = stm32_lptim_cnt_read, - .function_get = stm32_lptim_cnt_function_get, - .function_set = stm32_lptim_cnt_function_set, - .action_get = stm32_lptim_cnt_action_get, - .action_set = stm32_lptim_cnt_action_set, + .function_read = stm32_lptim_function_read, + .function_write = stm32_lptim_function_write, + .action_read = stm32_lptim_cnt_action_get, + .action_write = stm32_lptim_cnt_action_set, }; static struct counter_signal stm32_lptim_cnt_signals[] = { @@ -606,8 +621,8 @@ static struct counter_synapse stm32_lptim_cnt_synapses[] = { static struct counter_count stm32_lptim_enc_counts = { .id = 0, .name = "LPTimer Count", - .functions_list = stm32_lptim_cnt_functions, - .num_functions = ARRAY_SIZE(stm32_lptim_cnt_functions), + .functions_list = stm32_lptim_functions, + .num_functions = ARRAY_SIZE(stm32_lptim_functions), .synapses = stm32_lptim_cnt_synapses, .num_synapses = ARRAY_SIZE(stm32_lptim_cnt_synapses), .ext = stm32_lptim_cnt_ext, @@ -618,7 +633,7 @@ static struct counter_count stm32_lptim_enc_counts = { static struct counter_count stm32_lptim_in1_counts = { .id = 0, .name = "LPTimer Count", - .functions_list = stm32_lptim_cnt_functions, + .functions_list = stm32_lptim_functions, .num_functions = 1, .synapses = stm32_lptim_cnt_synapses, .num_synapses = 1, diff --git a/drivers/counter/stm32-timer-cnt.c b/drivers/counter/stm32-timer-cnt.c index ef2a974a2f10..5b9b272ab8f6 100644 --- a/drivers/counter/stm32-timer-cnt.c +++ b/drivers/counter/stm32-timer-cnt.c @@ -13,6 +13,7 @@ #include <linux/module.h> #include <linux/pinctrl/consumer.h> #include <linux/platform_device.h> +#include <linux/types.h> #define TIM_CCMR_CCXS (BIT(8) | BIT(0)) #define TIM_CCMR_MASK (TIM_CCMR_CC1S | TIM_CCMR_CC2S | \ @@ -37,27 +38,27 @@ struct stm32_timer_cnt { }; /** - * enum stm32_count_function - enumerates stm32 timer counter encoder modes + * enum stm32_function - enumerates stm32 timer counter encoder modes * @STM32_COUNT_SLAVE_MODE_DISABLED: counts on internal clock when CEN=1 * @STM32_COUNT_ENCODER_MODE_1: counts TI1FP1 edges, depending on TI2FP2 level * @STM32_COUNT_ENCODER_MODE_2: counts TI2FP2 edges, depending on TI1FP1 level * @STM32_COUNT_ENCODER_MODE_3: counts on both TI1FP1 and TI2FP2 edges */ -enum stm32_count_function { +enum stm32_function { STM32_COUNT_SLAVE_MODE_DISABLED = -1, + STM32_COUNT_ENCODER_MODE_1 = COUNTER_FUNCTION_QUADRATURE_X2_A, + STM32_COUNT_ENCODER_MODE_2 = COUNTER_FUNCTION_QUADRATURE_X2_B, + STM32_COUNT_ENCODER_MODE_3 = COUNTER_FUNCTION_QUADRATURE_X4, +}; + +static const enum counter_function stm32_functions[] = { STM32_COUNT_ENCODER_MODE_1, STM32_COUNT_ENCODER_MODE_2, STM32_COUNT_ENCODER_MODE_3, }; -static enum counter_count_function stm32_count_functions[] = { - [STM32_COUNT_ENCODER_MODE_1] = COUNTER_COUNT_FUNCTION_QUADRATURE_X2_A, - [STM32_COUNT_ENCODER_MODE_2] = COUNTER_COUNT_FUNCTION_QUADRATURE_X2_B, - [STM32_COUNT_ENCODER_MODE_3] = COUNTER_COUNT_FUNCTION_QUADRATURE_X4, -}; - static int stm32_count_read(struct counter_device *counter, - struct counter_count *count, unsigned long *val) + struct counter_count *count, u64 *val) { struct stm32_timer_cnt *const priv = counter->priv; u32 cnt; @@ -69,8 +70,7 @@ static int stm32_count_read(struct counter_device *counter, } static int stm32_count_write(struct counter_device *counter, - struct counter_count *count, - const unsigned long val) + struct counter_count *count, const u64 val) { struct stm32_timer_cnt *const priv = counter->priv; @@ -80,9 +80,9 @@ static int stm32_count_write(struct counter_device *counter, return regmap_write(priv->regmap, TIM_CNT, val); } -static int stm32_count_function_get(struct counter_device *counter, - struct counter_count *count, - size_t *function) +static int stm32_function_read(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function) { struct stm32_timer_cnt *const priv = counter->priv; u32 smcr; @@ -104,9 +104,9 @@ static int stm32_count_function_get(struct counter_device *counter, return -EINVAL; } -static int stm32_count_function_set(struct counter_device *counter, - struct counter_count *count, - size_t function) +static int stm32_function_write(struct counter_device *counter, + struct counter_count *count, + enum counter_function function) { struct stm32_timer_cnt *const priv = counter->priv; u32 cr1, sms; @@ -146,78 +146,67 @@ static int stm32_count_function_set(struct counter_device *counter, return 0; } -static ssize_t stm32_count_direction_read(struct counter_device *counter, +static int stm32_count_direction_read(struct counter_device *counter, struct counter_count *count, - void *private, char *buf) + enum counter_count_direction *direction) { struct stm32_timer_cnt *const priv = counter->priv; - const char *direction; u32 cr1; regmap_read(priv->regmap, TIM_CR1, &cr1); - direction = (cr1 & TIM_CR1_DIR) ? "backward" : "forward"; + *direction = (cr1 & TIM_CR1_DIR) ? COUNTER_COUNT_DIRECTION_BACKWARD : + COUNTER_COUNT_DIRECTION_FORWARD; - return scnprintf(buf, PAGE_SIZE, "%s\n", direction); + return 0; } -static ssize_t stm32_count_ceiling_read(struct counter_device *counter, - struct counter_count *count, - void *private, char *buf) +static int stm32_count_ceiling_read(struct counter_device *counter, + struct counter_count *count, u64 *ceiling) { struct stm32_timer_cnt *const priv = counter->priv; u32 arr; regmap_read(priv->regmap, TIM_ARR, &arr); - return snprintf(buf, PAGE_SIZE, "%u\n", arr); + *ceiling = arr; + + return 0; } -static ssize_t stm32_count_ceiling_write(struct counter_device *counter, - struct counter_count *count, - void *private, - const char *buf, size_t len) +static int stm32_count_ceiling_write(struct counter_device *counter, + struct counter_count *count, u64 ceiling) { struct stm32_timer_cnt *const priv = counter->priv; - unsigned int ceiling; - int ret; - ret = kstrtouint(buf, 0, &ceiling); - if (ret) - return ret; + if (ceiling != (u32)ceiling) + return -ERANGE; /* TIMx_ARR register shouldn't be buffered (ARPE=0) */ regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_ARPE, 0); regmap_write(priv->regmap, TIM_ARR, ceiling); priv->ceiling = ceiling; - return len; + return 0; } -static ssize_t stm32_count_enable_read(struct counter_device *counter, - struct counter_count *count, - void *private, char *buf) +static int stm32_count_enable_read(struct counter_device *counter, + struct counter_count *count, u8 *enable) { struct stm32_timer_cnt *const priv = counter->priv; u32 cr1; regmap_read(priv->regmap, TIM_CR1, &cr1); - return scnprintf(buf, PAGE_SIZE, "%d\n", (bool)(cr1 & TIM_CR1_CEN)); + *enable = cr1 & TIM_CR1_CEN; + + return 0; } -static ssize_t stm32_count_enable_write(struct counter_device *counter, - struct counter_count *count, - void *private, - const char *buf, size_t len) +static int stm32_count_enable_write(struct counter_device *counter, + struct counter_count *count, u8 enable) { struct stm32_timer_cnt *const priv = counter->priv; - int err; u32 cr1; - bool enable; - - err = kstrtobool(buf, &enable); - if (err) - return err; if (enable) { regmap_read(priv->regmap, TIM_CR1, &cr1); @@ -236,48 +225,33 @@ static ssize_t stm32_count_enable_write(struct counter_device *counter, /* Keep enabled state to properly handle low power states */ priv->enabled = enable; - return len; + return 0; } -static const struct counter_count_ext stm32_count_ext[] = { - { - .name = "direction", - .read = stm32_count_direction_read, - }, - { - .name = "enable", - .read = stm32_count_enable_read, - .write = stm32_count_enable_write - }, - { - .name = "ceiling", - .read = stm32_count_ceiling_read, - .write = stm32_count_ceiling_write - }, -}; - -enum stm32_synapse_action { - STM32_SYNAPSE_ACTION_NONE, - STM32_SYNAPSE_ACTION_BOTH_EDGES +static struct counter_comp stm32_count_ext[] = { + COUNTER_COMP_DIRECTION(stm32_count_direction_read), + COUNTER_COMP_ENABLE(stm32_count_enable_read, stm32_count_enable_write), + COUNTER_COMP_CEILING(stm32_count_ceiling_read, + stm32_count_ceiling_write), }; -static enum counter_synapse_action stm32_synapse_actions[] = { - [STM32_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, - [STM32_SYNAPSE_ACTION_BOTH_EDGES] = COUNTER_SYNAPSE_ACTION_BOTH_EDGES +static const enum counter_synapse_action stm32_synapse_actions[] = { + COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES }; static int stm32_action_get(struct counter_device *counter, struct counter_count *count, struct counter_synapse *synapse, - size_t *action) + enum counter_synapse_action *action) { - size_t function; + enum counter_function function; int err; /* Default action mode (e.g. STM32_COUNT_SLAVE_MODE_DISABLED) */ - *action = STM32_SYNAPSE_ACTION_NONE; + *action = COUNTER_SYNAPSE_ACTION_NONE; - err = stm32_count_function_get(counter, count, &function); + err = stm32_function_read(counter, count, &function); if (err) return 0; @@ -285,17 +259,20 @@ static int stm32_action_get(struct counter_device *counter, case STM32_COUNT_ENCODER_MODE_1: /* counts up/down on TI1FP1 edge depending on TI2FP2 level */ if (synapse->signal->id == count->synapses[0].signal->id) - *action = STM32_SYNAPSE_ACTION_BOTH_EDGES; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; break; case STM32_COUNT_ENCODER_MODE_2: /* counts up/down on TI2FP2 edge depending on TI1FP1 level */ if (synapse->signal->id == count->synapses[1].signal->id) - *action = STM32_SYNAPSE_ACTION_BOTH_EDGES; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; break; case STM32_COUNT_ENCODER_MODE_3: /* counts up/down on both TI1FP1 and TI2FP2 edges */ - *action = STM32_SYNAPSE_ACTION_BOTH_EDGES; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; break; + default: + /* should never reach this path */ + return -EINVAL; } return 0; @@ -304,9 +281,9 @@ static int stm32_action_get(struct counter_device *counter, static const struct counter_ops stm32_timer_cnt_ops = { .count_read = stm32_count_read, .count_write = stm32_count_write, - .function_get = stm32_count_function_get, - .function_set = stm32_count_function_set, - .action_get = stm32_action_get, + .function_read = stm32_function_read, + .function_write = stm32_function_write, + .action_read = stm32_action_get, }; static struct counter_signal stm32_signals[] = { @@ -336,8 +313,8 @@ static struct counter_synapse stm32_count_synapses[] = { static struct counter_count stm32_counts = { .id = 0, .name = "Channel 1 Count", - .functions_list = stm32_count_functions, - .num_functions = ARRAY_SIZE(stm32_count_functions), + .functions_list = stm32_functions, + .num_functions = ARRAY_SIZE(stm32_functions), .synapses = stm32_count_synapses, .num_synapses = ARRAY_SIZE(stm32_count_synapses), .ext = stm32_count_ext, diff --git a/drivers/counter/ti-eqep.c b/drivers/counter/ti-eqep.c index a60aee1a1a29..6c058b93dc98 100644 --- a/drivers/counter/ti-eqep.c +++ b/drivers/counter/ti-eqep.c @@ -13,6 +13,7 @@ #include <linux/platform_device.h> #include <linux/pm_runtime.h> #include <linux/regmap.h> +#include <linux/types.h> /* 32-bit registers */ #define QPOSCNT 0x0 @@ -73,17 +74,11 @@ enum { }; /* Position Counter Input Modes */ -enum { - TI_EQEP_COUNT_FUNC_QUAD_COUNT, - TI_EQEP_COUNT_FUNC_DIR_COUNT, - TI_EQEP_COUNT_FUNC_UP_COUNT, - TI_EQEP_COUNT_FUNC_DOWN_COUNT, -}; - -enum { - TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES, - TI_EQEP_SYNAPSE_ACTION_RISING_EDGE, - TI_EQEP_SYNAPSE_ACTION_NONE, +enum ti_eqep_function { + TI_EQEP_FUNCTION_QUAD_COUNT, + TI_EQEP_FUNCTION_DIR_COUNT, + TI_EQEP_FUNCTION_UP_COUNT, + TI_EQEP_FUNCTION_DOWN_COUNT, }; struct ti_eqep_cnt { @@ -93,7 +88,7 @@ struct ti_eqep_cnt { }; static int ti_eqep_count_read(struct counter_device *counter, - struct counter_count *count, unsigned long *val) + struct counter_count *count, u64 *val) { struct ti_eqep_cnt *priv = counter->priv; u32 cnt; @@ -105,7 +100,7 @@ static int ti_eqep_count_read(struct counter_device *counter, } static int ti_eqep_count_write(struct counter_device *counter, - struct counter_count *count, unsigned long val) + struct counter_count *count, u64 val) { struct ti_eqep_cnt *priv = counter->priv; u32 max; @@ -117,62 +112,97 @@ static int ti_eqep_count_write(struct counter_device *counter, return regmap_write(priv->regmap32, QPOSCNT, val); } -static int ti_eqep_function_get(struct counter_device *counter, - struct counter_count *count, size_t *function) +static int ti_eqep_function_read(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function) { struct ti_eqep_cnt *priv = counter->priv; u32 qdecctl; regmap_read(priv->regmap16, QDECCTL, &qdecctl); - *function = (qdecctl & QDECCTL_QSRC) >> QDECCTL_QSRC_SHIFT; + + switch ((qdecctl & QDECCTL_QSRC) >> QDECCTL_QSRC_SHIFT) { + case TI_EQEP_FUNCTION_QUAD_COUNT: + *function = COUNTER_FUNCTION_QUADRATURE_X4; + break; + case TI_EQEP_FUNCTION_DIR_COUNT: + *function = COUNTER_FUNCTION_PULSE_DIRECTION; + break; + case TI_EQEP_FUNCTION_UP_COUNT: + *function = COUNTER_FUNCTION_INCREASE; + break; + case TI_EQEP_FUNCTION_DOWN_COUNT: + *function = COUNTER_FUNCTION_DECREASE; + break; + } return 0; } -static int ti_eqep_function_set(struct counter_device *counter, - struct counter_count *count, size_t function) +static int ti_eqep_function_write(struct counter_device *counter, + struct counter_count *count, + enum counter_function function) { struct ti_eqep_cnt *priv = counter->priv; + enum ti_eqep_function qsrc; + + switch (function) { + case COUNTER_FUNCTION_QUADRATURE_X4: + qsrc = TI_EQEP_FUNCTION_QUAD_COUNT; + break; + case COUNTER_FUNCTION_PULSE_DIRECTION: + qsrc = TI_EQEP_FUNCTION_DIR_COUNT; + break; + case COUNTER_FUNCTION_INCREASE: + qsrc = TI_EQEP_FUNCTION_UP_COUNT; + break; + case COUNTER_FUNCTION_DECREASE: + qsrc = TI_EQEP_FUNCTION_DOWN_COUNT; + break; + default: + return -EINVAL; + } return regmap_write_bits(priv->regmap16, QDECCTL, QDECCTL_QSRC, - function << QDECCTL_QSRC_SHIFT); + qsrc << QDECCTL_QSRC_SHIFT); } static int ti_eqep_action_get(struct counter_device *counter, struct counter_count *count, - struct counter_synapse *synapse, size_t *action) + struct counter_synapse *synapse, + enum counter_synapse_action *action) { struct ti_eqep_cnt *priv = counter->priv; - size_t function; + enum counter_function function; u32 qdecctl; int err; - err = ti_eqep_function_get(counter, count, &function); + err = ti_eqep_function_read(counter, count, &function); if (err) return err; switch (function) { - case TI_EQEP_COUNT_FUNC_QUAD_COUNT: + case COUNTER_FUNCTION_QUADRATURE_X4: /* In quadrature mode, the rising and falling edge of both * QEPA and QEPB trigger QCLK. */ - *action = TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; break; - case TI_EQEP_COUNT_FUNC_DIR_COUNT: + case COUNTER_FUNCTION_PULSE_DIRECTION: /* In direction-count mode only rising edge of QEPA is counted * and QEPB gives direction. */ switch (synapse->signal->id) { case TI_EQEP_SIGNAL_QEPA: - *action = TI_EQEP_SYNAPSE_ACTION_RISING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; break; default: - *action = TI_EQEP_SYNAPSE_ACTION_NONE; + *action = COUNTER_SYNAPSE_ACTION_NONE; break; } break; - case TI_EQEP_COUNT_FUNC_UP_COUNT: - case TI_EQEP_COUNT_FUNC_DOWN_COUNT: + case COUNTER_FUNCTION_INCREASE: + case COUNTER_FUNCTION_DECREASE: /* In up/down-count modes only QEPA is counted and QEPB is not * used. */ @@ -183,134 +213,114 @@ static int ti_eqep_action_get(struct counter_device *counter, return err; if (qdecctl & QDECCTL_XCR) - *action = TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES; + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; else - *action = TI_EQEP_SYNAPSE_ACTION_RISING_EDGE; + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; break; default: - *action = TI_EQEP_SYNAPSE_ACTION_NONE; + *action = COUNTER_SYNAPSE_ACTION_NONE; break; } break; + default: + return -EINVAL; } return 0; } static const struct counter_ops ti_eqep_counter_ops = { - .count_read = ti_eqep_count_read, - .count_write = ti_eqep_count_write, - .function_get = ti_eqep_function_get, - .function_set = ti_eqep_function_set, - .action_get = ti_eqep_action_get, + .count_read = ti_eqep_count_read, + .count_write = ti_eqep_count_write, + .function_read = ti_eqep_function_read, + .function_write = ti_eqep_function_write, + .action_read = ti_eqep_action_get, }; -static ssize_t ti_eqep_position_ceiling_read(struct counter_device *counter, - struct counter_count *count, - void *ext_priv, char *buf) +static int ti_eqep_position_ceiling_read(struct counter_device *counter, + struct counter_count *count, + u64 *ceiling) { struct ti_eqep_cnt *priv = counter->priv; u32 qposmax; regmap_read(priv->regmap32, QPOSMAX, &qposmax); - return sprintf(buf, "%u\n", qposmax); + *ceiling = qposmax; + + return 0; } -static ssize_t ti_eqep_position_ceiling_write(struct counter_device *counter, - struct counter_count *count, - void *ext_priv, const char *buf, - size_t len) +static int ti_eqep_position_ceiling_write(struct counter_device *counter, + struct counter_count *count, + u64 ceiling) { struct ti_eqep_cnt *priv = counter->priv; - int err; - u32 res; - err = kstrtouint(buf, 0, &res); - if (err < 0) - return err; + if (ceiling != (u32)ceiling) + return -ERANGE; - regmap_write(priv->regmap32, QPOSMAX, res); + regmap_write(priv->regmap32, QPOSMAX, ceiling); - return len; + return 0; } -static ssize_t ti_eqep_position_floor_read(struct counter_device *counter, - struct counter_count *count, - void *ext_priv, char *buf) +static int ti_eqep_position_floor_read(struct counter_device *counter, + struct counter_count *count, u64 *floor) { struct ti_eqep_cnt *priv = counter->priv; u32 qposinit; regmap_read(priv->regmap32, QPOSINIT, &qposinit); - return sprintf(buf, "%u\n", qposinit); + *floor = qposinit; + + return 0; } -static ssize_t ti_eqep_position_floor_write(struct counter_device *counter, - struct counter_count *count, - void *ext_priv, const char *buf, - size_t len) +static int ti_eqep_position_floor_write(struct counter_device *counter, + struct counter_count *count, u64 floor) { struct ti_eqep_cnt *priv = counter->priv; - int err; - u32 res; - err = kstrtouint(buf, 0, &res); - if (err < 0) - return err; + if (floor != (u32)floor) + return -ERANGE; - regmap_write(priv->regmap32, QPOSINIT, res); + regmap_write(priv->regmap32, QPOSINIT, floor); - return len; + return 0; } -static ssize_t ti_eqep_position_enable_read(struct counter_device *counter, - struct counter_count *count, - void *ext_priv, char *buf) +static int ti_eqep_position_enable_read(struct counter_device *counter, + struct counter_count *count, u8 *enable) { struct ti_eqep_cnt *priv = counter->priv; u32 qepctl; regmap_read(priv->regmap16, QEPCTL, &qepctl); - return sprintf(buf, "%u\n", !!(qepctl & QEPCTL_PHEN)); + *enable = !!(qepctl & QEPCTL_PHEN); + + return 0; } -static ssize_t ti_eqep_position_enable_write(struct counter_device *counter, - struct counter_count *count, - void *ext_priv, const char *buf, - size_t len) +static int ti_eqep_position_enable_write(struct counter_device *counter, + struct counter_count *count, u8 enable) { struct ti_eqep_cnt *priv = counter->priv; - int err; - bool res; - - err = kstrtobool(buf, &res); - if (err < 0) - return err; - regmap_write_bits(priv->regmap16, QEPCTL, QEPCTL_PHEN, res ? -1 : 0); + regmap_write_bits(priv->regmap16, QEPCTL, QEPCTL_PHEN, enable ? -1 : 0); - return len; + return 0; } -static struct counter_count_ext ti_eqep_position_ext[] = { - { - .name = "ceiling", - .read = ti_eqep_position_ceiling_read, - .write = ti_eqep_position_ceiling_write, - }, - { - .name = "floor", - .read = ti_eqep_position_floor_read, - .write = ti_eqep_position_floor_write, - }, - { - .name = "enable", - .read = ti_eqep_position_enable_read, - .write = ti_eqep_position_enable_write, - }, +static struct counter_comp ti_eqep_position_ext[] = { + COUNTER_COMP_CEILING(ti_eqep_position_ceiling_read, + ti_eqep_position_ceiling_write), + COUNTER_COMP_FLOOR(ti_eqep_position_floor_read, + ti_eqep_position_floor_write), + COUNTER_COMP_ENABLE(ti_eqep_position_enable_read, + ti_eqep_position_enable_write), }; static struct counter_signal ti_eqep_signals[] = { @@ -324,17 +334,17 @@ static struct counter_signal ti_eqep_signals[] = { }, }; -static const enum counter_count_function ti_eqep_position_functions[] = { - [TI_EQEP_COUNT_FUNC_QUAD_COUNT] = COUNTER_COUNT_FUNCTION_QUADRATURE_X4, - [TI_EQEP_COUNT_FUNC_DIR_COUNT] = COUNTER_COUNT_FUNCTION_PULSE_DIRECTION, - [TI_EQEP_COUNT_FUNC_UP_COUNT] = COUNTER_COUNT_FUNCTION_INCREASE, - [TI_EQEP_COUNT_FUNC_DOWN_COUNT] = COUNTER_COUNT_FUNCTION_DECREASE, +static const enum counter_function ti_eqep_position_functions[] = { + COUNTER_FUNCTION_QUADRATURE_X4, + COUNTER_FUNCTION_PULSE_DIRECTION, + COUNTER_FUNCTION_INCREASE, + COUNTER_FUNCTION_DECREASE, }; static const enum counter_synapse_action ti_eqep_position_synapse_actions[] = { - [TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES] = COUNTER_SYNAPSE_ACTION_BOTH_EDGES, - [TI_EQEP_SYNAPSE_ACTION_RISING_EDGE] = COUNTER_SYNAPSE_ACTION_RISING_EDGE, - [TI_EQEP_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_NONE, }; static struct counter_synapse ti_eqep_position_synapses[] = { diff --git a/include/linux/counter.h b/include/linux/counter.h index 9dbd5df4cd34..2f01e1fec857 100644 --- a/include/linux/counter.h +++ b/include/linux/counter.h @@ -6,417 +6,290 @@ #ifndef _COUNTER_H_ #define _COUNTER_H_ -#include <linux/counter_enum.h> #include <linux/device.h> +#include <linux/kernel.h> #include <linux/types.h> +struct counter_device; +struct counter_count; +struct counter_synapse; +struct counter_signal; + +enum counter_comp_type { + COUNTER_COMP_U8, + COUNTER_COMP_U64, + COUNTER_COMP_BOOL, + COUNTER_COMP_SIGNAL_LEVEL, + COUNTER_COMP_FUNCTION, + COUNTER_COMP_SYNAPSE_ACTION, + COUNTER_COMP_ENUM, + COUNTER_COMP_COUNT_DIRECTION, + COUNTER_COMP_COUNT_MODE, +}; + +enum counter_scope { + COUNTER_SCOPE_DEVICE, + COUNTER_SCOPE_SIGNAL, + COUNTER_SCOPE_COUNT, +}; + enum counter_count_direction { - COUNTER_COUNT_DIRECTION_FORWARD = 0, - COUNTER_COUNT_DIRECTION_BACKWARD + COUNTER_COUNT_DIRECTION_FORWARD, + COUNTER_COUNT_DIRECTION_BACKWARD, }; -extern const char *const counter_count_direction_str[2]; enum counter_count_mode { - COUNTER_COUNT_MODE_NORMAL = 0, + COUNTER_COUNT_MODE_NORMAL, COUNTER_COUNT_MODE_RANGE_LIMIT, COUNTER_COUNT_MODE_NON_RECYCLE, - COUNTER_COUNT_MODE_MODULO_N + COUNTER_COUNT_MODE_MODULO_N, }; -extern const char *const counter_count_mode_str[4]; -struct counter_device; -struct counter_signal; +enum counter_function { + COUNTER_FUNCTION_INCREASE, + COUNTER_FUNCTION_DECREASE, + COUNTER_FUNCTION_PULSE_DIRECTION, + COUNTER_FUNCTION_QUADRATURE_X1_A, + COUNTER_FUNCTION_QUADRATURE_X1_B, + COUNTER_FUNCTION_QUADRATURE_X2_A, + COUNTER_FUNCTION_QUADRATURE_X2_B, + COUNTER_FUNCTION_QUADRATURE_X4, +}; + +enum counter_signal_level { + COUNTER_SIGNAL_LEVEL_LOW, + COUNTER_SIGNAL_LEVEL_HIGH, +}; + +enum counter_synapse_action { + COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, +}; /** - * struct counter_signal_ext - Counter Signal extensions - * @name: attribute name - * @read: read callback for this attribute; may be NULL - * @write: write callback for this attribute; may be NULL - * @priv: data private to the driver + * struct counter_comp - Counter component node + * @type: Counter component data type + * @name: device-specific component name + * @priv: component-relevant data + * @action_read Synapse action mode read callback. The read value of the + * respective Synapse action mode should be passed back via + * the action parameter. + * @device_u8_read Device u8 component read callback. The read value of the + * respective Device u8 component should be passed back via + * the val parameter. + * @count_u8_read Count u8 component read callback. The read value of the + * respective Count u8 component should be passed back via + * the val parameter. + * @signal_u8_read Signal u8 component read callback. The read value of the + * respective Signal u8 component should be passed back via + * the val parameter. + * @device_u32_read Device u32 component read callback. The read value of + * the respective Device u32 component should be passed + * back via the val parameter. + * @count_u32_read Count u32 component read callback. The read value of the + * respective Count u32 component should be passed back via + * the val parameter. + * @signal_u32_read Signal u32 component read callback. The read value of + * the respective Signal u32 component should be passed + * back via the val parameter. + * @device_u64_read Device u64 component read callback. The read value of + * the respective Device u64 component should be passed + * back via the val parameter. + * @count_u64_read Count u64 component read callback. The read value of the + * respective Count u64 component should be passed back via + * the val parameter. + * @signal_u64_read Signal u64 component read callback. The read value of + * the respective Signal u64 component should be passed + * back via the val parameter. + * @action_write Synapse action mode write callback. The write value of + * the respective Synapse action mode is passed via the + * action parameter. + * @device_u8_write Device u8 component write callback. The write value of + * the respective Device u8 component is passed via the val + * parameter. + * @count_u8_write Count u8 component write callback. The write value of + * the respective Count u8 component is passed via the val + * parameter. + * @signal_u8_write Signal u8 component write callback. The write value of + * the respective Signal u8 component is passed via the val + * parameter. + * @device_u32_write Device u32 component write callback. The write value of + * the respective Device u32 component is passed via the + * val parameter. + * @count_u32_write Count u32 component write callback. The write value of + * the respective Count u32 component is passed via the val + * parameter. + * @signal_u32_write Signal u32 component write callback. The write value of + * the respective Signal u32 component is passed via the + * val parameter. + * @device_u64_write Device u64 component write callback. The write value of + * the respective Device u64 component is passed via the + * val parameter. + * @count_u64_write Count u64 component write callback. The write value of + * the respective Count u64 component is passed via the val + * parameter. + * @signal_u64_write Signal u64 component write callback. The write value of + * the respective Signal u64 component is passed via the + * val parameter. */ -struct counter_signal_ext { +struct counter_comp { + enum counter_comp_type type; const char *name; - ssize_t (*read)(struct counter_device *counter, - struct counter_signal *signal, void *priv, char *buf); - ssize_t (*write)(struct counter_device *counter, - struct counter_signal *signal, void *priv, - const char *buf, size_t len); void *priv; + union { + int (*action_read)(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action *action); + int (*device_u8_read)(struct counter_device *counter, u8 *val); + int (*count_u8_read)(struct counter_device *counter, + struct counter_count *count, u8 *val); + int (*signal_u8_read)(struct counter_device *counter, + struct counter_signal *signal, u8 *val); + int (*device_u32_read)(struct counter_device *counter, + u32 *val); + int (*count_u32_read)(struct counter_device *counter, + struct counter_count *count, u32 *val); + int (*signal_u32_read)(struct counter_device *counter, + struct counter_signal *signal, u32 *val); + int (*device_u64_read)(struct counter_device *counter, + u64 *val); + int (*count_u64_read)(struct counter_device *counter, + struct counter_count *count, u64 *val); + int (*signal_u64_read)(struct counter_device *counter, + struct counter_signal *signal, u64 *val); + }; + union { + int (*action_write)(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action action); + int (*device_u8_write)(struct counter_device *counter, u8 val); + int (*count_u8_write)(struct counter_device *counter, + struct counter_count *count, u8 val); + int (*signal_u8_write)(struct counter_device *counter, + struct counter_signal *signal, u8 val); + int (*device_u32_write)(struct counter_device *counter, + u32 val); + int (*count_u32_write)(struct counter_device *counter, + struct counter_count *count, u32 val); + int (*signal_u32_write)(struct counter_device *counter, + struct counter_signal *signal, u32 val); + int (*device_u64_write)(struct counter_device *counter, + u64 val); + int (*count_u64_write)(struct counter_device *counter, + struct counter_count *count, u64 val); + int (*signal_u64_write)(struct counter_device *counter, + struct counter_signal *signal, u64 val); + }; }; /** * struct counter_signal - Counter Signal node - * @id: unique ID used to identify signal - * @name: device-specific Signal name; ideally, this should match the name - * as it appears in the datasheet documentation - * @ext: optional array of Counter Signal extensions - * @num_ext: number of Counter Signal extensions specified in @ext - * @priv: optional private data supplied by driver + * @id: unique ID used to identify the Signal + * @name: device-specific Signal name + * @ext: optional array of Signal extensions + * @num_ext: number of Signal extensions specified in @ext */ struct counter_signal { int id; const char *name; - const struct counter_signal_ext *ext; + struct counter_comp *ext; size_t num_ext; - - void *priv; -}; - -/** - * struct counter_signal_enum_ext - Signal enum extension attribute - * @items: Array of strings - * @num_items: Number of items specified in @items - * @set: Set callback function; may be NULL - * @get: Get callback function; may be NULL - * - * The counter_signal_enum_ext structure can be used to implement enum style - * Signal extension attributes. Enum style attributes are those which have a set - * of strings that map to unsigned integer values. The Generic Counter Signal - * enum extension helper code takes care of mapping between value and string, as - * well as generating a "_available" file which contains a list of all available - * items. The get callback is used to query the currently active item; the index - * of the item within the respective items array is returned via the 'item' - * parameter. The set callback is called when the attribute is updated; the - * 'item' parameter contains the index of the newly activated item within the - * respective items array. - */ -struct counter_signal_enum_ext { - const char * const *items; - size_t num_items; - int (*get)(struct counter_device *counter, - struct counter_signal *signal, size_t *item); - int (*set)(struct counter_device *counter, - struct counter_signal *signal, size_t item); -}; - -/** - * COUNTER_SIGNAL_ENUM() - Initialize Signal enum extension - * @_name: Attribute name - * @_e: Pointer to a counter_signal_enum_ext structure - * - * This should usually be used together with COUNTER_SIGNAL_ENUM_AVAILABLE() - */ -#define COUNTER_SIGNAL_ENUM(_name, _e) \ -{ \ - .name = (_name), \ - .read = counter_signal_enum_read, \ - .write = counter_signal_enum_write, \ - .priv = (_e) \ -} - -/** - * COUNTER_SIGNAL_ENUM_AVAILABLE() - Initialize Signal enum available extension - * @_name: Attribute name ("_available" will be appended to the name) - * @_e: Pointer to a counter_signal_enum_ext structure - * - * Creates a read only attribute that lists all the available enum items in a - * newline separated list. This should usually be used together with - * COUNTER_SIGNAL_ENUM() - */ -#define COUNTER_SIGNAL_ENUM_AVAILABLE(_name, _e) \ -{ \ - .name = (_name "_available"), \ - .read = counter_signal_enum_available_read, \ - .priv = (_e) \ -} - -enum counter_synapse_action { - COUNTER_SYNAPSE_ACTION_NONE = 0, - COUNTER_SYNAPSE_ACTION_RISING_EDGE, - COUNTER_SYNAPSE_ACTION_FALLING_EDGE, - COUNTER_SYNAPSE_ACTION_BOTH_EDGES }; /** * struct counter_synapse - Counter Synapse node - * @action: index of current action mode * @actions_list: array of available action modes * @num_actions: number of action modes specified in @actions_list - * @signal: pointer to associated signal + * @signal: pointer to the associated Signal */ struct counter_synapse { - size_t action; const enum counter_synapse_action *actions_list; size_t num_actions; struct counter_signal *signal; }; -struct counter_count; - -/** - * struct counter_count_ext - Counter Count extension - * @name: attribute name - * @read: read callback for this attribute; may be NULL - * @write: write callback for this attribute; may be NULL - * @priv: data private to the driver - */ -struct counter_count_ext { - const char *name; - ssize_t (*read)(struct counter_device *counter, - struct counter_count *count, void *priv, char *buf); - ssize_t (*write)(struct counter_device *counter, - struct counter_count *count, void *priv, - const char *buf, size_t len); - void *priv; -}; - -enum counter_count_function { - COUNTER_COUNT_FUNCTION_INCREASE = 0, - COUNTER_COUNT_FUNCTION_DECREASE, - COUNTER_COUNT_FUNCTION_PULSE_DIRECTION, - COUNTER_COUNT_FUNCTION_QUADRATURE_X1_A, - COUNTER_COUNT_FUNCTION_QUADRATURE_X1_B, - COUNTER_COUNT_FUNCTION_QUADRATURE_X2_A, - COUNTER_COUNT_FUNCTION_QUADRATURE_X2_B, - COUNTER_COUNT_FUNCTION_QUADRATURE_X4 -}; - /** * struct counter_count - Counter Count node - * @id: unique ID used to identify Count - * @name: device-specific Count name; ideally, this should match - * the name as it appears in the datasheet documentation - * @function: index of current function mode - * @functions_list: array available function modes + * @id: unique ID used to identify the Count + * @name: device-specific Count name + * @functions_list: array of available function modes * @num_functions: number of function modes specified in @functions_list - * @synapses: array of synapses for initialization - * @num_synapses: number of synapses specified in @synapses - * @ext: optional array of Counter Count extensions - * @num_ext: number of Counter Count extensions specified in @ext - * @priv: optional private data supplied by driver + * @synapses: array of Synapses for initialization + * @num_synapses: number of Synapses specified in @synapses + * @ext: optional array of Count extensions + * @num_ext: number of Count extensions specified in @ext */ struct counter_count { int id; const char *name; - size_t function; - const enum counter_count_function *functions_list; + const enum counter_function *functions_list; size_t num_functions; struct counter_synapse *synapses; size_t num_synapses; - const struct counter_count_ext *ext; + struct counter_comp *ext; size_t num_ext; - - void *priv; -}; - -/** - * struct counter_count_enum_ext - Count enum extension attribute - * @items: Array of strings - * @num_items: Number of items specified in @items - * @set: Set callback function; may be NULL - * @get: Get callback function; may be NULL - * - * The counter_count_enum_ext structure can be used to implement enum style - * Count extension attributes. Enum style attributes are those which have a set - * of strings that map to unsigned integer values. The Generic Counter Count - * enum extension helper code takes care of mapping between value and string, as - * well as generating a "_available" file which contains a list of all available - * items. The get callback is used to query the currently active item; the index - * of the item within the respective items array is returned via the 'item' - * parameter. The set callback is called when the attribute is updated; the - * 'item' parameter contains the index of the newly activated item within the - * respective items array. - */ -struct counter_count_enum_ext { - const char * const *items; - size_t num_items; - int (*get)(struct counter_device *counter, struct counter_count *count, - size_t *item); - int (*set)(struct counter_device *counter, struct counter_count *count, - size_t item); -}; - -/** - * COUNTER_COUNT_ENUM() - Initialize Count enum extension - * @_name: Attribute name - * @_e: Pointer to a counter_count_enum_ext structure - * - * This should usually be used together with COUNTER_COUNT_ENUM_AVAILABLE() - */ -#define COUNTER_COUNT_ENUM(_name, _e) \ -{ \ - .name = (_name), \ - .read = counter_count_enum_read, \ - .write = counter_count_enum_write, \ - .priv = (_e) \ -} - -/** - * COUNTER_COUNT_ENUM_AVAILABLE() - Initialize Count enum available extension - * @_name: Attribute name ("_available" will be appended to the name) - * @_e: Pointer to a counter_count_enum_ext structure - * - * Creates a read only attribute that lists all the available enum items in a - * newline separated list. This should usually be used together with - * COUNTER_COUNT_ENUM() - */ -#define COUNTER_COUNT_ENUM_AVAILABLE(_name, _e) \ -{ \ - .name = (_name "_available"), \ - .read = counter_count_enum_available_read, \ - .priv = (_e) \ -} - -/** - * struct counter_device_attr_group - internal container for attribute group - * @attr_group: Counter sysfs attributes group - * @attr_list: list to keep track of created Counter sysfs attributes - * @num_attr: number of Counter sysfs attributes - */ -struct counter_device_attr_group { - struct attribute_group attr_group; - struct list_head attr_list; - size_t num_attr; -}; - -/** - * struct counter_device_state - internal state container for a Counter device - * @id: unique ID used to identify the Counter - * @dev: internal device structure - * @groups_list: attribute groups list (for Signals, Counts, and ext) - * @num_groups: number of attribute groups containers - * @groups: Counter sysfs attribute groups (to populate @dev.groups) - */ -struct counter_device_state { - int id; - struct device dev; - struct counter_device_attr_group *groups_list; - size_t num_groups; - const struct attribute_group **groups; -}; - -enum counter_signal_value { - COUNTER_SIGNAL_LOW = 0, - COUNTER_SIGNAL_HIGH }; /** * struct counter_ops - Callbacks from driver - * @signal_read: optional read callback for Signal attribute. The read - * value of the respective Signal should be passed back via - * the val parameter. - * @count_read: optional read callback for Count attribute. The read - * value of the respective Count should be passed back via - * the val parameter. - * @count_write: optional write callback for Count attribute. The write - * value for the respective Count is passed in via the val + * @signal_read: read callback for Signals. The read level of the + * respective Signal should be passed back via the level * parameter. - * @function_get: function to get the current count function mode. Returns - * 0 on success and negative error code on error. The index - * of the respective Count's returned function mode should - * be passed back via the function parameter. - * @function_set: function to set the count function mode. function is the - * index of the requested function mode from the respective - * Count's functions_list array. - * @action_get: function to get the current action mode. Returns 0 on - * success and negative error code on error. The index of - * the respective Synapse's returned action mode should be - * passed back via the action parameter. - * @action_set: function to set the action mode. action is the index of - * the requested action mode from the respective Synapse's - * actions_list array. + * @count_read: read callback for Counts. The read value of the + * respective Count should be passed back via the value + * parameter. + * @count_write: write callback for Counts. The write value for the + * respective Count is passed in via the value parameter. + * @function_read: read callback the Count function modes. The read + * function mode of the respective Count should be passed + * back via the function parameter. + * @function_write: write callback for Count function modes. The function + * mode to write for the respective Count is passed in via + * the function parameter. + * @action_read: read callback the Synapse action modes. The read action + * mode of the respective Synapse should be passed back via + * the action parameter. + * @action_write: write callback for Synapse action modes. The action mode + * to write for the respective Synapse is passed in via the + * action parameter. */ struct counter_ops { int (*signal_read)(struct counter_device *counter, struct counter_signal *signal, - enum counter_signal_value *val); + enum counter_signal_level *level); int (*count_read)(struct counter_device *counter, - struct counter_count *count, unsigned long *val); + struct counter_count *count, u64 *value); int (*count_write)(struct counter_device *counter, - struct counter_count *count, unsigned long val); - int (*function_get)(struct counter_device *counter, - struct counter_count *count, size_t *function); - int (*function_set)(struct counter_device *counter, - struct counter_count *count, size_t function); - int (*action_get)(struct counter_device *counter, - struct counter_count *count, - struct counter_synapse *synapse, size_t *action); - int (*action_set)(struct counter_device *counter, - struct counter_count *count, - struct counter_synapse *synapse, size_t action); + struct counter_count *count, u64 value); + int (*function_read)(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function); + int (*function_write)(struct counter_device *counter, + struct counter_count *count, + enum counter_function function); + int (*action_read)(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action *action); + int (*action_write)(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action action); }; -/** - * struct counter_device_ext - Counter device extension - * @name: attribute name - * @read: read callback for this attribute; may be NULL - * @write: write callback for this attribute; may be NULL - * @priv: data private to the driver - */ -struct counter_device_ext { - const char *name; - ssize_t (*read)(struct counter_device *counter, void *priv, char *buf); - ssize_t (*write)(struct counter_device *counter, void *priv, - const char *buf, size_t len); - void *priv; -}; - -/** - * struct counter_device_enum_ext - Counter enum extension attribute - * @items: Array of strings - * @num_items: Number of items specified in @items - * @set: Set callback function; may be NULL - * @get: Get callback function; may be NULL - * - * The counter_device_enum_ext structure can be used to implement enum style - * Counter extension attributes. Enum style attributes are those which have a - * set of strings that map to unsigned integer values. The Generic Counter enum - * extension helper code takes care of mapping between value and string, as well - * as generating a "_available" file which contains a list of all available - * items. The get callback is used to query the currently active item; the index - * of the item within the respective items array is returned via the 'item' - * parameter. The set callback is called when the attribute is updated; the - * 'item' parameter contains the index of the newly activated item within the - * respective items array. - */ -struct counter_device_enum_ext { - const char * const *items; - size_t num_items; - int (*get)(struct counter_device *counter, size_t *item); - int (*set)(struct counter_device *counter, size_t item); -}; - -/** - * COUNTER_DEVICE_ENUM() - Initialize Counter enum extension - * @_name: Attribute name - * @_e: Pointer to a counter_device_enum_ext structure - * - * This should usually be used together with COUNTER_DEVICE_ENUM_AVAILABLE() - */ -#define COUNTER_DEVICE_ENUM(_name, _e) \ -{ \ - .name = (_name), \ - .read = counter_device_enum_read, \ - .write = counter_device_enum_write, \ - .priv = (_e) \ -} - -/** - * COUNTER_DEVICE_ENUM_AVAILABLE() - Initialize Counter enum available extension - * @_name: Attribute name ("_available" will be appended to the name) - * @_e: Pointer to a counter_device_enum_ext structure - * - * Creates a read only attribute that lists all the available enum items in a - * newline separated list. This should usually be used together with - * COUNTER_DEVICE_ENUM() - */ -#define COUNTER_DEVICE_ENUM_AVAILABLE(_name, _e) \ -{ \ - .name = (_name "_available"), \ - .read = counter_device_enum_available_read, \ - .priv = (_e) \ -} - /** * struct counter_device - Counter data structure - * @name: name of the device as it appears in the datasheet + * @name: name of the device * @parent: optional parent device providing the counters - * @device_state: internal device state container * @ops: callbacks from driver * @signals: array of Signals * @num_signals: number of Signals specified in @signals @@ -425,11 +298,12 @@ struct counter_device_enum_ext { * @ext: optional array of Counter device extensions * @num_ext: number of Counter device extensions specified in @ext * @priv: optional private data supplied by driver + * @id: unique ID used to identify the Counter + * @dev: internal device structure */ struct counter_device { const char *name; struct device *parent; - struct counter_device_state *device_state; const struct counter_ops *ops; @@ -438,17 +312,160 @@ struct counter_device { struct counter_count *counts; size_t num_counts; - const struct counter_device_ext *ext; + struct counter_comp *ext; size_t num_ext; void *priv; + + int id; + struct device dev; }; int counter_register(struct counter_device *const counter); void counter_unregister(struct counter_device *const counter); int devm_counter_register(struct device *dev, struct counter_device *const counter); -void devm_counter_unregister(struct device *dev, - struct counter_device *const counter); + +#define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_U8, \ + .name = (_name), \ + .device_u8_read = (_read), \ + .device_u8_write = (_write), \ +} +#define COUNTER_COMP_COUNT_U8(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_U8, \ + .name = (_name), \ + .count_u8_read = (_read), \ + .count_u8_write = (_write), \ +} +#define COUNTER_COMP_SIGNAL_U8(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_U8, \ + .name = (_name), \ + .signal_u8_read = (_read), \ + .signal_u8_write = (_write), \ +} + +#define COUNTER_COMP_DEVICE_U64(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_U64, \ + .name = (_name), \ + .device_u64_read = (_read), \ + .device_u64_write = (_write), \ +} +#define COUNTER_COMP_COUNT_U64(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_U64, \ + .name = (_name), \ + .count_u64_read = (_read), \ + .count_u64_write = (_write), \ +} +#define COUNTER_COMP_SIGNAL_U64(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_U64, \ + .name = (_name), \ + .signal_u64_read = (_read), \ + .signal_u64_write = (_write), \ +} + +#define COUNTER_COMP_DEVICE_BOOL(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_BOOL, \ + .name = (_name), \ + .device_u8_read = (_read), \ + .device_u8_write = (_write), \ +} +#define COUNTER_COMP_COUNT_BOOL(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_BOOL, \ + .name = (_name), \ + .count_u8_read = (_read), \ + .count_u8_write = (_write), \ +} +#define COUNTER_COMP_SIGNAL_BOOL(_name, _read, _write) \ +{ \ + .type = COUNTER_COMP_BOOL, \ + .name = (_name), \ + .signal_u8_read = (_read), \ + .signal_u8_write = (_write), \ +} + +struct counter_available { + union { + const u32 *enums; + const char *const *strs; + }; + size_t num_items; +}; + +#define DEFINE_COUNTER_AVAILABLE(_name, _enums) \ + struct counter_available _name = { \ + .enums = (_enums), \ + .num_items = ARRAY_SIZE(_enums), \ + } + +#define DEFINE_COUNTER_ENUM(_name, _strs) \ + struct counter_available _name = { \ + .strs = (_strs), \ + .num_items = ARRAY_SIZE(_strs), \ + } + +#define COUNTER_COMP_DEVICE_ENUM(_name, _get, _set, _available) \ +{ \ + .type = COUNTER_COMP_ENUM, \ + .name = (_name), \ + .device_u32_read = (_get), \ + .device_u32_write = (_set), \ + .priv = &(_available), \ +} +#define COUNTER_COMP_COUNT_ENUM(_name, _get, _set, _available) \ +{ \ + .type = COUNTER_COMP_ENUM, \ + .name = (_name), \ + .count_u32_read = (_get), \ + .count_u32_write = (_set), \ + .priv = &(_available), \ +} +#define COUNTER_COMP_SIGNAL_ENUM(_name, _get, _set, _available) \ +{ \ + .type = COUNTER_COMP_ENUM, \ + .name = (_name), \ + .signal_u32_read = (_get), \ + .signal_u32_write = (_set), \ + .priv = &(_available), \ +} + +#define COUNTER_COMP_CEILING(_read, _write) \ + COUNTER_COMP_COUNT_U64("ceiling", _read, _write) + +#define COUNTER_COMP_COUNT_MODE(_read, _write, _available) \ +{ \ + .type = COUNTER_COMP_COUNT_MODE, \ + .name = "count_mode", \ + .count_u32_read = (_read), \ + .count_u32_write = (_write), \ + .priv = &(_available), \ +} + +#define COUNTER_COMP_DIRECTION(_read) \ +{ \ + .type = COUNTER_COMP_COUNT_DIRECTION, \ + .name = "direction", \ + .count_u32_read = (_read), \ +} + +#define COUNTER_COMP_ENABLE(_read, _write) \ + COUNTER_COMP_COUNT_BOOL("enable", _read, _write) + +#define COUNTER_COMP_FLOOR(_read, _write) \ + COUNTER_COMP_COUNT_U64("floor", _read, _write) + +#define COUNTER_COMP_PRESET(_read, _write) \ + COUNTER_COMP_COUNT_U64("preset", _read, _write) + +#define COUNTER_COMP_PRESET_ENABLE(_read, _write) \ + COUNTER_COMP_COUNT_BOOL("preset_enable", _read, _write) #endif /* _COUNTER_H_ */ diff --git a/include/linux/counter_enum.h b/include/linux/counter_enum.h deleted file mode 100644 index 9f917298a88f..000000000000 --- a/include/linux/counter_enum.h +++ /dev/null @@ -1,45 +0,0 @@ -/* SPDX-License-Identifier: GPL-2.0 */ -/* - * Counter interface enum functions - * Copyright (C) 2018 William Breathitt Gray - */ -#ifndef _COUNTER_ENUM_H_ -#define _COUNTER_ENUM_H_ - -#include <linux/types.h> - -struct counter_device; -struct counter_signal; -struct counter_count; - -ssize_t counter_signal_enum_read(struct counter_device *counter, - struct counter_signal *signal, void *priv, - char *buf); -ssize_t counter_signal_enum_write(struct counter_device *counter, - struct counter_signal *signal, void *priv, - const char *buf, size_t len); - -ssize_t counter_signal_enum_available_read(struct counter_device *counter, - struct counter_signal *signal, - void *priv, char *buf); - -ssize_t counter_count_enum_read(struct counter_device *counter, - struct counter_count *count, void *priv, - char *buf); -ssize_t counter_count_enum_write(struct counter_device *counter, - struct counter_count *count, void *priv, - const char *buf, size_t len); - -ssize_t counter_count_enum_available_read(struct counter_device *counter, - struct counter_count *count, - void *priv, char *buf); - -ssize_t counter_device_enum_read(struct counter_device *counter, void *priv, - char *buf); -ssize_t counter_device_enum_write(struct counter_device *counter, void *priv, - const char *buf, size_t len); - -ssize_t counter_device_enum_available_read(struct counter_device *counter, - void *priv, char *buf); - -#endif /* _COUNTER_ENUM_H_ */ -- 2.29.2 ^ permalink raw reply related [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code 2020-12-26 0:15 ` [PATCH v7 1/5] counter: Internalize sysfs interface code William Breathitt Gray @ 2020-12-30 14:37 ` Jonathan Cameron 2021-01-06 5:29 ` William Breathitt Gray 2020-12-30 23:24 ` David Lechner 1 sibling, 1 reply; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 14:37 UTC (permalink / raw) To: William Breathitt Gray Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter On Fri, 25 Dec 2020 19:15:34 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > This is a reimplementation of the Generic Counter driver interface. > There are no modifications to the Counter subsystem userspace interface, > so existing userspace applications should continue to run seamlessly. Hi William Been a while since I looked at this series. Its rather big and I'm lazy (or busy depending on who I'm talking to :) Hmm. I'm a bit in two minds about how you should handle the huge amount of description here. Some of it clearly belongs in the kernel docs (and some is I think put there in a later patch). Other parts are specific to this series, but I'm not 100% sure this much detail is really useful in the git log. Note that we now have links to the threads for all patches applied using b4 (which this will be) so it's fine to have really detailed stuff in cover letters rather than the individual patches. One thing that would be handy for review, might be if you put up a tree somewhere with this applied and included a link. Mind you I don't feel that strongly about it if it you do want to maintain it in the individual patch descriptions. I've been a bit lazy and not cropped this down as much as I ideally should have done (to include only bits I'm commenting on). Anyhow, various minor things inline but this fundamentally looks fine to me. Jonathan > > Overview > ======== > > The purpose of this patch is to internalize the sysfs interface code > among the various counter drivers into a shared module. Counter drivers > pass and take data natively (i.e. u8, u64, etc.) and the shared counter > module handles the translation between the sysfs interface. Confusing statement. Between the sysfs interface and what? Perhaps "handles the translation to/from the sysfs interface." > This > guarantees a standard userspace interface for all counter drivers, and > helps generalize the Generic Counter driver ABI in order to support the > Generic Counter chrdev interface (introduced in a subsequent patch) > without significant changes to the existing counter drivers. > > A high-level view of how a count value is passed down from a counter > driver is exemplified by the following. The driver callbacks are first > registered to the Counter core component for use by the Counter > userspace interface components: > > +----------------------------+ > | Counter device driver | Looks like something snuck a tab in amongst your spaces. > +----------------------------+ > | Processes data from device | > +----------------------------+ > | > ------------------- > / driver callbacks / > ------------------- > | > V > +----------------------+ > | Counter core | > +----------------------+ > | Routes device driver | > | callbacks to the | > | userspace interfaces | > +----------------------+ > | > ------------------- > / driver callbacks / > ------------------- > | > +---------------+ > | > V > +--------------------+ > | Counter sysfs | > +--------------------+ > | Translates to the | > | standard Counter | > | sysfs output | > +--------------------+ > > Thereafter, data can be transferred directly between the Counter device > driver and Counter userspace interface: > > ---------------------- > / Counter device \ > +----------------------+ > | Count register: 0x28 | > +----------------------+ > | > ----------------- > / raw count data / > ----------------- > | > V > +----------------------------+ > | Counter device driver | > +----------------------------+ > | Processes data from device | > |----------------------------| > | Type: u64 | > | Value: 42 | > +----------------------------+ > | > ---------- > / u64 / > ---------- > | > +---------------+ > | > V > +--------------------+ > | Counter sysfs | > +--------------------+ > | Translates to the | > | standard Counter | > | sysfs output | > |--------------------| > | Type: const char * | > | Value: "42" | > +--------------------+ > | > --------------- > / const char * / > --------------- > | > V > +--------------------------------------------------+ > | `/sys/bus/counter/devices/counterX/countY/count` | > +--------------------------------------------------+ > \ Count: "42" / > -------------------------------------------------- > > There are three primary components involved: > > Counter device driver > --------------------- > Communicates with the hardware device to read/write data; e.g. counter > drivers for quadrature encoders, timers, etc. > > Counter core > ------------ > Registers the counter device driver to the system so that the respective > callbacks are called during userspace interaction. > > Counter sysfs > ------------- > Translates counter data to the standard Counter sysfs interface format > and vice versa. > > Driver ABI > ========== > > This reimplementation entails several changes to the driver ABI. In > particular, the device driver callbacks are now expected to handle > standard C datatypes rather than translating the sysfs I/O directly. > > To that end, the struct counter_comp structure is introduced to > establish counter extensions for Signals, Synapses, and Counts. > > The "type" member specifies the type of high-level data (e.g. BOOL, > COUNT_DIRECTION, etc.) handled by this extension. The "*_read" and > "*_write" members can then be set by the counter device driver with > callbacks to handle that data using native C data types (i.e. u8, u64, > etc.). > > Convenience macros such as COUNTER_COMP_COUNT_U64 are provided for use > by driver authors. In particular, driver authors are expected to use > the provided macros for standard Counter subsystem attributes in order > to maintain a consistent interface for userspace. For example, a counter > device driver may define several standard attributes like so: > > struct counter_comp count_ext[] = { > COUNTER_COMP_DIRECTION(count_direction_read), > COUNTER_COMP_ENABLE(count_enable_read, count_enable_write), > COUNTER_COMP_CEILING(count_ceiling_read, count_ceiling_write), > }; > > This makes it simple to see, add, and modify the attributes that are > supported by this driver ("direction", "enable", and "ceiling") and to > maintain this code without getting lost in a web of struct braces. > > Callbacks must match the function type expected for the respective > component or extension. These function types are defined in the struct > counter_comp structure as the "*_read" and "*_write" union members. > > The corresponding callback prototypes for the extensions above would be: > > int count_direction_read(struct counter_device *counter, > struct counter_count *count, u8 *direction); > int count_enable_read(struct counter_device *counter, > struct counter_count *count, u8 *enable); > int count_enable_write(struct counter_device *counter, > struct counter_count *count, u8 enable); > int count_ceiling_read(struct counter_device *counter, > struct counter_count *count, u64 *ceiling); > int count_ceiling_write(struct counter_device *counter, > struct counter_count *count, u64 ceiling); > > In this way, driver authors no longer need to mess with sysfs strings > and are instead able to focus on what they actually care about doing -- > getting data to/from the devices -- while the Generic Counter interface > handles the translation of that data for them between the various > userspace interfaces (e.g. sysfs and chardev). > > Architecture > ============ > > Counter device registration is the same as before: drivers populate a > struct counter_device with components and callbacks, then pass the > structure to the devm_counter_register function. However, what's > different now is how the Counter subsystem code handles this > registration internally. > > Whereas before callbacks would interact directly with sysfs data, this > interaction is now abstracted and instead callbacks interact with native > C data types. The counter_comp structure forms the basis for Counter > extensions. > > The counter-sysfs.c file contains the code to parse through the > counter_device structure and register the requested components and > extensions. Attributes are created and populated based on type, with > respective translation functions to handle the mapping between sysfs and > the counter driver callbacks. > > The translation performed for each attribute is straightforward: the > attribute type and data is parsed from the counter_attribute structure, > the respective counter driver read/write callback is called, and sysfs > I/O is handled before or after the driver read/write function is called. > > Cc: Syed Nayyar Waris <syednwaris@gmail.com> > Cc: Patrick Havelange <patrick.havelange@essensium.com> > Cc: Kamel Bouhara <kamel.bouhara@bootlin.com> > Cc: Fabrice Gasnier <fabrice.gasnier@st.com> > Cc: Maxime Coquelin <mcoquelin.stm32@gmail.com> > Cc: Alexandre Torgue <alexandre.torgue@st.com> > Cc: David Lechner <david@lechnology.com> > Cc: Dan Carpenter <dan.carpenter@oracle.com> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > --- > MAINTAINERS | 1 - > drivers/counter/104-quad-8.c | 489 ++++---- > drivers/counter/Makefile | 1 + > drivers/counter/counter-core.c | 153 +++ > drivers/counter/counter-sysfs.c | 837 +++++++++++++ > drivers/counter/counter-sysfs.h | 13 + > drivers/counter/counter.c | 1496 ----------------------- > drivers/counter/ftm-quaddec.c | 61 +- > drivers/counter/microchip-tcb-capture.c | 103 +- > drivers/counter/stm32-lptimer-cnt.c | 181 +-- > drivers/counter/stm32-timer-cnt.c | 149 +-- > drivers/counter/ti-eqep.c | 224 ++-- > include/linux/counter.h | 707 +++++------ > include/linux/counter_enum.h | 45 - > 14 files changed, 1932 insertions(+), 2528 deletions(-) > create mode 100644 drivers/counter/counter-core.c > create mode 100644 drivers/counter/counter-sysfs.c > create mode 100644 drivers/counter/counter-sysfs.h > delete mode 100644 drivers/counter/counter.c > delete mode 100644 include/linux/counter_enum.h > > diff --git a/MAINTAINERS b/MAINTAINERS > index 2ac5688db43a..b64fa49d5796 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -4494,7 +4494,6 @@ F: Documentation/ABI/testing/sysfs-bus-counter* > F: Documentation/driver-api/generic-counter.rst > F: drivers/counter/ > F: include/linux/counter.h > -F: include/linux/counter_enum.h > > CPMAC ETHERNET DRIVER > M: Florian Fainelli <f.fainelli@gmail.com> > diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c > index 78766b6ec271..f4fb36b751c4 100644 > --- a/drivers/counter/104-quad-8.c > +++ b/drivers/counter/104-quad-8.c > @@ -621,7 +621,8 @@ static const struct iio_chan_spec quad8_channels[] = { > }; > > static int quad8_signal_read(struct counter_device *counter, > - struct counter_signal *signal, enum counter_signal_value *val) > + struct counter_signal *signal, > + enum counter_signal_level *level) > { > const struct quad8_iio *const priv = counter->priv; > unsigned int state; > @@ -633,13 +634,13 @@ static int quad8_signal_read(struct counter_device *counter, > state = inb(priv->base + QUAD8_REG_INDEX_INPUT_LEVELS) > & BIT(signal->id - 16); > > - *val = (state) ? COUNTER_SIGNAL_HIGH : COUNTER_SIGNAL_LOW; > + *level = (state) ? COUNTER_SIGNAL_LEVEL_HIGH : COUNTER_SIGNAL_LEVEL_LOW; This bit of refactoring / renaming could have been split out as a precursor patch I think. There may be other opportunities. > > return 0; > } > > static int quad8_count_read(struct counter_device *counter, > - struct counter_count *count, unsigned long *val) > + struct counter_count *count, u64 *val) Could the type change for val have been done as a precursor? > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id; > @@ -670,7 +671,7 @@ static int quad8_count_read(struct counter_device *counter, > } > > static int quad8_count_write(struct counter_device *counter, > - struct counter_count *count, unsigned long val) > + struct counter_count *count, u64 val) > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id; > @@ -710,22 +711,17 @@ static int quad8_count_write(struct counter_device *counter, > return 0; > } > > -enum quad8_count_function { > - QUAD8_COUNT_FUNCTION_PULSE_DIRECTION = 0, > - QUAD8_COUNT_FUNCTION_QUADRATURE_X1, > - QUAD8_COUNT_FUNCTION_QUADRATURE_X2, > - QUAD8_COUNT_FUNCTION_QUADRATURE_X4 > -}; > > -static enum counter_count_function quad8_count_functions_list[] = { > - [QUAD8_COUNT_FUNCTION_PULSE_DIRECTION] = COUNTER_COUNT_FUNCTION_PULSE_DIRECTION, > - [QUAD8_COUNT_FUNCTION_QUADRATURE_X1] = COUNTER_COUNT_FUNCTION_QUADRATURE_X1_A, > - [QUAD8_COUNT_FUNCTION_QUADRATURE_X2] = COUNTER_COUNT_FUNCTION_QUADRATURE_X2_A, > - [QUAD8_COUNT_FUNCTION_QUADRATURE_X4] = COUNTER_COUNT_FUNCTION_QUADRATURE_X4 > +static const enum counter_function quad8_functions_list[] = { > + COUNTER_FUNCTION_PULSE_DIRECTION, > + COUNTER_FUNCTION_QUADRATURE_X1_A, > + COUNTER_FUNCTION_QUADRATURE_X2_A, > + COUNTER_FUNCTION_QUADRATURE_X4, > }; > > -static int quad8_function_get(struct counter_device *counter, > - struct counter_count *count, size_t *function) > +static int quad8_function_read(struct counter_device *counter, > + struct counter_count *count, > + enum counter_function *function) > { > struct quad8_iio *const priv = counter->priv; > const int id = count->id; > @@ -735,25 +731,26 @@ static int quad8_function_get(struct counter_device *counter, > if (priv->quadrature_mode[id]) > switch (priv->quadrature_scale[id]) { > case 0: > - *function = QUAD8_COUNT_FUNCTION_QUADRATURE_X1; > + *function = COUNTER_FUNCTION_QUADRATURE_X1_A; > break; > case 1: > - *function = QUAD8_COUNT_FUNCTION_QUADRATURE_X2; > + *function = COUNTER_FUNCTION_QUADRATURE_X2_A; > break; > case 2: > - *function = QUAD8_COUNT_FUNCTION_QUADRATURE_X4; > + *function = COUNTER_FUNCTION_QUADRATURE_X4; > break; > } > else > - *function = QUAD8_COUNT_FUNCTION_PULSE_DIRECTION; > + *function = COUNTER_FUNCTION_PULSE_DIRECTION; > > mutex_unlock(&priv->lock); > > return 0; > } > > -static int quad8_function_set(struct counter_device *counter, > - struct counter_count *count, size_t function) > +static int quad8_function_write(struct counter_device *counter, > + struct counter_count *count, > + enum counter_function function) > { > struct quad8_iio *const priv = counter->priv; > const int id = count->id; > @@ -769,7 +766,7 @@ static int quad8_function_set(struct counter_device *counter, > mode_cfg = priv->count_mode[id] << 1; > idr_cfg = priv->index_polarity[id] << 1; > > - if (function == QUAD8_COUNT_FUNCTION_PULSE_DIRECTION) { > + if (function == COUNTER_FUNCTION_PULSE_DIRECTION) { > *quadrature_mode = 0; > > /* Quadrature scaling only available in quadrature mode */ > @@ -785,18 +782,21 @@ static int quad8_function_set(struct counter_device *counter, > *quadrature_mode = 1; > > switch (function) { > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X1: > + case COUNTER_FUNCTION_QUADRATURE_X1_A: > *scale = 0; > mode_cfg |= QUAD8_CMR_QUADRATURE_X1; > break; > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X2: > + case COUNTER_FUNCTION_QUADRATURE_X2_A: > *scale = 1; > mode_cfg |= QUAD8_CMR_QUADRATURE_X2; > break; > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X4: > + case COUNTER_FUNCTION_QUADRATURE_X4: > *scale = 2; > mode_cfg |= QUAD8_CMR_QUADRATURE_X4; > break; > + default: > + mutex_unlock(&priv->lock); > + return -EINVAL; This looks like a sensible precaution / cleanup but could have been done separately to the rest of the patch I think? > } > } > > @@ -808,8 +808,9 @@ static int quad8_function_set(struct counter_device *counter, > return 0; > } > > -static void quad8_direction_get(struct counter_device *counter, > - struct counter_count *count, enum counter_count_direction *direction) > +static int quad8_direction_read(struct counter_device *counter, > + struct counter_count *count, > + enum counter_count_direction *direction) > { > const struct quad8_iio *const priv = counter->priv; > unsigned int ud_flag; > @@ -820,77 +821,78 @@ static void quad8_direction_get(struct counter_device *counter, > > *direction = (ud_flag) ? COUNTER_COUNT_DIRECTION_FORWARD : > COUNTER_COUNT_DIRECTION_BACKWARD; > -} > > -enum quad8_synapse_action { > - QUAD8_SYNAPSE_ACTION_NONE = 0, > - QUAD8_SYNAPSE_ACTION_RISING_EDGE, > - QUAD8_SYNAPSE_ACTION_FALLING_EDGE, > - QUAD8_SYNAPSE_ACTION_BOTH_EDGES > -}; > + return 0; > +} > > -static enum counter_synapse_action quad8_index_actions_list[] = { > - [QUAD8_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, > - [QUAD8_SYNAPSE_ACTION_RISING_EDGE] = COUNTER_SYNAPSE_ACTION_RISING_EDGE > +static const enum counter_synapse_action quad8_index_actions_list[] = { > + COUNTER_SYNAPSE_ACTION_NONE, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > }; > > -static enum counter_synapse_action quad8_synapse_actions_list[] = { > - [QUAD8_SYNAPSE_ACTION_NONE] = COUNTER_SYNAPSE_ACTION_NONE, > - [QUAD8_SYNAPSE_ACTION_RISING_EDGE] = COUNTER_SYNAPSE_ACTION_RISING_EDGE, > - [QUAD8_SYNAPSE_ACTION_FALLING_EDGE] = COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > - [QUAD8_SYNAPSE_ACTION_BOTH_EDGES] = COUNTER_SYNAPSE_ACTION_BOTH_EDGES > +static const enum counter_synapse_action quad8_synapse_actions_list[] = { > + COUNTER_SYNAPSE_ACTION_NONE, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > }; > > -static int quad8_action_get(struct counter_device *counter, > - struct counter_count *count, struct counter_synapse *synapse, > - size_t *action) > +static int quad8_action_read(struct counter_device *counter, > + struct counter_count *count, > + struct counter_synapse *synapse, > + enum counter_synapse_action *action) > { > struct quad8_iio *const priv = counter->priv; > int err; > - size_t function = 0; > + enum counter_function function; > const size_t signal_a_id = count->synapses[0].signal->id; > enum counter_count_direction direction; > > /* Handle Index signals */ > if (synapse->signal->id >= 16) { > if (priv->preset_enable[count->id]) > - *action = QUAD8_SYNAPSE_ACTION_RISING_EDGE; > + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; > else > - *action = QUAD8_SYNAPSE_ACTION_NONE; > + *action = COUNTER_SYNAPSE_ACTION_NONE; > > return 0; > } > > - err = quad8_function_get(counter, count, &function); > + err = quad8_function_read(counter, count, &function); > if (err) > return err; > > /* Default action mode */ > - *action = QUAD8_SYNAPSE_ACTION_NONE; > + *action = COUNTER_SYNAPSE_ACTION_NONE; > > /* Determine action mode based on current count function mode */ > switch (function) { > - case QUAD8_COUNT_FUNCTION_PULSE_DIRECTION: > + case COUNTER_FUNCTION_PULSE_DIRECTION: > if (synapse->signal->id == signal_a_id) > - *action = QUAD8_SYNAPSE_ACTION_RISING_EDGE; > + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; > break; > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X1: > + case COUNTER_FUNCTION_QUADRATURE_X1_A: > if (synapse->signal->id == signal_a_id) { > - quad8_direction_get(counter, count, &direction); > + err = quad8_direction_read(counter, count, &direction); > + if (err) > + return err; > > if (direction == COUNTER_COUNT_DIRECTION_FORWARD) > - *action = QUAD8_SYNAPSE_ACTION_RISING_EDGE; > + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; > else > - *action = QUAD8_SYNAPSE_ACTION_FALLING_EDGE; > + *action = COUNTER_SYNAPSE_ACTION_FALLING_EDGE; > } > break; > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X2: > + case COUNTER_FUNCTION_QUADRATURE_X2_A: > if (synapse->signal->id == signal_a_id) > - *action = QUAD8_SYNAPSE_ACTION_BOTH_EDGES; > + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; > break; > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X4: > - *action = QUAD8_SYNAPSE_ACTION_BOTH_EDGES; > + case COUNTER_FUNCTION_QUADRATURE_X4: > + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; > break; > + default: > + /* should never reach this path */ > + return -EINVAL; > } > > return 0; > @@ -900,13 +902,14 @@ static const struct counter_ops quad8_ops = { > .signal_read = quad8_signal_read, > .count_read = quad8_count_read, > .count_write = quad8_count_write, > - .function_get = quad8_function_get, > - .function_set = quad8_function_set, > - .action_get = quad8_action_get > + .function_read = quad8_function_read, > + .function_write = quad8_function_write, > + .action_read = quad8_action_read > }; > > static int quad8_index_polarity_get(struct counter_device *counter, > - struct counter_signal *signal, size_t *index_polarity) > + struct counter_signal *signal, > + u32 *index_polarity) > { > const struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > @@ -917,7 +920,8 @@ static int quad8_index_polarity_get(struct counter_device *counter, > } > > static int quad8_index_polarity_set(struct counter_device *counter, > - struct counter_signal *signal, size_t index_polarity) > + struct counter_signal *signal, > + u32 index_polarity) > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > @@ -938,15 +942,9 @@ static int quad8_index_polarity_set(struct counter_device *counter, > return 0; > } > > -static struct counter_signal_enum_ext quad8_index_pol_enum = { > - .items = quad8_index_polarity_modes, > - .num_items = ARRAY_SIZE(quad8_index_polarity_modes), > - .get = quad8_index_polarity_get, > - .set = quad8_index_polarity_set > -}; > - > static int quad8_synchronous_mode_get(struct counter_device *counter, > - struct counter_signal *signal, size_t *synchronous_mode) > + struct counter_signal *signal, > + u32 *synchronous_mode) > { > const struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > @@ -957,7 +955,8 @@ static int quad8_synchronous_mode_get(struct counter_device *counter, > } > > static int quad8_synchronous_mode_set(struct counter_device *counter, > - struct counter_signal *signal, size_t synchronous_mode) > + struct counter_signal *signal, > + u32 synchronous_mode) > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > @@ -984,22 +983,18 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, > return 0; > } > > -static struct counter_signal_enum_ext quad8_syn_mode_enum = { > - .items = quad8_synchronous_modes, > - .num_items = ARRAY_SIZE(quad8_synchronous_modes), > - .get = quad8_synchronous_mode_get, > - .set = quad8_synchronous_mode_set > -}; > - > -static ssize_t quad8_count_floor_read(struct counter_device *counter, > - struct counter_count *count, void *private, char *buf) > +static int quad8_count_floor_read(struct counter_device *counter, > + struct counter_count *count, u64 *floor) > { > /* Only a floor of 0 is supported */ > - return sprintf(buf, "0\n"); > + *floor = 0; > + > + return 0; > } > > -static int quad8_count_mode_get(struct counter_device *counter, > - struct counter_count *count, size_t *cnt_mode) > +static int quad8_count_mode_read(struct counter_device *counter, > + struct counter_count *count, > + enum counter_count_mode *cnt_mode) > { > const struct quad8_iio *const priv = counter->priv; > > @@ -1022,35 +1017,39 @@ static int quad8_count_mode_get(struct counter_device *counter, > return 0; > } > > -static int quad8_count_mode_set(struct counter_device *counter, > - struct counter_count *count, size_t cnt_mode) > +static int quad8_count_mode_write(struct counter_device *counter, > + struct counter_count *count, > + enum counter_count_mode cnt_mode) > { > struct quad8_iio *const priv = counter->priv; > + unsigned int count_mode; > unsigned int mode_cfg; > const int base_offset = priv->base + 2 * count->id + 1; > > /* Map Generic Counter count mode to 104-QUAD-8 count mode */ > switch (cnt_mode) { > case COUNTER_COUNT_MODE_NORMAL: > - cnt_mode = 0; > + count_mode = 0; > break; > case COUNTER_COUNT_MODE_RANGE_LIMIT: > - cnt_mode = 1; > + count_mode = 1; > break; > case COUNTER_COUNT_MODE_NON_RECYCLE: > - cnt_mode = 2; > + count_mode = 2; > break; > case COUNTER_COUNT_MODE_MODULO_N: > - cnt_mode = 3; > + count_mode = 3; > break; > + default: > + return -EINVAL; > } > > mutex_lock(&priv->lock); > > - priv->count_mode[count->id] = cnt_mode; > + priv->count_mode[count->id] = count_mode; > > /* Set count mode configuration value */ > - mode_cfg = cnt_mode << 1; > + mode_cfg = count_mode << 1; > > /* Add quadrature mode configuration */ > if (priv->quadrature_mode[count->id]) > @@ -1064,60 +1063,39 @@ static int quad8_count_mode_set(struct counter_device *counter, > return 0; > } > > -static struct counter_count_enum_ext quad8_cnt_mode_enum = { > - .items = counter_count_mode_str, > - .num_items = ARRAY_SIZE(counter_count_mode_str), > - .get = quad8_count_mode_get, > - .set = quad8_count_mode_set > -}; > - > -static ssize_t quad8_count_direction_read(struct counter_device *counter, > - struct counter_count *count, void *priv, char *buf) > -{ > - enum counter_count_direction dir; > - > - quad8_direction_get(counter, count, &dir); > - > - return sprintf(buf, "%s\n", counter_count_direction_str[dir]); > -} > - > -static ssize_t quad8_count_enable_read(struct counter_device *counter, > - struct counter_count *count, void *private, char *buf) > +static int quad8_count_enable_read(struct counter_device *counter, > + struct counter_count *count, u8 *enable) > { > const struct quad8_iio *const priv = counter->priv; > > - return sprintf(buf, "%u\n", priv->ab_enable[count->id]); > + *enable = priv->ab_enable[count->id]; > + > + return 0; > } > > -static ssize_t quad8_count_enable_write(struct counter_device *counter, > - struct counter_count *count, void *private, const char *buf, size_t len) > +static int quad8_count_enable_write(struct counter_device *counter, > + struct counter_count *count, u8 enable) > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id; > - int err; > - bool ab_enable; > unsigned int ior_cfg; > > - err = kstrtobool(buf, &ab_enable); > - if (err) > - return err; > - > mutex_lock(&priv->lock); > > - priv->ab_enable[count->id] = ab_enable; > + priv->ab_enable[count->id] = enable; > > - ior_cfg = ab_enable | priv->preset_enable[count->id] << 1; > + ior_cfg = enable | priv->preset_enable[count->id] << 1; > > /* Load I/O control configuration */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); > > mutex_unlock(&priv->lock); > > - return len; > + return 0; > } > > static int quad8_error_noise_get(struct counter_device *counter, > - struct counter_count *count, size_t *noise_error) > + struct counter_count *count, u32 *noise_error) > { > const struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id + 1; > @@ -1127,22 +1105,18 @@ static int quad8_error_noise_get(struct counter_device *counter, > return 0; > } > > -static struct counter_count_enum_ext quad8_error_noise_enum = { > - .items = quad8_noise_error_states, > - .num_items = ARRAY_SIZE(quad8_noise_error_states), > - .get = quad8_error_noise_get > -}; > - > -static ssize_t quad8_count_preset_read(struct counter_device *counter, > - struct counter_count *count, void *private, char *buf) > +static int quad8_count_preset_read(struct counter_device *counter, > + struct counter_count *count, u64 *preset) > { > const struct quad8_iio *const priv = counter->priv; > > - return sprintf(buf, "%u\n", priv->preset[count->id]); > + *preset = priv->preset[count->id]; > + > + return 0; > } > > -static void quad8_preset_register_set(struct quad8_iio *quad8iio, int id, > - unsigned int preset) > +static void quad8_preset_register_set(struct quad8_iio *const quad8iio, > + const int id, const u64 preset) > { > const unsigned int base_offset = quad8iio->base + 2 * id; > int i; > @@ -1157,16 +1131,10 @@ static void quad8_preset_register_set(struct quad8_iio *quad8iio, int id, > outb(preset >> (8 * i), base_offset); > } > > -static ssize_t quad8_count_preset_write(struct counter_device *counter, > - struct counter_count *count, void *private, const char *buf, size_t len) > +static int quad8_count_preset_write(struct counter_device *counter, > + struct counter_count *count, u64 preset) > { > struct quad8_iio *const priv = counter->priv; > - unsigned int preset; > - int ret; > - > - ret = kstrtouint(buf, 0, &preset); > - if (ret) > - return ret; > > /* Only 24-bit values are supported */ > if (preset > 0xFFFFFF) > @@ -1178,11 +1146,11 @@ static ssize_t quad8_count_preset_write(struct counter_device *counter, > > mutex_unlock(&priv->lock); > > - return len; > + return 0; > } > > -static ssize_t quad8_count_ceiling_read(struct counter_device *counter, > - struct counter_count *count, void *private, char *buf) > +static int quad8_count_ceiling_read(struct counter_device *counter, > + struct counter_count *count, u64 *ceiling) > { > struct quad8_iio *const priv = counter->priv; > > @@ -1192,26 +1160,23 @@ static ssize_t quad8_count_ceiling_read(struct counter_device *counter, > switch (priv->count_mode[count->id]) { > case 1: > case 3: > - mutex_unlock(&priv->lock); > - return sprintf(buf, "%u\n", priv->preset[count->id]); > + *ceiling = priv->preset[count->id]; > + break; > + default: > + /* By default 0x1FFFFFF (25 bits unsigned) is maximum count */ > + *ceiling = 0x1FFFFFF; > + break; > } > > mutex_unlock(&priv->lock); > > - /* By default 0x1FFFFFF (25 bits unsigned) is maximum count */ > - return sprintf(buf, "33554431\n"); > + return 0; > } > > -static ssize_t quad8_count_ceiling_write(struct counter_device *counter, > - struct counter_count *count, void *private, const char *buf, size_t len) > +static int quad8_count_ceiling_write(struct counter_device *counter, > + struct counter_count *count, u64 ceiling) > { > struct quad8_iio *const priv = counter->priv; > - unsigned int ceiling; > - int ret; > - > - ret = kstrtouint(buf, 0, &ceiling); > - if (ret) > - return ret; > > /* Only 24-bit values are supported */ > if (ceiling > 0xFFFFFF) > @@ -1229,30 +1194,28 @@ static ssize_t quad8_count_ceiling_write(struct counter_device *counter, > > mutex_unlock(&priv->lock); > > - return len; > + return -EINVAL; ? That looks like the good exit path to me. > } > > -static ssize_t quad8_count_preset_enable_read(struct counter_device *counter, > - struct counter_count *count, void *private, char *buf) > +static int quad8_count_preset_enable_read(struct counter_device *counter, > + struct counter_count *count, > + u8 *preset_enable) > { > const struct quad8_iio *const priv = counter->priv; > > - return sprintf(buf, "%u\n", !priv->preset_enable[count->id]); > + *preset_enable = !priv->preset_enable[count->id]; > + > + return 0; > } > > -static ssize_t quad8_count_preset_enable_write(struct counter_device *counter, > - struct counter_count *count, void *private, const char *buf, size_t len) > +static int quad8_count_preset_enable_write(struct counter_device *counter, > + struct counter_count *count, > + u8 preset_enable) > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id + 1; > - bool preset_enable; > - int ret; > unsigned int ior_cfg; > > - ret = kstrtobool(buf, &preset_enable); > - if (ret) > - return ret; > - > /* Preset enable is active low in Input/Output Control register */ > preset_enable = !preset_enable; > > @@ -1260,25 +1223,24 @@ static ssize_t quad8_count_preset_enable_write(struct counter_device *counter, > > priv->preset_enable[count->id] = preset_enable; > > - ior_cfg = priv->ab_enable[count->id] | (unsigned int)preset_enable << 1; > + ior_cfg = priv->ab_enable[count->id] | preset_enable << 1; > > /* Load I/O control configuration to Input / Output Control Register */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset); > > mutex_unlock(&priv->lock); > > - return len; > + return 0; > } > > -static ssize_t quad8_signal_cable_fault_read(struct counter_device *counter, > - struct counter_signal *signal, > - void *private, char *buf) > +static int quad8_signal_cable_fault_read(struct counter_device *counter, > + struct counter_signal *signal, > + u8 *cable_fault) > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > bool disabled; > unsigned int status; > - unsigned int fault; > > mutex_lock(&priv->lock); > > @@ -1295,36 +1257,31 @@ static ssize_t quad8_signal_cable_fault_read(struct counter_device *counter, > mutex_unlock(&priv->lock); > > /* Mask respective channel and invert logic */ > - fault = !(status & BIT(channel_id)); > + *cable_fault = !(status & BIT(channel_id)); > > - return sprintf(buf, "%u\n", fault); > + return 0; > } > > -static ssize_t quad8_signal_cable_fault_enable_read( > - struct counter_device *counter, struct counter_signal *signal, > - void *private, char *buf) > +static int quad8_signal_cable_fault_enable_read(struct counter_device *counter, > + struct counter_signal *signal, > + u8 *enable) > { > const struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > - const unsigned int enb = !!(priv->cable_fault_enable & BIT(channel_id)); > > - return sprintf(buf, "%u\n", enb); > + *enable = !!(priv->cable_fault_enable & BIT(channel_id)); > + > + return 0; > } > > -static ssize_t quad8_signal_cable_fault_enable_write( > - struct counter_device *counter, struct counter_signal *signal, > - void *private, const char *buf, size_t len) > +static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, > + struct counter_signal *signal, > + u8 enable) > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > - bool enable; > - int ret; > unsigned int cable_fault_enable; > > - ret = kstrtobool(buf, &enable); > - if (ret) > - return ret; > - > mutex_lock(&priv->lock); > > if (enable) > @@ -1339,31 +1296,27 @@ static ssize_t quad8_signal_cable_fault_enable_write( > > mutex_unlock(&priv->lock); > > - return len; > + return 0; > } > > -static ssize_t quad8_signal_fck_prescaler_read(struct counter_device *counter, > - struct counter_signal *signal, void *private, char *buf) > +static int quad8_signal_fck_prescaler_read(struct counter_device *counter, > + struct counter_signal *signal, > + u8 *prescaler) > { > const struct quad8_iio *const priv = counter->priv; > - const size_t channel_id = signal->id / 2; > > - return sprintf(buf, "%u\n", priv->fck_prescaler[channel_id]); > + *prescaler = priv->fck_prescaler[signal->id / 2]; > + > + return 0; > } > > -static ssize_t quad8_signal_fck_prescaler_write(struct counter_device *counter, > - struct counter_signal *signal, void *private, const char *buf, > - size_t len) > +static int quad8_signal_fck_prescaler_write(struct counter_device *counter, > + struct counter_signal *signal, > + u8 prescaler) > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > const int base_offset = priv->base + 2 * channel_id; > - u8 prescaler; > - int ret; > - > - ret = kstrtou8(buf, 0, &prescaler); > - if (ret) > - return ret; > > mutex_lock(&priv->lock); > > @@ -1379,31 +1332,30 @@ static ssize_t quad8_signal_fck_prescaler_write(struct counter_device *counter, > > mutex_unlock(&priv->lock); > > - return len; > + return 0; > } > > -static const struct counter_signal_ext quad8_signal_ext[] = { > - { > - .name = "cable_fault", > - .read = quad8_signal_cable_fault_read > - }, > - { > - .name = "cable_fault_enable", > - .read = quad8_signal_cable_fault_enable_read, > - .write = quad8_signal_cable_fault_enable_write > - }, > - { > - .name = "filter_clock_prescaler", > - .read = quad8_signal_fck_prescaler_read, > - .write = quad8_signal_fck_prescaler_write > - } > +static struct counter_comp quad8_signal_ext[] = { > + COUNTER_COMP_SIGNAL_BOOL("cable_fault", quad8_signal_cable_fault_read, > + NULL), > + COUNTER_COMP_SIGNAL_BOOL("cable_fault_enable", > + quad8_signal_cable_fault_enable_read, > + quad8_signal_cable_fault_enable_write), > + COUNTER_COMP_SIGNAL_U8("filter_clock_prescaler", > + quad8_signal_fck_prescaler_read, > + quad8_signal_fck_prescaler_write) > }; > > -static const struct counter_signal_ext quad8_index_ext[] = { > - COUNTER_SIGNAL_ENUM("index_polarity", &quad8_index_pol_enum), > - COUNTER_SIGNAL_ENUM_AVAILABLE("index_polarity", &quad8_index_pol_enum), > - COUNTER_SIGNAL_ENUM("synchronous_mode", &quad8_syn_mode_enum), > - COUNTER_SIGNAL_ENUM_AVAILABLE("synchronous_mode", &quad8_syn_mode_enum) > +static DEFINE_COUNTER_ENUM(quad8_index_pol_enum, quad8_index_polarity_modes); > +static DEFINE_COUNTER_ENUM(quad8_synch_mode_enum, quad8_synchronous_modes); > + > +static struct counter_comp quad8_index_ext[] = { > + COUNTER_COMP_SIGNAL_ENUM("index_polarity", quad8_index_polarity_get, > + quad8_index_polarity_set, > + quad8_index_pol_enum), > + COUNTER_COMP_SIGNAL_ENUM("synchronous_mode", quad8_synchronous_mode_get, > + quad8_synchronous_mode_set, > + quad8_synch_mode_enum), > }; > > #define QUAD8_QUAD_SIGNAL(_id, _name) { \ > @@ -1472,50 +1424,41 @@ static struct counter_synapse quad8_count_synapses[][3] = { > QUAD8_COUNT_SYNAPSES(6), QUAD8_COUNT_SYNAPSES(7) > }; > > -static const struct counter_count_ext quad8_count_ext[] = { > - { > - .name = "ceiling", > - .read = quad8_count_ceiling_read, > - .write = quad8_count_ceiling_write > - }, > - { > - .name = "floor", > - .read = quad8_count_floor_read > - }, > - COUNTER_COUNT_ENUM("count_mode", &quad8_cnt_mode_enum), > - COUNTER_COUNT_ENUM_AVAILABLE("count_mode", &quad8_cnt_mode_enum), > - { > - .name = "direction", > - .read = quad8_count_direction_read > - }, > - { > - .name = "enable", > - .read = quad8_count_enable_read, > - .write = quad8_count_enable_write > - }, > - COUNTER_COUNT_ENUM("error_noise", &quad8_error_noise_enum), > - COUNTER_COUNT_ENUM_AVAILABLE("error_noise", &quad8_error_noise_enum), > - { > - .name = "preset", > - .read = quad8_count_preset_read, > - .write = quad8_count_preset_write > - }, > - { > - .name = "preset_enable", > - .read = quad8_count_preset_enable_read, > - .write = quad8_count_preset_enable_write > - } > +static const enum counter_count_mode quad8_cnt_modes[] = { > + COUNTER_COUNT_MODE_NORMAL, > + COUNTER_COUNT_MODE_RANGE_LIMIT, > + COUNTER_COUNT_MODE_NON_RECYCLE, > + COUNTER_COUNT_MODE_MODULO_N, > +}; > + > +static DEFINE_COUNTER_AVAILABLE(quad8_count_mode_available, quad8_cnt_modes); > + > +static DEFINE_COUNTER_ENUM(quad8_error_noise_enum, quad8_noise_error_states); > + > +static struct counter_comp quad8_count_ext[] = { > + COUNTER_COMP_CEILING(quad8_count_ceiling_read, > + quad8_count_ceiling_write), > + COUNTER_COMP_FLOOR(quad8_count_floor_read, NULL), > + COUNTER_COMP_COUNT_MODE(quad8_count_mode_read, quad8_count_mode_write, > + quad8_count_mode_available), > + COUNTER_COMP_DIRECTION(quad8_direction_read), > + COUNTER_COMP_ENABLE(quad8_count_enable_read, quad8_count_enable_write), > + COUNTER_COMP_COUNT_ENUM("error_noise", quad8_error_noise_get, NULL, > + quad8_error_noise_enum), > + COUNTER_COMP_PRESET(quad8_count_preset_read, quad8_count_preset_write), > + COUNTER_COMP_PRESET_ENABLE(quad8_count_preset_enable_read, > + quad8_count_preset_enable_write), > }; > > -#define QUAD8_COUNT(_id, _cntname) { \ > - .id = (_id), \ > - .name = (_cntname), \ > - .functions_list = quad8_count_functions_list, \ > - .num_functions = ARRAY_SIZE(quad8_count_functions_list), \ > - .synapses = quad8_count_synapses[(_id)], \ > - .num_synapses = 2, \ > - .ext = quad8_count_ext, \ > - .num_ext = ARRAY_SIZE(quad8_count_ext) \ > +#define QUAD8_COUNT(_id, _cntname) { \ > + .id = (_id), \ > + .name = (_cntname), \ > + .functions_list = quad8_functions_list, \ > + .num_functions = ARRAY_SIZE(quad8_functions_list), \ > + .synapses = quad8_count_synapses[(_id)], \ > + .num_synapses = 2, \ > + .ext = quad8_count_ext, \ > + .num_ext = ARRAY_SIZE(quad8_count_ext) \ > } > > static struct counter_count quad8_counts[] = { > diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile > index 0a393f71e481..cbe1d06af6a9 100644 > --- a/drivers/counter/Makefile > +++ b/drivers/counter/Makefile > @@ -4,6 +4,7 @@ > # > > obj-$(CONFIG_COUNTER) += counter.o > +counter-y := counter-core.o counter-sysfs.o > > obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o > obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o > diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c > new file mode 100644 > index 000000000000..78e07588717b > --- /dev/null > +++ b/drivers/counter/counter-core.c > @@ -0,0 +1,153 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * Generic Counter interface > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#include <linux/counter.h> > +#include <linux/device.h> > +#include <linux/export.h> > +#include <linux/gfp.h> > +#include <linux/idr.h> > +#include <linux/init.h> > +#include <linux/module.h> > + > +#include "counter-sysfs.h" > + > +/* Provides a unique ID for each counter device */ > +static DEFINE_IDA(counter_ida); > + > +static void counter_device_release(struct device *dev) > +{ > + struct counter_device *const counter = dev_get_drvdata(dev); > + > + counter_chrdev_remove(counter); > + ida_simple_remove(&counter_ida, counter->id); > +} > + > +static struct device_type counter_device_type = { > + .name = "counter_device", > + .release = counter_device_release > +}; > + > +static struct bus_type counter_bus_type = { > + .name = "counter" > +}; > + > +/** > + * counter_register - register Counter to the system > + * @counter: pointer to Counter to register > + * > + * This function registers a Counter to the system. A sysfs "counter" directory > + * will be created and populated with sysfs attributes correlating with the > + * Counter Signals, Synapses, and Counts respectively. Where easy to do it's worth documenting return values. > + */ > +int counter_register(struct counter_device *const counter) > +{ > + struct device *const dev = &counter->dev; > + int err; > + > + /* Acquire unique ID */ > + counter->id = ida_simple_get(&counter_ida, 0, 0, GFP_KERNEL); > + if (counter->id < 0) > + return counter->id; > + > + /* Configure device structure for Counter */ > + dev->type = &counter_device_type; > + dev->bus = &counter_bus_type; > + if (counter->parent) { > + dev->parent = counter->parent; > + dev->of_node = counter->parent->of_node; > + } > + dev_set_name(dev, "counter%d", counter->id); > + device_initialize(dev); > + dev_set_drvdata(dev, counter); > + > + /* Add Counter sysfs attributes */ > + err = counter_sysfs_add(counter); > + if (err < 0) > + goto err_free_id; > + > + /* Add device to system */ > + err = device_add(dev); > + if (err < 0) > + goto err_free_id; > + > + return 0; > + > +err_free_id: > + put_device(dev); > + return err; > +} > +EXPORT_SYMBOL_GPL(counter_register); > + > +/** > + * counter_unregister - unregister Counter from the system > + * @counter: pointer to Counter to unregister > + * > + * The Counter is unregistered from the system; all allocated memory is freed. > + */ > +void counter_unregister(struct counter_device *const counter) > +{ > + if (!counter) > + return; > + > + device_unregister(&counter->dev); > +} > +EXPORT_SYMBOL_GPL(counter_unregister); > + > +static void devm_counter_unregister(struct device *dev, void *res) > +{ > + counter_unregister(*(struct counter_device **)res); Rename this. It looks like it's a generic way of unwinding devm_counter_register which it is definitely not... > +} > + > +/** > + * devm_counter_register - Resource-managed counter_register > + * @dev: device to allocate counter_device for > + * @counter: pointer to Counter to register > + * > + * Managed counter_register. The Counter registered with this function is > + * automatically unregistered on driver detach. This function calls > + * counter_register internally. Refer to that function for more information. > + * > + * RETURNS: > + * 0 on success, negative error number on failure. > + */ > +int devm_counter_register(struct device *dev, > + struct counter_device *const counter) > +{ > + struct counter_device **ptr; > + int err; > + > + ptr = devres_alloc(devm_counter_unregister, sizeof(*ptr), GFP_KERNEL); > + if (!ptr) > + return -ENOMEM; > + > + err = counter_register(counter); > + if (err < 0) { > + devres_free(ptr); > + return err; > + } > + > + *ptr = counter; > + devres_add(dev, ptr); > + > + return 0; > +} > +EXPORT_SYMBOL_GPL(devm_counter_register); > + > +static int __init counter_init(void) > +{ > + return bus_register(&counter_bus_type); > +} > + > +static void __exit counter_exit(void) > +{ > + bus_unregister(&counter_bus_type); > +} > + > +subsys_initcall(counter_init); > +module_exit(counter_exit); > + > +MODULE_AUTHOR("William Breathitt Gray <vilhelm.gray@gmail.com>"); > +MODULE_DESCRIPTION("Generic Counter interface"); > +MODULE_LICENSE("GPL v2"); > diff --git a/drivers/counter/counter-sysfs.c b/drivers/counter/counter-sysfs.c > new file mode 100644 > index 000000000000..654afa91ae9f > --- /dev/null > +++ b/drivers/counter/counter-sysfs.c > @@ -0,0 +1,837 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * Generic Counter sysfs interface > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#include <linux/counter.h> > +#include <linux/device.h> > +#include <linux/err.h> > +#include <linux/gfp.h> > +#include <linux/kernel.h> > +#include <linux/list.h> > +#include <linux/string.h> > +#include <linux/sysfs.h> > +#include <linux/types.h> > + > +#include "counter-sysfs.h" > + > +/** > + * struct counter_attribute - Counter sysfs attribute > + * @dev_attr: device attribute for sysfs > + * @l: node to add Counter attribute to attribute group list > + * @comp: Counter component callbacks and data > + * @scope: Counter scope of the attribute > + * @parent: pointer to the parent component > + */ > +struct counter_attribute { > + struct device_attribute dev_attr; > + struct list_head l; > + > + struct counter_comp comp; > + __u8 scope; Why not an enum? > + void *parent; > +}; > + > +#define to_counter_attribute(_dev_attr) \ > + container_of(_dev_attr, struct counter_attribute, dev_attr) > + > +/** > + * struct counter_attribute_group - container for attribute group > + * @name: name of the attribute group > + * @attr_list: list to keep track of created attributes > + * @num_attr: number of attributes > + */ > +struct counter_attribute_group { > + const char *name; > + struct list_head attr_list; > + size_t num_attr; > +}; > + > +static const char *const counter_function_str[] = { > + [COUNTER_FUNCTION_INCREASE] = "increase", > + [COUNTER_FUNCTION_DECREASE] = "decrease", > + [COUNTER_FUNCTION_PULSE_DIRECTION] = "pulse-direction", > + [COUNTER_FUNCTION_QUADRATURE_X1_A] = "quadrature x1 a", > + [COUNTER_FUNCTION_QUADRATURE_X1_B] = "quadrature x1 b", > + [COUNTER_FUNCTION_QUADRATURE_X2_A] = "quadrature x2 a", > + [COUNTER_FUNCTION_QUADRATURE_X2_B] = "quadrature x2 b", > + [COUNTER_FUNCTION_QUADRATURE_X4] = "quadrature x4" > +}; > + > +static const char *const counter_signal_value_str[] = { > + [COUNTER_SIGNAL_LEVEL_LOW] = "low", > + [COUNTER_SIGNAL_LEVEL_HIGH] = "high" > +}; > + > +static const char *const counter_synapse_action_str[] = { > + [COUNTER_SYNAPSE_ACTION_NONE] = "none", > + [COUNTER_SYNAPSE_ACTION_RISING_EDGE] = "rising edge", > + [COUNTER_SYNAPSE_ACTION_FALLING_EDGE] = "falling edge", > + [COUNTER_SYNAPSE_ACTION_BOTH_EDGES] = "both edges" > +}; > + > +static const char *const counter_count_direction_str[] = { > + [COUNTER_COUNT_DIRECTION_FORWARD] = "forward", > + [COUNTER_COUNT_DIRECTION_BACKWARD] = "backward" > +}; > + > +static const char *const counter_count_mode_str[] = { > + [COUNTER_COUNT_MODE_NORMAL] = "normal", > + [COUNTER_COUNT_MODE_RANGE_LIMIT] = "range limit", > + [COUNTER_COUNT_MODE_NON_RECYCLE] = "non-recycle", > + [COUNTER_COUNT_MODE_MODULO_N] = "modulo-n" > +}; > + > +static ssize_t counter_comp_u8_show(struct device *dev, > + struct device_attribute *attr, char *buf) > +{ > + const struct counter_attribute *const a = to_counter_attribute(attr); > + struct counter_device *const counter = dev_get_drvdata(dev); > + int err; > + u8 data = 0; > + > + switch (a->scope) { > + case COUNTER_SCOPE_DEVICE: > + err = a->comp.device_u8_read(counter, &data); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = a->comp.signal_u8_read(counter, a->parent, &data); > + break; > + case COUNTER_SCOPE_COUNT: > + err = a->comp.count_u8_read(counter, a->parent, &data); > + break; > + } > + if (err < 0) > + return err; > + > + if (a->comp.type == COUNTER_COMP_BOOL) > + data = !!data; > + > + return sprintf(buf, "%u\n", (unsigned int)data); > +} > + > +static ssize_t counter_comp_u8_store(struct device *dev, > + struct device_attribute *attr, > + const char *buf, size_t len) > +{ > + const struct counter_attribute *const a = to_counter_attribute(attr); > + struct counter_device *const counter = dev_get_drvdata(dev); > + int err; > + bool bool_data = 0; > + u8 data = 0; > + > + if (a->comp.type == COUNTER_COMP_BOOL) { > + err = kstrtobool(buf, &bool_data); > + data = bool_data; > + } else > + err = kstrtou8(buf, 0, &data); > + if (err < 0) > + return err; > + > + switch (a->scope) { > + case COUNTER_SCOPE_DEVICE: > + err = a->comp.device_u8_write(counter, data); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = a->comp.signal_u8_write(counter, a->parent, data); > + break; > + case COUNTER_SCOPE_COUNT: > + err = a->comp.count_u8_write(counter, a->parent, data); > + break; > + } > + if (err < 0) > + return err; > + > + return len; > +} > + > +static ssize_t counter_comp_u32_show(struct device *dev, > + struct device_attribute *attr, char *buf) > +{ > + const struct counter_attribute *const a = to_counter_attribute(attr); > + struct counter_device *const counter = dev_get_drvdata(dev); > + const struct counter_available *const avail = a->comp.priv; > + int err; > + u32 data = 0; > + > + switch (a->scope) { > + case COUNTER_SCOPE_DEVICE: > + err = a->comp.device_u32_read(counter, &data); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = a->comp.signal_u32_read(counter, a->parent, &data); > + break; > + case COUNTER_SCOPE_COUNT: > + if (a->comp.type == COUNTER_COMP_SYNAPSE_ACTION) > + err = a->comp.action_read(counter, a->parent, > + a->comp.priv, &data); > + else > + err = a->comp.count_u32_read(counter, a->parent, &data); > + break; > + } > + if (err < 0) > + return err; > + > + switch (a->comp.type) { > + case COUNTER_COMP_FUNCTION: > + return sprintf(buf, "%s\n", counter_function_str[data]); > + case COUNTER_COMP_SIGNAL_LEVEL: > + return sprintf(buf, "%s\n", counter_signal_value_str[data]); > + case COUNTER_COMP_SYNAPSE_ACTION: > + return sprintf(buf, "%s\n", counter_synapse_action_str[data]); > + case COUNTER_COMP_ENUM: > + return sprintf(buf, "%s\n", avail->strs[data]); > + case COUNTER_COMP_COUNT_DIRECTION: > + return sprintf(buf, "%s\n", counter_count_direction_str[data]); > + case COUNTER_COMP_COUNT_MODE: > + return sprintf(buf, "%s\n", counter_count_mode_str[data]); > + default: Perhaps move the below return sprintf() up here? > + break; > + } > + > + return sprintf(buf, "%u\n", (unsigned int)data); > +} > + > +static int find_in_string_array(u32 *const enum_item, const u32 *const enums, > + const size_t num_enums, const char *const buf, > + const char *const string_array[]) Please avoid defining such generically named functions. High chance of a clash with something that turns up in generic headers sometime in the future. > +{ > + size_t index; > + > + for (index = 0; index < num_enums; index++) { > + *enum_item = enums[index]; > + if (sysfs_streq(buf, string_array[*enum_item])) > + return 0; > + } > + > + return -EINVAL; > +} > + > +static ssize_t counter_comp_u32_store(struct device *dev, > + struct device_attribute *attr, > + const char *buf, size_t len) > +{ > + const struct counter_attribute *const a = to_counter_attribute(attr); > + struct counter_device *const counter = dev_get_drvdata(dev); > + struct counter_count *const count = a->parent; > + struct counter_synapse *const synapse = a->comp.priv; > + const struct counter_available *const avail = a->comp.priv; > + int err; > + u32 data = 0; > + > + switch (a->comp.type) { > + case COUNTER_COMP_FUNCTION: > + err = find_in_string_array(&data, count->functions_list, > + count->num_functions, buf, > + counter_function_str); > + break; > + case COUNTER_COMP_SYNAPSE_ACTION: > + err = find_in_string_array(&data, synapse->actions_list, > + synapse->num_actions, buf, > + counter_synapse_action_str); > + break; > + case COUNTER_COMP_ENUM: > + err = __sysfs_match_string(avail->strs, avail->num_items, buf); > + data = err; > + break; > + case COUNTER_COMP_COUNT_MODE: > + err = find_in_string_array(&data, avail->enums, > + avail->num_items, buf, > + counter_count_mode_str); > + break; > + default: > + err = kstrtou32(buf, 0, &data); > + break; > + } > + if (err < 0) > + return err; > + > + switch (a->scope) { > + case COUNTER_SCOPE_DEVICE: > + err = a->comp.device_u32_write(counter, data); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = a->comp.signal_u32_write(counter, a->parent, data); > + break; > + case COUNTER_SCOPE_COUNT: > + if (a->comp.type == COUNTER_COMP_SYNAPSE_ACTION) > + err = a->comp.action_write(counter, count, synapse, > + data); > + else > + err = a->comp.count_u32_write(counter, count, data); > + break; > + } > + if (err < 0) > + return err; > + > + return len; > +} > + > +static ssize_t counter_comp_u64_show(struct device *dev, > + struct device_attribute *attr, char *buf) > +{ > + const struct counter_attribute *const a = to_counter_attribute(attr); > + struct counter_device *const counter = dev_get_drvdata(dev); > + int err; > + u64 data = 0; > + > + switch (a->scope) { > + case COUNTER_SCOPE_DEVICE: > + err = a->comp.device_u64_read(counter, &data); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = a->comp.signal_u64_read(counter, a->parent, &data); > + break; > + case COUNTER_SCOPE_COUNT: > + err = a->comp.count_u64_read(counter, a->parent, &data); > + break; > + } > + if (err < 0) > + return err; > + > + return sprintf(buf, "%llu\n", (unsigned long long)data); > +} > + > +static ssize_t counter_comp_u64_store(struct device *dev, > + struct device_attribute *attr, > + const char *buf, size_t len) > +{ > + const struct counter_attribute *const a = to_counter_attribute(attr); > + struct counter_device *const counter = dev_get_drvdata(dev); > + int err; > + u64 data = 0; > + > + err = kstrtou64(buf, 0, &data); > + if (err < 0) > + return err; > + > + switch (a->scope) { > + case COUNTER_SCOPE_DEVICE: > + err = a->comp.device_u64_write(counter, data); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = a->comp.signal_u64_write(counter, a->parent, data); > + break; > + case COUNTER_SCOPE_COUNT: > + err = a->comp.count_u64_write(counter, a->parent, data); > + break; > + } > + if (err < 0) > + return err; > + > + return len; > +} > + > +static ssize_t enums_available_show(const u32 *const enums, > + const size_t num_enums, > + const char *const strs[], char *buf) > +{ > + size_t len = 0; > + size_t index; > + > + for (index = 0; index < num_enums; index++) > + len += sprintf(buf + len, "%s\n", strs[enums[index]]); Probably better to add protections on overrunning the buffer to this. Sure it won't actually happen but that may not be obvious to someone reading this code in future. Look at new sysfs_emit * family for this. https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=2efc459d06f1630001e3984854848a5647086232 > + > + return len; > +} > + > +static ssize_t strs_available_show(const struct counter_available *const avail, > + char *buf) > +{ > + size_t len = 0; > + size_t index; > + > + for (index = 0; index < avail->num_items; index++) > + len += sprintf(buf + len, "%s\n", avail->strs[index]); > + > + return len; > +} > + > +static ssize_t counter_comp_available_show(struct device *dev, > + struct device_attribute *attr, > + char *buf) > +{ > + const struct counter_attribute *const a = to_counter_attribute(attr); > + const struct counter_count *const count = a->parent; > + const struct counter_synapse *const synapse = a->comp.priv; > + const struct counter_available *const avail = a->comp.priv; > + > + switch (a->comp.type) { > + case COUNTER_COMP_FUNCTION: > + return enums_available_show(count->functions_list, > + count->num_functions, > + counter_function_str, buf); > + case COUNTER_COMP_SYNAPSE_ACTION: > + return enums_available_show(synapse->actions_list, > + synapse->num_actions, > + counter_synapse_action_str, buf); > + case COUNTER_COMP_ENUM: > + return strs_available_show(avail, buf); > + case COUNTER_COMP_COUNT_MODE: > + return enums_available_show(avail->enums, avail->num_items, > + counter_count_mode_str, buf); > + default: > + break; Might as well return -EINVAL; here > + } > + > + return -EINVAL; > +} > + > +static int counter_avail_attr_create(struct device *const dev, > + struct counter_attribute_group *const group, > + const struct counter_comp *const comp, void *const parent) > +{ > + struct counter_attribute *counter_attr; > + struct device_attribute *dev_attr; > + > + /* Allocate Counter attribute */ > + counter_attr = devm_kzalloc(dev, sizeof(*counter_attr), GFP_KERNEL); > + if (!counter_attr) > + return -ENOMEM; > + > + /* Configure Counter attribute */ > + counter_attr->comp.type = comp->type; > + counter_attr->comp.priv = comp->priv; > + counter_attr->parent = parent; > + > + /* Initialize sysfs attribute */ > + dev_attr = &counter_attr->dev_attr; > + sysfs_attr_init(&dev_attr->attr); > + > + /* Configure device attribute */ > + dev_attr->attr.name = devm_kasprintf(dev, GFP_KERNEL, "%s_available", > + comp->name); > + if (!dev_attr->attr.name) > + return -ENOMEM; > + dev_attr->attr.mode = 0444; > + dev_attr->show = counter_comp_available_show; > + > + /* Store list node */ > + list_add(&counter_attr->l, &group->attr_list); > + group->num_attr++; > + > + return 0; > +} > + > +static int counter_attr_create(struct device *const dev, > + struct counter_attribute_group *const group, > + const struct counter_comp *const comp, > + const __u8 scope, void *const parent) > +{ > + struct counter_attribute *counter_attr; > + struct device_attribute *dev_attr; > + > + /* Allocate Counter attribute */ > + counter_attr = devm_kzalloc(dev, sizeof(*counter_attr), GFP_KERNEL); > + if (!counter_attr) > + return -ENOMEM; > + > + /* Configure Counter attribute */ > + counter_attr->comp = *comp; > + counter_attr->scope = scope; > + counter_attr->parent = parent; > + > + /* Configure device attribute */ > + dev_attr = &counter_attr->dev_attr; > + sysfs_attr_init(&dev_attr->attr); > + dev_attr->attr.name = comp->name; > + switch (comp->type) { > + case COUNTER_COMP_U8: > + case COUNTER_COMP_BOOL: > + if (comp->device_u8_read) { > + dev_attr->attr.mode |= 0444; > + dev_attr->show = counter_comp_u8_show; > + } > + if (comp->device_u8_write) { > + dev_attr->attr.mode |= 0200; > + dev_attr->store = counter_comp_u8_store; > + } > + break; > + case COUNTER_COMP_SIGNAL_LEVEL: > + case COUNTER_COMP_FUNCTION: > + case COUNTER_COMP_SYNAPSE_ACTION: > + case COUNTER_COMP_ENUM: > + case COUNTER_COMP_COUNT_DIRECTION: > + case COUNTER_COMP_COUNT_MODE: > + if (comp->device_u32_read) { > + dev_attr->attr.mode |= 0444; > + dev_attr->show = counter_comp_u32_show; > + } > + if (comp->device_u32_write) { > + dev_attr->attr.mode |= 0200; > + dev_attr->store = counter_comp_u32_store; > + } > + break; > + case COUNTER_COMP_U64: > + if (comp->device_u64_read) { > + dev_attr->attr.mode |= 0444; > + dev_attr->show = counter_comp_u64_show; > + } > + if (comp->device_u64_write) { > + dev_attr->attr.mode |= 0200; > + dev_attr->store = counter_comp_u64_store; > + } > + break; > + } > + > + /* Store list node */ > + list_add(&counter_attr->l, &group->attr_list); > + group->num_attr++; > + > + switch (comp->type) { > + case COUNTER_COMP_FUNCTION: > + case COUNTER_COMP_SYNAPSE_ACTION: > + case COUNTER_COMP_ENUM: > + case COUNTER_COMP_COUNT_MODE: > + return counter_avail_attr_create(dev, group, comp, parent); > + default: > + break; return 0 in here. Also add a comment on why it isn't an error. > + } > + > + return 0; > +} > + > +static ssize_t counter_comp_name_show(struct device *dev, > + struct device_attribute *attr, char *buf) > +{ > + return sprintf(buf, "%s\n", to_counter_attribute(attr)->comp.name); > +} > + > +static int counter_name_attr_create(struct device *const dev, > + struct counter_attribute_group *const group, > + const char *const name) > +{ > + struct counter_attribute *counter_attr; > + > + /* Allocate Counter attribute */ > + counter_attr = devm_kzalloc(dev, sizeof(*counter_attr), GFP_KERNEL); > + if (!counter_attr) > + return -ENOMEM; > + > + /* Configure Counter attribute */ > + counter_attr->comp.name = name; > + > + /* Configure device attribute */ > + sysfs_attr_init(&counter_attr->dev_attr.attr); > + counter_attr->dev_attr.attr.name = "name"; > + counter_attr->dev_attr.attr.mode = 0444; > + counter_attr->dev_attr.show = counter_comp_name_show; > + > + /* Store list node */ > + list_add(&counter_attr->l, &group->attr_list); > + group->num_attr++; > + > + return 0; > +} > + > + > +static struct counter_comp counter_signal_comp = { > + .type = COUNTER_COMP_SIGNAL_LEVEL, > + .name = "signal", > +}; > + > +static int counter_signal_attrs_create(struct counter_device *const counter, > + struct counter_attribute_group *const group, > + struct counter_signal *const signal) > +{ > + const __u8 scope = COUNTER_SCOPE_SIGNAL; > + struct device *const dev = &counter->dev; > + int err; > + struct counter_comp comp; > + size_t i; > + > + /* Create main Signal attribute */ > + comp = counter_signal_comp; > + comp.signal_u32_read = counter->ops->signal_read; > + err = counter_attr_create(dev, group, &comp, scope, signal); > + if (err < 0) > + return err; > + > + /* Create Signal name attribute */ > + err = counter_name_attr_create(dev, group, signal->name); > + if (err < 0) > + return err; > + > + /* Create an attribute for each extension */ > + for (i = 0; i < signal->num_ext; i++) { > + err = counter_attr_create(dev, group, signal->ext + i, scope, > + signal); > + if (err < 0) > + return err; > + } > + > + return 0; > +} > + > +static int counter_sysfs_signals_add(struct counter_device *const counter, > + struct counter_attribute_group *const groups) > +{ > + size_t i; > + int err; > + > + /* Add each Signal */ > + for (i = 0; i < counter->num_signals; i++) { > + /* Generate Signal attribute directory name */ > + groups[i].name = devm_kasprintf(&counter->dev, GFP_KERNEL, > + "signal%zu", i); > + if (!groups[i].name) > + return -ENOMEM; > + > + /* Create all attributes associated with Signal */ > + err = counter_signal_attrs_create(counter, groups + i, > + counter->signals + i); > + if (err < 0) > + return err; > + } > + > + return 0; > +} > + > +static int counter_sysfs_synapses_add(struct counter_device *const counter, > + struct counter_attribute_group *const group, > + struct counter_count *const count) > +{ > + const __u8 scope = COUNTER_SCOPE_COUNT; > + struct device *const dev = &counter->dev; > + size_t i; > + struct counter_synapse *synapse; > + size_t id; > + struct counter_comp comp; > + int err; > + > + /* Add each Synapse */ > + for (i = 0; i < count->num_synapses; i++) { Could reduce scope and make code a bit more readable by pulling struct counter_synapse *synapse; struct counter_comp comp; size_t id; and maybe other things in here. Makes it clear their scope is just within this loop. > + synapse = count->synapses + i; > + > + /* Generate Synapse action name */ > + id = synapse->signal - counter->signals; > + comp.name = devm_kasprintf(dev, GFP_KERNEL, "signal%zu_action", > + id); > + if (!comp.name) > + return -ENOMEM; > + > + /* Create action attribute */ > + comp.type = COUNTER_COMP_SYNAPSE_ACTION; > + comp.action_read = counter->ops->action_read; > + comp.action_write = counter->ops->action_write; > + comp.priv = synapse; > + err = counter_attr_create(dev, group, &comp, scope, count); > + if (err < 0) > + return err; > + } > + > + return 0; > +} > + > +static struct counter_comp counter_count_comp = > + COUNTER_COMP_COUNT_U64("count", NULL, NULL); > + > +static struct counter_comp counter_function_comp = { > + .type = COUNTER_COMP_FUNCTION, > + .name = "function", > +}; > + > +static int counter_count_attrs_create(struct counter_device *const counter, > + struct counter_attribute_group *const group, > + struct counter_count *const count) > +{ > + const __u8 scope = COUNTER_SCOPE_COUNT; > + struct device *const dev = &counter->dev; > + int err; > + struct counter_comp comp; > + size_t i; > + > + /* Create main Count attribute */ > + comp = counter_count_comp; > + comp.count_u64_read = counter->ops->count_read; > + comp.count_u64_write = counter->ops->count_write; > + err = counter_attr_create(dev, group, &comp, scope, count); > + if (err < 0) > + return err; > + > + /* Create Count name attribute */ > + err = counter_name_attr_create(dev, group, count->name); > + if (err < 0) > + return err; > + > + /* Create Count function attribute */ > + comp = counter_function_comp; > + comp.count_u32_read = counter->ops->function_read; > + comp.count_u32_write = counter->ops->function_write; > + err = counter_attr_create(dev, group, &comp, scope, count); > + if (err < 0) > + return err; > + > + /* Create an attribute for each extension */ > + for (i = 0; i < count->num_ext; i++) { > + err = counter_attr_create(dev, group, count->ext + i, scope, > + count); > + if (err < 0) > + return err; > + } > + > + return 0; > +} > + > +static int counter_sysfs_counts_add(struct counter_device *const counter, > + struct counter_attribute_group *const groups) > +{ > + size_t i; > + struct counter_count *count; > + int err; > + > + /* Add each Count */ > + for (i = 0; i < counter->num_counts; i++) { > + count = counter->counts + i; > + > + /* Generate Count attribute directory name */ > + groups[i].name = devm_kasprintf(&counter->dev, GFP_KERNEL, > + "count%zu", i); > + if (!groups[i].name) > + return -ENOMEM; > + > + /* Add sysfs attributes of the Synapses */ > + err = counter_sysfs_synapses_add(counter, groups + i, count); > + if (err < 0) > + return err; > + > + /* Create all attributes associated with Count */ > + err = counter_count_attrs_create(counter, groups + i, count); > + if (err < 0) > + return err; > + } > + > + return 0; > +} > + > +static int counter_num_signals_read(struct counter_device *counter, u8 *val) > +{ > + *val = counter->num_signals; > + return 0; > +} > + > +static int counter_num_counts_read(struct counter_device *counter, u8 *val) > +{ > + *val = counter->num_counts; > + return 0; > +} > + > +static struct counter_comp counter_num_signals_comp = > + COUNTER_COMP_DEVICE_U8("num_signals", counter_num_signals_read, NULL); > + > +static struct counter_comp counter_num_counts_comp = > + COUNTER_COMP_DEVICE_U8("num_counts", counter_num_counts_read, NULL); > + > +static int counter_sysfs_attr_add(struct counter_device *const counter, > + struct counter_attribute_group *group) > +{ > + const __u8 scope = COUNTER_SCOPE_DEVICE; > + struct device *const dev = &counter->dev; > + int err; > + size_t i; > + > + /* Add Signals sysfs attributes */ > + err = counter_sysfs_signals_add(counter, group); > + if (err < 0) > + return err; > + group += counter->num_signals; > + > + /* Add Counts sysfs attributes */ > + err = counter_sysfs_counts_add(counter, group); > + if (err < 0) > + return err; > + group += counter->num_counts; > + > + /* Create name attribute */ > + err = counter_name_attr_create(dev, group, counter->name); > + if (err < 0) > + return err; > + > + /* Create num_signals attribute */ > + err = counter_attr_create(dev, group, &counter_num_signals_comp, scope, > + NULL); > + if (err < 0) > + return err; > + > + /* Create num_counts attribute */ > + err = counter_attr_create(dev, group, &counter_num_counts_comp, scope, > + NULL); > + if (err < 0) > + return err; > + > + /* Create an attribute for each extension */ > + for (i = 0; i < counter->num_ext; i++) { > + err = counter_attr_create(dev, group, counter->ext + i, scope, > + NULL); > + if (err < 0) > + return err; > + } > + > + return 0; > +} > + > +/** > + * counter_sysfs_add - Adds Counter sysfs attributes to the device structure > + * @counter: Pointer to the Counter device structure > + * > + * Counter sysfs attributes are created and added to the respective device > + * structure for later registration to the system. Resource-managed memory > + * allocation is performed by this function, and this memory should be freed > + * when no longer needed (automatically by a device_unregister call, or > + * manually by a devres_release_all call). > + */ > +int counter_sysfs_add(struct counter_device *const counter) > +{ > + struct device *const dev = &counter->dev; > + const size_t num_groups = counter->num_signals + counter->num_counts + 1; > + struct counter_attribute_group *groups; > + size_t i, j; > + int err; > + struct attribute_group *group; > + struct counter_attribute *p; > + > + /* Allocate space for attribute groups (signals, counts, and ext) */ > + groups = devm_kcalloc(dev, num_groups, sizeof(*groups), GFP_KERNEL); > + if (!groups) > + return -ENOMEM; > + > + /* Initialize attribute lists */ > + for (i = 0; i < num_groups; i++) > + INIT_LIST_HEAD(&groups[i].attr_list); > + > + /* Add Counter device sysfs attributes */ > + err = counter_sysfs_attr_add(counter, groups); > + if (err < 0) > + return err; > + > + /* Allocate attribute groups for association with device */ > + dev->groups = devm_kcalloc(dev, num_groups + 1, sizeof(*dev->groups), > + GFP_KERNEL); > + if (!dev->groups) > + return -ENOMEM; > + > + /* Prepare each group of attributes for association */ > + for (i = 0; i < num_groups; i++) { > + /* Allocate space for attribute group */ > + group = devm_kzalloc(dev, sizeof(*group), GFP_KERNEL); > + if (!group) > + return -ENOMEM; > + group->name = groups[i].name; > + > + /* Allocate space for attribute pointers */ > + group->attrs = devm_kcalloc(dev, groups[i].num_attr + 1, > + sizeof(*group->attrs), GFP_KERNEL); > + if (!group->attrs) > + return -ENOMEM; > + > + /* Add attribute pointers to attribute group */ > + j = 0; > + list_for_each_entry(p, &groups[i].attr_list, l) > + group->attrs[j++] = &p->dev_attr.attr; > + > + /* Associate attribute group */ > + dev->groups[i] = group; > + } > + > + return 0; > +} ... ... > diff --git a/include/linux/counter.h b/include/linux/counter.h > index 9dbd5df4cd34..2f01e1fec857 100644 > --- a/include/linux/counter.h > +++ b/include/linux/counter.h > @@ -6,417 +6,290 @@ > #ifndef _COUNTER_H_ > #define _COUNTER_H_ > > -#include <linux/counter_enum.h> > #include <linux/device.h> > +#include <linux/kernel.h> > #include <linux/types.h> > > +struct counter_device; > +struct counter_count; > +struct counter_synapse; > +struct counter_signal; > + > +enum counter_comp_type { > + COUNTER_COMP_U8, > + COUNTER_COMP_U64, > + COUNTER_COMP_BOOL, > + COUNTER_COMP_SIGNAL_LEVEL, > + COUNTER_COMP_FUNCTION, > + COUNTER_COMP_SYNAPSE_ACTION, > + COUNTER_COMP_ENUM, > + COUNTER_COMP_COUNT_DIRECTION, > + COUNTER_COMP_COUNT_MODE, > +}; > + > +enum counter_scope { > + COUNTER_SCOPE_DEVICE, > + COUNTER_SCOPE_SIGNAL, > + COUNTER_SCOPE_COUNT, > +}; > + > enum counter_count_direction { > - COUNTER_COUNT_DIRECTION_FORWARD = 0, > - COUNTER_COUNT_DIRECTION_BACKWARD > + COUNTER_COUNT_DIRECTION_FORWARD, > + COUNTER_COUNT_DIRECTION_BACKWARD, > }; > -extern const char *const counter_count_direction_str[2]; > > enum counter_count_mode { > - COUNTER_COUNT_MODE_NORMAL = 0, > + COUNTER_COUNT_MODE_NORMAL, > COUNTER_COUNT_MODE_RANGE_LIMIT, > COUNTER_COUNT_MODE_NON_RECYCLE, > - COUNTER_COUNT_MODE_MODULO_N > + COUNTER_COUNT_MODE_MODULO_N, > }; > -extern const char *const counter_count_mode_str[4]; > > -struct counter_device; > -struct counter_signal; > +enum counter_function { > + COUNTER_FUNCTION_INCREASE, > + COUNTER_FUNCTION_DECREASE, > + COUNTER_FUNCTION_PULSE_DIRECTION, > + COUNTER_FUNCTION_QUADRATURE_X1_A, > + COUNTER_FUNCTION_QUADRATURE_X1_B, > + COUNTER_FUNCTION_QUADRATURE_X2_A, > + COUNTER_FUNCTION_QUADRATURE_X2_B, > + COUNTER_FUNCTION_QUADRATURE_X4, > +}; > + > +enum counter_signal_level { > + COUNTER_SIGNAL_LEVEL_LOW, > + COUNTER_SIGNAL_LEVEL_HIGH, > +}; > + > +enum counter_synapse_action { > + COUNTER_SYNAPSE_ACTION_NONE, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > +}; > > /** > - * struct counter_signal_ext - Counter Signal extensions > - * @name: attribute name > - * @read: read callback for this attribute; may be NULL > - * @write: write callback for this attribute; may be NULL > - * @priv: data private to the driver > + * struct counter_comp - Counter component node > + * @type: Counter component data type > + * @name: device-specific component name > + * @priv: component-relevant data > + * @action_read Synapse action mode read callback. The read value of the > + * respective Synapse action mode should be passed back via > + * the action parameter. > + * @device_u8_read Device u8 component read callback. The read value of the > + * respective Device u8 component should be passed back via > + * the val parameter. > + * @count_u8_read Count u8 component read callback. The read value of the > + * respective Count u8 component should be passed back via > + * the val parameter. > + * @signal_u8_read Signal u8 component read callback. The read value of the > + * respective Signal u8 component should be passed back via > + * the val parameter. > + * @device_u32_read Device u32 component read callback. The read value of > + * the respective Device u32 component should be passed > + * back via the val parameter. > + * @count_u32_read Count u32 component read callback. The read value of the > + * respective Count u32 component should be passed back via > + * the val parameter. > + * @signal_u32_read Signal u32 component read callback. The read value of > + * the respective Signal u32 component should be passed > + * back via the val parameter. > + * @device_u64_read Device u64 component read callback. The read value of > + * the respective Device u64 component should be passed > + * back via the val parameter. > + * @count_u64_read Count u64 component read callback. The read value of the > + * respective Count u64 component should be passed back via > + * the val parameter. > + * @signal_u64_read Signal u64 component read callback. The read value of > + * the respective Signal u64 component should be passed > + * back via the val parameter. > + * @action_write Synapse action mode write callback. The write value of > + * the respective Synapse action mode is passed via the > + * action parameter. > + * @device_u8_write Device u8 component write callback. The write value of > + * the respective Device u8 component is passed via the val > + * parameter. > + * @count_u8_write Count u8 component write callback. The write value of > + * the respective Count u8 component is passed via the val > + * parameter. > + * @signal_u8_write Signal u8 component write callback. The write value of > + * the respective Signal u8 component is passed via the val > + * parameter. > + * @device_u32_write Device u32 component write callback. The write value of > + * the respective Device u32 component is passed via the > + * val parameter. > + * @count_u32_write Count u32 component write callback. The write value of > + * the respective Count u32 component is passed via the val > + * parameter. > + * @signal_u32_write Signal u32 component write callback. The write value of > + * the respective Signal u32 component is passed via the > + * val parameter. > + * @device_u64_write Device u64 component write callback. The write value of > + * the respective Device u64 component is passed via the > + * val parameter. > + * @count_u64_write Count u64 component write callback. The write value of > + * the respective Count u64 component is passed via the val > + * parameter. > + * @signal_u64_write Signal u64 component write callback. The write value of > + * the respective Signal u64 component is passed via the > + * val parameter. > */ > -struct counter_signal_ext { > +struct counter_comp { > + enum counter_comp_type type; > const char *name; > - ssize_t (*read)(struct counter_device *counter, > - struct counter_signal *signal, void *priv, char *buf); > - ssize_t (*write)(struct counter_device *counter, > - struct counter_signal *signal, void *priv, > - const char *buf, size_t len); > void *priv; > + union { > + int (*action_read)(struct counter_device *counter, > + struct counter_count *count, > + struct counter_synapse *synapse, > + enum counter_synapse_action *action); > + int (*device_u8_read)(struct counter_device *counter, u8 *val); > + int (*count_u8_read)(struct counter_device *counter, > + struct counter_count *count, u8 *val); > + int (*signal_u8_read)(struct counter_device *counter, > + struct counter_signal *signal, u8 *val); > + int (*device_u32_read)(struct counter_device *counter, > + u32 *val); > + int (*count_u32_read)(struct counter_device *counter, > + struct counter_count *count, u32 *val); > + int (*signal_u32_read)(struct counter_device *counter, > + struct counter_signal *signal, u32 *val); > + int (*device_u64_read)(struct counter_device *counter, > + u64 *val); > + int (*count_u64_read)(struct counter_device *counter, > + struct counter_count *count, u64 *val); > + int (*signal_u64_read)(struct counter_device *counter, > + struct counter_signal *signal, u64 *val); > + }; > + union { > + int (*action_write)(struct counter_device *counter, > + struct counter_count *count, > + struct counter_synapse *synapse, > + enum counter_synapse_action action); > + int (*device_u8_write)(struct counter_device *counter, u8 val); > + int (*count_u8_write)(struct counter_device *counter, > + struct counter_count *count, u8 val); > + int (*signal_u8_write)(struct counter_device *counter, > + struct counter_signal *signal, u8 val); > + int (*device_u32_write)(struct counter_device *counter, > + u32 val); > + int (*count_u32_write)(struct counter_device *counter, > + struct counter_count *count, u32 val); > + int (*signal_u32_write)(struct counter_device *counter, > + struct counter_signal *signal, u32 val); > + int (*device_u64_write)(struct counter_device *counter, > + u64 val); > + int (*count_u64_write)(struct counter_device *counter, > + struct counter_count *count, u64 val); > + int (*signal_u64_write)(struct counter_device *counter, > + struct counter_signal *signal, u64 val); > + }; > }; > > /** > * struct counter_signal - Counter Signal node > - * @id: unique ID used to identify signal > - * @name: device-specific Signal name; ideally, this should match the name > - * as it appears in the datasheet documentation > - * @ext: optional array of Counter Signal extensions > - * @num_ext: number of Counter Signal extensions specified in @ext > - * @priv: optional private data supplied by driver > + * @id: unique ID used to identify the Signal > + * @name: device-specific Signal name > + * @ext: optional array of Signal extensions > + * @num_ext: number of Signal extensions specified in @ext > */ > struct counter_signal { > int id; > const char *name; > > - const struct counter_signal_ext *ext; > + struct counter_comp *ext; > size_t num_ext; > - > - void *priv; > -}; > - > -/** > - * struct counter_signal_enum_ext - Signal enum extension attribute > - * @items: Array of strings > - * @num_items: Number of items specified in @items > - * @set: Set callback function; may be NULL > - * @get: Get callback function; may be NULL > - * > - * The counter_signal_enum_ext structure can be used to implement enum style > - * Signal extension attributes. Enum style attributes are those which have a set > - * of strings that map to unsigned integer values. The Generic Counter Signal > - * enum extension helper code takes care of mapping between value and string, as > - * well as generating a "_available" file which contains a list of all available > - * items. The get callback is used to query the currently active item; the index > - * of the item within the respective items array is returned via the 'item' > - * parameter. The set callback is called when the attribute is updated; the > - * 'item' parameter contains the index of the newly activated item within the > - * respective items array. > - */ > -struct counter_signal_enum_ext { > - const char * const *items; > - size_t num_items; > - int (*get)(struct counter_device *counter, > - struct counter_signal *signal, size_t *item); > - int (*set)(struct counter_device *counter, > - struct counter_signal *signal, size_t item); > -}; > - > -/** > - * COUNTER_SIGNAL_ENUM() - Initialize Signal enum extension > - * @_name: Attribute name > - * @_e: Pointer to a counter_signal_enum_ext structure > - * > - * This should usually be used together with COUNTER_SIGNAL_ENUM_AVAILABLE() > - */ > -#define COUNTER_SIGNAL_ENUM(_name, _e) \ > -{ \ > - .name = (_name), \ > - .read = counter_signal_enum_read, \ > - .write = counter_signal_enum_write, \ > - .priv = (_e) \ > -} > - > -/** > - * COUNTER_SIGNAL_ENUM_AVAILABLE() - Initialize Signal enum available extension > - * @_name: Attribute name ("_available" will be appended to the name) > - * @_e: Pointer to a counter_signal_enum_ext structure > - * > - * Creates a read only attribute that lists all the available enum items in a > - * newline separated list. This should usually be used together with > - * COUNTER_SIGNAL_ENUM() > - */ > -#define COUNTER_SIGNAL_ENUM_AVAILABLE(_name, _e) \ > -{ \ > - .name = (_name "_available"), \ > - .read = counter_signal_enum_available_read, \ > - .priv = (_e) \ > -} > - > -enum counter_synapse_action { > - COUNTER_SYNAPSE_ACTION_NONE = 0, > - COUNTER_SYNAPSE_ACTION_RISING_EDGE, > - COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > - COUNTER_SYNAPSE_ACTION_BOTH_EDGES > }; > > /** > * struct counter_synapse - Counter Synapse node > - * @action: index of current action mode > * @actions_list: array of available action modes > * @num_actions: number of action modes specified in @actions_list > - * @signal: pointer to associated signal > + * @signal: pointer to the associated Signal Might have been nice to pull the cases that were purely capitalization out as a separate patch immediately following this one. There aren't a huge number, but from a review point of view it's a noop patch so doesn't need the reviewer to be awake :) > */ > struct counter_synapse { > - size_t action; > const enum counter_synapse_action *actions_list; > size_t num_actions; > > struct counter_signal *signal; > }; > > -struct counter_count; > - > -/** > - * struct counter_count_ext - Counter Count extension > - * @name: attribute name > - * @read: read callback for this attribute; may be NULL > - * @write: write callback for this attribute; may be NULL > - * @priv: data private to the driver > - */ > -struct counter_count_ext { > - const char *name; > - ssize_t (*read)(struct counter_device *counter, > - struct counter_count *count, void *priv, char *buf); > - ssize_t (*write)(struct counter_device *counter, > - struct counter_count *count, void *priv, > - const char *buf, size_t len); > - void *priv; > -}; > - > -enum counter_count_function { > - COUNTER_COUNT_FUNCTION_INCREASE = 0, > - COUNTER_COUNT_FUNCTION_DECREASE, > - COUNTER_COUNT_FUNCTION_PULSE_DIRECTION, > - COUNTER_COUNT_FUNCTION_QUADRATURE_X1_A, > - COUNTER_COUNT_FUNCTION_QUADRATURE_X1_B, > - COUNTER_COUNT_FUNCTION_QUADRATURE_X2_A, > - COUNTER_COUNT_FUNCTION_QUADRATURE_X2_B, > - COUNTER_COUNT_FUNCTION_QUADRATURE_X4 > -}; > - > /** > * struct counter_count - Counter Count node > - * @id: unique ID used to identify Count > - * @name: device-specific Count name; ideally, this should match > - * the name as it appears in the datasheet documentation > - * @function: index of current function mode > - * @functions_list: array available function modes > + * @id: unique ID used to identify the Count > + * @name: device-specific Count name > + * @functions_list: array of available function modes > * @num_functions: number of function modes specified in @functions_list > - * @synapses: array of synapses for initialization > - * @num_synapses: number of synapses specified in @synapses > - * @ext: optional array of Counter Count extensions > - * @num_ext: number of Counter Count extensions specified in @ext > - * @priv: optional private data supplied by driver > + * @synapses: array of Synapses for initialization > + * @num_synapses: number of Synapses specified in @synapses > + * @ext: optional array of Count extensions > + * @num_ext: number of Count extensions specified in @ext > */ > struct counter_count { > int id; > const char *name; > > - size_t function; > - const enum counter_count_function *functions_list; > + const enum counter_function *functions_list; > size_t num_functions; > > struct counter_synapse *synapses; > size_t num_synapses; > > - const struct counter_count_ext *ext; > + struct counter_comp *ext; > size_t num_ext; > - > - void *priv; > -}; > - > -/** > - * struct counter_count_enum_ext - Count enum extension attribute > - * @items: Array of strings > - * @num_items: Number of items specified in @items > - * @set: Set callback function; may be NULL > - * @get: Get callback function; may be NULL > - * > - * The counter_count_enum_ext structure can be used to implement enum style > - * Count extension attributes. Enum style attributes are those which have a set > - * of strings that map to unsigned integer values. The Generic Counter Count > - * enum extension helper code takes care of mapping between value and string, as > - * well as generating a "_available" file which contains a list of all available > - * items. The get callback is used to query the currently active item; the index > - * of the item within the respective items array is returned via the 'item' > - * parameter. The set callback is called when the attribute is updated; the > - * 'item' parameter contains the index of the newly activated item within the > - * respective items array. > - */ > -struct counter_count_enum_ext { > - const char * const *items; > - size_t num_items; > - int (*get)(struct counter_device *counter, struct counter_count *count, > - size_t *item); > - int (*set)(struct counter_device *counter, struct counter_count *count, > - size_t item); > -}; > - > -/** > - * COUNTER_COUNT_ENUM() - Initialize Count enum extension > - * @_name: Attribute name > - * @_e: Pointer to a counter_count_enum_ext structure > - * > - * This should usually be used together with COUNTER_COUNT_ENUM_AVAILABLE() > - */ > -#define COUNTER_COUNT_ENUM(_name, _e) \ > -{ \ > - .name = (_name), \ > - .read = counter_count_enum_read, \ > - .write = counter_count_enum_write, \ > - .priv = (_e) \ > -} > - > -/** > - * COUNTER_COUNT_ENUM_AVAILABLE() - Initialize Count enum available extension > - * @_name: Attribute name ("_available" will be appended to the name) > - * @_e: Pointer to a counter_count_enum_ext structure > - * > - * Creates a read only attribute that lists all the available enum items in a > - * newline separated list. This should usually be used together with > - * COUNTER_COUNT_ENUM() > - */ > -#define COUNTER_COUNT_ENUM_AVAILABLE(_name, _e) \ > -{ \ > - .name = (_name "_available"), \ > - .read = counter_count_enum_available_read, \ > - .priv = (_e) \ > -} > - > -/** > - * struct counter_device_attr_group - internal container for attribute group > - * @attr_group: Counter sysfs attributes group > - * @attr_list: list to keep track of created Counter sysfs attributes > - * @num_attr: number of Counter sysfs attributes > - */ > -struct counter_device_attr_group { > - struct attribute_group attr_group; > - struct list_head attr_list; > - size_t num_attr; > -}; > - > -/** > - * struct counter_device_state - internal state container for a Counter device > - * @id: unique ID used to identify the Counter > - * @dev: internal device structure > - * @groups_list: attribute groups list (for Signals, Counts, and ext) > - * @num_groups: number of attribute groups containers > - * @groups: Counter sysfs attribute groups (to populate @dev.groups) > - */ > -struct counter_device_state { > - int id; > - struct device dev; > - struct counter_device_attr_group *groups_list; > - size_t num_groups; > - const struct attribute_group **groups; > -}; > - > -enum counter_signal_value { > - COUNTER_SIGNAL_LOW = 0, > - COUNTER_SIGNAL_HIGH > }; > > /** > * struct counter_ops - Callbacks from driver > - * @signal_read: optional read callback for Signal attribute. The read > - * value of the respective Signal should be passed back via > - * the val parameter. > - * @count_read: optional read callback for Count attribute. The read > - * value of the respective Count should be passed back via > - * the val parameter. > - * @count_write: optional write callback for Count attribute. The write > - * value for the respective Count is passed in via the val > + * @signal_read: read callback for Signals. The read level of the > + * respective Signal should be passed back via the level > * parameter. > - * @function_get: function to get the current count function mode. Returns > - * 0 on success and negative error code on error. The index > - * of the respective Count's returned function mode should > - * be passed back via the function parameter. > - * @function_set: function to set the count function mode. function is the > - * index of the requested function mode from the respective > - * Count's functions_list array. > - * @action_get: function to get the current action mode. Returns 0 on > - * success and negative error code on error. The index of > - * the respective Synapse's returned action mode should be > - * passed back via the action parameter. > - * @action_set: function to set the action mode. action is the index of > - * the requested action mode from the respective Synapse's > - * actions_list array. > + * @count_read: read callback for Counts. The read value of the > + * respective Count should be passed back via the value > + * parameter. > + * @count_write: write callback for Counts. The write value for the > + * respective Count is passed in via the value parameter. > + * @function_read: read callback the Count function modes. The read > + * function mode of the respective Count should be passed > + * back via the function parameter. > + * @function_write: write callback for Count function modes. The function > + * mode to write for the respective Count is passed in via > + * the function parameter. > + * @action_read: read callback the Synapse action modes. The read action > + * mode of the respective Synapse should be passed back via > + * the action parameter. > + * @action_write: write callback for Synapse action modes. The action mode > + * to write for the respective Synapse is passed in via the > + * action parameter. > */ > struct counter_ops { > int (*signal_read)(struct counter_device *counter, > struct counter_signal *signal, > - enum counter_signal_value *val); > + enum counter_signal_level *level); > int (*count_read)(struct counter_device *counter, > - struct counter_count *count, unsigned long *val); > + struct counter_count *count, u64 *value); > int (*count_write)(struct counter_device *counter, > - struct counter_count *count, unsigned long val); > - int (*function_get)(struct counter_device *counter, > - struct counter_count *count, size_t *function); > - int (*function_set)(struct counter_device *counter, > - struct counter_count *count, size_t function); > - int (*action_get)(struct counter_device *counter, > - struct counter_count *count, > - struct counter_synapse *synapse, size_t *action); > - int (*action_set)(struct counter_device *counter, > - struct counter_count *count, > - struct counter_synapse *synapse, size_t action); > + struct counter_count *count, u64 value); > + int (*function_read)(struct counter_device *counter, > + struct counter_count *count, > + enum counter_function *function); > + int (*function_write)(struct counter_device *counter, > + struct counter_count *count, > + enum counter_function function); > + int (*action_read)(struct counter_device *counter, > + struct counter_count *count, > + struct counter_synapse *synapse, > + enum counter_synapse_action *action); > + int (*action_write)(struct counter_device *counter, > + struct counter_count *count, > + struct counter_synapse *synapse, > + enum counter_synapse_action action); > }; > > -/** > - * struct counter_device_ext - Counter device extension > - * @name: attribute name > - * @read: read callback for this attribute; may be NULL > - * @write: write callback for this attribute; may be NULL > - * @priv: data private to the driver > - */ > -struct counter_device_ext { > - const char *name; > - ssize_t (*read)(struct counter_device *counter, void *priv, char *buf); > - ssize_t (*write)(struct counter_device *counter, void *priv, > - const char *buf, size_t len); > - void *priv; > -}; > - > -/** > - * struct counter_device_enum_ext - Counter enum extension attribute > - * @items: Array of strings > - * @num_items: Number of items specified in @items > - * @set: Set callback function; may be NULL > - * @get: Get callback function; may be NULL > - * > - * The counter_device_enum_ext structure can be used to implement enum style > - * Counter extension attributes. Enum style attributes are those which have a > - * set of strings that map to unsigned integer values. The Generic Counter enum > - * extension helper code takes care of mapping between value and string, as well > - * as generating a "_available" file which contains a list of all available > - * items. The get callback is used to query the currently active item; the index > - * of the item within the respective items array is returned via the 'item' > - * parameter. The set callback is called when the attribute is updated; the > - * 'item' parameter contains the index of the newly activated item within the > - * respective items array. > - */ > -struct counter_device_enum_ext { > - const char * const *items; > - size_t num_items; > - int (*get)(struct counter_device *counter, size_t *item); > - int (*set)(struct counter_device *counter, size_t item); > -}; > - > -/** > - * COUNTER_DEVICE_ENUM() - Initialize Counter enum extension > - * @_name: Attribute name > - * @_e: Pointer to a counter_device_enum_ext structure > - * > - * This should usually be used together with COUNTER_DEVICE_ENUM_AVAILABLE() > - */ > -#define COUNTER_DEVICE_ENUM(_name, _e) \ > -{ \ > - .name = (_name), \ > - .read = counter_device_enum_read, \ > - .write = counter_device_enum_write, \ > - .priv = (_e) \ > -} > - > -/** > - * COUNTER_DEVICE_ENUM_AVAILABLE() - Initialize Counter enum available extension > - * @_name: Attribute name ("_available" will be appended to the name) > - * @_e: Pointer to a counter_device_enum_ext structure > - * > - * Creates a read only attribute that lists all the available enum items in a > - * newline separated list. This should usually be used together with > - * COUNTER_DEVICE_ENUM() > - */ > -#define COUNTER_DEVICE_ENUM_AVAILABLE(_name, _e) \ > -{ \ > - .name = (_name "_available"), \ > - .read = counter_device_enum_available_read, \ > - .priv = (_e) \ > -} > - > /** > * struct counter_device - Counter data structure > - * @name: name of the device as it appears in the datasheet > + * @name: name of the device > * @parent: optional parent device providing the counters > - * @device_state: internal device state container > * @ops: callbacks from driver > * @signals: array of Signals > * @num_signals: number of Signals specified in @signals > @@ -425,11 +298,12 @@ struct counter_device_enum_ext { > * @ext: optional array of Counter device extensions > * @num_ext: number of Counter device extensions specified in @ext > * @priv: optional private data supplied by driver > + * @id: unique ID used to identify the Counter > + * @dev: internal device structure > */ > struct counter_device { > const char *name; > struct device *parent; > - struct counter_device_state *device_state; > > const struct counter_ops *ops; > > @@ -438,17 +312,160 @@ struct counter_device { > struct counter_count *counts; > size_t num_counts; > > - const struct counter_device_ext *ext; > + struct counter_comp *ext; > size_t num_ext; > > void *priv; > + > + int id; > + struct device dev; > }; > > int counter_register(struct counter_device *const counter); > void counter_unregister(struct counter_device *const counter); > int devm_counter_register(struct device *dev, > struct counter_device *const counter); > -void devm_counter_unregister(struct device *dev, > - struct counter_device *const counter); > + > +#define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_U8, \ > + .name = (_name), \ > + .device_u8_read = (_read), \ > + .device_u8_write = (_write), \ > +} > +#define COUNTER_COMP_COUNT_U8(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_U8, \ > + .name = (_name), \ > + .count_u8_read = (_read), \ > + .count_u8_write = (_write), \ > +} > +#define COUNTER_COMP_SIGNAL_U8(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_U8, \ > + .name = (_name), \ > + .signal_u8_read = (_read), \ > + .signal_u8_write = (_write), \ > +} > + > +#define COUNTER_COMP_DEVICE_U64(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_U64, \ > + .name = (_name), \ > + .device_u64_read = (_read), \ > + .device_u64_write = (_write), \ > +} > +#define COUNTER_COMP_COUNT_U64(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_U64, \ > + .name = (_name), \ > + .count_u64_read = (_read), \ > + .count_u64_write = (_write), \ > +} > +#define COUNTER_COMP_SIGNAL_U64(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_U64, \ > + .name = (_name), \ > + .signal_u64_read = (_read), \ > + .signal_u64_write = (_write), \ > +} > + > +#define COUNTER_COMP_DEVICE_BOOL(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_BOOL, \ > + .name = (_name), \ > + .device_u8_read = (_read), \ > + .device_u8_write = (_write), \ > +} > +#define COUNTER_COMP_COUNT_BOOL(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_BOOL, \ > + .name = (_name), \ > + .count_u8_read = (_read), \ > + .count_u8_write = (_write), \ > +} > +#define COUNTER_COMP_SIGNAL_BOOL(_name, _read, _write) \ > +{ \ > + .type = COUNTER_COMP_BOOL, \ > + .name = (_name), \ > + .signal_u8_read = (_read), \ > + .signal_u8_write = (_write), \ > +} > + > +struct counter_available { > + union { > + const u32 *enums; > + const char *const *strs; > + }; > + size_t num_items; > +}; > + > +#define DEFINE_COUNTER_AVAILABLE(_name, _enums) \ > + struct counter_available _name = { \ > + .enums = (_enums), \ > + .num_items = ARRAY_SIZE(_enums), \ > + } > + > +#define DEFINE_COUNTER_ENUM(_name, _strs) \ > + struct counter_available _name = { \ > + .strs = (_strs), \ > + .num_items = ARRAY_SIZE(_strs), \ > + } > + > +#define COUNTER_COMP_DEVICE_ENUM(_name, _get, _set, _available) \ > +{ \ > + .type = COUNTER_COMP_ENUM, \ > + .name = (_name), \ > + .device_u32_read = (_get), \ > + .device_u32_write = (_set), \ > + .priv = &(_available), \ > +} > +#define COUNTER_COMP_COUNT_ENUM(_name, _get, _set, _available) \ > +{ \ > + .type = COUNTER_COMP_ENUM, \ > + .name = (_name), \ > + .count_u32_read = (_get), \ > + .count_u32_write = (_set), \ > + .priv = &(_available), \ > +} > +#define COUNTER_COMP_SIGNAL_ENUM(_name, _get, _set, _available) \ > +{ \ > + .type = COUNTER_COMP_ENUM, \ > + .name = (_name), \ > + .signal_u32_read = (_get), \ > + .signal_u32_write = (_set), \ > + .priv = &(_available), \ > +} > + > +#define COUNTER_COMP_CEILING(_read, _write) \ > + COUNTER_COMP_COUNT_U64("ceiling", _read, _write) > + > +#define COUNTER_COMP_COUNT_MODE(_read, _write, _available) \ > +{ \ > + .type = COUNTER_COMP_COUNT_MODE, \ > + .name = "count_mode", \ > + .count_u32_read = (_read), \ > + .count_u32_write = (_write), \ > + .priv = &(_available), \ > +} > + > +#define COUNTER_COMP_DIRECTION(_read) \ > +{ \ > + .type = COUNTER_COMP_COUNT_DIRECTION, \ > + .name = "direction", \ > + .count_u32_read = (_read), \ > +} > + > +#define COUNTER_COMP_ENABLE(_read, _write) \ > + COUNTER_COMP_COUNT_BOOL("enable", _read, _write) > + > +#define COUNTER_COMP_FLOOR(_read, _write) \ > + COUNTER_COMP_COUNT_U64("floor", _read, _write) > + > +#define COUNTER_COMP_PRESET(_read, _write) \ > + COUNTER_COMP_COUNT_U64("preset", _read, _write) > + > +#define COUNTER_COMP_PRESET_ENABLE(_read, _write) \ > + COUNTER_COMP_COUNT_BOOL("preset_enable", _read, _write) > > #endif /* _COUNTER_H_ */ ... ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code 2020-12-30 14:37 ` Jonathan Cameron @ 2021-01-06 5:29 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-06 5:29 UTC (permalink / raw) To: Jonathan Cameron Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter [-- Attachment #1: Type: text/plain, Size: 12192 bytes --] On Wed, Dec 30, 2020 at 02:37:19PM +0000, Jonathan Cameron wrote: > On Fri, 25 Dec 2020 19:15:34 -0500 > William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > > > This is a reimplementation of the Generic Counter driver interface. > > There are no modifications to the Counter subsystem userspace interface, > > so existing userspace applications should continue to run seamlessly. > Hi William > > Been a while since I looked at this series. Its rather big and I'm lazy > (or busy depending on who I'm talking to :) > > Hmm. I'm a bit in two minds about how you should handle the huge amount of > description here. Some of it clearly belongs in the kernel docs (and some > is I think put there in a later patch). Other parts are specific to > this series, but I'm not 100% sure this much detail is really useful in the > git log. Note that we now have links to the threads for all patches applied > using b4 (which this will be) so it's fine to have really detailed stuff > in cover letters rather than the individual patches. I'll simplify the description here to something more succinct. > One thing that would be handy for review, might be if you put up a tree > somewhere with this applied and included a link. This is such a large set of changes that having a tree to checkout for review would be convenient. I typically push to my personal tree, so you can check out the changes there in the counter_chrdev_v* branches: https://gitlab.com/vilhelmgray/iio I'll include a link to it again in the cover letter for v8 when it's ready. > Mind you I don't feel that strongly about it if it you do want to maintain > it in the individual patch descriptions. > > I've been a bit lazy and not cropped this down as much as I ideally should > have done (to include only bits I'm commenting on). > > Anyhow, various minor things inline but this fundamentally looks fine to me. > > Jonathan > > > > > > Overview > > ======== > > > > The purpose of this patch is to internalize the sysfs interface code > > among the various counter drivers into a shared module. Counter drivers > > pass and take data natively (i.e. u8, u64, etc.) and the shared counter > > module handles the translation between the sysfs interface. > > Confusing statement. Between the sysfs interface and what? > Perhaps "handles the translation to/from the sysfs interface." Looks like I cut that line short by accident; it should read: "between the sysfs interface and the device drivers". I'll fix this up. > > This > > guarantees a standard userspace interface for all counter drivers, and > > helps generalize the Generic Counter driver ABI in order to support the > > Generic Counter chrdev interface (introduced in a subsequent patch) > > without significant changes to the existing counter drivers. > > > > A high-level view of how a count value is passed down from a counter > > driver is exemplified by the following. The driver callbacks are first > > registered to the Counter core component for use by the Counter > > userspace interface components: > > > > +----------------------------+ > > | Counter device driver | > > Looks like something snuck a tab in amongst your spaces. Ack. > > static int quad8_signal_read(struct counter_device *counter, > > - struct counter_signal *signal, enum counter_signal_value *val) > > + struct counter_signal *signal, > > + enum counter_signal_level *level) > > { > > const struct quad8_iio *const priv = counter->priv; > > unsigned int state; > > @@ -633,13 +634,13 @@ static int quad8_signal_read(struct counter_device *counter, > > state = inb(priv->base + QUAD8_REG_INDEX_INPUT_LEVELS) > > & BIT(signal->id - 16); > > > > - *val = (state) ? COUNTER_SIGNAL_HIGH : COUNTER_SIGNAL_LOW; > > + *level = (state) ? COUNTER_SIGNAL_LEVEL_HIGH : COUNTER_SIGNAL_LEVEL_LOW; > > This bit of refactoring / renaming could have been split out as a precursor patch > I think. There may be other opportunities. Ack. I'll look around for additional changes I can pull out as precursor patches too. > > > > return 0; > > } > > > > static int quad8_count_read(struct counter_device *counter, > > - struct counter_count *count, unsigned long *val) > > + struct counter_count *count, u64 *val) > > Could the type change for val have been done as a precursor? I don't think we can pull this one out as a precursor unfortunately. Since unsigned long is passed in as pointer, we could get a type mismatch if we're on a 32-bit system. For this to work, it requires the u64 change in struct counter_ops and subsequent dependent code, so we'll have to keep it as part of this patch for now. > > @@ -785,18 +782,21 @@ static int quad8_function_set(struct counter_device *counter, > > *quadrature_mode = 1; > > > > switch (function) { > > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X1: > > + case COUNTER_FUNCTION_QUADRATURE_X1_A: > > *scale = 0; > > mode_cfg |= QUAD8_CMR_QUADRATURE_X1; > > break; > > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X2: > > + case COUNTER_FUNCTION_QUADRATURE_X2_A: > > *scale = 1; > > mode_cfg |= QUAD8_CMR_QUADRATURE_X2; > > break; > > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X4: > > + case COUNTER_FUNCTION_QUADRATURE_X4: > > *scale = 2; > > mode_cfg |= QUAD8_CMR_QUADRATURE_X4; > > break; > > + default: > > + mutex_unlock(&priv->lock); > > + return -EINVAL; > > This looks like a sensible precaution / cleanup but could have been > done separately to the rest of the patch I think? Ack. > > @@ -1229,30 +1194,28 @@ static ssize_t quad8_count_ceiling_write(struct counter_device *counter, > > > > mutex_unlock(&priv->lock); > > > > - return len; > > + return -EINVAL; > > ? That looks like the good exit path to me. You're right, this should be a return 0. > > +/** > > + * counter_register - register Counter to the system > > + * @counter: pointer to Counter to register > > + * > > + * This function registers a Counter to the system. A sysfs "counter" directory > > + * will be created and populated with sysfs attributes correlating with the > > + * Counter Signals, Synapses, and Counts respectively. > > Where easy to do it's worth documenting return values. Ack. > > +static void devm_counter_unregister(struct device *dev, void *res) > > +{ > > + counter_unregister(*(struct counter_device **)res); > > Rename this. It looks like it's a generic way of unwinding > devm_counter_register which it is definitely not... Ack. > > +/** > > + * struct counter_attribute - Counter sysfs attribute > > + * @dev_attr: device attribute for sysfs > > + * @l: node to add Counter attribute to attribute group list > > + * @comp: Counter component callbacks and data > > + * @scope: Counter scope of the attribute > > + * @parent: pointer to the parent component > > + */ > > +struct counter_attribute { > > + struct device_attribute dev_attr; > > + struct list_head l; > > + > > + struct counter_comp comp; > > + __u8 scope; > > Why not an enum? This should be enum; I missed it from the previous revision. > > + switch (a->comp.type) { > > + case COUNTER_COMP_FUNCTION: > > + return sprintf(buf, "%s\n", counter_function_str[data]); > > + case COUNTER_COMP_SIGNAL_LEVEL: > > + return sprintf(buf, "%s\n", counter_signal_value_str[data]); > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + return sprintf(buf, "%s\n", counter_synapse_action_str[data]); > > + case COUNTER_COMP_ENUM: > > + return sprintf(buf, "%s\n", avail->strs[data]); > > + case COUNTER_COMP_COUNT_DIRECTION: > > + return sprintf(buf, "%s\n", counter_count_direction_str[data]); > > + case COUNTER_COMP_COUNT_MODE: > > + return sprintf(buf, "%s\n", counter_count_mode_str[data]); > > + default: > > Perhaps move the below return sprintf() up here? Ack. > > + break; > > + } > > + > > + return sprintf(buf, "%u\n", (unsigned int)data); > > +} > > + > > +static int find_in_string_array(u32 *const enum_item, const u32 *const enums, > > + const size_t num_enums, const char *const buf, > > + const char *const string_array[]) > > Please avoid defining such generically named functions. High chance of a clash > with something that turns up in generic headers sometime in the future. Ack. > > +static ssize_t enums_available_show(const u32 *const enums, > > + const size_t num_enums, > > + const char *const strs[], char *buf) > > +{ > > + size_t len = 0; > > + size_t index; > > + > > + for (index = 0; index < num_enums; index++) > > + len += sprintf(buf + len, "%s\n", strs[enums[index]]); > > Probably better to add protections on overrunning the buffer to this. > Sure it won't actually happen but that may not be obvious to someone reading > this code in future. > > Look at new sysfs_emit * family for this. > > https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=2efc459d06f1630001e3984854848a5647086232 Ack. > > +static ssize_t counter_comp_available_show(struct device *dev, > > + struct device_attribute *attr, > > + char *buf) > > +{ > > + const struct counter_attribute *const a = to_counter_attribute(attr); > > + const struct counter_count *const count = a->parent; > > + const struct counter_synapse *const synapse = a->comp.priv; > > + const struct counter_available *const avail = a->comp.priv; > > + > > + switch (a->comp.type) { > > + case COUNTER_COMP_FUNCTION: > > + return enums_available_show(count->functions_list, > > + count->num_functions, > > + counter_function_str, buf); > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + return enums_available_show(synapse->actions_list, > > + synapse->num_actions, > > + counter_synapse_action_str, buf); > > + case COUNTER_COMP_ENUM: > > + return strs_available_show(avail, buf); > > + case COUNTER_COMP_COUNT_MODE: > > + return enums_available_show(avail->enums, avail->num_items, > > + counter_count_mode_str, buf); > > + default: > > + break; > > Might as well return -EINVAL; here Ack. > > + /* Store list node */ > > + list_add(&counter_attr->l, &group->attr_list); > > + group->num_attr++; > > + > > + switch (comp->type) { > > + case COUNTER_COMP_FUNCTION: > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + case COUNTER_COMP_ENUM: > > + case COUNTER_COMP_COUNT_MODE: > > + return counter_avail_attr_create(dev, group, comp, parent); > > + default: > > + break; > > return 0 in here. Also add a comment on why it isn't an error. Ack. > > +static int counter_sysfs_synapses_add(struct counter_device *const counter, > > + struct counter_attribute_group *const group, > > + struct counter_count *const count) > > +{ > > + const __u8 scope = COUNTER_SCOPE_COUNT; > > + struct device *const dev = &counter->dev; > > + size_t i; > > + struct counter_synapse *synapse; > > + size_t id; > > + struct counter_comp comp; > > + int err; > > + > > + /* Add each Synapse */ > > + for (i = 0; i < count->num_synapses; i++) { > Could reduce scope and make code a bit more readable by > pulling > > struct counter_synapse *synapse; > struct counter_comp comp; > size_t id; > > and maybe other things in here. Makes it clear their scope > is just within this loop. Ack. > > /** > > * struct counter_synapse - Counter Synapse node > > - * @action: index of current action mode > > * @actions_list: array of available action modes > > * @num_actions: number of action modes specified in @actions_list > > - * @signal: pointer to associated signal > > + * @signal: pointer to the associated Signal > > Might have been nice to pull the cases that were purely capitalization out as > a separate patch immediately following this one. There aren't > a huge number, but from a review point of view it's a noop patch > so doesn't need the reviewer to be awake :) Ack. William Breathitt Gray [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code @ 2021-01-06 5:29 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-06 5:29 UTC (permalink / raw) To: Jonathan Cameron Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, Dan Carpenter, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue [-- Attachment #1.1: Type: text/plain, Size: 12192 bytes --] On Wed, Dec 30, 2020 at 02:37:19PM +0000, Jonathan Cameron wrote: > On Fri, 25 Dec 2020 19:15:34 -0500 > William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > > > This is a reimplementation of the Generic Counter driver interface. > > There are no modifications to the Counter subsystem userspace interface, > > so existing userspace applications should continue to run seamlessly. > Hi William > > Been a while since I looked at this series. Its rather big and I'm lazy > (or busy depending on who I'm talking to :) > > Hmm. I'm a bit in two minds about how you should handle the huge amount of > description here. Some of it clearly belongs in the kernel docs (and some > is I think put there in a later patch). Other parts are specific to > this series, but I'm not 100% sure this much detail is really useful in the > git log. Note that we now have links to the threads for all patches applied > using b4 (which this will be) so it's fine to have really detailed stuff > in cover letters rather than the individual patches. I'll simplify the description here to something more succinct. > One thing that would be handy for review, might be if you put up a tree > somewhere with this applied and included a link. This is such a large set of changes that having a tree to checkout for review would be convenient. I typically push to my personal tree, so you can check out the changes there in the counter_chrdev_v* branches: https://gitlab.com/vilhelmgray/iio I'll include a link to it again in the cover letter for v8 when it's ready. > Mind you I don't feel that strongly about it if it you do want to maintain > it in the individual patch descriptions. > > I've been a bit lazy and not cropped this down as much as I ideally should > have done (to include only bits I'm commenting on). > > Anyhow, various minor things inline but this fundamentally looks fine to me. > > Jonathan > > > > > > Overview > > ======== > > > > The purpose of this patch is to internalize the sysfs interface code > > among the various counter drivers into a shared module. Counter drivers > > pass and take data natively (i.e. u8, u64, etc.) and the shared counter > > module handles the translation between the sysfs interface. > > Confusing statement. Between the sysfs interface and what? > Perhaps "handles the translation to/from the sysfs interface." Looks like I cut that line short by accident; it should read: "between the sysfs interface and the device drivers". I'll fix this up. > > This > > guarantees a standard userspace interface for all counter drivers, and > > helps generalize the Generic Counter driver ABI in order to support the > > Generic Counter chrdev interface (introduced in a subsequent patch) > > without significant changes to the existing counter drivers. > > > > A high-level view of how a count value is passed down from a counter > > driver is exemplified by the following. The driver callbacks are first > > registered to the Counter core component for use by the Counter > > userspace interface components: > > > > +----------------------------+ > > | Counter device driver | > > Looks like something snuck a tab in amongst your spaces. Ack. > > static int quad8_signal_read(struct counter_device *counter, > > - struct counter_signal *signal, enum counter_signal_value *val) > > + struct counter_signal *signal, > > + enum counter_signal_level *level) > > { > > const struct quad8_iio *const priv = counter->priv; > > unsigned int state; > > @@ -633,13 +634,13 @@ static int quad8_signal_read(struct counter_device *counter, > > state = inb(priv->base + QUAD8_REG_INDEX_INPUT_LEVELS) > > & BIT(signal->id - 16); > > > > - *val = (state) ? COUNTER_SIGNAL_HIGH : COUNTER_SIGNAL_LOW; > > + *level = (state) ? COUNTER_SIGNAL_LEVEL_HIGH : COUNTER_SIGNAL_LEVEL_LOW; > > This bit of refactoring / renaming could have been split out as a precursor patch > I think. There may be other opportunities. Ack. I'll look around for additional changes I can pull out as precursor patches too. > > > > return 0; > > } > > > > static int quad8_count_read(struct counter_device *counter, > > - struct counter_count *count, unsigned long *val) > > + struct counter_count *count, u64 *val) > > Could the type change for val have been done as a precursor? I don't think we can pull this one out as a precursor unfortunately. Since unsigned long is passed in as pointer, we could get a type mismatch if we're on a 32-bit system. For this to work, it requires the u64 change in struct counter_ops and subsequent dependent code, so we'll have to keep it as part of this patch for now. > > @@ -785,18 +782,21 @@ static int quad8_function_set(struct counter_device *counter, > > *quadrature_mode = 1; > > > > switch (function) { > > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X1: > > + case COUNTER_FUNCTION_QUADRATURE_X1_A: > > *scale = 0; > > mode_cfg |= QUAD8_CMR_QUADRATURE_X1; > > break; > > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X2: > > + case COUNTER_FUNCTION_QUADRATURE_X2_A: > > *scale = 1; > > mode_cfg |= QUAD8_CMR_QUADRATURE_X2; > > break; > > - case QUAD8_COUNT_FUNCTION_QUADRATURE_X4: > > + case COUNTER_FUNCTION_QUADRATURE_X4: > > *scale = 2; > > mode_cfg |= QUAD8_CMR_QUADRATURE_X4; > > break; > > + default: > > + mutex_unlock(&priv->lock); > > + return -EINVAL; > > This looks like a sensible precaution / cleanup but could have been > done separately to the rest of the patch I think? Ack. > > @@ -1229,30 +1194,28 @@ static ssize_t quad8_count_ceiling_write(struct counter_device *counter, > > > > mutex_unlock(&priv->lock); > > > > - return len; > > + return -EINVAL; > > ? That looks like the good exit path to me. You're right, this should be a return 0. > > +/** > > + * counter_register - register Counter to the system > > + * @counter: pointer to Counter to register > > + * > > + * This function registers a Counter to the system. A sysfs "counter" directory > > + * will be created and populated with sysfs attributes correlating with the > > + * Counter Signals, Synapses, and Counts respectively. > > Where easy to do it's worth documenting return values. Ack. > > +static void devm_counter_unregister(struct device *dev, void *res) > > +{ > > + counter_unregister(*(struct counter_device **)res); > > Rename this. It looks like it's a generic way of unwinding > devm_counter_register which it is definitely not... Ack. > > +/** > > + * struct counter_attribute - Counter sysfs attribute > > + * @dev_attr: device attribute for sysfs > > + * @l: node to add Counter attribute to attribute group list > > + * @comp: Counter component callbacks and data > > + * @scope: Counter scope of the attribute > > + * @parent: pointer to the parent component > > + */ > > +struct counter_attribute { > > + struct device_attribute dev_attr; > > + struct list_head l; > > + > > + struct counter_comp comp; > > + __u8 scope; > > Why not an enum? This should be enum; I missed it from the previous revision. > > + switch (a->comp.type) { > > + case COUNTER_COMP_FUNCTION: > > + return sprintf(buf, "%s\n", counter_function_str[data]); > > + case COUNTER_COMP_SIGNAL_LEVEL: > > + return sprintf(buf, "%s\n", counter_signal_value_str[data]); > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + return sprintf(buf, "%s\n", counter_synapse_action_str[data]); > > + case COUNTER_COMP_ENUM: > > + return sprintf(buf, "%s\n", avail->strs[data]); > > + case COUNTER_COMP_COUNT_DIRECTION: > > + return sprintf(buf, "%s\n", counter_count_direction_str[data]); > > + case COUNTER_COMP_COUNT_MODE: > > + return sprintf(buf, "%s\n", counter_count_mode_str[data]); > > + default: > > Perhaps move the below return sprintf() up here? Ack. > > + break; > > + } > > + > > + return sprintf(buf, "%u\n", (unsigned int)data); > > +} > > + > > +static int find_in_string_array(u32 *const enum_item, const u32 *const enums, > > + const size_t num_enums, const char *const buf, > > + const char *const string_array[]) > > Please avoid defining such generically named functions. High chance of a clash > with something that turns up in generic headers sometime in the future. Ack. > > +static ssize_t enums_available_show(const u32 *const enums, > > + const size_t num_enums, > > + const char *const strs[], char *buf) > > +{ > > + size_t len = 0; > > + size_t index; > > + > > + for (index = 0; index < num_enums; index++) > > + len += sprintf(buf + len, "%s\n", strs[enums[index]]); > > Probably better to add protections on overrunning the buffer to this. > Sure it won't actually happen but that may not be obvious to someone reading > this code in future. > > Look at new sysfs_emit * family for this. > > https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=2efc459d06f1630001e3984854848a5647086232 Ack. > > +static ssize_t counter_comp_available_show(struct device *dev, > > + struct device_attribute *attr, > > + char *buf) > > +{ > > + const struct counter_attribute *const a = to_counter_attribute(attr); > > + const struct counter_count *const count = a->parent; > > + const struct counter_synapse *const synapse = a->comp.priv; > > + const struct counter_available *const avail = a->comp.priv; > > + > > + switch (a->comp.type) { > > + case COUNTER_COMP_FUNCTION: > > + return enums_available_show(count->functions_list, > > + count->num_functions, > > + counter_function_str, buf); > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + return enums_available_show(synapse->actions_list, > > + synapse->num_actions, > > + counter_synapse_action_str, buf); > > + case COUNTER_COMP_ENUM: > > + return strs_available_show(avail, buf); > > + case COUNTER_COMP_COUNT_MODE: > > + return enums_available_show(avail->enums, avail->num_items, > > + counter_count_mode_str, buf); > > + default: > > + break; > > Might as well return -EINVAL; here Ack. > > + /* Store list node */ > > + list_add(&counter_attr->l, &group->attr_list); > > + group->num_attr++; > > + > > + switch (comp->type) { > > + case COUNTER_COMP_FUNCTION: > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + case COUNTER_COMP_ENUM: > > + case COUNTER_COMP_COUNT_MODE: > > + return counter_avail_attr_create(dev, group, comp, parent); > > + default: > > + break; > > return 0 in here. Also add a comment on why it isn't an error. Ack. > > +static int counter_sysfs_synapses_add(struct counter_device *const counter, > > + struct counter_attribute_group *const group, > > + struct counter_count *const count) > > +{ > > + const __u8 scope = COUNTER_SCOPE_COUNT; > > + struct device *const dev = &counter->dev; > > + size_t i; > > + struct counter_synapse *synapse; > > + size_t id; > > + struct counter_comp comp; > > + int err; > > + > > + /* Add each Synapse */ > > + for (i = 0; i < count->num_synapses; i++) { > Could reduce scope and make code a bit more readable by > pulling > > struct counter_synapse *synapse; > struct counter_comp comp; > size_t id; > > and maybe other things in here. Makes it clear their scope > is just within this loop. Ack. > > /** > > * struct counter_synapse - Counter Synapse node > > - * @action: index of current action mode > > * @actions_list: array of available action modes > > * @num_actions: number of action modes specified in @actions_list > > - * @signal: pointer to associated signal > > + * @signal: pointer to the associated Signal > > Might have been nice to pull the cases that were purely capitalization out as > a separate patch immediately following this one. There aren't > a huge number, but from a review point of view it's a noop patch > so doesn't need the reviewer to be awake :) Ack. William Breathitt Gray [-- Attachment #1.2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] [-- Attachment #2: Type: text/plain, Size: 176 bytes --] _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code 2020-12-26 0:15 ` [PATCH v7 1/5] counter: Internalize sysfs interface code William Breathitt Gray @ 2020-12-30 23:24 ` David Lechner 2020-12-30 23:24 ` David Lechner 1 sibling, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 23:24 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter On 12/25/20 6:15 PM, William Breathitt Gray wrote: > diff --git a/drivers/counter/ti-eqep.c b/drivers/counter/ti-eqep.c > index a60aee1a1a29..6c058b93dc98 100644 > --- a/drivers/counter/ti-eqep.c > +++ b/drivers/counter/ti-eqep.c > -static ssize_t ti_eqep_position_floor_write(struct counter_device *counter, > - struct counter_count *count, > - void *ext_priv, const char *buf, > - size_t len) > +static int ti_eqep_position_floor_write(struct counter_device *counter, > + struct counter_count *count, u64 floor) > { > struct ti_eqep_cnt *priv = counter->priv; > - int err; > - u32 res; > > - err = kstrtouint(buf, 0, &res); > - if (err < 0) > - return err; > + if (floor != (u32)floor) > + return -ERANGE; > > - regmap_write(priv->regmap32, QPOSINIT, res); > + regmap_write(priv->regmap32, QPOSINIT, floor); > > - return len; > + return 0; > } This will conflict with 2ba7b50893de "counter:ti-eqep: remove floor" (in Jonathan's fixes-togreg branch) which removes these functions. ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code @ 2020-12-30 23:24 ` David Lechner 0 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 23:24 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, Dan Carpenter, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > diff --git a/drivers/counter/ti-eqep.c b/drivers/counter/ti-eqep.c > index a60aee1a1a29..6c058b93dc98 100644 > --- a/drivers/counter/ti-eqep.c > +++ b/drivers/counter/ti-eqep.c > -static ssize_t ti_eqep_position_floor_write(struct counter_device *counter, > - struct counter_count *count, > - void *ext_priv, const char *buf, > - size_t len) > +static int ti_eqep_position_floor_write(struct counter_device *counter, > + struct counter_count *count, u64 floor) > { > struct ti_eqep_cnt *priv = counter->priv; > - int err; > - u32 res; > > - err = kstrtouint(buf, 0, &res); > - if (err < 0) > - return err; > + if (floor != (u32)floor) > + return -ERANGE; > > - regmap_write(priv->regmap32, QPOSINIT, res); > + regmap_write(priv->regmap32, QPOSINIT, floor); > > - return len; > + return 0; > } This will conflict with 2ba7b50893de "counter:ti-eqep: remove floor" (in Jonathan's fixes-togreg branch) which removes these functions. _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code 2020-12-30 23:24 ` David Lechner @ 2021-01-06 5:30 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-06 5:30 UTC (permalink / raw) To: David Lechner Cc: jic23, kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter [-- Attachment #1: Type: text/plain, Size: 1270 bytes --] On Wed, Dec 30, 2020 at 05:24:34PM -0600, David Lechner wrote: > On 12/25/20 6:15 PM, William Breathitt Gray wrote: > > > diff --git a/drivers/counter/ti-eqep.c b/drivers/counter/ti-eqep.c > > index a60aee1a1a29..6c058b93dc98 100644 > > --- a/drivers/counter/ti-eqep.c > > +++ b/drivers/counter/ti-eqep.c > > > > -static ssize_t ti_eqep_position_floor_write(struct counter_device *counter, > > - struct counter_count *count, > > - void *ext_priv, const char *buf, > > - size_t len) > > +static int ti_eqep_position_floor_write(struct counter_device *counter, > > + struct counter_count *count, u64 floor) > > { > > struct ti_eqep_cnt *priv = counter->priv; > > - int err; > > - u32 res; > > > > - err = kstrtouint(buf, 0, &res); > > - if (err < 0) > > - return err; > > + if (floor != (u32)floor) > > + return -ERANGE; > > > > - regmap_write(priv->regmap32, QPOSINIT, res); > > + regmap_write(priv->regmap32, QPOSINIT, floor); > > > > - return len; > > + return 0; > > } > > This will conflict with 2ba7b50893de "counter:ti-eqep: remove floor" > (in Jonathan's fixes-togreg branch) which removes these functions. Ack, I'll rebase and remove these changes. William Breathitt Gray [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code @ 2021-01-06 5:30 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-06 5:30 UTC (permalink / raw) To: David Lechner Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, linux-arm-kernel, kernel, Dan Carpenter, fabrice.gasnier, syednwaris, linux-stm32, jic23, alexandre.torgue [-- Attachment #1.1: Type: text/plain, Size: 1270 bytes --] On Wed, Dec 30, 2020 at 05:24:34PM -0600, David Lechner wrote: > On 12/25/20 6:15 PM, William Breathitt Gray wrote: > > > diff --git a/drivers/counter/ti-eqep.c b/drivers/counter/ti-eqep.c > > index a60aee1a1a29..6c058b93dc98 100644 > > --- a/drivers/counter/ti-eqep.c > > +++ b/drivers/counter/ti-eqep.c > > > > -static ssize_t ti_eqep_position_floor_write(struct counter_device *counter, > > - struct counter_count *count, > > - void *ext_priv, const char *buf, > > - size_t len) > > +static int ti_eqep_position_floor_write(struct counter_device *counter, > > + struct counter_count *count, u64 floor) > > { > > struct ti_eqep_cnt *priv = counter->priv; > > - int err; > > - u32 res; > > > > - err = kstrtouint(buf, 0, &res); > > - if (err < 0) > > - return err; > > + if (floor != (u32)floor) > > + return -ERANGE; > > > > - regmap_write(priv->regmap32, QPOSINIT, res); > > + regmap_write(priv->regmap32, QPOSINIT, floor); > > > > - return len; > > + return 0; > > } > > This will conflict with 2ba7b50893de "counter:ti-eqep: remove floor" > (in Jonathan's fixes-togreg branch) which removes these functions. Ack, I'll rebase and remove these changes. William Breathitt Gray [-- Attachment #1.2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] [-- Attachment #2: Type: text/plain, Size: 176 bytes --] _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH v7 2/5] docs: counter: Update to reflect sysfs internalization 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-26 0:15 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, William Breathitt Gray The Counter subsystem architecture and driver implementations have changed in order to handle Counter sysfs interactions in a more consistent way. This patch updates the Generic Counter interface documentation to reflect the changes. Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- Documentation/ABI/testing/sysfs-bus-counter | 9 +- Documentation/driver-api/generic-counter.rst | 242 ++++++++++++++----- 2 files changed, 184 insertions(+), 67 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter index 566bd99fe0a5..1820ce2f9183 100644 --- a/Documentation/ABI/testing/sysfs-bus-counter +++ b/Documentation/ABI/testing/sysfs-bus-counter @@ -219,7 +219,14 @@ What: /sys/bus/counter/devices/counterX/signalY/signal KernelVersion: 5.2 Contact: linux-iio@vger.kernel.org Description: - Signal data of Signal Y represented as a string. + Signal level state of Signal Y. The following signal level + states are available: + + low: + Low level state. + + high: + High level state. What: /sys/bus/counter/devices/counterX/signalY/name KernelVersion: 5.2 diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst index b02c52cd69d6..b842ddbbd8a0 100644 --- a/Documentation/driver-api/generic-counter.rst +++ b/Documentation/driver-api/generic-counter.rst @@ -250,8 +250,8 @@ for defining a counter device. .. kernel-doc:: drivers/counter/counter.c :export: -Implementation -============== +Driver Implementation +===================== To support a counter device, a driver must first allocate the available Counter Signals via counter_signal structures. These Signals should @@ -267,25 +267,59 @@ respective counter_count structure. These counter_count structures are set to the counts array member of an allocated counter_device structure before the Counter is registered to the system. -Driver callbacks should be provided to the counter_device structure via -a constant counter_ops structure in order to communicate with the -device: to read and write various Signals and Counts, and to set and get -the "action mode" and "function mode" for various Synapses and Counts -respectively. +Driver callbacks must be provided to the counter_device structure in +order to communicate with the device: to read and write various Signals +and Counts, and to set and get the "action mode" and "function mode" for +various Synapses and Counts respectively. A defined counter_device structure may be registered to the system by passing it to the counter_register function, and unregistered by passing it to the counter_unregister function. Similarly, the -devm_counter_register and devm_counter_unregister functions may be used -if device memory-managed registration is desired. - -Extension sysfs attributes can be created for auxiliary functionality -and data by passing in defined counter_device_ext, counter_count_ext, -and counter_signal_ext structures. In these cases, the -counter_device_ext structure is used for global/miscellaneous exposure -and configuration of the respective Counter device, while the -counter_count_ext and counter_signal_ext structures allow for auxiliary -exposure and configuration of a specific Count or Signal respectively. +devm_counter_register function may be used if device memory-managed +registration is desired. + +The struct counter_comp structure is used to define counter extensions +for Signals, Synapses, and Counts. + +The "type" member specifies the type of high-level data (e.g. BOOL, +COUNT_DIRECTION, etc.) handled by this extension. The "`*_read`" and +"`*_write`" members can then be set by the counter device driver with +callbacks to handle that data using native C data types (i.e. u8, u64, +etc.). + +Convenience macros such as `COUNTER_COMP_COUNT_U64` are provided for use +by driver authors. In particular, driver authors are expected to use +the provided macros for standard Counter subsystem attributes in order +to maintain a consistent interface for userspace. For example, a counter +device driver may define several standard attributes like so:: + + struct counter_comp count_ext[] = { + COUNTER_COMP_DIRECTION(count_direction_read), + COUNTER_COMP_ENABLE(count_enable_read, count_enable_write), + COUNTER_COMP_CEILING(count_ceiling_read, count_ceiling_write), + }; + +This makes it simple to see, add, and modify the attributes that are +supported by this driver ("direction", "enable", and "ceiling") and to +maintain this code without getting lost in a web of struct braces. + +Callbacks must match the function type expected for the respective +component or extension. These function types are defined in the struct +counter_comp structure as the "`*_read`" and "`*_write`" union members. + +The corresponding callback prototypes for the extensions mentioned in +the previous example above would be:: + + int count_direction_read(struct counter_device *counter, + struct counter_count *count, u8 *direction); + int count_enable_read(struct counter_device *counter, + struct counter_count *count, u8 *enable); + int count_enable_write(struct counter_device *counter, + struct counter_count *count, u8 enable); + int count_ceiling_read(struct counter_device *counter, + struct counter_count *count, u64 *ceiling); + int count_ceiling_write(struct counter_device *counter, + struct counter_count *count, u64 ceiling); Determining the type of extension to create is a matter of scope. @@ -313,52 +347,128 @@ Determining the type of extension to create is a matter of scope. chip overheated via a device extension called "error_overtemp": /sys/bus/counter/devices/counterX/error_overtemp -Architecture -============ - -When the Generic Counter interface counter module is loaded, the -counter_init function is called which registers a bus_type named -"counter" to the system. Subsequently, when the module is unloaded, the -counter_exit function is called which unregisters the bus_type named -"counter" from the system. - -Counter devices are registered to the system via the counter_register -function, and later removed via the counter_unregister function. The -counter_register function establishes a unique ID for the Counter -device and creates a respective sysfs directory, where X is the -mentioned unique ID: - - /sys/bus/counter/devices/counterX - -Sysfs attributes are created within the counterX directory to expose -functionality, configurations, and data relating to the Counts, Signals, -and Synapses of the Counter device, as well as options and information -for the Counter device itself. - -Each Signal has a directory created to house its relevant sysfs -attributes, where Y is the unique ID of the respective Signal: - - /sys/bus/counter/devices/counterX/signalY - -Similarly, each Count has a directory created to house its relevant -sysfs attributes, where Y is the unique ID of the respective Count: - - /sys/bus/counter/devices/counterX/countY - -For a more detailed breakdown of the available Generic Counter interface -sysfs attributes, please refer to the -Documentation/ABI/testing/sysfs-bus-counter file. - -The Signals and Counts associated with the Counter device are registered -to the system as well by the counter_register function. The -signal_read/signal_write driver callbacks are associated with their -respective Signal attributes, while the count_read/count_write and -function_get/function_set driver callbacks are associated with their -respective Count attributes; similarly, the same is true for the -action_get/action_set driver callbacks and their respective Synapse -attributes. If a driver callback is left undefined, then the respective -read/write permission is left disabled for the relevant attributes. - -Similarly, extension sysfs attributes are created for the defined -counter_device_ext, counter_count_ext, and counter_signal_ext -structures that are passed in. +Subsystem Architecture +====================== + +Counter drivers pass and take data natively (i.e. `u8`, `u64`, etc.) and +the shared counter module handles the translation between the sysfs +interface. This gurantees a standard userspace interface for all counter +drivers, and helps generalize the Generic Counter driver ABI in order to +support the Generic Counter chrdev interface without significant changes +to the existing counter drivers. + +A high-level view of how a count value is passed down from a counter +driver is exemplified by the following. The driver callbacks are first +registered to the Counter core component for use by the Counter +userspace interface components:: + + Driver callbacks registration: + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +----------------------------+ + | Counter device driver | + +----------------------------+ + | Processes data from device | + +----------------------------+ + | + ------------------- + / driver callbacks / + ------------------- + | + V + +----------------------+ + | Counter core | + +----------------------+ + | Routes device driver | + | callbacks to the | + | userspace interfaces | + +----------------------+ + | + ------------------- + / driver callbacks / + ------------------- + | + +---------------+ + | + V + +--------------------+ + | Counter sysfs | + +--------------------+ + | Translates to the | + | standard Counter | + | sysfs output | + +--------------------+ + +Thereafter, data can be transferred directly between the Counter device +driver and Counter userspace interface:: + + Count data request: + ~~~~~~~~~~~~~~~~~~~ + ---------------------- + / Counter device \ + +----------------------+ + | Count register: 0x28 | + +----------------------+ + | + ----------------- + / raw count data / + ----------------- + | + V + +----------------------------+ + | Counter device driver | + +----------------------------+ + | Processes data from device | + |----------------------------| + | Type: u64 | + | Value: 42 | + +----------------------------+ + | + ---------- + / u64 / + ---------- + | + +---------------+ + | + V + +--------------------+ + | Counter sysfs | + +--------------------+ + | Translates to the | + | standard Counter | + | sysfs output | + |--------------------| + | Type: const char * | + | Value: "42" | + +--------------------+ + | + --------------- + / const char * / + --------------- + | + V + +--------------------------------------------------+ + | `/sys/bus/counter/devices/counterX/countY/count` | + +--------------------------------------------------+ + \ Count: "42" / + -------------------------------------------------- + +There are three primary components involved: + +Counter device driver +--------------------- +Communicates with the hardware device to read/write data; e.g. counter +drivers for quadrature encoders, timers, etc. + +Counter core +------------ +Registers the counter device driver to the system so that the respective +callbacks are called during userspace interaction. + +Counter sysfs +------------- +Translates counter data to the standard Counter sysfs interface format +and vice versa. + +Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file +for a detailed breakdown of the available Generic Counter interface +sysfs attributes. -- 2.29.2 ^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH v7 2/5] docs: counter: Update to reflect sysfs internalization @ 2020-12-26 0:15 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, William Breathitt Gray, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue The Counter subsystem architecture and driver implementations have changed in order to handle Counter sysfs interactions in a more consistent way. This patch updates the Generic Counter interface documentation to reflect the changes. Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- Documentation/ABI/testing/sysfs-bus-counter | 9 +- Documentation/driver-api/generic-counter.rst | 242 ++++++++++++++----- 2 files changed, 184 insertions(+), 67 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter index 566bd99fe0a5..1820ce2f9183 100644 --- a/Documentation/ABI/testing/sysfs-bus-counter +++ b/Documentation/ABI/testing/sysfs-bus-counter @@ -219,7 +219,14 @@ What: /sys/bus/counter/devices/counterX/signalY/signal KernelVersion: 5.2 Contact: linux-iio@vger.kernel.org Description: - Signal data of Signal Y represented as a string. + Signal level state of Signal Y. The following signal level + states are available: + + low: + Low level state. + + high: + High level state. What: /sys/bus/counter/devices/counterX/signalY/name KernelVersion: 5.2 diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst index b02c52cd69d6..b842ddbbd8a0 100644 --- a/Documentation/driver-api/generic-counter.rst +++ b/Documentation/driver-api/generic-counter.rst @@ -250,8 +250,8 @@ for defining a counter device. .. kernel-doc:: drivers/counter/counter.c :export: -Implementation -============== +Driver Implementation +===================== To support a counter device, a driver must first allocate the available Counter Signals via counter_signal structures. These Signals should @@ -267,25 +267,59 @@ respective counter_count structure. These counter_count structures are set to the counts array member of an allocated counter_device structure before the Counter is registered to the system. -Driver callbacks should be provided to the counter_device structure via -a constant counter_ops structure in order to communicate with the -device: to read and write various Signals and Counts, and to set and get -the "action mode" and "function mode" for various Synapses and Counts -respectively. +Driver callbacks must be provided to the counter_device structure in +order to communicate with the device: to read and write various Signals +and Counts, and to set and get the "action mode" and "function mode" for +various Synapses and Counts respectively. A defined counter_device structure may be registered to the system by passing it to the counter_register function, and unregistered by passing it to the counter_unregister function. Similarly, the -devm_counter_register and devm_counter_unregister functions may be used -if device memory-managed registration is desired. - -Extension sysfs attributes can be created for auxiliary functionality -and data by passing in defined counter_device_ext, counter_count_ext, -and counter_signal_ext structures. In these cases, the -counter_device_ext structure is used for global/miscellaneous exposure -and configuration of the respective Counter device, while the -counter_count_ext and counter_signal_ext structures allow for auxiliary -exposure and configuration of a specific Count or Signal respectively. +devm_counter_register function may be used if device memory-managed +registration is desired. + +The struct counter_comp structure is used to define counter extensions +for Signals, Synapses, and Counts. + +The "type" member specifies the type of high-level data (e.g. BOOL, +COUNT_DIRECTION, etc.) handled by this extension. The "`*_read`" and +"`*_write`" members can then be set by the counter device driver with +callbacks to handle that data using native C data types (i.e. u8, u64, +etc.). + +Convenience macros such as `COUNTER_COMP_COUNT_U64` are provided for use +by driver authors. In particular, driver authors are expected to use +the provided macros for standard Counter subsystem attributes in order +to maintain a consistent interface for userspace. For example, a counter +device driver may define several standard attributes like so:: + + struct counter_comp count_ext[] = { + COUNTER_COMP_DIRECTION(count_direction_read), + COUNTER_COMP_ENABLE(count_enable_read, count_enable_write), + COUNTER_COMP_CEILING(count_ceiling_read, count_ceiling_write), + }; + +This makes it simple to see, add, and modify the attributes that are +supported by this driver ("direction", "enable", and "ceiling") and to +maintain this code without getting lost in a web of struct braces. + +Callbacks must match the function type expected for the respective +component or extension. These function types are defined in the struct +counter_comp structure as the "`*_read`" and "`*_write`" union members. + +The corresponding callback prototypes for the extensions mentioned in +the previous example above would be:: + + int count_direction_read(struct counter_device *counter, + struct counter_count *count, u8 *direction); + int count_enable_read(struct counter_device *counter, + struct counter_count *count, u8 *enable); + int count_enable_write(struct counter_device *counter, + struct counter_count *count, u8 enable); + int count_ceiling_read(struct counter_device *counter, + struct counter_count *count, u64 *ceiling); + int count_ceiling_write(struct counter_device *counter, + struct counter_count *count, u64 ceiling); Determining the type of extension to create is a matter of scope. @@ -313,52 +347,128 @@ Determining the type of extension to create is a matter of scope. chip overheated via a device extension called "error_overtemp": /sys/bus/counter/devices/counterX/error_overtemp -Architecture -============ - -When the Generic Counter interface counter module is loaded, the -counter_init function is called which registers a bus_type named -"counter" to the system. Subsequently, when the module is unloaded, the -counter_exit function is called which unregisters the bus_type named -"counter" from the system. - -Counter devices are registered to the system via the counter_register -function, and later removed via the counter_unregister function. The -counter_register function establishes a unique ID for the Counter -device and creates a respective sysfs directory, where X is the -mentioned unique ID: - - /sys/bus/counter/devices/counterX - -Sysfs attributes are created within the counterX directory to expose -functionality, configurations, and data relating to the Counts, Signals, -and Synapses of the Counter device, as well as options and information -for the Counter device itself. - -Each Signal has a directory created to house its relevant sysfs -attributes, where Y is the unique ID of the respective Signal: - - /sys/bus/counter/devices/counterX/signalY - -Similarly, each Count has a directory created to house its relevant -sysfs attributes, where Y is the unique ID of the respective Count: - - /sys/bus/counter/devices/counterX/countY - -For a more detailed breakdown of the available Generic Counter interface -sysfs attributes, please refer to the -Documentation/ABI/testing/sysfs-bus-counter file. - -The Signals and Counts associated with the Counter device are registered -to the system as well by the counter_register function. The -signal_read/signal_write driver callbacks are associated with their -respective Signal attributes, while the count_read/count_write and -function_get/function_set driver callbacks are associated with their -respective Count attributes; similarly, the same is true for the -action_get/action_set driver callbacks and their respective Synapse -attributes. If a driver callback is left undefined, then the respective -read/write permission is left disabled for the relevant attributes. - -Similarly, extension sysfs attributes are created for the defined -counter_device_ext, counter_count_ext, and counter_signal_ext -structures that are passed in. +Subsystem Architecture +====================== + +Counter drivers pass and take data natively (i.e. `u8`, `u64`, etc.) and +the shared counter module handles the translation between the sysfs +interface. This gurantees a standard userspace interface for all counter +drivers, and helps generalize the Generic Counter driver ABI in order to +support the Generic Counter chrdev interface without significant changes +to the existing counter drivers. + +A high-level view of how a count value is passed down from a counter +driver is exemplified by the following. The driver callbacks are first +registered to the Counter core component for use by the Counter +userspace interface components:: + + Driver callbacks registration: + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +----------------------------+ + | Counter device driver | + +----------------------------+ + | Processes data from device | + +----------------------------+ + | + ------------------- + / driver callbacks / + ------------------- + | + V + +----------------------+ + | Counter core | + +----------------------+ + | Routes device driver | + | callbacks to the | + | userspace interfaces | + +----------------------+ + | + ------------------- + / driver callbacks / + ------------------- + | + +---------------+ + | + V + +--------------------+ + | Counter sysfs | + +--------------------+ + | Translates to the | + | standard Counter | + | sysfs output | + +--------------------+ + +Thereafter, data can be transferred directly between the Counter device +driver and Counter userspace interface:: + + Count data request: + ~~~~~~~~~~~~~~~~~~~ + ---------------------- + / Counter device \ + +----------------------+ + | Count register: 0x28 | + +----------------------+ + | + ----------------- + / raw count data / + ----------------- + | + V + +----------------------------+ + | Counter device driver | + +----------------------------+ + | Processes data from device | + |----------------------------| + | Type: u64 | + | Value: 42 | + +----------------------------+ + | + ---------- + / u64 / + ---------- + | + +---------------+ + | + V + +--------------------+ + | Counter sysfs | + +--------------------+ + | Translates to the | + | standard Counter | + | sysfs output | + |--------------------| + | Type: const char * | + | Value: "42" | + +--------------------+ + | + --------------- + / const char * / + --------------- + | + V + +--------------------------------------------------+ + | `/sys/bus/counter/devices/counterX/countY/count` | + +--------------------------------------------------+ + \ Count: "42" / + -------------------------------------------------- + +There are three primary components involved: + +Counter device driver +--------------------- +Communicates with the hardware device to read/write data; e.g. counter +drivers for quadrature encoders, timers, etc. + +Counter core +------------ +Registers the counter device driver to the system so that the respective +callbacks are called during userspace interaction. + +Counter sysfs +------------- +Translates counter data to the standard Counter sysfs interface format +and vice versa. + +Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file +for a detailed breakdown of the available Generic Counter interface +sysfs attributes. -- 2.29.2 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply related [flat|nested] 51+ messages in thread
* Re: [PATCH v7 2/5] docs: counter: Update to reflect sysfs internalization 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 14:41 ` Jonathan Cameron -1 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 14:41 UTC (permalink / raw) To: William Breathitt Gray Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue On Fri, 25 Dec 2020 19:15:35 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > The Counter subsystem architecture and driver implementations have > changed in order to handle Counter sysfs interactions in a more > consistent way. This patch updates the Generic Counter interface > documentation to reflect the changes. > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > --- > Documentation/ABI/testing/sysfs-bus-counter | 9 +- > Documentation/driver-api/generic-counter.rst | 242 ++++++++++++++----- > 2 files changed, 184 insertions(+), 67 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter > index 566bd99fe0a5..1820ce2f9183 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter > +++ b/Documentation/ABI/testing/sysfs-bus-counter > @@ -219,7 +219,14 @@ What: /sys/bus/counter/devices/counterX/signalY/signal > KernelVersion: 5.2 > Contact: linux-iio@vger.kernel.org > Description: > - Signal data of Signal Y represented as a string. > + Signal level state of Signal Y. The following signal level > + states are available: > + > + low: > + Low level state. > + > + high: > + High level state. > > What: /sys/bus/counter/devices/counterX/signalY/name > KernelVersion: 5.2 > diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst > index b02c52cd69d6..b842ddbbd8a0 100644 > --- a/Documentation/driver-api/generic-counter.rst > +++ b/Documentation/driver-api/generic-counter.rst > @@ -250,8 +250,8 @@ for defining a counter device. > .. kernel-doc:: drivers/counter/counter.c > :export: > > -Implementation > -============== > +Driver Implementation > +===================== > > To support a counter device, a driver must first allocate the available > Counter Signals via counter_signal structures. These Signals should > @@ -267,25 +267,59 @@ respective counter_count structure. These counter_count structures are > set to the counts array member of an allocated counter_device structure > before the Counter is registered to the system. > > -Driver callbacks should be provided to the counter_device structure via > -a constant counter_ops structure in order to communicate with the > -device: to read and write various Signals and Counts, and to set and get > -the "action mode" and "function mode" for various Synapses and Counts > -respectively. > +Driver callbacks must be provided to the counter_device structure in > +order to communicate with the device: to read and write various Signals > +and Counts, and to set and get the "action mode" and "function mode" for > +various Synapses and Counts respectively. > > A defined counter_device structure may be registered to the system by > passing it to the counter_register function, and unregistered by passing > it to the counter_unregister function. Similarly, the > -devm_counter_register and devm_counter_unregister functions may be used > -if device memory-managed registration is desired. > - > -Extension sysfs attributes can be created for auxiliary functionality > -and data by passing in defined counter_device_ext, counter_count_ext, > -and counter_signal_ext structures. In these cases, the > -counter_device_ext structure is used for global/miscellaneous exposure > -and configuration of the respective Counter device, while the > -counter_count_ext and counter_signal_ext structures allow for auxiliary > -exposure and configuration of a specific Count or Signal respectively. > +devm_counter_register function may be used if device memory-managed > +registration is desired. > + > +The struct counter_comp structure is used to define counter extensions > +for Signals, Synapses, and Counts. > + > +The "type" member specifies the type of high-level data (e.g. BOOL, > +COUNT_DIRECTION, etc.) handled by this extension. The "`*_read`" and > +"`*_write`" members can then be set by the counter device driver with > +callbacks to handle that data using native C data types (i.e. u8, u64, > +etc.). > + > +Convenience macros such as `COUNTER_COMP_COUNT_U64` are provided for use > +by driver authors. In particular, driver authors are expected to use > +the provided macros for standard Counter subsystem attributes in order > +to maintain a consistent interface for userspace. For example, a counter > +device driver may define several standard attributes like so:: > + > + struct counter_comp count_ext[] = { > + COUNTER_COMP_DIRECTION(count_direction_read), > + COUNTER_COMP_ENABLE(count_enable_read, count_enable_write), > + COUNTER_COMP_CEILING(count_ceiling_read, count_ceiling_write), > + }; > + > +This makes it simple to see, add, and modify the attributes that are > +supported by this driver ("direction", "enable", and "ceiling") and to > +maintain this code without getting lost in a web of struct braces. > + > +Callbacks must match the function type expected for the respective > +component or extension. These function types are defined in the struct > +counter_comp structure as the "`*_read`" and "`*_write`" union members. > + > +The corresponding callback prototypes for the extensions mentioned in > +the previous example above would be:: > + > + int count_direction_read(struct counter_device *counter, > + struct counter_count *count, u8 *direction); > + int count_enable_read(struct counter_device *counter, > + struct counter_count *count, u8 *enable); > + int count_enable_write(struct counter_device *counter, > + struct counter_count *count, u8 enable); > + int count_ceiling_read(struct counter_device *counter, > + struct counter_count *count, u64 *ceiling); > + int count_ceiling_write(struct counter_device *counter, > + struct counter_count *count, u64 ceiling); > > Determining the type of extension to create is a matter of scope. > > @@ -313,52 +347,128 @@ Determining the type of extension to create is a matter of scope. > chip overheated via a device extension called "error_overtemp": > /sys/bus/counter/devices/counterX/error_overtemp > > -Architecture > -============ > - > -When the Generic Counter interface counter module is loaded, the > -counter_init function is called which registers a bus_type named > -"counter" to the system. Subsequently, when the module is unloaded, the > -counter_exit function is called which unregisters the bus_type named > -"counter" from the system. > - > -Counter devices are registered to the system via the counter_register > -function, and later removed via the counter_unregister function. The > -counter_register function establishes a unique ID for the Counter > -device and creates a respective sysfs directory, where X is the > -mentioned unique ID: > - > - /sys/bus/counter/devices/counterX > - > -Sysfs attributes are created within the counterX directory to expose > -functionality, configurations, and data relating to the Counts, Signals, > -and Synapses of the Counter device, as well as options and information > -for the Counter device itself. > - > -Each Signal has a directory created to house its relevant sysfs > -attributes, where Y is the unique ID of the respective Signal: > - > - /sys/bus/counter/devices/counterX/signalY > - > -Similarly, each Count has a directory created to house its relevant > -sysfs attributes, where Y is the unique ID of the respective Count: > - > - /sys/bus/counter/devices/counterX/countY > - > -For a more detailed breakdown of the available Generic Counter interface > -sysfs attributes, please refer to the > -Documentation/ABI/testing/sysfs-bus-counter file. > - > -The Signals and Counts associated with the Counter device are registered > -to the system as well by the counter_register function. The > -signal_read/signal_write driver callbacks are associated with their > -respective Signal attributes, while the count_read/count_write and > -function_get/function_set driver callbacks are associated with their > -respective Count attributes; similarly, the same is true for the > -action_get/action_set driver callbacks and their respective Synapse > -attributes. If a driver callback is left undefined, then the respective > -read/write permission is left disabled for the relevant attributes. > - > -Similarly, extension sysfs attributes are created for the defined > -counter_device_ext, counter_count_ext, and counter_signal_ext > -structures that are passed in. > +Subsystem Architecture > +====================== > + > +Counter drivers pass and take data natively (i.e. `u8`, `u64`, etc.) and > +the shared counter module handles the translation between the sysfs > +interface. Same point as raised in previous patch description. > This gurantees a standard userspace interface for all counter Spell check this file. guarantees > +drivers, and helps generalize the Generic Counter driver ABI in order to > +support the Generic Counter chrdev interface without significant changes > +to the existing counter drivers. I would modify this to assume you've already done the chrdev interface. "and enables a Generic Counter chrdev interface without..." > + > +A high-level view of how a count value is passed down from a counter > +driver is exemplified by the following. The driver callbacks are first > +registered to the Counter core component for use by the Counter > +userspace interface components:: > + > + Driver callbacks registration: > + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > + +----------------------------+ > + | Counter device driver | That tab again ;) > + +----------------------------+ > + | Processes data from device | > + +----------------------------+ > + | > + ------------------- > + / driver callbacks / > + ------------------- > + | > + V > + +----------------------+ > + | Counter core | > + +----------------------+ > + | Routes device driver | > + | callbacks to the | > + | userspace interfaces | > + +----------------------+ > + | > + ------------------- > + / driver callbacks / > + ------------------- > + | > + +---------------+ > + | > + V > + +--------------------+ > + | Counter sysfs | > + +--------------------+ > + | Translates to the | > + | standard Counter | > + | sysfs output | > + +--------------------+ > + > +Thereafter, data can be transferred directly between the Counter device > +driver and Counter userspace interface:: > + > + Count data request: > + ~~~~~~~~~~~~~~~~~~~ > + ---------------------- > + / Counter device \ > + +----------------------+ > + | Count register: 0x28 | > + +----------------------+ > + | > + ----------------- > + / raw count data / > + ----------------- > + | > + V > + +----------------------------+ > + | Counter device driver | > + +----------------------------+ > + | Processes data from device | > + |----------------------------| > + | Type: u64 | > + | Value: 42 | > + +----------------------------+ > + | > + ---------- > + / u64 / > + ---------- > + | > + +---------------+ > + | > + V > + +--------------------+ > + | Counter sysfs | > + +--------------------+ > + | Translates to the | > + | standard Counter | > + | sysfs output | > + |--------------------| > + | Type: const char * | > + | Value: "42" | > + +--------------------+ > + | > + --------------- > + / const char * / > + --------------- > + | > + V > + +--------------------------------------------------+ > + | `/sys/bus/counter/devices/counterX/countY/count` | > + +--------------------------------------------------+ > + \ Count: "42" / > + -------------------------------------------------- > + > +There are three primary components involved: > + > +Counter device driver > +--------------------- > +Communicates with the hardware device to read/write data; e.g. counter > +drivers for quadrature encoders, timers, etc. > + > +Counter core > +------------ > +Registers the counter device driver to the system so that the respective > +callbacks are called during userspace interaction. > + > +Counter sysfs > +------------- > +Translates counter data to the standard Counter sysfs interface format > +and vice versa. > + > +Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file > +for a detailed breakdown of the available Generic Counter interface > +sysfs attributes. Otherwise LGTM. Thanks, Jonathan ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 2/5] docs: counter: Update to reflect sysfs internalization @ 2020-12-30 14:41 ` Jonathan Cameron 0 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 14:41 UTC (permalink / raw) To: William Breathitt Gray Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On Fri, 25 Dec 2020 19:15:35 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > The Counter subsystem architecture and driver implementations have > changed in order to handle Counter sysfs interactions in a more > consistent way. This patch updates the Generic Counter interface > documentation to reflect the changes. > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > --- > Documentation/ABI/testing/sysfs-bus-counter | 9 +- > Documentation/driver-api/generic-counter.rst | 242 ++++++++++++++----- > 2 files changed, 184 insertions(+), 67 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter > index 566bd99fe0a5..1820ce2f9183 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter > +++ b/Documentation/ABI/testing/sysfs-bus-counter > @@ -219,7 +219,14 @@ What: /sys/bus/counter/devices/counterX/signalY/signal > KernelVersion: 5.2 > Contact: linux-iio@vger.kernel.org > Description: > - Signal data of Signal Y represented as a string. > + Signal level state of Signal Y. The following signal level > + states are available: > + > + low: > + Low level state. > + > + high: > + High level state. > > What: /sys/bus/counter/devices/counterX/signalY/name > KernelVersion: 5.2 > diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst > index b02c52cd69d6..b842ddbbd8a0 100644 > --- a/Documentation/driver-api/generic-counter.rst > +++ b/Documentation/driver-api/generic-counter.rst > @@ -250,8 +250,8 @@ for defining a counter device. > .. kernel-doc:: drivers/counter/counter.c > :export: > > -Implementation > -============== > +Driver Implementation > +===================== > > To support a counter device, a driver must first allocate the available > Counter Signals via counter_signal structures. These Signals should > @@ -267,25 +267,59 @@ respective counter_count structure. These counter_count structures are > set to the counts array member of an allocated counter_device structure > before the Counter is registered to the system. > > -Driver callbacks should be provided to the counter_device structure via > -a constant counter_ops structure in order to communicate with the > -device: to read and write various Signals and Counts, and to set and get > -the "action mode" and "function mode" for various Synapses and Counts > -respectively. > +Driver callbacks must be provided to the counter_device structure in > +order to communicate with the device: to read and write various Signals > +and Counts, and to set and get the "action mode" and "function mode" for > +various Synapses and Counts respectively. > > A defined counter_device structure may be registered to the system by > passing it to the counter_register function, and unregistered by passing > it to the counter_unregister function. Similarly, the > -devm_counter_register and devm_counter_unregister functions may be used > -if device memory-managed registration is desired. > - > -Extension sysfs attributes can be created for auxiliary functionality > -and data by passing in defined counter_device_ext, counter_count_ext, > -and counter_signal_ext structures. In these cases, the > -counter_device_ext structure is used for global/miscellaneous exposure > -and configuration of the respective Counter device, while the > -counter_count_ext and counter_signal_ext structures allow for auxiliary > -exposure and configuration of a specific Count or Signal respectively. > +devm_counter_register function may be used if device memory-managed > +registration is desired. > + > +The struct counter_comp structure is used to define counter extensions > +for Signals, Synapses, and Counts. > + > +The "type" member specifies the type of high-level data (e.g. BOOL, > +COUNT_DIRECTION, etc.) handled by this extension. The "`*_read`" and > +"`*_write`" members can then be set by the counter device driver with > +callbacks to handle that data using native C data types (i.e. u8, u64, > +etc.). > + > +Convenience macros such as `COUNTER_COMP_COUNT_U64` are provided for use > +by driver authors. In particular, driver authors are expected to use > +the provided macros for standard Counter subsystem attributes in order > +to maintain a consistent interface for userspace. For example, a counter > +device driver may define several standard attributes like so:: > + > + struct counter_comp count_ext[] = { > + COUNTER_COMP_DIRECTION(count_direction_read), > + COUNTER_COMP_ENABLE(count_enable_read, count_enable_write), > + COUNTER_COMP_CEILING(count_ceiling_read, count_ceiling_write), > + }; > + > +This makes it simple to see, add, and modify the attributes that are > +supported by this driver ("direction", "enable", and "ceiling") and to > +maintain this code without getting lost in a web of struct braces. > + > +Callbacks must match the function type expected for the respective > +component or extension. These function types are defined in the struct > +counter_comp structure as the "`*_read`" and "`*_write`" union members. > + > +The corresponding callback prototypes for the extensions mentioned in > +the previous example above would be:: > + > + int count_direction_read(struct counter_device *counter, > + struct counter_count *count, u8 *direction); > + int count_enable_read(struct counter_device *counter, > + struct counter_count *count, u8 *enable); > + int count_enable_write(struct counter_device *counter, > + struct counter_count *count, u8 enable); > + int count_ceiling_read(struct counter_device *counter, > + struct counter_count *count, u64 *ceiling); > + int count_ceiling_write(struct counter_device *counter, > + struct counter_count *count, u64 ceiling); > > Determining the type of extension to create is a matter of scope. > > @@ -313,52 +347,128 @@ Determining the type of extension to create is a matter of scope. > chip overheated via a device extension called "error_overtemp": > /sys/bus/counter/devices/counterX/error_overtemp > > -Architecture > -============ > - > -When the Generic Counter interface counter module is loaded, the > -counter_init function is called which registers a bus_type named > -"counter" to the system. Subsequently, when the module is unloaded, the > -counter_exit function is called which unregisters the bus_type named > -"counter" from the system. > - > -Counter devices are registered to the system via the counter_register > -function, and later removed via the counter_unregister function. The > -counter_register function establishes a unique ID for the Counter > -device and creates a respective sysfs directory, where X is the > -mentioned unique ID: > - > - /sys/bus/counter/devices/counterX > - > -Sysfs attributes are created within the counterX directory to expose > -functionality, configurations, and data relating to the Counts, Signals, > -and Synapses of the Counter device, as well as options and information > -for the Counter device itself. > - > -Each Signal has a directory created to house its relevant sysfs > -attributes, where Y is the unique ID of the respective Signal: > - > - /sys/bus/counter/devices/counterX/signalY > - > -Similarly, each Count has a directory created to house its relevant > -sysfs attributes, where Y is the unique ID of the respective Count: > - > - /sys/bus/counter/devices/counterX/countY > - > -For a more detailed breakdown of the available Generic Counter interface > -sysfs attributes, please refer to the > -Documentation/ABI/testing/sysfs-bus-counter file. > - > -The Signals and Counts associated with the Counter device are registered > -to the system as well by the counter_register function. The > -signal_read/signal_write driver callbacks are associated with their > -respective Signal attributes, while the count_read/count_write and > -function_get/function_set driver callbacks are associated with their > -respective Count attributes; similarly, the same is true for the > -action_get/action_set driver callbacks and their respective Synapse > -attributes. If a driver callback is left undefined, then the respective > -read/write permission is left disabled for the relevant attributes. > - > -Similarly, extension sysfs attributes are created for the defined > -counter_device_ext, counter_count_ext, and counter_signal_ext > -structures that are passed in. > +Subsystem Architecture > +====================== > + > +Counter drivers pass and take data natively (i.e. `u8`, `u64`, etc.) and > +the shared counter module handles the translation between the sysfs > +interface. Same point as raised in previous patch description. > This gurantees a standard userspace interface for all counter Spell check this file. guarantees > +drivers, and helps generalize the Generic Counter driver ABI in order to > +support the Generic Counter chrdev interface without significant changes > +to the existing counter drivers. I would modify this to assume you've already done the chrdev interface. "and enables a Generic Counter chrdev interface without..." > + > +A high-level view of how a count value is passed down from a counter > +driver is exemplified by the following. The driver callbacks are first > +registered to the Counter core component for use by the Counter > +userspace interface components:: > + > + Driver callbacks registration: > + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > + +----------------------------+ > + | Counter device driver | That tab again ;) > + +----------------------------+ > + | Processes data from device | > + +----------------------------+ > + | > + ------------------- > + / driver callbacks / > + ------------------- > + | > + V > + +----------------------+ > + | Counter core | > + +----------------------+ > + | Routes device driver | > + | callbacks to the | > + | userspace interfaces | > + +----------------------+ > + | > + ------------------- > + / driver callbacks / > + ------------------- > + | > + +---------------+ > + | > + V > + +--------------------+ > + | Counter sysfs | > + +--------------------+ > + | Translates to the | > + | standard Counter | > + | sysfs output | > + +--------------------+ > + > +Thereafter, data can be transferred directly between the Counter device > +driver and Counter userspace interface:: > + > + Count data request: > + ~~~~~~~~~~~~~~~~~~~ > + ---------------------- > + / Counter device \ > + +----------------------+ > + | Count register: 0x28 | > + +----------------------+ > + | > + ----------------- > + / raw count data / > + ----------------- > + | > + V > + +----------------------------+ > + | Counter device driver | > + +----------------------------+ > + | Processes data from device | > + |----------------------------| > + | Type: u64 | > + | Value: 42 | > + +----------------------------+ > + | > + ---------- > + / u64 / > + ---------- > + | > + +---------------+ > + | > + V > + +--------------------+ > + | Counter sysfs | > + +--------------------+ > + | Translates to the | > + | standard Counter | > + | sysfs output | > + |--------------------| > + | Type: const char * | > + | Value: "42" | > + +--------------------+ > + | > + --------------- > + / const char * / > + --------------- > + | > + V > + +--------------------------------------------------+ > + | `/sys/bus/counter/devices/counterX/countY/count` | > + +--------------------------------------------------+ > + \ Count: "42" / > + -------------------------------------------------- > + > +There are three primary components involved: > + > +Counter device driver > +--------------------- > +Communicates with the hardware device to read/write data; e.g. counter > +drivers for quadrature encoders, timers, etc. > + > +Counter core > +------------ > +Registers the counter device driver to the system so that the respective > +callbacks are called during userspace interaction. > + > +Counter sysfs > +------------- > +Translates counter data to the standard Counter sysfs interface format > +and vice versa. > + > +Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file > +for a detailed breakdown of the available Generic Counter interface > +sysfs attributes. Otherwise LGTM. Thanks, Jonathan _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH v7 3/5] counter: Add character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-26 0:15 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, William Breathitt Gray, Dan Carpenter This patch introduces a character device interface for the Counter subsystem. Device data is exposed through standard character device read operations. Device data is gathered when a Counter event is pushed by the respective Counter device driver. Configuration is handled via ioctl operations on the respective Counter character device node. Cc: David Lechner <david@lechnology.com> Cc: Gwendal Grignou <gwendal@chromium.org> Cc: Dan Carpenter <dan.carpenter@oracle.com> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- MAINTAINERS | 1 + drivers/counter/Makefile | 2 +- drivers/counter/counter-chrdev.c | 490 +++++++++++++++++++++++++++++++ drivers/counter/counter-chrdev.h | 16 + drivers/counter/counter-core.c | 37 ++- drivers/counter/counter-sysfs.c | 51 +++- include/linux/counter.h | 87 +++--- include/uapi/linux/counter.h | 123 ++++++++ 8 files changed, 751 insertions(+), 56 deletions(-) create mode 100644 drivers/counter/counter-chrdev.c create mode 100644 drivers/counter/counter-chrdev.h create mode 100644 include/uapi/linux/counter.h diff --git a/MAINTAINERS b/MAINTAINERS index b64fa49d5796..3a240f70bdd4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4494,6 +4494,7 @@ F: Documentation/ABI/testing/sysfs-bus-counter* F: Documentation/driver-api/generic-counter.rst F: drivers/counter/ F: include/linux/counter.h +F: include/uapi/linux/counter.h CPMAC ETHERNET DRIVER M: Florian Fainelli <f.fainelli@gmail.com> diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile index cbe1d06af6a9..c4870eb5b1dd 100644 --- a/drivers/counter/Makefile +++ b/drivers/counter/Makefile @@ -4,7 +4,7 @@ # obj-$(CONFIG_COUNTER) += counter.o -counter-y := counter-core.o counter-sysfs.o +counter-y := counter-core.o counter-sysfs.o counter-chrdev.o obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o diff --git a/drivers/counter/counter-chrdev.c b/drivers/counter/counter-chrdev.c new file mode 100644 index 000000000000..61b11989546a --- /dev/null +++ b/drivers/counter/counter-chrdev.c @@ -0,0 +1,490 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Generic Counter character device interface + * Copyright (C) 2020 William Breathitt Gray + */ + +#include <linux/cdev.h> +#include <linux/counter.h> +#include <linux/device.h> +#include <linux/err.h> +#include <linux/errno.h> +#include <linux/export.h> +#include <linux/fs.h> +#include <linux/kdev_t.h> +#include <linux/kfifo.h> +#include <linux/list.h> +#include <linux/mutex.h> +#include <linux/nospec.h> +#include <linux/poll.h> +#include <linux/slab.h> +#include <linux/spinlock.h> +#include <linux/timekeeping.h> +#include <linux/types.h> +#include <linux/wait.h> +#include <linux/uaccess.h> + +#include "counter-chrdev.h" + +struct counter_comp_node { + struct list_head l; + struct counter_component component; + struct counter_comp comp; + void *parent; +}; + +static ssize_t counter_chrdev_read(struct file *filp, char __user *buf, + size_t len, loff_t *f_ps) +{ + struct counter_device *const counter = filp->private_data; + int err; + unsigned int copied; + + if (len < sizeof(struct counter_event)) + return -EINVAL; + + do { + if (kfifo_is_empty(&counter->events)) { + if (filp->f_flags & O_NONBLOCK) + return -EAGAIN; + + err = wait_event_interruptible(counter->events_wait, + !kfifo_is_empty(&counter->events)); + if (err < 0) + return err; + } + + if (mutex_lock_interruptible(&counter->events_lock)) + return -ERESTARTSYS; + err = kfifo_to_user(&counter->events, buf, len, &copied); + mutex_unlock(&counter->events_lock); + if (err < 0) + return err; + } while (!copied); + + return copied; +} + +static __poll_t counter_chrdev_poll(struct file *filp, + struct poll_table_struct *pollt) +{ + struct counter_device *const counter = filp->private_data; + __poll_t events = 0; + + poll_wait(filp, &counter->events_wait, pollt); + + if (!kfifo_is_empty(&counter->events)) + events = EPOLLIN | EPOLLRDNORM; + + return events; +} + +static void counter_events_list_free(struct list_head *const events_list) +{ + struct counter_event_node *p, *n; + struct counter_comp_node *q, *o; + + list_for_each_entry_safe(p, n, events_list, l) { + /* Free associated component nodes */ + list_for_each_entry_safe(q, o, &p->comp_list, l) { + list_del(&q->l); + kfree(q); + } + + /* Free event node */ + list_del(&p->l); + kfree(p); + } +} + +static int counter_set_event_node(struct counter_device *const counter, + struct counter_watch *const watch, + const struct counter_comp_node *const cfg) +{ + struct counter_event_node *event_node; + struct counter_comp_node *comp_node; + + /* Search for event in the list */ + list_for_each_entry(event_node, &counter->next_events_list, l) + if (event_node->event == watch->event && + event_node->channel == watch->channel) + break; + + /* If event is not already in the list */ + if (&event_node->l == &counter->next_events_list) { + /* Allocate new event node */ + event_node = kmalloc(sizeof(*event_node), GFP_ATOMIC); + if (!event_node) + return -ENOMEM; + + /* Configure event node and add to the list */ + event_node->event = watch->event; + event_node->channel = watch->channel; + INIT_LIST_HEAD(&event_node->comp_list); + list_add(&event_node->l, &counter->next_events_list); + } + + /* Check if component watch has already been set before */ + list_for_each_entry(comp_node, &event_node->comp_list, l) + if (comp_node->parent == cfg->parent && + comp_node->comp.count_u8_read == cfg->comp.count_u8_read) + return -EINVAL; + + /* Allocate component node */ + comp_node = kmalloc(sizeof(*comp_node), GFP_ATOMIC); + if (!comp_node) { + /* Free event node if no one else is watching */ + if (list_empty(&event_node->comp_list)) { + list_del(&event_node->l); + kfree(event_node); + } + return -ENOMEM; + } + *comp_node = *cfg; + + /* Add component node to event node */ + list_add_tail(&comp_node->l, &event_node->comp_list); + + return 0; +} + +static int counter_clear_watches(struct counter_device *const counter) +{ + unsigned long flags; + int err = 0; + + raw_spin_lock_irqsave(&counter->events_list_lock, flags); + + counter_events_list_free(&counter->events_list); + + if (counter->ops->events_configure) + err = counter->ops->events_configure(counter); + + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); + + counter_events_list_free(&counter->next_events_list); + + return err; +} + +static int counter_add_watch(struct counter_device *const counter, + const unsigned long arg) +{ + void __user *const uwatch = (void __user *)arg; + struct counter_watch watch; + struct counter_comp_node comp_node = {0}; + size_t parent, id; + struct counter_comp *ext; + size_t num_ext; + int err; + + if (copy_from_user(&watch, uwatch, sizeof(watch))) + return -EFAULT; + + if (watch.component.type == COUNTER_COMPONENT_NONE) + goto no_component; + + parent = watch.component.parent; + + /* Configure parent component info for comp node */ + switch (watch.component.scope) { + case COUNTER_SCOPE_DEVICE: + ext = counter->ext; + num_ext = counter->num_ext; + break; + case COUNTER_SCOPE_SIGNAL: + if (parent >= counter->num_signals) + return -EINVAL; + parent = array_index_nospec(parent, counter->num_signals); + + comp_node.parent = counter->signals + parent; + + ext = counter->signals[parent].ext; + num_ext = counter->signals[parent].num_ext; + break; + case COUNTER_SCOPE_COUNT: + if (parent >= counter->num_counts) + return -EINVAL; + parent = array_index_nospec(parent, counter->num_counts); + + comp_node.parent = counter->counts + parent; + + ext = counter->counts[parent].ext; + num_ext = counter->counts[parent].num_ext; + break; + } + + id = watch.component.id; + + /* Configure component info for comp node */ + switch (watch.component.type) { + case COUNTER_COMPONENT_SIGNAL: + if (watch.component.scope != COUNTER_SCOPE_SIGNAL) + return -EINVAL; + + comp_node.comp.type = COUNTER_COMP_SIGNAL_LEVEL; + comp_node.comp.signal_u32_read = counter->ops->signal_read; + break; + case COUNTER_COMPONENT_COUNT: + if (watch.component.scope != COUNTER_SCOPE_COUNT) + return -EINVAL; + + comp_node.comp.type = COUNTER_COMP_U64; + comp_node.comp.count_u64_read = counter->ops->count_read; + break; + case COUNTER_COMPONENT_FUNCTION: + if (watch.component.scope != COUNTER_SCOPE_COUNT) + return -EINVAL; + + comp_node.comp.type = COUNTER_COMP_FUNCTION; + comp_node.comp.count_u32_read = counter->ops->function_read; + break; + case COUNTER_COMPONENT_SYNAPSE_ACTION: + if (watch.component.scope != COUNTER_SCOPE_COUNT) + return -EINVAL; + if (id >= counter->counts[parent].num_synapses) + return -EINVAL; + id = array_index_nospec(id, counter->counts[parent].num_synapses); + + comp_node.comp.type = COUNTER_COMP_SYNAPSE_ACTION; + comp_node.comp.action_read = counter->ops->action_read; + comp_node.comp.priv = counter->counts[parent].synapses + id; + break; + case COUNTER_COMPONENT_EXTENSION: + if (id >= num_ext) + return -EINVAL; + id = array_index_nospec(id, num_ext); + + comp_node.comp = ext[id]; + break; + default: + return -EINVAL; + } + /* Check if any read callback is set; this is part of a union */ + if (!comp_node.comp.count_u8_read) + return -EOPNOTSUPP; + +no_component: + if (counter->ops->watch_validate) { + err = counter->ops->watch_validate(counter, &watch); + if (err < 0) + return err; + } + + comp_node.component = watch.component; + + return counter_set_event_node(counter, &watch, &comp_node); +} + +static long counter_chrdev_ioctl(struct file *filp, unsigned int cmd, + unsigned long arg) +{ + struct counter_device *const counter = filp->private_data; + unsigned long flags; + int err = 0; + + switch (cmd) { + case COUNTER_CLEAR_WATCHES_IOCTL: + return counter_clear_watches(counter); + case COUNTER_ADD_WATCH_IOCTL: + return counter_add_watch(counter, arg); + case COUNTER_LOAD_WATCHES_IOCTL: + raw_spin_lock_irqsave(&counter->events_list_lock, flags); + + counter_events_list_free(&counter->events_list); + list_replace_init(&counter->next_events_list, + &counter->events_list); + + if (counter->ops->events_configure) + err = counter->ops->events_configure(counter); + + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); + break; + default: + return -ENOIOCTLCMD; + } + + return err; +} + +static int counter_chrdev_open(struct inode *inode, struct file *filp) +{ + struct counter_device *const counter = container_of(inode->i_cdev, + typeof(*counter), + chrdev); + + get_device(&counter->dev); + filp->private_data = counter; + + return nonseekable_open(inode, filp); +} + +static int counter_chrdev_release(struct inode *inode, struct file *filp) +{ + struct counter_device *const counter = filp->private_data; + int err; + + err = counter_clear_watches(counter); + if (err < 0) + return err; + + put_device(&counter->dev); + + return 0; +} + +static const struct file_operations counter_fops = { + .llseek = no_llseek, + .read = counter_chrdev_read, + .poll = counter_chrdev_poll, + .unlocked_ioctl = counter_chrdev_ioctl, + .open = counter_chrdev_open, + .release = counter_chrdev_release, +}; + +int counter_chrdev_add(struct counter_device *const counter, + const dev_t counter_devt) +{ + struct device *const dev = &counter->dev; + struct cdev *const chrdev = &counter->chrdev; + + /* Initialize Counter events lists */ + INIT_LIST_HEAD(&counter->events_list); + INIT_LIST_HEAD(&counter->next_events_list); + raw_spin_lock_init(&counter->events_list_lock); + + /* Initialize Counter events queue */ + INIT_KFIFO(counter->events); + init_waitqueue_head(&counter->events_wait); + mutex_init(&counter->events_lock); + + /* Initialize character device */ + cdev_init(chrdev, &counter_fops); + dev->devt = MKDEV(MAJOR(counter_devt), counter->id); + cdev_set_parent(chrdev, &dev->kobj); + + return cdev_add(chrdev, dev->devt, 1); +} + +void counter_chrdev_remove(struct counter_device *const counter) +{ + cdev_del(&counter->chrdev); +} + +static int counter_get_data(struct counter_device *const counter, + const struct counter_comp_node *const comp_node, + u64 *const value) +{ + const struct counter_comp *const comp = &comp_node->comp; + void *const parent = comp_node->parent; + int err = 0; + u8 value_u8 = 0; + u32 value_u32 = 0; + + if (comp_node->component.type == COUNTER_COMPONENT_NONE) + return 0; + + switch (comp->type) { + case COUNTER_COMP_U8: + case COUNTER_COMP_BOOL: + switch (comp_node->component.scope) { + case COUNTER_SCOPE_DEVICE: + err = comp->device_u8_read(counter, &value_u8); + break; + case COUNTER_SCOPE_SIGNAL: + err = comp->signal_u8_read(counter, parent, &value_u8); + break; + case COUNTER_SCOPE_COUNT: + err = comp->count_u8_read(counter, parent, &value_u8); + break; + } + *value = value_u8; + break; + case COUNTER_COMP_SIGNAL_LEVEL: + case COUNTER_COMP_FUNCTION: + case COUNTER_COMP_ENUM: + case COUNTER_COMP_COUNT_DIRECTION: + case COUNTER_COMP_COUNT_MODE: + switch (comp_node->component.scope) { + case COUNTER_SCOPE_DEVICE: + err = comp->device_u32_read(counter, &value_u32); + break; + case COUNTER_SCOPE_SIGNAL: + err = comp->signal_u32_read(counter, parent, + &value_u32); + break; + case COUNTER_SCOPE_COUNT: + err = comp->count_u32_read(counter, parent, &value_u32); + break; + } + *value = value_u32; + break; + case COUNTER_COMP_U64: + switch (comp_node->component.scope) { + case COUNTER_SCOPE_DEVICE: + return comp->device_u64_read(counter, value); + case COUNTER_SCOPE_SIGNAL: + return comp->signal_u64_read(counter, parent, value); + case COUNTER_SCOPE_COUNT: + return comp->count_u64_read(counter, parent, value); + } + break; + case COUNTER_COMP_SYNAPSE_ACTION: + err = comp->action_read(counter, parent, comp->priv, + &value_u32); + *value = value_u32; + break; + } + + return err; +} + +/** + * counter_push_event - queue event for userspace reading + * @counter: pointer to Counter structure + * @event: triggered event + * @channel: event channel + * + * Note: If no one is watching for the respective event, it is silently + * discarded. + */ +void counter_push_event(struct counter_device *const counter, const u8 event, + const u8 channel) +{ + struct counter_event ev = {0}; + unsigned int copied = 0; + unsigned long flags; + struct counter_event_node *event_node; + struct counter_comp_node *comp_node; + + ev.timestamp = ktime_get_ns(); + ev.watch.event = event; + ev.watch.channel = channel; + + raw_spin_lock_irqsave(&counter->events_list_lock, flags); + + /* Search for event in the list */ + list_for_each_entry(event_node, &counter->events_list, l) + if (event_node->event == event && + event_node->channel == channel) + break; + + /* If event is not in the list */ + if (&event_node->l == &counter->events_list) + goto exit_early; + + /* Read and queue relevant comp for userspace */ + list_for_each_entry(comp_node, &event_node->comp_list, l) { + ev.watch.component = comp_node->component; + ev.errno = -counter_get_data(counter, comp_node, &ev.value); + + copied += kfifo_put(&counter->events, ev); + } + + if (copied) + wake_up_poll(&counter->events_wait, EPOLLIN); + +exit_early: + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); +} +EXPORT_SYMBOL_GPL(counter_push_event); diff --git a/drivers/counter/counter-chrdev.h b/drivers/counter/counter-chrdev.h new file mode 100644 index 000000000000..cf5a318fe540 --- /dev/null +++ b/drivers/counter/counter-chrdev.h @@ -0,0 +1,16 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * Counter character device interface + * Copyright (C) 2020 William Breathitt Gray + */ +#ifndef _COUNTER_CHRDEV_H_ +#define _COUNTER_CHRDEV_H_ + +#include <linux/counter.h> +#include <linux/types.h> + +int counter_chrdev_add(struct counter_device *const counter, + const dev_t counter_devt); +void counter_chrdev_remove(struct counter_device *const counter); + +#endif /* _COUNTER_CHRDEV_H_ */ diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c index 78e07588717b..1334e2f4ce4e 100644 --- a/drivers/counter/counter-core.c +++ b/drivers/counter/counter-core.c @@ -5,12 +5,16 @@ */ #include <linux/counter.h> #include <linux/device.h> +#include <linux/device/bus.h> #include <linux/export.h> +#include <linux/fs.h> #include <linux/gfp.h> #include <linux/idr.h> #include <linux/init.h> #include <linux/module.h> +#include <linux/types.h> +#include "counter-chrdev.h" #include "counter-sysfs.h" /* Provides a unique ID for each counter device */ @@ -33,6 +37,8 @@ static struct bus_type counter_bus_type = { .name = "counter" }; +static dev_t counter_devt; + /** * counter_register - register Counter to the system * @counter: pointer to Counter to register @@ -51,7 +57,6 @@ int counter_register(struct counter_device *const counter) if (counter->id < 0) return counter->id; - /* Configure device structure for Counter */ dev->type = &counter_device_type; dev->bus = &counter_bus_type; if (counter->parent) { @@ -62,18 +67,25 @@ int counter_register(struct counter_device *const counter) device_initialize(dev); dev_set_drvdata(dev, counter); + /* Add Counter character device */ + err = counter_chrdev_add(counter, counter_devt); + if (err) + goto err_free_id; + /* Add Counter sysfs attributes */ err = counter_sysfs_add(counter); if (err < 0) - goto err_free_id; + goto err_remove_chrdev; /* Add device to system */ err = device_add(dev); if (err < 0) - goto err_free_id; + goto err_remove_chrdev; return 0; +err_remove_chrdev: + counter_chrdev_remove(counter); err_free_id: put_device(dev); return err; @@ -135,13 +147,30 @@ int devm_counter_register(struct device *dev, } EXPORT_SYMBOL_GPL(devm_counter_register); +#define COUNTER_DEV_MAX 256 + static int __init counter_init(void) { - return bus_register(&counter_bus_type); + int err; + + err = bus_register(&counter_bus_type); + if (err < 0) + return err; + + err = alloc_chrdev_region(&counter_devt, 0, COUNTER_DEV_MAX, "counter"); + if (err < 0) + goto err_unregister_bus; + + return 0; + +err_unregister_bus: + bus_unregister(&counter_bus_type); + return err; } static void __exit counter_exit(void) { + unregister_chrdev_region(counter_devt, COUNTER_DEV_MAX); bus_unregister(&counter_bus_type); } diff --git a/drivers/counter/counter-sysfs.c b/drivers/counter/counter-sysfs.c index 654afa91ae9f..4d97d6e50d48 100644 --- a/drivers/counter/counter-sysfs.c +++ b/drivers/counter/counter-sysfs.c @@ -499,6 +499,7 @@ static ssize_t counter_comp_name_show(struct device *dev, static int counter_name_attr_create(struct device *const dev, struct counter_attribute_group *const group, + const char *const attr_name, const char *const name) { struct counter_attribute *counter_attr; @@ -513,7 +514,7 @@ static int counter_name_attr_create(struct device *const dev, /* Configure device attribute */ sysfs_attr_init(&counter_attr->dev_attr.attr); - counter_attr->dev_attr.attr.name = "name"; + counter_attr->dev_attr.attr.name = attr_name; counter_attr->dev_attr.attr.mode = 0444; counter_attr->dev_attr.show = counter_comp_name_show; @@ -524,6 +525,18 @@ static int counter_name_attr_create(struct device *const dev, return 0; } +static int counter_ext_name_attr_create(struct device *const dev, + struct counter_attribute_group *const group, const size_t i, + const char *const name) +{ + const char *attr_name; + + attr_name = devm_kasprintf(dev, GFP_KERNEL, "extension%zu_name", i); + if (!attr_name) + return -ENOMEM; + + return counter_name_attr_create(dev, group, attr_name, name); +} static struct counter_comp counter_signal_comp = { .type = COUNTER_COMP_SIGNAL_LEVEL, @@ -539,6 +552,7 @@ static int counter_signal_attrs_create(struct counter_device *const counter, int err; struct counter_comp comp; size_t i; + struct counter_comp *ext; /* Create main Signal attribute */ comp = counter_signal_comp; @@ -548,14 +562,19 @@ static int counter_signal_attrs_create(struct counter_device *const counter, return err; /* Create Signal name attribute */ - err = counter_name_attr_create(dev, group, signal->name); + err = counter_name_attr_create(dev, group, "name", signal->name); if (err < 0) return err; /* Create an attribute for each extension */ for (i = 0; i < signal->num_ext; i++) { - err = counter_attr_create(dev, group, signal->ext + i, scope, - signal); + ext = signal->ext + i; + + err = counter_attr_create(dev, group, ext, scope, signal); + if (err < 0) + return err; + + err = counter_ext_name_attr_create(dev, group, i, ext->name); if (err < 0) return err; } @@ -640,6 +659,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, int err; struct counter_comp comp; size_t i; + struct counter_comp *ext; /* Create main Count attribute */ comp = counter_count_comp; @@ -650,7 +670,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, return err; /* Create Count name attribute */ - err = counter_name_attr_create(dev, group, count->name); + err = counter_name_attr_create(dev, group, "name", count->name); if (err < 0) return err; @@ -664,8 +684,13 @@ static int counter_count_attrs_create(struct counter_device *const counter, /* Create an attribute for each extension */ for (i = 0; i < count->num_ext; i++) { - err = counter_attr_create(dev, group, count->ext + i, scope, - count); + ext = count->ext + i; + + err = counter_attr_create(dev, group, ext, scope, count); + if (err < 0) + return err; + + err = counter_ext_name_attr_create(dev, group, i, ext->name); if (err < 0) return err; } @@ -729,6 +754,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, struct device *const dev = &counter->dev; int err; size_t i; + struct counter_comp *ext; /* Add Signals sysfs attributes */ err = counter_sysfs_signals_add(counter, group); @@ -743,7 +769,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, group += counter->num_counts; /* Create name attribute */ - err = counter_name_attr_create(dev, group, counter->name); + err = counter_name_attr_create(dev, group, "name", counter->name); if (err < 0) return err; @@ -761,8 +787,13 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, /* Create an attribute for each extension */ for (i = 0; i < counter->num_ext; i++) { - err = counter_attr_create(dev, group, counter->ext + i, scope, - NULL); + ext = counter->ext + i; + + err = counter_attr_create(dev, group, ext, scope, NULL); + if (err < 0) + return err; + + err = counter_ext_name_attr_create(dev, group, i, ext->name); if (err < 0) return err; } diff --git a/include/linux/counter.h b/include/linux/counter.h index 2f01e1fec857..ce79e62a2e58 100644 --- a/include/linux/counter.h +++ b/include/linux/counter.h @@ -6,9 +6,15 @@ #ifndef _COUNTER_H_ #define _COUNTER_H_ +#include <linux/cdev.h> #include <linux/device.h> #include <linux/kernel.h> +#include <linux/kfifo.h> +#include <linux/mutex.h> +#include <linux/spinlock_types.h> #include <linux/types.h> +#include <linux/wait.h> +#include <uapi/linux/counter.h> struct counter_device; struct counter_count; @@ -27,47 +33,6 @@ enum counter_comp_type { COUNTER_COMP_COUNT_MODE, }; -enum counter_scope { - COUNTER_SCOPE_DEVICE, - COUNTER_SCOPE_SIGNAL, - COUNTER_SCOPE_COUNT, -}; - -enum counter_count_direction { - COUNTER_COUNT_DIRECTION_FORWARD, - COUNTER_COUNT_DIRECTION_BACKWARD, -}; - -enum counter_count_mode { - COUNTER_COUNT_MODE_NORMAL, - COUNTER_COUNT_MODE_RANGE_LIMIT, - COUNTER_COUNT_MODE_NON_RECYCLE, - COUNTER_COUNT_MODE_MODULO_N, -}; - -enum counter_function { - COUNTER_FUNCTION_INCREASE, - COUNTER_FUNCTION_DECREASE, - COUNTER_FUNCTION_PULSE_DIRECTION, - COUNTER_FUNCTION_QUADRATURE_X1_A, - COUNTER_FUNCTION_QUADRATURE_X1_B, - COUNTER_FUNCTION_QUADRATURE_X2_A, - COUNTER_FUNCTION_QUADRATURE_X2_B, - COUNTER_FUNCTION_QUADRATURE_X4, -}; - -enum counter_signal_level { - COUNTER_SIGNAL_LEVEL_LOW, - COUNTER_SIGNAL_LEVEL_HIGH, -}; - -enum counter_synapse_action { - COUNTER_SYNAPSE_ACTION_NONE, - COUNTER_SYNAPSE_ACTION_RISING_EDGE, - COUNTER_SYNAPSE_ACTION_FALLING_EDGE, - COUNTER_SYNAPSE_ACTION_BOTH_EDGES, -}; - /** * struct counter_comp - Counter component node * @type: Counter component data type @@ -239,6 +204,20 @@ struct counter_count { size_t num_ext; }; +/** + * struct counter_event_node - Counter Event node + * @l: list of current watching Counter events + * @event: event that triggers + * @channel: event channel + * @comp_list: list of components to watch when event triggers + */ +struct counter_event_node { + struct list_head l; + u8 event; + u8 channel; + struct list_head comp_list; +}; + /** * struct counter_ops - Callbacks from driver * @signal_read: read callback for Signals. The read level of the @@ -261,6 +240,13 @@ struct counter_count { * @action_write: write callback for Synapse action modes. The action mode * to write for the respective Synapse is passed in via the * action parameter. + * @events_configure: write callback to configure events. The list of struct + * counter_event_node may be accessed via the events_list + * member of the counter parameter. + * @watch_validate: callback to validate a watch. The Counter component + * watch configuration is passed in via the watch + * parameter. A return value of 0 indicates a valid Counter + * component watch configuration. */ struct counter_ops { int (*signal_read)(struct counter_device *counter, @@ -284,6 +270,9 @@ struct counter_ops { struct counter_count *count, struct counter_synapse *synapse, enum counter_synapse_action action); + int (*events_configure)(struct counter_device *counter); + int (*watch_validate)(struct counter_device *counter, + const struct counter_watch *watch); }; /** @@ -300,6 +289,13 @@ struct counter_ops { * @priv: optional private data supplied by driver * @id: unique ID used to identify the Counter * @dev: internal device structure + * @chrdev: internal character device structure + * @events_list: list of current watching Counter events + * @events_list_lock: lock to protect Counter events list operations + * @next_events_list: list of next watching Counter events + * @events: queue of detected Counter events + * @events_wait: wait queue to allow blocking reads of Counter events + * @events_lock: lock to protect Counter events queue read operations */ struct counter_device { const char *name; @@ -319,12 +315,21 @@ struct counter_device { int id; struct device dev; + struct cdev chrdev; + struct list_head events_list; + raw_spinlock_t events_list_lock; + struct list_head next_events_list; + DECLARE_KFIFO(events, struct counter_event, 64); + wait_queue_head_t events_wait; + struct mutex events_lock; }; int counter_register(struct counter_device *const counter); void counter_unregister(struct counter_device *const counter); int devm_counter_register(struct device *dev, struct counter_device *const counter); +void counter_push_event(struct counter_device *const counter, const u8 event, + const u8 channel); #define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ { \ diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h new file mode 100644 index 000000000000..7585dc9db19d --- /dev/null +++ b/include/uapi/linux/counter.h @@ -0,0 +1,123 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +/* + * Userspace ABI for Counter character devices + * Copyright (C) 2020 William Breathitt Gray + */ +#ifndef _UAPI_COUNTER_H_ +#define _UAPI_COUNTER_H_ + +#include <linux/ioctl.h> +#include <linux/types.h> + +/* Component type definitions */ +enum counter_component_type { + COUNTER_COMPONENT_NONE, + COUNTER_COMPONENT_SIGNAL, + COUNTER_COMPONENT_COUNT, + COUNTER_COMPONENT_FUNCTION, + COUNTER_COMPONENT_SYNAPSE_ACTION, + COUNTER_COMPONENT_EXTENSION, +}; + +/* Component scope definitions */ +enum counter_scope { + COUNTER_SCOPE_DEVICE, + COUNTER_SCOPE_SIGNAL, + COUNTER_SCOPE_COUNT, +}; + +/** + * struct counter_component - Counter component identification + * @type: component type (Count, extension, etc.) + * @scope: component scope (Device, Count, or Signal) + * @parent: parent component identification number + * @id: component identification number + */ +struct counter_component { + __u8 type; + __u8 scope; + __u8 parent; + __u8 id; +}; + +/* Event type definitions */ +enum counter_event_type { + COUNTER_EVENT_OVERFLOW, + COUNTER_EVENT_UNDERFLOW, + COUNTER_EVENT_OVERFLOW_UNDERFLOW, + COUNTER_EVENT_THRESHOLD, + COUNTER_EVENT_INDEX, +}; + +/** + * struct counter_watch - Counter component watch configuration + * @component: component to watch when event triggers + * @event: event that triggers + * @channel: event channel + */ +struct counter_watch { + struct counter_component component; + __u8 event; + __u8 channel; +}; + +/* ioctl commands */ +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) + +/** + * struct counter_event - Counter event data + * @timestamp: best estimate of time of event occurrence, in nanoseconds + * @value: component value + * @watch: component watch configuration + * @errno: system error number + */ +struct counter_event { + __aligned_u64 timestamp; + __aligned_u64 value; + struct counter_watch watch; + __u8 errno; +}; + +/* Count direction values */ +enum counter_count_direction { + COUNTER_COUNT_DIRECTION_FORWARD, + COUNTER_COUNT_DIRECTION_BACKWARD, +}; + +/* Count mode values */ +enum counter_count_mode { + COUNTER_COUNT_MODE_NORMAL, + COUNTER_COUNT_MODE_RANGE_LIMIT, + COUNTER_COUNT_MODE_NON_RECYCLE, + COUNTER_COUNT_MODE_MODULO_N, +}; + +/* Count function values */ +enum counter_function { + COUNTER_FUNCTION_INCREASE, + COUNTER_FUNCTION_DECREASE, + COUNTER_FUNCTION_PULSE_DIRECTION, + COUNTER_FUNCTION_QUADRATURE_X1_A, + COUNTER_FUNCTION_QUADRATURE_X1_B, + COUNTER_FUNCTION_QUADRATURE_X2_A, + COUNTER_FUNCTION_QUADRATURE_X2_B, + COUNTER_FUNCTION_QUADRATURE_X4, +}; + +/* Signal values */ +enum counter_signal_level { + COUNTER_SIGNAL_LEVEL_LOW, + COUNTER_SIGNAL_LEVEL_HIGH, +}; + +/* Action mode values */ +enum counter_synapse_action { + COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, +}; + +#endif /* _UAPI_COUNTER_H_ */ -- 2.29.2 ^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH v7 3/5] counter: Add character device interface @ 2020-12-26 0:15 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, Dan Carpenter, kernel, William Breathitt Gray, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue This patch introduces a character device interface for the Counter subsystem. Device data is exposed through standard character device read operations. Device data is gathered when a Counter event is pushed by the respective Counter device driver. Configuration is handled via ioctl operations on the respective Counter character device node. Cc: David Lechner <david@lechnology.com> Cc: Gwendal Grignou <gwendal@chromium.org> Cc: Dan Carpenter <dan.carpenter@oracle.com> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- MAINTAINERS | 1 + drivers/counter/Makefile | 2 +- drivers/counter/counter-chrdev.c | 490 +++++++++++++++++++++++++++++++ drivers/counter/counter-chrdev.h | 16 + drivers/counter/counter-core.c | 37 ++- drivers/counter/counter-sysfs.c | 51 +++- include/linux/counter.h | 87 +++--- include/uapi/linux/counter.h | 123 ++++++++ 8 files changed, 751 insertions(+), 56 deletions(-) create mode 100644 drivers/counter/counter-chrdev.c create mode 100644 drivers/counter/counter-chrdev.h create mode 100644 include/uapi/linux/counter.h diff --git a/MAINTAINERS b/MAINTAINERS index b64fa49d5796..3a240f70bdd4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4494,6 +4494,7 @@ F: Documentation/ABI/testing/sysfs-bus-counter* F: Documentation/driver-api/generic-counter.rst F: drivers/counter/ F: include/linux/counter.h +F: include/uapi/linux/counter.h CPMAC ETHERNET DRIVER M: Florian Fainelli <f.fainelli@gmail.com> diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile index cbe1d06af6a9..c4870eb5b1dd 100644 --- a/drivers/counter/Makefile +++ b/drivers/counter/Makefile @@ -4,7 +4,7 @@ # obj-$(CONFIG_COUNTER) += counter.o -counter-y := counter-core.o counter-sysfs.o +counter-y := counter-core.o counter-sysfs.o counter-chrdev.o obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o diff --git a/drivers/counter/counter-chrdev.c b/drivers/counter/counter-chrdev.c new file mode 100644 index 000000000000..61b11989546a --- /dev/null +++ b/drivers/counter/counter-chrdev.c @@ -0,0 +1,490 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Generic Counter character device interface + * Copyright (C) 2020 William Breathitt Gray + */ + +#include <linux/cdev.h> +#include <linux/counter.h> +#include <linux/device.h> +#include <linux/err.h> +#include <linux/errno.h> +#include <linux/export.h> +#include <linux/fs.h> +#include <linux/kdev_t.h> +#include <linux/kfifo.h> +#include <linux/list.h> +#include <linux/mutex.h> +#include <linux/nospec.h> +#include <linux/poll.h> +#include <linux/slab.h> +#include <linux/spinlock.h> +#include <linux/timekeeping.h> +#include <linux/types.h> +#include <linux/wait.h> +#include <linux/uaccess.h> + +#include "counter-chrdev.h" + +struct counter_comp_node { + struct list_head l; + struct counter_component component; + struct counter_comp comp; + void *parent; +}; + +static ssize_t counter_chrdev_read(struct file *filp, char __user *buf, + size_t len, loff_t *f_ps) +{ + struct counter_device *const counter = filp->private_data; + int err; + unsigned int copied; + + if (len < sizeof(struct counter_event)) + return -EINVAL; + + do { + if (kfifo_is_empty(&counter->events)) { + if (filp->f_flags & O_NONBLOCK) + return -EAGAIN; + + err = wait_event_interruptible(counter->events_wait, + !kfifo_is_empty(&counter->events)); + if (err < 0) + return err; + } + + if (mutex_lock_interruptible(&counter->events_lock)) + return -ERESTARTSYS; + err = kfifo_to_user(&counter->events, buf, len, &copied); + mutex_unlock(&counter->events_lock); + if (err < 0) + return err; + } while (!copied); + + return copied; +} + +static __poll_t counter_chrdev_poll(struct file *filp, + struct poll_table_struct *pollt) +{ + struct counter_device *const counter = filp->private_data; + __poll_t events = 0; + + poll_wait(filp, &counter->events_wait, pollt); + + if (!kfifo_is_empty(&counter->events)) + events = EPOLLIN | EPOLLRDNORM; + + return events; +} + +static void counter_events_list_free(struct list_head *const events_list) +{ + struct counter_event_node *p, *n; + struct counter_comp_node *q, *o; + + list_for_each_entry_safe(p, n, events_list, l) { + /* Free associated component nodes */ + list_for_each_entry_safe(q, o, &p->comp_list, l) { + list_del(&q->l); + kfree(q); + } + + /* Free event node */ + list_del(&p->l); + kfree(p); + } +} + +static int counter_set_event_node(struct counter_device *const counter, + struct counter_watch *const watch, + const struct counter_comp_node *const cfg) +{ + struct counter_event_node *event_node; + struct counter_comp_node *comp_node; + + /* Search for event in the list */ + list_for_each_entry(event_node, &counter->next_events_list, l) + if (event_node->event == watch->event && + event_node->channel == watch->channel) + break; + + /* If event is not already in the list */ + if (&event_node->l == &counter->next_events_list) { + /* Allocate new event node */ + event_node = kmalloc(sizeof(*event_node), GFP_ATOMIC); + if (!event_node) + return -ENOMEM; + + /* Configure event node and add to the list */ + event_node->event = watch->event; + event_node->channel = watch->channel; + INIT_LIST_HEAD(&event_node->comp_list); + list_add(&event_node->l, &counter->next_events_list); + } + + /* Check if component watch has already been set before */ + list_for_each_entry(comp_node, &event_node->comp_list, l) + if (comp_node->parent == cfg->parent && + comp_node->comp.count_u8_read == cfg->comp.count_u8_read) + return -EINVAL; + + /* Allocate component node */ + comp_node = kmalloc(sizeof(*comp_node), GFP_ATOMIC); + if (!comp_node) { + /* Free event node if no one else is watching */ + if (list_empty(&event_node->comp_list)) { + list_del(&event_node->l); + kfree(event_node); + } + return -ENOMEM; + } + *comp_node = *cfg; + + /* Add component node to event node */ + list_add_tail(&comp_node->l, &event_node->comp_list); + + return 0; +} + +static int counter_clear_watches(struct counter_device *const counter) +{ + unsigned long flags; + int err = 0; + + raw_spin_lock_irqsave(&counter->events_list_lock, flags); + + counter_events_list_free(&counter->events_list); + + if (counter->ops->events_configure) + err = counter->ops->events_configure(counter); + + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); + + counter_events_list_free(&counter->next_events_list); + + return err; +} + +static int counter_add_watch(struct counter_device *const counter, + const unsigned long arg) +{ + void __user *const uwatch = (void __user *)arg; + struct counter_watch watch; + struct counter_comp_node comp_node = {0}; + size_t parent, id; + struct counter_comp *ext; + size_t num_ext; + int err; + + if (copy_from_user(&watch, uwatch, sizeof(watch))) + return -EFAULT; + + if (watch.component.type == COUNTER_COMPONENT_NONE) + goto no_component; + + parent = watch.component.parent; + + /* Configure parent component info for comp node */ + switch (watch.component.scope) { + case COUNTER_SCOPE_DEVICE: + ext = counter->ext; + num_ext = counter->num_ext; + break; + case COUNTER_SCOPE_SIGNAL: + if (parent >= counter->num_signals) + return -EINVAL; + parent = array_index_nospec(parent, counter->num_signals); + + comp_node.parent = counter->signals + parent; + + ext = counter->signals[parent].ext; + num_ext = counter->signals[parent].num_ext; + break; + case COUNTER_SCOPE_COUNT: + if (parent >= counter->num_counts) + return -EINVAL; + parent = array_index_nospec(parent, counter->num_counts); + + comp_node.parent = counter->counts + parent; + + ext = counter->counts[parent].ext; + num_ext = counter->counts[parent].num_ext; + break; + } + + id = watch.component.id; + + /* Configure component info for comp node */ + switch (watch.component.type) { + case COUNTER_COMPONENT_SIGNAL: + if (watch.component.scope != COUNTER_SCOPE_SIGNAL) + return -EINVAL; + + comp_node.comp.type = COUNTER_COMP_SIGNAL_LEVEL; + comp_node.comp.signal_u32_read = counter->ops->signal_read; + break; + case COUNTER_COMPONENT_COUNT: + if (watch.component.scope != COUNTER_SCOPE_COUNT) + return -EINVAL; + + comp_node.comp.type = COUNTER_COMP_U64; + comp_node.comp.count_u64_read = counter->ops->count_read; + break; + case COUNTER_COMPONENT_FUNCTION: + if (watch.component.scope != COUNTER_SCOPE_COUNT) + return -EINVAL; + + comp_node.comp.type = COUNTER_COMP_FUNCTION; + comp_node.comp.count_u32_read = counter->ops->function_read; + break; + case COUNTER_COMPONENT_SYNAPSE_ACTION: + if (watch.component.scope != COUNTER_SCOPE_COUNT) + return -EINVAL; + if (id >= counter->counts[parent].num_synapses) + return -EINVAL; + id = array_index_nospec(id, counter->counts[parent].num_synapses); + + comp_node.comp.type = COUNTER_COMP_SYNAPSE_ACTION; + comp_node.comp.action_read = counter->ops->action_read; + comp_node.comp.priv = counter->counts[parent].synapses + id; + break; + case COUNTER_COMPONENT_EXTENSION: + if (id >= num_ext) + return -EINVAL; + id = array_index_nospec(id, num_ext); + + comp_node.comp = ext[id]; + break; + default: + return -EINVAL; + } + /* Check if any read callback is set; this is part of a union */ + if (!comp_node.comp.count_u8_read) + return -EOPNOTSUPP; + +no_component: + if (counter->ops->watch_validate) { + err = counter->ops->watch_validate(counter, &watch); + if (err < 0) + return err; + } + + comp_node.component = watch.component; + + return counter_set_event_node(counter, &watch, &comp_node); +} + +static long counter_chrdev_ioctl(struct file *filp, unsigned int cmd, + unsigned long arg) +{ + struct counter_device *const counter = filp->private_data; + unsigned long flags; + int err = 0; + + switch (cmd) { + case COUNTER_CLEAR_WATCHES_IOCTL: + return counter_clear_watches(counter); + case COUNTER_ADD_WATCH_IOCTL: + return counter_add_watch(counter, arg); + case COUNTER_LOAD_WATCHES_IOCTL: + raw_spin_lock_irqsave(&counter->events_list_lock, flags); + + counter_events_list_free(&counter->events_list); + list_replace_init(&counter->next_events_list, + &counter->events_list); + + if (counter->ops->events_configure) + err = counter->ops->events_configure(counter); + + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); + break; + default: + return -ENOIOCTLCMD; + } + + return err; +} + +static int counter_chrdev_open(struct inode *inode, struct file *filp) +{ + struct counter_device *const counter = container_of(inode->i_cdev, + typeof(*counter), + chrdev); + + get_device(&counter->dev); + filp->private_data = counter; + + return nonseekable_open(inode, filp); +} + +static int counter_chrdev_release(struct inode *inode, struct file *filp) +{ + struct counter_device *const counter = filp->private_data; + int err; + + err = counter_clear_watches(counter); + if (err < 0) + return err; + + put_device(&counter->dev); + + return 0; +} + +static const struct file_operations counter_fops = { + .llseek = no_llseek, + .read = counter_chrdev_read, + .poll = counter_chrdev_poll, + .unlocked_ioctl = counter_chrdev_ioctl, + .open = counter_chrdev_open, + .release = counter_chrdev_release, +}; + +int counter_chrdev_add(struct counter_device *const counter, + const dev_t counter_devt) +{ + struct device *const dev = &counter->dev; + struct cdev *const chrdev = &counter->chrdev; + + /* Initialize Counter events lists */ + INIT_LIST_HEAD(&counter->events_list); + INIT_LIST_HEAD(&counter->next_events_list); + raw_spin_lock_init(&counter->events_list_lock); + + /* Initialize Counter events queue */ + INIT_KFIFO(counter->events); + init_waitqueue_head(&counter->events_wait); + mutex_init(&counter->events_lock); + + /* Initialize character device */ + cdev_init(chrdev, &counter_fops); + dev->devt = MKDEV(MAJOR(counter_devt), counter->id); + cdev_set_parent(chrdev, &dev->kobj); + + return cdev_add(chrdev, dev->devt, 1); +} + +void counter_chrdev_remove(struct counter_device *const counter) +{ + cdev_del(&counter->chrdev); +} + +static int counter_get_data(struct counter_device *const counter, + const struct counter_comp_node *const comp_node, + u64 *const value) +{ + const struct counter_comp *const comp = &comp_node->comp; + void *const parent = comp_node->parent; + int err = 0; + u8 value_u8 = 0; + u32 value_u32 = 0; + + if (comp_node->component.type == COUNTER_COMPONENT_NONE) + return 0; + + switch (comp->type) { + case COUNTER_COMP_U8: + case COUNTER_COMP_BOOL: + switch (comp_node->component.scope) { + case COUNTER_SCOPE_DEVICE: + err = comp->device_u8_read(counter, &value_u8); + break; + case COUNTER_SCOPE_SIGNAL: + err = comp->signal_u8_read(counter, parent, &value_u8); + break; + case COUNTER_SCOPE_COUNT: + err = comp->count_u8_read(counter, parent, &value_u8); + break; + } + *value = value_u8; + break; + case COUNTER_COMP_SIGNAL_LEVEL: + case COUNTER_COMP_FUNCTION: + case COUNTER_COMP_ENUM: + case COUNTER_COMP_COUNT_DIRECTION: + case COUNTER_COMP_COUNT_MODE: + switch (comp_node->component.scope) { + case COUNTER_SCOPE_DEVICE: + err = comp->device_u32_read(counter, &value_u32); + break; + case COUNTER_SCOPE_SIGNAL: + err = comp->signal_u32_read(counter, parent, + &value_u32); + break; + case COUNTER_SCOPE_COUNT: + err = comp->count_u32_read(counter, parent, &value_u32); + break; + } + *value = value_u32; + break; + case COUNTER_COMP_U64: + switch (comp_node->component.scope) { + case COUNTER_SCOPE_DEVICE: + return comp->device_u64_read(counter, value); + case COUNTER_SCOPE_SIGNAL: + return comp->signal_u64_read(counter, parent, value); + case COUNTER_SCOPE_COUNT: + return comp->count_u64_read(counter, parent, value); + } + break; + case COUNTER_COMP_SYNAPSE_ACTION: + err = comp->action_read(counter, parent, comp->priv, + &value_u32); + *value = value_u32; + break; + } + + return err; +} + +/** + * counter_push_event - queue event for userspace reading + * @counter: pointer to Counter structure + * @event: triggered event + * @channel: event channel + * + * Note: If no one is watching for the respective event, it is silently + * discarded. + */ +void counter_push_event(struct counter_device *const counter, const u8 event, + const u8 channel) +{ + struct counter_event ev = {0}; + unsigned int copied = 0; + unsigned long flags; + struct counter_event_node *event_node; + struct counter_comp_node *comp_node; + + ev.timestamp = ktime_get_ns(); + ev.watch.event = event; + ev.watch.channel = channel; + + raw_spin_lock_irqsave(&counter->events_list_lock, flags); + + /* Search for event in the list */ + list_for_each_entry(event_node, &counter->events_list, l) + if (event_node->event == event && + event_node->channel == channel) + break; + + /* If event is not in the list */ + if (&event_node->l == &counter->events_list) + goto exit_early; + + /* Read and queue relevant comp for userspace */ + list_for_each_entry(comp_node, &event_node->comp_list, l) { + ev.watch.component = comp_node->component; + ev.errno = -counter_get_data(counter, comp_node, &ev.value); + + copied += kfifo_put(&counter->events, ev); + } + + if (copied) + wake_up_poll(&counter->events_wait, EPOLLIN); + +exit_early: + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); +} +EXPORT_SYMBOL_GPL(counter_push_event); diff --git a/drivers/counter/counter-chrdev.h b/drivers/counter/counter-chrdev.h new file mode 100644 index 000000000000..cf5a318fe540 --- /dev/null +++ b/drivers/counter/counter-chrdev.h @@ -0,0 +1,16 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * Counter character device interface + * Copyright (C) 2020 William Breathitt Gray + */ +#ifndef _COUNTER_CHRDEV_H_ +#define _COUNTER_CHRDEV_H_ + +#include <linux/counter.h> +#include <linux/types.h> + +int counter_chrdev_add(struct counter_device *const counter, + const dev_t counter_devt); +void counter_chrdev_remove(struct counter_device *const counter); + +#endif /* _COUNTER_CHRDEV_H_ */ diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c index 78e07588717b..1334e2f4ce4e 100644 --- a/drivers/counter/counter-core.c +++ b/drivers/counter/counter-core.c @@ -5,12 +5,16 @@ */ #include <linux/counter.h> #include <linux/device.h> +#include <linux/device/bus.h> #include <linux/export.h> +#include <linux/fs.h> #include <linux/gfp.h> #include <linux/idr.h> #include <linux/init.h> #include <linux/module.h> +#include <linux/types.h> +#include "counter-chrdev.h" #include "counter-sysfs.h" /* Provides a unique ID for each counter device */ @@ -33,6 +37,8 @@ static struct bus_type counter_bus_type = { .name = "counter" }; +static dev_t counter_devt; + /** * counter_register - register Counter to the system * @counter: pointer to Counter to register @@ -51,7 +57,6 @@ int counter_register(struct counter_device *const counter) if (counter->id < 0) return counter->id; - /* Configure device structure for Counter */ dev->type = &counter_device_type; dev->bus = &counter_bus_type; if (counter->parent) { @@ -62,18 +67,25 @@ int counter_register(struct counter_device *const counter) device_initialize(dev); dev_set_drvdata(dev, counter); + /* Add Counter character device */ + err = counter_chrdev_add(counter, counter_devt); + if (err) + goto err_free_id; + /* Add Counter sysfs attributes */ err = counter_sysfs_add(counter); if (err < 0) - goto err_free_id; + goto err_remove_chrdev; /* Add device to system */ err = device_add(dev); if (err < 0) - goto err_free_id; + goto err_remove_chrdev; return 0; +err_remove_chrdev: + counter_chrdev_remove(counter); err_free_id: put_device(dev); return err; @@ -135,13 +147,30 @@ int devm_counter_register(struct device *dev, } EXPORT_SYMBOL_GPL(devm_counter_register); +#define COUNTER_DEV_MAX 256 + static int __init counter_init(void) { - return bus_register(&counter_bus_type); + int err; + + err = bus_register(&counter_bus_type); + if (err < 0) + return err; + + err = alloc_chrdev_region(&counter_devt, 0, COUNTER_DEV_MAX, "counter"); + if (err < 0) + goto err_unregister_bus; + + return 0; + +err_unregister_bus: + bus_unregister(&counter_bus_type); + return err; } static void __exit counter_exit(void) { + unregister_chrdev_region(counter_devt, COUNTER_DEV_MAX); bus_unregister(&counter_bus_type); } diff --git a/drivers/counter/counter-sysfs.c b/drivers/counter/counter-sysfs.c index 654afa91ae9f..4d97d6e50d48 100644 --- a/drivers/counter/counter-sysfs.c +++ b/drivers/counter/counter-sysfs.c @@ -499,6 +499,7 @@ static ssize_t counter_comp_name_show(struct device *dev, static int counter_name_attr_create(struct device *const dev, struct counter_attribute_group *const group, + const char *const attr_name, const char *const name) { struct counter_attribute *counter_attr; @@ -513,7 +514,7 @@ static int counter_name_attr_create(struct device *const dev, /* Configure device attribute */ sysfs_attr_init(&counter_attr->dev_attr.attr); - counter_attr->dev_attr.attr.name = "name"; + counter_attr->dev_attr.attr.name = attr_name; counter_attr->dev_attr.attr.mode = 0444; counter_attr->dev_attr.show = counter_comp_name_show; @@ -524,6 +525,18 @@ static int counter_name_attr_create(struct device *const dev, return 0; } +static int counter_ext_name_attr_create(struct device *const dev, + struct counter_attribute_group *const group, const size_t i, + const char *const name) +{ + const char *attr_name; + + attr_name = devm_kasprintf(dev, GFP_KERNEL, "extension%zu_name", i); + if (!attr_name) + return -ENOMEM; + + return counter_name_attr_create(dev, group, attr_name, name); +} static struct counter_comp counter_signal_comp = { .type = COUNTER_COMP_SIGNAL_LEVEL, @@ -539,6 +552,7 @@ static int counter_signal_attrs_create(struct counter_device *const counter, int err; struct counter_comp comp; size_t i; + struct counter_comp *ext; /* Create main Signal attribute */ comp = counter_signal_comp; @@ -548,14 +562,19 @@ static int counter_signal_attrs_create(struct counter_device *const counter, return err; /* Create Signal name attribute */ - err = counter_name_attr_create(dev, group, signal->name); + err = counter_name_attr_create(dev, group, "name", signal->name); if (err < 0) return err; /* Create an attribute for each extension */ for (i = 0; i < signal->num_ext; i++) { - err = counter_attr_create(dev, group, signal->ext + i, scope, - signal); + ext = signal->ext + i; + + err = counter_attr_create(dev, group, ext, scope, signal); + if (err < 0) + return err; + + err = counter_ext_name_attr_create(dev, group, i, ext->name); if (err < 0) return err; } @@ -640,6 +659,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, int err; struct counter_comp comp; size_t i; + struct counter_comp *ext; /* Create main Count attribute */ comp = counter_count_comp; @@ -650,7 +670,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, return err; /* Create Count name attribute */ - err = counter_name_attr_create(dev, group, count->name); + err = counter_name_attr_create(dev, group, "name", count->name); if (err < 0) return err; @@ -664,8 +684,13 @@ static int counter_count_attrs_create(struct counter_device *const counter, /* Create an attribute for each extension */ for (i = 0; i < count->num_ext; i++) { - err = counter_attr_create(dev, group, count->ext + i, scope, - count); + ext = count->ext + i; + + err = counter_attr_create(dev, group, ext, scope, count); + if (err < 0) + return err; + + err = counter_ext_name_attr_create(dev, group, i, ext->name); if (err < 0) return err; } @@ -729,6 +754,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, struct device *const dev = &counter->dev; int err; size_t i; + struct counter_comp *ext; /* Add Signals sysfs attributes */ err = counter_sysfs_signals_add(counter, group); @@ -743,7 +769,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, group += counter->num_counts; /* Create name attribute */ - err = counter_name_attr_create(dev, group, counter->name); + err = counter_name_attr_create(dev, group, "name", counter->name); if (err < 0) return err; @@ -761,8 +787,13 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, /* Create an attribute for each extension */ for (i = 0; i < counter->num_ext; i++) { - err = counter_attr_create(dev, group, counter->ext + i, scope, - NULL); + ext = counter->ext + i; + + err = counter_attr_create(dev, group, ext, scope, NULL); + if (err < 0) + return err; + + err = counter_ext_name_attr_create(dev, group, i, ext->name); if (err < 0) return err; } diff --git a/include/linux/counter.h b/include/linux/counter.h index 2f01e1fec857..ce79e62a2e58 100644 --- a/include/linux/counter.h +++ b/include/linux/counter.h @@ -6,9 +6,15 @@ #ifndef _COUNTER_H_ #define _COUNTER_H_ +#include <linux/cdev.h> #include <linux/device.h> #include <linux/kernel.h> +#include <linux/kfifo.h> +#include <linux/mutex.h> +#include <linux/spinlock_types.h> #include <linux/types.h> +#include <linux/wait.h> +#include <uapi/linux/counter.h> struct counter_device; struct counter_count; @@ -27,47 +33,6 @@ enum counter_comp_type { COUNTER_COMP_COUNT_MODE, }; -enum counter_scope { - COUNTER_SCOPE_DEVICE, - COUNTER_SCOPE_SIGNAL, - COUNTER_SCOPE_COUNT, -}; - -enum counter_count_direction { - COUNTER_COUNT_DIRECTION_FORWARD, - COUNTER_COUNT_DIRECTION_BACKWARD, -}; - -enum counter_count_mode { - COUNTER_COUNT_MODE_NORMAL, - COUNTER_COUNT_MODE_RANGE_LIMIT, - COUNTER_COUNT_MODE_NON_RECYCLE, - COUNTER_COUNT_MODE_MODULO_N, -}; - -enum counter_function { - COUNTER_FUNCTION_INCREASE, - COUNTER_FUNCTION_DECREASE, - COUNTER_FUNCTION_PULSE_DIRECTION, - COUNTER_FUNCTION_QUADRATURE_X1_A, - COUNTER_FUNCTION_QUADRATURE_X1_B, - COUNTER_FUNCTION_QUADRATURE_X2_A, - COUNTER_FUNCTION_QUADRATURE_X2_B, - COUNTER_FUNCTION_QUADRATURE_X4, -}; - -enum counter_signal_level { - COUNTER_SIGNAL_LEVEL_LOW, - COUNTER_SIGNAL_LEVEL_HIGH, -}; - -enum counter_synapse_action { - COUNTER_SYNAPSE_ACTION_NONE, - COUNTER_SYNAPSE_ACTION_RISING_EDGE, - COUNTER_SYNAPSE_ACTION_FALLING_EDGE, - COUNTER_SYNAPSE_ACTION_BOTH_EDGES, -}; - /** * struct counter_comp - Counter component node * @type: Counter component data type @@ -239,6 +204,20 @@ struct counter_count { size_t num_ext; }; +/** + * struct counter_event_node - Counter Event node + * @l: list of current watching Counter events + * @event: event that triggers + * @channel: event channel + * @comp_list: list of components to watch when event triggers + */ +struct counter_event_node { + struct list_head l; + u8 event; + u8 channel; + struct list_head comp_list; +}; + /** * struct counter_ops - Callbacks from driver * @signal_read: read callback for Signals. The read level of the @@ -261,6 +240,13 @@ struct counter_count { * @action_write: write callback for Synapse action modes. The action mode * to write for the respective Synapse is passed in via the * action parameter. + * @events_configure: write callback to configure events. The list of struct + * counter_event_node may be accessed via the events_list + * member of the counter parameter. + * @watch_validate: callback to validate a watch. The Counter component + * watch configuration is passed in via the watch + * parameter. A return value of 0 indicates a valid Counter + * component watch configuration. */ struct counter_ops { int (*signal_read)(struct counter_device *counter, @@ -284,6 +270,9 @@ struct counter_ops { struct counter_count *count, struct counter_synapse *synapse, enum counter_synapse_action action); + int (*events_configure)(struct counter_device *counter); + int (*watch_validate)(struct counter_device *counter, + const struct counter_watch *watch); }; /** @@ -300,6 +289,13 @@ struct counter_ops { * @priv: optional private data supplied by driver * @id: unique ID used to identify the Counter * @dev: internal device structure + * @chrdev: internal character device structure + * @events_list: list of current watching Counter events + * @events_list_lock: lock to protect Counter events list operations + * @next_events_list: list of next watching Counter events + * @events: queue of detected Counter events + * @events_wait: wait queue to allow blocking reads of Counter events + * @events_lock: lock to protect Counter events queue read operations */ struct counter_device { const char *name; @@ -319,12 +315,21 @@ struct counter_device { int id; struct device dev; + struct cdev chrdev; + struct list_head events_list; + raw_spinlock_t events_list_lock; + struct list_head next_events_list; + DECLARE_KFIFO(events, struct counter_event, 64); + wait_queue_head_t events_wait; + struct mutex events_lock; }; int counter_register(struct counter_device *const counter); void counter_unregister(struct counter_device *const counter); int devm_counter_register(struct device *dev, struct counter_device *const counter); +void counter_push_event(struct counter_device *const counter, const u8 event, + const u8 channel); #define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ { \ diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h new file mode 100644 index 000000000000..7585dc9db19d --- /dev/null +++ b/include/uapi/linux/counter.h @@ -0,0 +1,123 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +/* + * Userspace ABI for Counter character devices + * Copyright (C) 2020 William Breathitt Gray + */ +#ifndef _UAPI_COUNTER_H_ +#define _UAPI_COUNTER_H_ + +#include <linux/ioctl.h> +#include <linux/types.h> + +/* Component type definitions */ +enum counter_component_type { + COUNTER_COMPONENT_NONE, + COUNTER_COMPONENT_SIGNAL, + COUNTER_COMPONENT_COUNT, + COUNTER_COMPONENT_FUNCTION, + COUNTER_COMPONENT_SYNAPSE_ACTION, + COUNTER_COMPONENT_EXTENSION, +}; + +/* Component scope definitions */ +enum counter_scope { + COUNTER_SCOPE_DEVICE, + COUNTER_SCOPE_SIGNAL, + COUNTER_SCOPE_COUNT, +}; + +/** + * struct counter_component - Counter component identification + * @type: component type (Count, extension, etc.) + * @scope: component scope (Device, Count, or Signal) + * @parent: parent component identification number + * @id: component identification number + */ +struct counter_component { + __u8 type; + __u8 scope; + __u8 parent; + __u8 id; +}; + +/* Event type definitions */ +enum counter_event_type { + COUNTER_EVENT_OVERFLOW, + COUNTER_EVENT_UNDERFLOW, + COUNTER_EVENT_OVERFLOW_UNDERFLOW, + COUNTER_EVENT_THRESHOLD, + COUNTER_EVENT_INDEX, +}; + +/** + * struct counter_watch - Counter component watch configuration + * @component: component to watch when event triggers + * @event: event that triggers + * @channel: event channel + */ +struct counter_watch { + struct counter_component component; + __u8 event; + __u8 channel; +}; + +/* ioctl commands */ +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) + +/** + * struct counter_event - Counter event data + * @timestamp: best estimate of time of event occurrence, in nanoseconds + * @value: component value + * @watch: component watch configuration + * @errno: system error number + */ +struct counter_event { + __aligned_u64 timestamp; + __aligned_u64 value; + struct counter_watch watch; + __u8 errno; +}; + +/* Count direction values */ +enum counter_count_direction { + COUNTER_COUNT_DIRECTION_FORWARD, + COUNTER_COUNT_DIRECTION_BACKWARD, +}; + +/* Count mode values */ +enum counter_count_mode { + COUNTER_COUNT_MODE_NORMAL, + COUNTER_COUNT_MODE_RANGE_LIMIT, + COUNTER_COUNT_MODE_NON_RECYCLE, + COUNTER_COUNT_MODE_MODULO_N, +}; + +/* Count function values */ +enum counter_function { + COUNTER_FUNCTION_INCREASE, + COUNTER_FUNCTION_DECREASE, + COUNTER_FUNCTION_PULSE_DIRECTION, + COUNTER_FUNCTION_QUADRATURE_X1_A, + COUNTER_FUNCTION_QUADRATURE_X1_B, + COUNTER_FUNCTION_QUADRATURE_X2_A, + COUNTER_FUNCTION_QUADRATURE_X2_B, + COUNTER_FUNCTION_QUADRATURE_X4, +}; + +/* Signal values */ +enum counter_signal_level { + COUNTER_SIGNAL_LEVEL_LOW, + COUNTER_SIGNAL_LEVEL_HIGH, +}; + +/* Action mode values */ +enum counter_synapse_action { + COUNTER_SYNAPSE_ACTION_NONE, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, +}; + +#endif /* _UAPI_COUNTER_H_ */ -- 2.29.2 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply related [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 15:04 ` Jonathan Cameron -1 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 15:04 UTC (permalink / raw) To: William Breathitt Gray Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter On Fri, 25 Dec 2020 19:15:36 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > This patch introduces a character device interface for the Counter > subsystem. Device data is exposed through standard character device read > operations. Device data is gathered when a Counter event is pushed by > the respective Counter device driver. Configuration is handled via ioctl > operations on the respective Counter character device node. > > Cc: David Lechner <david@lechnology.com> > Cc: Gwendal Grignou <gwendal@chromium.org> > Cc: Dan Carpenter <dan.carpenter@oracle.com> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> There are a few things in here that could profitably be pulled out as precursor patches. I don't really understand the connection of extension_name to the addition of a chardev for example. Might be needed to provide enough info to actually use the chardev, but does it have meaning without that? Either way, definitely feels like it can be done in a separate patch. > --- > MAINTAINERS | 1 + > drivers/counter/Makefile | 2 +- > drivers/counter/counter-chrdev.c | 490 +++++++++++++++++++++++++++++++ > drivers/counter/counter-chrdev.h | 16 + > drivers/counter/counter-core.c | 37 ++- > drivers/counter/counter-sysfs.c | 51 +++- > include/linux/counter.h | 87 +++--- > include/uapi/linux/counter.h | 123 ++++++++ > 8 files changed, 751 insertions(+), 56 deletions(-) > create mode 100644 drivers/counter/counter-chrdev.c > create mode 100644 drivers/counter/counter-chrdev.h > create mode 100644 include/uapi/linux/counter.h > > diff --git a/MAINTAINERS b/MAINTAINERS > index b64fa49d5796..3a240f70bdd4 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -4494,6 +4494,7 @@ F: Documentation/ABI/testing/sysfs-bus-counter* > F: Documentation/driver-api/generic-counter.rst > F: drivers/counter/ > F: include/linux/counter.h > +F: include/uapi/linux/counter.h > > CPMAC ETHERNET DRIVER > M: Florian Fainelli <f.fainelli@gmail.com> > diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile > index cbe1d06af6a9..c4870eb5b1dd 100644 > --- a/drivers/counter/Makefile > +++ b/drivers/counter/Makefile > @@ -4,7 +4,7 @@ > # > > obj-$(CONFIG_COUNTER) += counter.o > -counter-y := counter-core.o counter-sysfs.o > +counter-y := counter-core.o counter-sysfs.o counter-chrdev.o > > obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o > obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o > diff --git a/drivers/counter/counter-chrdev.c b/drivers/counter/counter-chrdev.c > new file mode 100644 > index 000000000000..61b11989546a > --- /dev/null > +++ b/drivers/counter/counter-chrdev.c > @@ -0,0 +1,490 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * Generic Counter character device interface > + * Copyright (C) 2020 William Breathitt Gray > + */ > + > +#include <linux/cdev.h> > +#include <linux/counter.h> > +#include <linux/device.h> > +#include <linux/err.h> > +#include <linux/errno.h> > +#include <linux/export.h> > +#include <linux/fs.h> > +#include <linux/kdev_t.h> > +#include <linux/kfifo.h> > +#include <linux/list.h> > +#include <linux/mutex.h> > +#include <linux/nospec.h> > +#include <linux/poll.h> > +#include <linux/slab.h> > +#include <linux/spinlock.h> > +#include <linux/timekeeping.h> > +#include <linux/types.h> > +#include <linux/wait.h> > +#include <linux/uaccess.h> > + > +#include "counter-chrdev.h" > + > +struct counter_comp_node { > + struct list_head l; > + struct counter_component component; > + struct counter_comp comp; > + void *parent; > +}; > + > +static ssize_t counter_chrdev_read(struct file *filp, char __user *buf, > + size_t len, loff_t *f_ps) > +{ > + struct counter_device *const counter = filp->private_data; > + int err; > + unsigned int copied; > + > + if (len < sizeof(struct counter_event)) > + return -EINVAL; > + > + do { > + if (kfifo_is_empty(&counter->events)) { > + if (filp->f_flags & O_NONBLOCK) > + return -EAGAIN; > + > + err = wait_event_interruptible(counter->events_wait, > + !kfifo_is_empty(&counter->events)); > + if (err < 0) > + return err; > + } > + > + if (mutex_lock_interruptible(&counter->events_lock)) > + return -ERESTARTSYS; > + err = kfifo_to_user(&counter->events, buf, len, &copied); > + mutex_unlock(&counter->events_lock); > + if (err < 0) > + return err; > + } while (!copied); > + > + return copied; > +} > + > +static __poll_t counter_chrdev_poll(struct file *filp, > + struct poll_table_struct *pollt) > +{ > + struct counter_device *const counter = filp->private_data; > + __poll_t events = 0; > + > + poll_wait(filp, &counter->events_wait, pollt); > + > + if (!kfifo_is_empty(&counter->events)) > + events = EPOLLIN | EPOLLRDNORM; > + > + return events; > +} > + > +static void counter_events_list_free(struct list_head *const events_list) > +{ > + struct counter_event_node *p, *n; > + struct counter_comp_node *q, *o; > + > + list_for_each_entry_safe(p, n, events_list, l) { > + /* Free associated component nodes */ > + list_for_each_entry_safe(q, o, &p->comp_list, l) { > + list_del(&q->l); > + kfree(q); > + } > + > + /* Free event node */ > + list_del(&p->l); > + kfree(p); > + } > +} > + > +static int counter_set_event_node(struct counter_device *const counter, > + struct counter_watch *const watch, > + const struct counter_comp_node *const cfg) > +{ > + struct counter_event_node *event_node; > + struct counter_comp_node *comp_node; > + > + /* Search for event in the list */ > + list_for_each_entry(event_node, &counter->next_events_list, l) > + if (event_node->event == watch->event && > + event_node->channel == watch->channel) > + break; > + > + /* If event is not already in the list */ > + if (&event_node->l == &counter->next_events_list) { > + /* Allocate new event node */ > + event_node = kmalloc(sizeof(*event_node), GFP_ATOMIC); > + if (!event_node) > + return -ENOMEM; > + > + /* Configure event node and add to the list */ > + event_node->event = watch->event; > + event_node->channel = watch->channel; > + INIT_LIST_HEAD(&event_node->comp_list); > + list_add(&event_node->l, &counter->next_events_list); > + } > + > + /* Check if component watch has already been set before */ > + list_for_each_entry(comp_node, &event_node->comp_list, l) > + if (comp_node->parent == cfg->parent && > + comp_node->comp.count_u8_read == cfg->comp.count_u8_read) > + return -EINVAL; > + > + /* Allocate component node */ > + comp_node = kmalloc(sizeof(*comp_node), GFP_ATOMIC); > + if (!comp_node) { > + /* Free event node if no one else is watching */ > + if (list_empty(&event_node->comp_list)) { > + list_del(&event_node->l); > + kfree(event_node); > + } > + return -ENOMEM; > + } > + *comp_node = *cfg; > + > + /* Add component node to event node */ > + list_add_tail(&comp_node->l, &event_node->comp_list); > + > + return 0; > +} > + > +static int counter_clear_watches(struct counter_device *const counter) > +{ > + unsigned long flags; > + int err = 0; > + > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > + > + counter_events_list_free(&counter->events_list); > + > + if (counter->ops->events_configure) > + err = counter->ops->events_configure(counter); > + > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > + > + counter_events_list_free(&counter->next_events_list); > + > + return err; > +} > + > +static int counter_add_watch(struct counter_device *const counter, > + const unsigned long arg) > +{ > + void __user *const uwatch = (void __user *)arg; > + struct counter_watch watch; > + struct counter_comp_node comp_node = {0}; > + size_t parent, id; > + struct counter_comp *ext; > + size_t num_ext; > + int err; > + > + if (copy_from_user(&watch, uwatch, sizeof(watch))) > + return -EFAULT; > + > + if (watch.component.type == COUNTER_COMPONENT_NONE) > + goto no_component; > + > + parent = watch.component.parent; > + > + /* Configure parent component info for comp node */ > + switch (watch.component.scope) { > + case COUNTER_SCOPE_DEVICE: > + ext = counter->ext; > + num_ext = counter->num_ext; > + break; > + case COUNTER_SCOPE_SIGNAL: > + if (parent >= counter->num_signals) > + return -EINVAL; > + parent = array_index_nospec(parent, counter->num_signals); > + > + comp_node.parent = counter->signals + parent; > + > + ext = counter->signals[parent].ext; > + num_ext = counter->signals[parent].num_ext; > + break; > + case COUNTER_SCOPE_COUNT: > + if (parent >= counter->num_counts) > + return -EINVAL; > + parent = array_index_nospec(parent, counter->num_counts); > + > + comp_node.parent = counter->counts + parent; > + > + ext = counter->counts[parent].ext; > + num_ext = counter->counts[parent].num_ext; > + break; > + } > + > + id = watch.component.id; > + > + /* Configure component info for comp node */ > + switch (watch.component.type) { > + case COUNTER_COMPONENT_SIGNAL: > + if (watch.component.scope != COUNTER_SCOPE_SIGNAL) > + return -EINVAL; > + > + comp_node.comp.type = COUNTER_COMP_SIGNAL_LEVEL; > + comp_node.comp.signal_u32_read = counter->ops->signal_read; > + break; > + case COUNTER_COMPONENT_COUNT: > + if (watch.component.scope != COUNTER_SCOPE_COUNT) > + return -EINVAL; > + > + comp_node.comp.type = COUNTER_COMP_U64; > + comp_node.comp.count_u64_read = counter->ops->count_read; > + break; > + case COUNTER_COMPONENT_FUNCTION: > + if (watch.component.scope != COUNTER_SCOPE_COUNT) > + return -EINVAL; > + > + comp_node.comp.type = COUNTER_COMP_FUNCTION; > + comp_node.comp.count_u32_read = counter->ops->function_read; > + break; > + case COUNTER_COMPONENT_SYNAPSE_ACTION: > + if (watch.component.scope != COUNTER_SCOPE_COUNT) > + return -EINVAL; > + if (id >= counter->counts[parent].num_synapses) > + return -EINVAL; > + id = array_index_nospec(id, counter->counts[parent].num_synapses); > + > + comp_node.comp.type = COUNTER_COMP_SYNAPSE_ACTION; > + comp_node.comp.action_read = counter->ops->action_read; > + comp_node.comp.priv = counter->counts[parent].synapses + id; > + break; > + case COUNTER_COMPONENT_EXTENSION: > + if (id >= num_ext) > + return -EINVAL; > + id = array_index_nospec(id, num_ext); > + > + comp_node.comp = ext[id]; > + break; > + default: > + return -EINVAL; > + } > + /* Check if any read callback is set; this is part of a union */ > + if (!comp_node.comp.count_u8_read) > + return -EOPNOTSUPP; > + > +no_component: > + if (counter->ops->watch_validate) { > + err = counter->ops->watch_validate(counter, &watch); > + if (err < 0) > + return err; > + } > + > + comp_node.component = watch.component; > + > + return counter_set_event_node(counter, &watch, &comp_node); > +} > + > +static long counter_chrdev_ioctl(struct file *filp, unsigned int cmd, > + unsigned long arg) > +{ > + struct counter_device *const counter = filp->private_data; > + unsigned long flags; > + int err = 0; > + > + switch (cmd) { > + case COUNTER_CLEAR_WATCHES_IOCTL: > + return counter_clear_watches(counter); > + case COUNTER_ADD_WATCH_IOCTL: > + return counter_add_watch(counter, arg); > + case COUNTER_LOAD_WATCHES_IOCTL: > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > + > + counter_events_list_free(&counter->events_list); > + list_replace_init(&counter->next_events_list, > + &counter->events_list); > + > + if (counter->ops->events_configure) > + err = counter->ops->events_configure(counter); > + > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > + break; return here. > + default: > + return -ENOIOCTLCMD; > + } > + > + return err; > +} > + > +static int counter_chrdev_open(struct inode *inode, struct file *filp) > +{ > + struct counter_device *const counter = container_of(inode->i_cdev, > + typeof(*counter), > + chrdev); > + > + get_device(&counter->dev); > + filp->private_data = counter; > + > + return nonseekable_open(inode, filp); > +} > + > +static int counter_chrdev_release(struct inode *inode, struct file *filp) > +{ > + struct counter_device *const counter = filp->private_data; > + int err; > + > + err = counter_clear_watches(counter); > + if (err < 0) > + return err; > + > + put_device(&counter->dev); > + > + return 0; > +} > + > +static const struct file_operations counter_fops = { > + .llseek = no_llseek, > + .read = counter_chrdev_read, > + .poll = counter_chrdev_poll, > + .unlocked_ioctl = counter_chrdev_ioctl, > + .open = counter_chrdev_open, > + .release = counter_chrdev_release, > +}; > + > +int counter_chrdev_add(struct counter_device *const counter, > + const dev_t counter_devt) > +{ > + struct device *const dev = &counter->dev; > + struct cdev *const chrdev = &counter->chrdev; > + > + /* Initialize Counter events lists */ > + INIT_LIST_HEAD(&counter->events_list); > + INIT_LIST_HEAD(&counter->next_events_list); > + raw_spin_lock_init(&counter->events_list_lock); > + > + /* Initialize Counter events queue */ > + INIT_KFIFO(counter->events); > + init_waitqueue_head(&counter->events_wait); > + mutex_init(&counter->events_lock); > + > + /* Initialize character device */ > + cdev_init(chrdev, &counter_fops); > + dev->devt = MKDEV(MAJOR(counter_devt), counter->id); > + cdev_set_parent(chrdev, &dev->kobj); > + > + return cdev_add(chrdev, dev->devt, 1); > +} > + > +void counter_chrdev_remove(struct counter_device *const counter) > +{ > + cdev_del(&counter->chrdev); > +} > + > +static int counter_get_data(struct counter_device *const counter, > + const struct counter_comp_node *const comp_node, > + u64 *const value) > +{ > + const struct counter_comp *const comp = &comp_node->comp; > + void *const parent = comp_node->parent; > + int err = 0; > + u8 value_u8 = 0; > + u32 value_u32 = 0; > + > + if (comp_node->component.type == COUNTER_COMPONENT_NONE) > + return 0; > + > + switch (comp->type) { > + case COUNTER_COMP_U8: > + case COUNTER_COMP_BOOL: > + switch (comp_node->component.scope) { > + case COUNTER_SCOPE_DEVICE: > + err = comp->device_u8_read(counter, &value_u8); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = comp->signal_u8_read(counter, parent, &value_u8); > + break; > + case COUNTER_SCOPE_COUNT: > + err = comp->count_u8_read(counter, parent, &value_u8); > + break; > + } > + *value = value_u8; > + break; > + case COUNTER_COMP_SIGNAL_LEVEL: > + case COUNTER_COMP_FUNCTION: > + case COUNTER_COMP_ENUM: > + case COUNTER_COMP_COUNT_DIRECTION: > + case COUNTER_COMP_COUNT_MODE: > + switch (comp_node->component.scope) { > + case COUNTER_SCOPE_DEVICE: > + err = comp->device_u32_read(counter, &value_u32); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = comp->signal_u32_read(counter, parent, > + &value_u32); > + break; > + case COUNTER_SCOPE_COUNT: > + err = comp->count_u32_read(counter, parent, &value_u32); > + break; > + } > + *value = value_u32; Seems like a return here would make more sense as no shared stuff to do at end of the switch. Same in other similar cases. > + break; > + case COUNTER_COMP_U64: > + switch (comp_node->component.scope) { > + case COUNTER_SCOPE_DEVICE: > + return comp->device_u64_read(counter, value); > + case COUNTER_SCOPE_SIGNAL: > + return comp->signal_u64_read(counter, parent, value); > + case COUNTER_SCOPE_COUNT: > + return comp->count_u64_read(counter, parent, value); > + } > + break; > + case COUNTER_COMP_SYNAPSE_ACTION: > + err = comp->action_read(counter, parent, comp->priv, > + &value_u32); > + *value = value_u32; > + break; > + } > + > + return err; > +} > + > +/** > + * counter_push_event - queue event for userspace reading > + * @counter: pointer to Counter structure > + * @event: triggered event > + * @channel: event channel > + * > + * Note: If no one is watching for the respective event, it is silently > + * discarded. > + */ > +void counter_push_event(struct counter_device *const counter, const u8 event, > + const u8 channel) > +{ > + struct counter_event ev = {0}; > + unsigned int copied = 0; > + unsigned long flags; > + struct counter_event_node *event_node; > + struct counter_comp_node *comp_node; > + > + ev.timestamp = ktime_get_ns(); > + ev.watch.event = event; > + ev.watch.channel = channel; > + > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); For a raw spin lock, we definitely want to see comments on why it is necessary. > + > + /* Search for event in the list */ > + list_for_each_entry(event_node, &counter->events_list, l) > + if (event_node->event == event && > + event_node->channel == channel) > + break; > + > + /* If event is not in the list */ > + if (&event_node->l == &counter->events_list) > + goto exit_early; > + > + /* Read and queue relevant comp for userspace */ > + list_for_each_entry(comp_node, &event_node->comp_list, l) { > + ev.watch.component = comp_node->component; > + ev.errno = -counter_get_data(counter, comp_node, &ev.value); > + > + copied += kfifo_put(&counter->events, ev); > + } > + > + if (copied) > + wake_up_poll(&counter->events_wait, EPOLLIN); > + > +exit_early: > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > +} > +EXPORT_SYMBOL_GPL(counter_push_event); > diff --git a/drivers/counter/counter-chrdev.h b/drivers/counter/counter-chrdev.h > new file mode 100644 > index 000000000000..cf5a318fe540 > --- /dev/null > +++ b/drivers/counter/counter-chrdev.h > @@ -0,0 +1,16 @@ > +/* SPDX-License-Identifier: GPL-2.0 */ > +/* > + * Counter character device interface > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#ifndef _COUNTER_CHRDEV_H_ > +#define _COUNTER_CHRDEV_H_ > + > +#include <linux/counter.h> > +#include <linux/types.h> > + > +int counter_chrdev_add(struct counter_device *const counter, > + const dev_t counter_devt); > +void counter_chrdev_remove(struct counter_device *const counter); > + > +#endif /* _COUNTER_CHRDEV_H_ */ > diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c > index 78e07588717b..1334e2f4ce4e 100644 > --- a/drivers/counter/counter-core.c > +++ b/drivers/counter/counter-core.c > @@ -5,12 +5,16 @@ > */ > #include <linux/counter.h> > #include <linux/device.h> > +#include <linux/device/bus.h> > #include <linux/export.h> > +#include <linux/fs.h> > #include <linux/gfp.h> > #include <linux/idr.h> > #include <linux/init.h> > #include <linux/module.h> > +#include <linux/types.h> > > +#include "counter-chrdev.h" > #include "counter-sysfs.h" > > /* Provides a unique ID for each counter device */ > @@ -33,6 +37,8 @@ static struct bus_type counter_bus_type = { > .name = "counter" > }; > > +static dev_t counter_devt; > + > /** > * counter_register - register Counter to the system > * @counter: pointer to Counter to register > @@ -51,7 +57,6 @@ int counter_register(struct counter_device *const counter) > if (counter->id < 0) > return counter->id; > > - /* Configure device structure for Counter */ > dev->type = &counter_device_type; > dev->bus = &counter_bus_type; > if (counter->parent) { > @@ -62,18 +67,25 @@ int counter_register(struct counter_device *const counter) > device_initialize(dev); > dev_set_drvdata(dev, counter); > > + /* Add Counter character device */ > + err = counter_chrdev_add(counter, counter_devt); > + if (err) > + goto err_free_id; > + > /* Add Counter sysfs attributes */ > err = counter_sysfs_add(counter); > if (err < 0) > - goto err_free_id; > + goto err_remove_chrdev; > > /* Add device to system */ > err = device_add(dev); > if (err < 0) > - goto err_free_id; > + goto err_remove_chrdev; > > return 0; > > +err_remove_chrdev: > + counter_chrdev_remove(counter); > err_free_id: > put_device(dev); > return err; > @@ -135,13 +147,30 @@ int devm_counter_register(struct device *dev, > } > EXPORT_SYMBOL_GPL(devm_counter_register); > > +#define COUNTER_DEV_MAX 256 > + > static int __init counter_init(void) > { > - return bus_register(&counter_bus_type); > + int err; > + > + err = bus_register(&counter_bus_type); > + if (err < 0) > + return err; > + > + err = alloc_chrdev_region(&counter_devt, 0, COUNTER_DEV_MAX, "counter"); > + if (err < 0) > + goto err_unregister_bus; > + > + return 0; > + > +err_unregister_bus: > + bus_unregister(&counter_bus_type); > + return err; > } > > static void __exit counter_exit(void) > { > + unregister_chrdev_region(counter_devt, COUNTER_DEV_MAX); > bus_unregister(&counter_bus_type); > } > > diff --git a/drivers/counter/counter-sysfs.c b/drivers/counter/counter-sysfs.c > index 654afa91ae9f..4d97d6e50d48 100644 > --- a/drivers/counter/counter-sysfs.c > +++ b/drivers/counter/counter-sysfs.c > @@ -499,6 +499,7 @@ static ssize_t counter_comp_name_show(struct device *dev, > > static int counter_name_attr_create(struct device *const dev, > struct counter_attribute_group *const group, > + const char *const attr_name, > const char *const name) > { > struct counter_attribute *counter_attr; > @@ -513,7 +514,7 @@ static int counter_name_attr_create(struct device *const dev, > > /* Configure device attribute */ > sysfs_attr_init(&counter_attr->dev_attr.attr); > - counter_attr->dev_attr.attr.name = "name"; > + counter_attr->dev_attr.attr.name = attr_name; > counter_attr->dev_attr.attr.mode = 0444; > counter_attr->dev_attr.show = counter_comp_name_show; > > @@ -524,6 +525,18 @@ static int counter_name_attr_create(struct device *const dev, > return 0; > } > > +static int counter_ext_name_attr_create(struct device *const dev, > + struct counter_attribute_group *const group, const size_t i, > + const char *const name) > +{ > + const char *attr_name; > + > + attr_name = devm_kasprintf(dev, GFP_KERNEL, "extension%zu_name", i); > + if (!attr_name) > + return -ENOMEM; > + > + return counter_name_attr_create(dev, group, attr_name, name); > +} > > static struct counter_comp counter_signal_comp = { > .type = COUNTER_COMP_SIGNAL_LEVEL, > @@ -539,6 +552,7 @@ static int counter_signal_attrs_create(struct counter_device *const counter, > int err; > struct counter_comp comp; > size_t i; > + struct counter_comp *ext; > > /* Create main Signal attribute */ > comp = counter_signal_comp; > @@ -548,14 +562,19 @@ static int counter_signal_attrs_create(struct counter_device *const counter, > return err; > > /* Create Signal name attribute */ > - err = counter_name_attr_create(dev, group, signal->name); > + err = counter_name_attr_create(dev, group, "name", signal->name); > if (err < 0) > return err; > > /* Create an attribute for each extension */ > for (i = 0; i < signal->num_ext; i++) { > - err = counter_attr_create(dev, group, signal->ext + i, scope, > - signal); > + ext = signal->ext + i; > + > + err = counter_attr_create(dev, group, ext, scope, signal); > + if (err < 0) > + return err; > + > + err = counter_ext_name_attr_create(dev, group, i, ext->name); > if (err < 0) > return err; > } > @@ -640,6 +659,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, > int err; > struct counter_comp comp; > size_t i; > + struct counter_comp *ext; > > /* Create main Count attribute */ > comp = counter_count_comp; > @@ -650,7 +670,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, > return err; > > /* Create Count name attribute */ > - err = counter_name_attr_create(dev, group, count->name); > + err = counter_name_attr_create(dev, group, "name", count->name); This refactoring could also be pulled out to a precusor patch. > if (err < 0) > return err; > > @@ -664,8 +684,13 @@ static int counter_count_attrs_create(struct counter_device *const counter, > > /* Create an attribute for each extension */ > for (i = 0; i < count->num_ext; i++) { > - err = counter_attr_create(dev, group, count->ext + i, scope, > - count); > + ext = count->ext + i; > + > + err = counter_attr_create(dev, group, ext, scope, count); > + if (err < 0) > + return err; > + > + err = counter_ext_name_attr_create(dev, group, i, ext->name); > if (err < 0) > return err; > } > @@ -729,6 +754,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, > struct device *const dev = &counter->dev; > int err; > size_t i; > + struct counter_comp *ext; > > /* Add Signals sysfs attributes */ > err = counter_sysfs_signals_add(counter, group); > @@ -743,7 +769,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, > group += counter->num_counts; > > /* Create name attribute */ > - err = counter_name_attr_create(dev, group, counter->name); > + err = counter_name_attr_create(dev, group, "name", counter->name); > if (err < 0) > return err; > > @@ -761,8 +787,13 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, > > /* Create an attribute for each extension */ > for (i = 0; i < counter->num_ext; i++) { > - err = counter_attr_create(dev, group, counter->ext + i, scope, > - NULL); > + ext = counter->ext + i; > + > + err = counter_attr_create(dev, group, ext, scope, NULL); > + if (err < 0) > + return err; > + > + err = counter_ext_name_attr_create(dev, group, i, ext->name); > if (err < 0) > return err; > } > diff --git a/include/linux/counter.h b/include/linux/counter.h > index 2f01e1fec857..ce79e62a2e58 100644 > --- a/include/linux/counter.h > +++ b/include/linux/counter.h > @@ -6,9 +6,15 @@ > #ifndef _COUNTER_H_ > #define _COUNTER_H_ > > +#include <linux/cdev.h> > #include <linux/device.h> > #include <linux/kernel.h> > +#include <linux/kfifo.h> > +#include <linux/mutex.h> > +#include <linux/spinlock_types.h> > #include <linux/types.h> > +#include <linux/wait.h> > +#include <uapi/linux/counter.h> > > struct counter_device; > struct counter_count; > @@ -27,47 +33,6 @@ enum counter_comp_type { > COUNTER_COMP_COUNT_MODE, > }; > > -enum counter_scope { > - COUNTER_SCOPE_DEVICE, > - COUNTER_SCOPE_SIGNAL, > - COUNTER_SCOPE_COUNT, > -}; > - > -enum counter_count_direction { > - COUNTER_COUNT_DIRECTION_FORWARD, > - COUNTER_COUNT_DIRECTION_BACKWARD, > -}; > - > -enum counter_count_mode { > - COUNTER_COUNT_MODE_NORMAL, > - COUNTER_COUNT_MODE_RANGE_LIMIT, > - COUNTER_COUNT_MODE_NON_RECYCLE, > - COUNTER_COUNT_MODE_MODULO_N, > -}; > - > -enum counter_function { > - COUNTER_FUNCTION_INCREASE, > - COUNTER_FUNCTION_DECREASE, > - COUNTER_FUNCTION_PULSE_DIRECTION, > - COUNTER_FUNCTION_QUADRATURE_X1_A, > - COUNTER_FUNCTION_QUADRATURE_X1_B, > - COUNTER_FUNCTION_QUADRATURE_X2_A, > - COUNTER_FUNCTION_QUADRATURE_X2_B, > - COUNTER_FUNCTION_QUADRATURE_X4, > -}; > - > -enum counter_signal_level { > - COUNTER_SIGNAL_LEVEL_LOW, > - COUNTER_SIGNAL_LEVEL_HIGH, > -}; > - > -enum counter_synapse_action { > - COUNTER_SYNAPSE_ACTION_NONE, > - COUNTER_SYNAPSE_ACTION_RISING_EDGE, > - COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > - COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > -}; > - > /** > * struct counter_comp - Counter component node > * @type: Counter component data type > @@ -239,6 +204,20 @@ struct counter_count { > size_t num_ext; > }; > > +/** > + * struct counter_event_node - Counter Event node > + * @l: list of current watching Counter events > + * @event: event that triggers > + * @channel: event channel > + * @comp_list: list of components to watch when event triggers > + */ > +struct counter_event_node { > + struct list_head l; > + u8 event; > + u8 channel; > + struct list_head comp_list; > +}; > + > /** > * struct counter_ops - Callbacks from driver > * @signal_read: read callback for Signals. The read level of the > @@ -261,6 +240,13 @@ struct counter_count { > * @action_write: write callback for Synapse action modes. The action mode > * to write for the respective Synapse is passed in via the > * action parameter. > + * @events_configure: write callback to configure events. The list of struct > + * counter_event_node may be accessed via the events_list > + * member of the counter parameter. > + * @watch_validate: callback to validate a watch. The Counter component > + * watch configuration is passed in via the watch > + * parameter. A return value of 0 indicates a valid Counter > + * component watch configuration. > */ > struct counter_ops { > int (*signal_read)(struct counter_device *counter, > @@ -284,6 +270,9 @@ struct counter_ops { > struct counter_count *count, > struct counter_synapse *synapse, > enum counter_synapse_action action); > + int (*events_configure)(struct counter_device *counter); > + int (*watch_validate)(struct counter_device *counter, > + const struct counter_watch *watch); > }; > > /** > @@ -300,6 +289,13 @@ struct counter_ops { > * @priv: optional private data supplied by driver > * @id: unique ID used to identify the Counter > * @dev: internal device structure > + * @chrdev: internal character device structure > + * @events_list: list of current watching Counter events > + * @events_list_lock: lock to protect Counter events list operations > + * @next_events_list: list of next watching Counter events > + * @events: queue of detected Counter events > + * @events_wait: wait queue to allow blocking reads of Counter events > + * @events_lock: lock to protect Counter events queue read operations > */ > struct counter_device { > const char *name; > @@ -319,12 +315,21 @@ struct counter_device { > > int id; > struct device dev; > + struct cdev chrdev; > + struct list_head events_list; > + raw_spinlock_t events_list_lock; > + struct list_head next_events_list; > + DECLARE_KFIFO(events, struct counter_event, 64); Why 64? Probably want that to be somewhat dynamic, even if only at build time. > + wait_queue_head_t events_wait; > + struct mutex events_lock; > }; > > int counter_register(struct counter_device *const counter); > void counter_unregister(struct counter_device *const counter); > int devm_counter_register(struct device *dev, > struct counter_device *const counter); > +void counter_push_event(struct counter_device *const counter, const u8 event, > + const u8 channel); > > #define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ > { \ > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > new file mode 100644 > index 000000000000..7585dc9db19d > --- /dev/null > +++ b/include/uapi/linux/counter.h Small thing but I would have been tempted to do a precursor patch to the main change simply putting in place the userspace header. Classic Nop patch that makes it easier to focus on the real stuff in this patch by getting that noise out of the way! Jonathan > @@ -0,0 +1,123 @@ > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ > +/* > + * Userspace ABI for Counter character devices > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#ifndef _UAPI_COUNTER_H_ > +#define _UAPI_COUNTER_H_ > + > +#include <linux/ioctl.h> > +#include <linux/types.h> > + > +/* Component type definitions */ > +enum counter_component_type { > + COUNTER_COMPONENT_NONE, > + COUNTER_COMPONENT_SIGNAL, > + COUNTER_COMPONENT_COUNT, > + COUNTER_COMPONENT_FUNCTION, > + COUNTER_COMPONENT_SYNAPSE_ACTION, > + COUNTER_COMPONENT_EXTENSION, > +}; > + > +/* Component scope definitions */ > +enum counter_scope { > + COUNTER_SCOPE_DEVICE, > + COUNTER_SCOPE_SIGNAL, > + COUNTER_SCOPE_COUNT, > +}; > + > +/** > + * struct counter_component - Counter component identification > + * @type: component type (Count, extension, etc.) > + * @scope: component scope (Device, Count, or Signal) > + * @parent: parent component identification number > + * @id: component identification number > + */ > +struct counter_component { > + __u8 type; > + __u8 scope; > + __u8 parent; > + __u8 id; > +}; > + > +/* Event type definitions */ > +enum counter_event_type { > + COUNTER_EVENT_OVERFLOW, > + COUNTER_EVENT_UNDERFLOW, > + COUNTER_EVENT_OVERFLOW_UNDERFLOW, > + COUNTER_EVENT_THRESHOLD, > + COUNTER_EVENT_INDEX, > +}; > + > +/** > + * struct counter_watch - Counter component watch configuration > + * @component: component to watch when event triggers > + * @event: event that triggers > + * @channel: event channel > + */ > +struct counter_watch { > + struct counter_component component; > + __u8 event; > + __u8 channel; > +}; > + > +/* ioctl commands */ > +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) > +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) > +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) > + > +/** > + * struct counter_event - Counter event data > + * @timestamp: best estimate of time of event occurrence, in nanoseconds > + * @value: component value > + * @watch: component watch configuration > + * @errno: system error number > + */ > +struct counter_event { > + __aligned_u64 timestamp; > + __aligned_u64 value; > + struct counter_watch watch; > + __u8 errno; > +}; > + > +/* Count direction values */ > +enum counter_count_direction { > + COUNTER_COUNT_DIRECTION_FORWARD, > + COUNTER_COUNT_DIRECTION_BACKWARD, > +}; > + > +/* Count mode values */ > +enum counter_count_mode { > + COUNTER_COUNT_MODE_NORMAL, > + COUNTER_COUNT_MODE_RANGE_LIMIT, > + COUNTER_COUNT_MODE_NON_RECYCLE, > + COUNTER_COUNT_MODE_MODULO_N, > +}; > + > +/* Count function values */ > +enum counter_function { > + COUNTER_FUNCTION_INCREASE, > + COUNTER_FUNCTION_DECREASE, > + COUNTER_FUNCTION_PULSE_DIRECTION, > + COUNTER_FUNCTION_QUADRATURE_X1_A, > + COUNTER_FUNCTION_QUADRATURE_X1_B, > + COUNTER_FUNCTION_QUADRATURE_X2_A, > + COUNTER_FUNCTION_QUADRATURE_X2_B, > + COUNTER_FUNCTION_QUADRATURE_X4, > +}; > + > +/* Signal values */ > +enum counter_signal_level { > + COUNTER_SIGNAL_LEVEL_LOW, > + COUNTER_SIGNAL_LEVEL_HIGH, > +}; > + > +/* Action mode values */ > +enum counter_synapse_action { > + COUNTER_SYNAPSE_ACTION_NONE, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > +}; > + > +#endif /* _UAPI_COUNTER_H_ */ ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface @ 2020-12-30 15:04 ` Jonathan Cameron 0 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 15:04 UTC (permalink / raw) To: William Breathitt Gray Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, Dan Carpenter, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On Fri, 25 Dec 2020 19:15:36 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > This patch introduces a character device interface for the Counter > subsystem. Device data is exposed through standard character device read > operations. Device data is gathered when a Counter event is pushed by > the respective Counter device driver. Configuration is handled via ioctl > operations on the respective Counter character device node. > > Cc: David Lechner <david@lechnology.com> > Cc: Gwendal Grignou <gwendal@chromium.org> > Cc: Dan Carpenter <dan.carpenter@oracle.com> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> There are a few things in here that could profitably be pulled out as precursor patches. I don't really understand the connection of extension_name to the addition of a chardev for example. Might be needed to provide enough info to actually use the chardev, but does it have meaning without that? Either way, definitely feels like it can be done in a separate patch. > --- > MAINTAINERS | 1 + > drivers/counter/Makefile | 2 +- > drivers/counter/counter-chrdev.c | 490 +++++++++++++++++++++++++++++++ > drivers/counter/counter-chrdev.h | 16 + > drivers/counter/counter-core.c | 37 ++- > drivers/counter/counter-sysfs.c | 51 +++- > include/linux/counter.h | 87 +++--- > include/uapi/linux/counter.h | 123 ++++++++ > 8 files changed, 751 insertions(+), 56 deletions(-) > create mode 100644 drivers/counter/counter-chrdev.c > create mode 100644 drivers/counter/counter-chrdev.h > create mode 100644 include/uapi/linux/counter.h > > diff --git a/MAINTAINERS b/MAINTAINERS > index b64fa49d5796..3a240f70bdd4 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -4494,6 +4494,7 @@ F: Documentation/ABI/testing/sysfs-bus-counter* > F: Documentation/driver-api/generic-counter.rst > F: drivers/counter/ > F: include/linux/counter.h > +F: include/uapi/linux/counter.h > > CPMAC ETHERNET DRIVER > M: Florian Fainelli <f.fainelli@gmail.com> > diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile > index cbe1d06af6a9..c4870eb5b1dd 100644 > --- a/drivers/counter/Makefile > +++ b/drivers/counter/Makefile > @@ -4,7 +4,7 @@ > # > > obj-$(CONFIG_COUNTER) += counter.o > -counter-y := counter-core.o counter-sysfs.o > +counter-y := counter-core.o counter-sysfs.o counter-chrdev.o > > obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o > obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o > diff --git a/drivers/counter/counter-chrdev.c b/drivers/counter/counter-chrdev.c > new file mode 100644 > index 000000000000..61b11989546a > --- /dev/null > +++ b/drivers/counter/counter-chrdev.c > @@ -0,0 +1,490 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * Generic Counter character device interface > + * Copyright (C) 2020 William Breathitt Gray > + */ > + > +#include <linux/cdev.h> > +#include <linux/counter.h> > +#include <linux/device.h> > +#include <linux/err.h> > +#include <linux/errno.h> > +#include <linux/export.h> > +#include <linux/fs.h> > +#include <linux/kdev_t.h> > +#include <linux/kfifo.h> > +#include <linux/list.h> > +#include <linux/mutex.h> > +#include <linux/nospec.h> > +#include <linux/poll.h> > +#include <linux/slab.h> > +#include <linux/spinlock.h> > +#include <linux/timekeeping.h> > +#include <linux/types.h> > +#include <linux/wait.h> > +#include <linux/uaccess.h> > + > +#include "counter-chrdev.h" > + > +struct counter_comp_node { > + struct list_head l; > + struct counter_component component; > + struct counter_comp comp; > + void *parent; > +}; > + > +static ssize_t counter_chrdev_read(struct file *filp, char __user *buf, > + size_t len, loff_t *f_ps) > +{ > + struct counter_device *const counter = filp->private_data; > + int err; > + unsigned int copied; > + > + if (len < sizeof(struct counter_event)) > + return -EINVAL; > + > + do { > + if (kfifo_is_empty(&counter->events)) { > + if (filp->f_flags & O_NONBLOCK) > + return -EAGAIN; > + > + err = wait_event_interruptible(counter->events_wait, > + !kfifo_is_empty(&counter->events)); > + if (err < 0) > + return err; > + } > + > + if (mutex_lock_interruptible(&counter->events_lock)) > + return -ERESTARTSYS; > + err = kfifo_to_user(&counter->events, buf, len, &copied); > + mutex_unlock(&counter->events_lock); > + if (err < 0) > + return err; > + } while (!copied); > + > + return copied; > +} > + > +static __poll_t counter_chrdev_poll(struct file *filp, > + struct poll_table_struct *pollt) > +{ > + struct counter_device *const counter = filp->private_data; > + __poll_t events = 0; > + > + poll_wait(filp, &counter->events_wait, pollt); > + > + if (!kfifo_is_empty(&counter->events)) > + events = EPOLLIN | EPOLLRDNORM; > + > + return events; > +} > + > +static void counter_events_list_free(struct list_head *const events_list) > +{ > + struct counter_event_node *p, *n; > + struct counter_comp_node *q, *o; > + > + list_for_each_entry_safe(p, n, events_list, l) { > + /* Free associated component nodes */ > + list_for_each_entry_safe(q, o, &p->comp_list, l) { > + list_del(&q->l); > + kfree(q); > + } > + > + /* Free event node */ > + list_del(&p->l); > + kfree(p); > + } > +} > + > +static int counter_set_event_node(struct counter_device *const counter, > + struct counter_watch *const watch, > + const struct counter_comp_node *const cfg) > +{ > + struct counter_event_node *event_node; > + struct counter_comp_node *comp_node; > + > + /* Search for event in the list */ > + list_for_each_entry(event_node, &counter->next_events_list, l) > + if (event_node->event == watch->event && > + event_node->channel == watch->channel) > + break; > + > + /* If event is not already in the list */ > + if (&event_node->l == &counter->next_events_list) { > + /* Allocate new event node */ > + event_node = kmalloc(sizeof(*event_node), GFP_ATOMIC); > + if (!event_node) > + return -ENOMEM; > + > + /* Configure event node and add to the list */ > + event_node->event = watch->event; > + event_node->channel = watch->channel; > + INIT_LIST_HEAD(&event_node->comp_list); > + list_add(&event_node->l, &counter->next_events_list); > + } > + > + /* Check if component watch has already been set before */ > + list_for_each_entry(comp_node, &event_node->comp_list, l) > + if (comp_node->parent == cfg->parent && > + comp_node->comp.count_u8_read == cfg->comp.count_u8_read) > + return -EINVAL; > + > + /* Allocate component node */ > + comp_node = kmalloc(sizeof(*comp_node), GFP_ATOMIC); > + if (!comp_node) { > + /* Free event node if no one else is watching */ > + if (list_empty(&event_node->comp_list)) { > + list_del(&event_node->l); > + kfree(event_node); > + } > + return -ENOMEM; > + } > + *comp_node = *cfg; > + > + /* Add component node to event node */ > + list_add_tail(&comp_node->l, &event_node->comp_list); > + > + return 0; > +} > + > +static int counter_clear_watches(struct counter_device *const counter) > +{ > + unsigned long flags; > + int err = 0; > + > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > + > + counter_events_list_free(&counter->events_list); > + > + if (counter->ops->events_configure) > + err = counter->ops->events_configure(counter); > + > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > + > + counter_events_list_free(&counter->next_events_list); > + > + return err; > +} > + > +static int counter_add_watch(struct counter_device *const counter, > + const unsigned long arg) > +{ > + void __user *const uwatch = (void __user *)arg; > + struct counter_watch watch; > + struct counter_comp_node comp_node = {0}; > + size_t parent, id; > + struct counter_comp *ext; > + size_t num_ext; > + int err; > + > + if (copy_from_user(&watch, uwatch, sizeof(watch))) > + return -EFAULT; > + > + if (watch.component.type == COUNTER_COMPONENT_NONE) > + goto no_component; > + > + parent = watch.component.parent; > + > + /* Configure parent component info for comp node */ > + switch (watch.component.scope) { > + case COUNTER_SCOPE_DEVICE: > + ext = counter->ext; > + num_ext = counter->num_ext; > + break; > + case COUNTER_SCOPE_SIGNAL: > + if (parent >= counter->num_signals) > + return -EINVAL; > + parent = array_index_nospec(parent, counter->num_signals); > + > + comp_node.parent = counter->signals + parent; > + > + ext = counter->signals[parent].ext; > + num_ext = counter->signals[parent].num_ext; > + break; > + case COUNTER_SCOPE_COUNT: > + if (parent >= counter->num_counts) > + return -EINVAL; > + parent = array_index_nospec(parent, counter->num_counts); > + > + comp_node.parent = counter->counts + parent; > + > + ext = counter->counts[parent].ext; > + num_ext = counter->counts[parent].num_ext; > + break; > + } > + > + id = watch.component.id; > + > + /* Configure component info for comp node */ > + switch (watch.component.type) { > + case COUNTER_COMPONENT_SIGNAL: > + if (watch.component.scope != COUNTER_SCOPE_SIGNAL) > + return -EINVAL; > + > + comp_node.comp.type = COUNTER_COMP_SIGNAL_LEVEL; > + comp_node.comp.signal_u32_read = counter->ops->signal_read; > + break; > + case COUNTER_COMPONENT_COUNT: > + if (watch.component.scope != COUNTER_SCOPE_COUNT) > + return -EINVAL; > + > + comp_node.comp.type = COUNTER_COMP_U64; > + comp_node.comp.count_u64_read = counter->ops->count_read; > + break; > + case COUNTER_COMPONENT_FUNCTION: > + if (watch.component.scope != COUNTER_SCOPE_COUNT) > + return -EINVAL; > + > + comp_node.comp.type = COUNTER_COMP_FUNCTION; > + comp_node.comp.count_u32_read = counter->ops->function_read; > + break; > + case COUNTER_COMPONENT_SYNAPSE_ACTION: > + if (watch.component.scope != COUNTER_SCOPE_COUNT) > + return -EINVAL; > + if (id >= counter->counts[parent].num_synapses) > + return -EINVAL; > + id = array_index_nospec(id, counter->counts[parent].num_synapses); > + > + comp_node.comp.type = COUNTER_COMP_SYNAPSE_ACTION; > + comp_node.comp.action_read = counter->ops->action_read; > + comp_node.comp.priv = counter->counts[parent].synapses + id; > + break; > + case COUNTER_COMPONENT_EXTENSION: > + if (id >= num_ext) > + return -EINVAL; > + id = array_index_nospec(id, num_ext); > + > + comp_node.comp = ext[id]; > + break; > + default: > + return -EINVAL; > + } > + /* Check if any read callback is set; this is part of a union */ > + if (!comp_node.comp.count_u8_read) > + return -EOPNOTSUPP; > + > +no_component: > + if (counter->ops->watch_validate) { > + err = counter->ops->watch_validate(counter, &watch); > + if (err < 0) > + return err; > + } > + > + comp_node.component = watch.component; > + > + return counter_set_event_node(counter, &watch, &comp_node); > +} > + > +static long counter_chrdev_ioctl(struct file *filp, unsigned int cmd, > + unsigned long arg) > +{ > + struct counter_device *const counter = filp->private_data; > + unsigned long flags; > + int err = 0; > + > + switch (cmd) { > + case COUNTER_CLEAR_WATCHES_IOCTL: > + return counter_clear_watches(counter); > + case COUNTER_ADD_WATCH_IOCTL: > + return counter_add_watch(counter, arg); > + case COUNTER_LOAD_WATCHES_IOCTL: > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > + > + counter_events_list_free(&counter->events_list); > + list_replace_init(&counter->next_events_list, > + &counter->events_list); > + > + if (counter->ops->events_configure) > + err = counter->ops->events_configure(counter); > + > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > + break; return here. > + default: > + return -ENOIOCTLCMD; > + } > + > + return err; > +} > + > +static int counter_chrdev_open(struct inode *inode, struct file *filp) > +{ > + struct counter_device *const counter = container_of(inode->i_cdev, > + typeof(*counter), > + chrdev); > + > + get_device(&counter->dev); > + filp->private_data = counter; > + > + return nonseekable_open(inode, filp); > +} > + > +static int counter_chrdev_release(struct inode *inode, struct file *filp) > +{ > + struct counter_device *const counter = filp->private_data; > + int err; > + > + err = counter_clear_watches(counter); > + if (err < 0) > + return err; > + > + put_device(&counter->dev); > + > + return 0; > +} > + > +static const struct file_operations counter_fops = { > + .llseek = no_llseek, > + .read = counter_chrdev_read, > + .poll = counter_chrdev_poll, > + .unlocked_ioctl = counter_chrdev_ioctl, > + .open = counter_chrdev_open, > + .release = counter_chrdev_release, > +}; > + > +int counter_chrdev_add(struct counter_device *const counter, > + const dev_t counter_devt) > +{ > + struct device *const dev = &counter->dev; > + struct cdev *const chrdev = &counter->chrdev; > + > + /* Initialize Counter events lists */ > + INIT_LIST_HEAD(&counter->events_list); > + INIT_LIST_HEAD(&counter->next_events_list); > + raw_spin_lock_init(&counter->events_list_lock); > + > + /* Initialize Counter events queue */ > + INIT_KFIFO(counter->events); > + init_waitqueue_head(&counter->events_wait); > + mutex_init(&counter->events_lock); > + > + /* Initialize character device */ > + cdev_init(chrdev, &counter_fops); > + dev->devt = MKDEV(MAJOR(counter_devt), counter->id); > + cdev_set_parent(chrdev, &dev->kobj); > + > + return cdev_add(chrdev, dev->devt, 1); > +} > + > +void counter_chrdev_remove(struct counter_device *const counter) > +{ > + cdev_del(&counter->chrdev); > +} > + > +static int counter_get_data(struct counter_device *const counter, > + const struct counter_comp_node *const comp_node, > + u64 *const value) > +{ > + const struct counter_comp *const comp = &comp_node->comp; > + void *const parent = comp_node->parent; > + int err = 0; > + u8 value_u8 = 0; > + u32 value_u32 = 0; > + > + if (comp_node->component.type == COUNTER_COMPONENT_NONE) > + return 0; > + > + switch (comp->type) { > + case COUNTER_COMP_U8: > + case COUNTER_COMP_BOOL: > + switch (comp_node->component.scope) { > + case COUNTER_SCOPE_DEVICE: > + err = comp->device_u8_read(counter, &value_u8); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = comp->signal_u8_read(counter, parent, &value_u8); > + break; > + case COUNTER_SCOPE_COUNT: > + err = comp->count_u8_read(counter, parent, &value_u8); > + break; > + } > + *value = value_u8; > + break; > + case COUNTER_COMP_SIGNAL_LEVEL: > + case COUNTER_COMP_FUNCTION: > + case COUNTER_COMP_ENUM: > + case COUNTER_COMP_COUNT_DIRECTION: > + case COUNTER_COMP_COUNT_MODE: > + switch (comp_node->component.scope) { > + case COUNTER_SCOPE_DEVICE: > + err = comp->device_u32_read(counter, &value_u32); > + break; > + case COUNTER_SCOPE_SIGNAL: > + err = comp->signal_u32_read(counter, parent, > + &value_u32); > + break; > + case COUNTER_SCOPE_COUNT: > + err = comp->count_u32_read(counter, parent, &value_u32); > + break; > + } > + *value = value_u32; Seems like a return here would make more sense as no shared stuff to do at end of the switch. Same in other similar cases. > + break; > + case COUNTER_COMP_U64: > + switch (comp_node->component.scope) { > + case COUNTER_SCOPE_DEVICE: > + return comp->device_u64_read(counter, value); > + case COUNTER_SCOPE_SIGNAL: > + return comp->signal_u64_read(counter, parent, value); > + case COUNTER_SCOPE_COUNT: > + return comp->count_u64_read(counter, parent, value); > + } > + break; > + case COUNTER_COMP_SYNAPSE_ACTION: > + err = comp->action_read(counter, parent, comp->priv, > + &value_u32); > + *value = value_u32; > + break; > + } > + > + return err; > +} > + > +/** > + * counter_push_event - queue event for userspace reading > + * @counter: pointer to Counter structure > + * @event: triggered event > + * @channel: event channel > + * > + * Note: If no one is watching for the respective event, it is silently > + * discarded. > + */ > +void counter_push_event(struct counter_device *const counter, const u8 event, > + const u8 channel) > +{ > + struct counter_event ev = {0}; > + unsigned int copied = 0; > + unsigned long flags; > + struct counter_event_node *event_node; > + struct counter_comp_node *comp_node; > + > + ev.timestamp = ktime_get_ns(); > + ev.watch.event = event; > + ev.watch.channel = channel; > + > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); For a raw spin lock, we definitely want to see comments on why it is necessary. > + > + /* Search for event in the list */ > + list_for_each_entry(event_node, &counter->events_list, l) > + if (event_node->event == event && > + event_node->channel == channel) > + break; > + > + /* If event is not in the list */ > + if (&event_node->l == &counter->events_list) > + goto exit_early; > + > + /* Read and queue relevant comp for userspace */ > + list_for_each_entry(comp_node, &event_node->comp_list, l) { > + ev.watch.component = comp_node->component; > + ev.errno = -counter_get_data(counter, comp_node, &ev.value); > + > + copied += kfifo_put(&counter->events, ev); > + } > + > + if (copied) > + wake_up_poll(&counter->events_wait, EPOLLIN); > + > +exit_early: > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > +} > +EXPORT_SYMBOL_GPL(counter_push_event); > diff --git a/drivers/counter/counter-chrdev.h b/drivers/counter/counter-chrdev.h > new file mode 100644 > index 000000000000..cf5a318fe540 > --- /dev/null > +++ b/drivers/counter/counter-chrdev.h > @@ -0,0 +1,16 @@ > +/* SPDX-License-Identifier: GPL-2.0 */ > +/* > + * Counter character device interface > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#ifndef _COUNTER_CHRDEV_H_ > +#define _COUNTER_CHRDEV_H_ > + > +#include <linux/counter.h> > +#include <linux/types.h> > + > +int counter_chrdev_add(struct counter_device *const counter, > + const dev_t counter_devt); > +void counter_chrdev_remove(struct counter_device *const counter); > + > +#endif /* _COUNTER_CHRDEV_H_ */ > diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c > index 78e07588717b..1334e2f4ce4e 100644 > --- a/drivers/counter/counter-core.c > +++ b/drivers/counter/counter-core.c > @@ -5,12 +5,16 @@ > */ > #include <linux/counter.h> > #include <linux/device.h> > +#include <linux/device/bus.h> > #include <linux/export.h> > +#include <linux/fs.h> > #include <linux/gfp.h> > #include <linux/idr.h> > #include <linux/init.h> > #include <linux/module.h> > +#include <linux/types.h> > > +#include "counter-chrdev.h" > #include "counter-sysfs.h" > > /* Provides a unique ID for each counter device */ > @@ -33,6 +37,8 @@ static struct bus_type counter_bus_type = { > .name = "counter" > }; > > +static dev_t counter_devt; > + > /** > * counter_register - register Counter to the system > * @counter: pointer to Counter to register > @@ -51,7 +57,6 @@ int counter_register(struct counter_device *const counter) > if (counter->id < 0) > return counter->id; > > - /* Configure device structure for Counter */ > dev->type = &counter_device_type; > dev->bus = &counter_bus_type; > if (counter->parent) { > @@ -62,18 +67,25 @@ int counter_register(struct counter_device *const counter) > device_initialize(dev); > dev_set_drvdata(dev, counter); > > + /* Add Counter character device */ > + err = counter_chrdev_add(counter, counter_devt); > + if (err) > + goto err_free_id; > + > /* Add Counter sysfs attributes */ > err = counter_sysfs_add(counter); > if (err < 0) > - goto err_free_id; > + goto err_remove_chrdev; > > /* Add device to system */ > err = device_add(dev); > if (err < 0) > - goto err_free_id; > + goto err_remove_chrdev; > > return 0; > > +err_remove_chrdev: > + counter_chrdev_remove(counter); > err_free_id: > put_device(dev); > return err; > @@ -135,13 +147,30 @@ int devm_counter_register(struct device *dev, > } > EXPORT_SYMBOL_GPL(devm_counter_register); > > +#define COUNTER_DEV_MAX 256 > + > static int __init counter_init(void) > { > - return bus_register(&counter_bus_type); > + int err; > + > + err = bus_register(&counter_bus_type); > + if (err < 0) > + return err; > + > + err = alloc_chrdev_region(&counter_devt, 0, COUNTER_DEV_MAX, "counter"); > + if (err < 0) > + goto err_unregister_bus; > + > + return 0; > + > +err_unregister_bus: > + bus_unregister(&counter_bus_type); > + return err; > } > > static void __exit counter_exit(void) > { > + unregister_chrdev_region(counter_devt, COUNTER_DEV_MAX); > bus_unregister(&counter_bus_type); > } > > diff --git a/drivers/counter/counter-sysfs.c b/drivers/counter/counter-sysfs.c > index 654afa91ae9f..4d97d6e50d48 100644 > --- a/drivers/counter/counter-sysfs.c > +++ b/drivers/counter/counter-sysfs.c > @@ -499,6 +499,7 @@ static ssize_t counter_comp_name_show(struct device *dev, > > static int counter_name_attr_create(struct device *const dev, > struct counter_attribute_group *const group, > + const char *const attr_name, > const char *const name) > { > struct counter_attribute *counter_attr; > @@ -513,7 +514,7 @@ static int counter_name_attr_create(struct device *const dev, > > /* Configure device attribute */ > sysfs_attr_init(&counter_attr->dev_attr.attr); > - counter_attr->dev_attr.attr.name = "name"; > + counter_attr->dev_attr.attr.name = attr_name; > counter_attr->dev_attr.attr.mode = 0444; > counter_attr->dev_attr.show = counter_comp_name_show; > > @@ -524,6 +525,18 @@ static int counter_name_attr_create(struct device *const dev, > return 0; > } > > +static int counter_ext_name_attr_create(struct device *const dev, > + struct counter_attribute_group *const group, const size_t i, > + const char *const name) > +{ > + const char *attr_name; > + > + attr_name = devm_kasprintf(dev, GFP_KERNEL, "extension%zu_name", i); > + if (!attr_name) > + return -ENOMEM; > + > + return counter_name_attr_create(dev, group, attr_name, name); > +} > > static struct counter_comp counter_signal_comp = { > .type = COUNTER_COMP_SIGNAL_LEVEL, > @@ -539,6 +552,7 @@ static int counter_signal_attrs_create(struct counter_device *const counter, > int err; > struct counter_comp comp; > size_t i; > + struct counter_comp *ext; > > /* Create main Signal attribute */ > comp = counter_signal_comp; > @@ -548,14 +562,19 @@ static int counter_signal_attrs_create(struct counter_device *const counter, > return err; > > /* Create Signal name attribute */ > - err = counter_name_attr_create(dev, group, signal->name); > + err = counter_name_attr_create(dev, group, "name", signal->name); > if (err < 0) > return err; > > /* Create an attribute for each extension */ > for (i = 0; i < signal->num_ext; i++) { > - err = counter_attr_create(dev, group, signal->ext + i, scope, > - signal); > + ext = signal->ext + i; > + > + err = counter_attr_create(dev, group, ext, scope, signal); > + if (err < 0) > + return err; > + > + err = counter_ext_name_attr_create(dev, group, i, ext->name); > if (err < 0) > return err; > } > @@ -640,6 +659,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, > int err; > struct counter_comp comp; > size_t i; > + struct counter_comp *ext; > > /* Create main Count attribute */ > comp = counter_count_comp; > @@ -650,7 +670,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, > return err; > > /* Create Count name attribute */ > - err = counter_name_attr_create(dev, group, count->name); > + err = counter_name_attr_create(dev, group, "name", count->name); This refactoring could also be pulled out to a precusor patch. > if (err < 0) > return err; > > @@ -664,8 +684,13 @@ static int counter_count_attrs_create(struct counter_device *const counter, > > /* Create an attribute for each extension */ > for (i = 0; i < count->num_ext; i++) { > - err = counter_attr_create(dev, group, count->ext + i, scope, > - count); > + ext = count->ext + i; > + > + err = counter_attr_create(dev, group, ext, scope, count); > + if (err < 0) > + return err; > + > + err = counter_ext_name_attr_create(dev, group, i, ext->name); > if (err < 0) > return err; > } > @@ -729,6 +754,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, > struct device *const dev = &counter->dev; > int err; > size_t i; > + struct counter_comp *ext; > > /* Add Signals sysfs attributes */ > err = counter_sysfs_signals_add(counter, group); > @@ -743,7 +769,7 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, > group += counter->num_counts; > > /* Create name attribute */ > - err = counter_name_attr_create(dev, group, counter->name); > + err = counter_name_attr_create(dev, group, "name", counter->name); > if (err < 0) > return err; > > @@ -761,8 +787,13 @@ static int counter_sysfs_attr_add(struct counter_device *const counter, > > /* Create an attribute for each extension */ > for (i = 0; i < counter->num_ext; i++) { > - err = counter_attr_create(dev, group, counter->ext + i, scope, > - NULL); > + ext = counter->ext + i; > + > + err = counter_attr_create(dev, group, ext, scope, NULL); > + if (err < 0) > + return err; > + > + err = counter_ext_name_attr_create(dev, group, i, ext->name); > if (err < 0) > return err; > } > diff --git a/include/linux/counter.h b/include/linux/counter.h > index 2f01e1fec857..ce79e62a2e58 100644 > --- a/include/linux/counter.h > +++ b/include/linux/counter.h > @@ -6,9 +6,15 @@ > #ifndef _COUNTER_H_ > #define _COUNTER_H_ > > +#include <linux/cdev.h> > #include <linux/device.h> > #include <linux/kernel.h> > +#include <linux/kfifo.h> > +#include <linux/mutex.h> > +#include <linux/spinlock_types.h> > #include <linux/types.h> > +#include <linux/wait.h> > +#include <uapi/linux/counter.h> > > struct counter_device; > struct counter_count; > @@ -27,47 +33,6 @@ enum counter_comp_type { > COUNTER_COMP_COUNT_MODE, > }; > > -enum counter_scope { > - COUNTER_SCOPE_DEVICE, > - COUNTER_SCOPE_SIGNAL, > - COUNTER_SCOPE_COUNT, > -}; > - > -enum counter_count_direction { > - COUNTER_COUNT_DIRECTION_FORWARD, > - COUNTER_COUNT_DIRECTION_BACKWARD, > -}; > - > -enum counter_count_mode { > - COUNTER_COUNT_MODE_NORMAL, > - COUNTER_COUNT_MODE_RANGE_LIMIT, > - COUNTER_COUNT_MODE_NON_RECYCLE, > - COUNTER_COUNT_MODE_MODULO_N, > -}; > - > -enum counter_function { > - COUNTER_FUNCTION_INCREASE, > - COUNTER_FUNCTION_DECREASE, > - COUNTER_FUNCTION_PULSE_DIRECTION, > - COUNTER_FUNCTION_QUADRATURE_X1_A, > - COUNTER_FUNCTION_QUADRATURE_X1_B, > - COUNTER_FUNCTION_QUADRATURE_X2_A, > - COUNTER_FUNCTION_QUADRATURE_X2_B, > - COUNTER_FUNCTION_QUADRATURE_X4, > -}; > - > -enum counter_signal_level { > - COUNTER_SIGNAL_LEVEL_LOW, > - COUNTER_SIGNAL_LEVEL_HIGH, > -}; > - > -enum counter_synapse_action { > - COUNTER_SYNAPSE_ACTION_NONE, > - COUNTER_SYNAPSE_ACTION_RISING_EDGE, > - COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > - COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > -}; > - > /** > * struct counter_comp - Counter component node > * @type: Counter component data type > @@ -239,6 +204,20 @@ struct counter_count { > size_t num_ext; > }; > > +/** > + * struct counter_event_node - Counter Event node > + * @l: list of current watching Counter events > + * @event: event that triggers > + * @channel: event channel > + * @comp_list: list of components to watch when event triggers > + */ > +struct counter_event_node { > + struct list_head l; > + u8 event; > + u8 channel; > + struct list_head comp_list; > +}; > + > /** > * struct counter_ops - Callbacks from driver > * @signal_read: read callback for Signals. The read level of the > @@ -261,6 +240,13 @@ struct counter_count { > * @action_write: write callback for Synapse action modes. The action mode > * to write for the respective Synapse is passed in via the > * action parameter. > + * @events_configure: write callback to configure events. The list of struct > + * counter_event_node may be accessed via the events_list > + * member of the counter parameter. > + * @watch_validate: callback to validate a watch. The Counter component > + * watch configuration is passed in via the watch > + * parameter. A return value of 0 indicates a valid Counter > + * component watch configuration. > */ > struct counter_ops { > int (*signal_read)(struct counter_device *counter, > @@ -284,6 +270,9 @@ struct counter_ops { > struct counter_count *count, > struct counter_synapse *synapse, > enum counter_synapse_action action); > + int (*events_configure)(struct counter_device *counter); > + int (*watch_validate)(struct counter_device *counter, > + const struct counter_watch *watch); > }; > > /** > @@ -300,6 +289,13 @@ struct counter_ops { > * @priv: optional private data supplied by driver > * @id: unique ID used to identify the Counter > * @dev: internal device structure > + * @chrdev: internal character device structure > + * @events_list: list of current watching Counter events > + * @events_list_lock: lock to protect Counter events list operations > + * @next_events_list: list of next watching Counter events > + * @events: queue of detected Counter events > + * @events_wait: wait queue to allow blocking reads of Counter events > + * @events_lock: lock to protect Counter events queue read operations > */ > struct counter_device { > const char *name; > @@ -319,12 +315,21 @@ struct counter_device { > > int id; > struct device dev; > + struct cdev chrdev; > + struct list_head events_list; > + raw_spinlock_t events_list_lock; > + struct list_head next_events_list; > + DECLARE_KFIFO(events, struct counter_event, 64); Why 64? Probably want that to be somewhat dynamic, even if only at build time. > + wait_queue_head_t events_wait; > + struct mutex events_lock; > }; > > int counter_register(struct counter_device *const counter); > void counter_unregister(struct counter_device *const counter); > int devm_counter_register(struct device *dev, > struct counter_device *const counter); > +void counter_push_event(struct counter_device *const counter, const u8 event, > + const u8 channel); > > #define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ > { \ > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > new file mode 100644 > index 000000000000..7585dc9db19d > --- /dev/null > +++ b/include/uapi/linux/counter.h Small thing but I would have been tempted to do a precursor patch to the main change simply putting in place the userspace header. Classic Nop patch that makes it easier to focus on the real stuff in this patch by getting that noise out of the way! Jonathan > @@ -0,0 +1,123 @@ > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ > +/* > + * Userspace ABI for Counter character devices > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#ifndef _UAPI_COUNTER_H_ > +#define _UAPI_COUNTER_H_ > + > +#include <linux/ioctl.h> > +#include <linux/types.h> > + > +/* Component type definitions */ > +enum counter_component_type { > + COUNTER_COMPONENT_NONE, > + COUNTER_COMPONENT_SIGNAL, > + COUNTER_COMPONENT_COUNT, > + COUNTER_COMPONENT_FUNCTION, > + COUNTER_COMPONENT_SYNAPSE_ACTION, > + COUNTER_COMPONENT_EXTENSION, > +}; > + > +/* Component scope definitions */ > +enum counter_scope { > + COUNTER_SCOPE_DEVICE, > + COUNTER_SCOPE_SIGNAL, > + COUNTER_SCOPE_COUNT, > +}; > + > +/** > + * struct counter_component - Counter component identification > + * @type: component type (Count, extension, etc.) > + * @scope: component scope (Device, Count, or Signal) > + * @parent: parent component identification number > + * @id: component identification number > + */ > +struct counter_component { > + __u8 type; > + __u8 scope; > + __u8 parent; > + __u8 id; > +}; > + > +/* Event type definitions */ > +enum counter_event_type { > + COUNTER_EVENT_OVERFLOW, > + COUNTER_EVENT_UNDERFLOW, > + COUNTER_EVENT_OVERFLOW_UNDERFLOW, > + COUNTER_EVENT_THRESHOLD, > + COUNTER_EVENT_INDEX, > +}; > + > +/** > + * struct counter_watch - Counter component watch configuration > + * @component: component to watch when event triggers > + * @event: event that triggers > + * @channel: event channel > + */ > +struct counter_watch { > + struct counter_component component; > + __u8 event; > + __u8 channel; > +}; > + > +/* ioctl commands */ > +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) > +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) > +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) > + > +/** > + * struct counter_event - Counter event data > + * @timestamp: best estimate of time of event occurrence, in nanoseconds > + * @value: component value > + * @watch: component watch configuration > + * @errno: system error number > + */ > +struct counter_event { > + __aligned_u64 timestamp; > + __aligned_u64 value; > + struct counter_watch watch; > + __u8 errno; > +}; > + > +/* Count direction values */ > +enum counter_count_direction { > + COUNTER_COUNT_DIRECTION_FORWARD, > + COUNTER_COUNT_DIRECTION_BACKWARD, > +}; > + > +/* Count mode values */ > +enum counter_count_mode { > + COUNTER_COUNT_MODE_NORMAL, > + COUNTER_COUNT_MODE_RANGE_LIMIT, > + COUNTER_COUNT_MODE_NON_RECYCLE, > + COUNTER_COUNT_MODE_MODULO_N, > +}; > + > +/* Count function values */ > +enum counter_function { > + COUNTER_FUNCTION_INCREASE, > + COUNTER_FUNCTION_DECREASE, > + COUNTER_FUNCTION_PULSE_DIRECTION, > + COUNTER_FUNCTION_QUADRATURE_X1_A, > + COUNTER_FUNCTION_QUADRATURE_X1_B, > + COUNTER_FUNCTION_QUADRATURE_X2_A, > + COUNTER_FUNCTION_QUADRATURE_X2_B, > + COUNTER_FUNCTION_QUADRATURE_X4, > +}; > + > +/* Signal values */ > +enum counter_signal_level { > + COUNTER_SIGNAL_LEVEL_LOW, > + COUNTER_SIGNAL_LEVEL_HIGH, > +}; > + > +/* Action mode values */ > +enum counter_synapse_action { > + COUNTER_SYNAPSE_ACTION_NONE, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > +}; > + > +#endif /* _UAPI_COUNTER_H_ */ _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface 2020-12-30 15:04 ` Jonathan Cameron @ 2021-02-12 6:32 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-02-12 6:32 UTC (permalink / raw) To: Jonathan Cameron Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter [-- Attachment #1: Type: text/plain, Size: 7511 bytes --] On Wed, Dec 30, 2020 at 03:04:40PM +0000, Jonathan Cameron wrote: > On Fri, 25 Dec 2020 19:15:36 -0500 > William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > > > This patch introduces a character device interface for the Counter > > subsystem. Device data is exposed through standard character device read > > operations. Device data is gathered when a Counter event is pushed by > > the respective Counter device driver. Configuration is handled via ioctl > > operations on the respective Counter character device node. > > > > Cc: David Lechner <david@lechnology.com> > > Cc: Gwendal Grignou <gwendal@chromium.org> > > Cc: Dan Carpenter <dan.carpenter@oracle.com> > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > > There are a few things in here that could profitably be pulled out as precursor > patches. I don't really understand the connection of extension_name to the > addition of a chardev for example. Might be needed to provide enough > info to actually use the chardev, but does it have meaning without that? > Either way, definitely feels like it can be done in a separate patch. The extension_name attributes are needed so chrdev users have enough info to identify which extension number corresponds to which extension. I'll move this to change to a separate patch and provide an appropriate explanation there to make things clearer. > > +static long counter_chrdev_ioctl(struct file *filp, unsigned int cmd, > > + unsigned long arg) > > +{ > > + struct counter_device *const counter = filp->private_data; > > + unsigned long flags; > > + int err = 0; > > + > > + switch (cmd) { > > + case COUNTER_CLEAR_WATCHES_IOCTL: > > + return counter_clear_watches(counter); > > + case COUNTER_ADD_WATCH_IOCTL: > > + return counter_add_watch(counter, arg); > > + case COUNTER_LOAD_WATCHES_IOCTL: > > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > > + > > + counter_events_list_free(&counter->events_list); > > + list_replace_init(&counter->next_events_list, > > + &counter->events_list); > > + > > + if (counter->ops->events_configure) > > + err = counter->ops->events_configure(counter); > > + > > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > > + break; > > return here. Ack. > > +static int counter_get_data(struct counter_device *const counter, > > + const struct counter_comp_node *const comp_node, > > + u64 *const value) > > +{ > > + const struct counter_comp *const comp = &comp_node->comp; > > + void *const parent = comp_node->parent; > > + int err = 0; > > + u8 value_u8 = 0; > > + u32 value_u32 = 0; > > + > > + if (comp_node->component.type == COUNTER_COMPONENT_NONE) > > + return 0; > > + > > + switch (comp->type) { > > + case COUNTER_COMP_U8: > > + case COUNTER_COMP_BOOL: > > + switch (comp_node->component.scope) { > > + case COUNTER_SCOPE_DEVICE: > > + err = comp->device_u8_read(counter, &value_u8); > > + break; > > + case COUNTER_SCOPE_SIGNAL: > > + err = comp->signal_u8_read(counter, parent, &value_u8); > > + break; > > + case COUNTER_SCOPE_COUNT: > > + err = comp->count_u8_read(counter, parent, &value_u8); > > + break; > > + } > > + *value = value_u8; > > + break; > > + case COUNTER_COMP_SIGNAL_LEVEL: > > + case COUNTER_COMP_FUNCTION: > > + case COUNTER_COMP_ENUM: > > + case COUNTER_COMP_COUNT_DIRECTION: > > + case COUNTER_COMP_COUNT_MODE: > > + switch (comp_node->component.scope) { > > + case COUNTER_SCOPE_DEVICE: > > + err = comp->device_u32_read(counter, &value_u32); > > + break; > > + case COUNTER_SCOPE_SIGNAL: > > + err = comp->signal_u32_read(counter, parent, > > + &value_u32); > > + break; > > + case COUNTER_SCOPE_COUNT: > > + err = comp->count_u32_read(counter, parent, &value_u32); > > + break; > > + } > > + *value = value_u32; > > Seems like a return here would make more sense as no shared stuff to do at > end of the switch. Same in other similar cases. Ack. > > + break; > > + case COUNTER_COMP_U64: > > + switch (comp_node->component.scope) { > > + case COUNTER_SCOPE_DEVICE: > > + return comp->device_u64_read(counter, value); > > + case COUNTER_SCOPE_SIGNAL: > > + return comp->signal_u64_read(counter, parent, value); > > + case COUNTER_SCOPE_COUNT: > > + return comp->count_u64_read(counter, parent, value); > > + } > > + break; > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + err = comp->action_read(counter, parent, comp->priv, > > + &value_u32); > > + *value = value_u32; > > + break; > > + } > > + > > + return err; > > +} > > + > > +/** > > + * counter_push_event - queue event for userspace reading > > + * @counter: pointer to Counter structure > > + * @event: triggered event > > + * @channel: event channel > > + * > > + * Note: If no one is watching for the respective event, it is silently > > + * discarded. > > + */ > > +void counter_push_event(struct counter_device *const counter, const u8 event, > > + const u8 channel) > > +{ > > + struct counter_event ev = {0}; > > + unsigned int copied = 0; > > + unsigned long flags; > > + struct counter_event_node *event_node; > > + struct counter_comp_node *comp_node; > > + > > + ev.timestamp = ktime_get_ns(); > > + ev.watch.event = event; > > + ev.watch.channel = channel; > > + > > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > > For a raw spin lock, we definitely want to see comments on why it > is necessary. Ack. > > @@ -650,7 +670,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, > > return err; > > > > /* Create Count name attribute */ > > - err = counter_name_attr_create(dev, group, count->name); > > + err = counter_name_attr_create(dev, group, "name", count->name); > > This refactoring could also be pulled out to a precusor patch. Ack. This will be part of the extension_name patch. > > @@ -319,12 +315,21 @@ struct counter_device { > > > > int id; > > struct device dev; > > + struct cdev chrdev; > > + struct list_head events_list; > > + raw_spinlock_t events_list_lock; > > + struct list_head next_events_list; > > + DECLARE_KFIFO(events, struct counter_event, 64); > > Why 64? Probably want that to be somewhat dynamic, even if only at build time. Ack. This will be dynamically configurable via sysfs attribute in v8. > > + wait_queue_head_t events_wait; > > + struct mutex events_lock; > > }; > > > > int counter_register(struct counter_device *const counter); > > void counter_unregister(struct counter_device *const counter); > > int devm_counter_register(struct device *dev, > > struct counter_device *const counter); > > +void counter_push_event(struct counter_device *const counter, const u8 event, > > + const u8 channel); > > > > #define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ > > { \ > > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > > new file mode 100644 > > index 000000000000..7585dc9db19d > > --- /dev/null > > +++ b/include/uapi/linux/counter.h > Small thing but I would have been tempted to do a precursor patch to the > main change simply putting in place the userspace header. > > Classic Nop patch that makes it easier to focus on the real stuff in this > patch by getting that noise out of the way! > > Jonathan Ack. William Breathitt Gray [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface @ 2021-02-12 6:32 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-02-12 6:32 UTC (permalink / raw) To: Jonathan Cameron Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, Dan Carpenter, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue [-- Attachment #1.1: Type: text/plain, Size: 7511 bytes --] On Wed, Dec 30, 2020 at 03:04:40PM +0000, Jonathan Cameron wrote: > On Fri, 25 Dec 2020 19:15:36 -0500 > William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > > > This patch introduces a character device interface for the Counter > > subsystem. Device data is exposed through standard character device read > > operations. Device data is gathered when a Counter event is pushed by > > the respective Counter device driver. Configuration is handled via ioctl > > operations on the respective Counter character device node. > > > > Cc: David Lechner <david@lechnology.com> > > Cc: Gwendal Grignou <gwendal@chromium.org> > > Cc: Dan Carpenter <dan.carpenter@oracle.com> > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > > There are a few things in here that could profitably be pulled out as precursor > patches. I don't really understand the connection of extension_name to the > addition of a chardev for example. Might be needed to provide enough > info to actually use the chardev, but does it have meaning without that? > Either way, definitely feels like it can be done in a separate patch. The extension_name attributes are needed so chrdev users have enough info to identify which extension number corresponds to which extension. I'll move this to change to a separate patch and provide an appropriate explanation there to make things clearer. > > +static long counter_chrdev_ioctl(struct file *filp, unsigned int cmd, > > + unsigned long arg) > > +{ > > + struct counter_device *const counter = filp->private_data; > > + unsigned long flags; > > + int err = 0; > > + > > + switch (cmd) { > > + case COUNTER_CLEAR_WATCHES_IOCTL: > > + return counter_clear_watches(counter); > > + case COUNTER_ADD_WATCH_IOCTL: > > + return counter_add_watch(counter, arg); > > + case COUNTER_LOAD_WATCHES_IOCTL: > > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > > + > > + counter_events_list_free(&counter->events_list); > > + list_replace_init(&counter->next_events_list, > > + &counter->events_list); > > + > > + if (counter->ops->events_configure) > > + err = counter->ops->events_configure(counter); > > + > > + raw_spin_unlock_irqrestore(&counter->events_list_lock, flags); > > + break; > > return here. Ack. > > +static int counter_get_data(struct counter_device *const counter, > > + const struct counter_comp_node *const comp_node, > > + u64 *const value) > > +{ > > + const struct counter_comp *const comp = &comp_node->comp; > > + void *const parent = comp_node->parent; > > + int err = 0; > > + u8 value_u8 = 0; > > + u32 value_u32 = 0; > > + > > + if (comp_node->component.type == COUNTER_COMPONENT_NONE) > > + return 0; > > + > > + switch (comp->type) { > > + case COUNTER_COMP_U8: > > + case COUNTER_COMP_BOOL: > > + switch (comp_node->component.scope) { > > + case COUNTER_SCOPE_DEVICE: > > + err = comp->device_u8_read(counter, &value_u8); > > + break; > > + case COUNTER_SCOPE_SIGNAL: > > + err = comp->signal_u8_read(counter, parent, &value_u8); > > + break; > > + case COUNTER_SCOPE_COUNT: > > + err = comp->count_u8_read(counter, parent, &value_u8); > > + break; > > + } > > + *value = value_u8; > > + break; > > + case COUNTER_COMP_SIGNAL_LEVEL: > > + case COUNTER_COMP_FUNCTION: > > + case COUNTER_COMP_ENUM: > > + case COUNTER_COMP_COUNT_DIRECTION: > > + case COUNTER_COMP_COUNT_MODE: > > + switch (comp_node->component.scope) { > > + case COUNTER_SCOPE_DEVICE: > > + err = comp->device_u32_read(counter, &value_u32); > > + break; > > + case COUNTER_SCOPE_SIGNAL: > > + err = comp->signal_u32_read(counter, parent, > > + &value_u32); > > + break; > > + case COUNTER_SCOPE_COUNT: > > + err = comp->count_u32_read(counter, parent, &value_u32); > > + break; > > + } > > + *value = value_u32; > > Seems like a return here would make more sense as no shared stuff to do at > end of the switch. Same in other similar cases. Ack. > > + break; > > + case COUNTER_COMP_U64: > > + switch (comp_node->component.scope) { > > + case COUNTER_SCOPE_DEVICE: > > + return comp->device_u64_read(counter, value); > > + case COUNTER_SCOPE_SIGNAL: > > + return comp->signal_u64_read(counter, parent, value); > > + case COUNTER_SCOPE_COUNT: > > + return comp->count_u64_read(counter, parent, value); > > + } > > + break; > > + case COUNTER_COMP_SYNAPSE_ACTION: > > + err = comp->action_read(counter, parent, comp->priv, > > + &value_u32); > > + *value = value_u32; > > + break; > > + } > > + > > + return err; > > +} > > + > > +/** > > + * counter_push_event - queue event for userspace reading > > + * @counter: pointer to Counter structure > > + * @event: triggered event > > + * @channel: event channel > > + * > > + * Note: If no one is watching for the respective event, it is silently > > + * discarded. > > + */ > > +void counter_push_event(struct counter_device *const counter, const u8 event, > > + const u8 channel) > > +{ > > + struct counter_event ev = {0}; > > + unsigned int copied = 0; > > + unsigned long flags; > > + struct counter_event_node *event_node; > > + struct counter_comp_node *comp_node; > > + > > + ev.timestamp = ktime_get_ns(); > > + ev.watch.event = event; > > + ev.watch.channel = channel; > > + > > + raw_spin_lock_irqsave(&counter->events_list_lock, flags); > > For a raw spin lock, we definitely want to see comments on why it > is necessary. Ack. > > @@ -650,7 +670,7 @@ static int counter_count_attrs_create(struct counter_device *const counter, > > return err; > > > > /* Create Count name attribute */ > > - err = counter_name_attr_create(dev, group, count->name); > > + err = counter_name_attr_create(dev, group, "name", count->name); > > This refactoring could also be pulled out to a precusor patch. Ack. This will be part of the extension_name patch. > > @@ -319,12 +315,21 @@ struct counter_device { > > > > int id; > > struct device dev; > > + struct cdev chrdev; > > + struct list_head events_list; > > + raw_spinlock_t events_list_lock; > > + struct list_head next_events_list; > > + DECLARE_KFIFO(events, struct counter_event, 64); > > Why 64? Probably want that to be somewhat dynamic, even if only at build time. Ack. This will be dynamically configurable via sysfs attribute in v8. > > + wait_queue_head_t events_wait; > > + struct mutex events_lock; > > }; > > > > int counter_register(struct counter_device *const counter); > > void counter_unregister(struct counter_device *const counter); > > int devm_counter_register(struct device *dev, > > struct counter_device *const counter); > > +void counter_push_event(struct counter_device *const counter, const u8 event, > > + const u8 channel); > > > > #define COUNTER_COMP_DEVICE_U8(_name, _read, _write) \ > > { \ > > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > > new file mode 100644 > > index 000000000000..7585dc9db19d > > --- /dev/null > > +++ b/include/uapi/linux/counter.h > Small thing but I would have been tempted to do a precursor patch to the > main change simply putting in place the userspace header. > > Classic Nop patch that makes it easier to focus on the real stuff in this > patch by getting that noise out of the way! > > Jonathan Ack. William Breathitt Gray [-- Attachment #1.2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] [-- Attachment #2: Type: text/plain, Size: 176 bytes --] _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 21:36 ` David Lechner -1 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 21:36 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter On 12/25/20 6:15 PM, William Breathitt Gray wrote: > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > new file mode 100644 > index 000000000000..7585dc9db19d > --- /dev/null > +++ b/include/uapi/linux/counter.h > @@ -0,0 +1,123 @@ > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ > +/* > + * Userspace ABI for Counter character devices > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#ifndef _UAPI_COUNTER_H_ > +#define _UAPI_COUNTER_H_ > + > +#include <linux/ioctl.h> > +#include <linux/types.h> > + > +/* Component type definitions */ > +enum counter_component_type { > + COUNTER_COMPONENT_NONE, > + COUNTER_COMPONENT_SIGNAL, > + COUNTER_COMPONENT_COUNT, > + COUNTER_COMPONENT_FUNCTION, > + COUNTER_COMPONENT_SYNAPSE_ACTION, > + COUNTER_COMPONENT_EXTENSION, > +}; > + > +/* Component scope definitions */ > +enum counter_scope { Do we need COUNTER_SCOPE_NONE to go with COUNTER_COMPONENT_NONE? > + COUNTER_SCOPE_DEVICE, > + COUNTER_SCOPE_SIGNAL, > + COUNTER_SCOPE_COUNT, > +}; > + > +/** > + * struct counter_component - Counter component identification > + * @type: component type (Count, extension, etc.) Instead of "Count, extension, etc.", it could be more helpful to say one of enum counter_component_type. > + * @scope: component scope (Device, Count, or Signal) Same here. @scope must be one of enum counter_scope. > + * @parent: parent component identification number > + * @id: component identification number It could be helpful to say that these id numbers match the X/Y/Z in the sysfs paths as described in the sysfs ABI. > + */ > +struct counter_component { > + __u8 type; > + __u8 scope; > + __u8 parent; > + __u8 id; > +}; > + > +/* Event type definitions */ > +enum counter_event_type { > + COUNTER_EVENT_OVERFLOW, > + COUNTER_EVENT_UNDERFLOW, > + COUNTER_EVENT_OVERFLOW_UNDERFLOW, > + COUNTER_EVENT_THRESHOLD, > + COUNTER_EVENT_INDEX, > +}; > + > +/** > + * struct counter_watch - Counter component watch configuration > + * @component: component to watch when event triggers > + * @event: event that triggers It would be helpful to say that @event must be one of enum counter_event_type. > + * @channel: event channel It would be useful to say that @channel should be 0 unless a component has more than one event of the same type. > + */ > +struct counter_watch { > + struct counter_component component; > + __u8 event; > + __u8 channel; > +}; > + > +/* ioctl commands */ > +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) > +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) > +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) > + > +/** > + * struct counter_event - Counter event data > + * @timestamp: best estimate of time of event occurrence, in nanoseconds > + * @value: component value > + * @watch: component watch configuration > + * @errno: system error number > + */ > +struct counter_event { > + __aligned_u64 timestamp; > + __aligned_u64 value; > + struct counter_watch watch; > + __u8 errno; There are error codes larger than 255. Probably better make this __u32. > +}; > + > +/* Count direction values */ > +enum counter_count_direction { > + COUNTER_COUNT_DIRECTION_FORWARD, > + COUNTER_COUNT_DIRECTION_BACKWARD, > +}; > + > +/* Count mode values */ > +enum counter_count_mode { > + COUNTER_COUNT_MODE_NORMAL, > + COUNTER_COUNT_MODE_RANGE_LIMIT, > + COUNTER_COUNT_MODE_NON_RECYCLE, > + COUNTER_COUNT_MODE_MODULO_N, > +}; > + > +/* Count function values */ > +enum counter_function { > + COUNTER_FUNCTION_INCREASE, > + COUNTER_FUNCTION_DECREASE, > + COUNTER_FUNCTION_PULSE_DIRECTION, > + COUNTER_FUNCTION_QUADRATURE_X1_A, > + COUNTER_FUNCTION_QUADRATURE_X1_B, > + COUNTER_FUNCTION_QUADRATURE_X2_A, > + COUNTER_FUNCTION_QUADRATURE_X2_B, > + COUNTER_FUNCTION_QUADRATURE_X4, > +}; > + > +/* Signal values */ > +enum counter_signal_level { > + COUNTER_SIGNAL_LEVEL_LOW, > + COUNTER_SIGNAL_LEVEL_HIGH, > +}; > + > +/* Action mode values */ > +enum counter_synapse_action { > + COUNTER_SYNAPSE_ACTION_NONE, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > +}; > + > +#endif /* _UAPI_COUNTER_H_ */ > ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface @ 2020-12-30 21:36 ` David Lechner 0 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 21:36 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, Dan Carpenter, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > new file mode 100644 > index 000000000000..7585dc9db19d > --- /dev/null > +++ b/include/uapi/linux/counter.h > @@ -0,0 +1,123 @@ > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ > +/* > + * Userspace ABI for Counter character devices > + * Copyright (C) 2020 William Breathitt Gray > + */ > +#ifndef _UAPI_COUNTER_H_ > +#define _UAPI_COUNTER_H_ > + > +#include <linux/ioctl.h> > +#include <linux/types.h> > + > +/* Component type definitions */ > +enum counter_component_type { > + COUNTER_COMPONENT_NONE, > + COUNTER_COMPONENT_SIGNAL, > + COUNTER_COMPONENT_COUNT, > + COUNTER_COMPONENT_FUNCTION, > + COUNTER_COMPONENT_SYNAPSE_ACTION, > + COUNTER_COMPONENT_EXTENSION, > +}; > + > +/* Component scope definitions */ > +enum counter_scope { Do we need COUNTER_SCOPE_NONE to go with COUNTER_COMPONENT_NONE? > + COUNTER_SCOPE_DEVICE, > + COUNTER_SCOPE_SIGNAL, > + COUNTER_SCOPE_COUNT, > +}; > + > +/** > + * struct counter_component - Counter component identification > + * @type: component type (Count, extension, etc.) Instead of "Count, extension, etc.", it could be more helpful to say one of enum counter_component_type. > + * @scope: component scope (Device, Count, or Signal) Same here. @scope must be one of enum counter_scope. > + * @parent: parent component identification number > + * @id: component identification number It could be helpful to say that these id numbers match the X/Y/Z in the sysfs paths as described in the sysfs ABI. > + */ > +struct counter_component { > + __u8 type; > + __u8 scope; > + __u8 parent; > + __u8 id; > +}; > + > +/* Event type definitions */ > +enum counter_event_type { > + COUNTER_EVENT_OVERFLOW, > + COUNTER_EVENT_UNDERFLOW, > + COUNTER_EVENT_OVERFLOW_UNDERFLOW, > + COUNTER_EVENT_THRESHOLD, > + COUNTER_EVENT_INDEX, > +}; > + > +/** > + * struct counter_watch - Counter component watch configuration > + * @component: component to watch when event triggers > + * @event: event that triggers It would be helpful to say that @event must be one of enum counter_event_type. > + * @channel: event channel It would be useful to say that @channel should be 0 unless a component has more than one event of the same type. > + */ > +struct counter_watch { > + struct counter_component component; > + __u8 event; > + __u8 channel; > +}; > + > +/* ioctl commands */ > +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) > +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) > +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) > + > +/** > + * struct counter_event - Counter event data > + * @timestamp: best estimate of time of event occurrence, in nanoseconds > + * @value: component value > + * @watch: component watch configuration > + * @errno: system error number > + */ > +struct counter_event { > + __aligned_u64 timestamp; > + __aligned_u64 value; > + struct counter_watch watch; > + __u8 errno; There are error codes larger than 255. Probably better make this __u32. > +}; > + > +/* Count direction values */ > +enum counter_count_direction { > + COUNTER_COUNT_DIRECTION_FORWARD, > + COUNTER_COUNT_DIRECTION_BACKWARD, > +}; > + > +/* Count mode values */ > +enum counter_count_mode { > + COUNTER_COUNT_MODE_NORMAL, > + COUNTER_COUNT_MODE_RANGE_LIMIT, > + COUNTER_COUNT_MODE_NON_RECYCLE, > + COUNTER_COUNT_MODE_MODULO_N, > +}; > + > +/* Count function values */ > +enum counter_function { > + COUNTER_FUNCTION_INCREASE, > + COUNTER_FUNCTION_DECREASE, > + COUNTER_FUNCTION_PULSE_DIRECTION, > + COUNTER_FUNCTION_QUADRATURE_X1_A, > + COUNTER_FUNCTION_QUADRATURE_X1_B, > + COUNTER_FUNCTION_QUADRATURE_X2_A, > + COUNTER_FUNCTION_QUADRATURE_X2_B, > + COUNTER_FUNCTION_QUADRATURE_X4, > +}; > + > +/* Signal values */ > +enum counter_signal_level { > + COUNTER_SIGNAL_LEVEL_LOW, > + COUNTER_SIGNAL_LEVEL_HIGH, > +}; > + > +/* Action mode values */ > +enum counter_synapse_action { > + COUNTER_SYNAPSE_ACTION_NONE, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > + COUNTER_SYNAPSE_ACTION_FALLING_EDGE, > + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > +}; > + > +#endif /* _UAPI_COUNTER_H_ */ > _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface 2020-12-30 21:36 ` David Lechner @ 2021-01-30 4:59 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-30 4:59 UTC (permalink / raw) To: David Lechner Cc: jic23, kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, Dan Carpenter [-- Attachment #1: Type: text/plain, Size: 4024 bytes --] On Wed, Dec 30, 2020 at 03:36:35PM -0600, David Lechner wrote: > On 12/25/20 6:15 PM, William Breathitt Gray wrote: > > > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > > new file mode 100644 > > index 000000000000..7585dc9db19d > > --- /dev/null > > +++ b/include/uapi/linux/counter.h > > @@ -0,0 +1,123 @@ > > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ > > +/* > > + * Userspace ABI for Counter character devices > > + * Copyright (C) 2020 William Breathitt Gray > > + */ > > +#ifndef _UAPI_COUNTER_H_ > > +#define _UAPI_COUNTER_H_ > > + > > +#include <linux/ioctl.h> > > +#include <linux/types.h> > > + > > +/* Component type definitions */ > > +enum counter_component_type { > > + COUNTER_COMPONENT_NONE, > > + COUNTER_COMPONENT_SIGNAL, > > + COUNTER_COMPONENT_COUNT, > > + COUNTER_COMPONENT_FUNCTION, > > + COUNTER_COMPONENT_SYNAPSE_ACTION, > > + COUNTER_COMPONENT_EXTENSION, > > +}; > > + > > +/* Component scope definitions */ > > +enum counter_scope { > > Do we need COUNTER_SCOPE_NONE to go with COUNTER_COMPONENT_NONE? COUNTER_COMPONENT_NONE alone should be fine because it already indicates that the 'component' member of the struct counter_watch is to be ignored (i.e. type, scope, etc. will not be evaluated and that section of code is bypassed). > > + COUNTER_SCOPE_DEVICE, > > + COUNTER_SCOPE_SIGNAL, > > + COUNTER_SCOPE_COUNT, > > +}; > > + > > +/** > > + * struct counter_component - Counter component identification > > + * @type: component type (Count, extension, etc.) > > Instead of "Count, extension, etc.", it could be more helpful > to say one of enum counter_component_type. Ack. > > + * @scope: component scope (Device, Count, or Signal) > > Same here. @scope must be one of enum counter_scope. Ack. > > + * @parent: parent component identification number > > + * @id: component identification number > > It could be helpful to say that these id numbers match > the X/Y/Z in the sysfs paths as described in the sysfs > ABI. Ack. > > + */ > > +struct counter_component { > > + __u8 type; > > + __u8 scope; > > + __u8 parent; > > + __u8 id; > > +}; > > + > > +/* Event type definitions */ > > +enum counter_event_type { > > + COUNTER_EVENT_OVERFLOW, > > + COUNTER_EVENT_UNDERFLOW, > > + COUNTER_EVENT_OVERFLOW_UNDERFLOW, > > + COUNTER_EVENT_THRESHOLD, > > + COUNTER_EVENT_INDEX, > > +}; > > + > > +/** > > + * struct counter_watch - Counter component watch configuration > > + * @component: component to watch when event triggers > > + * @event: event that triggers > > It would be helpful to say that @event must be one of > enum counter_event_type. Ack. > > + * @channel: event channel > > It would be useful to say that @channel should be 0 unless > a component has more than one event of the same type. I'll make this clearer. > > + */ > > +struct counter_watch { > > + struct counter_component component; > > + __u8 event; > > + __u8 channel; > > +}; > > + > > +/* ioctl commands */ > > +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) > > +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) > > +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) > > + > > +/** > > + * struct counter_event - Counter event data > > + * @timestamp: best estimate of time of event occurrence, in nanoseconds > > + * @value: component value > > + * @watch: component watch configuration > > + * @errno: system error number > > + */ > > +struct counter_event { > > + __aligned_u64 timestamp; > > + __aligned_u64 value; > > + struct counter_watch watch; > > + __u8 errno; > > There are error codes larger than 255. Probably better > make this __u32. Are error codes larger than 255 actually useful in this case? I noticed the exit() function will only return the least significant byte of status to the parent: https://man7.org/linux/man-pages/man3/exit.3.html William Breathitt Gray [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface @ 2021-01-30 4:59 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-30 4:59 UTC (permalink / raw) To: David Lechner Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, linux-arm-kernel, kernel, Dan Carpenter, fabrice.gasnier, syednwaris, linux-stm32, jic23, alexandre.torgue [-- Attachment #1.1: Type: text/plain, Size: 4024 bytes --] On Wed, Dec 30, 2020 at 03:36:35PM -0600, David Lechner wrote: > On 12/25/20 6:15 PM, William Breathitt Gray wrote: > > > diff --git a/include/uapi/linux/counter.h b/include/uapi/linux/counter.h > > new file mode 100644 > > index 000000000000..7585dc9db19d > > --- /dev/null > > +++ b/include/uapi/linux/counter.h > > @@ -0,0 +1,123 @@ > > +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ > > +/* > > + * Userspace ABI for Counter character devices > > + * Copyright (C) 2020 William Breathitt Gray > > + */ > > +#ifndef _UAPI_COUNTER_H_ > > +#define _UAPI_COUNTER_H_ > > + > > +#include <linux/ioctl.h> > > +#include <linux/types.h> > > + > > +/* Component type definitions */ > > +enum counter_component_type { > > + COUNTER_COMPONENT_NONE, > > + COUNTER_COMPONENT_SIGNAL, > > + COUNTER_COMPONENT_COUNT, > > + COUNTER_COMPONENT_FUNCTION, > > + COUNTER_COMPONENT_SYNAPSE_ACTION, > > + COUNTER_COMPONENT_EXTENSION, > > +}; > > + > > +/* Component scope definitions */ > > +enum counter_scope { > > Do we need COUNTER_SCOPE_NONE to go with COUNTER_COMPONENT_NONE? COUNTER_COMPONENT_NONE alone should be fine because it already indicates that the 'component' member of the struct counter_watch is to be ignored (i.e. type, scope, etc. will not be evaluated and that section of code is bypassed). > > + COUNTER_SCOPE_DEVICE, > > + COUNTER_SCOPE_SIGNAL, > > + COUNTER_SCOPE_COUNT, > > +}; > > + > > +/** > > + * struct counter_component - Counter component identification > > + * @type: component type (Count, extension, etc.) > > Instead of "Count, extension, etc.", it could be more helpful > to say one of enum counter_component_type. Ack. > > + * @scope: component scope (Device, Count, or Signal) > > Same here. @scope must be one of enum counter_scope. Ack. > > + * @parent: parent component identification number > > + * @id: component identification number > > It could be helpful to say that these id numbers match > the X/Y/Z in the sysfs paths as described in the sysfs > ABI. Ack. > > + */ > > +struct counter_component { > > + __u8 type; > > + __u8 scope; > > + __u8 parent; > > + __u8 id; > > +}; > > + > > +/* Event type definitions */ > > +enum counter_event_type { > > + COUNTER_EVENT_OVERFLOW, > > + COUNTER_EVENT_UNDERFLOW, > > + COUNTER_EVENT_OVERFLOW_UNDERFLOW, > > + COUNTER_EVENT_THRESHOLD, > > + COUNTER_EVENT_INDEX, > > +}; > > + > > +/** > > + * struct counter_watch - Counter component watch configuration > > + * @component: component to watch when event triggers > > + * @event: event that triggers > > It would be helpful to say that @event must be one of > enum counter_event_type. Ack. > > + * @channel: event channel > > It would be useful to say that @channel should be 0 unless > a component has more than one event of the same type. I'll make this clearer. > > + */ > > +struct counter_watch { > > + struct counter_component component; > > + __u8 event; > > + __u8 channel; > > +}; > > + > > +/* ioctl commands */ > > +#define COUNTER_CLEAR_WATCHES_IOCTL _IO(0x3E, 0x00) > > +#define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x01, struct counter_watch) > > +#define COUNTER_LOAD_WATCHES_IOCTL _IO(0x3E, 0x02) > > + > > +/** > > + * struct counter_event - Counter event data > > + * @timestamp: best estimate of time of event occurrence, in nanoseconds > > + * @value: component value > > + * @watch: component watch configuration > > + * @errno: system error number > > + */ > > +struct counter_event { > > + __aligned_u64 timestamp; > > + __aligned_u64 value; > > + struct counter_watch watch; > > + __u8 errno; > > There are error codes larger than 255. Probably better > make this __u32. Are error codes larger than 255 actually useful in this case? I noticed the exit() function will only return the least significant byte of status to the parent: https://man7.org/linux/man-pages/man3/exit.3.html William Breathitt Gray [-- Attachment #1.2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] [-- Attachment #2: Type: text/plain, Size: 176 bytes --] _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2021-01-04 18:15 ` Dan Carpenter -1 siblings, 0 replies; 51+ messages in thread From: Dan Carpenter @ 2021-01-04 18:15 UTC (permalink / raw) To: kbuild [-- Attachment #1: Type: text/plain, Size: 10222 bytes --] Hi William, url: https://github.com/0day-ci/linux/commits/William-Breathitt-Gray/Introduce-the-Counter-character-device-interface/20201226-082226 base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 61d791365b72a89062fbbea69aa61479476da946 config: i386-randconfig-m021-20201226 (attached as .config) compiler: gcc-9 (Debian 9.3.0-15) 9.3.0 If you fix the issue, kindly add following tag as appropriate Reported-by: kernel test robot <lkp@intel.com> Reported-by: Dan Carpenter <dan.carpenter@oracle.com> smatch warnings: drivers/counter/counter-chrdev.c:254 counter_add_watch() error: uninitialized symbol 'num_ext'. drivers/counter/counter-chrdev.c:258 counter_add_watch() error: uninitialized symbol 'ext'. vim +/num_ext +254 drivers/counter/counter-chrdev.c 0eae595bb599eaa William Breathitt Gray 2020-12-25 170 static int counter_add_watch(struct counter_device *const counter, 0eae595bb599eaa William Breathitt Gray 2020-12-25 171 const unsigned long arg) 0eae595bb599eaa William Breathitt Gray 2020-12-25 172 { 0eae595bb599eaa William Breathitt Gray 2020-12-25 173 void __user *const uwatch = (void __user *)arg; 0eae595bb599eaa William Breathitt Gray 2020-12-25 174 struct counter_watch watch; 0eae595bb599eaa William Breathitt Gray 2020-12-25 175 struct counter_comp_node comp_node = {0}; 0eae595bb599eaa William Breathitt Gray 2020-12-25 176 size_t parent, id; 0eae595bb599eaa William Breathitt Gray 2020-12-25 177 struct counter_comp *ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 178 size_t num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 179 int err; 0eae595bb599eaa William Breathitt Gray 2020-12-25 180 0eae595bb599eaa William Breathitt Gray 2020-12-25 181 if (copy_from_user(&watch, uwatch, sizeof(watch))) 0eae595bb599eaa William Breathitt Gray 2020-12-25 182 return -EFAULT; 0eae595bb599eaa William Breathitt Gray 2020-12-25 183 0eae595bb599eaa William Breathitt Gray 2020-12-25 184 if (watch.component.type == COUNTER_COMPONENT_NONE) 0eae595bb599eaa William Breathitt Gray 2020-12-25 185 goto no_component; 0eae595bb599eaa William Breathitt Gray 2020-12-25 186 0eae595bb599eaa William Breathitt Gray 2020-12-25 187 parent = watch.component.parent; 0eae595bb599eaa William Breathitt Gray 2020-12-25 188 0eae595bb599eaa William Breathitt Gray 2020-12-25 189 /* Configure parent component info for comp node */ 0eae595bb599eaa William Breathitt Gray 2020-12-25 190 switch (watch.component.scope) { 0eae595bb599eaa William Breathitt Gray 2020-12-25 191 case COUNTER_SCOPE_DEVICE: 0eae595bb599eaa William Breathitt Gray 2020-12-25 192 ext = counter->ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 193 num_ext = counter->num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 194 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 195 case COUNTER_SCOPE_SIGNAL: 0eae595bb599eaa William Breathitt Gray 2020-12-25 196 if (parent >= counter->num_signals) 0eae595bb599eaa William Breathitt Gray 2020-12-25 197 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 198 parent = array_index_nospec(parent, counter->num_signals); 0eae595bb599eaa William Breathitt Gray 2020-12-25 199 0eae595bb599eaa William Breathitt Gray 2020-12-25 200 comp_node.parent = counter->signals + parent; 0eae595bb599eaa William Breathitt Gray 2020-12-25 201 0eae595bb599eaa William Breathitt Gray 2020-12-25 202 ext = counter->signals[parent].ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 203 num_ext = counter->signals[parent].num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 204 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 205 case COUNTER_SCOPE_COUNT: 0eae595bb599eaa William Breathitt Gray 2020-12-25 206 if (parent >= counter->num_counts) 0eae595bb599eaa William Breathitt Gray 2020-12-25 207 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 208 parent = array_index_nospec(parent, counter->num_counts); 0eae595bb599eaa William Breathitt Gray 2020-12-25 209 0eae595bb599eaa William Breathitt Gray 2020-12-25 210 comp_node.parent = counter->counts + parent; 0eae595bb599eaa William Breathitt Gray 2020-12-25 211 0eae595bb599eaa William Breathitt Gray 2020-12-25 212 ext = counter->counts[parent].ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 213 num_ext = counter->counts[parent].num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 214 break; Uninitialized on the defualt: path. I can't actually find how the counter_watch struct is defined, but Smatch normally gets this stuff correct. 0eae595bb599eaa William Breathitt Gray 2020-12-25 215 } 0eae595bb599eaa William Breathitt Gray 2020-12-25 216 0eae595bb599eaa William Breathitt Gray 2020-12-25 217 id = watch.component.id; 0eae595bb599eaa William Breathitt Gray 2020-12-25 218 0eae595bb599eaa William Breathitt Gray 2020-12-25 219 /* Configure component info for comp node */ 0eae595bb599eaa William Breathitt Gray 2020-12-25 220 switch (watch.component.type) { 0eae595bb599eaa William Breathitt Gray 2020-12-25 221 case COUNTER_COMPONENT_SIGNAL: 0eae595bb599eaa William Breathitt Gray 2020-12-25 222 if (watch.component.scope != COUNTER_SCOPE_SIGNAL) 0eae595bb599eaa William Breathitt Gray 2020-12-25 223 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 224 0eae595bb599eaa William Breathitt Gray 2020-12-25 225 comp_node.comp.type = COUNTER_COMP_SIGNAL_LEVEL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 226 comp_node.comp.signal_u32_read = counter->ops->signal_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 227 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 228 case COUNTER_COMPONENT_COUNT: 0eae595bb599eaa William Breathitt Gray 2020-12-25 229 if (watch.component.scope != COUNTER_SCOPE_COUNT) 0eae595bb599eaa William Breathitt Gray 2020-12-25 230 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 231 0eae595bb599eaa William Breathitt Gray 2020-12-25 232 comp_node.comp.type = COUNTER_COMP_U64; 0eae595bb599eaa William Breathitt Gray 2020-12-25 233 comp_node.comp.count_u64_read = counter->ops->count_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 234 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 235 case COUNTER_COMPONENT_FUNCTION: 0eae595bb599eaa William Breathitt Gray 2020-12-25 236 if (watch.component.scope != COUNTER_SCOPE_COUNT) 0eae595bb599eaa William Breathitt Gray 2020-12-25 237 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 238 0eae595bb599eaa William Breathitt Gray 2020-12-25 239 comp_node.comp.type = COUNTER_COMP_FUNCTION; 0eae595bb599eaa William Breathitt Gray 2020-12-25 240 comp_node.comp.count_u32_read = counter->ops->function_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 241 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 242 case COUNTER_COMPONENT_SYNAPSE_ACTION: 0eae595bb599eaa William Breathitt Gray 2020-12-25 243 if (watch.component.scope != COUNTER_SCOPE_COUNT) 0eae595bb599eaa William Breathitt Gray 2020-12-25 244 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 245 if (id >= counter->counts[parent].num_synapses) 0eae595bb599eaa William Breathitt Gray 2020-12-25 246 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 247 id = array_index_nospec(id, counter->counts[parent].num_synapses); 0eae595bb599eaa William Breathitt Gray 2020-12-25 248 0eae595bb599eaa William Breathitt Gray 2020-12-25 249 comp_node.comp.type = COUNTER_COMP_SYNAPSE_ACTION; 0eae595bb599eaa William Breathitt Gray 2020-12-25 250 comp_node.comp.action_read = counter->ops->action_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 251 comp_node.comp.priv = counter->counts[parent].synapses + id; 0eae595bb599eaa William Breathitt Gray 2020-12-25 252 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 253 case COUNTER_COMPONENT_EXTENSION: 0eae595bb599eaa William Breathitt Gray 2020-12-25 @254 if (id >= num_ext) 0eae595bb599eaa William Breathitt Gray 2020-12-25 255 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 256 id = array_index_nospec(id, num_ext); 0eae595bb599eaa William Breathitt Gray 2020-12-25 257 0eae595bb599eaa William Breathitt Gray 2020-12-25 @258 comp_node.comp = ext[id]; 0eae595bb599eaa William Breathitt Gray 2020-12-25 259 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 260 default: 0eae595bb599eaa William Breathitt Gray 2020-12-25 261 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 262 } 0eae595bb599eaa William Breathitt Gray 2020-12-25 263 /* Check if any read callback is set; this is part of a union */ 0eae595bb599eaa William Breathitt Gray 2020-12-25 264 if (!comp_node.comp.count_u8_read) 0eae595bb599eaa William Breathitt Gray 2020-12-25 265 return -EOPNOTSUPP; 0eae595bb599eaa William Breathitt Gray 2020-12-25 266 0eae595bb599eaa William Breathitt Gray 2020-12-25 267 no_component: 0eae595bb599eaa William Breathitt Gray 2020-12-25 268 if (counter->ops->watch_validate) { 0eae595bb599eaa William Breathitt Gray 2020-12-25 269 err = counter->ops->watch_validate(counter, &watch); 0eae595bb599eaa William Breathitt Gray 2020-12-25 270 if (err < 0) 0eae595bb599eaa William Breathitt Gray 2020-12-25 271 return err; 0eae595bb599eaa William Breathitt Gray 2020-12-25 272 } 0eae595bb599eaa William Breathitt Gray 2020-12-25 273 0eae595bb599eaa William Breathitt Gray 2020-12-25 274 comp_node.component = watch.component; 0eae595bb599eaa William Breathitt Gray 2020-12-25 275 0eae595bb599eaa William Breathitt Gray 2020-12-25 276 return counter_set_event_node(counter, &watch, &comp_node); 0eae595bb599eaa William Breathitt Gray 2020-12-25 277 } --- 0-DAY CI Kernel Test Service, Intel Corporation https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org [-- Attachment #2: config.gz --] [-- Type: application/gzip, Size: 37701 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface @ 2021-01-04 18:15 ` Dan Carpenter 0 siblings, 0 replies; 51+ messages in thread From: Dan Carpenter @ 2021-01-04 18:15 UTC (permalink / raw) To: kbuild-all [-- Attachment #1: Type: text/plain, Size: 10222 bytes --] Hi William, url: https://github.com/0day-ci/linux/commits/William-Breathitt-Gray/Introduce-the-Counter-character-device-interface/20201226-082226 base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 61d791365b72a89062fbbea69aa61479476da946 config: i386-randconfig-m021-20201226 (attached as .config) compiler: gcc-9 (Debian 9.3.0-15) 9.3.0 If you fix the issue, kindly add following tag as appropriate Reported-by: kernel test robot <lkp@intel.com> Reported-by: Dan Carpenter <dan.carpenter@oracle.com> smatch warnings: drivers/counter/counter-chrdev.c:254 counter_add_watch() error: uninitialized symbol 'num_ext'. drivers/counter/counter-chrdev.c:258 counter_add_watch() error: uninitialized symbol 'ext'. vim +/num_ext +254 drivers/counter/counter-chrdev.c 0eae595bb599eaa William Breathitt Gray 2020-12-25 170 static int counter_add_watch(struct counter_device *const counter, 0eae595bb599eaa William Breathitt Gray 2020-12-25 171 const unsigned long arg) 0eae595bb599eaa William Breathitt Gray 2020-12-25 172 { 0eae595bb599eaa William Breathitt Gray 2020-12-25 173 void __user *const uwatch = (void __user *)arg; 0eae595bb599eaa William Breathitt Gray 2020-12-25 174 struct counter_watch watch; 0eae595bb599eaa William Breathitt Gray 2020-12-25 175 struct counter_comp_node comp_node = {0}; 0eae595bb599eaa William Breathitt Gray 2020-12-25 176 size_t parent, id; 0eae595bb599eaa William Breathitt Gray 2020-12-25 177 struct counter_comp *ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 178 size_t num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 179 int err; 0eae595bb599eaa William Breathitt Gray 2020-12-25 180 0eae595bb599eaa William Breathitt Gray 2020-12-25 181 if (copy_from_user(&watch, uwatch, sizeof(watch))) 0eae595bb599eaa William Breathitt Gray 2020-12-25 182 return -EFAULT; 0eae595bb599eaa William Breathitt Gray 2020-12-25 183 0eae595bb599eaa William Breathitt Gray 2020-12-25 184 if (watch.component.type == COUNTER_COMPONENT_NONE) 0eae595bb599eaa William Breathitt Gray 2020-12-25 185 goto no_component; 0eae595bb599eaa William Breathitt Gray 2020-12-25 186 0eae595bb599eaa William Breathitt Gray 2020-12-25 187 parent = watch.component.parent; 0eae595bb599eaa William Breathitt Gray 2020-12-25 188 0eae595bb599eaa William Breathitt Gray 2020-12-25 189 /* Configure parent component info for comp node */ 0eae595bb599eaa William Breathitt Gray 2020-12-25 190 switch (watch.component.scope) { 0eae595bb599eaa William Breathitt Gray 2020-12-25 191 case COUNTER_SCOPE_DEVICE: 0eae595bb599eaa William Breathitt Gray 2020-12-25 192 ext = counter->ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 193 num_ext = counter->num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 194 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 195 case COUNTER_SCOPE_SIGNAL: 0eae595bb599eaa William Breathitt Gray 2020-12-25 196 if (parent >= counter->num_signals) 0eae595bb599eaa William Breathitt Gray 2020-12-25 197 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 198 parent = array_index_nospec(parent, counter->num_signals); 0eae595bb599eaa William Breathitt Gray 2020-12-25 199 0eae595bb599eaa William Breathitt Gray 2020-12-25 200 comp_node.parent = counter->signals + parent; 0eae595bb599eaa William Breathitt Gray 2020-12-25 201 0eae595bb599eaa William Breathitt Gray 2020-12-25 202 ext = counter->signals[parent].ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 203 num_ext = counter->signals[parent].num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 204 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 205 case COUNTER_SCOPE_COUNT: 0eae595bb599eaa William Breathitt Gray 2020-12-25 206 if (parent >= counter->num_counts) 0eae595bb599eaa William Breathitt Gray 2020-12-25 207 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 208 parent = array_index_nospec(parent, counter->num_counts); 0eae595bb599eaa William Breathitt Gray 2020-12-25 209 0eae595bb599eaa William Breathitt Gray 2020-12-25 210 comp_node.parent = counter->counts + parent; 0eae595bb599eaa William Breathitt Gray 2020-12-25 211 0eae595bb599eaa William Breathitt Gray 2020-12-25 212 ext = counter->counts[parent].ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 213 num_ext = counter->counts[parent].num_ext; 0eae595bb599eaa William Breathitt Gray 2020-12-25 214 break; Uninitialized on the defualt: path. I can't actually find how the counter_watch struct is defined, but Smatch normally gets this stuff correct. 0eae595bb599eaa William Breathitt Gray 2020-12-25 215 } 0eae595bb599eaa William Breathitt Gray 2020-12-25 216 0eae595bb599eaa William Breathitt Gray 2020-12-25 217 id = watch.component.id; 0eae595bb599eaa William Breathitt Gray 2020-12-25 218 0eae595bb599eaa William Breathitt Gray 2020-12-25 219 /* Configure component info for comp node */ 0eae595bb599eaa William Breathitt Gray 2020-12-25 220 switch (watch.component.type) { 0eae595bb599eaa William Breathitt Gray 2020-12-25 221 case COUNTER_COMPONENT_SIGNAL: 0eae595bb599eaa William Breathitt Gray 2020-12-25 222 if (watch.component.scope != COUNTER_SCOPE_SIGNAL) 0eae595bb599eaa William Breathitt Gray 2020-12-25 223 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 224 0eae595bb599eaa William Breathitt Gray 2020-12-25 225 comp_node.comp.type = COUNTER_COMP_SIGNAL_LEVEL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 226 comp_node.comp.signal_u32_read = counter->ops->signal_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 227 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 228 case COUNTER_COMPONENT_COUNT: 0eae595bb599eaa William Breathitt Gray 2020-12-25 229 if (watch.component.scope != COUNTER_SCOPE_COUNT) 0eae595bb599eaa William Breathitt Gray 2020-12-25 230 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 231 0eae595bb599eaa William Breathitt Gray 2020-12-25 232 comp_node.comp.type = COUNTER_COMP_U64; 0eae595bb599eaa William Breathitt Gray 2020-12-25 233 comp_node.comp.count_u64_read = counter->ops->count_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 234 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 235 case COUNTER_COMPONENT_FUNCTION: 0eae595bb599eaa William Breathitt Gray 2020-12-25 236 if (watch.component.scope != COUNTER_SCOPE_COUNT) 0eae595bb599eaa William Breathitt Gray 2020-12-25 237 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 238 0eae595bb599eaa William Breathitt Gray 2020-12-25 239 comp_node.comp.type = COUNTER_COMP_FUNCTION; 0eae595bb599eaa William Breathitt Gray 2020-12-25 240 comp_node.comp.count_u32_read = counter->ops->function_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 241 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 242 case COUNTER_COMPONENT_SYNAPSE_ACTION: 0eae595bb599eaa William Breathitt Gray 2020-12-25 243 if (watch.component.scope != COUNTER_SCOPE_COUNT) 0eae595bb599eaa William Breathitt Gray 2020-12-25 244 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 245 if (id >= counter->counts[parent].num_synapses) 0eae595bb599eaa William Breathitt Gray 2020-12-25 246 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 247 id = array_index_nospec(id, counter->counts[parent].num_synapses); 0eae595bb599eaa William Breathitt Gray 2020-12-25 248 0eae595bb599eaa William Breathitt Gray 2020-12-25 249 comp_node.comp.type = COUNTER_COMP_SYNAPSE_ACTION; 0eae595bb599eaa William Breathitt Gray 2020-12-25 250 comp_node.comp.action_read = counter->ops->action_read; 0eae595bb599eaa William Breathitt Gray 2020-12-25 251 comp_node.comp.priv = counter->counts[parent].synapses + id; 0eae595bb599eaa William Breathitt Gray 2020-12-25 252 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 253 case COUNTER_COMPONENT_EXTENSION: 0eae595bb599eaa William Breathitt Gray 2020-12-25 @254 if (id >= num_ext) 0eae595bb599eaa William Breathitt Gray 2020-12-25 255 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 256 id = array_index_nospec(id, num_ext); 0eae595bb599eaa William Breathitt Gray 2020-12-25 257 0eae595bb599eaa William Breathitt Gray 2020-12-25 @258 comp_node.comp = ext[id]; 0eae595bb599eaa William Breathitt Gray 2020-12-25 259 break; 0eae595bb599eaa William Breathitt Gray 2020-12-25 260 default: 0eae595bb599eaa William Breathitt Gray 2020-12-25 261 return -EINVAL; 0eae595bb599eaa William Breathitt Gray 2020-12-25 262 } 0eae595bb599eaa William Breathitt Gray 2020-12-25 263 /* Check if any read callback is set; this is part of a union */ 0eae595bb599eaa William Breathitt Gray 2020-12-25 264 if (!comp_node.comp.count_u8_read) 0eae595bb599eaa William Breathitt Gray 2020-12-25 265 return -EOPNOTSUPP; 0eae595bb599eaa William Breathitt Gray 2020-12-25 266 0eae595bb599eaa William Breathitt Gray 2020-12-25 267 no_component: 0eae595bb599eaa William Breathitt Gray 2020-12-25 268 if (counter->ops->watch_validate) { 0eae595bb599eaa William Breathitt Gray 2020-12-25 269 err = counter->ops->watch_validate(counter, &watch); 0eae595bb599eaa William Breathitt Gray 2020-12-25 270 if (err < 0) 0eae595bb599eaa William Breathitt Gray 2020-12-25 271 return err; 0eae595bb599eaa William Breathitt Gray 2020-12-25 272 } 0eae595bb599eaa William Breathitt Gray 2020-12-25 273 0eae595bb599eaa William Breathitt Gray 2020-12-25 274 comp_node.component = watch.component; 0eae595bb599eaa William Breathitt Gray 2020-12-25 275 0eae595bb599eaa William Breathitt Gray 2020-12-25 276 return counter_set_event_node(counter, &watch, &comp_node); 0eae595bb599eaa William Breathitt Gray 2020-12-25 277 } --- 0-DAY CI Kernel Test Service, Intel Corporation https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org [-- Attachment #2: config.gz --] [-- Type: application/gzip, Size: 37701 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2021-01-28 9:01 ` Oleksij Rempel -1 siblings, 0 replies; 51+ messages in thread From: Oleksij Rempel @ 2021-01-28 9:01 UTC (permalink / raw) To: William Breathitt Gray Cc: jic23, kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, Dan Carpenter, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue Hello William, On Fri, Dec 25, 2020 at 07:15:36PM -0500, William Breathitt Gray wrote: > This patch introduces a character device interface for the Counter > subsystem. Device data is exposed through standard character device read > operations. Device data is gathered when a Counter event is pushed by > the respective Counter device driver. Configuration is handled via ioctl > operations on the respective Counter character device node. > > Cc: David Lechner <david@lechnology.com> > Cc: Gwendal Grignou <gwendal@chromium.org> > Cc: Dan Carpenter <dan.carpenter@oracle.com> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > --- ... > +struct counter_event { > + __aligned_u64 timestamp; > + __aligned_u64 value; > + struct counter_watch watch; > + __u8 errno; This variable clashed in user space, as soon as you include errno.h, with the libc's "magic" definition of errno. What about "err" instead. I'm not sure it an __u8 is the proper type, IIRC usually it's an int. Regards, Oleksij -- Pengutronix e.K. | | Steuerwalder Str. 21 | http://www.pengutronix.de/ | 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 | Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 | ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface @ 2021-01-28 9:01 ` Oleksij Rempel 0 siblings, 0 replies; 51+ messages in thread From: Oleksij Rempel @ 2021-01-28 9:01 UTC (permalink / raw) To: William Breathitt Gray Cc: linux-arm-kernel, kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, linux-stm32, alexandre.belloni, linux-kernel, Dan Carpenter, mcoquelin.stm32, fabrice.gasnier, syednwaris, kernel, jic23, alexandre.torgue Hello William, On Fri, Dec 25, 2020 at 07:15:36PM -0500, William Breathitt Gray wrote: > This patch introduces a character device interface for the Counter > subsystem. Device data is exposed through standard character device read > operations. Device data is gathered when a Counter event is pushed by > the respective Counter device driver. Configuration is handled via ioctl > operations on the respective Counter character device node. > > Cc: David Lechner <david@lechnology.com> > Cc: Gwendal Grignou <gwendal@chromium.org> > Cc: Dan Carpenter <dan.carpenter@oracle.com> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > --- ... > +struct counter_event { > + __aligned_u64 timestamp; > + __aligned_u64 value; > + struct counter_watch watch; > + __u8 errno; This variable clashed in user space, as soon as you include errno.h, with the libc's "magic" definition of errno. What about "err" instead. I'm not sure it an __u8 is the proper type, IIRC usually it's an int. Regards, Oleksij -- Pengutronix e.K. | | Steuerwalder Str. 21 | http://www.pengutronix.de/ | 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 | Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 | _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface 2021-01-28 9:01 ` Oleksij Rempel @ 2021-01-30 5:15 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-30 5:15 UTC (permalink / raw) To: Oleksij Rempel Cc: jic23, kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, Dan Carpenter, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue [-- Attachment #1: Type: text/plain, Size: 1936 bytes --] On Thu, Jan 28, 2021 at 10:01:13AM +0100, Oleksij Rempel wrote: > Hello William, > > > On Fri, Dec 25, 2020 at 07:15:36PM -0500, William Breathitt Gray wrote: > > This patch introduces a character device interface for the Counter > > subsystem. Device data is exposed through standard character device read > > operations. Device data is gathered when a Counter event is pushed by > > the respective Counter device driver. Configuration is handled via ioctl > > operations on the respective Counter character device node. > > > > Cc: David Lechner <david@lechnology.com> > > Cc: Gwendal Grignou <gwendal@chromium.org> > > Cc: Dan Carpenter <dan.carpenter@oracle.com> > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > > --- > ... > > +struct counter_event { > > + __aligned_u64 timestamp; > > + __aligned_u64 value; > > + struct counter_watch watch; > > + __u8 errno; > > This variable clashed in user space, as soon as you include errno.h, > with the libc's "magic" definition of errno. What about "err" instead. > I'm not sure it an __u8 is the proper type, IIRC usually it's an int. > > Regards, > Oleksij > -- > Pengutronix e.K. | | > Steuerwalder Str. 21 | http://www.pengutronix.de/ | > 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 | > Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 | Sure, I can rename this to avoid a possible clash with libc's errno. Maybe "status" would be more apt to indicate that this is an exit status for the event -- the code returned may simply be a warning and not necessarily a critical error. Regarding the datatype for this value, I've opened up the discussion in my reply to David Lechner [1], so perhaps we can continue it there. [1] https://lkml.org/lkml/2021/1/30/5 William Breathitt Gray [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 3/5] counter: Add character device interface @ 2021-01-30 5:15 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-01-30 5:15 UTC (permalink / raw) To: Oleksij Rempel Cc: linux-arm-kernel, kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, linux-stm32, alexandre.belloni, linux-kernel, Dan Carpenter, mcoquelin.stm32, fabrice.gasnier, syednwaris, kernel, jic23, alexandre.torgue [-- Attachment #1.1: Type: text/plain, Size: 1936 bytes --] On Thu, Jan 28, 2021 at 10:01:13AM +0100, Oleksij Rempel wrote: > Hello William, > > > On Fri, Dec 25, 2020 at 07:15:36PM -0500, William Breathitt Gray wrote: > > This patch introduces a character device interface for the Counter > > subsystem. Device data is exposed through standard character device read > > operations. Device data is gathered when a Counter event is pushed by > > the respective Counter device driver. Configuration is handled via ioctl > > operations on the respective Counter character device node. > > > > Cc: David Lechner <david@lechnology.com> > > Cc: Gwendal Grignou <gwendal@chromium.org> > > Cc: Dan Carpenter <dan.carpenter@oracle.com> > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > > --- > ... > > +struct counter_event { > > + __aligned_u64 timestamp; > > + __aligned_u64 value; > > + struct counter_watch watch; > > + __u8 errno; > > This variable clashed in user space, as soon as you include errno.h, > with the libc's "magic" definition of errno. What about "err" instead. > I'm not sure it an __u8 is the proper type, IIRC usually it's an int. > > Regards, > Oleksij > -- > Pengutronix e.K. | | > Steuerwalder Str. 21 | http://www.pengutronix.de/ | > 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 | > Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 | Sure, I can rename this to avoid a possible clash with libc's errno. Maybe "status" would be more apt to indicate that this is an exit status for the event -- the code returned may simply be a warning and not necessarily a critical error. Regarding the datatype for this value, I've opened up the discussion in my reply to David Lechner [1], so perhaps we can continue it there. [1] https://lkml.org/lkml/2021/1/30/5 William Breathitt Gray [-- Attachment #1.2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] [-- Attachment #2: Type: text/plain, Size: 176 bytes --] _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH v7 4/5] docs: counter: Document character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-26 0:15 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, William Breathitt Gray This patch adds high-level documentation about the Counter subsystem character device interface. Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- Documentation/ABI/testing/sysfs-bus-counter | 9 + Documentation/driver-api/generic-counter.rst | 236 +++++++++++++++--- .../userspace-api/ioctl/ioctl-number.rst | 1 + 3 files changed, 205 insertions(+), 41 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter index 1820ce2f9183..8f6ea0a50b75 100644 --- a/Documentation/ABI/testing/sysfs-bus-counter +++ b/Documentation/ABI/testing/sysfs-bus-counter @@ -99,6 +99,15 @@ Description: Read-only attribute that indicates whether excessive noise is present at the channel Y counter inputs. +What: /sys/bus/counter/devices/counterX/countY/extensionZ_name +What: /sys/bus/counter/devices/counterX/extensionZ_name +What: /sys/bus/counter/devices/counterX/signalY/extensionZ_name +KernelVersion: 5.12 +Contact: linux-iio@vger.kernel.org +Description: + Read-only attribute that indicates the component name of + Extension Z. + What: /sys/bus/counter/devices/counterX/countY/function KernelVersion: 5.2 Contact: linux-iio@vger.kernel.org diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst index b842ddbbd8a0..4775dcaff557 100644 --- a/Documentation/driver-api/generic-counter.rst +++ b/Documentation/driver-api/generic-counter.rst @@ -223,19 +223,6 @@ whether an input line is differential or single-ended) and instead focus on the core idea of what the data and process represent (e.g. position as interpreted from quadrature encoding data). -Userspace Interface -=================== - -Several sysfs attributes are generated by the Generic Counter interface, -and reside under the /sys/bus/counter/devices/counterX directory, where -counterX refers to the respective counter device. Please see -Documentation/ABI/testing/sysfs-bus-counter for detailed -information on each Generic Counter interface sysfs attribute. - -Through these sysfs attributes, programs and scripts may interact with -the Generic Counter paradigm Counts, Signals, and Synapses of respective -counter devices. - Driver API ========== @@ -387,16 +374,16 @@ userspace interface components:: / driver callbacks / ------------------- | - +---------------+ - | - V - +--------------------+ - | Counter sysfs | - +--------------------+ - | Translates to the | - | standard Counter | - | sysfs output | - +--------------------+ + +---------------+---------------+ + | | + V V + +--------------------+ +---------------------+ + | Counter sysfs | | Counter chrdev | + +--------------------+ +---------------------+ + | Translates to the | | Translates to the | + | standard Counter | | standard Counter | + | sysfs output | | character device | + +--------------------+ +---------------------+ Thereafter, data can be transferred directly between the Counter device driver and Counter userspace interface:: @@ -427,23 +414,30 @@ driver and Counter userspace interface:: / u64 / ---------- | - +---------------+ - | - V - +--------------------+ - | Counter sysfs | - +--------------------+ - | Translates to the | - | standard Counter | - | sysfs output | - |--------------------| - | Type: const char * | - | Value: "42" | - +--------------------+ - | - --------------- - / const char * / - --------------- + +---------------+---------------+ + | | + V V + +--------------------+ +---------------------+ + | Counter sysfs | | Counter chrdev | + +--------------------+ +---------------------+ + | Translates to the | | Translates to the | + | standard Counter | | standard Counter | + | sysfs output | | character device | + |--------------------| |---------------------| + | Type: const char * | | Type: u64 | + | Value: "42" | | Value: 42 | + +--------------------+ +---------------------+ + | | + --------------- ----------------------- + / const char * / / struct counter_event / + --------------- ----------------------- + | | + | V + | +-----------+ + | | read | + | +-----------+ + | \ Count: 42 / + | ----------- | V +--------------------------------------------------+ @@ -452,7 +446,7 @@ driver and Counter userspace interface:: \ Count: "42" / -------------------------------------------------- -There are three primary components involved: +There are four primary components involved: Counter device driver --------------------- @@ -472,3 +466,163 @@ and vice versa. Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file for a detailed breakdown of the available Generic Counter interface sysfs attributes. + +Counter chrdev +-------------- +Translates counter data to the standard Counter character device; data +is transferred via standard character device read calls, while Counter +events are configured via ioctl calls. + +Sysfs Interface +=============== + +Several sysfs attributes are generated by the Generic Counter interface, +and reside under the `/sys/bus/counter/devices/counterX` directory, +where `X` is to the respective counter device id. Please see +`Documentation/ABI/testing/sysfs-bus-counter` for detailed information +on each Generic Counter interface sysfs attribute. + +Through these sysfs attributes, programs and scripts may interact with +the Generic Counter paradigm Counts, Signals, and Synapses of respective +counter devices. + +Counter Character Device +======================== + +Counter character device nodes are created under the `/dev` directory as +`counterX`, where `X` is the respective counter device id. Defines for +the standard Counter data types are exposed via the userspace +`include/uapi/linux/counter.h` file. + +Counter events +-------------- +Counter device drivers can support Counter events by utilizing the +`counter_push_event` function:: + + int counter_push_event(struct counter_device *const counter, const u8 event, + const u8 channel); + +The event id is specified by the `event` parameter; the event channel id +is specified by the `channel` parameter. When this function is called, +the Counter data associated with the respective event is gathered, and a +`struct counter_event` is generated for each datum and pushed to +userspace. + +Counter events can be configured by users to report various Counter +data of interest. This can be conceptualized as a list of Counter +component read calls to perform. For example:: + + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ + | COUNTER_EVENT_OVERFLOW | COUNTER_EVENT_INDEX | + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ + | Channel 0 | Channel 0 | + +------------------------+------------------------+ + | * Count 0 | * Signal 0 | + | * Count 1 | * Signal 0 Extension 0 | + | * Signal 3 | * Extension 4 | + | * Count 4 Extension 2 +------------------------+ + | * Signal 5 Extension 0 | Channel 1 | + | +------------------------+ + | | * Signal 4 | + | | * Signal 4 Extension 0 | + | | * Count 7 | + +------------------------+------------------------+ + +When `counter_push_event(counter, COUNTER_EVENT_INDEX, 1)` is called for +example, it will go down the list for the `COUNTER_EVENT_INDEX` event +channel 1 and execute the read callbacks for Signal 4, Signal 4 +Extension 0, and Count 4 -- the data returned for each is pushed to a +kfifo as a `struct counter_event`, which userspace can retrieve via a +standard read operation on the respective character device node. + +Userspace +--------- +Userspace applications can configure Counter events via ioctl operations +on the Counter character device node. There following ioctl codes are +supported and provided by the `linux/counter.h` userspace header file: + +* COUNTER_CLEAR_WATCHES_IOCTL: + Clear all Counter watches from all events + +* COUNTER_ADD_WATCH_IOCTL: + Add a Counter watch for the specified event + +* COUNTER_LOAD_WATCHES_IOCTL: + Activates the Counter watches added earlier + +To configure events to gather Counter data, users first populate a +`struct counter_watch` with the relevant event id, event channel id, and +the information for the desired Counter component from which to read, +and then pass it via the `COUNTER_ADD_WATCH_IOCTL` ioctl command. + +Note that an event can be watched without gathering Counter data by +setting the `component.type` member equal to `COUNTER_COMPONENT_NONE`. +With this configuration the Counter character device will simply +populate the event timestamps for those respective +`struct counter_event` elements and ignore the component value. + +The `COUNTER_ADD_WATCH_IOCTL` command will buffer these Counter watches. +When ready, the `COUNTER_LOAD_WATCHES_IOCTL` ioctl command may be used +to activate these Counter watches. + +Userspace applications can then execute a `read` operation (optionally +calling `poll` first) on the Counter character device node to retrieve +`struct counter_event` elements with the desired data. + +For example, the following userspace code opens `/dev/counter0`, +configures the `COUNTER_EVENT_INDEX` event channel 0 to gather Count 0 +and Count 1, and prints out the data as it becomes available on the +character device node:: + + #include <fcntl.h> + #include <linux/counter.h> + #include <stdio.h> + #include <string.h> + #include <sys/ioctl.h> + #include <unistd.h> + + struct counter_watch watches[2] = { + { + .component.type = COUNTER_COMPONENT_COUNT, + .component.scope = COUNTER_SCOPE_COUNT, + .component.parent = 0, + .event = COUNTER_EVENT_INDEX, + .channel = 0, + }, + { + .component.type = COUNTER_COMPONENT_COUNT, + .component.scope = COUNTER_SCOPE_COUNT, + .component.parent = 1, + .event = COUNTER_EVENT_INDEX, + .channel = 0, + }, + }; + + int main(void) + { + int fd; + struct counter_event event_data[2]; + + fd = open("/dev/counter0", O_RDWR); + + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches); + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches + 1); + ioctl(fd, COUNTER_LOAD_WATCHES_IOCTL); + + for (;;) { + read(fd, event_data, sizeof(event_data)); + + printf("Timestamp 0: %llu\tCount 0: %llu\n" + "Error Message 0: %s\n" + "Timestamp 1: %llu\tCount 1: %llu\n" + "Error Message 1: %s\n", + (unsigned long long)event_data[0].timestamp, + (unsigned long long)event_data[0].value, + strerror(event_data[0].errno), + (unsigned long long)event_data[1].timestamp, + (unsigned long long)event_data[1].value, + strerror(event_data[1].errno)); + } + + return 0; + } diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst index 55a2d9b2ce33..b7761ceb82a7 100644 --- a/Documentation/userspace-api/ioctl/ioctl-number.rst +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst @@ -88,6 +88,7 @@ Code Seq# Include File Comments <http://infiniband.sourceforge.net/> 0x20 all drivers/cdrom/cm206.h 0x22 all scsi/sg.h +0x3E 00-0F linux/counter.h <mailto:linux-iio@vger.kernel.org> '!' 00-1F uapi/linux/seccomp.h '#' 00-3F IEEE 1394 Subsystem Block for the entire subsystem -- 2.29.2 ^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH v7 4/5] docs: counter: Document character device interface @ 2020-12-26 0:15 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, William Breathitt Gray, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue This patch adds high-level documentation about the Counter subsystem character device interface. Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- Documentation/ABI/testing/sysfs-bus-counter | 9 + Documentation/driver-api/generic-counter.rst | 236 +++++++++++++++--- .../userspace-api/ioctl/ioctl-number.rst | 1 + 3 files changed, 205 insertions(+), 41 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter index 1820ce2f9183..8f6ea0a50b75 100644 --- a/Documentation/ABI/testing/sysfs-bus-counter +++ b/Documentation/ABI/testing/sysfs-bus-counter @@ -99,6 +99,15 @@ Description: Read-only attribute that indicates whether excessive noise is present at the channel Y counter inputs. +What: /sys/bus/counter/devices/counterX/countY/extensionZ_name +What: /sys/bus/counter/devices/counterX/extensionZ_name +What: /sys/bus/counter/devices/counterX/signalY/extensionZ_name +KernelVersion: 5.12 +Contact: linux-iio@vger.kernel.org +Description: + Read-only attribute that indicates the component name of + Extension Z. + What: /sys/bus/counter/devices/counterX/countY/function KernelVersion: 5.2 Contact: linux-iio@vger.kernel.org diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst index b842ddbbd8a0..4775dcaff557 100644 --- a/Documentation/driver-api/generic-counter.rst +++ b/Documentation/driver-api/generic-counter.rst @@ -223,19 +223,6 @@ whether an input line is differential or single-ended) and instead focus on the core idea of what the data and process represent (e.g. position as interpreted from quadrature encoding data). -Userspace Interface -=================== - -Several sysfs attributes are generated by the Generic Counter interface, -and reside under the /sys/bus/counter/devices/counterX directory, where -counterX refers to the respective counter device. Please see -Documentation/ABI/testing/sysfs-bus-counter for detailed -information on each Generic Counter interface sysfs attribute. - -Through these sysfs attributes, programs and scripts may interact with -the Generic Counter paradigm Counts, Signals, and Synapses of respective -counter devices. - Driver API ========== @@ -387,16 +374,16 @@ userspace interface components:: / driver callbacks / ------------------- | - +---------------+ - | - V - +--------------------+ - | Counter sysfs | - +--------------------+ - | Translates to the | - | standard Counter | - | sysfs output | - +--------------------+ + +---------------+---------------+ + | | + V V + +--------------------+ +---------------------+ + | Counter sysfs | | Counter chrdev | + +--------------------+ +---------------------+ + | Translates to the | | Translates to the | + | standard Counter | | standard Counter | + | sysfs output | | character device | + +--------------------+ +---------------------+ Thereafter, data can be transferred directly between the Counter device driver and Counter userspace interface:: @@ -427,23 +414,30 @@ driver and Counter userspace interface:: / u64 / ---------- | - +---------------+ - | - V - +--------------------+ - | Counter sysfs | - +--------------------+ - | Translates to the | - | standard Counter | - | sysfs output | - |--------------------| - | Type: const char * | - | Value: "42" | - +--------------------+ - | - --------------- - / const char * / - --------------- + +---------------+---------------+ + | | + V V + +--------------------+ +---------------------+ + | Counter sysfs | | Counter chrdev | + +--------------------+ +---------------------+ + | Translates to the | | Translates to the | + | standard Counter | | standard Counter | + | sysfs output | | character device | + |--------------------| |---------------------| + | Type: const char * | | Type: u64 | + | Value: "42" | | Value: 42 | + +--------------------+ +---------------------+ + | | + --------------- ----------------------- + / const char * / / struct counter_event / + --------------- ----------------------- + | | + | V + | +-----------+ + | | read | + | +-----------+ + | \ Count: 42 / + | ----------- | V +--------------------------------------------------+ @@ -452,7 +446,7 @@ driver and Counter userspace interface:: \ Count: "42" / -------------------------------------------------- -There are three primary components involved: +There are four primary components involved: Counter device driver --------------------- @@ -472,3 +466,163 @@ and vice versa. Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file for a detailed breakdown of the available Generic Counter interface sysfs attributes. + +Counter chrdev +-------------- +Translates counter data to the standard Counter character device; data +is transferred via standard character device read calls, while Counter +events are configured via ioctl calls. + +Sysfs Interface +=============== + +Several sysfs attributes are generated by the Generic Counter interface, +and reside under the `/sys/bus/counter/devices/counterX` directory, +where `X` is to the respective counter device id. Please see +`Documentation/ABI/testing/sysfs-bus-counter` for detailed information +on each Generic Counter interface sysfs attribute. + +Through these sysfs attributes, programs and scripts may interact with +the Generic Counter paradigm Counts, Signals, and Synapses of respective +counter devices. + +Counter Character Device +======================== + +Counter character device nodes are created under the `/dev` directory as +`counterX`, where `X` is the respective counter device id. Defines for +the standard Counter data types are exposed via the userspace +`include/uapi/linux/counter.h` file. + +Counter events +-------------- +Counter device drivers can support Counter events by utilizing the +`counter_push_event` function:: + + int counter_push_event(struct counter_device *const counter, const u8 event, + const u8 channel); + +The event id is specified by the `event` parameter; the event channel id +is specified by the `channel` parameter. When this function is called, +the Counter data associated with the respective event is gathered, and a +`struct counter_event` is generated for each datum and pushed to +userspace. + +Counter events can be configured by users to report various Counter +data of interest. This can be conceptualized as a list of Counter +component read calls to perform. For example:: + + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ + | COUNTER_EVENT_OVERFLOW | COUNTER_EVENT_INDEX | + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ + | Channel 0 | Channel 0 | + +------------------------+------------------------+ + | * Count 0 | * Signal 0 | + | * Count 1 | * Signal 0 Extension 0 | + | * Signal 3 | * Extension 4 | + | * Count 4 Extension 2 +------------------------+ + | * Signal 5 Extension 0 | Channel 1 | + | +------------------------+ + | | * Signal 4 | + | | * Signal 4 Extension 0 | + | | * Count 7 | + +------------------------+------------------------+ + +When `counter_push_event(counter, COUNTER_EVENT_INDEX, 1)` is called for +example, it will go down the list for the `COUNTER_EVENT_INDEX` event +channel 1 and execute the read callbacks for Signal 4, Signal 4 +Extension 0, and Count 4 -- the data returned for each is pushed to a +kfifo as a `struct counter_event`, which userspace can retrieve via a +standard read operation on the respective character device node. + +Userspace +--------- +Userspace applications can configure Counter events via ioctl operations +on the Counter character device node. There following ioctl codes are +supported and provided by the `linux/counter.h` userspace header file: + +* COUNTER_CLEAR_WATCHES_IOCTL: + Clear all Counter watches from all events + +* COUNTER_ADD_WATCH_IOCTL: + Add a Counter watch for the specified event + +* COUNTER_LOAD_WATCHES_IOCTL: + Activates the Counter watches added earlier + +To configure events to gather Counter data, users first populate a +`struct counter_watch` with the relevant event id, event channel id, and +the information for the desired Counter component from which to read, +and then pass it via the `COUNTER_ADD_WATCH_IOCTL` ioctl command. + +Note that an event can be watched without gathering Counter data by +setting the `component.type` member equal to `COUNTER_COMPONENT_NONE`. +With this configuration the Counter character device will simply +populate the event timestamps for those respective +`struct counter_event` elements and ignore the component value. + +The `COUNTER_ADD_WATCH_IOCTL` command will buffer these Counter watches. +When ready, the `COUNTER_LOAD_WATCHES_IOCTL` ioctl command may be used +to activate these Counter watches. + +Userspace applications can then execute a `read` operation (optionally +calling `poll` first) on the Counter character device node to retrieve +`struct counter_event` elements with the desired data. + +For example, the following userspace code opens `/dev/counter0`, +configures the `COUNTER_EVENT_INDEX` event channel 0 to gather Count 0 +and Count 1, and prints out the data as it becomes available on the +character device node:: + + #include <fcntl.h> + #include <linux/counter.h> + #include <stdio.h> + #include <string.h> + #include <sys/ioctl.h> + #include <unistd.h> + + struct counter_watch watches[2] = { + { + .component.type = COUNTER_COMPONENT_COUNT, + .component.scope = COUNTER_SCOPE_COUNT, + .component.parent = 0, + .event = COUNTER_EVENT_INDEX, + .channel = 0, + }, + { + .component.type = COUNTER_COMPONENT_COUNT, + .component.scope = COUNTER_SCOPE_COUNT, + .component.parent = 1, + .event = COUNTER_EVENT_INDEX, + .channel = 0, + }, + }; + + int main(void) + { + int fd; + struct counter_event event_data[2]; + + fd = open("/dev/counter0", O_RDWR); + + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches); + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches + 1); + ioctl(fd, COUNTER_LOAD_WATCHES_IOCTL); + + for (;;) { + read(fd, event_data, sizeof(event_data)); + + printf("Timestamp 0: %llu\tCount 0: %llu\n" + "Error Message 0: %s\n" + "Timestamp 1: %llu\tCount 1: %llu\n" + "Error Message 1: %s\n", + (unsigned long long)event_data[0].timestamp, + (unsigned long long)event_data[0].value, + strerror(event_data[0].errno), + (unsigned long long)event_data[1].timestamp, + (unsigned long long)event_data[1].value, + strerror(event_data[1].errno)); + } + + return 0; + } diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst index 55a2d9b2ce33..b7761ceb82a7 100644 --- a/Documentation/userspace-api/ioctl/ioctl-number.rst +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst @@ -88,6 +88,7 @@ Code Seq# Include File Comments <http://infiniband.sourceforge.net/> 0x20 all drivers/cdrom/cm206.h 0x22 all scsi/sg.h +0x3E 00-0F linux/counter.h <mailto:linux-iio@vger.kernel.org> '!' 00-1F uapi/linux/seccomp.h '#' 00-3F IEEE 1394 Subsystem Block for the entire subsystem -- 2.29.2 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply related [flat|nested] 51+ messages in thread
* Re: [PATCH v7 4/5] docs: counter: Document character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 14:47 ` Jonathan Cameron -1 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 14:47 UTC (permalink / raw) To: William Breathitt Gray Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue On Fri, 25 Dec 2020 19:15:37 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > This patch adds high-level documentation about the Counter subsystem > character device interface. > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > --- > Documentation/ABI/testing/sysfs-bus-counter | 9 + > Documentation/driver-api/generic-counter.rst | 236 +++++++++++++++--- > .../userspace-api/ioctl/ioctl-number.rst | 1 + > 3 files changed, 205 insertions(+), 41 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter > index 1820ce2f9183..8f6ea0a50b75 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter > +++ b/Documentation/ABI/testing/sysfs-bus-counter > @@ -99,6 +99,15 @@ Description: > Read-only attribute that indicates whether excessive noise is > present at the channel Y counter inputs. > > +What: /sys/bus/counter/devices/counterX/countY/extensionZ_name > +What: /sys/bus/counter/devices/counterX/extensionZ_name > +What: /sys/bus/counter/devices/counterX/signalY/extensionZ_name > +KernelVersion: 5.12 > +Contact: linux-iio@vger.kernel.org > +Description: > + Read-only attribute that indicates the component name of > + Extension Z. Dumb question, but why is this only related to character device introduction? > + > What: /sys/bus/counter/devices/counterX/countY/function > KernelVersion: 5.2 > Contact: linux-iio@vger.kernel.org > diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst > index b842ddbbd8a0..4775dcaff557 100644 > --- a/Documentation/driver-api/generic-counter.rst > +++ b/Documentation/driver-api/generic-counter.rst > @@ -223,19 +223,6 @@ whether an input line is differential or single-ended) and instead focus > on the core idea of what the data and process represent (e.g. position > as interpreted from quadrature encoding data). > > -Userspace Interface > -=================== > - > -Several sysfs attributes are generated by the Generic Counter interface, > -and reside under the /sys/bus/counter/devices/counterX directory, where > -counterX refers to the respective counter device. Please see > -Documentation/ABI/testing/sysfs-bus-counter for detailed > -information on each Generic Counter interface sysfs attribute. > - > -Through these sysfs attributes, programs and scripts may interact with > -the Generic Counter paradigm Counts, Signals, and Synapses of respective > -counter devices. > - > Driver API > ========== > > @@ -387,16 +374,16 @@ userspace interface components:: > / driver callbacks / > ------------------- > | > - +---------------+ > - | > - V > - +--------------------+ > - | Counter sysfs | > - +--------------------+ > - | Translates to the | > - | standard Counter | > - | sysfs output | > - +--------------------+ > + +---------------+---------------+ > + | | > + V V > + +--------------------+ +---------------------+ > + | Counter sysfs | | Counter chrdev | > + +--------------------+ +---------------------+ > + | Translates to the | | Translates to the | > + | standard Counter | | standard Counter | > + | sysfs output | | character device | > + +--------------------+ +---------------------+ > > Thereafter, data can be transferred directly between the Counter device > driver and Counter userspace interface:: > @@ -427,23 +414,30 @@ driver and Counter userspace interface:: > / u64 / > ---------- > | > - +---------------+ > - | > - V > - +--------------------+ > - | Counter sysfs | > - +--------------------+ > - | Translates to the | > - | standard Counter | > - | sysfs output | > - |--------------------| > - | Type: const char * | > - | Value: "42" | > - +--------------------+ > - | > - --------------- > - / const char * / > - --------------- > + +---------------+---------------+ > + | | > + V V > + +--------------------+ +---------------------+ > + | Counter sysfs | | Counter chrdev | > + +--------------------+ +---------------------+ > + | Translates to the | | Translates to the | > + | standard Counter | | standard Counter | > + | sysfs output | | character device | > + |--------------------| |---------------------| > + | Type: const char * | | Type: u64 | > + | Value: "42" | | Value: 42 | > + +--------------------+ +---------------------+ > + | | > + --------------- ----------------------- > + / const char * / / struct counter_event / > + --------------- ----------------------- > + | | > + | V > + | +-----------+ > + | | read | > + | +-----------+ > + | \ Count: 42 / > + | ----------- > | > V > +--------------------------------------------------+ > @@ -452,7 +446,7 @@ driver and Counter userspace interface:: > \ Count: "42" / > -------------------------------------------------- > > -There are three primary components involved: > +There are four primary components involved: > > Counter device driver > --------------------- > @@ -472,3 +466,163 @@ and vice versa. > Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file > for a detailed breakdown of the available Generic Counter interface > sysfs attributes. > + > +Counter chrdev > +-------------- > +Translates counter data to the standard Counter character device; data > +is transferred via standard character device read calls, while Counter > +events are configured via ioctl calls. > + > +Sysfs Interface > +=============== > + > +Several sysfs attributes are generated by the Generic Counter interface, > +and reside under the `/sys/bus/counter/devices/counterX` directory, > +where `X` is to the respective counter device id. Please see > +`Documentation/ABI/testing/sysfs-bus-counter` for detailed information > +on each Generic Counter interface sysfs attribute. > + > +Through these sysfs attributes, programs and scripts may interact with > +the Generic Counter paradigm Counts, Signals, and Synapses of respective > +counter devices. > + > +Counter Character Device > +======================== > + > +Counter character device nodes are created under the `/dev` directory as > +`counterX`, where `X` is the respective counter device id. Defines for > +the standard Counter data types are exposed via the userspace > +`include/uapi/linux/counter.h` file. > + > +Counter events > +-------------- > +Counter device drivers can support Counter events by utilizing the > +`counter_push_event` function:: > + > + int counter_push_event(struct counter_device *const counter, const u8 event, > + const u8 channel); > + > +The event id is specified by the `event` parameter; the event channel id > +is specified by the `channel` parameter. When this function is called, > +the Counter data associated with the respective event is gathered, and a > +`struct counter_event` is generated for each datum and pushed to > +userspace. > + > +Counter events can be configured by users to report various Counter > +data of interest. This can be conceptualized as a list of Counter > +component read calls to perform. For example:: > + > + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ > + | COUNTER_EVENT_OVERFLOW | COUNTER_EVENT_INDEX | > + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ > + | Channel 0 | Channel 0 | > + +------------------------+------------------------+ > + | * Count 0 | * Signal 0 | > + | * Count 1 | * Signal 0 Extension 0 | > + | * Signal 3 | * Extension 4 | > + | * Count 4 Extension 2 +------------------------+ > + | * Signal 5 Extension 0 | Channel 1 | > + | +------------------------+ > + | | * Signal 4 | > + | | * Signal 4 Extension 0 | > + | | * Count 7 | > + +------------------------+------------------------+ > + > +When `counter_push_event(counter, COUNTER_EVENT_INDEX, 1)` is called for > +example, it will go down the list for the `COUNTER_EVENT_INDEX` event > +channel 1 and execute the read callbacks for Signal 4, Signal 4 > +Extension 0, and Count 4 -- the data returned for each is pushed to a > +kfifo as a `struct counter_event`, which userspace can retrieve via a > +standard read operation on the respective character device node. > + > +Userspace > +--------- > +Userspace applications can configure Counter events via ioctl operations > +on the Counter character device node. There following ioctl codes are > +supported and provided by the `linux/counter.h` userspace header file: > + > +* COUNTER_CLEAR_WATCHES_IOCTL: > + Clear all Counter watches from all events > + > +* COUNTER_ADD_WATCH_IOCTL: > + Add a Counter watch for the specified event > + > +* COUNTER_LOAD_WATCHES_IOCTL: > + Activates the Counter watches added earlier > + > +To configure events to gather Counter data, users first populate a > +`struct counter_watch` with the relevant event id, event channel id, and > +the information for the desired Counter component from which to read, > +and then pass it via the `COUNTER_ADD_WATCH_IOCTL` ioctl command. > + > +Note that an event can be watched without gathering Counter data by > +setting the `component.type` member equal to `COUNTER_COMPONENT_NONE`. > +With this configuration the Counter character device will simply > +populate the event timestamps for those respective > +`struct counter_event` elements and ignore the component value. > + > +The `COUNTER_ADD_WATCH_IOCTL` command will buffer these Counter watches. > +When ready, the `COUNTER_LOAD_WATCHES_IOCTL` ioctl command may be used > +to activate these Counter watches. > + > +Userspace applications can then execute a `read` operation (optionally > +calling `poll` first) on the Counter character device node to retrieve > +`struct counter_event` elements with the desired data. > + > +For example, the following userspace code opens `/dev/counter0`, > +configures the `COUNTER_EVENT_INDEX` event channel 0 to gather Count 0 > +and Count 1, and prints out the data as it becomes available on the > +character device node:: > + > + #include <fcntl.h> > + #include <linux/counter.h> > + #include <stdio.h> > + #include <string.h> > + #include <sys/ioctl.h> > + #include <unistd.h> > + > + struct counter_watch watches[2] = { > + { > + .component.type = COUNTER_COMPONENT_COUNT, > + .component.scope = COUNTER_SCOPE_COUNT, > + .component.parent = 0, > + .event = COUNTER_EVENT_INDEX, > + .channel = 0, > + }, > + { > + .component.type = COUNTER_COMPONENT_COUNT, > + .component.scope = COUNTER_SCOPE_COUNT, > + .component.parent = 1, > + .event = COUNTER_EVENT_INDEX, > + .channel = 0, > + }, > + }; > + > + int main(void) > + { > + int fd; > + struct counter_event event_data[2]; > + > + fd = open("/dev/counter0", O_RDWR); > + > + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches); > + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches + 1); > + ioctl(fd, COUNTER_LOAD_WATCHES_IOCTL); > + > + for (;;) { > + read(fd, event_data, sizeof(event_data)); > + > + printf("Timestamp 0: %llu\tCount 0: %llu\n" > + "Error Message 0: %s\n" > + "Timestamp 1: %llu\tCount 1: %llu\n" > + "Error Message 1: %s\n", > + (unsigned long long)event_data[0].timestamp, > + (unsigned long long)event_data[0].value, > + strerror(event_data[0].errno), > + (unsigned long long)event_data[1].timestamp, > + (unsigned long long)event_data[1].value, > + strerror(event_data[1].errno)); > + } > + > + return 0; > + } > diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst > index 55a2d9b2ce33..b7761ceb82a7 100644 > --- a/Documentation/userspace-api/ioctl/ioctl-number.rst > +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst > @@ -88,6 +88,7 @@ Code Seq# Include File Comments > <http://infiniband.sourceforge.net/> > 0x20 all drivers/cdrom/cm206.h > 0x22 all scsi/sg.h > +0x3E 00-0F linux/counter.h <mailto:linux-iio@vger.kernel.org> > '!' 00-1F uapi/linux/seccomp.h > '#' 00-3F IEEE 1394 Subsystem > Block for the entire subsystem ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 4/5] docs: counter: Document character device interface @ 2020-12-30 14:47 ` Jonathan Cameron 0 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 14:47 UTC (permalink / raw) To: William Breathitt Gray Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On Fri, 25 Dec 2020 19:15:37 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > This patch adds high-level documentation about the Counter subsystem > character device interface. > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > --- > Documentation/ABI/testing/sysfs-bus-counter | 9 + > Documentation/driver-api/generic-counter.rst | 236 +++++++++++++++--- > .../userspace-api/ioctl/ioctl-number.rst | 1 + > 3 files changed, 205 insertions(+), 41 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter > index 1820ce2f9183..8f6ea0a50b75 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter > +++ b/Documentation/ABI/testing/sysfs-bus-counter > @@ -99,6 +99,15 @@ Description: > Read-only attribute that indicates whether excessive noise is > present at the channel Y counter inputs. > > +What: /sys/bus/counter/devices/counterX/countY/extensionZ_name > +What: /sys/bus/counter/devices/counterX/extensionZ_name > +What: /sys/bus/counter/devices/counterX/signalY/extensionZ_name > +KernelVersion: 5.12 > +Contact: linux-iio@vger.kernel.org > +Description: > + Read-only attribute that indicates the component name of > + Extension Z. Dumb question, but why is this only related to character device introduction? > + > What: /sys/bus/counter/devices/counterX/countY/function > KernelVersion: 5.2 > Contact: linux-iio@vger.kernel.org > diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst > index b842ddbbd8a0..4775dcaff557 100644 > --- a/Documentation/driver-api/generic-counter.rst > +++ b/Documentation/driver-api/generic-counter.rst > @@ -223,19 +223,6 @@ whether an input line is differential or single-ended) and instead focus > on the core idea of what the data and process represent (e.g. position > as interpreted from quadrature encoding data). > > -Userspace Interface > -=================== > - > -Several sysfs attributes are generated by the Generic Counter interface, > -and reside under the /sys/bus/counter/devices/counterX directory, where > -counterX refers to the respective counter device. Please see > -Documentation/ABI/testing/sysfs-bus-counter for detailed > -information on each Generic Counter interface sysfs attribute. > - > -Through these sysfs attributes, programs and scripts may interact with > -the Generic Counter paradigm Counts, Signals, and Synapses of respective > -counter devices. > - > Driver API > ========== > > @@ -387,16 +374,16 @@ userspace interface components:: > / driver callbacks / > ------------------- > | > - +---------------+ > - | > - V > - +--------------------+ > - | Counter sysfs | > - +--------------------+ > - | Translates to the | > - | standard Counter | > - | sysfs output | > - +--------------------+ > + +---------------+---------------+ > + | | > + V V > + +--------------------+ +---------------------+ > + | Counter sysfs | | Counter chrdev | > + +--------------------+ +---------------------+ > + | Translates to the | | Translates to the | > + | standard Counter | | standard Counter | > + | sysfs output | | character device | > + +--------------------+ +---------------------+ > > Thereafter, data can be transferred directly between the Counter device > driver and Counter userspace interface:: > @@ -427,23 +414,30 @@ driver and Counter userspace interface:: > / u64 / > ---------- > | > - +---------------+ > - | > - V > - +--------------------+ > - | Counter sysfs | > - +--------------------+ > - | Translates to the | > - | standard Counter | > - | sysfs output | > - |--------------------| > - | Type: const char * | > - | Value: "42" | > - +--------------------+ > - | > - --------------- > - / const char * / > - --------------- > + +---------------+---------------+ > + | | > + V V > + +--------------------+ +---------------------+ > + | Counter sysfs | | Counter chrdev | > + +--------------------+ +---------------------+ > + | Translates to the | | Translates to the | > + | standard Counter | | standard Counter | > + | sysfs output | | character device | > + |--------------------| |---------------------| > + | Type: const char * | | Type: u64 | > + | Value: "42" | | Value: 42 | > + +--------------------+ +---------------------+ > + | | > + --------------- ----------------------- > + / const char * / / struct counter_event / > + --------------- ----------------------- > + | | > + | V > + | +-----------+ > + | | read | > + | +-----------+ > + | \ Count: 42 / > + | ----------- > | > V > +--------------------------------------------------+ > @@ -452,7 +446,7 @@ driver and Counter userspace interface:: > \ Count: "42" / > -------------------------------------------------- > > -There are three primary components involved: > +There are four primary components involved: > > Counter device driver > --------------------- > @@ -472,3 +466,163 @@ and vice versa. > Please refer to the `Documentation/ABI/testing/sysfs-bus-counter` file > for a detailed breakdown of the available Generic Counter interface > sysfs attributes. > + > +Counter chrdev > +-------------- > +Translates counter data to the standard Counter character device; data > +is transferred via standard character device read calls, while Counter > +events are configured via ioctl calls. > + > +Sysfs Interface > +=============== > + > +Several sysfs attributes are generated by the Generic Counter interface, > +and reside under the `/sys/bus/counter/devices/counterX` directory, > +where `X` is to the respective counter device id. Please see > +`Documentation/ABI/testing/sysfs-bus-counter` for detailed information > +on each Generic Counter interface sysfs attribute. > + > +Through these sysfs attributes, programs and scripts may interact with > +the Generic Counter paradigm Counts, Signals, and Synapses of respective > +counter devices. > + > +Counter Character Device > +======================== > + > +Counter character device nodes are created under the `/dev` directory as > +`counterX`, where `X` is the respective counter device id. Defines for > +the standard Counter data types are exposed via the userspace > +`include/uapi/linux/counter.h` file. > + > +Counter events > +-------------- > +Counter device drivers can support Counter events by utilizing the > +`counter_push_event` function:: > + > + int counter_push_event(struct counter_device *const counter, const u8 event, > + const u8 channel); > + > +The event id is specified by the `event` parameter; the event channel id > +is specified by the `channel` parameter. When this function is called, > +the Counter data associated with the respective event is gathered, and a > +`struct counter_event` is generated for each datum and pushed to > +userspace. > + > +Counter events can be configured by users to report various Counter > +data of interest. This can be conceptualized as a list of Counter > +component read calls to perform. For example:: > + > + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ > + | COUNTER_EVENT_OVERFLOW | COUNTER_EVENT_INDEX | > + +~~~~~~~~~~~~~~~~~~~~~~~~+~~~~~~~~~~~~~~~~~~~~~~~~+ > + | Channel 0 | Channel 0 | > + +------------------------+------------------------+ > + | * Count 0 | * Signal 0 | > + | * Count 1 | * Signal 0 Extension 0 | > + | * Signal 3 | * Extension 4 | > + | * Count 4 Extension 2 +------------------------+ > + | * Signal 5 Extension 0 | Channel 1 | > + | +------------------------+ > + | | * Signal 4 | > + | | * Signal 4 Extension 0 | > + | | * Count 7 | > + +------------------------+------------------------+ > + > +When `counter_push_event(counter, COUNTER_EVENT_INDEX, 1)` is called for > +example, it will go down the list for the `COUNTER_EVENT_INDEX` event > +channel 1 and execute the read callbacks for Signal 4, Signal 4 > +Extension 0, and Count 4 -- the data returned for each is pushed to a > +kfifo as a `struct counter_event`, which userspace can retrieve via a > +standard read operation on the respective character device node. > + > +Userspace > +--------- > +Userspace applications can configure Counter events via ioctl operations > +on the Counter character device node. There following ioctl codes are > +supported and provided by the `linux/counter.h` userspace header file: > + > +* COUNTER_CLEAR_WATCHES_IOCTL: > + Clear all Counter watches from all events > + > +* COUNTER_ADD_WATCH_IOCTL: > + Add a Counter watch for the specified event > + > +* COUNTER_LOAD_WATCHES_IOCTL: > + Activates the Counter watches added earlier > + > +To configure events to gather Counter data, users first populate a > +`struct counter_watch` with the relevant event id, event channel id, and > +the information for the desired Counter component from which to read, > +and then pass it via the `COUNTER_ADD_WATCH_IOCTL` ioctl command. > + > +Note that an event can be watched without gathering Counter data by > +setting the `component.type` member equal to `COUNTER_COMPONENT_NONE`. > +With this configuration the Counter character device will simply > +populate the event timestamps for those respective > +`struct counter_event` elements and ignore the component value. > + > +The `COUNTER_ADD_WATCH_IOCTL` command will buffer these Counter watches. > +When ready, the `COUNTER_LOAD_WATCHES_IOCTL` ioctl command may be used > +to activate these Counter watches. > + > +Userspace applications can then execute a `read` operation (optionally > +calling `poll` first) on the Counter character device node to retrieve > +`struct counter_event` elements with the desired data. > + > +For example, the following userspace code opens `/dev/counter0`, > +configures the `COUNTER_EVENT_INDEX` event channel 0 to gather Count 0 > +and Count 1, and prints out the data as it becomes available on the > +character device node:: > + > + #include <fcntl.h> > + #include <linux/counter.h> > + #include <stdio.h> > + #include <string.h> > + #include <sys/ioctl.h> > + #include <unistd.h> > + > + struct counter_watch watches[2] = { > + { > + .component.type = COUNTER_COMPONENT_COUNT, > + .component.scope = COUNTER_SCOPE_COUNT, > + .component.parent = 0, > + .event = COUNTER_EVENT_INDEX, > + .channel = 0, > + }, > + { > + .component.type = COUNTER_COMPONENT_COUNT, > + .component.scope = COUNTER_SCOPE_COUNT, > + .component.parent = 1, > + .event = COUNTER_EVENT_INDEX, > + .channel = 0, > + }, > + }; > + > + int main(void) > + { > + int fd; > + struct counter_event event_data[2]; > + > + fd = open("/dev/counter0", O_RDWR); > + > + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches); > + ioctl(fd, COUNTER_ADD_WATCH_IOCTL, watches + 1); > + ioctl(fd, COUNTER_LOAD_WATCHES_IOCTL); > + > + for (;;) { > + read(fd, event_data, sizeof(event_data)); > + > + printf("Timestamp 0: %llu\tCount 0: %llu\n" > + "Error Message 0: %s\n" > + "Timestamp 1: %llu\tCount 1: %llu\n" > + "Error Message 1: %s\n", > + (unsigned long long)event_data[0].timestamp, > + (unsigned long long)event_data[0].value, > + strerror(event_data[0].errno), > + (unsigned long long)event_data[1].timestamp, > + (unsigned long long)event_data[1].value, > + strerror(event_data[1].errno)); > + } > + > + return 0; > + } > diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst > index 55a2d9b2ce33..b7761ceb82a7 100644 > --- a/Documentation/userspace-api/ioctl/ioctl-number.rst > +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst > @@ -88,6 +88,7 @@ Code Seq# Include File Comments > <http://infiniband.sourceforge.net/> > 0x20 all drivers/cdrom/cm206.h > 0x22 all scsi/sg.h > +0x3E 00-0F linux/counter.h <mailto:linux-iio@vger.kernel.org> > '!' 00-1F uapi/linux/seccomp.h > '#' 00-3F IEEE 1394 Subsystem > Block for the entire subsystem _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 4/5] docs: counter: Document character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 18:18 ` David Lechner -1 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 18:18 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > +Userspace > +--------- > +Userspace applications can configure Counter events via ioctl operations > +on the Counter character device node. There following ioctl codes are > +supported and provided by the `linux/counter.h` userspace header file: > + > +* COUNTER_CLEAR_WATCHES_IOCTL: > + Clear all Counter watches from all events > + > +* COUNTER_ADD_WATCH_IOCTL: > + Add a Counter watch for the specified event > + > +* COUNTER_LOAD_WATCHES_IOCTL: > + Activates the Counter watches added earlier Would it make more sense to call the last and first ones COUNTER_ENABLE_EVENTS_IOCTL and COUNTER_DISABLE_EVENTS_IOCTL? In any case, more explanation would be helpful. * COUNTER_ADD_WATCH_IOCTL: Queues a Counter watch for the specified event. The queued watches will not be applied until COUNTER_ENABLE_EVENTS_IOCTL is called. * COUNTER_ENABLE_EVENTS_IOCTL: Enables monitoring the events specified by the Counter watches that were queued by COUNTER_ADD_WATCH_IOCTL. If events are already enabled, the new set of watches replaces the old one. Calling this ioctl also has the effect of clearing the queue of watches added by COUNTER_ADD_WATCH_IOCTL. * COUNTER_DISABLE_EVENTS_IOCTL: Stops monitoring the previously enabled events. > + > +To configure events to gather Counter data, users first populate a > +`struct counter_watch` with the relevant event id, event channel id, and > +the information for the desired Counter component from which to read, > +and then pass it via the `COUNTER_ADD_WATCH_IOCTL` ioctl command. for restructured text, two backticks are needed for ``code`` formatting ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 4/5] docs: counter: Document character device interface @ 2020-12-30 18:18 ` David Lechner 0 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 18:18 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > +Userspace > +--------- > +Userspace applications can configure Counter events via ioctl operations > +on the Counter character device node. There following ioctl codes are > +supported and provided by the `linux/counter.h` userspace header file: > + > +* COUNTER_CLEAR_WATCHES_IOCTL: > + Clear all Counter watches from all events > + > +* COUNTER_ADD_WATCH_IOCTL: > + Add a Counter watch for the specified event > + > +* COUNTER_LOAD_WATCHES_IOCTL: > + Activates the Counter watches added earlier Would it make more sense to call the last and first ones COUNTER_ENABLE_EVENTS_IOCTL and COUNTER_DISABLE_EVENTS_IOCTL? In any case, more explanation would be helpful. * COUNTER_ADD_WATCH_IOCTL: Queues a Counter watch for the specified event. The queued watches will not be applied until COUNTER_ENABLE_EVENTS_IOCTL is called. * COUNTER_ENABLE_EVENTS_IOCTL: Enables monitoring the events specified by the Counter watches that were queued by COUNTER_ADD_WATCH_IOCTL. If events are already enabled, the new set of watches replaces the old one. Calling this ioctl also has the effect of clearing the queue of watches added by COUNTER_ADD_WATCH_IOCTL. * COUNTER_DISABLE_EVENTS_IOCTL: Stops monitoring the previously enabled events. > + > +To configure events to gather Counter data, users first populate a > +`struct counter_watch` with the relevant event id, event channel id, and > +the information for the desired Counter component from which to read, > +and then pass it via the `COUNTER_ADD_WATCH_IOCTL` ioctl command. for restructured text, two backticks are needed for ``code`` formatting _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-26 0:15 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue, William Breathitt Gray The LSI/CSI LS7266R1 chip provides programmable output via the FLG pins. When interrupts are enabled on the ACCES 104-QUAD-8, they occur whenever FLG1 is active. Four functions are available for the FLG1 signal: Carry, Compare, Carry-Borrow, and Index. Carry: Interrupt generated on active low Carry signal. Carry signal toggles every time the respective channel's counter overflows. Compare: Interrupt generated on active low Compare signal. Compare signal toggles every time respective channel's preset register is equal to the respective channel's counter. Carry-Borrow: Interrupt generated on active low Carry signal and active low Borrow signal. Carry signal toggles every time the respective channel's counter overflows. Borrow signal toggles every time the respective channel's counter underflows. Index: Interrupt generated on active high Index signal. The irq_trigger Count extension is introduced to allow the selection of the desired IRQ trigger function per channel. Interrupts push Counter events to event channel X, where 'X' is the respective channel whose FLG1 activated. This patch adds IRQ support for the ACCES 104-QUAD-8. The interrupt line numbers for the devices may be configured via the irq array module parameter. Reviewed-by: Syed Nayyar Waris <syednwaris@gmail.com> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 ++ drivers/counter/104-quad-8.c | 318 ++++++++++++++---- drivers/counter/Kconfig | 6 +- 3 files changed, 276 insertions(+), 73 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 index eac32180c40d..0ecba24d43aa 100644 --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 @@ -1,3 +1,28 @@ +What: /sys/bus/counter/devices/counterX/countY/irq_trigger +KernelVersion: 5.12 +Contact: linux-iio@vger.kernel.org +Description: + IRQ trigger function for channel Y. Four trigger functions are + available: carry, compare, carry-borrow, and index. + + carry: + Interrupt generated on active low Carry signal. Carry + signal toggles every time channel Y counter overflows. + + compare: + Interrupt generated on active low Compare signal. + Compare signal toggles every time channel Y preset + register is equal to channel Y counter. + + carry-borrow: + Interrupt generated on active low Carry signal and + active low Borrow signal. Carry signal toggles every + time channel Y counter overflows. Borrow signal toggles + every time channel Y counter underflows. + + index: + Interrupt generated on active high Index signal. + What: /sys/bus/counter/devices/counterX/signalY/cable_fault KernelVersion: 5.7 Contact: linux-iio@vger.kernel.org diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c index f4fb36b751c4..7537575568d0 100644 --- a/drivers/counter/104-quad-8.c +++ b/drivers/counter/104-quad-8.c @@ -13,23 +13,30 @@ #include <linux/iio/types.h> #include <linux/io.h> #include <linux/ioport.h> +#include <linux/interrupt.h> #include <linux/isa.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/moduleparam.h> #include <linux/types.h> +#include <linux/spinlock.h> #define QUAD8_EXTENT 32 static unsigned int base[max_num_isa_dev(QUAD8_EXTENT)]; static unsigned int num_quad8; -module_param_array(base, uint, &num_quad8, 0); +module_param_hw_array(base, uint, ioport, &num_quad8, 0); MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); +static unsigned int irq[max_num_isa_dev(QUAD8_EXTENT)]; +module_param_hw_array(irq, uint, irq, NULL, 0); +MODULE_PARM_DESC(irq, "ACCES 104-QUAD-8 interrupt line numbers"); + #define QUAD8_NUM_COUNTERS 8 /** * struct quad8_iio - IIO device private data structure + * @lock: synchronization lock to prevent I/O race conditions * @counter: instance of the counter_device * @fck_prescaler: array of filter clock prescaler configurations * @preset: array of preset values @@ -38,13 +45,14 @@ MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); * @quadrature_scale: array of quadrature mode scale configurations * @ab_enable: array of A and B inputs enable configurations * @preset_enable: array of set_to_preset_on_index attribute configurations + * @irq_trigger: array of interrupt trigger function configurations * @synchronous_mode: array of index function synchronous mode configurations * @index_polarity: array of index function polarity configurations * @cable_fault_enable: differential encoder cable status enable configurations * @base: base port address of the IIO device */ struct quad8_iio { - struct mutex lock; + raw_spinlock_t lock; struct counter_device counter; unsigned int fck_prescaler[QUAD8_NUM_COUNTERS]; unsigned int preset[QUAD8_NUM_COUNTERS]; @@ -53,13 +61,16 @@ struct quad8_iio { unsigned int quadrature_scale[QUAD8_NUM_COUNTERS]; unsigned int ab_enable[QUAD8_NUM_COUNTERS]; unsigned int preset_enable[QUAD8_NUM_COUNTERS]; + unsigned int irq_trigger[QUAD8_NUM_COUNTERS]; unsigned int synchronous_mode[QUAD8_NUM_COUNTERS]; unsigned int index_polarity[QUAD8_NUM_COUNTERS]; unsigned int cable_fault_enable; unsigned int base; }; +#define QUAD8_REG_INTERRUPT_STATUS 0x10 #define QUAD8_REG_CHAN_OP 0x11 +#define QUAD8_REG_INDEX_INTERRUPT 0x12 #define QUAD8_REG_INDEX_INPUT_LEVELS 0x16 #define QUAD8_DIFF_ENCODER_CABLE_STATUS 0x17 /* Borrow Toggle flip-flop */ @@ -92,8 +103,8 @@ struct quad8_iio { #define QUAD8_RLD_CNTR_OUT 0x10 /* Transfer Preset Register LSB to FCK Prescaler */ #define QUAD8_RLD_PRESET_PSC 0x18 -#define QUAD8_CHAN_OP_ENABLE_COUNTERS 0x00 #define QUAD8_CHAN_OP_RESET_COUNTERS 0x01 +#define QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC 0x04 #define QUAD8_CMR_QUADRATURE_X1 0x08 #define QUAD8_CMR_QUADRATURE_X2 0x10 #define QUAD8_CMR_QUADRATURE_X4 0x18 @@ -107,6 +118,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, unsigned int flags; unsigned int borrow; unsigned int carry; + unsigned long irqflags; int i; switch (mask) { @@ -124,7 +136,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, /* Borrow XOR Carry effectively doubles count range */ *val = (borrow ^ carry) << 24; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Reset Byte Pointer; transfer Counter to Output Latch */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, @@ -133,7 +145,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, for (i = 0; i < 3; i++) *val |= (unsigned int)inb(base_offset) << (8 * i); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return IIO_VAL_INT; case IIO_CHAN_INFO_ENABLE: @@ -153,6 +165,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, { struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel; + unsigned long flags; int i; unsigned int ior_cfg; @@ -165,7 +178,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, if ((unsigned int)val > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, flags); /* Reset Byte Pointer */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); @@ -190,7 +203,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, /* Reset Error flag */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return 0; case IIO_CHAN_INFO_ENABLE: @@ -198,25 +211,26 @@ static int quad8_write_raw(struct iio_dev *indio_dev, if (val < 0 || val > 1) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, flags); priv->ab_enable[chan->channel] = val; - ior_cfg = val | priv->preset_enable[chan->channel] << 1; + ior_cfg = val | priv->preset_enable[chan->channel] << 1 | + priv->irq_trigger[chan->channel] << 3; /* Load I/O control configuration */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return 0; case IIO_CHAN_INFO_SCALE: - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, flags); /* Quadrature scaling only available in quadrature mode */ if (!priv->quadrature_mode[chan->channel] && (val2 || val != 1)) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return -EINVAL; } @@ -232,15 +246,15 @@ static int quad8_write_raw(struct iio_dev *indio_dev, priv->quadrature_scale[chan->channel] = 2; break; default: - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return -EINVAL; } else { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return -EINVAL; } - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return 0; } @@ -266,6 +280,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel; unsigned int preset; + unsigned long irqflags; int ret; int i; @@ -277,7 +292,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, if (preset > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->preset[chan->channel] = preset; @@ -288,7 +303,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, for (i = 0; i < 3; i++) outb(preset >> (8 * i), base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return len; } @@ -309,6 +324,7 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; bool preset_enable; + unsigned long irqflags; int ret; unsigned int ior_cfg; @@ -319,17 +335,18 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, /* Preset enable is active low in Input/Output Control register */ preset_enable = !preset_enable; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->preset_enable[chan->channel] = preset_enable; ior_cfg = priv->ab_enable[chan->channel] | - (unsigned int)preset_enable << 1; + (unsigned int)preset_enable << 1 | + priv->irq_trigger[chan->channel] << 3; /* Load I/O control configuration to Input / Output Control Register */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return len; } @@ -387,8 +404,9 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); unsigned int mode_cfg = cnt_mode << 1; const int base_offset = priv->base + 2 * chan->channel + 1; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->count_mode[chan->channel] = cnt_mode; @@ -399,7 +417,7 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -430,14 +448,15 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; unsigned int idr_cfg = synchronous_mode; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->index_polarity[chan->channel] << 1; /* Index function must be non-synchronous in non-quadrature mode */ if (synchronous_mode && !priv->quadrature_mode[chan->channel]) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } @@ -446,7 +465,7 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -476,9 +495,10 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, { struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; + unsigned long irqflags; unsigned int mode_cfg; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); mode_cfg = priv->count_mode[chan->channel] << 1; @@ -498,7 +518,7 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -529,8 +549,9 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; unsigned int idr_cfg = index_polarity << 1; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->synchronous_mode[chan->channel]; @@ -539,7 +560,7 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -647,6 +668,7 @@ static int quad8_count_read(struct counter_device *counter, unsigned int flags; unsigned int borrow; unsigned int carry; + unsigned long irqflags; int i; flags = inb(base_offset + 1); @@ -656,7 +678,7 @@ static int quad8_count_read(struct counter_device *counter, /* Borrow XOR Carry effectively doubles count range */ *val = (unsigned long)(borrow ^ carry) << 24; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Reset Byte Pointer; transfer Counter to Output Latch */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, @@ -665,7 +687,7 @@ static int quad8_count_read(struct counter_device *counter, for (i = 0; i < 3; i++) *val |= (unsigned long)inb(base_offset) << (8 * i); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -675,13 +697,14 @@ static int quad8_count_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id; + unsigned long irqflags; int i; /* Only 24-bit values are supported */ if (val > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Reset Byte Pointer */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); @@ -706,7 +729,7 @@ static int quad8_count_write(struct counter_device *counter, /* Reset Error flag */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -725,8 +748,9 @@ static int quad8_function_read(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int id = count->id; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); if (priv->quadrature_mode[id]) switch (priv->quadrature_scale[id]) { @@ -743,7 +767,7 @@ static int quad8_function_read(struct counter_device *counter, else *function = COUNTER_FUNCTION_PULSE_DIRECTION; - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -758,10 +782,11 @@ static int quad8_function_write(struct counter_device *counter, unsigned int *const scale = priv->quadrature_scale + id; unsigned int *const synchronous_mode = priv->synchronous_mode + id; const int base_offset = priv->base + 2 * id + 1; + unsigned long irqflags; unsigned int mode_cfg; unsigned int idr_cfg; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); mode_cfg = priv->count_mode[id] << 1; idr_cfg = priv->index_polarity[id] << 1; @@ -795,7 +820,7 @@ static int quad8_function_write(struct counter_device *counter, mode_cfg |= QUAD8_CMR_QUADRATURE_X4; break; default: - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } } @@ -803,7 +828,7 @@ static int quad8_function_write(struct counter_device *counter, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -898,13 +923,62 @@ static int quad8_action_read(struct counter_device *counter, return 0; } +static int quad8_events_configure(struct counter_device *counter) +{ + struct quad8_iio *const priv = counter->priv; + unsigned long irq_enabled = 0; + struct counter_event_node *event_node; + + /* Enable interrupts for the requested channels, disable for the rest */ + list_for_each_entry(event_node, &counter->events_list, l) + irq_enabled |= BIT(event_node->channel); + + outb(irq_enabled, priv->base + QUAD8_REG_INDEX_INTERRUPT); + + return 0; +} + +static int quad8_watch_validate(struct counter_device *counter, + const struct counter_watch *watch) +{ + struct quad8_iio *const priv = counter->priv; + + if (watch->channel > QUAD8_NUM_COUNTERS - 1) + return -EINVAL; + + switch (watch->event) { + case COUNTER_EVENT_OVERFLOW: + if (priv->irq_trigger[watch->channel] != 0) + return -EINVAL; + break; + case COUNTER_EVENT_THRESHOLD: + if (priv->irq_trigger[watch->channel] != 1) + return -EINVAL; + break; + case COUNTER_EVENT_OVERFLOW_UNDERFLOW: + if (priv->irq_trigger[watch->channel] != 2) + return -EINVAL; + break; + case COUNTER_EVENT_INDEX: + if (priv->irq_trigger[watch->channel] != 3) + return -EINVAL; + break; + default: + return -EINVAL; + } + + return 0; +} + static const struct counter_ops quad8_ops = { .signal_read = quad8_signal_read, .count_read = quad8_count_read, .count_write = quad8_count_write, .function_read = quad8_function_read, .function_write = quad8_function_write, - .action_read = quad8_action_read + .action_read = quad8_action_read, + .events_configure = quad8_events_configure, + .watch_validate = quad8_watch_validate, }; static int quad8_index_polarity_get(struct counter_device *counter, @@ -926,9 +1000,10 @@ static int quad8_index_polarity_set(struct counter_device *counter, struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; const int base_offset = priv->base + 2 * channel_id + 1; + unsigned long irqflags; unsigned int idr_cfg = index_polarity << 1; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->synchronous_mode[channel_id]; @@ -937,7 +1012,7 @@ static int quad8_index_polarity_set(struct counter_device *counter, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -961,15 +1036,16 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; const int base_offset = priv->base + 2 * channel_id + 1; + unsigned long irqflags; unsigned int idr_cfg = synchronous_mode; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->index_polarity[channel_id] << 1; /* Index function must be non-synchronous in non-quadrature mode */ if (synchronous_mode && !priv->quadrature_mode[channel_id]) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } @@ -978,7 +1054,7 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1025,6 +1101,7 @@ static int quad8_count_mode_write(struct counter_device *counter, unsigned int count_mode; unsigned int mode_cfg; const int base_offset = priv->base + 2 * count->id + 1; + unsigned long irqflags; /* Map Generic Counter count mode to 104-QUAD-8 count mode */ switch (cnt_mode) { @@ -1044,7 +1121,7 @@ static int quad8_count_mode_write(struct counter_device *counter, return -EINVAL; } - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->count_mode[count->id] = count_mode; @@ -1058,7 +1135,7 @@ static int quad8_count_mode_write(struct counter_device *counter, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1078,18 +1155,20 @@ static int quad8_count_enable_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id; + unsigned long irqflags; unsigned int ior_cfg; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->ab_enable[count->id] = enable; - ior_cfg = enable | priv->preset_enable[count->id] << 1; + ior_cfg = enable | priv->preset_enable[count->id] << 1 | + priv->irq_trigger[count->id] << 3; /* Load I/O control configuration */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1135,16 +1214,17 @@ static int quad8_count_preset_write(struct counter_device *counter, struct counter_count *count, u64 preset) { struct quad8_iio *const priv = counter->priv; + unsigned long irqflags; /* Only 24-bit values are supported */ if (preset > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); quad8_preset_register_set(priv, count->id, preset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1153,8 +1233,9 @@ static int quad8_count_ceiling_read(struct counter_device *counter, struct counter_count *count, u64 *ceiling) { struct quad8_iio *const priv = counter->priv; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Range Limit and Modulo-N count modes use preset value as ceiling */ switch (priv->count_mode[count->id]) { @@ -1168,7 +1249,7 @@ static int quad8_count_ceiling_read(struct counter_device *counter, break; } - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1177,12 +1258,13 @@ static int quad8_count_ceiling_write(struct counter_device *counter, struct counter_count *count, u64 ceiling) { struct quad8_iio *const priv = counter->priv; + unsigned long irqflags; /* Only 24-bit values are supported */ if (ceiling > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Range Limit and Modulo-N count modes use preset value as ceiling */ switch (priv->count_mode[count->id]) { @@ -1192,7 +1274,7 @@ static int quad8_count_ceiling_write(struct counter_device *counter, break; } - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } @@ -1214,21 +1296,56 @@ static int quad8_count_preset_enable_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id + 1; + unsigned long irqflags; unsigned int ior_cfg; /* Preset enable is active low in Input/Output Control register */ preset_enable = !preset_enable; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->preset_enable[count->id] = preset_enable; - ior_cfg = priv->ab_enable[count->id] | preset_enable << 1; + ior_cfg = priv->ab_enable[count->id] | preset_enable << 1 | + priv->irq_trigger[count->id] << 3; + + /* Load I/O control configuration to Input / Output Control Register */ + outb(QUAD8_CTR_IOR | ior_cfg, base_offset); + + raw_spin_unlock_irqrestore(&priv->lock, irqflags); + + return 0; +} + +static int quad8_irq_trigger_get(struct counter_device *counter, + struct counter_count *count, u32 *irq_trigger) +{ + const struct quad8_iio *const priv = counter->priv; + + *irq_trigger = priv->irq_trigger[count->id]; + + return 0; +} + +static int quad8_irq_trigger_set(struct counter_device *counter, + struct counter_count *count, u32 irq_trigger) +{ + struct quad8_iio *const priv = counter->priv; + const unsigned long base_offset = priv->base + 2 * count->id + 1; + unsigned long irqflags; + unsigned long ior_cfg; + + raw_spin_lock_irqsave(&priv->lock, irqflags); + + priv->irq_trigger[count->id] = irq_trigger; + + ior_cfg = priv->ab_enable[count->id] | + priv->preset_enable[count->id] << 1 | irq_trigger << 3; /* Load I/O control configuration to Input / Output Control Register */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1239,22 +1356,23 @@ static int quad8_signal_cable_fault_read(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; + unsigned long irqflags; bool disabled; unsigned int status; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); disabled = !(priv->cable_fault_enable & BIT(channel_id)); if (disabled) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } /* Logic 0 = cable fault */ status = inb(priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); /* Mask respective channel and invert logic */ *cable_fault = !(status & BIT(channel_id)); @@ -1280,9 +1398,10 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; + unsigned long irqflags; unsigned int cable_fault_enable; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); if (enable) priv->cable_fault_enable |= BIT(channel_id); @@ -1294,7 +1413,7 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, outb(cable_fault_enable, priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1317,8 +1436,9 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; const int base_offset = priv->base + 2 * channel_id; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->fck_prescaler[channel_id] = prescaler; @@ -1330,7 +1450,7 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_PRESET_PSC, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1433,7 +1553,15 @@ static const enum counter_count_mode quad8_cnt_modes[] = { static DEFINE_COUNTER_AVAILABLE(quad8_count_mode_available, quad8_cnt_modes); +static const char *const quad8_irq_trigger_states[] = { + "carry", + "compare", + "carry-borrow", + "index", +}; + static DEFINE_COUNTER_ENUM(quad8_error_noise_enum, quad8_noise_error_states); +static DEFINE_COUNTER_ENUM(quad8_irq_trigger_enum, quad8_irq_trigger_states); static struct counter_comp quad8_count_ext[] = { COUNTER_COMP_CEILING(quad8_count_ceiling_read, @@ -1448,6 +1576,8 @@ static struct counter_comp quad8_count_ext[] = { COUNTER_COMP_PRESET(quad8_count_preset_read, quad8_count_preset_write), COUNTER_COMP_PRESET_ENABLE(quad8_count_preset_enable_read, quad8_count_preset_enable_write), + COUNTER_COMP_COUNT_ENUM("irq_trigger", quad8_irq_trigger_get, + quad8_irq_trigger_set, quad8_irq_trigger_enum), }; #define QUAD8_COUNT(_id, _cntname) { \ @@ -1472,6 +1602,48 @@ static struct counter_count quad8_counts[] = { QUAD8_COUNT(7, "Channel 8 Count") }; +static irqreturn_t quad8_irq_handler(int irq, void *quad8iio) +{ + struct quad8_iio *const priv = quad8iio; + const unsigned long base = priv->base; + unsigned long irq_status; + unsigned long channel; + u8 event; + + irq_status = inb(base + QUAD8_REG_INTERRUPT_STATUS); + if (!irq_status) + return IRQ_NONE; + + for_each_set_bit(channel, &irq_status, QUAD8_NUM_COUNTERS) { + switch (priv->irq_trigger[channel]) { + case 0: + event = COUNTER_EVENT_OVERFLOW; + break; + case 1: + event = COUNTER_EVENT_THRESHOLD; + break; + case 2: + event = COUNTER_EVENT_OVERFLOW_UNDERFLOW; + break; + case 3: + event = COUNTER_EVENT_INDEX; + break; + default: + /* should never reach this path */ + WARN_ONCE(true, "invalid interrupt trigger function %u configured for channel %lu\n", + priv->irq_trigger[channel], channel); + continue; + } + + counter_push_event(&priv->counter, event, channel); + } + + /* Clear pending interrupts on device */ + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base + QUAD8_REG_CHAN_OP); + + return IRQ_HANDLED; +} + static int quad8_probe(struct device *dev, unsigned int id) { struct iio_dev *indio_dev; @@ -1510,9 +1682,10 @@ static int quad8_probe(struct device *dev, unsigned int id) quad8iio->counter.priv = quad8iio; quad8iio->base = base[id]; - /* Initialize mutex */ - mutex_init(&quad8iio->lock); + raw_spin_lock_init(&quad8iio->lock); + /* Reset Index/Interrupt Register */ + outb(0x00, base[id] + QUAD8_REG_INDEX_INTERRUPT); /* Reset all counters and disable interrupt function */ outb(QUAD8_CHAN_OP_RESET_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); /* Set initial configuration for all counters */ @@ -1542,8 +1715,8 @@ static int quad8_probe(struct device *dev, unsigned int id) } /* Disable Differential Encoder Cable Status for all channels */ outb(0xFF, base[id] + QUAD8_DIFF_ENCODER_CABLE_STATUS); - /* Enable all counters */ - outb(QUAD8_CHAN_OP_ENABLE_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); + /* Enable all counters and enable interrupt function */ + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base[id] + QUAD8_REG_CHAN_OP); /* Register IIO device */ err = devm_iio_device_register(dev, indio_dev); @@ -1551,7 +1724,12 @@ static int quad8_probe(struct device *dev, unsigned int id) return err; /* Register Counter device */ - return devm_counter_register(dev, &quad8iio->counter); + err = devm_counter_register(dev, &quad8iio->counter); + if (err) + return err; + + return devm_request_irq(dev, irq[id], quad8_irq_handler, IRQF_SHARED, + quad8iio->counter.name, quad8iio); } static struct isa_driver quad8_driver = { diff --git a/drivers/counter/Kconfig b/drivers/counter/Kconfig index 2de53ab0dd25..bd42df98f522 100644 --- a/drivers/counter/Kconfig +++ b/drivers/counter/Kconfig @@ -23,11 +23,11 @@ config 104_QUAD_8 A counter's respective error flag may be cleared by performing a write operation on the respective count value attribute. Although the 104-QUAD-8 counters have a 25-bit range, only the lower 24 bits may be - set, either directly or via the counter's preset attribute. Interrupts - are not supported by this driver. + set, either directly or via the counter's preset attribute. The base port addresses for the devices may be configured via the base - array module parameter. + array module parameter. The interrupt line numbers for the devices may + be configured via the irq array module parameter. config STM32_TIMER_CNT tristate "STM32 Timer encoder counter driver" -- 2.29.2 ^ permalink raw reply related [flat|nested] 51+ messages in thread
* [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 @ 2020-12-26 0:15 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2020-12-26 0:15 UTC (permalink / raw) To: jic23 Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, William Breathitt Gray, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue The LSI/CSI LS7266R1 chip provides programmable output via the FLG pins. When interrupts are enabled on the ACCES 104-QUAD-8, they occur whenever FLG1 is active. Four functions are available for the FLG1 signal: Carry, Compare, Carry-Borrow, and Index. Carry: Interrupt generated on active low Carry signal. Carry signal toggles every time the respective channel's counter overflows. Compare: Interrupt generated on active low Compare signal. Compare signal toggles every time respective channel's preset register is equal to the respective channel's counter. Carry-Borrow: Interrupt generated on active low Carry signal and active low Borrow signal. Carry signal toggles every time the respective channel's counter overflows. Borrow signal toggles every time the respective channel's counter underflows. Index: Interrupt generated on active high Index signal. The irq_trigger Count extension is introduced to allow the selection of the desired IRQ trigger function per channel. Interrupts push Counter events to event channel X, where 'X' is the respective channel whose FLG1 activated. This patch adds IRQ support for the ACCES 104-QUAD-8. The interrupt line numbers for the devices may be configured via the irq array module parameter. Reviewed-by: Syed Nayyar Waris <syednwaris@gmail.com> Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> --- .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 ++ drivers/counter/104-quad-8.c | 318 ++++++++++++++---- drivers/counter/Kconfig | 6 +- 3 files changed, 276 insertions(+), 73 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 index eac32180c40d..0ecba24d43aa 100644 --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 @@ -1,3 +1,28 @@ +What: /sys/bus/counter/devices/counterX/countY/irq_trigger +KernelVersion: 5.12 +Contact: linux-iio@vger.kernel.org +Description: + IRQ trigger function for channel Y. Four trigger functions are + available: carry, compare, carry-borrow, and index. + + carry: + Interrupt generated on active low Carry signal. Carry + signal toggles every time channel Y counter overflows. + + compare: + Interrupt generated on active low Compare signal. + Compare signal toggles every time channel Y preset + register is equal to channel Y counter. + + carry-borrow: + Interrupt generated on active low Carry signal and + active low Borrow signal. Carry signal toggles every + time channel Y counter overflows. Borrow signal toggles + every time channel Y counter underflows. + + index: + Interrupt generated on active high Index signal. + What: /sys/bus/counter/devices/counterX/signalY/cable_fault KernelVersion: 5.7 Contact: linux-iio@vger.kernel.org diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c index f4fb36b751c4..7537575568d0 100644 --- a/drivers/counter/104-quad-8.c +++ b/drivers/counter/104-quad-8.c @@ -13,23 +13,30 @@ #include <linux/iio/types.h> #include <linux/io.h> #include <linux/ioport.h> +#include <linux/interrupt.h> #include <linux/isa.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/moduleparam.h> #include <linux/types.h> +#include <linux/spinlock.h> #define QUAD8_EXTENT 32 static unsigned int base[max_num_isa_dev(QUAD8_EXTENT)]; static unsigned int num_quad8; -module_param_array(base, uint, &num_quad8, 0); +module_param_hw_array(base, uint, ioport, &num_quad8, 0); MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); +static unsigned int irq[max_num_isa_dev(QUAD8_EXTENT)]; +module_param_hw_array(irq, uint, irq, NULL, 0); +MODULE_PARM_DESC(irq, "ACCES 104-QUAD-8 interrupt line numbers"); + #define QUAD8_NUM_COUNTERS 8 /** * struct quad8_iio - IIO device private data structure + * @lock: synchronization lock to prevent I/O race conditions * @counter: instance of the counter_device * @fck_prescaler: array of filter clock prescaler configurations * @preset: array of preset values @@ -38,13 +45,14 @@ MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); * @quadrature_scale: array of quadrature mode scale configurations * @ab_enable: array of A and B inputs enable configurations * @preset_enable: array of set_to_preset_on_index attribute configurations + * @irq_trigger: array of interrupt trigger function configurations * @synchronous_mode: array of index function synchronous mode configurations * @index_polarity: array of index function polarity configurations * @cable_fault_enable: differential encoder cable status enable configurations * @base: base port address of the IIO device */ struct quad8_iio { - struct mutex lock; + raw_spinlock_t lock; struct counter_device counter; unsigned int fck_prescaler[QUAD8_NUM_COUNTERS]; unsigned int preset[QUAD8_NUM_COUNTERS]; @@ -53,13 +61,16 @@ struct quad8_iio { unsigned int quadrature_scale[QUAD8_NUM_COUNTERS]; unsigned int ab_enable[QUAD8_NUM_COUNTERS]; unsigned int preset_enable[QUAD8_NUM_COUNTERS]; + unsigned int irq_trigger[QUAD8_NUM_COUNTERS]; unsigned int synchronous_mode[QUAD8_NUM_COUNTERS]; unsigned int index_polarity[QUAD8_NUM_COUNTERS]; unsigned int cable_fault_enable; unsigned int base; }; +#define QUAD8_REG_INTERRUPT_STATUS 0x10 #define QUAD8_REG_CHAN_OP 0x11 +#define QUAD8_REG_INDEX_INTERRUPT 0x12 #define QUAD8_REG_INDEX_INPUT_LEVELS 0x16 #define QUAD8_DIFF_ENCODER_CABLE_STATUS 0x17 /* Borrow Toggle flip-flop */ @@ -92,8 +103,8 @@ struct quad8_iio { #define QUAD8_RLD_CNTR_OUT 0x10 /* Transfer Preset Register LSB to FCK Prescaler */ #define QUAD8_RLD_PRESET_PSC 0x18 -#define QUAD8_CHAN_OP_ENABLE_COUNTERS 0x00 #define QUAD8_CHAN_OP_RESET_COUNTERS 0x01 +#define QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC 0x04 #define QUAD8_CMR_QUADRATURE_X1 0x08 #define QUAD8_CMR_QUADRATURE_X2 0x10 #define QUAD8_CMR_QUADRATURE_X4 0x18 @@ -107,6 +118,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, unsigned int flags; unsigned int borrow; unsigned int carry; + unsigned long irqflags; int i; switch (mask) { @@ -124,7 +136,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, /* Borrow XOR Carry effectively doubles count range */ *val = (borrow ^ carry) << 24; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Reset Byte Pointer; transfer Counter to Output Latch */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, @@ -133,7 +145,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, for (i = 0; i < 3; i++) *val |= (unsigned int)inb(base_offset) << (8 * i); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return IIO_VAL_INT; case IIO_CHAN_INFO_ENABLE: @@ -153,6 +165,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, { struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel; + unsigned long flags; int i; unsigned int ior_cfg; @@ -165,7 +178,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, if ((unsigned int)val > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, flags); /* Reset Byte Pointer */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); @@ -190,7 +203,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, /* Reset Error flag */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return 0; case IIO_CHAN_INFO_ENABLE: @@ -198,25 +211,26 @@ static int quad8_write_raw(struct iio_dev *indio_dev, if (val < 0 || val > 1) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, flags); priv->ab_enable[chan->channel] = val; - ior_cfg = val | priv->preset_enable[chan->channel] << 1; + ior_cfg = val | priv->preset_enable[chan->channel] << 1 | + priv->irq_trigger[chan->channel] << 3; /* Load I/O control configuration */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return 0; case IIO_CHAN_INFO_SCALE: - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, flags); /* Quadrature scaling only available in quadrature mode */ if (!priv->quadrature_mode[chan->channel] && (val2 || val != 1)) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return -EINVAL; } @@ -232,15 +246,15 @@ static int quad8_write_raw(struct iio_dev *indio_dev, priv->quadrature_scale[chan->channel] = 2; break; default: - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return -EINVAL; } else { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return -EINVAL; } - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, flags); return 0; } @@ -266,6 +280,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel; unsigned int preset; + unsigned long irqflags; int ret; int i; @@ -277,7 +292,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, if (preset > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->preset[chan->channel] = preset; @@ -288,7 +303,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, for (i = 0; i < 3; i++) outb(preset >> (8 * i), base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return len; } @@ -309,6 +324,7 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; bool preset_enable; + unsigned long irqflags; int ret; unsigned int ior_cfg; @@ -319,17 +335,18 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, /* Preset enable is active low in Input/Output Control register */ preset_enable = !preset_enable; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->preset_enable[chan->channel] = preset_enable; ior_cfg = priv->ab_enable[chan->channel] | - (unsigned int)preset_enable << 1; + (unsigned int)preset_enable << 1 | + priv->irq_trigger[chan->channel] << 3; /* Load I/O control configuration to Input / Output Control Register */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return len; } @@ -387,8 +404,9 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); unsigned int mode_cfg = cnt_mode << 1; const int base_offset = priv->base + 2 * chan->channel + 1; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->count_mode[chan->channel] = cnt_mode; @@ -399,7 +417,7 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -430,14 +448,15 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; unsigned int idr_cfg = synchronous_mode; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->index_polarity[chan->channel] << 1; /* Index function must be non-synchronous in non-quadrature mode */ if (synchronous_mode && !priv->quadrature_mode[chan->channel]) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } @@ -446,7 +465,7 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -476,9 +495,10 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, { struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; + unsigned long irqflags; unsigned int mode_cfg; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); mode_cfg = priv->count_mode[chan->channel] << 1; @@ -498,7 +518,7 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -529,8 +549,9 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, struct quad8_iio *const priv = iio_priv(indio_dev); const int base_offset = priv->base + 2 * chan->channel + 1; unsigned int idr_cfg = index_polarity << 1; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->synchronous_mode[chan->channel]; @@ -539,7 +560,7 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -647,6 +668,7 @@ static int quad8_count_read(struct counter_device *counter, unsigned int flags; unsigned int borrow; unsigned int carry; + unsigned long irqflags; int i; flags = inb(base_offset + 1); @@ -656,7 +678,7 @@ static int quad8_count_read(struct counter_device *counter, /* Borrow XOR Carry effectively doubles count range */ *val = (unsigned long)(borrow ^ carry) << 24; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Reset Byte Pointer; transfer Counter to Output Latch */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, @@ -665,7 +687,7 @@ static int quad8_count_read(struct counter_device *counter, for (i = 0; i < 3; i++) *val |= (unsigned long)inb(base_offset) << (8 * i); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -675,13 +697,14 @@ static int quad8_count_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id; + unsigned long irqflags; int i; /* Only 24-bit values are supported */ if (val > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Reset Byte Pointer */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); @@ -706,7 +729,7 @@ static int quad8_count_write(struct counter_device *counter, /* Reset Error flag */ outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -725,8 +748,9 @@ static int quad8_function_read(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int id = count->id; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); if (priv->quadrature_mode[id]) switch (priv->quadrature_scale[id]) { @@ -743,7 +767,7 @@ static int quad8_function_read(struct counter_device *counter, else *function = COUNTER_FUNCTION_PULSE_DIRECTION; - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -758,10 +782,11 @@ static int quad8_function_write(struct counter_device *counter, unsigned int *const scale = priv->quadrature_scale + id; unsigned int *const synchronous_mode = priv->synchronous_mode + id; const int base_offset = priv->base + 2 * id + 1; + unsigned long irqflags; unsigned int mode_cfg; unsigned int idr_cfg; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); mode_cfg = priv->count_mode[id] << 1; idr_cfg = priv->index_polarity[id] << 1; @@ -795,7 +820,7 @@ static int quad8_function_write(struct counter_device *counter, mode_cfg |= QUAD8_CMR_QUADRATURE_X4; break; default: - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } } @@ -803,7 +828,7 @@ static int quad8_function_write(struct counter_device *counter, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -898,13 +923,62 @@ static int quad8_action_read(struct counter_device *counter, return 0; } +static int quad8_events_configure(struct counter_device *counter) +{ + struct quad8_iio *const priv = counter->priv; + unsigned long irq_enabled = 0; + struct counter_event_node *event_node; + + /* Enable interrupts for the requested channels, disable for the rest */ + list_for_each_entry(event_node, &counter->events_list, l) + irq_enabled |= BIT(event_node->channel); + + outb(irq_enabled, priv->base + QUAD8_REG_INDEX_INTERRUPT); + + return 0; +} + +static int quad8_watch_validate(struct counter_device *counter, + const struct counter_watch *watch) +{ + struct quad8_iio *const priv = counter->priv; + + if (watch->channel > QUAD8_NUM_COUNTERS - 1) + return -EINVAL; + + switch (watch->event) { + case COUNTER_EVENT_OVERFLOW: + if (priv->irq_trigger[watch->channel] != 0) + return -EINVAL; + break; + case COUNTER_EVENT_THRESHOLD: + if (priv->irq_trigger[watch->channel] != 1) + return -EINVAL; + break; + case COUNTER_EVENT_OVERFLOW_UNDERFLOW: + if (priv->irq_trigger[watch->channel] != 2) + return -EINVAL; + break; + case COUNTER_EVENT_INDEX: + if (priv->irq_trigger[watch->channel] != 3) + return -EINVAL; + break; + default: + return -EINVAL; + } + + return 0; +} + static const struct counter_ops quad8_ops = { .signal_read = quad8_signal_read, .count_read = quad8_count_read, .count_write = quad8_count_write, .function_read = quad8_function_read, .function_write = quad8_function_write, - .action_read = quad8_action_read + .action_read = quad8_action_read, + .events_configure = quad8_events_configure, + .watch_validate = quad8_watch_validate, }; static int quad8_index_polarity_get(struct counter_device *counter, @@ -926,9 +1000,10 @@ static int quad8_index_polarity_set(struct counter_device *counter, struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; const int base_offset = priv->base + 2 * channel_id + 1; + unsigned long irqflags; unsigned int idr_cfg = index_polarity << 1; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->synchronous_mode[channel_id]; @@ -937,7 +1012,7 @@ static int quad8_index_polarity_set(struct counter_device *counter, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -961,15 +1036,16 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id - 16; const int base_offset = priv->base + 2 * channel_id + 1; + unsigned long irqflags; unsigned int idr_cfg = synchronous_mode; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); idr_cfg |= priv->index_polarity[channel_id] << 1; /* Index function must be non-synchronous in non-quadrature mode */ if (synchronous_mode && !priv->quadrature_mode[channel_id]) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } @@ -978,7 +1054,7 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, /* Load Index Control configuration to Index Control Register */ outb(QUAD8_CTR_IDR | idr_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1025,6 +1101,7 @@ static int quad8_count_mode_write(struct counter_device *counter, unsigned int count_mode; unsigned int mode_cfg; const int base_offset = priv->base + 2 * count->id + 1; + unsigned long irqflags; /* Map Generic Counter count mode to 104-QUAD-8 count mode */ switch (cnt_mode) { @@ -1044,7 +1121,7 @@ static int quad8_count_mode_write(struct counter_device *counter, return -EINVAL; } - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->count_mode[count->id] = count_mode; @@ -1058,7 +1135,7 @@ static int quad8_count_mode_write(struct counter_device *counter, /* Load mode configuration to Counter Mode Register */ outb(QUAD8_CTR_CMR | mode_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1078,18 +1155,20 @@ static int quad8_count_enable_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id; + unsigned long irqflags; unsigned int ior_cfg; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->ab_enable[count->id] = enable; - ior_cfg = enable | priv->preset_enable[count->id] << 1; + ior_cfg = enable | priv->preset_enable[count->id] << 1 | + priv->irq_trigger[count->id] << 3; /* Load I/O control configuration */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1135,16 +1214,17 @@ static int quad8_count_preset_write(struct counter_device *counter, struct counter_count *count, u64 preset) { struct quad8_iio *const priv = counter->priv; + unsigned long irqflags; /* Only 24-bit values are supported */ if (preset > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); quad8_preset_register_set(priv, count->id, preset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1153,8 +1233,9 @@ static int quad8_count_ceiling_read(struct counter_device *counter, struct counter_count *count, u64 *ceiling) { struct quad8_iio *const priv = counter->priv; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Range Limit and Modulo-N count modes use preset value as ceiling */ switch (priv->count_mode[count->id]) { @@ -1168,7 +1249,7 @@ static int quad8_count_ceiling_read(struct counter_device *counter, break; } - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1177,12 +1258,13 @@ static int quad8_count_ceiling_write(struct counter_device *counter, struct counter_count *count, u64 ceiling) { struct quad8_iio *const priv = counter->priv; + unsigned long irqflags; /* Only 24-bit values are supported */ if (ceiling > 0xFFFFFF) return -EINVAL; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); /* Range Limit and Modulo-N count modes use preset value as ceiling */ switch (priv->count_mode[count->id]) { @@ -1192,7 +1274,7 @@ static int quad8_count_ceiling_write(struct counter_device *counter, break; } - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } @@ -1214,21 +1296,56 @@ static int quad8_count_preset_enable_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const int base_offset = priv->base + 2 * count->id + 1; + unsigned long irqflags; unsigned int ior_cfg; /* Preset enable is active low in Input/Output Control register */ preset_enable = !preset_enable; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->preset_enable[count->id] = preset_enable; - ior_cfg = priv->ab_enable[count->id] | preset_enable << 1; + ior_cfg = priv->ab_enable[count->id] | preset_enable << 1 | + priv->irq_trigger[count->id] << 3; + + /* Load I/O control configuration to Input / Output Control Register */ + outb(QUAD8_CTR_IOR | ior_cfg, base_offset); + + raw_spin_unlock_irqrestore(&priv->lock, irqflags); + + return 0; +} + +static int quad8_irq_trigger_get(struct counter_device *counter, + struct counter_count *count, u32 *irq_trigger) +{ + const struct quad8_iio *const priv = counter->priv; + + *irq_trigger = priv->irq_trigger[count->id]; + + return 0; +} + +static int quad8_irq_trigger_set(struct counter_device *counter, + struct counter_count *count, u32 irq_trigger) +{ + struct quad8_iio *const priv = counter->priv; + const unsigned long base_offset = priv->base + 2 * count->id + 1; + unsigned long irqflags; + unsigned long ior_cfg; + + raw_spin_lock_irqsave(&priv->lock, irqflags); + + priv->irq_trigger[count->id] = irq_trigger; + + ior_cfg = priv->ab_enable[count->id] | + priv->preset_enable[count->id] << 1 | irq_trigger << 3; /* Load I/O control configuration to Input / Output Control Register */ outb(QUAD8_CTR_IOR | ior_cfg, base_offset); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1239,22 +1356,23 @@ static int quad8_signal_cable_fault_read(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; + unsigned long irqflags; bool disabled; unsigned int status; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); disabled = !(priv->cable_fault_enable & BIT(channel_id)); if (disabled) { - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return -EINVAL; } /* Logic 0 = cable fault */ status = inb(priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); /* Mask respective channel and invert logic */ *cable_fault = !(status & BIT(channel_id)); @@ -1280,9 +1398,10 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, { struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; + unsigned long irqflags; unsigned int cable_fault_enable; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); if (enable) priv->cable_fault_enable |= BIT(channel_id); @@ -1294,7 +1413,7 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, outb(cable_fault_enable, priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1317,8 +1436,9 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, struct quad8_iio *const priv = counter->priv; const size_t channel_id = signal->id / 2; const int base_offset = priv->base + 2 * channel_id; + unsigned long irqflags; - mutex_lock(&priv->lock); + raw_spin_lock_irqsave(&priv->lock, irqflags); priv->fck_prescaler[channel_id] = prescaler; @@ -1330,7 +1450,7 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_PRESET_PSC, base_offset + 1); - mutex_unlock(&priv->lock); + raw_spin_unlock_irqrestore(&priv->lock, irqflags); return 0; } @@ -1433,7 +1553,15 @@ static const enum counter_count_mode quad8_cnt_modes[] = { static DEFINE_COUNTER_AVAILABLE(quad8_count_mode_available, quad8_cnt_modes); +static const char *const quad8_irq_trigger_states[] = { + "carry", + "compare", + "carry-borrow", + "index", +}; + static DEFINE_COUNTER_ENUM(quad8_error_noise_enum, quad8_noise_error_states); +static DEFINE_COUNTER_ENUM(quad8_irq_trigger_enum, quad8_irq_trigger_states); static struct counter_comp quad8_count_ext[] = { COUNTER_COMP_CEILING(quad8_count_ceiling_read, @@ -1448,6 +1576,8 @@ static struct counter_comp quad8_count_ext[] = { COUNTER_COMP_PRESET(quad8_count_preset_read, quad8_count_preset_write), COUNTER_COMP_PRESET_ENABLE(quad8_count_preset_enable_read, quad8_count_preset_enable_write), + COUNTER_COMP_COUNT_ENUM("irq_trigger", quad8_irq_trigger_get, + quad8_irq_trigger_set, quad8_irq_trigger_enum), }; #define QUAD8_COUNT(_id, _cntname) { \ @@ -1472,6 +1602,48 @@ static struct counter_count quad8_counts[] = { QUAD8_COUNT(7, "Channel 8 Count") }; +static irqreturn_t quad8_irq_handler(int irq, void *quad8iio) +{ + struct quad8_iio *const priv = quad8iio; + const unsigned long base = priv->base; + unsigned long irq_status; + unsigned long channel; + u8 event; + + irq_status = inb(base + QUAD8_REG_INTERRUPT_STATUS); + if (!irq_status) + return IRQ_NONE; + + for_each_set_bit(channel, &irq_status, QUAD8_NUM_COUNTERS) { + switch (priv->irq_trigger[channel]) { + case 0: + event = COUNTER_EVENT_OVERFLOW; + break; + case 1: + event = COUNTER_EVENT_THRESHOLD; + break; + case 2: + event = COUNTER_EVENT_OVERFLOW_UNDERFLOW; + break; + case 3: + event = COUNTER_EVENT_INDEX; + break; + default: + /* should never reach this path */ + WARN_ONCE(true, "invalid interrupt trigger function %u configured for channel %lu\n", + priv->irq_trigger[channel], channel); + continue; + } + + counter_push_event(&priv->counter, event, channel); + } + + /* Clear pending interrupts on device */ + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base + QUAD8_REG_CHAN_OP); + + return IRQ_HANDLED; +} + static int quad8_probe(struct device *dev, unsigned int id) { struct iio_dev *indio_dev; @@ -1510,9 +1682,10 @@ static int quad8_probe(struct device *dev, unsigned int id) quad8iio->counter.priv = quad8iio; quad8iio->base = base[id]; - /* Initialize mutex */ - mutex_init(&quad8iio->lock); + raw_spin_lock_init(&quad8iio->lock); + /* Reset Index/Interrupt Register */ + outb(0x00, base[id] + QUAD8_REG_INDEX_INTERRUPT); /* Reset all counters and disable interrupt function */ outb(QUAD8_CHAN_OP_RESET_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); /* Set initial configuration for all counters */ @@ -1542,8 +1715,8 @@ static int quad8_probe(struct device *dev, unsigned int id) } /* Disable Differential Encoder Cable Status for all channels */ outb(0xFF, base[id] + QUAD8_DIFF_ENCODER_CABLE_STATUS); - /* Enable all counters */ - outb(QUAD8_CHAN_OP_ENABLE_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); + /* Enable all counters and enable interrupt function */ + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base[id] + QUAD8_REG_CHAN_OP); /* Register IIO device */ err = devm_iio_device_register(dev, indio_dev); @@ -1551,7 +1724,12 @@ static int quad8_probe(struct device *dev, unsigned int id) return err; /* Register Counter device */ - return devm_counter_register(dev, &quad8iio->counter); + err = devm_counter_register(dev, &quad8iio->counter); + if (err) + return err; + + return devm_request_irq(dev, irq[id], quad8_irq_handler, IRQF_SHARED, + quad8iio->counter.name, quad8iio); } static struct isa_driver quad8_driver = { diff --git a/drivers/counter/Kconfig b/drivers/counter/Kconfig index 2de53ab0dd25..bd42df98f522 100644 --- a/drivers/counter/Kconfig +++ b/drivers/counter/Kconfig @@ -23,11 +23,11 @@ config 104_QUAD_8 A counter's respective error flag may be cleared by performing a write operation on the respective count value attribute. Although the 104-QUAD-8 counters have a 25-bit range, only the lower 24 bits may be - set, either directly or via the counter's preset attribute. Interrupts - are not supported by this driver. + set, either directly or via the counter's preset attribute. The base port addresses for the devices may be configured via the base - array module parameter. + array module parameter. The interrupt line numbers for the devices may + be configured via the irq array module parameter. config STM32_TIMER_CNT tristate "STM32 Timer encoder counter driver" -- 2.29.2 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply related [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 15:31 ` Jonathan Cameron -1 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 15:31 UTC (permalink / raw) To: William Breathitt Gray Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue On Fri, 25 Dec 2020 19:15:38 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > The LSI/CSI LS7266R1 chip provides programmable output via the FLG pins. > When interrupts are enabled on the ACCES 104-QUAD-8, they occur whenever > FLG1 is active. Four functions are available for the FLG1 signal: Carry, > Compare, Carry-Borrow, and Index. > > Carry: > Interrupt generated on active low Carry signal. Carry > signal toggles every time the respective channel's > counter overflows. > > Compare: > Interrupt generated on active low Compare signal. > Compare signal toggles every time respective channel's > preset register is equal to the respective channel's > counter. > > Carry-Borrow: > Interrupt generated on active low Carry signal and > active low Borrow signal. Carry signal toggles every > time the respective channel's counter overflows. Borrow > signal toggles every time the respective channel's > counter underflows. > > Index: > Interrupt generated on active high Index signal. > > The irq_trigger Count extension is introduced to allow the selection of > the desired IRQ trigger function per channel. Interrupts push Counter > events to event channel X, where 'X' is the respective channel whose > FLG1 activated. > > This patch adds IRQ support for the ACCES 104-QUAD-8. The interrupt line > numbers for the devices may be configured via the irq array module > parameter. > > Reviewed-by: Syed Nayyar Waris <syednwaris@gmail.com> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> Immediate thought on this is that you should pull the lock type change out as a precursor patch that simply says we need it to be a spin_lock for the following patch. That should be an obvious change to review and then leave a much shorter patch to focus on here. Jonathan > --- > .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 ++ > drivers/counter/104-quad-8.c | 318 ++++++++++++++---- > drivers/counter/Kconfig | 6 +- > 3 files changed, 276 insertions(+), 73 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > index eac32180c40d..0ecba24d43aa 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > @@ -1,3 +1,28 @@ > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger A warning on this. The ABI docs are now built into the main kernel html docs build. The snag is that it doesn't cope will with specialising or different devices having the same named file with different allowed values. You have to unify them all into one place. It may be worth just doing that from the start. > +KernelVersion: 5.12 > +Contact: linux-iio@vger.kernel.org > +Description: > + IRQ trigger function for channel Y. Four trigger functions are > + available: carry, compare, carry-borrow, and index. > + > + carry: > + Interrupt generated on active low Carry signal. Carry > + signal toggles every time channel Y counter overflows. > + > + compare: > + Interrupt generated on active low Compare signal. > + Compare signal toggles every time channel Y preset > + register is equal to channel Y counter. > + > + carry-borrow: > + Interrupt generated on active low Carry signal and > + active low Borrow signal. Carry signal toggles every > + time channel Y counter overflows. Borrow signal toggles > + every time channel Y counter underflows. > + > + index: > + Interrupt generated on active high Index signal. > + > What: /sys/bus/counter/devices/counterX/signalY/cable_fault > KernelVersion: 5.7 > Contact: linux-iio@vger.kernel.org > diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c > index f4fb36b751c4..7537575568d0 100644 > --- a/drivers/counter/104-quad-8.c > +++ b/drivers/counter/104-quad-8.c > @@ -13,23 +13,30 @@ > #include <linux/iio/types.h> > #include <linux/io.h> > #include <linux/ioport.h> > +#include <linux/interrupt.h> > #include <linux/isa.h> > #include <linux/kernel.h> > #include <linux/module.h> > #include <linux/moduleparam.h> > #include <linux/types.h> > +#include <linux/spinlock.h> > > #define QUAD8_EXTENT 32 > > static unsigned int base[max_num_isa_dev(QUAD8_EXTENT)]; > static unsigned int num_quad8; > -module_param_array(base, uint, &num_quad8, 0); > +module_param_hw_array(base, uint, ioport, &num_quad8, 0); Why this change? Perhaps a note in the patch description on why this is needed? > MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > > +static unsigned int irq[max_num_isa_dev(QUAD8_EXTENT)]; > +module_param_hw_array(irq, uint, irq, NULL, 0); > +MODULE_PARM_DESC(irq, "ACCES 104-QUAD-8 interrupt line numbers"); > + > #define QUAD8_NUM_COUNTERS 8 > > /** > * struct quad8_iio - IIO device private data structure > + * @lock: synchronization lock to prevent I/O race conditions Probably want to be more specific. RMW, indexed writes or what sort of race? > * @counter: instance of the counter_device > * @fck_prescaler: array of filter clock prescaler configurations > * @preset: array of preset values > @@ -38,13 +45,14 @@ MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > * @quadrature_scale: array of quadrature mode scale configurations > * @ab_enable: array of A and B inputs enable configurations > * @preset_enable: array of set_to_preset_on_index attribute configurations > + * @irq_trigger: array of interrupt trigger function configurations > * @synchronous_mode: array of index function synchronous mode configurations > * @index_polarity: array of index function polarity configurations > * @cable_fault_enable: differential encoder cable status enable configurations > * @base: base port address of the IIO device > */ > struct quad8_iio { > - struct mutex lock; > + raw_spinlock_t lock; So it was here before but not documented. You should fix that with a precusor patch. Why raw_spinlock_t rather than spinlock_t? > struct counter_device counter; > unsigned int fck_prescaler[QUAD8_NUM_COUNTERS]; > unsigned int preset[QUAD8_NUM_COUNTERS]; > @@ -53,13 +61,16 @@ struct quad8_iio { > unsigned int quadrature_scale[QUAD8_NUM_COUNTERS]; > unsigned int ab_enable[QUAD8_NUM_COUNTERS]; > unsigned int preset_enable[QUAD8_NUM_COUNTERS]; > + unsigned int irq_trigger[QUAD8_NUM_COUNTERS]; > unsigned int synchronous_mode[QUAD8_NUM_COUNTERS]; > unsigned int index_polarity[QUAD8_NUM_COUNTERS]; > unsigned int cable_fault_enable; > unsigned int base; > }; > > +#define QUAD8_REG_INTERRUPT_STATUS 0x10 > #define QUAD8_REG_CHAN_OP 0x11 > +#define QUAD8_REG_INDEX_INTERRUPT 0x12 > #define QUAD8_REG_INDEX_INPUT_LEVELS 0x16 > #define QUAD8_DIFF_ENCODER_CABLE_STATUS 0x17 > /* Borrow Toggle flip-flop */ > @@ -92,8 +103,8 @@ struct quad8_iio { > #define QUAD8_RLD_CNTR_OUT 0x10 > /* Transfer Preset Register LSB to FCK Prescaler */ > #define QUAD8_RLD_PRESET_PSC 0x18 > -#define QUAD8_CHAN_OP_ENABLE_COUNTERS 0x00 > #define QUAD8_CHAN_OP_RESET_COUNTERS 0x01 > +#define QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC 0x04 > #define QUAD8_CMR_QUADRATURE_X1 0x08 > #define QUAD8_CMR_QUADRATURE_X2 0x10 > #define QUAD8_CMR_QUADRATURE_X4 0x18 > @@ -107,6 +118,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, > unsigned int flags; > unsigned int borrow; > unsigned int carry; > + unsigned long irqflags; > int i; > > switch (mask) { > @@ -124,7 +136,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, > /* Borrow XOR Carry effectively doubles count range */ > *val = (borrow ^ carry) << 24; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Reset Byte Pointer; transfer Counter to Output Latch */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, > @@ -133,7 +145,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, > for (i = 0; i < 3; i++) > *val |= (unsigned int)inb(base_offset) << (8 * i); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return IIO_VAL_INT; > case IIO_CHAN_INFO_ENABLE: > @@ -153,6 +165,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > { > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel; > + unsigned long flags; > int i; > unsigned int ior_cfg; > > @@ -165,7 +178,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > if ((unsigned int)val > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, flags); > > /* Reset Byte Pointer */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); > @@ -190,7 +203,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > /* Reset Error flag */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > > return 0; > case IIO_CHAN_INFO_ENABLE: > @@ -198,25 +211,26 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > if (val < 0 || val > 1) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, flags); > > priv->ab_enable[chan->channel] = val; > > - ior_cfg = val | priv->preset_enable[chan->channel] << 1; > + ior_cfg = val | priv->preset_enable[chan->channel] << 1 | > + priv->irq_trigger[chan->channel] << 3; > > /* Load I/O control configuration */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > > return 0; > case IIO_CHAN_INFO_SCALE: > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, flags); > > /* Quadrature scaling only available in quadrature mode */ > if (!priv->quadrature_mode[chan->channel] && > (val2 || val != 1)) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return -EINVAL; > } > > @@ -232,15 +246,15 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > priv->quadrature_scale[chan->channel] = 2; > break; > default: > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return -EINVAL; > } > else { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return -EINVAL; > } > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return 0; > } > > @@ -266,6 +280,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel; > unsigned int preset; > + unsigned long irqflags; > int ret; > int i; > > @@ -277,7 +292,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, > if (preset > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->preset[chan->channel] = preset; > > @@ -288,7 +303,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, > for (i = 0; i < 3; i++) > outb(preset >> (8 * i), base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return len; > } > @@ -309,6 +324,7 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > bool preset_enable; > + unsigned long irqflags; > int ret; > unsigned int ior_cfg; > > @@ -319,17 +335,18 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, > /* Preset enable is active low in Input/Output Control register */ > preset_enable = !preset_enable; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->preset_enable[chan->channel] = preset_enable; > > ior_cfg = priv->ab_enable[chan->channel] | > - (unsigned int)preset_enable << 1; > + (unsigned int)preset_enable << 1 | > + priv->irq_trigger[chan->channel] << 3; > > /* Load I/O control configuration to Input / Output Control Register */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return len; > } > @@ -387,8 +404,9 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > unsigned int mode_cfg = cnt_mode << 1; > const int base_offset = priv->base + 2 * chan->channel + 1; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->count_mode[chan->channel] = cnt_mode; > > @@ -399,7 +417,7 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -430,14 +448,15 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > unsigned int idr_cfg = synchronous_mode; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->index_polarity[chan->channel] << 1; > > /* Index function must be non-synchronous in non-quadrature mode */ > if (synchronous_mode && !priv->quadrature_mode[chan->channel]) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > > @@ -446,7 +465,7 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -476,9 +495,10 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, > { > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > + unsigned long irqflags; > unsigned int mode_cfg; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > mode_cfg = priv->count_mode[chan->channel] << 1; > > @@ -498,7 +518,7 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -529,8 +549,9 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > unsigned int idr_cfg = index_polarity << 1; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->synchronous_mode[chan->channel]; > > @@ -539,7 +560,7 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -647,6 +668,7 @@ static int quad8_count_read(struct counter_device *counter, > unsigned int flags; > unsigned int borrow; > unsigned int carry; > + unsigned long irqflags; > int i; > > flags = inb(base_offset + 1); > @@ -656,7 +678,7 @@ static int quad8_count_read(struct counter_device *counter, > /* Borrow XOR Carry effectively doubles count range */ > *val = (unsigned long)(borrow ^ carry) << 24; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Reset Byte Pointer; transfer Counter to Output Latch */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, > @@ -665,7 +687,7 @@ static int quad8_count_read(struct counter_device *counter, > for (i = 0; i < 3; i++) > *val |= (unsigned long)inb(base_offset) << (8 * i); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -675,13 +697,14 @@ static int quad8_count_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id; > + unsigned long irqflags; > int i; > > /* Only 24-bit values are supported */ > if (val > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Reset Byte Pointer */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); > @@ -706,7 +729,7 @@ static int quad8_count_write(struct counter_device *counter, > /* Reset Error flag */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -725,8 +748,9 @@ static int quad8_function_read(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int id = count->id; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > if (priv->quadrature_mode[id]) > switch (priv->quadrature_scale[id]) { > @@ -743,7 +767,7 @@ static int quad8_function_read(struct counter_device *counter, > else > *function = COUNTER_FUNCTION_PULSE_DIRECTION; > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -758,10 +782,11 @@ static int quad8_function_write(struct counter_device *counter, > unsigned int *const scale = priv->quadrature_scale + id; > unsigned int *const synchronous_mode = priv->synchronous_mode + id; > const int base_offset = priv->base + 2 * id + 1; > + unsigned long irqflags; > unsigned int mode_cfg; > unsigned int idr_cfg; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > mode_cfg = priv->count_mode[id] << 1; > idr_cfg = priv->index_polarity[id] << 1; > @@ -795,7 +820,7 @@ static int quad8_function_write(struct counter_device *counter, > mode_cfg |= QUAD8_CMR_QUADRATURE_X4; > break; > default: > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > } > @@ -803,7 +828,7 @@ static int quad8_function_write(struct counter_device *counter, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -898,13 +923,62 @@ static int quad8_action_read(struct counter_device *counter, > return 0; > } > > +static int quad8_events_configure(struct counter_device *counter) > +{ > + struct quad8_iio *const priv = counter->priv; > + unsigned long irq_enabled = 0; > + struct counter_event_node *event_node; > + > + /* Enable interrupts for the requested channels, disable for the rest */ > + list_for_each_entry(event_node, &counter->events_list, l) > + irq_enabled |= BIT(event_node->channel); > + > + outb(irq_enabled, priv->base + QUAD8_REG_INDEX_INTERRUPT); > + > + return 0; > +} > + > +static int quad8_watch_validate(struct counter_device *counter, > + const struct counter_watch *watch) > +{ > + struct quad8_iio *const priv = counter->priv; > + > + if (watch->channel > QUAD8_NUM_COUNTERS - 1) > + return -EINVAL; > + > + switch (watch->event) { > + case COUNTER_EVENT_OVERFLOW: > + if (priv->irq_trigger[watch->channel] != 0) > + return -EINVAL; > + break; > + case COUNTER_EVENT_THRESHOLD: > + if (priv->irq_trigger[watch->channel] != 1) > + return -EINVAL; > + break; > + case COUNTER_EVENT_OVERFLOW_UNDERFLOW: > + if (priv->irq_trigger[watch->channel] != 2) > + return -EINVAL; > + break; > + case COUNTER_EVENT_INDEX: > + if (priv->irq_trigger[watch->channel] != 3) > + return -EINVAL; > + break; > + default: > + return -EINVAL; > + } > + > + return 0; I'm a great fan of early returns if nothing to be done at the end of a switch. Much cleaner than having to follow the breaks and see where they end up (nothing in this case!) > +} > + > static const struct counter_ops quad8_ops = { > .signal_read = quad8_signal_read, > .count_read = quad8_count_read, > .count_write = quad8_count_write, > .function_read = quad8_function_read, > .function_write = quad8_function_write, > - .action_read = quad8_action_read > + .action_read = quad8_action_read, > + .events_configure = quad8_events_configure, > + .watch_validate = quad8_watch_validate, > }; > > static int quad8_index_polarity_get(struct counter_device *counter, > @@ -926,9 +1000,10 @@ static int quad8_index_polarity_set(struct counter_device *counter, > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > const int base_offset = priv->base + 2 * channel_id + 1; > + unsigned long irqflags; > unsigned int idr_cfg = index_polarity << 1; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->synchronous_mode[channel_id]; > > @@ -937,7 +1012,7 @@ static int quad8_index_polarity_set(struct counter_device *counter, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -961,15 +1036,16 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > const int base_offset = priv->base + 2 * channel_id + 1; > + unsigned long irqflags; > unsigned int idr_cfg = synchronous_mode; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->index_polarity[channel_id] << 1; > > /* Index function must be non-synchronous in non-quadrature mode */ > if (synchronous_mode && !priv->quadrature_mode[channel_id]) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > > @@ -978,7 +1054,7 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1025,6 +1101,7 @@ static int quad8_count_mode_write(struct counter_device *counter, > unsigned int count_mode; > unsigned int mode_cfg; > const int base_offset = priv->base + 2 * count->id + 1; > + unsigned long irqflags; > > /* Map Generic Counter count mode to 104-QUAD-8 count mode */ > switch (cnt_mode) { > @@ -1044,7 +1121,7 @@ static int quad8_count_mode_write(struct counter_device *counter, > return -EINVAL; > } > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->count_mode[count->id] = count_mode; > > @@ -1058,7 +1135,7 @@ static int quad8_count_mode_write(struct counter_device *counter, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1078,18 +1155,20 @@ static int quad8_count_enable_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id; > + unsigned long irqflags; > unsigned int ior_cfg; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->ab_enable[count->id] = enable; > > - ior_cfg = enable | priv->preset_enable[count->id] << 1; > + ior_cfg = enable | priv->preset_enable[count->id] << 1 | > + priv->irq_trigger[count->id] << 3; > > /* Load I/O control configuration */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1135,16 +1214,17 @@ static int quad8_count_preset_write(struct counter_device *counter, > struct counter_count *count, u64 preset) > { > struct quad8_iio *const priv = counter->priv; > + unsigned long irqflags; > > /* Only 24-bit values are supported */ > if (preset > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > quad8_preset_register_set(priv, count->id, preset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1153,8 +1233,9 @@ static int quad8_count_ceiling_read(struct counter_device *counter, > struct counter_count *count, u64 *ceiling) > { > struct quad8_iio *const priv = counter->priv; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Range Limit and Modulo-N count modes use preset value as ceiling */ > switch (priv->count_mode[count->id]) { > @@ -1168,7 +1249,7 @@ static int quad8_count_ceiling_read(struct counter_device *counter, > break; > } > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1177,12 +1258,13 @@ static int quad8_count_ceiling_write(struct counter_device *counter, > struct counter_count *count, u64 ceiling) > { > struct quad8_iio *const priv = counter->priv; > + unsigned long irqflags; > > /* Only 24-bit values are supported */ > if (ceiling > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Range Limit and Modulo-N count modes use preset value as ceiling */ > switch (priv->count_mode[count->id]) { > @@ -1192,7 +1274,7 @@ static int quad8_count_ceiling_write(struct counter_device *counter, > break; > } > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return -EINVAL; > } > @@ -1214,21 +1296,56 @@ static int quad8_count_preset_enable_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id + 1; > + unsigned long irqflags; > unsigned int ior_cfg; > > /* Preset enable is active low in Input/Output Control register */ > preset_enable = !preset_enable; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->preset_enable[count->id] = preset_enable; > > - ior_cfg = priv->ab_enable[count->id] | preset_enable << 1; > + ior_cfg = priv->ab_enable[count->id] | preset_enable << 1 | > + priv->irq_trigger[count->id] << 3; > + > + /* Load I/O control configuration to Input / Output Control Register */ > + outb(QUAD8_CTR_IOR | ior_cfg, base_offset); > + > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > + > + return 0; > +} > + > +static int quad8_irq_trigger_get(struct counter_device *counter, > + struct counter_count *count, u32 *irq_trigger) > +{ > + const struct quad8_iio *const priv = counter->priv; > + > + *irq_trigger = priv->irq_trigger[count->id]; > + > + return 0; > +} > + > +static int quad8_irq_trigger_set(struct counter_device *counter, > + struct counter_count *count, u32 irq_trigger) > +{ > + struct quad8_iio *const priv = counter->priv; > + const unsigned long base_offset = priv->base + 2 * count->id + 1; > + unsigned long irqflags; > + unsigned long ior_cfg; > + > + raw_spin_lock_irqsave(&priv->lock, irqflags); > + > + priv->irq_trigger[count->id] = irq_trigger; > + > + ior_cfg = priv->ab_enable[count->id] | > + priv->preset_enable[count->id] << 1 | irq_trigger << 3; > > /* Load I/O control configuration to Input / Output Control Register */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1239,22 +1356,23 @@ static int quad8_signal_cable_fault_read(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > + unsigned long irqflags; > bool disabled; > unsigned int status; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > disabled = !(priv->cable_fault_enable & BIT(channel_id)); > > if (disabled) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > > /* Logic 0 = cable fault */ > status = inb(priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > /* Mask respective channel and invert logic */ > *cable_fault = !(status & BIT(channel_id)); > @@ -1280,9 +1398,10 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > + unsigned long irqflags; > unsigned int cable_fault_enable; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > if (enable) > priv->cable_fault_enable |= BIT(channel_id); > @@ -1294,7 +1413,7 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, > > outb(cable_fault_enable, priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1317,8 +1436,9 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > const int base_offset = priv->base + 2 * channel_id; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->fck_prescaler[channel_id] = prescaler; > > @@ -1330,7 +1450,7 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_PRESET_PSC, > base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1433,7 +1553,15 @@ static const enum counter_count_mode quad8_cnt_modes[] = { > > static DEFINE_COUNTER_AVAILABLE(quad8_count_mode_available, quad8_cnt_modes); > > +static const char *const quad8_irq_trigger_states[] = { > + "carry", > + "compare", > + "carry-borrow", > + "index", > +}; > + > static DEFINE_COUNTER_ENUM(quad8_error_noise_enum, quad8_noise_error_states); > +static DEFINE_COUNTER_ENUM(quad8_irq_trigger_enum, quad8_irq_trigger_states); > > static struct counter_comp quad8_count_ext[] = { > COUNTER_COMP_CEILING(quad8_count_ceiling_read, > @@ -1448,6 +1576,8 @@ static struct counter_comp quad8_count_ext[] = { > COUNTER_COMP_PRESET(quad8_count_preset_read, quad8_count_preset_write), > COUNTER_COMP_PRESET_ENABLE(quad8_count_preset_enable_read, > quad8_count_preset_enable_write), > + COUNTER_COMP_COUNT_ENUM("irq_trigger", quad8_irq_trigger_get, > + quad8_irq_trigger_set, quad8_irq_trigger_enum), > }; > > #define QUAD8_COUNT(_id, _cntname) { \ > @@ -1472,6 +1602,48 @@ static struct counter_count quad8_counts[] = { > QUAD8_COUNT(7, "Channel 8 Count") > }; > > +static irqreturn_t quad8_irq_handler(int irq, void *quad8iio) > +{ > + struct quad8_iio *const priv = quad8iio; > + const unsigned long base = priv->base; > + unsigned long irq_status; > + unsigned long channel; > + u8 event; > + Take the spin lock? > + irq_status = inb(base + QUAD8_REG_INTERRUPT_STATUS); > + if (!irq_status) > + return IRQ_NONE; > + > + for_each_set_bit(channel, &irq_status, QUAD8_NUM_COUNTERS) { > + switch (priv->irq_trigger[channel]) { > + case 0: > + event = COUNTER_EVENT_OVERFLOW; > + break; > + case 1: > + event = COUNTER_EVENT_THRESHOLD; > + break; > + case 2: > + event = COUNTER_EVENT_OVERFLOW_UNDERFLOW; > + break; > + case 3: > + event = COUNTER_EVENT_INDEX; > + break; > + default: > + /* should never reach this path */ > + WARN_ONCE(true, "invalid interrupt trigger function %u configured for channel %lu\n", > + priv->irq_trigger[channel], channel); > + continue; > + } > + > + counter_push_event(&priv->counter, event, channel); > + } > + > + /* Clear pending interrupts on device */ > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base + QUAD8_REG_CHAN_OP); > + > + return IRQ_HANDLED; > +} > + > static int quad8_probe(struct device *dev, unsigned int id) > { > struct iio_dev *indio_dev; > @@ -1510,9 +1682,10 @@ static int quad8_probe(struct device *dev, unsigned int id) > quad8iio->counter.priv = quad8iio; > quad8iio->base = base[id]; > > - /* Initialize mutex */ > - mutex_init(&quad8iio->lock); > + raw_spin_lock_init(&quad8iio->lock); > > + /* Reset Index/Interrupt Register */ > + outb(0x00, base[id] + QUAD8_REG_INDEX_INTERRUPT); > /* Reset all counters and disable interrupt function */ > outb(QUAD8_CHAN_OP_RESET_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > /* Set initial configuration for all counters */ > @@ -1542,8 +1715,8 @@ static int quad8_probe(struct device *dev, unsigned int id) > } > /* Disable Differential Encoder Cable Status for all channels */ > outb(0xFF, base[id] + QUAD8_DIFF_ENCODER_CABLE_STATUS); > - /* Enable all counters */ > - outb(QUAD8_CHAN_OP_ENABLE_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > + /* Enable all counters and enable interrupt function */ > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base[id] + QUAD8_REG_CHAN_OP); > > /* Register IIO device */ > err = devm_iio_device_register(dev, indio_dev); > @@ -1551,7 +1724,12 @@ static int quad8_probe(struct device *dev, unsigned int id) > return err; > > /* Register Counter device */ > - return devm_counter_register(dev, &quad8iio->counter); > + err = devm_counter_register(dev, &quad8iio->counter); > + if (err) > + return err; > + > + return devm_request_irq(dev, irq[id], quad8_irq_handler, IRQF_SHARED, > + quad8iio->counter.name, quad8iio); You probably want to do that before the counter_register above as I assume that's where the userspace interface gets exposed. Otherwise there is probably a theoretical race. If not then I'd expect a comment here to explain why it needs to be in this unexpected order. > } > > static struct isa_driver quad8_driver = { > diff --git a/drivers/counter/Kconfig b/drivers/counter/Kconfig > index 2de53ab0dd25..bd42df98f522 100644 > --- a/drivers/counter/Kconfig > +++ b/drivers/counter/Kconfig > @@ -23,11 +23,11 @@ config 104_QUAD_8 > A counter's respective error flag may be cleared by performing a write > operation on the respective count value attribute. Although the > 104-QUAD-8 counters have a 25-bit range, only the lower 24 bits may be > - set, either directly or via the counter's preset attribute. Interrupts > - are not supported by this driver. > + set, either directly or via the counter's preset attribute. > > The base port addresses for the devices may be configured via the base > - array module parameter. > + array module parameter. The interrupt line numbers for the devices may > + be configured via the irq array module parameter. > > config STM32_TIMER_CNT > tristate "STM32 Timer encoder counter driver" ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 @ 2020-12-30 15:31 ` Jonathan Cameron 0 siblings, 0 replies; 51+ messages in thread From: Jonathan Cameron @ 2020-12-30 15:31 UTC (permalink / raw) To: William Breathitt Gray Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On Fri, 25 Dec 2020 19:15:38 -0500 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > The LSI/CSI LS7266R1 chip provides programmable output via the FLG pins. > When interrupts are enabled on the ACCES 104-QUAD-8, they occur whenever > FLG1 is active. Four functions are available for the FLG1 signal: Carry, > Compare, Carry-Borrow, and Index. > > Carry: > Interrupt generated on active low Carry signal. Carry > signal toggles every time the respective channel's > counter overflows. > > Compare: > Interrupt generated on active low Compare signal. > Compare signal toggles every time respective channel's > preset register is equal to the respective channel's > counter. > > Carry-Borrow: > Interrupt generated on active low Carry signal and > active low Borrow signal. Carry signal toggles every > time the respective channel's counter overflows. Borrow > signal toggles every time the respective channel's > counter underflows. > > Index: > Interrupt generated on active high Index signal. > > The irq_trigger Count extension is introduced to allow the selection of > the desired IRQ trigger function per channel. Interrupts push Counter > events to event channel X, where 'X' is the respective channel whose > FLG1 activated. > > This patch adds IRQ support for the ACCES 104-QUAD-8. The interrupt line > numbers for the devices may be configured via the irq array module > parameter. > > Reviewed-by: Syed Nayyar Waris <syednwaris@gmail.com> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> Immediate thought on this is that you should pull the lock type change out as a precursor patch that simply says we need it to be a spin_lock for the following patch. That should be an obvious change to review and then leave a much shorter patch to focus on here. Jonathan > --- > .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 ++ > drivers/counter/104-quad-8.c | 318 ++++++++++++++---- > drivers/counter/Kconfig | 6 +- > 3 files changed, 276 insertions(+), 73 deletions(-) > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > index eac32180c40d..0ecba24d43aa 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > @@ -1,3 +1,28 @@ > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger A warning on this. The ABI docs are now built into the main kernel html docs build. The snag is that it doesn't cope will with specialising or different devices having the same named file with different allowed values. You have to unify them all into one place. It may be worth just doing that from the start. > +KernelVersion: 5.12 > +Contact: linux-iio@vger.kernel.org > +Description: > + IRQ trigger function for channel Y. Four trigger functions are > + available: carry, compare, carry-borrow, and index. > + > + carry: > + Interrupt generated on active low Carry signal. Carry > + signal toggles every time channel Y counter overflows. > + > + compare: > + Interrupt generated on active low Compare signal. > + Compare signal toggles every time channel Y preset > + register is equal to channel Y counter. > + > + carry-borrow: > + Interrupt generated on active low Carry signal and > + active low Borrow signal. Carry signal toggles every > + time channel Y counter overflows. Borrow signal toggles > + every time channel Y counter underflows. > + > + index: > + Interrupt generated on active high Index signal. > + > What: /sys/bus/counter/devices/counterX/signalY/cable_fault > KernelVersion: 5.7 > Contact: linux-iio@vger.kernel.org > diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c > index f4fb36b751c4..7537575568d0 100644 > --- a/drivers/counter/104-quad-8.c > +++ b/drivers/counter/104-quad-8.c > @@ -13,23 +13,30 @@ > #include <linux/iio/types.h> > #include <linux/io.h> > #include <linux/ioport.h> > +#include <linux/interrupt.h> > #include <linux/isa.h> > #include <linux/kernel.h> > #include <linux/module.h> > #include <linux/moduleparam.h> > #include <linux/types.h> > +#include <linux/spinlock.h> > > #define QUAD8_EXTENT 32 > > static unsigned int base[max_num_isa_dev(QUAD8_EXTENT)]; > static unsigned int num_quad8; > -module_param_array(base, uint, &num_quad8, 0); > +module_param_hw_array(base, uint, ioport, &num_quad8, 0); Why this change? Perhaps a note in the patch description on why this is needed? > MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > > +static unsigned int irq[max_num_isa_dev(QUAD8_EXTENT)]; > +module_param_hw_array(irq, uint, irq, NULL, 0); > +MODULE_PARM_DESC(irq, "ACCES 104-QUAD-8 interrupt line numbers"); > + > #define QUAD8_NUM_COUNTERS 8 > > /** > * struct quad8_iio - IIO device private data structure > + * @lock: synchronization lock to prevent I/O race conditions Probably want to be more specific. RMW, indexed writes or what sort of race? > * @counter: instance of the counter_device > * @fck_prescaler: array of filter clock prescaler configurations > * @preset: array of preset values > @@ -38,13 +45,14 @@ MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > * @quadrature_scale: array of quadrature mode scale configurations > * @ab_enable: array of A and B inputs enable configurations > * @preset_enable: array of set_to_preset_on_index attribute configurations > + * @irq_trigger: array of interrupt trigger function configurations > * @synchronous_mode: array of index function synchronous mode configurations > * @index_polarity: array of index function polarity configurations > * @cable_fault_enable: differential encoder cable status enable configurations > * @base: base port address of the IIO device > */ > struct quad8_iio { > - struct mutex lock; > + raw_spinlock_t lock; So it was here before but not documented. You should fix that with a precusor patch. Why raw_spinlock_t rather than spinlock_t? > struct counter_device counter; > unsigned int fck_prescaler[QUAD8_NUM_COUNTERS]; > unsigned int preset[QUAD8_NUM_COUNTERS]; > @@ -53,13 +61,16 @@ struct quad8_iio { > unsigned int quadrature_scale[QUAD8_NUM_COUNTERS]; > unsigned int ab_enable[QUAD8_NUM_COUNTERS]; > unsigned int preset_enable[QUAD8_NUM_COUNTERS]; > + unsigned int irq_trigger[QUAD8_NUM_COUNTERS]; > unsigned int synchronous_mode[QUAD8_NUM_COUNTERS]; > unsigned int index_polarity[QUAD8_NUM_COUNTERS]; > unsigned int cable_fault_enable; > unsigned int base; > }; > > +#define QUAD8_REG_INTERRUPT_STATUS 0x10 > #define QUAD8_REG_CHAN_OP 0x11 > +#define QUAD8_REG_INDEX_INTERRUPT 0x12 > #define QUAD8_REG_INDEX_INPUT_LEVELS 0x16 > #define QUAD8_DIFF_ENCODER_CABLE_STATUS 0x17 > /* Borrow Toggle flip-flop */ > @@ -92,8 +103,8 @@ struct quad8_iio { > #define QUAD8_RLD_CNTR_OUT 0x10 > /* Transfer Preset Register LSB to FCK Prescaler */ > #define QUAD8_RLD_PRESET_PSC 0x18 > -#define QUAD8_CHAN_OP_ENABLE_COUNTERS 0x00 > #define QUAD8_CHAN_OP_RESET_COUNTERS 0x01 > +#define QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC 0x04 > #define QUAD8_CMR_QUADRATURE_X1 0x08 > #define QUAD8_CMR_QUADRATURE_X2 0x10 > #define QUAD8_CMR_QUADRATURE_X4 0x18 > @@ -107,6 +118,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, > unsigned int flags; > unsigned int borrow; > unsigned int carry; > + unsigned long irqflags; > int i; > > switch (mask) { > @@ -124,7 +136,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, > /* Borrow XOR Carry effectively doubles count range */ > *val = (borrow ^ carry) << 24; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Reset Byte Pointer; transfer Counter to Output Latch */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, > @@ -133,7 +145,7 @@ static int quad8_read_raw(struct iio_dev *indio_dev, > for (i = 0; i < 3; i++) > *val |= (unsigned int)inb(base_offset) << (8 * i); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return IIO_VAL_INT; > case IIO_CHAN_INFO_ENABLE: > @@ -153,6 +165,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > { > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel; > + unsigned long flags; > int i; > unsigned int ior_cfg; > > @@ -165,7 +178,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > if ((unsigned int)val > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, flags); > > /* Reset Byte Pointer */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); > @@ -190,7 +203,7 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > /* Reset Error flag */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > > return 0; > case IIO_CHAN_INFO_ENABLE: > @@ -198,25 +211,26 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > if (val < 0 || val > 1) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, flags); > > priv->ab_enable[chan->channel] = val; > > - ior_cfg = val | priv->preset_enable[chan->channel] << 1; > + ior_cfg = val | priv->preset_enable[chan->channel] << 1 | > + priv->irq_trigger[chan->channel] << 3; > > /* Load I/O control configuration */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > > return 0; > case IIO_CHAN_INFO_SCALE: > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, flags); > > /* Quadrature scaling only available in quadrature mode */ > if (!priv->quadrature_mode[chan->channel] && > (val2 || val != 1)) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return -EINVAL; > } > > @@ -232,15 +246,15 @@ static int quad8_write_raw(struct iio_dev *indio_dev, > priv->quadrature_scale[chan->channel] = 2; > break; > default: > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return -EINVAL; > } > else { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return -EINVAL; > } > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, flags); > return 0; > } > > @@ -266,6 +280,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel; > unsigned int preset; > + unsigned long irqflags; > int ret; > int i; > > @@ -277,7 +292,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, > if (preset > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->preset[chan->channel] = preset; > > @@ -288,7 +303,7 @@ static ssize_t quad8_write_preset(struct iio_dev *indio_dev, uintptr_t private, > for (i = 0; i < 3; i++) > outb(preset >> (8 * i), base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return len; > } > @@ -309,6 +324,7 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > bool preset_enable; > + unsigned long irqflags; > int ret; > unsigned int ior_cfg; > > @@ -319,17 +335,18 @@ static ssize_t quad8_write_set_to_preset_on_index(struct iio_dev *indio_dev, > /* Preset enable is active low in Input/Output Control register */ > preset_enable = !preset_enable; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->preset_enable[chan->channel] = preset_enable; > > ior_cfg = priv->ab_enable[chan->channel] | > - (unsigned int)preset_enable << 1; > + (unsigned int)preset_enable << 1 | > + priv->irq_trigger[chan->channel] << 3; > > /* Load I/O control configuration to Input / Output Control Register */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return len; > } > @@ -387,8 +404,9 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > unsigned int mode_cfg = cnt_mode << 1; > const int base_offset = priv->base + 2 * chan->channel + 1; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->count_mode[chan->channel] = cnt_mode; > > @@ -399,7 +417,7 @@ static int quad8_set_count_mode(struct iio_dev *indio_dev, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -430,14 +448,15 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > unsigned int idr_cfg = synchronous_mode; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->index_polarity[chan->channel] << 1; > > /* Index function must be non-synchronous in non-quadrature mode */ > if (synchronous_mode && !priv->quadrature_mode[chan->channel]) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > > @@ -446,7 +465,7 @@ static int quad8_set_synchronous_mode(struct iio_dev *indio_dev, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -476,9 +495,10 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, > { > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > + unsigned long irqflags; > unsigned int mode_cfg; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > mode_cfg = priv->count_mode[chan->channel] << 1; > > @@ -498,7 +518,7 @@ static int quad8_set_quadrature_mode(struct iio_dev *indio_dev, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -529,8 +549,9 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, > struct quad8_iio *const priv = iio_priv(indio_dev); > const int base_offset = priv->base + 2 * chan->channel + 1; > unsigned int idr_cfg = index_polarity << 1; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->synchronous_mode[chan->channel]; > > @@ -539,7 +560,7 @@ static int quad8_set_index_polarity(struct iio_dev *indio_dev, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -647,6 +668,7 @@ static int quad8_count_read(struct counter_device *counter, > unsigned int flags; > unsigned int borrow; > unsigned int carry; > + unsigned long irqflags; > int i; > > flags = inb(base_offset + 1); > @@ -656,7 +678,7 @@ static int quad8_count_read(struct counter_device *counter, > /* Borrow XOR Carry effectively doubles count range */ > *val = (unsigned long)(borrow ^ carry) << 24; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Reset Byte Pointer; transfer Counter to Output Latch */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_CNTR_OUT, > @@ -665,7 +687,7 @@ static int quad8_count_read(struct counter_device *counter, > for (i = 0; i < 3; i++) > *val |= (unsigned long)inb(base_offset) << (8 * i); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -675,13 +697,14 @@ static int quad8_count_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id; > + unsigned long irqflags; > int i; > > /* Only 24-bit values are supported */ > if (val > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Reset Byte Pointer */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP, base_offset + 1); > @@ -706,7 +729,7 @@ static int quad8_count_write(struct counter_device *counter, > /* Reset Error flag */ > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_E, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -725,8 +748,9 @@ static int quad8_function_read(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int id = count->id; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > if (priv->quadrature_mode[id]) > switch (priv->quadrature_scale[id]) { > @@ -743,7 +767,7 @@ static int quad8_function_read(struct counter_device *counter, > else > *function = COUNTER_FUNCTION_PULSE_DIRECTION; > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -758,10 +782,11 @@ static int quad8_function_write(struct counter_device *counter, > unsigned int *const scale = priv->quadrature_scale + id; > unsigned int *const synchronous_mode = priv->synchronous_mode + id; > const int base_offset = priv->base + 2 * id + 1; > + unsigned long irqflags; > unsigned int mode_cfg; > unsigned int idr_cfg; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > mode_cfg = priv->count_mode[id] << 1; > idr_cfg = priv->index_polarity[id] << 1; > @@ -795,7 +820,7 @@ static int quad8_function_write(struct counter_device *counter, > mode_cfg |= QUAD8_CMR_QUADRATURE_X4; > break; > default: > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > } > @@ -803,7 +828,7 @@ static int quad8_function_write(struct counter_device *counter, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -898,13 +923,62 @@ static int quad8_action_read(struct counter_device *counter, > return 0; > } > > +static int quad8_events_configure(struct counter_device *counter) > +{ > + struct quad8_iio *const priv = counter->priv; > + unsigned long irq_enabled = 0; > + struct counter_event_node *event_node; > + > + /* Enable interrupts for the requested channels, disable for the rest */ > + list_for_each_entry(event_node, &counter->events_list, l) > + irq_enabled |= BIT(event_node->channel); > + > + outb(irq_enabled, priv->base + QUAD8_REG_INDEX_INTERRUPT); > + > + return 0; > +} > + > +static int quad8_watch_validate(struct counter_device *counter, > + const struct counter_watch *watch) > +{ > + struct quad8_iio *const priv = counter->priv; > + > + if (watch->channel > QUAD8_NUM_COUNTERS - 1) > + return -EINVAL; > + > + switch (watch->event) { > + case COUNTER_EVENT_OVERFLOW: > + if (priv->irq_trigger[watch->channel] != 0) > + return -EINVAL; > + break; > + case COUNTER_EVENT_THRESHOLD: > + if (priv->irq_trigger[watch->channel] != 1) > + return -EINVAL; > + break; > + case COUNTER_EVENT_OVERFLOW_UNDERFLOW: > + if (priv->irq_trigger[watch->channel] != 2) > + return -EINVAL; > + break; > + case COUNTER_EVENT_INDEX: > + if (priv->irq_trigger[watch->channel] != 3) > + return -EINVAL; > + break; > + default: > + return -EINVAL; > + } > + > + return 0; I'm a great fan of early returns if nothing to be done at the end of a switch. Much cleaner than having to follow the breaks and see where they end up (nothing in this case!) > +} > + > static const struct counter_ops quad8_ops = { > .signal_read = quad8_signal_read, > .count_read = quad8_count_read, > .count_write = quad8_count_write, > .function_read = quad8_function_read, > .function_write = quad8_function_write, > - .action_read = quad8_action_read > + .action_read = quad8_action_read, > + .events_configure = quad8_events_configure, > + .watch_validate = quad8_watch_validate, > }; > > static int quad8_index_polarity_get(struct counter_device *counter, > @@ -926,9 +1000,10 @@ static int quad8_index_polarity_set(struct counter_device *counter, > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > const int base_offset = priv->base + 2 * channel_id + 1; > + unsigned long irqflags; > unsigned int idr_cfg = index_polarity << 1; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->synchronous_mode[channel_id]; > > @@ -937,7 +1012,7 @@ static int quad8_index_polarity_set(struct counter_device *counter, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -961,15 +1036,16 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id - 16; > const int base_offset = priv->base + 2 * channel_id + 1; > + unsigned long irqflags; > unsigned int idr_cfg = synchronous_mode; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > idr_cfg |= priv->index_polarity[channel_id] << 1; > > /* Index function must be non-synchronous in non-quadrature mode */ > if (synchronous_mode && !priv->quadrature_mode[channel_id]) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > > @@ -978,7 +1054,7 @@ static int quad8_synchronous_mode_set(struct counter_device *counter, > /* Load Index Control configuration to Index Control Register */ > outb(QUAD8_CTR_IDR | idr_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1025,6 +1101,7 @@ static int quad8_count_mode_write(struct counter_device *counter, > unsigned int count_mode; > unsigned int mode_cfg; > const int base_offset = priv->base + 2 * count->id + 1; > + unsigned long irqflags; > > /* Map Generic Counter count mode to 104-QUAD-8 count mode */ > switch (cnt_mode) { > @@ -1044,7 +1121,7 @@ static int quad8_count_mode_write(struct counter_device *counter, > return -EINVAL; > } > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->count_mode[count->id] = count_mode; > > @@ -1058,7 +1135,7 @@ static int quad8_count_mode_write(struct counter_device *counter, > /* Load mode configuration to Counter Mode Register */ > outb(QUAD8_CTR_CMR | mode_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1078,18 +1155,20 @@ static int quad8_count_enable_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id; > + unsigned long irqflags; > unsigned int ior_cfg; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->ab_enable[count->id] = enable; > > - ior_cfg = enable | priv->preset_enable[count->id] << 1; > + ior_cfg = enable | priv->preset_enable[count->id] << 1 | > + priv->irq_trigger[count->id] << 3; > > /* Load I/O control configuration */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1135,16 +1214,17 @@ static int quad8_count_preset_write(struct counter_device *counter, > struct counter_count *count, u64 preset) > { > struct quad8_iio *const priv = counter->priv; > + unsigned long irqflags; > > /* Only 24-bit values are supported */ > if (preset > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > quad8_preset_register_set(priv, count->id, preset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1153,8 +1233,9 @@ static int quad8_count_ceiling_read(struct counter_device *counter, > struct counter_count *count, u64 *ceiling) > { > struct quad8_iio *const priv = counter->priv; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Range Limit and Modulo-N count modes use preset value as ceiling */ > switch (priv->count_mode[count->id]) { > @@ -1168,7 +1249,7 @@ static int quad8_count_ceiling_read(struct counter_device *counter, > break; > } > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1177,12 +1258,13 @@ static int quad8_count_ceiling_write(struct counter_device *counter, > struct counter_count *count, u64 ceiling) > { > struct quad8_iio *const priv = counter->priv; > + unsigned long irqflags; > > /* Only 24-bit values are supported */ > if (ceiling > 0xFFFFFF) > return -EINVAL; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > /* Range Limit and Modulo-N count modes use preset value as ceiling */ > switch (priv->count_mode[count->id]) { > @@ -1192,7 +1274,7 @@ static int quad8_count_ceiling_write(struct counter_device *counter, > break; > } > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return -EINVAL; > } > @@ -1214,21 +1296,56 @@ static int quad8_count_preset_enable_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const int base_offset = priv->base + 2 * count->id + 1; > + unsigned long irqflags; > unsigned int ior_cfg; > > /* Preset enable is active low in Input/Output Control register */ > preset_enable = !preset_enable; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->preset_enable[count->id] = preset_enable; > > - ior_cfg = priv->ab_enable[count->id] | preset_enable << 1; > + ior_cfg = priv->ab_enable[count->id] | preset_enable << 1 | > + priv->irq_trigger[count->id] << 3; > + > + /* Load I/O control configuration to Input / Output Control Register */ > + outb(QUAD8_CTR_IOR | ior_cfg, base_offset); > + > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > + > + return 0; > +} > + > +static int quad8_irq_trigger_get(struct counter_device *counter, > + struct counter_count *count, u32 *irq_trigger) > +{ > + const struct quad8_iio *const priv = counter->priv; > + > + *irq_trigger = priv->irq_trigger[count->id]; > + > + return 0; > +} > + > +static int quad8_irq_trigger_set(struct counter_device *counter, > + struct counter_count *count, u32 irq_trigger) > +{ > + struct quad8_iio *const priv = counter->priv; > + const unsigned long base_offset = priv->base + 2 * count->id + 1; > + unsigned long irqflags; > + unsigned long ior_cfg; > + > + raw_spin_lock_irqsave(&priv->lock, irqflags); > + > + priv->irq_trigger[count->id] = irq_trigger; > + > + ior_cfg = priv->ab_enable[count->id] | > + priv->preset_enable[count->id] << 1 | irq_trigger << 3; > > /* Load I/O control configuration to Input / Output Control Register */ > outb(QUAD8_CTR_IOR | ior_cfg, base_offset); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1239,22 +1356,23 @@ static int quad8_signal_cable_fault_read(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > + unsigned long irqflags; > bool disabled; > unsigned int status; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > disabled = !(priv->cable_fault_enable & BIT(channel_id)); > > if (disabled) { > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > return -EINVAL; > } > > /* Logic 0 = cable fault */ > status = inb(priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > /* Mask respective channel and invert logic */ > *cable_fault = !(status & BIT(channel_id)); > @@ -1280,9 +1398,10 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, > { > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > + unsigned long irqflags; > unsigned int cable_fault_enable; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > if (enable) > priv->cable_fault_enable |= BIT(channel_id); > @@ -1294,7 +1413,7 @@ static int quad8_signal_cable_fault_enable_write(struct counter_device *counter, > > outb(cable_fault_enable, priv->base + QUAD8_DIFF_ENCODER_CABLE_STATUS); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1317,8 +1436,9 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, > struct quad8_iio *const priv = counter->priv; > const size_t channel_id = signal->id / 2; > const int base_offset = priv->base + 2 * channel_id; > + unsigned long irqflags; > > - mutex_lock(&priv->lock); > + raw_spin_lock_irqsave(&priv->lock, irqflags); > > priv->fck_prescaler[channel_id] = prescaler; > > @@ -1330,7 +1450,7 @@ static int quad8_signal_fck_prescaler_write(struct counter_device *counter, > outb(QUAD8_CTR_RLD | QUAD8_RLD_RESET_BP | QUAD8_RLD_PRESET_PSC, > base_offset + 1); > > - mutex_unlock(&priv->lock); > + raw_spin_unlock_irqrestore(&priv->lock, irqflags); > > return 0; > } > @@ -1433,7 +1553,15 @@ static const enum counter_count_mode quad8_cnt_modes[] = { > > static DEFINE_COUNTER_AVAILABLE(quad8_count_mode_available, quad8_cnt_modes); > > +static const char *const quad8_irq_trigger_states[] = { > + "carry", > + "compare", > + "carry-borrow", > + "index", > +}; > + > static DEFINE_COUNTER_ENUM(quad8_error_noise_enum, quad8_noise_error_states); > +static DEFINE_COUNTER_ENUM(quad8_irq_trigger_enum, quad8_irq_trigger_states); > > static struct counter_comp quad8_count_ext[] = { > COUNTER_COMP_CEILING(quad8_count_ceiling_read, > @@ -1448,6 +1576,8 @@ static struct counter_comp quad8_count_ext[] = { > COUNTER_COMP_PRESET(quad8_count_preset_read, quad8_count_preset_write), > COUNTER_COMP_PRESET_ENABLE(quad8_count_preset_enable_read, > quad8_count_preset_enable_write), > + COUNTER_COMP_COUNT_ENUM("irq_trigger", quad8_irq_trigger_get, > + quad8_irq_trigger_set, quad8_irq_trigger_enum), > }; > > #define QUAD8_COUNT(_id, _cntname) { \ > @@ -1472,6 +1602,48 @@ static struct counter_count quad8_counts[] = { > QUAD8_COUNT(7, "Channel 8 Count") > }; > > +static irqreturn_t quad8_irq_handler(int irq, void *quad8iio) > +{ > + struct quad8_iio *const priv = quad8iio; > + const unsigned long base = priv->base; > + unsigned long irq_status; > + unsigned long channel; > + u8 event; > + Take the spin lock? > + irq_status = inb(base + QUAD8_REG_INTERRUPT_STATUS); > + if (!irq_status) > + return IRQ_NONE; > + > + for_each_set_bit(channel, &irq_status, QUAD8_NUM_COUNTERS) { > + switch (priv->irq_trigger[channel]) { > + case 0: > + event = COUNTER_EVENT_OVERFLOW; > + break; > + case 1: > + event = COUNTER_EVENT_THRESHOLD; > + break; > + case 2: > + event = COUNTER_EVENT_OVERFLOW_UNDERFLOW; > + break; > + case 3: > + event = COUNTER_EVENT_INDEX; > + break; > + default: > + /* should never reach this path */ > + WARN_ONCE(true, "invalid interrupt trigger function %u configured for channel %lu\n", > + priv->irq_trigger[channel], channel); > + continue; > + } > + > + counter_push_event(&priv->counter, event, channel); > + } > + > + /* Clear pending interrupts on device */ > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base + QUAD8_REG_CHAN_OP); > + > + return IRQ_HANDLED; > +} > + > static int quad8_probe(struct device *dev, unsigned int id) > { > struct iio_dev *indio_dev; > @@ -1510,9 +1682,10 @@ static int quad8_probe(struct device *dev, unsigned int id) > quad8iio->counter.priv = quad8iio; > quad8iio->base = base[id]; > > - /* Initialize mutex */ > - mutex_init(&quad8iio->lock); > + raw_spin_lock_init(&quad8iio->lock); > > + /* Reset Index/Interrupt Register */ > + outb(0x00, base[id] + QUAD8_REG_INDEX_INTERRUPT); > /* Reset all counters and disable interrupt function */ > outb(QUAD8_CHAN_OP_RESET_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > /* Set initial configuration for all counters */ > @@ -1542,8 +1715,8 @@ static int quad8_probe(struct device *dev, unsigned int id) > } > /* Disable Differential Encoder Cable Status for all channels */ > outb(0xFF, base[id] + QUAD8_DIFF_ENCODER_CABLE_STATUS); > - /* Enable all counters */ > - outb(QUAD8_CHAN_OP_ENABLE_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > + /* Enable all counters and enable interrupt function */ > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base[id] + QUAD8_REG_CHAN_OP); > > /* Register IIO device */ > err = devm_iio_device_register(dev, indio_dev); > @@ -1551,7 +1724,12 @@ static int quad8_probe(struct device *dev, unsigned int id) > return err; > > /* Register Counter device */ > - return devm_counter_register(dev, &quad8iio->counter); > + err = devm_counter_register(dev, &quad8iio->counter); > + if (err) > + return err; > + > + return devm_request_irq(dev, irq[id], quad8_irq_handler, IRQF_SHARED, > + quad8iio->counter.name, quad8iio); You probably want to do that before the counter_register above as I assume that's where the userspace interface gets exposed. Otherwise there is probably a theoretical race. If not then I'd expect a comment here to explain why it needs to be in this unexpected order. > } > > static struct isa_driver quad8_driver = { > diff --git a/drivers/counter/Kconfig b/drivers/counter/Kconfig > index 2de53ab0dd25..bd42df98f522 100644 > --- a/drivers/counter/Kconfig > +++ b/drivers/counter/Kconfig > @@ -23,11 +23,11 @@ config 104_QUAD_8 > A counter's respective error flag may be cleared by performing a write > operation on the respective count value attribute. Although the > 104-QUAD-8 counters have a 25-bit range, only the lower 24 bits may be > - set, either directly or via the counter's preset attribute. Interrupts > - are not supported by this driver. > + set, either directly or via the counter's preset attribute. > > The base port addresses for the devices may be configured via the base > - array module parameter. > + array module parameter. The interrupt line numbers for the devices may > + be configured via the irq array module parameter. > > config STM32_TIMER_CNT > tristate "STM32 Timer encoder counter driver" _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 2020-12-30 15:31 ` Jonathan Cameron @ 2021-02-12 6:04 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-02-12 6:04 UTC (permalink / raw) To: Jonathan Cameron Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, david, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue [-- Attachment #1: Type: text/plain, Size: 10405 bytes --] On Wed, Dec 30, 2020 at 03:31:15PM +0000, Jonathan Cameron wrote: > On Fri, 25 Dec 2020 19:15:38 -0500 > William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > > > The LSI/CSI LS7266R1 chip provides programmable output via the FLG pins. > > When interrupts are enabled on the ACCES 104-QUAD-8, they occur whenever > > FLG1 is active. Four functions are available for the FLG1 signal: Carry, > > Compare, Carry-Borrow, and Index. > > > > Carry: > > Interrupt generated on active low Carry signal. Carry > > signal toggles every time the respective channel's > > counter overflows. > > > > Compare: > > Interrupt generated on active low Compare signal. > > Compare signal toggles every time respective channel's > > preset register is equal to the respective channel's > > counter. > > > > Carry-Borrow: > > Interrupt generated on active low Carry signal and > > active low Borrow signal. Carry signal toggles every > > time the respective channel's counter overflows. Borrow > > signal toggles every time the respective channel's > > counter underflows. > > > > Index: > > Interrupt generated on active high Index signal. > > > > The irq_trigger Count extension is introduced to allow the selection of > > the desired IRQ trigger function per channel. Interrupts push Counter > > events to event channel X, where 'X' is the respective channel whose > > FLG1 activated. > > > > This patch adds IRQ support for the ACCES 104-QUAD-8. The interrupt line > > numbers for the devices may be configured via the irq array module > > parameter. > > > > Reviewed-by: Syed Nayyar Waris <syednwaris@gmail.com> > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > > Immediate thought on this is that you should pull the lock type change > out as a precursor patch that simply says we need it to be a spin_lock > for the following patch. That should be an obvious change to review > and then leave a much shorter patch to focus on here. > > Jonathan Ack. > > --- > > .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 ++ > > drivers/counter/104-quad-8.c | 318 ++++++++++++++---- > > drivers/counter/Kconfig | 6 +- > > 3 files changed, 276 insertions(+), 73 deletions(-) > > > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > index eac32180c40d..0ecba24d43aa 100644 > > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > @@ -1,3 +1,28 @@ > > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger > > A warning on this. The ABI docs are now built into the main kernel > html docs build. The snag is that it doesn't cope will with specialising > or different devices having the same named file with different allowed values. > You have to unify them all into one place. It may be worth just doing that > from the start. Ack. > > diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c > > index f4fb36b751c4..7537575568d0 100644 > > --- a/drivers/counter/104-quad-8.c > > +++ b/drivers/counter/104-quad-8.c > > @@ -13,23 +13,30 @@ > > #include <linux/iio/types.h> > > #include <linux/io.h> > > #include <linux/ioport.h> > > +#include <linux/interrupt.h> > > #include <linux/isa.h> > > #include <linux/kernel.h> > > #include <linux/module.h> > > #include <linux/moduleparam.h> > > #include <linux/types.h> > > +#include <linux/spinlock.h> > > > > #define QUAD8_EXTENT 32 > > > > static unsigned int base[max_num_isa_dev(QUAD8_EXTENT)]; > > static unsigned int num_quad8; > > -module_param_array(base, uint, &num_quad8, 0); > > +module_param_hw_array(base, uint, ioport, &num_quad8, 0); > > Why this change? Perhaps a note in the patch description on why > this is needed? This change is unrelated to this patch so I'll move it to a precursor patch with an explanation of the reason for the change. > > MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > > > > +static unsigned int irq[max_num_isa_dev(QUAD8_EXTENT)]; > > +module_param_hw_array(irq, uint, irq, NULL, 0); > > +MODULE_PARM_DESC(irq, "ACCES 104-QUAD-8 interrupt line numbers"); > > + > > #define QUAD8_NUM_COUNTERS 8 > > > > /** > > * struct quad8_iio - IIO device private data structure > > + * @lock: synchronization lock to prevent I/O race conditions > > Probably want to be more specific. RMW, indexed writes or what sort of race? Ack. > > * @counter: instance of the counter_device > > * @fck_prescaler: array of filter clock prescaler configurations > > * @preset: array of preset values > > @@ -38,13 +45,14 @@ MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > > * @quadrature_scale: array of quadrature mode scale configurations > > * @ab_enable: array of A and B inputs enable configurations > > * @preset_enable: array of set_to_preset_on_index attribute configurations > > + * @irq_trigger: array of interrupt trigger function configurations > > * @synchronous_mode: array of index function synchronous mode configurations > > * @index_polarity: array of index function polarity configurations > > * @cable_fault_enable: differential encoder cable status enable configurations > > * @base: base port address of the IIO device > > */ > > struct quad8_iio { > > - struct mutex lock; > > + raw_spinlock_t lock; > > So it was here before but not documented. You should fix that with a precusor patch. > Why raw_spinlock_t rather than spinlock_t? Ack. > > +static int quad8_watch_validate(struct counter_device *counter, > > + const struct counter_watch *watch) > > +{ > > + struct quad8_iio *const priv = counter->priv; > > + > > + if (watch->channel > QUAD8_NUM_COUNTERS - 1) > > + return -EINVAL; > > + > > + switch (watch->event) { > > + case COUNTER_EVENT_OVERFLOW: > > + if (priv->irq_trigger[watch->channel] != 0) > > + return -EINVAL; > > + break; > > + case COUNTER_EVENT_THRESHOLD: > > + if (priv->irq_trigger[watch->channel] != 1) > > + return -EINVAL; > > + break; > > + case COUNTER_EVENT_OVERFLOW_UNDERFLOW: > > + if (priv->irq_trigger[watch->channel] != 2) > > + return -EINVAL; > > + break; > > + case COUNTER_EVENT_INDEX: > > + if (priv->irq_trigger[watch->channel] != 3) > > + return -EINVAL; > > + break; > > + default: > > + return -EINVAL; > > + } > > + > > + return 0; > > I'm a great fan of early returns if nothing to be done at > the end of a switch. Much cleaner than having to follow the > breaks and see where they end up (nothing in this case!) Ack. > > +static irqreturn_t quad8_irq_handler(int irq, void *quad8iio) > > +{ > > + struct quad8_iio *const priv = quad8iio; > > + const unsigned long base = priv->base; > > + unsigned long irq_status; > > + unsigned long channel; > > + u8 event; > > + > > Take the spin lock? A lock isn't necessary for this particular function. This is the only place where the device's pending interrupt state is read and reset, so there is no risk of stale data nor of clobbering the device state because interrupts are currently disabled. > > + irq_status = inb(base + QUAD8_REG_INTERRUPT_STATUS); > > + if (!irq_status) > > + return IRQ_NONE; > > + > > + for_each_set_bit(channel, &irq_status, QUAD8_NUM_COUNTERS) { > > + switch (priv->irq_trigger[channel]) { > > + case 0: > > + event = COUNTER_EVENT_OVERFLOW; > > + break; > > + case 1: > > + event = COUNTER_EVENT_THRESHOLD; > > + break; > > + case 2: > > + event = COUNTER_EVENT_OVERFLOW_UNDERFLOW; > > + break; > > + case 3: > > + event = COUNTER_EVENT_INDEX; > > + break; > > + default: > > + /* should never reach this path */ > > + WARN_ONCE(true, "invalid interrupt trigger function %u configured for channel %lu\n", > > + priv->irq_trigger[channel], channel); > > + continue; > > + } > > + > > + counter_push_event(&priv->counter, event, channel); > > + } > > + > > + /* Clear pending interrupts on device */ > > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base + QUAD8_REG_CHAN_OP); > > + > > + return IRQ_HANDLED; > > +} > > + > > static int quad8_probe(struct device *dev, unsigned int id) > > { > > struct iio_dev *indio_dev; > > @@ -1510,9 +1682,10 @@ static int quad8_probe(struct device *dev, unsigned int id) > > quad8iio->counter.priv = quad8iio; > > quad8iio->base = base[id]; > > > > - /* Initialize mutex */ > > - mutex_init(&quad8iio->lock); > > + raw_spin_lock_init(&quad8iio->lock); > > > > + /* Reset Index/Interrupt Register */ > > + outb(0x00, base[id] + QUAD8_REG_INDEX_INTERRUPT); > > /* Reset all counters and disable interrupt function */ > > outb(QUAD8_CHAN_OP_RESET_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > > /* Set initial configuration for all counters */ > > @@ -1542,8 +1715,8 @@ static int quad8_probe(struct device *dev, unsigned int id) > > } > > /* Disable Differential Encoder Cable Status for all channels */ > > outb(0xFF, base[id] + QUAD8_DIFF_ENCODER_CABLE_STATUS); > > - /* Enable all counters */ > > - outb(QUAD8_CHAN_OP_ENABLE_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > > + /* Enable all counters and enable interrupt function */ > > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base[id] + QUAD8_REG_CHAN_OP); > > > > /* Register IIO device */ > > err = devm_iio_device_register(dev, indio_dev); > > @@ -1551,7 +1724,12 @@ static int quad8_probe(struct device *dev, unsigned int id) > > return err; > > > > /* Register Counter device */ > > - return devm_counter_register(dev, &quad8iio->counter); > > + err = devm_counter_register(dev, &quad8iio->counter); > > + if (err) > > + return err; > > + > > + return devm_request_irq(dev, irq[id], quad8_irq_handler, IRQF_SHARED, > > + quad8iio->counter.name, quad8iio); > You probably want to do that before the counter_register above > as I assume that's where the userspace interface gets exposed. > Otherwise there is probably a theoretical race. > If not then I'd expect a comment here to explain why it needs to be > in this unexpected order. Ack. William Breathitt Gray [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 @ 2021-02-12 6:04 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-02-12 6:04 UTC (permalink / raw) To: Jonathan Cameron Cc: kamel.bouhara, gwendal, a.fatoum, david, linux-iio, patrick.havelange, alexandre.belloni, mcoquelin.stm32, linux-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue [-- Attachment #1.1: Type: text/plain, Size: 10405 bytes --] On Wed, Dec 30, 2020 at 03:31:15PM +0000, Jonathan Cameron wrote: > On Fri, 25 Dec 2020 19:15:38 -0500 > William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > > > The LSI/CSI LS7266R1 chip provides programmable output via the FLG pins. > > When interrupts are enabled on the ACCES 104-QUAD-8, they occur whenever > > FLG1 is active. Four functions are available for the FLG1 signal: Carry, > > Compare, Carry-Borrow, and Index. > > > > Carry: > > Interrupt generated on active low Carry signal. Carry > > signal toggles every time the respective channel's > > counter overflows. > > > > Compare: > > Interrupt generated on active low Compare signal. > > Compare signal toggles every time respective channel's > > preset register is equal to the respective channel's > > counter. > > > > Carry-Borrow: > > Interrupt generated on active low Carry signal and > > active low Borrow signal. Carry signal toggles every > > time the respective channel's counter overflows. Borrow > > signal toggles every time the respective channel's > > counter underflows. > > > > Index: > > Interrupt generated on active high Index signal. > > > > The irq_trigger Count extension is introduced to allow the selection of > > the desired IRQ trigger function per channel. Interrupts push Counter > > events to event channel X, where 'X' is the respective channel whose > > FLG1 activated. > > > > This patch adds IRQ support for the ACCES 104-QUAD-8. The interrupt line > > numbers for the devices may be configured via the irq array module > > parameter. > > > > Reviewed-by: Syed Nayyar Waris <syednwaris@gmail.com> > > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com> > > Immediate thought on this is that you should pull the lock type change > out as a precursor patch that simply says we need it to be a spin_lock > for the following patch. That should be an obvious change to review > and then leave a much shorter patch to focus on here. > > Jonathan Ack. > > --- > > .../ABI/testing/sysfs-bus-counter-104-quad-8 | 25 ++ > > drivers/counter/104-quad-8.c | 318 ++++++++++++++---- > > drivers/counter/Kconfig | 6 +- > > 3 files changed, 276 insertions(+), 73 deletions(-) > > > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > index eac32180c40d..0ecba24d43aa 100644 > > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > @@ -1,3 +1,28 @@ > > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger > > A warning on this. The ABI docs are now built into the main kernel > html docs build. The snag is that it doesn't cope will with specialising > or different devices having the same named file with different allowed values. > You have to unify them all into one place. It may be worth just doing that > from the start. Ack. > > diff --git a/drivers/counter/104-quad-8.c b/drivers/counter/104-quad-8.c > > index f4fb36b751c4..7537575568d0 100644 > > --- a/drivers/counter/104-quad-8.c > > +++ b/drivers/counter/104-quad-8.c > > @@ -13,23 +13,30 @@ > > #include <linux/iio/types.h> > > #include <linux/io.h> > > #include <linux/ioport.h> > > +#include <linux/interrupt.h> > > #include <linux/isa.h> > > #include <linux/kernel.h> > > #include <linux/module.h> > > #include <linux/moduleparam.h> > > #include <linux/types.h> > > +#include <linux/spinlock.h> > > > > #define QUAD8_EXTENT 32 > > > > static unsigned int base[max_num_isa_dev(QUAD8_EXTENT)]; > > static unsigned int num_quad8; > > -module_param_array(base, uint, &num_quad8, 0); > > +module_param_hw_array(base, uint, ioport, &num_quad8, 0); > > Why this change? Perhaps a note in the patch description on why > this is needed? This change is unrelated to this patch so I'll move it to a precursor patch with an explanation of the reason for the change. > > MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > > > > +static unsigned int irq[max_num_isa_dev(QUAD8_EXTENT)]; > > +module_param_hw_array(irq, uint, irq, NULL, 0); > > +MODULE_PARM_DESC(irq, "ACCES 104-QUAD-8 interrupt line numbers"); > > + > > #define QUAD8_NUM_COUNTERS 8 > > > > /** > > * struct quad8_iio - IIO device private data structure > > + * @lock: synchronization lock to prevent I/O race conditions > > Probably want to be more specific. RMW, indexed writes or what sort of race? Ack. > > * @counter: instance of the counter_device > > * @fck_prescaler: array of filter clock prescaler configurations > > * @preset: array of preset values > > @@ -38,13 +45,14 @@ MODULE_PARM_DESC(base, "ACCES 104-QUAD-8 base addresses"); > > * @quadrature_scale: array of quadrature mode scale configurations > > * @ab_enable: array of A and B inputs enable configurations > > * @preset_enable: array of set_to_preset_on_index attribute configurations > > + * @irq_trigger: array of interrupt trigger function configurations > > * @synchronous_mode: array of index function synchronous mode configurations > > * @index_polarity: array of index function polarity configurations > > * @cable_fault_enable: differential encoder cable status enable configurations > > * @base: base port address of the IIO device > > */ > > struct quad8_iio { > > - struct mutex lock; > > + raw_spinlock_t lock; > > So it was here before but not documented. You should fix that with a precusor patch. > Why raw_spinlock_t rather than spinlock_t? Ack. > > +static int quad8_watch_validate(struct counter_device *counter, > > + const struct counter_watch *watch) > > +{ > > + struct quad8_iio *const priv = counter->priv; > > + > > + if (watch->channel > QUAD8_NUM_COUNTERS - 1) > > + return -EINVAL; > > + > > + switch (watch->event) { > > + case COUNTER_EVENT_OVERFLOW: > > + if (priv->irq_trigger[watch->channel] != 0) > > + return -EINVAL; > > + break; > > + case COUNTER_EVENT_THRESHOLD: > > + if (priv->irq_trigger[watch->channel] != 1) > > + return -EINVAL; > > + break; > > + case COUNTER_EVENT_OVERFLOW_UNDERFLOW: > > + if (priv->irq_trigger[watch->channel] != 2) > > + return -EINVAL; > > + break; > > + case COUNTER_EVENT_INDEX: > > + if (priv->irq_trigger[watch->channel] != 3) > > + return -EINVAL; > > + break; > > + default: > > + return -EINVAL; > > + } > > + > > + return 0; > > I'm a great fan of early returns if nothing to be done at > the end of a switch. Much cleaner than having to follow the > breaks and see where they end up (nothing in this case!) Ack. > > +static irqreturn_t quad8_irq_handler(int irq, void *quad8iio) > > +{ > > + struct quad8_iio *const priv = quad8iio; > > + const unsigned long base = priv->base; > > + unsigned long irq_status; > > + unsigned long channel; > > + u8 event; > > + > > Take the spin lock? A lock isn't necessary for this particular function. This is the only place where the device's pending interrupt state is read and reset, so there is no risk of stale data nor of clobbering the device state because interrupts are currently disabled. > > + irq_status = inb(base + QUAD8_REG_INTERRUPT_STATUS); > > + if (!irq_status) > > + return IRQ_NONE; > > + > > + for_each_set_bit(channel, &irq_status, QUAD8_NUM_COUNTERS) { > > + switch (priv->irq_trigger[channel]) { > > + case 0: > > + event = COUNTER_EVENT_OVERFLOW; > > + break; > > + case 1: > > + event = COUNTER_EVENT_THRESHOLD; > > + break; > > + case 2: > > + event = COUNTER_EVENT_OVERFLOW_UNDERFLOW; > > + break; > > + case 3: > > + event = COUNTER_EVENT_INDEX; > > + break; > > + default: > > + /* should never reach this path */ > > + WARN_ONCE(true, "invalid interrupt trigger function %u configured for channel %lu\n", > > + priv->irq_trigger[channel], channel); > > + continue; > > + } > > + > > + counter_push_event(&priv->counter, event, channel); > > + } > > + > > + /* Clear pending interrupts on device */ > > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base + QUAD8_REG_CHAN_OP); > > + > > + return IRQ_HANDLED; > > +} > > + > > static int quad8_probe(struct device *dev, unsigned int id) > > { > > struct iio_dev *indio_dev; > > @@ -1510,9 +1682,10 @@ static int quad8_probe(struct device *dev, unsigned int id) > > quad8iio->counter.priv = quad8iio; > > quad8iio->base = base[id]; > > > > - /* Initialize mutex */ > > - mutex_init(&quad8iio->lock); > > + raw_spin_lock_init(&quad8iio->lock); > > > > + /* Reset Index/Interrupt Register */ > > + outb(0x00, base[id] + QUAD8_REG_INDEX_INTERRUPT); > > /* Reset all counters and disable interrupt function */ > > outb(QUAD8_CHAN_OP_RESET_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > > /* Set initial configuration for all counters */ > > @@ -1542,8 +1715,8 @@ static int quad8_probe(struct device *dev, unsigned int id) > > } > > /* Disable Differential Encoder Cable Status for all channels */ > > outb(0xFF, base[id] + QUAD8_DIFF_ENCODER_CABLE_STATUS); > > - /* Enable all counters */ > > - outb(QUAD8_CHAN_OP_ENABLE_COUNTERS, base[id] + QUAD8_REG_CHAN_OP); > > + /* Enable all counters and enable interrupt function */ > > + outb(QUAD8_CHAN_OP_ENABLE_INTERRUPT_FUNC, base[id] + QUAD8_REG_CHAN_OP); > > > > /* Register IIO device */ > > err = devm_iio_device_register(dev, indio_dev); > > @@ -1551,7 +1724,12 @@ static int quad8_probe(struct device *dev, unsigned int id) > > return err; > > > > /* Register Counter device */ > > - return devm_counter_register(dev, &quad8iio->counter); > > + err = devm_counter_register(dev, &quad8iio->counter); > > + if (err) > > + return err; > > + > > + return devm_request_irq(dev, irq[id], quad8_irq_handler, IRQF_SHARED, > > + quad8iio->counter.name, quad8iio); > You probably want to do that before the counter_register above > as I assume that's where the userspace interface gets exposed. > Otherwise there is probably a theoretical race. > If not then I'd expect a comment here to explain why it needs to be > in this unexpected order. Ack. William Breathitt Gray [-- Attachment #1.2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] [-- Attachment #2: Type: text/plain, Size: 176 bytes --] _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 17:36 ` David Lechner -1 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 17:36 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > index eac32180c40d..0ecba24d43aa 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > @@ -1,3 +1,28 @@ > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger Do we really need this sysfs attribute? Shouldn't interrupts be configured _only_ by the chrdev interface? ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 @ 2020-12-30 17:36 ` David Lechner 0 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 17:36 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > index eac32180c40d..0ecba24d43aa 100644 > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > @@ -1,3 +1,28 @@ > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger Do we really need this sysfs attribute? Shouldn't interrupts be configured _only_ by the chrdev interface? _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 2020-12-30 17:36 ` David Lechner @ 2021-02-11 23:56 ` William Breathitt Gray -1 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-02-11 23:56 UTC (permalink / raw) To: David Lechner Cc: jic23, kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue [-- Attachment #1: Type: text/plain, Size: 2427 bytes --] On Wed, Dec 30, 2020 at 11:36:45AM -0600, David Lechner wrote: > On 12/25/20 6:15 PM, William Breathitt Gray wrote: > > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > index eac32180c40d..0ecba24d43aa 100644 > > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > @@ -1,3 +1,28 @@ > > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger > > Do we really need this sysfs attribute? Shouldn't interrupts be configured > _only_ by the chrdev interface? I think this attribute can go away because we can implicitly figure out the correct IRQ configuration from the struct counter_watch data when a user executes a COUNTER_ADD_WATCH_IOCTL ioctl command. However, I need some help deciding on an appropriate behavior for conflicting counter_watch configurations. Let me give some context first. The 104-QUAD-8 features 8 channels (essentially 8 independent physical counters on the device). Each channel can independently issue an event, but any particular channel can only be set to a single kind of event (COUNTER_EVENT_INDEX, COUNTER_EVENT_OVERFLOW, etc.). The purpose of the irq_trigger sysfs attribute I introduced in this patch is to allow the user to select the event configuration they want for a particular channel. We can theoretically figure this out implicitly from the struct counter_watch request, so this sysfs attribute may not be necessary. However, how do we handle the case where a user executes two COUNTER_ADD_WATCH_IOCTL ioctl commands for the same channel but with different event selections? I'm considering three possible behaviors: * Fail the second ioctl call; event selection of the first struct counter_watch takes precedence and thus second is incompatible. * Issue a dev_warn() indicating that the second struct counter_watch event selection will now be the event configuration for that channel. * Don't notify the user, just silently reconfigure for the second struct counter_watch event selection. I'm suspecting the first behavior I listed here (ioctl returning failed) is the most appropriate as a user is explicitly made known of this particular device's inability to support more than one type of event per channel. What do you think? William Breathitt Gray [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 @ 2021-02-11 23:56 ` William Breathitt Gray 0 siblings, 0 replies; 51+ messages in thread From: William Breathitt Gray @ 2021-02-11 23:56 UTC (permalink / raw) To: David Lechner Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, linux-arm-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, jic23, alexandre.torgue [-- Attachment #1.1: Type: text/plain, Size: 2427 bytes --] On Wed, Dec 30, 2020 at 11:36:45AM -0600, David Lechner wrote: > On 12/25/20 6:15 PM, William Breathitt Gray wrote: > > > diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > index eac32180c40d..0ecba24d43aa 100644 > > --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 > > @@ -1,3 +1,28 @@ > > +What: /sys/bus/counter/devices/counterX/countY/irq_trigger > > Do we really need this sysfs attribute? Shouldn't interrupts be configured > _only_ by the chrdev interface? I think this attribute can go away because we can implicitly figure out the correct IRQ configuration from the struct counter_watch data when a user executes a COUNTER_ADD_WATCH_IOCTL ioctl command. However, I need some help deciding on an appropriate behavior for conflicting counter_watch configurations. Let me give some context first. The 104-QUAD-8 features 8 channels (essentially 8 independent physical counters on the device). Each channel can independently issue an event, but any particular channel can only be set to a single kind of event (COUNTER_EVENT_INDEX, COUNTER_EVENT_OVERFLOW, etc.). The purpose of the irq_trigger sysfs attribute I introduced in this patch is to allow the user to select the event configuration they want for a particular channel. We can theoretically figure this out implicitly from the struct counter_watch request, so this sysfs attribute may not be necessary. However, how do we handle the case where a user executes two COUNTER_ADD_WATCH_IOCTL ioctl commands for the same channel but with different event selections? I'm considering three possible behaviors: * Fail the second ioctl call; event selection of the first struct counter_watch takes precedence and thus second is incompatible. * Issue a dev_warn() indicating that the second struct counter_watch event selection will now be the event configuration for that channel. * Don't notify the user, just silently reconfigure for the second struct counter_watch event selection. I'm suspecting the first behavior I listed here (ioctl returning failed) is the most appropriate as a user is explicitly made known of this particular device's inability to support more than one type of event per channel. What do you think? William Breathitt Gray [-- Attachment #1.2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] [-- Attachment #2: Type: text/plain, Size: 176 bytes --] _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 2021-02-11 23:56 ` William Breathitt Gray @ 2021-02-12 1:10 ` David Lechner -1 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2021-02-12 1:10 UTC (permalink / raw) To: William Breathitt Gray Cc: jic23, kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue On 2/11/21 5:56 PM, William Breathitt Gray wrote: > On Wed, Dec 30, 2020 at 11:36:45AM -0600, David Lechner wrote: >> On 12/25/20 6:15 PM, William Breathitt Gray wrote: >> >>> diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 >>> index eac32180c40d..0ecba24d43aa 100644 >>> --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 >>> +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 >>> @@ -1,3 +1,28 @@ >>> +What: /sys/bus/counter/devices/counterX/countY/irq_trigger >> >> Do we really need this sysfs attribute? Shouldn't interrupts be configured >> _only_ by the chrdev interface? > > I think this attribute can go away because we can implicitly figure out > the correct IRQ configuration from the struct counter_watch data when a > user executes a COUNTER_ADD_WATCH_IOCTL ioctl command. > > However, I need some help deciding on an appropriate behavior for > conflicting counter_watch configurations. Let me give some context > first. > > The 104-QUAD-8 features 8 channels (essentially 8 independent physical > counters on the device). Each channel can independently issue an event, > but any particular channel can only be set to a single kind of event > (COUNTER_EVENT_INDEX, COUNTER_EVENT_OVERFLOW, etc.). > > The purpose of the irq_trigger sysfs attribute I introduced in this > patch is to allow the user to select the event configuration they want > for a particular channel. We can theoretically figure this out > implicitly from the struct counter_watch request, so this sysfs > attribute may not be necessary. > > However, how do we handle the case where a user executes two > COUNTER_ADD_WATCH_IOCTL ioctl commands for the same channel but with > different event selections? I'm considering three possible behaviors: > > * Fail the second ioctl call; event selection of the first struct > counter_watch takes precedence and thus second is incompatible. > * Issue a dev_warn() indicating that the second struct counter_watch > event selection will now be the event configuration for that channel. > * Don't notify the user, just silently reconfigure for the second struct > counter_watch event selection. > > I'm suspecting the first behavior I listed here (ioctl returning failed) > is the most appropriate as a user is explicitly made known of this > particular device's inability to support more than one type of event per > channel. > > What do you think? > I agree that it should return an error instead of adding the watch. I'm pretty sure that is how I implemented the TI eQEP driver already. ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 @ 2021-02-12 1:10 ` David Lechner 0 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2021-02-12 1:10 UTC (permalink / raw) To: William Breathitt Gray Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, linux-arm-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, jic23, alexandre.torgue On 2/11/21 5:56 PM, William Breathitt Gray wrote: > On Wed, Dec 30, 2020 at 11:36:45AM -0600, David Lechner wrote: >> On 12/25/20 6:15 PM, William Breathitt Gray wrote: >> >>> diff --git a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 >>> index eac32180c40d..0ecba24d43aa 100644 >>> --- a/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 >>> +++ b/Documentation/ABI/testing/sysfs-bus-counter-104-quad-8 >>> @@ -1,3 +1,28 @@ >>> +What: /sys/bus/counter/devices/counterX/countY/irq_trigger >> >> Do we really need this sysfs attribute? Shouldn't interrupts be configured >> _only_ by the chrdev interface? > > I think this attribute can go away because we can implicitly figure out > the correct IRQ configuration from the struct counter_watch data when a > user executes a COUNTER_ADD_WATCH_IOCTL ioctl command. > > However, I need some help deciding on an appropriate behavior for > conflicting counter_watch configurations. Let me give some context > first. > > The 104-QUAD-8 features 8 channels (essentially 8 independent physical > counters on the device). Each channel can independently issue an event, > but any particular channel can only be set to a single kind of event > (COUNTER_EVENT_INDEX, COUNTER_EVENT_OVERFLOW, etc.). > > The purpose of the irq_trigger sysfs attribute I introduced in this > patch is to allow the user to select the event configuration they want > for a particular channel. We can theoretically figure this out > implicitly from the struct counter_watch request, so this sysfs > attribute may not be necessary. > > However, how do we handle the case where a user executes two > COUNTER_ADD_WATCH_IOCTL ioctl commands for the same channel but with > different event selections? I'm considering three possible behaviors: > > * Fail the second ioctl call; event selection of the first struct > counter_watch takes precedence and thus second is incompatible. > * Issue a dev_warn() indicating that the second struct counter_watch > event selection will now be the event configuration for that channel. > * Don't notify the user, just silently reconfigure for the second struct > counter_watch event selection. > > I'm suspecting the first behavior I listed here (ioctl returning failed) > is the most appropriate as a user is explicitly made known of this > particular device's inability to support more than one type of event per > channel. > > What do you think? > I agree that it should return an error instead of adding the watch. I'm pretty sure that is how I implemented the TI eQEP driver already. _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 0/5] Introduce the Counter character device interface 2020-12-26 0:15 ` William Breathitt Gray @ 2020-12-30 23:34 ` David Lechner -1 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 23:34 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kernel, linux-stm32, a.fatoum, kamel.bouhara, gwendal, alexandre.belloni, linux-iio, linux-kernel, linux-arm-kernel, syednwaris, patrick.havelange, fabrice.gasnier, mcoquelin.stm32, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > Changes in v7: > - Implemented u32 enums; enum types can now be used directly for > callbacks and values > - Fixed refcount underflow bug > - Refactored all err check to check for err < 0; this should help > prevent future oversights on valid positive return valids > - Use mutex instead of raw_spin_lock in counter_chrdev_read(); > kifo_to_user() can now safely sleep > - Renamed COUNTER_COMPONENT_DUMMY to COUNTER_COMPONENT_NONE to make > purpose more obvious > - Introduced a watch_validate() callback > - Consolidated the functionality to clear the watches to the > counter_clear_watches() function > - Reimplemented counter_push_event() as a void function; on error, > errno is returned via struct counter_event so that it can be handled > by userspace (because interrupt handlers can't do much for this) > - Renamed the events_config() callback to events_configure(); > "events_config" could be confused as a read callback when this is > actually intended to configure the device for the requested events > - Reimplemented 104-QUAD-8 driver to use events_configure() and > watch_validate() callbacks; irq_trigger_enable sysfs attribute > removed because events_configure() now serves this purpose > > The changes for this revision were much simpler compared to the previous > revisions. I don't have any further questions for this patchset, so it's > really just a search for possible bugs or regressions now. Please test > and verify this patchset on your systems, and ACK appropriately. > I'll wait for the next round to give my Reviewed-By, Tested-By but I've rebased my WIP TI eQEP changes[1] on this and I haven't ran into any problems yet. [1]: https://github.com/dlech/linux/commits/bone-counter ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 0/5] Introduce the Counter character device interface @ 2020-12-30 23:34 ` David Lechner 0 siblings, 0 replies; 51+ messages in thread From: David Lechner @ 2020-12-30 23:34 UTC (permalink / raw) To: William Breathitt Gray, jic23 Cc: kamel.bouhara, gwendal, a.fatoum, mcoquelin.stm32, linux-iio, patrick.havelange, alexandre.belloni, linux-kernel, kernel, fabrice.gasnier, syednwaris, linux-stm32, linux-arm-kernel, alexandre.torgue On 12/25/20 6:15 PM, William Breathitt Gray wrote: > Changes in v7: > - Implemented u32 enums; enum types can now be used directly for > callbacks and values > - Fixed refcount underflow bug > - Refactored all err check to check for err < 0; this should help > prevent future oversights on valid positive return valids > - Use mutex instead of raw_spin_lock in counter_chrdev_read(); > kifo_to_user() can now safely sleep > - Renamed COUNTER_COMPONENT_DUMMY to COUNTER_COMPONENT_NONE to make > purpose more obvious > - Introduced a watch_validate() callback > - Consolidated the functionality to clear the watches to the > counter_clear_watches() function > - Reimplemented counter_push_event() as a void function; on error, > errno is returned via struct counter_event so that it can be handled > by userspace (because interrupt handlers can't do much for this) > - Renamed the events_config() callback to events_configure(); > "events_config" could be confused as a read callback when this is > actually intended to configure the device for the requested events > - Reimplemented 104-QUAD-8 driver to use events_configure() and > watch_validate() callbacks; irq_trigger_enable sysfs attribute > removed because events_configure() now serves this purpose > > The changes for this revision were much simpler compared to the previous > revisions. I don't have any further questions for this patchset, so it's > really just a search for possible bugs or regressions now. Please test > and verify this patchset on your systems, and ACK appropriately. > I'll wait for the next round to give my Reviewed-By, Tested-By but I've rebased my WIP TI eQEP changes[1] on this and I haven't ran into any problems yet. [1]: https://github.com/dlech/linux/commits/bone-counter _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel ^ permalink raw reply [flat|nested] 51+ messages in thread
* Re: [PATCH v7 1/5] counter: Internalize sysfs interface code
@ 2020-12-26 18:47 kernel test robot
0 siblings, 0 replies; 51+ messages in thread
From: kernel test robot @ 2020-12-26 18:47 UTC (permalink / raw)
To: kbuild
[-- Attachment #1: Type: text/plain, Size: 5965 bytes --]
CC: kbuild-all(a)lists.01.org
In-Reply-To: <fc40ab7f4a38e80d86715daa5eaf744dd645a75b.1608935587.git.vilhelm.gray@gmail.com>
References: <fc40ab7f4a38e80d86715daa5eaf744dd645a75b.1608935587.git.vilhelm.gray@gmail.com>
TO: William Breathitt Gray <vilhelm.gray@gmail.com>
Hi William,
I love your patch! Perhaps something to improve:
[auto build test WARNING on linus/master]
[also build test WARNING on next-20201223]
[cannot apply to stm32/stm32-next linux/master v5.10]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/William-Breathitt-Gray/Introduce-the-Counter-character-device-interface/20201226-082226
base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 61d791365b72a89062fbbea69aa61479476da946
:::::: branch date: 18 hours ago
:::::: commit date: 18 hours ago
config: i386-randconfig-m021-20201226 (attached as .config)
compiler: gcc-9 (Debian 9.3.0-15) 9.3.0
If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>
Reported-by: Dan Carpenter <dan.carpenter@oracle.com>
New smatch warnings:
drivers/counter/counter-sysfs.c:172 counter_comp_u32_show() error: uninitialized symbol 'err'.
Old smatch warnings:
drivers/counter/counter-sysfs.c:104 counter_comp_u8_show() error: uninitialized symbol 'err'.
drivers/counter/counter-sysfs.c:289 counter_comp_u64_show() error: uninitialized symbol 'err'.
vim +/err +172 drivers/counter/counter-sysfs.c
d2735d30323ad0d William Breathitt Gray 2020-12-25 147
d2735d30323ad0d William Breathitt Gray 2020-12-25 148 static ssize_t counter_comp_u32_show(struct device *dev,
d2735d30323ad0d William Breathitt Gray 2020-12-25 149 struct device_attribute *attr, char *buf)
d2735d30323ad0d William Breathitt Gray 2020-12-25 150 {
d2735d30323ad0d William Breathitt Gray 2020-12-25 151 const struct counter_attribute *const a = to_counter_attribute(attr);
d2735d30323ad0d William Breathitt Gray 2020-12-25 152 struct counter_device *const counter = dev_get_drvdata(dev);
d2735d30323ad0d William Breathitt Gray 2020-12-25 153 const struct counter_available *const avail = a->comp.priv;
d2735d30323ad0d William Breathitt Gray 2020-12-25 154 int err;
d2735d30323ad0d William Breathitt Gray 2020-12-25 155 u32 data = 0;
d2735d30323ad0d William Breathitt Gray 2020-12-25 156
d2735d30323ad0d William Breathitt Gray 2020-12-25 157 switch (a->scope) {
d2735d30323ad0d William Breathitt Gray 2020-12-25 158 case COUNTER_SCOPE_DEVICE:
d2735d30323ad0d William Breathitt Gray 2020-12-25 159 err = a->comp.device_u32_read(counter, &data);
d2735d30323ad0d William Breathitt Gray 2020-12-25 160 break;
d2735d30323ad0d William Breathitt Gray 2020-12-25 161 case COUNTER_SCOPE_SIGNAL:
d2735d30323ad0d William Breathitt Gray 2020-12-25 162 err = a->comp.signal_u32_read(counter, a->parent, &data);
d2735d30323ad0d William Breathitt Gray 2020-12-25 163 break;
d2735d30323ad0d William Breathitt Gray 2020-12-25 164 case COUNTER_SCOPE_COUNT:
d2735d30323ad0d William Breathitt Gray 2020-12-25 165 if (a->comp.type == COUNTER_COMP_SYNAPSE_ACTION)
d2735d30323ad0d William Breathitt Gray 2020-12-25 166 err = a->comp.action_read(counter, a->parent,
d2735d30323ad0d William Breathitt Gray 2020-12-25 167 a->comp.priv, &data);
d2735d30323ad0d William Breathitt Gray 2020-12-25 168 else
d2735d30323ad0d William Breathitt Gray 2020-12-25 169 err = a->comp.count_u32_read(counter, a->parent, &data);
d2735d30323ad0d William Breathitt Gray 2020-12-25 170 break;
d2735d30323ad0d William Breathitt Gray 2020-12-25 171 }
d2735d30323ad0d William Breathitt Gray 2020-12-25 @172 if (err < 0)
d2735d30323ad0d William Breathitt Gray 2020-12-25 173 return err;
d2735d30323ad0d William Breathitt Gray 2020-12-25 174
d2735d30323ad0d William Breathitt Gray 2020-12-25 175 switch (a->comp.type) {
d2735d30323ad0d William Breathitt Gray 2020-12-25 176 case COUNTER_COMP_FUNCTION:
d2735d30323ad0d William Breathitt Gray 2020-12-25 177 return sprintf(buf, "%s\n", counter_function_str[data]);
d2735d30323ad0d William Breathitt Gray 2020-12-25 178 case COUNTER_COMP_SIGNAL_LEVEL:
d2735d30323ad0d William Breathitt Gray 2020-12-25 179 return sprintf(buf, "%s\n", counter_signal_value_str[data]);
d2735d30323ad0d William Breathitt Gray 2020-12-25 180 case COUNTER_COMP_SYNAPSE_ACTION:
d2735d30323ad0d William Breathitt Gray 2020-12-25 181 return sprintf(buf, "%s\n", counter_synapse_action_str[data]);
d2735d30323ad0d William Breathitt Gray 2020-12-25 182 case COUNTER_COMP_ENUM:
d2735d30323ad0d William Breathitt Gray 2020-12-25 183 return sprintf(buf, "%s\n", avail->strs[data]);
d2735d30323ad0d William Breathitt Gray 2020-12-25 184 case COUNTER_COMP_COUNT_DIRECTION:
d2735d30323ad0d William Breathitt Gray 2020-12-25 185 return sprintf(buf, "%s\n", counter_count_direction_str[data]);
d2735d30323ad0d William Breathitt Gray 2020-12-25 186 case COUNTER_COMP_COUNT_MODE:
d2735d30323ad0d William Breathitt Gray 2020-12-25 187 return sprintf(buf, "%s\n", counter_count_mode_str[data]);
d2735d30323ad0d William Breathitt Gray 2020-12-25 188 default:
d2735d30323ad0d William Breathitt Gray 2020-12-25 189 break;
d2735d30323ad0d William Breathitt Gray 2020-12-25 190 }
d2735d30323ad0d William Breathitt Gray 2020-12-25 191
d2735d30323ad0d William Breathitt Gray 2020-12-25 192 return sprintf(buf, "%u\n", (unsigned int)data);
d2735d30323ad0d William Breathitt Gray 2020-12-25 193 }
d2735d30323ad0d William Breathitt Gray 2020-12-25 194
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org
[-- Attachment #2: config.gz --]
[-- Type: application/gzip, Size: 37701 bytes --]
^ permalink raw reply [flat|nested] 51+ messages in threadend of thread, other threads:[~2021-02-12 6:34 UTC | newest] Thread overview: 51+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2020-12-26 0:15 [PATCH v7 0/5] Introduce the Counter character device interface William Breathitt Gray 2020-12-26 0:15 ` William Breathitt Gray 2020-12-26 0:15 ` [PATCH v7 1/5] counter: Internalize sysfs interface code William Breathitt Gray 2020-12-30 14:37 ` Jonathan Cameron 2021-01-06 5:29 ` William Breathitt Gray 2021-01-06 5:29 ` William Breathitt Gray 2020-12-30 23:24 ` David Lechner 2020-12-30 23:24 ` David Lechner 2021-01-06 5:30 ` William Breathitt Gray 2021-01-06 5:30 ` William Breathitt Gray 2020-12-26 0:15 ` [PATCH v7 2/5] docs: counter: Update to reflect sysfs internalization William Breathitt Gray 2020-12-26 0:15 ` William Breathitt Gray 2020-12-30 14:41 ` Jonathan Cameron 2020-12-30 14:41 ` Jonathan Cameron 2020-12-26 0:15 ` [PATCH v7 3/5] counter: Add character device interface William Breathitt Gray 2020-12-26 0:15 ` William Breathitt Gray 2020-12-30 15:04 ` Jonathan Cameron 2020-12-30 15:04 ` Jonathan Cameron 2021-02-12 6:32 ` William Breathitt Gray 2021-02-12 6:32 ` William Breathitt Gray 2020-12-30 21:36 ` David Lechner 2020-12-30 21:36 ` David Lechner 2021-01-30 4:59 ` William Breathitt Gray 2021-01-30 4:59 ` William Breathitt Gray 2021-01-04 18:15 ` Dan Carpenter 2021-01-04 18:15 ` Dan Carpenter 2021-01-28 9:01 ` Oleksij Rempel 2021-01-28 9:01 ` Oleksij Rempel 2021-01-30 5:15 ` William Breathitt Gray 2021-01-30 5:15 ` William Breathitt Gray 2020-12-26 0:15 ` [PATCH v7 4/5] docs: counter: Document " William Breathitt Gray 2020-12-26 0:15 ` William Breathitt Gray 2020-12-30 14:47 ` Jonathan Cameron 2020-12-30 14:47 ` Jonathan Cameron 2020-12-30 18:18 ` David Lechner 2020-12-30 18:18 ` David Lechner 2020-12-26 0:15 ` [PATCH v7 5/5] counter: 104-quad-8: Add IRQ support for the ACCES 104-QUAD-8 William Breathitt Gray 2020-12-26 0:15 ` William Breathitt Gray 2020-12-30 15:31 ` Jonathan Cameron 2020-12-30 15:31 ` Jonathan Cameron 2021-02-12 6:04 ` William Breathitt Gray 2021-02-12 6:04 ` William Breathitt Gray 2020-12-30 17:36 ` David Lechner 2020-12-30 17:36 ` David Lechner 2021-02-11 23:56 ` William Breathitt Gray 2021-02-11 23:56 ` William Breathitt Gray 2021-02-12 1:10 ` David Lechner 2021-02-12 1:10 ` David Lechner 2020-12-30 23:34 ` [PATCH v7 0/5] Introduce the Counter character device interface David Lechner 2020-12-30 23:34 ` David Lechner 2020-12-26 18:47 [PATCH v7 1/5] counter: Internalize sysfs interface code kernel test robot
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.