staging: iio:: fix some typos
typos in comments, fix ring_sw module description Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net> Acked-by: Jonathan Cameron <jic23@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
parent
a21601463d
commit
60ba16e35b
|
@ -12,7 +12,7 @@ struct iio_dev *indio_dev = iio_device_alloc(sizeof(struct chip_state));
|
||||||
where chip_state is a structure of local state data for this instance of
|
where chip_state is a structure of local state data for this instance of
|
||||||
the chip.
|
the chip.
|
||||||
|
|
||||||
That data can be accessed using iio_priv(struct iio_dev *)
|
That data can be accessed using iio_priv(struct iio_dev *).
|
||||||
|
|
||||||
Then fill in the following:
|
Then fill in the following:
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ Then fill in the following:
|
||||||
and for associate parameters such as offsets and scales.
|
and for associate parameters such as offsets and scales.
|
||||||
* info->write_raw:
|
* info->write_raw:
|
||||||
Raw value writing function. Used for writable device values such
|
Raw value writing function. Used for writable device values such
|
||||||
as DAC values and caliboffset.
|
as DAC values and calibbias.
|
||||||
* info->read_event_config:
|
* info->read_event_config:
|
||||||
Typically only set if there are some interrupt lines. This
|
Typically only set if there are some interrupt lines. This
|
||||||
is used to read if an on sensor event detector is enabled.
|
is used to read if an on sensor event detector is enabled.
|
||||||
|
@ -62,8 +62,8 @@ Then fill in the following:
|
||||||
Poll function related elements. This controls what occurs when a trigger
|
Poll function related elements. This controls what occurs when a trigger
|
||||||
to which this device is attached sends an event.
|
to which this device is attached sends an event.
|
||||||
- indio_dev->channels:
|
- indio_dev->channels:
|
||||||
Specification of device channels. Most attributes etc are built
|
Specification of device channels. Most attributes etc. are built
|
||||||
form this spec.
|
from this spec.
|
||||||
- indio_dev->num_channels:
|
- indio_dev->num_channels:
|
||||||
How many channels are there?
|
How many channels are there?
|
||||||
|
|
||||||
|
@ -76,4 +76,4 @@ be registered afterwards (otherwise the whole parentage of devices
|
||||||
gets confused)
|
gets confused)
|
||||||
|
|
||||||
On remove, iio_device_unregister(indio_dev) will remove the device from
|
On remove, iio_device_unregister(indio_dev) will remove the device from
|
||||||
the core, and iio_device_free will clean up.
|
the core, and iio_device_free(indio_dev) will clean up.
|
||||||
|
|
|
@ -8,7 +8,7 @@ actual devices combine some ADCs with digital to analog converters
|
||||||
The aim is to fill the gap between the somewhat similar hwmon and
|
The aim is to fill the gap between the somewhat similar hwmon and
|
||||||
input subsystems. Hwmon is very much directed at low sample rate
|
input subsystems. Hwmon is very much directed at low sample rate
|
||||||
sensors used in applications such as fan speed control and temperature
|
sensors used in applications such as fan speed control and temperature
|
||||||
measurement. Input is, as it's name suggests focused on input
|
measurement. Input is, as its name suggests focused on input
|
||||||
devices. In some cases there is considerable overlap between these and
|
devices. In some cases there is considerable overlap between these and
|
||||||
IIO.
|
IIO.
|
||||||
|
|
||||||
|
|
|
@ -15,8 +15,8 @@ struct iio_ring_buffer contains a struct iio_ring_setup_ops *setup_ops
|
||||||
which in turn contains the 4 function pointers
|
which in turn contains the 4 function pointers
|
||||||
(preenable, postenable, predisable and postdisable).
|
(preenable, postenable, predisable and postdisable).
|
||||||
These are used to perform device specific steps on either side
|
These are used to perform device specific steps on either side
|
||||||
of the core changing it's current mode to indicate that the buffer
|
of the core changing its current mode to indicate that the buffer
|
||||||
is enabled or disabled (along with enabling triggering etc as appropriate).
|
is enabled or disabled (along with enabling triggering etc. as appropriate).
|
||||||
|
|
||||||
Also in struct iio_ring_buffer is a struct iio_ring_access_funcs.
|
Also in struct iio_ring_buffer is a struct iio_ring_access_funcs.
|
||||||
The function pointers within here are used to allow the core to handle
|
The function pointers within here are used to allow the core to handle
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
* @read_p: read pointer (oldest available)
|
* @read_p: read pointer (oldest available)
|
||||||
* @write_p: write pointer
|
* @write_p: write pointer
|
||||||
* @half_p: half buffer length behind write_p (event generation)
|
* @half_p: half buffer length behind write_p (event generation)
|
||||||
* @update_needed: flag to indicated change in size requested
|
* @update_needed: flag to indicate change in size requested
|
||||||
*
|
*
|
||||||
* Note that the first element of all ring buffers must be a
|
* Note that the first element of all ring buffers must be a
|
||||||
* struct iio_buffer.
|
* struct iio_buffer.
|
||||||
|
@ -363,5 +363,5 @@ void iio_sw_rb_free(struct iio_buffer *r)
|
||||||
}
|
}
|
||||||
EXPORT_SYMBOL(iio_sw_rb_free);
|
EXPORT_SYMBOL(iio_sw_rb_free);
|
||||||
|
|
||||||
MODULE_DESCRIPTION("Industrialio I/O software ring buffer");
|
MODULE_DESCRIPTION("Industrial I/O software ring buffer");
|
||||||
MODULE_LICENSE("GPL");
|
MODULE_LICENSE("GPL");
|
||||||
|
|
Loading…
Reference in New Issue