ronnie
2022-10-23 1972b0e7ed50e5b37c5633d662ea03d23b15499c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
#ifndef _LINUX_MEI_CL_BUS_H
#define _LINUX_MEI_CL_BUS_H
 
#include <linux/device.h>
#include <linux/uuid.h>
#include <linux/mod_devicetable.h>
 
struct mei_cl_device;
struct mei_device;
 
typedef void (*mei_cldev_event_cb_t)(struct mei_cl_device *cldev,
                    u32 events, void *context);
 
/**
 * struct mei_cl_device - MEI device handle
 * An mei_cl_device pointer is returned from mei_add_device()
 * and links MEI bus clients to their actual ME host client pointer.
 * Drivers for MEI devices will get an mei_cl_device pointer
 * when being probed and shall use it for doing ME bus I/O.
 *
 * @bus_list: device on the bus list
 * @bus: parent mei device
 * @dev: linux driver model device pointer
 * @me_cl: me client
 * @cl: mei client
 * @name: device name
 * @event_work: async work to execute event callback
 * @event_cb: Drivers register this callback to get asynchronous ME
 *    events (e.g. Rx buffer pending) notifications.
 * @event_context: event callback run context
 * @events_mask: Events bit mask requested by driver.
 * @events: Events bitmask sent to the driver.
 *
 * @do_match: wheather device can be matched with a driver
 * @is_added: device is already scanned
 * @priv_data: client private data
 */
struct mei_cl_device {
   struct list_head bus_list;
   struct mei_device *bus;
   struct device dev;
 
   struct mei_me_client *me_cl;
   struct mei_cl *cl;
   char name[MEI_CL_NAME_SIZE];
 
   struct work_struct event_work;
   mei_cldev_event_cb_t event_cb;
   void *event_context;
   unsigned long events_mask;
   unsigned long events;
 
   unsigned int do_match:1;
   unsigned int is_added:1;
 
   void *priv_data;
};
 
struct mei_cl_driver {
   struct device_driver driver;
   const char *name;
 
   const struct mei_cl_device_id *id_table;
 
   int (*probe)(struct mei_cl_device *cldev,
            const struct mei_cl_device_id *id);
   int (*remove)(struct mei_cl_device *cldev);
};
 
int __mei_cldev_driver_register(struct mei_cl_driver *cldrv,
               struct module *owner);
#define mei_cldev_driver_register(cldrv)             \
   __mei_cldev_driver_register(cldrv, THIS_MODULE)
 
void mei_cldev_driver_unregister(struct mei_cl_driver *cldrv);
 
ssize_t mei_cldev_send(struct mei_cl_device *cldev, u8 *buf, size_t length);
ssize_t  mei_cldev_recv(struct mei_cl_device *cldev, u8 *buf, size_t length);
 
int mei_cldev_register_event_cb(struct mei_cl_device *cldev,
               unsigned long event_mask,
               mei_cldev_event_cb_t read_cb, void *context);
 
#define MEI_CL_EVENT_RX 0
#define MEI_CL_EVENT_TX 1
#define MEI_CL_EVENT_NOTIF 2
 
const uuid_le *mei_cldev_uuid(const struct mei_cl_device *cldev);
u8 mei_cldev_ver(const struct mei_cl_device *cldev);
 
void *mei_cldev_get_drvdata(const struct mei_cl_device *cldev);
void mei_cldev_set_drvdata(struct mei_cl_device *cldev, void *data);
 
int mei_cldev_enable(struct mei_cl_device *cldev);
int mei_cldev_disable(struct mei_cl_device *cldev);
bool mei_cldev_enabled(struct mei_cl_device *cldev);
 
#endif /* _LINUX_MEI_CL_BUS_H */