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