include/linux/mei_cl_bus.h

   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
   8 struct mei_cl_device;
   9 struct mei_device;
  10
  11 typedef void (*mei_cldev_cb_t)(struct mei_cl_device *cldev);
  12
  13 /**
  14  * struct mei_cl_device - MEI device handle
  15  * An mei_cl_device pointer is returned from mei_add_device()
  16  * and links MEI bus clients to their actual ME host client pointer.
  17  * Drivers for MEI devices will get an mei_cl_device pointer
  18  * when being probed and shall use it for doing ME bus I/O.
  19  *
  20  * @bus_list: device on the bus list
  21  * @bus: parent mei device
  22  * @dev: linux driver model device pointer
  23  * @me_cl: me client
  24  * @cl: mei client
  25  * @name: device name
  26  * @rx_work: async work to execute Rx event callback
  27  * @rx_cb: Drivers register this callback to get asynchronous ME
  28  *      Rx buffer pending notifications.
  29  * @notif_work: async work to execute FW notif event callback
  30  * @notif_cb: Drivers register this callback to get asynchronous ME
  31  *      FW notification pending notifications.
  32  *
  33  * @do_match: wheather device can be matched with a driver
  34  * @is_added: device is already scanned
  35  * @priv_data: client private data
  36  */
  37 struct mei_cl_device {
  38         struct list_head bus_list;
  39         struct mei_device *bus;
  40         struct device dev;
  41
  42         struct mei_me_client *me_cl;
  43         struct mei_cl *cl;
  44         char name[MEI_CL_NAME_SIZE];
  45
  46         struct work_struct rx_work;
  47         mei_cldev_cb_t rx_cb;
  48         struct work_struct notif_work;
  49         mei_cldev_cb_t notif_cb;
  50
  51         unsigned int do_match:1;
  52         unsigned int is_added:1;
  53
  54         void *priv_data;
  55 };
  56
  57 struct mei_cl_driver {
  58         struct device_driver driver;
  59         const char *name;
  60
  61         const struct mei_cl_device_id *id_table;
  62
  63         int (*probe)(struct mei_cl_device *cldev,
  64                      const struct mei_cl_device_id *id);
  65         int (*remove)(struct mei_cl_device *cldev);
  66 };
  67
  68 int __mei_cldev_driver_register(struct mei_cl_driver *cldrv,
  69                                 struct module *owner);
  70 #define mei_cldev_driver_register(cldrv)             \
  71         __mei_cldev_driver_register(cldrv, THIS_MODULE)
  72
  73 void mei_cldev_driver_unregister(struct mei_cl_driver *cldrv);
  74
  75 /**
  76  * module_mei_cl_driver - Helper macro for registering mei cl driver
  77  *
  78  * @__mei_cldrv: mei_cl_driver structure
  79  *
  80  *  Helper macro for mei cl drivers which do not do anything special in module
  81  *  init/exit, for eliminating a boilerplate code.
  82  */
  83 #define module_mei_cl_driver(__mei_cldrv) \
  84         module_driver(__mei_cldrv, \
  85                       mei_cldev_driver_register,\
  86                       mei_cldev_driver_unregister)
  87
  88 ssize_t mei_cldev_send(struct mei_cl_device *cldev, u8 *buf, size_t length);
  89 ssize_t mei_cldev_recv(struct mei_cl_device *cldev, u8 *buf, size_t length);
  90 ssize_t mei_cldev_recv_nonblock(struct mei_cl_device *cldev, u8 *buf,
  91                                 size_t length);
  92
  93 int mei_cldev_register_rx_cb(struct mei_cl_device *cldev, mei_cldev_cb_t rx_cb);
  94 int mei_cldev_register_notif_cb(struct mei_cl_device *cldev,
  95                                 mei_cldev_cb_t notif_cb);
  96
  97 const uuid_le *mei_cldev_uuid(const struct mei_cl_device *cldev);
  98 u8 mei_cldev_ver(const struct mei_cl_device *cldev);
  99
 100 void *mei_cldev_get_drvdata(const struct mei_cl_device *cldev);
 101 void mei_cldev_set_drvdata(struct mei_cl_device *cldev, void *data);
 102
 103 int mei_cldev_enable(struct mei_cl_device *cldev);
 104 int mei_cldev_disable(struct mei_cl_device *cldev);
 105 bool mei_cldev_enabled(struct mei_cl_device *cldev);
 106
 107 #endif /* _LINUX_MEI_CL_BUS_H */