include/linux/mhi_ep.h

1 /* SPDX-License-Identifier: GPL-2.0 */
9 #include <linux/dma-direction.h>
15  * struct mhi_ep_channel_config - Channel configuration structure for controller
19  * @dir: Direction that data may flow on this channel
29  * struct mhi_ep_cntrl_config - MHI Endpoint controller configuration
30  * @mhi_version: MHI spec version supported by the controller
43  * struct mhi_ep_db_info - MHI Endpoint doorbell info
53  * struct mhi_ep_buf_info - MHI Endpoint transfer buffer info
59  * @cb: Callback to be executed by controller drivers after transfer completion (async)
74  * struct mhi_ep_cntrl - MHI Endpoint controller structure
76  *             Endpoint controller
77  * @mhi_dev: MHI Endpoint device instance for the controller
83  * @ch_ctx_cache: Cache of host channel context data structure
84  * @ev_ctx_cache: Cache of host event context data structure
85  * @cmd_ctx_cache: Cache of host command context data structure
86  * @ch_ctx_host_pa: Physical address of host channel context data structure
87  * @ev_ctx_host_pa: Physical address of host event context data structure
88  * @cmd_ctx_host_pa: Physical address of host command context data structure
111  * @max_chan: Maximum channels supported by the endpoint controller
112  * @mru: MRU (Maximum Receive Unit) value of the endpoint controller
113  * @event_rings: Number of event rings supported by the endpoint controller
114  * @hw_event_rings: Number of hardware event rings supported by the endpoint controller
117  * @index: MHI Endpoint controller index
118  * @irq: IRQ used by the endpoint controller
119  * @enabled: Check if the endpoint controller is enabled or not
182  * struct mhi_ep_device - Structure representing an MHI Endpoint device that binds
185  * @mhi_cntrl: Controller the device belongs to
203  * struct mhi_ep_driver - Structure representing a MHI Endpoint client driver
208  * @ul_xfer_cb: CB function for UL (from host to endpoint) data transfer
209  * @dl_xfer_cb: CB function for DL (from endpoint to host) data transfer
227  * module_mhi_ep_driver() - Helper macro for drivers that don't do
243  * __mhi_ep_driver_register - Register a driver with MHI Endpoint bus
252  * mhi_ep_driver_unregister - Unregister a driver from MHI Endpoint bus
258  * mhi_ep_register_controller - Register MHI Endpoint controller
259  * @mhi_cntrl: MHI Endpoint controller to register
260  * @config: Configuration to use for the controller
262  * Return: 0 if controller registrations succeeds, a negative error code otherwise.
268  * mhi_ep_unregister_controller - Unregister MHI Endpoint controller
269  * @mhi_cntrl: MHI Endpoint controller to unregister
274  * mhi_ep_power_up - Power up the MHI endpoint stack
275  * @mhi_cntrl: MHI Endpoint controller
282  * mhi_ep_power_down - Power down the MHI endpoint stack
283  * @mhi_cntrl: MHI controller
288  * mhi_ep_queue_is_empty - Determine whether the transfer queue is empty
297  * mhi_ep_queue_skb - Send SKBs to host over MHI Endpoint