mei: add kdoc for struct mei_aux_device
[platform/kernel/linux-starfive.git] / include / linux / mei_aux.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (c) 2022, Intel Corporation. All rights reserved.
4  */
5 #ifndef _LINUX_MEI_AUX_H
6 #define _LINUX_MEI_AUX_H
7
8 #include <linux/auxiliary_bus.h>
9
10 /**
11  * struct mei_aux_device - mei auxiliary device
12  * @aux_dev: - auxiliary device object
13  * @irq: interrupt driving the mei auxiliary device
14  * @bar: mmio resource bar reserved to mei auxiliary device
15  */
16 struct mei_aux_device {
17         struct auxiliary_device aux_dev;
18         int irq;
19         struct resource bar;
20 };
21
22 #define auxiliary_dev_to_mei_aux_dev(auxiliary_dev) \
23         container_of(auxiliary_dev, struct mei_aux_device, aux_dev)
24
25 #endif /* _LINUX_MEI_AUX_H */