| Message ID | 1445502750-22672-6-git-send-email-linus.walleij@linaro.org |
|---|---|
| State | New |
| Headers | show |
On Thu, Oct 22, 2015 at 10:32:29AM +0200, Linus Walleij wrote: > Put in some documentation for the new character device ABI > so we can properly etch it in stone. > > Signed-off-by: Linus Walleij <linus.walleij@linaro.org> > --- > Documentation/ABI/testing/gpio-cdev | 26 ++++++++++++++++++++++++++ > MAINTAINERS | 1 + > 2 files changed, 27 insertions(+) > create mode 100644 Documentation/ABI/testing/gpio-cdev > > diff --git a/Documentation/ABI/testing/gpio-cdev b/Documentation/ABI/testing/gpio-cdev > new file mode 100644 > index 000000000000..7b265fbb47e3 > --- /dev/null > +++ b/Documentation/ABI/testing/gpio-cdev > @@ -0,0 +1,26 @@ > +What: /dev/gpiochip[0-9]+ > +Date: November 2015 > +KernelVersion: 4.4 > +Contact: linux-gpio@vger.kernel.org > +Description: > + The character device files /dev/gpiochip* are the interface > + between GPIO chips and userspace. > + > + The ioctl(2)-based ABI is defined and documented in > + [include/uapi]<linux/gpio.h>. > + > + The following file operations are supported: > + > + open(2) > + Currently the only useful flags are O_RDWR. > + > + ioctl(2) > + Initiate various actions. > + See the inline documentation in [include/uapi]<linux/gpio.h> > + for descriptions of all ioctls. Minor thing: The one ioctl is obvious but has no inline documentation at the moment. Best Regards, Markus > + > + close(2) > + Stops and free up the I/O contexts that was associated > + with the file descriptor. > + > +Users: TBD > diff --git a/MAINTAINERS b/MAINTAINERS > index 3bb1f52d54e0..23cd966cb974 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -4642,6 +4642,7 @@ L: linux-gpio@vger.kernel.org > T: git git://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-gpio.git > S: Maintained > F: Documentation/gpio/ > +F: Documentation/ABI/testing/gpio-cdev > F: drivers/gpio/ > F: include/linux/gpio/ > F: include/linux/gpio.h > -- > 2.4.3 > >
diff --git a/Documentation/ABI/testing/gpio-cdev b/Documentation/ABI/testing/gpio-cdev new file mode 100644 index 000000000000..7b265fbb47e3 --- /dev/null +++ b/Documentation/ABI/testing/gpio-cdev @@ -0,0 +1,26 @@ +What: /dev/gpiochip[0-9]+ +Date: November 2015 +KernelVersion: 4.4 +Contact: linux-gpio@vger.kernel.org +Description: + The character device files /dev/gpiochip* are the interface + between GPIO chips and userspace. + + The ioctl(2)-based ABI is defined and documented in + [include/uapi]<linux/gpio.h>. + + The following file operations are supported: + + open(2) + Currently the only useful flags are O_RDWR. + + ioctl(2) + Initiate various actions. + See the inline documentation in [include/uapi]<linux/gpio.h> + for descriptions of all ioctls. + + close(2) + Stops and free up the I/O contexts that was associated + with the file descriptor. + +Users: TBD diff --git a/MAINTAINERS b/MAINTAINERS index 3bb1f52d54e0..23cd966cb974 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4642,6 +4642,7 @@ L: linux-gpio@vger.kernel.org T: git git://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-gpio.git S: Maintained F: Documentation/gpio/ +F: Documentation/ABI/testing/gpio-cdev F: drivers/gpio/ F: include/linux/gpio/ F: include/linux/gpio.h
Put in some documentation for the new character device ABI so we can properly etch it in stone. Signed-off-by: Linus Walleij <linus.walleij@linaro.org> --- Documentation/ABI/testing/gpio-cdev | 26 ++++++++++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 27 insertions(+) create mode 100644 Documentation/ABI/testing/gpio-cdev