drivers/staging: Gasket driver framework + Apex driver
authorSimon Que <sque@chromium.org>
Sat, 30 Jun 2018 02:49:38 +0000 (22:49 -0400)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 2 Jul 2018 07:01:49 +0000 (09:01 +0200)
commit9a69f5087ccc20bb411025decab455836df04168
tree92d560731f5c2ebcf237cc6a8e86480f4a4ec60e
parentee55fe552fcd8dcdafc52155ba515548c6538647
drivers/staging: Gasket driver framework + Apex driver

The Gasket (Google ASIC Software, Kernel Extensions, and Tools) kernel
framework is a generic, flexible system that supports thin kernel
drivers. Gasket kernel drivers are expected to handle opening and
closing devices, mmap'ing BAR space as requested, a small selection of
ioctls, and handling page table translation (covered below). Any other
functions should be handled by userspace code.

The Gasket common module is not enough to run a device. In order to
customize the Gasket code for a given piece of hardware, a device
specific module must be created. At a minimum, this module must define a
struct gasket_driver_desc containing the device-specific data for use by
the framework; in addition, the module must declare an __init function
that calls gasket_register_device with the module's gasket_driver_desc
struct. Finally, the driver must define an exit function that calls
gasket_unregister_device with the module's gasket_driver_desc struct.

One of the core assumptions of the Gasket framework is that precisely
one process is allowed to have an open write handle to the device node
at any given time. (That process may, once it has one write handle, open
any number of additional write handles.) This is accomplished by
tracking open and close data for each driver instance.

Signed-off-by: Rob Springer <rspringer@google.com>
Signed-off-by: John Joseph <jnjoseph@google.com>
Signed-off-by: Simon Que <sque@chromium.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
21 files changed:
MAINTAINERS
drivers/staging/Kconfig
drivers/staging/Makefile
drivers/staging/gasket/Kconfig [new file with mode: 0644]
drivers/staging/gasket/Makefile [new file with mode: 0644]
drivers/staging/gasket/TODO [new file with mode: 0644]
drivers/staging/gasket/apex.h [new file with mode: 0644]
drivers/staging/gasket/apex_driver.c [new file with mode: 0644]
drivers/staging/gasket/gasket.h [new file with mode: 0644]
drivers/staging/gasket/gasket_constants.h [new file with mode: 0644]
drivers/staging/gasket/gasket_core.c [new file with mode: 0644]
drivers/staging/gasket/gasket_core.h [new file with mode: 0644]
drivers/staging/gasket/gasket_interrupt.c [new file with mode: 0644]
drivers/staging/gasket/gasket_interrupt.h [new file with mode: 0644]
drivers/staging/gasket/gasket_ioctl.c [new file with mode: 0644]
drivers/staging/gasket/gasket_ioctl.h [new file with mode: 0644]
drivers/staging/gasket/gasket_logging.h [new file with mode: 0644]
drivers/staging/gasket/gasket_page_table.c [new file with mode: 0644]
drivers/staging/gasket/gasket_page_table.h [new file with mode: 0644]
drivers/staging/gasket/gasket_sysfs.c [new file with mode: 0644]
drivers/staging/gasket/gasket_sysfs.h [new file with mode: 0644]