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