[PATCH] staging: comedi: improve comedi_check_chanlist() documentation

[Hartley Sweeten]

On Wednesday, August 05, 2015 10:13 AM, Ian Abbott wrote:
>
> Signed-off-by: Ian Abbott <abbotti at mev.co.uk>
> ---
>  drivers/staging/comedi/range.c | 13 ++++++++++++-
>  1 file changed, 12 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/staging/comedi/range.c b/drivers/staging/comedi/range.c
> index 6a393b2..ce3a58a 100644
> --- a/drivers/staging/comedi/range.c
> +++ b/drivers/staging/comedi/range.c
> @@ -102,7 +102,18 @@ int do_rangeinfo_ioctl(struct comedi_device *dev,
>   * @s: comedi_subdevice struct
>   * @n: number of elements in the chanlist
>   * @chanlist: the chanlist to validate
> -*/
> + *
> + * Each element consists of a channel number, a range index, an analog
> + * reference type and some flags, all packed into an unsigned int.
> + *
> + * This checks that the channel number and range index are supported by
> + * the comedi subdevice.  It does not check whether the analog reference
> + * type and the flags are supported.  Drivers that care should check those
> + * themselves.
> + *
> + * Return: %0 if all @chanlist elements are valid (success),
> + *         %-EINVAL if one or more elements are invalid.
> + */
>  int comedi_check_chanlist(struct comedi_subdevice *s, int n,
>  			  unsigned int *chanlist)
>  {

Thanks,

Reviewed-by: H Hartley Sweeten <hsweeten at visionengravers.com>