From: Tomas Winkler <tomas.winkler@intel.com>
Date: Wed, 7 Sep 2022 21:50:59 +0000 (+0300)
Subject: mei: add kdoc for struct mei_aux_device
X-Git-Tag: v6.1-rc1~159^2~12^2~45
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=fd72cb1bb5c71d2738a17cbdee6280365a451706;p=thirdparty%2Flinux.git

mei: add kdoc for struct mei_aux_device

struct mei_aux_device is an interface structure
requires proper documenation.

Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
Reviewed-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
Signed-off-by: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20220907215113.1596567-3-tomas.winkler@intel.com
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
---

diff --git a/include/linux/mei_aux.h b/include/linux/mei_aux.h
index 587f251288481..a0cb587006d5a 100644
--- a/include/linux/mei_aux.h
+++ b/include/linux/mei_aux.h
@@ -7,6 +7,12 @@
 
 #include <linux/auxiliary_bus.h>
 
+/**
+ * struct mei_aux_device - mei auxiliary device
+ * @aux_dev: - auxiliary device object
+ * @irq: interrupt driving the mei auxiliary device
+ * @bar: mmio resource bar reserved to mei auxiliary device
+ */
 struct mei_aux_device {
 	struct auxiliary_device aux_dev;
 	int irq;