gpiolib: convert gpiod_lookup description to kernel-doc

The patch moves description of the fields to the top of struct definition and
converts them to the kernel-doc format.

There is no functional change.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Alexandre Courbot <acourbot@nvidia.com>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
This commit is contained in:
Andy Shevchenko 2013-12-05 11:26:25 +02:00 committed by Linus Walleij
parent 1a2a99c69e
commit f9244ae5dc
1 changed files with 9 additions and 17 deletions

View File

@ -137,29 +137,21 @@ enum gpio_lookup_flags {
}; };
/** /**
* Lookup table for associating GPIOs to specific devices and functions using * struct gpiod_lookup - lookup table
* platform data. * @chip_label: name of the chip the GPIO belongs to
* @chip_hwnum: hardware number (i.e. relative to the chip) of the GPIO
* @con_id: name of the GPIO from the device's point of view
* @idx: index of the GPIO in case several GPIOs share the same name
* @flags: mask of GPIO_* values
*
* gpiod_lookup is a lookup table for associating GPIOs to specific devices and
* functions using platform data.
*/ */
struct gpiod_lookup { struct gpiod_lookup {
/*
* name of the chip the GPIO belongs to
*/
const char *chip_label; const char *chip_label;
/*
* hardware number (i.e. relative to the chip) of the GPIO
*/
u16 chip_hwnum; u16 chip_hwnum;
/*
* name of the GPIO from the device's point of view
*/
const char *con_id; const char *con_id;
/*
* index of the GPIO in case several GPIOs share the same name
*/
unsigned int idx; unsigned int idx;
/*
* mask of GPIO_* values
*/
enum gpio_lookup_flags flags; enum gpio_lookup_flags flags;
}; };