2 * Copyright (c) 2005-2011 Atheros Communications Inc.
3 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <linux/kernel.h>
24 struct ath10k_hif_sg_item {
26 void *transfer_context; /* NULL = tx completion callback not called */
27 void *vaddr; /* for debugging mostly */
32 struct ath10k_hif_cb {
33 int (*tx_completion)(struct ath10k *ar,
35 unsigned transfer_id);
36 int (*rx_completion)(struct ath10k *ar,
41 struct ath10k_hif_ops {
42 /* send a scatter-gather list to the target */
43 int (*tx_sg)(struct ath10k *ar, u8 pipe_id,
44 struct ath10k_hif_sg_item *items, int n_items);
47 * API to handle HIF-specific BMI message exchanges, this API is
48 * synchronous and only allowed to be called from a context that
51 int (*exchange_bmi_msg)(struct ath10k *ar,
52 void *request, u32 request_len,
53 void *response, u32 *response_len);
55 /* Post BMI phase, after FW is loaded. Starts regular operation */
56 int (*start)(struct ath10k *ar);
58 /* Clean up what start() did. This does not revert to BMI phase. If
59 * desired so, call power_down() and power_up() */
60 void (*stop)(struct ath10k *ar);
62 int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id,
63 u8 *ul_pipe, u8 *dl_pipe,
64 int *ul_is_polled, int *dl_is_polled);
66 void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe);
69 * Check if prior sends have completed.
71 * Check whether the pipe in question has any completed
72 * sends that have not yet been processed.
73 * This function is only relevant for HIF pipes that are configured
74 * to be polled rather than interrupt-driven.
76 void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force);
78 void (*set_callbacks)(struct ath10k *ar,
79 struct ath10k_hif_cb *callbacks);
81 u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id);
83 /* Power up the device and enter BMI transfer mode for FW download */
84 int (*power_up)(struct ath10k *ar);
86 /* Power down the device and free up resources. stop() must be called
87 * before this if start() was called earlier */
88 void (*power_down)(struct ath10k *ar);
90 int (*suspend)(struct ath10k *ar);
91 int (*resume)(struct ath10k *ar);
95 static inline int ath10k_hif_tx_sg(struct ath10k *ar, u8 pipe_id,
96 struct ath10k_hif_sg_item *items,
99 return ar->hif.ops->tx_sg(ar, pipe_id, items, n_items);
102 static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar,
103 void *request, u32 request_len,
104 void *response, u32 *response_len)
106 return ar->hif.ops->exchange_bmi_msg(ar, request, request_len,
107 response, response_len);
110 static inline int ath10k_hif_start(struct ath10k *ar)
112 return ar->hif.ops->start(ar);
115 static inline void ath10k_hif_stop(struct ath10k *ar)
117 return ar->hif.ops->stop(ar);
120 static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar,
122 u8 *ul_pipe, u8 *dl_pipe,
126 return ar->hif.ops->map_service_to_pipe(ar, service_id,
128 ul_is_polled, dl_is_polled);
131 static inline void ath10k_hif_get_default_pipe(struct ath10k *ar,
132 u8 *ul_pipe, u8 *dl_pipe)
134 ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe);
137 static inline void ath10k_hif_send_complete_check(struct ath10k *ar,
138 u8 pipe_id, int force)
140 ar->hif.ops->send_complete_check(ar, pipe_id, force);
143 static inline void ath10k_hif_set_callbacks(struct ath10k *ar,
144 struct ath10k_hif_cb *callbacks)
146 ar->hif.ops->set_callbacks(ar, callbacks);
149 static inline u16 ath10k_hif_get_free_queue_number(struct ath10k *ar,
152 return ar->hif.ops->get_free_queue_number(ar, pipe_id);
155 static inline int ath10k_hif_power_up(struct ath10k *ar)
157 return ar->hif.ops->power_up(ar);
160 static inline void ath10k_hif_power_down(struct ath10k *ar)
162 ar->hif.ops->power_down(ar);
165 static inline int ath10k_hif_suspend(struct ath10k *ar)
167 if (!ar->hif.ops->suspend)
170 return ar->hif.ops->suspend(ar);
173 static inline int ath10k_hif_resume(struct ath10k *ar)
175 if (!ar->hif.ops->resume)
178 return ar->hif.ops->resume(ar);