diff options
author | Simon Que <sque@chromium.org> | 2018-06-29 22:49:38 -0400 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2018-07-02 09:01:49 +0200 |
commit | 9a69f5087ccc20bb411025decab455836df04168 (patch) | |
tree | 92d560731f5c2ebcf237cc6a8e86480f4a4ec60e /drivers/staging/gasket/TODO | |
parent | ee55fe552fcd8dcdafc52155ba515548c6538647 (diff) |
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>
Diffstat (limited to 'drivers/staging/gasket/TODO')
-rw-r--r-- | drivers/staging/gasket/TODO | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/drivers/staging/gasket/TODO b/drivers/staging/gasket/TODO new file mode 100644 index 000000000000..0d8ee9602c80 --- /dev/null +++ b/drivers/staging/gasket/TODO @@ -0,0 +1,17 @@ +This is a list of things that need to be done to get this driver out of the +staging directory. +- Use SPDX tags to show the license of the file, and no more "boiler-plate" + license text is needed. +- Remove static function declarations. +- Document sysfs files with Documentation/ABI/ entries. +- Use misc interface instead of major number for driver version description. +- Add descriptions of module_param's +- Remove gasket-specific logging functions. +- apex_get_status() should actually check status. +- Static functions don't need kernel doc formatting, can be simplified. +- Fix multi-line alignment formatting to look like: + int ret = long_function_name(device, VARIABLE1, VARIABLE2, + VARIABLE3, VARIABLE4); +- "drivers" should never be dealing with "raw" sysfs calls or mess around with + kobjects at all. The driver core should handle all of this for you + automaically. There should not be a need for raw attribute macros. |