1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2018-2020, The Linux Foundation. All rights reserved.
9 #include <linux/device.h>
10 #include <linux/dma-direction.h>
11 #include <linux/mutex.h>
12 #include <linux/skbuff.h>
13 #include <linux/slab.h>
14 #include <linux/spinlock.h>
15 #include <linux/wait.h>
16 #include <linux/workqueue.h>
18 #define MHI_MAX_OEM_PK_HASH_SEGMENTS 16
27 * enum mhi_callback - MHI callback
28 * @MHI_CB_IDLE: MHI entered idle state
29 * @MHI_CB_PENDING_DATA: New data available for client to process
30 * @MHI_CB_LPM_ENTER: MHI host entered low power mode
31 * @MHI_CB_LPM_EXIT: MHI host about to exit low power mode
32 * @MHI_CB_EE_RDDM: MHI device entered RDDM exec env
33 * @MHI_CB_EE_MISSION_MODE: MHI device entered Mission Mode exec env
34 * @MHI_CB_SYS_ERROR: MHI device entered error state (may recover)
35 * @MHI_CB_FATAL_ERROR: MHI device entered fatal error state
36 * @MHI_CB_BW_REQ: Received a bandwidth switch request from device
44 MHI_CB_EE_MISSION_MODE,
51 * enum mhi_flags - Transfer flags
52 * @MHI_EOB: End of buffer for bulk transfer
53 * @MHI_EOT: End of transfer
54 * @MHI_CHAIN: Linked transfer
63 * enum mhi_device_type - Device types
64 * @MHI_DEVICE_XFER: Handles data transfer
65 * @MHI_DEVICE_CONTROLLER: Control device
67 enum mhi_device_type {
69 MHI_DEVICE_CONTROLLER,
73 * enum mhi_ch_type - Channel types
74 * @MHI_CH_TYPE_INVALID: Invalid channel type
75 * @MHI_CH_TYPE_OUTBOUND: Outbound channel to the device
76 * @MHI_CH_TYPE_INBOUND: Inbound channel from the device
77 * @MHI_CH_TYPE_INBOUND_COALESCED: Coalesced channel for the device to combine
78 * multiple packets and send them as a single
79 * large packet to reduce CPU consumption
82 MHI_CH_TYPE_INVALID = 0,
83 MHI_CH_TYPE_OUTBOUND = DMA_TO_DEVICE,
84 MHI_CH_TYPE_INBOUND = DMA_FROM_DEVICE,
85 MHI_CH_TYPE_INBOUND_COALESCED = 3,
89 * struct image_info - Firmware and RDDM table
90 * @mhi_buf: Buffer for firmware and RDDM table
91 * @entries: # of entries in table
94 struct mhi_buf *mhi_buf;
95 /* private: from internal.h */
96 struct bhi_vec_entry *bhi_vec;
102 * struct mhi_link_info - BW requirement
103 * target_link_speed - Link speed as defined by TLS bits in LinkControl reg
104 * target_link_width - Link width as defined by NLW bits in LinkStatus reg
106 struct mhi_link_info {
107 unsigned int target_link_speed;
108 unsigned int target_link_width;
112 * enum mhi_ee_type - Execution environment types
113 * @MHI_EE_PBL: Primary Bootloader
114 * @MHI_EE_SBL: Secondary Bootloader
115 * @MHI_EE_AMSS: Modem, aka the primary runtime EE
116 * @MHI_EE_RDDM: Ram dump download mode
117 * @MHI_EE_WFW: WLAN firmware mode
118 * @MHI_EE_PTHRU: Passthrough
119 * @MHI_EE_EDL: Embedded downloader
120 * @MHI_EE_FP: Flash Programmer Environment
131 MHI_EE_MAX_SUPPORTED = MHI_EE_FP,
132 MHI_EE_DISABLE_TRANSITION, /* local EE, not related to mhi spec */
133 MHI_EE_NOT_SUPPORTED,
138 * enum mhi_state - MHI states
139 * @MHI_STATE_RESET: Reset state
140 * @MHI_STATE_READY: Ready state
141 * @MHI_STATE_M0: M0 state
142 * @MHI_STATE_M1: M1 state
143 * @MHI_STATE_M2: M2 state
144 * @MHI_STATE_M3: M3 state
145 * @MHI_STATE_M3_FAST: M3 Fast state
146 * @MHI_STATE_BHI: BHI state
147 * @MHI_STATE_SYS_ERR: System Error state
150 MHI_STATE_RESET = 0x0,
151 MHI_STATE_READY = 0x1,
156 MHI_STATE_M3_FAST = 0x6,
158 MHI_STATE_SYS_ERR = 0xFF,
163 * enum mhi_ch_ee_mask - Execution environment mask for channel
164 * @MHI_CH_EE_PBL: Allow channel to be used in PBL EE
165 * @MHI_CH_EE_SBL: Allow channel to be used in SBL EE
166 * @MHI_CH_EE_AMSS: Allow channel to be used in AMSS EE
167 * @MHI_CH_EE_RDDM: Allow channel to be used in RDDM EE
168 * @MHI_CH_EE_PTHRU: Allow channel to be used in PTHRU EE
169 * @MHI_CH_EE_WFW: Allow channel to be used in WFW EE
170 * @MHI_CH_EE_EDL: Allow channel to be used in EDL EE
172 enum mhi_ch_ee_mask {
173 MHI_CH_EE_PBL = BIT(MHI_EE_PBL),
174 MHI_CH_EE_SBL = BIT(MHI_EE_SBL),
175 MHI_CH_EE_AMSS = BIT(MHI_EE_AMSS),
176 MHI_CH_EE_RDDM = BIT(MHI_EE_RDDM),
177 MHI_CH_EE_PTHRU = BIT(MHI_EE_PTHRU),
178 MHI_CH_EE_WFW = BIT(MHI_EE_WFW),
179 MHI_CH_EE_EDL = BIT(MHI_EE_EDL),
183 * enum mhi_er_data_type - Event ring data types
184 * @MHI_ER_DATA: Only client data over this ring
185 * @MHI_ER_CTRL: MHI control data and client data
187 enum mhi_er_data_type {
193 * enum mhi_db_brst_mode - Doorbell mode
194 * @MHI_DB_BRST_DISABLE: Burst mode disable
195 * @MHI_DB_BRST_ENABLE: Burst mode enable
197 enum mhi_db_brst_mode {
198 MHI_DB_BRST_DISABLE = 0x2,
199 MHI_DB_BRST_ENABLE = 0x3,
203 * struct mhi_channel_config - Channel configuration structure for controller
204 * @name: The name of this channel
205 * @num: The number assigned to this channel
206 * @num_elements: The number of elements that can be queued to this channel
207 * @local_elements: The local ring length of the channel
208 * @event_ring: The event ring index that services this channel
209 * @dir: Direction that data may flow on this channel
210 * @type: Channel type
211 * @ee_mask: Execution Environment mask for this channel
212 * @pollcfg: Polling configuration for burst mode. 0 is default. milliseconds
213 for UL channels, multiple of 8 ring elements for DL channels
214 * @doorbell: Doorbell mode
215 * @lpm_notify: The channel master requires low power mode notifications
216 * @offload_channel: The client manages the channel completely
217 * @doorbell_mode_switch: Channel switches to doorbell mode on M0 transition
218 * @auto_queue: Framework will automatically queue buffers for DL traffic
219 * @wake-capable: Channel capable of waking up the system
221 struct mhi_channel_config {
227 enum dma_data_direction dir;
228 enum mhi_ch_type type;
231 enum mhi_db_brst_mode doorbell;
233 bool offload_channel;
234 bool doorbell_mode_switch;
240 * struct mhi_event_config - Event ring configuration structure for controller
241 * @num_elements: The number of elements that can be queued to this ring
242 * @irq_moderation_ms: Delay irq for additional events to be aggregated
243 * @irq: IRQ associated with this ring
244 * @channel: Dedicated channel number. U32_MAX indicates a non-dedicated ring
245 * @priority: Priority of this ring. Use 1 for now
246 * @mode: Doorbell mode
247 * @data_type: Type of data this ring will process
248 * @hardware_event: This ring is associated with hardware channels
249 * @client_managed: This ring is client managed
250 * @offload_channel: This ring is associated with an offloaded channel
252 struct mhi_event_config {
254 u32 irq_moderation_ms;
258 enum mhi_db_brst_mode mode;
259 enum mhi_er_data_type data_type;
262 bool offload_channel;
266 * struct mhi_controller_config - Root MHI controller configuration
267 * @max_channels: Maximum number of channels supported
268 * @timeout_ms: Timeout value for operations. 0 means use default
269 * @ready_timeout_ms: Timeout value for waiting device to be ready (optional)
270 * @buf_len: Size of automatically allocated buffers. 0 means use default
271 * @num_channels: Number of channels defined in @ch_cfg
272 * @ch_cfg: Array of defined channels
273 * @num_events: Number of event rings defined in @event_cfg
274 * @event_cfg: Array of defined event rings
275 * @use_bounce_buf: Use a bounce buffer pool due to limited DDR access
276 * @m2_no_db: Host is not allowed to ring DB in M2 state
278 struct mhi_controller_config {
281 u32 ready_timeout_ms;
284 const struct mhi_channel_config *ch_cfg;
286 struct mhi_event_config *event_cfg;
292 * struct mhi_controller - Master MHI controller structure
293 * @cntrl_dev: Pointer to the struct device of physical bus acting as the MHI
294 * controller (required)
295 * @mhi_dev: MHI device instance for the controller
296 * @debugfs_dentry: MHI controller debugfs directory
297 * @regs: Base address of MHI MMIO register space (required)
298 * @bhi: Points to base of MHI BHI register space
299 * @bhie: Points to base of MHI BHIe register space
300 * @wake_db: MHI WAKE doorbell register address
301 * @iova_start: IOMMU starting address for data (required)
302 * @iova_stop: IOMMU stop address for data (required)
303 * @fw_image: Firmware image name for normal booting (optional)
304 * @fw_data: Firmware image data content for normal booting, used only
305 * if fw_image is NULL and fbc_download is true (optional)
306 * @fw_sz: Firmware image data size for normal booting, used only if fw_image
307 * is NULL and fbc_download is true (optional)
308 * @edl_image: Firmware image name for emergency download mode (optional)
309 * @rddm_size: RAM dump size that host should allocate for debugging purpose
310 * @sbl_size: SBL image size downloaded through BHIe (optional)
311 * @seg_len: BHIe vector size (optional)
312 * @reg_len: Length of the MHI MMIO region (required)
313 * @fbc_image: Points to firmware image buffer
314 * @rddm_image: Points to RAM dump buffer
315 * @mhi_chan: Points to the channel configuration table
316 * @lpm_chans: List of channels that require LPM notifications
317 * @irq: base irq # to request (required)
318 * @max_chan: Maximum number of channels the controller supports
319 * @total_ev_rings: Total # of event rings allocated
320 * @hw_ev_rings: Number of hardware event rings
321 * @sw_ev_rings: Number of software event rings
322 * @nr_irqs: Number of IRQ allocated by bus master (required)
323 * @serial_number: MHI controller serial number obtained from BHI
324 * @mhi_event: MHI event ring configurations table
325 * @mhi_cmd: MHI command ring configurations table
326 * @mhi_ctxt: MHI device context, shared memory between host and device
327 * @pm_mutex: Mutex for suspend/resume operation
328 * @pm_lock: Lock for protecting MHI power management state
329 * @timeout_ms: Timeout in ms for state transitions
330 * @ready_timeout_ms: Timeout in ms for waiting device to be ready (optional)
331 * @pm_state: MHI power management state
332 * @db_access: DB access states
333 * @ee: MHI device execution environment
334 * @dev_state: MHI device state
335 * @dev_wake: Device wakeup count
336 * @pending_pkts: Pending packets for the controller
337 * @M0, M2, M3: Counters to track number of device MHI state changes
338 * @transition_list: List of MHI state transitions
339 * @transition_lock: Lock for protecting MHI state transition list
340 * @wlock: Lock for protecting device wakeup
341 * @mhi_link_info: Device bandwidth info
342 * @st_worker: State transition worker
343 * @hiprio_wq: High priority workqueue for MHI work such as state transitions
344 * @state_event: State change event
345 * @status_cb: CB function to notify power states of the device (required)
346 * @wake_get: CB function to assert device wake (optional)
347 * @wake_put: CB function to de-assert device wake (optional)
348 * @wake_toggle: CB function to assert and de-assert device wake (optional)
349 * @runtime_get: CB function to controller runtime resume (required)
350 * @runtime_put: CB function to decrement pm usage (required)
351 * @map_single: CB function to create TRE buffer
352 * @unmap_single: CB function to destroy TRE buffer
353 * @read_reg: Read a MHI register via the physical link (required)
354 * @write_reg: Write a MHI register via the physical link (required)
355 * @reset: Controller specific reset function (optional)
356 * @buffer_len: Bounce buffer length
357 * @index: Index of the MHI controller instance
358 * @bounce_buf: Use of bounce buffer
359 * @fbc_download: MHI host needs to do complete image transfer (optional)
360 * @wake_set: Device wakeup set flag
361 * @irq_flags: irq flags passed to request_irq (optional)
362 * @mru: the default MRU for the MHI device
364 * Fields marked as (required) need to be populated by the controller driver
365 * before calling mhi_register_controller(). For the fields marked as (optional)
366 * they can be populated depending on the usecase.
368 struct mhi_controller {
369 struct device *cntrl_dev;
370 struct mhi_device *mhi_dev;
371 struct dentry *debugfs_dentry;
375 void __iomem *wake_db;
377 dma_addr_t iova_start;
378 dma_addr_t iova_stop;
379 const char *fw_image;
382 const char *edl_image;
387 struct image_info *fbc_image;
388 struct image_info *rddm_image;
389 struct mhi_chan *mhi_chan;
390 struct list_head lpm_chans;
399 struct mhi_event *mhi_event;
400 struct mhi_cmd *mhi_cmd;
401 struct mhi_ctxt *mhi_ctxt;
403 struct mutex pm_mutex;
406 u32 ready_timeout_ms;
410 enum mhi_state dev_state;
412 atomic_t pending_pkts;
414 struct list_head transition_list;
415 spinlock_t transition_lock;
417 struct mhi_link_info mhi_link_info;
418 struct work_struct st_worker;
419 struct workqueue_struct *hiprio_wq;
420 wait_queue_head_t state_event;
422 void (*status_cb)(struct mhi_controller *mhi_cntrl,
423 enum mhi_callback cb);
424 void (*wake_get)(struct mhi_controller *mhi_cntrl, bool override);
425 void (*wake_put)(struct mhi_controller *mhi_cntrl, bool override);
426 void (*wake_toggle)(struct mhi_controller *mhi_cntrl);
427 int (*runtime_get)(struct mhi_controller *mhi_cntrl);
428 void (*runtime_put)(struct mhi_controller *mhi_cntrl);
429 int (*map_single)(struct mhi_controller *mhi_cntrl,
430 struct mhi_buf_info *buf);
431 void (*unmap_single)(struct mhi_controller *mhi_cntrl,
432 struct mhi_buf_info *buf);
433 int (*read_reg)(struct mhi_controller *mhi_cntrl, void __iomem *addr,
435 void (*write_reg)(struct mhi_controller *mhi_cntrl, void __iomem *addr,
437 void (*reset)(struct mhi_controller *mhi_cntrl);
444 unsigned long irq_flags;
449 * struct mhi_device - Structure representing an MHI device which binds
450 * to channels or is associated with controllers
451 * @id: Pointer to MHI device ID struct
452 * @name: Name of the associated MHI device
453 * @mhi_cntrl: Controller the device belongs to
454 * @ul_chan: UL channel for the device
455 * @dl_chan: DL channel for the device
456 * @dev: Driver model device node for the MHI device
457 * @dev_type: MHI device type
458 * @ul_chan_id: MHI channel id for UL transfer
459 * @dl_chan_id: MHI channel id for DL transfer
460 * @dev_wake: Device wakeup counter
463 const struct mhi_device_id *id;
465 struct mhi_controller *mhi_cntrl;
466 struct mhi_chan *ul_chan;
467 struct mhi_chan *dl_chan;
469 enum mhi_device_type dev_type;
476 * struct mhi_result - Completed buffer information
477 * @buf_addr: Address of data buffer
478 * @bytes_xferd: # of bytes transferred
479 * @dir: Channel direction
480 * @transaction_status: Status of last transaction
485 enum dma_data_direction dir;
486 int transaction_status;
490 * struct mhi_buf - MHI Buffer description
491 * @buf: Virtual address of the buffer
492 * @name: Buffer label. For offload channel, configurations name must be:
493 * ECA - Event context array data
494 * CCA - Channel context array data
495 * @dma_addr: IOMMU address of the buffer
506 * struct mhi_driver - Structure representing a MHI client driver
507 * @probe: CB function for client driver probe function
508 * @remove: CB function for client driver remove function
509 * @ul_xfer_cb: CB function for UL data transfer
510 * @dl_xfer_cb: CB function for DL data transfer
511 * @status_cb: CB functions for asynchronous status
512 * @driver: Device driver model driver
515 const struct mhi_device_id *id_table;
516 int (*probe)(struct mhi_device *mhi_dev,
517 const struct mhi_device_id *id);
518 void (*remove)(struct mhi_device *mhi_dev);
519 void (*ul_xfer_cb)(struct mhi_device *mhi_dev,
520 struct mhi_result *result);
521 void (*dl_xfer_cb)(struct mhi_device *mhi_dev,
522 struct mhi_result *result);
523 void (*status_cb)(struct mhi_device *mhi_dev, enum mhi_callback mhi_cb);
524 struct device_driver driver;
527 #define to_mhi_driver(drv) container_of(drv, struct mhi_driver, driver)
528 #define to_mhi_device(dev) container_of(dev, struct mhi_device, dev)
531 * mhi_alloc_controller - Allocate the MHI Controller structure
532 * Allocate the mhi_controller structure using zero initialized memory
534 struct mhi_controller *mhi_alloc_controller(void);
537 * mhi_free_controller - Free the MHI Controller structure
538 * Free the mhi_controller structure which was previously allocated
540 void mhi_free_controller(struct mhi_controller *mhi_cntrl);
543 * mhi_register_controller - Register MHI controller
544 * @mhi_cntrl: MHI controller to register
545 * @config: Configuration to use for the controller
547 int mhi_register_controller(struct mhi_controller *mhi_cntrl,
548 const struct mhi_controller_config *config);
551 * mhi_unregister_controller - Unregister MHI controller
552 * @mhi_cntrl: MHI controller to unregister
554 void mhi_unregister_controller(struct mhi_controller *mhi_cntrl);
557 * module_mhi_driver() - Helper macro for drivers that don't do
558 * anything special other than using default mhi_driver_register() and
559 * mhi_driver_unregister(). This eliminates a lot of boilerplate.
560 * Each module may only use this macro once.
562 #define module_mhi_driver(mhi_drv) \
563 module_driver(mhi_drv, mhi_driver_register, \
564 mhi_driver_unregister)
567 * Macro to avoid include chaining to get THIS_MODULE
569 #define mhi_driver_register(mhi_drv) \
570 __mhi_driver_register(mhi_drv, THIS_MODULE)
573 * __mhi_driver_register - Register driver with MHI framework
574 * @mhi_drv: Driver associated with the device
575 * @owner: The module owner
577 int __mhi_driver_register(struct mhi_driver *mhi_drv, struct module *owner);
580 * mhi_driver_unregister - Unregister a driver for mhi_devices
581 * @mhi_drv: Driver associated with the device
583 void mhi_driver_unregister(struct mhi_driver *mhi_drv);
586 * mhi_set_mhi_state - Set MHI device state
587 * @mhi_cntrl: MHI controller
588 * @state: State to set
590 void mhi_set_mhi_state(struct mhi_controller *mhi_cntrl,
591 enum mhi_state state);
594 * mhi_notify - Notify the MHI client driver about client device status
595 * @mhi_dev: MHI device instance
596 * @cb_reason: MHI callback reason
598 void mhi_notify(struct mhi_device *mhi_dev, enum mhi_callback cb_reason);
601 * mhi_get_free_desc_count - Get transfer ring length
602 * Get # of TD available to queue buffers
603 * @mhi_dev: Device associated with the channels
604 * @dir: Direction of the channel
606 int mhi_get_free_desc_count(struct mhi_device *mhi_dev,
607 enum dma_data_direction dir);
610 * mhi_prepare_for_power_up - Do pre-initialization before power up.
611 * This is optional, call this before power up if
612 * the controller does not want bus framework to
613 * automatically free any allocated memory during
615 * @mhi_cntrl: MHI controller
617 int mhi_prepare_for_power_up(struct mhi_controller *mhi_cntrl);
620 * mhi_async_power_up - Start MHI power up sequence
621 * @mhi_cntrl: MHI controller
623 int mhi_async_power_up(struct mhi_controller *mhi_cntrl);
626 * mhi_sync_power_up - Start MHI power up sequence and wait till the device
627 * enters valid EE state
628 * @mhi_cntrl: MHI controller
630 int mhi_sync_power_up(struct mhi_controller *mhi_cntrl);
633 * mhi_power_down - Power down the MHI device and also destroy the
634 * 'struct device' for the channels associated with it.
635 * See also mhi_power_down_keep_dev() which is a variant
636 * of this API that keeps the 'struct device' for channels
637 * (useful during suspend/hibernation).
638 * @mhi_cntrl: MHI controller
639 * @graceful: Link is still accessible, so do a graceful shutdown process
641 void mhi_power_down(struct mhi_controller *mhi_cntrl, bool graceful);
644 * mhi_power_down_keep_dev - Power down the MHI device but keep the 'struct
645 * device' for the channels associated with it.
646 * This is a variant of 'mhi_power_down()' and
647 * useful in scenarios such as suspend/hibernation
648 * where destroying of the 'struct device' is not
650 * @mhi_cntrl: MHI controller
651 * @graceful: Link is still accessible, so do a graceful shutdown process
653 void mhi_power_down_keep_dev(struct mhi_controller *mhi_cntrl, bool graceful);
656 * mhi_unprepare_after_power_down - Free any allocated memory after power down
657 * @mhi_cntrl: MHI controller
659 void mhi_unprepare_after_power_down(struct mhi_controller *mhi_cntrl);
662 * mhi_pm_suspend - Move MHI into a suspended state
663 * @mhi_cntrl: MHI controller
665 int mhi_pm_suspend(struct mhi_controller *mhi_cntrl);
668 * mhi_pm_resume - Resume MHI from suspended state
669 * @mhi_cntrl: MHI controller
671 int mhi_pm_resume(struct mhi_controller *mhi_cntrl);
674 * mhi_pm_resume_force - Force resume MHI from suspended state
675 * @mhi_cntrl: MHI controller
677 * Resume the device irrespective of its MHI state. As per the MHI spec, devices
678 * has to be in M3 state during resume. But some devices seem to be in a
679 * different MHI state other than M3 but they continue working fine if allowed.
680 * This API is intented to be used for such devices.
682 * Return: 0 if the resume succeeds, a negative error code otherwise
684 int mhi_pm_resume_force(struct mhi_controller *mhi_cntrl);
687 * mhi_download_rddm_image - Download ramdump image from device for
689 * @mhi_cntrl: MHI controller
690 * @in_panic: Download rddm image during kernel panic
692 int mhi_download_rddm_image(struct mhi_controller *mhi_cntrl, bool in_panic);
695 * mhi_force_rddm_mode - Force device into rddm mode
696 * @mhi_cntrl: MHI controller
698 int mhi_force_rddm_mode(struct mhi_controller *mhi_cntrl);
701 * mhi_get_exec_env - Get BHI execution environment of the device
702 * @mhi_cntrl: MHI controller
704 enum mhi_ee_type mhi_get_exec_env(struct mhi_controller *mhi_cntrl);
707 * mhi_get_mhi_state - Get MHI state of the device
708 * @mhi_cntrl: MHI controller
710 enum mhi_state mhi_get_mhi_state(struct mhi_controller *mhi_cntrl);
713 * mhi_soc_reset - Trigger a device reset. This can be used as a last resort
714 * to reset and recover a device.
715 * @mhi_cntrl: MHI controller
717 void mhi_soc_reset(struct mhi_controller *mhi_cntrl);
720 * mhi_device_get - Disable device low power mode
721 * @mhi_dev: Device associated with the channel
723 void mhi_device_get(struct mhi_device *mhi_dev);
726 * mhi_device_get_sync - Disable device low power mode. Synchronously
727 * take the controller out of suspended state
728 * @mhi_dev: Device associated with the channel
730 int mhi_device_get_sync(struct mhi_device *mhi_dev);
733 * mhi_device_put - Re-enable device low power mode
734 * @mhi_dev: Device associated with the channel
736 void mhi_device_put(struct mhi_device *mhi_dev);
739 * mhi_prepare_for_transfer - Setup UL and DL channels for data transfer.
740 * @mhi_dev: Device associated with the channels
742 * Allocate and initialize the channel context and also issue the START channel
743 * command to both channels. Channels can be started only if both host and
744 * device execution environments match and channels are in a DISABLED state.
746 int mhi_prepare_for_transfer(struct mhi_device *mhi_dev);
749 * mhi_prepare_for_transfer_autoqueue - Setup UL and DL channels with auto queue
750 * buffers for DL traffic
751 * @mhi_dev: Device associated with the channels
753 * Allocate and initialize the channel context and also issue the START channel
754 * command to both channels. Channels can be started only if both host and
755 * device execution environments match and channels are in a DISABLED state.
756 * The MHI core will automatically allocate and queue buffers for the DL traffic.
758 int mhi_prepare_for_transfer_autoqueue(struct mhi_device *mhi_dev);
761 * mhi_unprepare_from_transfer - Reset UL and DL channels for data transfer.
762 * Issue the RESET channel command and let the
763 * device clean-up the context so no incoming
764 * transfers are seen on the host. Free memory
765 * associated with the context on host. If device
766 * is unresponsive, only perform a host side
767 * clean-up. Channels can be reset only if both
768 * host and device execution environments match
769 * and channels are in an ENABLED, STOPPED or
771 * @mhi_dev: Device associated with the channels
773 void mhi_unprepare_from_transfer(struct mhi_device *mhi_dev);
776 * mhi_queue_dma - Send or receive DMA mapped buffers from client device
778 * @mhi_dev: Device associated with the channels
779 * @dir: DMA direction for the channel
780 * @mhi_buf: Buffer for holding the DMA mapped data
781 * @len: Buffer length
782 * @mflags: MHI transfer flags used for the transfer
784 int mhi_queue_dma(struct mhi_device *mhi_dev, enum dma_data_direction dir,
785 struct mhi_buf *mhi_buf, size_t len, enum mhi_flags mflags);
788 * mhi_queue_buf - Send or receive raw buffers from client device over MHI
790 * @mhi_dev: Device associated with the channels
791 * @dir: DMA direction for the channel
792 * @buf: Buffer for holding the data
793 * @len: Buffer length
794 * @mflags: MHI transfer flags used for the transfer
796 int mhi_queue_buf(struct mhi_device *mhi_dev, enum dma_data_direction dir,
797 void *buf, size_t len, enum mhi_flags mflags);
800 * mhi_queue_skb - Send or receive SKBs from client device over MHI channel
801 * @mhi_dev: Device associated with the channels
802 * @dir: DMA direction for the channel
803 * @skb: Buffer for holding SKBs
804 * @len: Buffer length
805 * @mflags: MHI transfer flags used for the transfer
807 int mhi_queue_skb(struct mhi_device *mhi_dev, enum dma_data_direction dir,
808 struct sk_buff *skb, size_t len, enum mhi_flags mflags);
811 * mhi_queue_is_full - Determine whether queueing new elements is possible
812 * @mhi_dev: Device associated with the channels
813 * @dir: DMA direction for the channel
815 bool mhi_queue_is_full(struct mhi_device *mhi_dev, enum dma_data_direction dir);