WSL2-Linux-Kernel/drivers/staging/nvec
Lee Jones e950dd6bb3 staging: nvec: Fix a bunch of kernel-doc issues
Fixes the following W=1 kernel build warning(s):

 drivers/staging/nvec/nvec.c:109: warning: Function parameter or member 'events' not described in 'nvec_register_notifier'
 drivers/staging/nvec/nvec.c:136: warning: Function parameter or member 'nb' not described in 'nvec_status_notifier'
 drivers/staging/nvec/nvec.c:136: warning: Function parameter or member 'event_type' not described in 'nvec_status_notifier'
 drivers/staging/nvec/nvec.c:136: warning: Function parameter or member 'data' not described in 'nvec_status_notifier'
 drivers/staging/nvec/nvec.c:358: warning: Function parameter or member 'ev' not described in 'nvec_event_mask'
 drivers/staging/nvec/nvec.c:358: warning: Function parameter or member 'mask' not described in 'nvec_event_mask'

Cc: Marc Dietrich <marvin24@gmx.de>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Philipp Zabel <p.zabel@pengutronix.de>
Cc: Kernel Team <ac100@lists.lauchpad.net>
Cc: Pierre-Hugues Husson <phhusson@free.fr>
Cc: Ilya Petrov <ilya.muromec@gmail.com>
Cc: Andres Klode <jak@jak-linux.org>
Cc: ac100@lists.launchpad.net
Cc: linux-tegra@vger.kernel.org
Cc: linux-staging@lists.linux.dev
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210414181129.1628598-23-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2021-05-10 11:19:24 +02:00
..
Kconfig staging: nvec: Fix Kconfig indentation 2019-11-20 15:20:29 +01:00
Makefile
README Staging: nvec: Replace HTTP links with HTTPS ones 2020-07-10 13:52:46 +02:00
TODO Revert "staging: nvec: Augment TODO file with GPIO work item" 2018-04-23 18:49:51 +02:00
nvec-keytable.h staging: nvec: remove redundant license text 2018-01-15 16:03:45 +01:00
nvec.c staging: nvec: Fix a bunch of kernel-doc issues 2021-05-10 11:19:24 +02:00
nvec.h staging: nvec: convert to use GPIO descriptors 2018-04-23 14:38:00 +02:00
nvec_kbd.c staging: nvec: check return value 2019-12-19 19:23:29 +01:00
nvec_paz00.c staging: nvec: remove redundant license text 2018-01-15 16:03:45 +01:00
nvec_power.c staging: nvec: minor coding style fix 2021-02-12 09:49:43 +01:00
nvec_ps2.c staging/nvec:: avoid Wempty-body warning 2021-03-22 17:05:15 +01:00

README

NVEC: An NVidia compliant Embedded Controller Protocol Implementation

This is an implementation of the NVEC protocol used to communicate with an
embedded controller (EC) via I2C bus. The EC is an I2C master while the host
processor is the I2C slave. Requests from the host processor to the EC are
started by triggering a gpio line.

There is no written documentation of the protocol available to the public,
but the source code[1] of the published nvec reference drivers can be a guide.
This driver is currently only used by the AC100 project[2], but it is likely,
that other Tegra boards (not yet mainlined, if ever) also use it.

[1] e.g. https://nv-tegra.nvidia.com/gitweb/?p=linux-2.6.git;a=tree;f=arch/arm/mach-tegra/nvec;hb=android-tegra-2.6.32
[2] http://gitorious.org/ac100, http://launchpad.net/ac100