counter: Update counter.h comments to reflect sysfs internalization

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
header file comments to reflect the changes.

Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
Link: https://lore.kernel.org/r/19da8ae0c05381b0967c8a334b67f86b814eb880.1630031207.git.vilhelm.gray@gmail.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

diff --git a/drivers/counter/counter-core.c b/drivers/counter/counter-core.c
index c533a6ff12cf7a5d41c3f930ab1d00b3240207c4..3cda2c47bacb1b839ac42a1459f4ae985728d633 100644 (file)
--- a/drivers/counter/counter-core.c
+++ b/drivers/counter/counter-core.c
@@ -38,6 +38,9 @@ static struct bus_type counter_bus_type = {
  * 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.
+ *
+ * RETURNS:
+ * 0 on success, negative error number on failure.
  */
 int counter_register(struct counter_device *const counter)
 {

diff --git a/include/linux/counter.h b/include/linux/counter.h
index b69277f5c4c5ec9ee16e6b79000990b778d59f99..445f22d8bfe2d9b11be140a65643b9c150e8889e 100644 (file)
--- a/include/linux/counter.h
+++ b/include/linux/counter.h
@@ -188,11 +188,10 @@ struct counter_comp {
 
 /**
  * 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
+ * @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;
@@ -206,7 +205,7 @@ struct counter_signal {
  * struct counter_synapse - Counter Synapse node
  * @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 {
        const enum counter_synapse_action *actions_list;
@@ -217,15 +216,14 @@ struct counter_synapse {
 
 /**
  * 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
- * @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
+ * @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;
@@ -243,27 +241,27 @@ struct counter_count {
 
 /**
  * struct counter_ops - Callbacks from driver
- * @signal_read:       optional read callback for Signal attribute. The read
- *                     level of the respective Signal should be passed back via
- *                     the level 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:       optional read callback for Signals. The read level of
+ *                     the respective Signal should be passed back via the
+ *                     level parameter.
+ * @count_read:                read callback for Counts. The read value of the
+ *                     respective Count should be passed back via the value
+ *                     parameter.
+ * @count_write:       optional 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.
+ * @function_write:    optional write callback for Count function modes. The
+ *                     function mode to write for the respective Count is
+ *                     passed in via the function parameter.
+ * @action_read:       optional read callback the Synapse action modes. The
+ *                     read action mode of the respective Synapse should be
+ *                     passed back via the action parameter.
+ * @action_write:      optional 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,
@@ -291,7 +289,7 @@ struct counter_ops {
 
 /**
  * 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
  * @ops:               callbacks from driver
  * @signals:           array of Signals