/* * ISHTP bus definitions * * Copyright (c) 2014-2016, Intel Corporation. * * This program is free software; you can redistribute it and/or modify it * under the terms and conditions of the GNU General Public License, * version 2, as published by the Free Software Foundation. * * This program is distributed in the hope it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. */ #ifndef _LINUX_ISHTP_CL_BUS_H #define _LINUX_ISHTP_CL_BUS_H #include #include struct ishtp_cl; struct ishtp_cl_device; struct ishtp_device; struct ishtp_msg_hdr; /** * struct ishtp_cl_device - ISHTP device handle * @dev: device pointer * @ishtp_dev: pointer to ishtp device structure to primarily to access * hw device operation callbacks and properties * @fw_client: fw_client pointer to get fw information like protocol name * max message length etc. * @device_link: Link to next client in the list on a bus * @event_work: Used to schedule rx event for client * @driver_data: Storage driver private data * @reference_count: Used for get/put device * @event_cb: Callback to driver to send events * * An ishtp_cl_device pointer is returned from ishtp_add_device() * and links ISHTP bus clients to their actual host client pointer. * Drivers for ISHTP devices will get an ishtp_cl_device pointer * when being probed and shall use it for doing bus I/O. */ struct ishtp_cl_device { struct device dev; struct ishtp_device *ishtp_dev; struct ishtp_fw_client *fw_client; struct list_head device_link; struct work_struct event_work; void *driver_data; int reference_count; void (*event_cb)(struct ishtp_cl_device *device); }; /** * struct ishtp_cl_device - ISHTP device handle * @driver: driver instance on a bus * @name: Name of the device for probe * @probe: driver callback for device probe * @remove: driver callback on device removal * * Client drivers defines to get probed/removed for ISHTP client device. */ struct ishtp_cl_driver { struct device_driver driver; const char *name; int (*probe)(struct ishtp_cl_device *dev); int (*remove)(struct ishtp_cl_device *dev); int (*reset)(struct ishtp_cl_device *dev); const struct dev_pm_ops *pm; }; int ishtp_bus_new_client(struct ishtp_device *dev); void ishtp_remove_all_clients(struct ishtp_device *dev); int ishtp_cl_device_bind(struct ishtp_cl *cl); void ishtp_cl_bus_rx_event(struct ishtp_cl_device *device); /* Write a multi-fragment message */ int ishtp_send_msg(struct ishtp_device *dev, struct ishtp_msg_hdr *hdr, void *msg, void (*ipc_send_compl)(void *), void *ipc_send_compl_prm); /* Write a single-fragment message */ int ishtp_write_message(struct ishtp_device *dev, struct ishtp_msg_hdr *hdr, void *buf); /* Use DMA to send/receive messages */ int ishtp_use_dma_transfer(void); /* Exported functions */ void ishtp_bus_remove_all_clients(struct ishtp_device *ishtp_dev, bool warm_reset); void ishtp_recv(struct ishtp_device *dev); void ishtp_reset_handler(struct ishtp_device *dev); void ishtp_reset_compl_handler(struct ishtp_device *dev); void ishtp_put_device(struct ishtp_cl_device *); void ishtp_get_device(struct ishtp_cl_device *); void ishtp_set_drvdata(struct ishtp_cl_device *cl_device, void *data); void *ishtp_get_drvdata(struct ishtp_cl_device *cl_device); int __ishtp_cl_driver_register(struct ishtp_cl_driver *driver, struct module *owner); #define ishtp_cl_driver_register(driver) \ __ishtp_cl_driver_register(driver, THIS_MODULE) void ishtp_cl_driver_unregister(struct ishtp_cl_driver *driver); int ishtp_register_event_cb(struct ishtp_cl_device *device, void (*read_cb)(struct ishtp_cl_device *)); int ishtp_fw_cl_by_uuid(struct ishtp_device *dev, const guid_t *cuuid); struct ishtp_fw_client *ishtp_fw_cl_get_client(struct ishtp_device *dev, const guid_t *uuid); #endif /* _LINUX_ISHTP_CL_BUS_H */