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