| Message ID | 20190310174640.dksy7pfkptrbcdgj@smtp.gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | move out of staging | expand |
On Sun, Mar 10, 2019 at 7:47 PM Marcelo Schmitt <marcelo.schmitt1@gmail.com> wrote: > > Add an ABI documentation for the ad5933 driver. There's already an ABI documentation for this driver. See: https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/tree/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933 Apologies for not mentioning this sooner. Could you check for other references for ad5933 in the kernel (in staging) ? I don't think I missed other stuff, but it's good to check. > > Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.com> > --- > .../ABI/testing/sysfs-bus-iio-ad5933 | 39 +++++++++++++++++++ > 1 file changed, 39 insertions(+) > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933 > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-ad5933 b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 > new file mode 100644 > index 000000000000..8a60dd178b1f > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 > @@ -0,0 +1,39 @@ > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start > +Date: March 2019 > +KernelVersion: Kernel 4.19 > +Contact: linux-iio@vger.kernel.org > +Description: > + The start frequency. Set this to define the frequency point at > + which the device should start the next frequency sweep. > + > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_increment > +Date: March 2019 > +KernelVersion: Kernel 4.19 > +Contact: linux-iio@vger.kernel.org > +Description: > + The frequency sweep increment. Set this to define the amount by > + which the frequency is incremented after each scan point. After > + the measurement at a frequency point is completed, the next > + measurement will be made at a frequency point > + 'frequency increment'Hz higher than the previous one unless a > + repeat frequency command is issued. This behavior will follow > + until the defined number of frequency points have been measured > + or frequency sweep is somewhat reset. > + > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_points > +Date: March 2019 > +KernelVersion: Kernel 4.19 > +Contact: linux-iio@vger.kernel.org > +Description: > + The number of increments. This defines the number of frequency > + points in the frequency sweep. > + > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_settling_cycles > +Date: March 2019 > +KernelVersion: Kernel 4.19 > +Contact: linux-iio@vger.kernel.org > +Description: > + Number of settling time cycles. This sets the delay between a > + start frequency sweep/increment frequency /repeat frequency to > + be proportional to the excitation signal frequency times the > + number of settling time cycles. > -- > 2.20.1 >
On 03/11, Alexandru Ardelean wrote: > On Sun, Mar 10, 2019 at 7:47 PM Marcelo Schmitt > <marcelo.schmitt1@gmail.com> wrote: > > > > Add an ABI documentation for the ad5933 driver. > > There's already an ABI documentation for this driver. > See: > https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/tree/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933 > > Apologies for not mentioning this sooner. > > Could you check for other references for ad5933 in the kernel (in staging) ? > I don't think I missed other stuff, but it's good to check. > Didn't see any other reference for ad5933 with find and grep inside iio, neither on general documentation. I'll replace mine ABI doc by yours and add your sign-off-by on my next patch set. OK? > > > > Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.com> > > --- > > .../ABI/testing/sysfs-bus-iio-ad5933 | 39 +++++++++++++++++++ > > 1 file changed, 39 insertions(+) > > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933 > > > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-ad5933 b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 > > new file mode 100644 > > index 000000000000..8a60dd178b1f > > --- /dev/null > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 > > @@ -0,0 +1,39 @@ > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start > > +Date: March 2019 > > +KernelVersion: Kernel 4.19 > > +Contact: linux-iio@vger.kernel.org > > +Description: > > + The start frequency. Set this to define the frequency point at > > + which the device should start the next frequency sweep. > > + > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_increment > > +Date: March 2019 > > +KernelVersion: Kernel 4.19 > > +Contact: linux-iio@vger.kernel.org > > +Description: > > + The frequency sweep increment. Set this to define the amount by > > + which the frequency is incremented after each scan point. After > > + the measurement at a frequency point is completed, the next > > + measurement will be made at a frequency point > > + 'frequency increment'Hz higher than the previous one unless a > > + repeat frequency command is issued. This behavior will follow > > + until the defined number of frequency points have been measured > > + or frequency sweep is somewhat reset. > > + > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_points > > +Date: March 2019 > > +KernelVersion: Kernel 4.19 > > +Contact: linux-iio@vger.kernel.org > > +Description: > > + The number of increments. This defines the number of frequency > > + points in the frequency sweep. > > + > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_settling_cycles > > +Date: March 2019 > > +KernelVersion: Kernel 4.19 > > +Contact: linux-iio@vger.kernel.org > > +Description: > > + Number of settling time cycles. This sets the delay between a > > + start frequency sweep/increment frequency /repeat frequency to > > + be proportional to the excitation signal frequency times the > > + number of settling time cycles. > > -- > > 2.20.1 > >
On Tue, Mar 12, 2019 at 7:31 PM Marcelo Schmitt <marcelo.schmitt1@gmail.com> wrote: > > On 03/11, Alexandru Ardelean wrote: > > On Sun, Mar 10, 2019 at 7:47 PM Marcelo Schmitt > > <marcelo.schmitt1@gmail.com> wrote: > > > > > > Add an ABI documentation for the ad5933 driver. > > > > There's already an ABI documentation for this driver. > > See: > > https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/tree/drivers/staging/iio/Documentation/sysfs-bus-iio-impedance-analyzer-ad5933 > > > > Apologies for not mentioning this sooner. > > > > Could you check for other references for ad5933 in the kernel (in staging) ? > > I don't think I missed other stuff, but it's good to check. > > > > Didn't see any other reference for ad5933 with find and grep inside iio, > neither on general documentation. I'll replace mine ABI doc by yours and > add your sign-off-by on my next patch set. OK? You don't need to add me anywhere :) I did not contribute anything to that ABI doc. I just raised a note about it. But, that doc should be taken care of; whether you update it, remove it, or anything. It's good to not forget it in staging. > > > > > > > Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.com> > > > --- > > > .../ABI/testing/sysfs-bus-iio-ad5933 | 39 +++++++++++++++++++ > > > 1 file changed, 39 insertions(+) > > > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933 > > > > > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-ad5933 b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 > > > new file mode 100644 > > > index 000000000000..8a60dd178b1f > > > --- /dev/null > > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 > > > @@ -0,0 +1,39 @@ > > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start > > > +Date: March 2019 > > > +KernelVersion: Kernel 4.19 > > > +Contact: linux-iio@vger.kernel.org > > > +Description: > > > + The start frequency. Set this to define the frequency point at > > > + which the device should start the next frequency sweep. > > > + > > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_increment > > > +Date: March 2019 > > > +KernelVersion: Kernel 4.19 > > > +Contact: linux-iio@vger.kernel.org > > > +Description: > > > + The frequency sweep increment. Set this to define the amount by > > > + which the frequency is incremented after each scan point. After > > > + the measurement at a frequency point is completed, the next > > > + measurement will be made at a frequency point > > > + 'frequency increment'Hz higher than the previous one unless a > > > + repeat frequency command is issued. This behavior will follow > > > + until the defined number of frequency points have been measured > > > + or frequency sweep is somewhat reset. > > > + > > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_points > > > +Date: March 2019 > > > +KernelVersion: Kernel 4.19 > > > +Contact: linux-iio@vger.kernel.org > > > +Description: > > > + The number of increments. This defines the number of frequency > > > + points in the frequency sweep. > > > + > > > +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_settling_cycles > > > +Date: March 2019 > > > +KernelVersion: Kernel 4.19 > > > +Contact: linux-iio@vger.kernel.org > > > +Description: > > > + Number of settling time cycles. This sets the delay between a > > > + start frequency sweep/increment frequency /repeat frequency to > > > + be proportional to the excitation signal frequency times the > > > + number of settling time cycles. > > > -- > > > 2.20.1 > > >
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-ad5933 b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 new file mode 100644 index 000000000000..8a60dd178b1f --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-ad5933 @@ -0,0 +1,39 @@ +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_start +Date: March 2019 +KernelVersion: Kernel 4.19 +Contact: linux-iio@vger.kernel.org +Description: + The start frequency. Set this to define the frequency point at + which the device should start the next frequency sweep. + +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_increment +Date: March 2019 +KernelVersion: Kernel 4.19 +Contact: linux-iio@vger.kernel.org +Description: + The frequency sweep increment. Set this to define the amount by + which the frequency is incremented after each scan point. After + the measurement at a frequency point is completed, the next + measurement will be made at a frequency point + 'frequency increment'Hz higher than the previous one unless a + repeat frequency command is issued. This behavior will follow + until the defined number of frequency points have been measured + or frequency sweep is somewhat reset. + +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_freq_points +Date: March 2019 +KernelVersion: Kernel 4.19 +Contact: linux-iio@vger.kernel.org +Description: + The number of increments. This defines the number of frequency + points in the frequency sweep. + +What:/sys/bus/iio/devices/iio:deviceX/out_voltage0_settling_cycles +Date: March 2019 +KernelVersion: Kernel 4.19 +Contact: linux-iio@vger.kernel.org +Description: + Number of settling time cycles. This sets the delay between a + start frequency sweep/increment frequency /repeat frequency to + be proportional to the excitation signal frequency times the + number of settling time cycles.
Add an ABI documentation for the ad5933 driver. Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.com> --- .../ABI/testing/sysfs-bus-iio-ad5933 | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-ad5933