| Message ID | 20221210102110.443043-4-biju.das.jz@bp.renesas.com (mailing list archive) |
|---|---|
| State | Handled Elsewhere |
| Headers | show |
| Series | None | expand |
On Sat, Dec 10, 2022 at 10:21:08AM +0000, Biju Das wrote: > +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select > +KernelVersion: 6.3 > +Contact: linux-iio@vger.kernel.org > +Description: > + This attribute selects the external clock pin for phase > + counting mode of counter X. Hi Biju, Remove the "This attribute" from the description, and capitalize the word "counter": "Selects the external clock pin for phase counting mode of Counter X." > +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_available At some point in the future I should combine the *_available blocks, but right now they're separated between Count and Signal configurations. This external_input_phase_clock_select_available is a device-level configuration so it'll need its own block as well, such as the following. What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_available KernelVersion: 6.3 Contact: linux-iio@vger.kernel.org Description: Discrete set of available values for the respective device configuration are listed in this file. > +What: /sys/bus/counter/devices/counterX/cascade_counts_enable > +KernelVersion: 6.3 > +Contact: linux-iio@vger.kernel.org > +Description: > + This attribute indicates the cascading of counts on > + counter X. Similar to before, remove the "This attribute" from the description, and capitalize "counts" and "counter": "Indicates the cascading of Counts on Counter X." William Breathitt Gray
On Sun, Dec 11, 2022 at 04:12:51PM +0000, Biju Das wrote: > Hi William Breathitt Gray, > > Thanks for the feedback. > > > Subject: Re: [PATCH v8 3/5] Documentation: ABI: sysfs-bus-counter: add > > cascade_counts_enable and external_input_phase_clock_select > > > > On Sat, Dec 10, 2022 at 10:21:08AM +0000, Biju Das wrote: > > > +What: > > /sys/bus/counter/devices/counterX/external_input_phase_clock_select > > > +KernelVersion: 6.3 > > > +Contact: linux-iio@vger.kernel.org > > > +Description: > > > + This attribute selects the external clock pin for phase > > > + counting mode of counter X. > > > > Hi Biju, > > > > Remove the "This attribute" from the description, and capitalize the word > > "counter": "Selects the external clock pin for phase counting mode of > > Counter X." > > > > > +What: > > /sys/bus/counter/devices/counterX/external_input_phase_clock_select_ > > available > > > > At some point in the future I should combine the *_available blocks, but > > right now they're separated between Count and Signal configurations. > > This external_input_phase_clock_select_available is a device-level > > configuration so it'll need its own block as well, such as the following. > > Since it is device-level configuration, I will move the below 3 blocks > to the top of file. I hope it is ok to you. That's okay with me, so go ahead. I think at one point I was trying to keep the attributes listed in alphabetical order, but I haven't really minded lately as long as the information in this file is clear. William Breathitt Gray > > +What: /sys/bus/counter/devices/counterX/cascade_counts_enable > +KernelVersion: 6.3 > +Contact: linux-iio@vger.kernel.org > +Description: > + Indicates the cascading of Counts on Counter X. > + > + Valid attribute values are boolean. > + > +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select > +KernelVersion: 6.3 > +Contact: linux-iio@vger.kernel.org > +Description: > + Selects the external clock pin for phase counting mode of > + Counter X. > + > + MTCLKA-MTCLKB: > + MTCLKA and MTCLKB pins are selected for the external > + phase clock. > + > + MTCLKC-MTCLKD: > + MTCLKC and MTCLKD pins are selected for the external > + phase clock. > + > +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_available > +KernelVersion: 6.3 > +Contact: linux-iio@vger.kernel.org > +Description: > + Discrete set of available values for the respective device > + configuration are listed in this file. > > Cheers, > Biju
Hi William Breathitt Gray, Thanks for the feedback. > Subject: Re: [PATCH v8 3/5] Documentation: ABI: sysfs-bus-counter: add > cascade_counts_enable and external_input_phase_clock_select > > On Sat, Dec 10, 2022 at 10:21:08AM +0000, Biju Das wrote: > > +What: > /sys/bus/counter/devices/counterX/external_input_phase_clock_select > > +KernelVersion: 6.3 > > +Contact: linux-iio@vger.kernel.org > > +Description: > > + This attribute selects the external clock pin for phase > > + counting mode of counter X. > > Hi Biju, > > Remove the "This attribute" from the description, and capitalize the word > "counter": "Selects the external clock pin for phase counting mode of > Counter X." > > > +What: > /sys/bus/counter/devices/counterX/external_input_phase_clock_select_ > available > > At some point in the future I should combine the *_available blocks, but > right now they're separated between Count and Signal configurations. > This external_input_phase_clock_select_available is a device-level > configuration so it'll need its own block as well, such as the following. Since it is device-level configuration, I will move the below 3 blocks to the top of file. I hope it is ok to you. +What: /sys/bus/counter/devices/counterX/cascade_counts_enable +KernelVersion: 6.3 +Contact: linux-iio@vger.kernel.org +Description: + Indicates the cascading of Counts on Counter X. + + Valid attribute values are boolean. + +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select +KernelVersion: 6.3 +Contact: linux-iio@vger.kernel.org +Description: + Selects the external clock pin for phase counting mode of + Counter X. + + MTCLKA-MTCLKB: + MTCLKA and MTCLKB pins are selected for the external + phase clock. + + MTCLKC-MTCLKD: + MTCLKC and MTCLKD pins are selected for the external + phase clock. + +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_available +KernelVersion: 6.3 +Contact: linux-iio@vger.kernel.org +Description: + Discrete set of available values for the respective device + configuration are listed in this file. Cheers, Biju
diff --git a/Documentation/ABI/testing/sysfs-bus-counter b/Documentation/ABI/testing/sysfs-bus-counter index ff83320b4255..2e7a25010c84 100644 --- a/Documentation/ABI/testing/sysfs-bus-counter +++ b/Documentation/ABI/testing/sysfs-bus-counter @@ -60,6 +60,20 @@ Description: counter does not freeze at the boundary points, but counts continuously throughout. +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select +KernelVersion: 6.3 +Contact: linux-iio@vger.kernel.org +Description: + This attribute selects the external clock pin for phase + counting mode of counter X. + + MTCLKA-MTCLKB: + MTCLKA and MTCLKB pins are selected for the external phase clock. + + MTCLKC-MTCLKD: + MTCLKC and MTCLKD pins are selected for the external phase clock. + +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_available What: /sys/bus/counter/devices/counterX/countY/count_mode_available What: /sys/bus/counter/devices/counterX/countY/error_noise_available What: /sys/bus/counter/devices/counterX/countY/function_available @@ -215,6 +229,17 @@ Contact: linux-iio@vger.kernel.org Description: This attribute indicates the number of overflows of count Y. +What: /sys/bus/counter/devices/counterX/cascade_counts_enable +KernelVersion: 6.3 +Contact: linux-iio@vger.kernel.org +Description: + This attribute indicates the cascading of counts on + counter X. + + Valid attribute values are boolean. + +What: /sys/bus/counter/devices/counterX/cascade_counts_enable_component_id +What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_component_id What: /sys/bus/counter/devices/counterX/countY/capture_component_id What: /sys/bus/counter/devices/counterX/countY/ceiling_component_id What: /sys/bus/counter/devices/counterX/countY/floor_component_id
This commit adds cascade_counts_enable and external_input_phase_ clock_select items to counter ABI file. (e.g. for Renesas MTU3 hardware used for phase counting). Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com> --- v7->v8: * Replaced cascade_enable->cascade_counts_enable * Updated commit header and description * Added external_input_phase_clock_select_available entry for driver- specific enum attribute and created a new entry block for it. * Add a line stating cascade_counts_enable is a boolean attribute. * Added missing 'component_id' suffix. v6->v7: * Replaced long_word_access_ctrl_mode->cascade_enable * Updated Kernel version v5->v6: * No change v5: * New patch --- Documentation/ABI/testing/sysfs-bus-counter | 25 +++++++++++++++++++++ 1 file changed, 25 insertions(+)