1 /* 2 * Copyright (c) 2005-2011 Atheros Communications Inc. 3 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc. 4 * 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. 8 * 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. 16 */ 17 18 #ifndef _HIF_H_ 19 #define _HIF_H_ 20 21 #include <linux/kernel.h> 22 #include "core.h" 23 #include "debug.h" 24 25 struct ath10k_hif_sg_item { 26 u16 transfer_id; 27 void *transfer_context; /* NULL = tx completion callback not called */ 28 void *vaddr; /* for debugging mostly */ 29 u32 paddr; 30 u16 len; 31 }; 32 33 struct ath10k_hif_cb { 34 int (*tx_completion)(struct ath10k *ar, 35 struct sk_buff *wbuf, 36 unsigned transfer_id); 37 int (*rx_completion)(struct ath10k *ar, 38 struct sk_buff *wbuf); 39 }; 40 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); 45 46 /* read firmware memory through the diagnose interface */ 47 int (*diag_read)(struct ath10k *ar, u32 address, void *buf, 48 size_t buf_len); 49 50 int (*diag_write)(struct ath10k *ar, u32 address, const void *data, 51 int nbytes); 52 /* 53 * API to handle HIF-specific BMI message exchanges, this API is 54 * synchronous and only allowed to be called from a context that 55 * can block (sleep) 56 */ 57 int (*exchange_bmi_msg)(struct ath10k *ar, 58 void *request, u32 request_len, 59 void *response, u32 *response_len); 60 61 /* Post BMI phase, after FW is loaded. Starts regular operation */ 62 int (*start)(struct ath10k *ar); 63 64 /* Clean up what start() did. This does not revert to BMI phase. If 65 * desired so, call power_down() and power_up() */ 66 void (*stop)(struct ath10k *ar); 67 68 int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id, 69 u8 *ul_pipe, u8 *dl_pipe, 70 int *ul_is_polled, int *dl_is_polled); 71 72 void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe); 73 74 /* 75 * Check if prior sends have completed. 76 * 77 * Check whether the pipe in question has any completed 78 * sends that have not yet been processed. 79 * This function is only relevant for HIF pipes that are configured 80 * to be polled rather than interrupt-driven. 81 */ 82 void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force); 83 84 void (*set_callbacks)(struct ath10k *ar, 85 struct ath10k_hif_cb *callbacks); 86 87 u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id); 88 89 u32 (*read32)(struct ath10k *ar, u32 address); 90 91 void (*write32)(struct ath10k *ar, u32 address, u32 value); 92 93 /* Power up the device and enter BMI transfer mode for FW download */ 94 int (*power_up)(struct ath10k *ar); 95 96 /* Power down the device and free up resources. stop() must be called 97 * before this if start() was called earlier */ 98 void (*power_down)(struct ath10k *ar); 99 100 int (*suspend)(struct ath10k *ar); 101 int (*resume)(struct ath10k *ar); 102 }; 103 104 static inline int ath10k_hif_tx_sg(struct ath10k *ar, u8 pipe_id, 105 struct ath10k_hif_sg_item *items, 106 int n_items) 107 { 108 return ar->hif.ops->tx_sg(ar, pipe_id, items, n_items); 109 } 110 111 static inline int ath10k_hif_diag_read(struct ath10k *ar, u32 address, void *buf, 112 size_t buf_len) 113 { 114 return ar->hif.ops->diag_read(ar, address, buf, buf_len); 115 } 116 117 static inline int ath10k_hif_diag_write(struct ath10k *ar, u32 address, 118 const void *data, int nbytes) 119 { 120 if (!ar->hif.ops->diag_write) 121 return -EOPNOTSUPP; 122 123 return ar->hif.ops->diag_write(ar, address, data, nbytes); 124 } 125 126 static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar, 127 void *request, u32 request_len, 128 void *response, u32 *response_len) 129 { 130 return ar->hif.ops->exchange_bmi_msg(ar, request, request_len, 131 response, response_len); 132 } 133 134 static inline int ath10k_hif_start(struct ath10k *ar) 135 { 136 return ar->hif.ops->start(ar); 137 } 138 139 static inline void ath10k_hif_stop(struct ath10k *ar) 140 { 141 return ar->hif.ops->stop(ar); 142 } 143 144 static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar, 145 u16 service_id, 146 u8 *ul_pipe, u8 *dl_pipe, 147 int *ul_is_polled, 148 int *dl_is_polled) 149 { 150 return ar->hif.ops->map_service_to_pipe(ar, service_id, 151 ul_pipe, dl_pipe, 152 ul_is_polled, dl_is_polled); 153 } 154 155 static inline void ath10k_hif_get_default_pipe(struct ath10k *ar, 156 u8 *ul_pipe, u8 *dl_pipe) 157 { 158 ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe); 159 } 160 161 static inline void ath10k_hif_send_complete_check(struct ath10k *ar, 162 u8 pipe_id, int force) 163 { 164 ar->hif.ops->send_complete_check(ar, pipe_id, force); 165 } 166 167 static inline void ath10k_hif_set_callbacks(struct ath10k *ar, 168 struct ath10k_hif_cb *callbacks) 169 { 170 ar->hif.ops->set_callbacks(ar, callbacks); 171 } 172 173 static inline u16 ath10k_hif_get_free_queue_number(struct ath10k *ar, 174 u8 pipe_id) 175 { 176 return ar->hif.ops->get_free_queue_number(ar, pipe_id); 177 } 178 179 static inline int ath10k_hif_power_up(struct ath10k *ar) 180 { 181 return ar->hif.ops->power_up(ar); 182 } 183 184 static inline void ath10k_hif_power_down(struct ath10k *ar) 185 { 186 ar->hif.ops->power_down(ar); 187 } 188 189 static inline int ath10k_hif_suspend(struct ath10k *ar) 190 { 191 if (!ar->hif.ops->suspend) 192 return -EOPNOTSUPP; 193 194 return ar->hif.ops->suspend(ar); 195 } 196 197 static inline int ath10k_hif_resume(struct ath10k *ar) 198 { 199 if (!ar->hif.ops->resume) 200 return -EOPNOTSUPP; 201 202 return ar->hif.ops->resume(ar); 203 } 204 205 static inline u32 ath10k_hif_read32(struct ath10k *ar, u32 address) 206 { 207 if (!ar->hif.ops->read32) { 208 ath10k_warn(ar, "hif read32 not supported\n"); 209 return 0xdeaddead; 210 } 211 212 return ar->hif.ops->read32(ar, address); 213 } 214 215 static inline void ath10k_hif_write32(struct ath10k *ar, 216 u32 address, u32 data) 217 { 218 if (!ar->hif.ops->write32) { 219 ath10k_warn(ar, "hif write32 not supported\n"); 220 return; 221 } 222 223 ar->hif.ops->write32(ar, address, data); 224 } 225 226 #endif /* _HIF_H_ */ 227