drivers/net/wireless/ath/ath10k/hif.h

   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
  24 struct ath10k_hif_sg_item {
  25         u16 transfer_id;
  26         void *transfer_context; /* NULL = tx completion callback not called */
  27         void *vaddr; /* for debugging mostly */
  28         u32 paddr;
  29         u16 len;
  30 };
  31
  32 struct ath10k_hif_cb {
  33         int (*tx_completion)(struct ath10k *ar,
  34                              struct sk_buff *wbuf,
  35                              unsigned transfer_id);
  36         int (*rx_completion)(struct ath10k *ar,
  37                              struct sk_buff *wbuf,
  38                              u8 pipe_id);
  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         /*
  51          * API to handle HIF-specific BMI message exchanges, this API is
  52          * synchronous and only allowed to be called from a context that
  53          * can block (sleep)
  54          */
  55         int (*exchange_bmi_msg)(struct ath10k *ar,
  56                                 void *request, u32 request_len,
  57                                 void *response, u32 *response_len);
  58
  59         /* Post BMI phase, after FW is loaded. Starts regular operation */
  60         int (*start)(struct ath10k *ar);
  61
  62         /* Clean up what start() did. This does not revert to BMI phase. If
  63          * desired so, call power_down() and power_up() */
  64         void (*stop)(struct ath10k *ar);
  65
  66         int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id,
  67                                    u8 *ul_pipe, u8 *dl_pipe,
  68                                    int *ul_is_polled, int *dl_is_polled);
  69
  70         void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe);
  71
  72         /*
  73          * Check if prior sends have completed.
  74          *
  75          * Check whether the pipe in question has any completed
  76          * sends that have not yet been processed.
  77          * This function is only relevant for HIF pipes that are configured
  78          * to be polled rather than interrupt-driven.
  79          */
  80         void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force);
  81
  82         void (*set_callbacks)(struct ath10k *ar,
  83                               struct ath10k_hif_cb *callbacks);
  84
  85         u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id);
  86
  87         /* Power up the device and enter BMI transfer mode for FW download */
  88         int (*power_up)(struct ath10k *ar);
  89
  90         /* Power down the device and free up resources. stop() must be called
  91          * before this if start() was called earlier */
  92         void (*power_down)(struct ath10k *ar);
  93
  94         int (*suspend)(struct ath10k *ar);
  95         int (*resume)(struct ath10k *ar);
  96 };
  97
  98 static inline int ath10k_hif_tx_sg(struct ath10k *ar, u8 pipe_id,
  99                                    struct ath10k_hif_sg_item *items,
 100                                    int n_items)
 101 {
 102         return ar->hif.ops->tx_sg(ar, pipe_id, items, n_items);
 103 }
 104
 105 static inline int ath10k_hif_diag_read(struct ath10k *ar, u32 address, void *buf,
 106                                        size_t buf_len)
 107 {
 108         return ar->hif.ops->diag_read(ar, address, buf, buf_len);
 109 }
 110
 111 static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar,
 112                                               void *request, u32 request_len,
 113                                               void *response, u32 *response_len)
 114 {
 115         return ar->hif.ops->exchange_bmi_msg(ar, request, request_len,
 116                                              response, response_len);
 117 }
 118
 119 static inline int ath10k_hif_start(struct ath10k *ar)
 120 {
 121         return ar->hif.ops->start(ar);
 122 }
 123
 124 static inline void ath10k_hif_stop(struct ath10k *ar)
 125 {
 126         return ar->hif.ops->stop(ar);
 127 }
 128
 129 static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar,
 130                                                  u16 service_id,
 131                                                  u8 *ul_pipe, u8 *dl_pipe,
 132                                                  int *ul_is_polled,
 133                                                  int *dl_is_polled)
 134 {
 135         return ar->hif.ops->map_service_to_pipe(ar, service_id,
 136                                                 ul_pipe, dl_pipe,
 137                                                 ul_is_polled, dl_is_polled);
 138 }
 139
 140 static inline void ath10k_hif_get_default_pipe(struct ath10k *ar,
 141                                                u8 *ul_pipe, u8 *dl_pipe)
 142 {
 143         ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe);
 144 }
 145
 146 static inline void ath10k_hif_send_complete_check(struct ath10k *ar,
 147                                                   u8 pipe_id, int force)
 148 {
 149         ar->hif.ops->send_complete_check(ar, pipe_id, force);
 150 }
 151
 152 static inline void ath10k_hif_set_callbacks(struct ath10k *ar,
 153                                             struct ath10k_hif_cb *callbacks)
 154 {
 155         ar->hif.ops->set_callbacks(ar, callbacks);
 156 }
 157
 158 static inline u16 ath10k_hif_get_free_queue_number(struct ath10k *ar,
 159                                                    u8 pipe_id)
 160 {
 161         return ar->hif.ops->get_free_queue_number(ar, pipe_id);
 162 }
 163
 164 static inline int ath10k_hif_power_up(struct ath10k *ar)
 165 {
 166         return ar->hif.ops->power_up(ar);
 167 }
 168
 169 static inline void ath10k_hif_power_down(struct ath10k *ar)
 170 {
 171         ar->hif.ops->power_down(ar);
 172 }
 173
 174 static inline int ath10k_hif_suspend(struct ath10k *ar)
 175 {
 176         if (!ar->hif.ops->suspend)
 177                 return -EOPNOTSUPP;
 178
 179         return ar->hif.ops->suspend(ar);
 180 }
 181
 182 static inline int ath10k_hif_resume(struct ath10k *ar)
 183 {
 184         if (!ar->hif.ops->resume)
 185                 return -EOPNOTSUPP;
 186
 187         return ar->hif.ops->resume(ar);
 188 }
 189
 190 #endif /* _HIF_H_ */