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_cb {
25 int (*tx_completion)(struct ath10k *ar,
27 unsigned transfer_id);
28 int (*rx_completion)(struct ath10k *ar,
33 struct ath10k_hif_ops {
34 /* Send the head of a buffer to HIF for transmission to the target. */
35 int (*send_head)(struct ath10k *ar, u8 pipe_id,
36 unsigned int transfer_id,
41 * API to handle HIF-specific BMI message exchanges, this API is
42 * synchronous and only allowed to be called from a context that
45 int (*exchange_bmi_msg)(struct ath10k *ar,
46 void *request, u32 request_len,
47 void *response, u32 *response_len);
49 /* Post BMI phase, after FW is loaded. Starts regular operation */
50 int (*start)(struct ath10k *ar);
52 /* Clean up what start() did. This does not revert to BMI phase. If
53 * desired so, call power_down() and power_up() */
54 void (*stop)(struct ath10k *ar);
56 int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id,
57 u8 *ul_pipe, u8 *dl_pipe,
58 int *ul_is_polled, int *dl_is_polled);
60 void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe);
63 * Check if prior sends have completed.
65 * Check whether the pipe in question has any completed
66 * sends that have not yet been processed.
67 * This function is only relevant for HIF pipes that are configured
68 * to be polled rather than interrupt-driven.
70 void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force);
72 void (*set_callbacks)(struct ath10k *ar,
73 struct ath10k_hif_cb *callbacks);
75 u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id);
77 /* Power up the device and enter BMI transfer mode for FW download */
78 int (*power_up)(struct ath10k *ar);
80 /* Power down the device and free up resources. stop() must be called
81 * before this if start() was called earlier */
82 void (*power_down)(struct ath10k *ar);
84 int (*suspend)(struct ath10k *ar);
85 int (*resume)(struct ath10k *ar);
89 static inline int ath10k_hif_send_head(struct ath10k *ar, u8 pipe_id,
90 unsigned int transfer_id,
94 return ar->hif.ops->send_head(ar, pipe_id, transfer_id, nbytes, buf);
97 static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar,
98 void *request, u32 request_len,
99 void *response, u32 *response_len)
101 return ar->hif.ops->exchange_bmi_msg(ar, request, request_len,
102 response, response_len);
105 static inline int ath10k_hif_start(struct ath10k *ar)
107 return ar->hif.ops->start(ar);
110 static inline void ath10k_hif_stop(struct ath10k *ar)
112 return ar->hif.ops->stop(ar);
115 static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar,
117 u8 *ul_pipe, u8 *dl_pipe,
121 return ar->hif.ops->map_service_to_pipe(ar, service_id,
123 ul_is_polled, dl_is_polled);
126 static inline void ath10k_hif_get_default_pipe(struct ath10k *ar,
127 u8 *ul_pipe, u8 *dl_pipe)
129 ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe);
132 static inline void ath10k_hif_send_complete_check(struct ath10k *ar,
133 u8 pipe_id, int force)
135 ar->hif.ops->send_complete_check(ar, pipe_id, force);
138 static inline void ath10k_hif_set_callbacks(struct ath10k *ar,
139 struct ath10k_hif_cb *callbacks)
141 ar->hif.ops->set_callbacks(ar, callbacks);
144 static inline u16 ath10k_hif_get_free_queue_number(struct ath10k *ar,
147 return ar->hif.ops->get_free_queue_number(ar, pipe_id);
150 static inline int ath10k_hif_power_up(struct ath10k *ar)
152 return ar->hif.ops->power_up(ar);
155 static inline void ath10k_hif_power_down(struct ath10k *ar)
157 ar->hif.ops->power_down(ar);
160 static inline int ath10k_hif_suspend(struct ath10k *ar)
162 if (!ar->hif.ops->suspend)
165 return ar->hif.ops->suspend(ar);
168 static inline int ath10k_hif_resume(struct ath10k *ar)
170 if (!ar->hif.ops->resume)
173 return ar->hif.ops->resume(ar);