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

   1 /*
   2  * Copyright (c) 2005-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011-2015,2017 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_ops {
  34         /* send a scatter-gather list to the target */
  35         int (*tx_sg)(struct ath10k *ar, u8 pipe_id,
  36                      struct ath10k_hif_sg_item *items, int n_items);
  37
  38         /* read firmware memory through the diagnose interface */
  39         int (*diag_read)(struct ath10k *ar, u32 address, void *buf,
  40                          size_t buf_len);
  41
  42         int (*diag_write)(struct ath10k *ar, u32 address, const void *data,
  43                           int nbytes);
  44         /*
  45          * API to handle HIF-specific BMI message exchanges, this API is
  46          * synchronous and only allowed to be called from a context that
  47          * can block (sleep)
  48          */
  49         int (*exchange_bmi_msg)(struct ath10k *ar,
  50                                 void *request, u32 request_len,
  51                                 void *response, u32 *response_len);
  52
  53         /* Post BMI phase, after FW is loaded. Starts regular operation */
  54         int (*start)(struct ath10k *ar);
  55
  56         /* Clean up what start() did. This does not revert to BMI phase. If
  57          * desired so, call power_down() and power_up()
  58          */
  59         void (*stop)(struct ath10k *ar);
  60
  61         int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id,
  62                                    u8 *ul_pipe, u8 *dl_pipe);
  63
  64         void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe);
  65
  66         /*
  67          * Check if prior sends have completed.
  68          *
  69          * Check whether the pipe in question has any completed
  70          * sends that have not yet been processed.
  71          * This function is only relevant for HIF pipes that are configured
  72          * to be polled rather than interrupt-driven.
  73          */
  74         void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force);
  75
  76         u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id);
  77
  78         u32 (*read32)(struct ath10k *ar, u32 address);
  79
  80         void (*write32)(struct ath10k *ar, u32 address, u32 value);
  81
  82         /* Power up the device and enter BMI transfer mode for FW download */
  83         int (*power_up)(struct ath10k *ar);
  84
  85         /* Power down the device and free up resources. stop() must be called
  86          * before this if start() was called earlier
  87          */
  88         void (*power_down)(struct ath10k *ar);
  89
  90         int (*suspend)(struct ath10k *ar);
  91         int (*resume)(struct ath10k *ar);
  92
  93         /* fetch calibration data from target eeprom */
  94         int (*fetch_cal_eeprom)(struct ath10k *ar, void **data,
  95                                 size_t *data_len);
  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_diag_write(struct ath10k *ar, u32 address,
 112                                         const void *data, int nbytes)
 113 {
 114         if (!ar->hif.ops->diag_write)
 115                 return -EOPNOTSUPP;
 116
 117         return ar->hif.ops->diag_write(ar, address, data, nbytes);
 118 }
 119
 120 static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar,
 121                                               void *request, u32 request_len,
 122                                               void *response, u32 *response_len)
 123 {
 124         return ar->hif.ops->exchange_bmi_msg(ar, request, request_len,
 125                                              response, response_len);
 126 }
 127
 128 static inline int ath10k_hif_start(struct ath10k *ar)
 129 {
 130         return ar->hif.ops->start(ar);
 131 }
 132
 133 static inline void ath10k_hif_stop(struct ath10k *ar)
 134 {
 135         return ar->hif.ops->stop(ar);
 136 }
 137
 138 static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar,
 139                                                  u16 service_id,
 140                                                  u8 *ul_pipe, u8 *dl_pipe)
 141 {
 142         return ar->hif.ops->map_service_to_pipe(ar, service_id,
 143                                                 ul_pipe, dl_pipe);
 144 }
 145
 146 static inline void ath10k_hif_get_default_pipe(struct ath10k *ar,
 147                                                u8 *ul_pipe, u8 *dl_pipe)
 148 {
 149         ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe);
 150 }
 151
 152 static inline void ath10k_hif_send_complete_check(struct ath10k *ar,
 153                                                   u8 pipe_id, int force)
 154 {
 155         ar->hif.ops->send_complete_check(ar, pipe_id, force);
 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 static inline u32 ath10k_hif_read32(struct ath10k *ar, u32 address)
 191 {
 192         if (!ar->hif.ops->read32) {
 193                 ath10k_warn(ar, "hif read32 not supported\n");
 194                 return 0xdeaddead;
 195         }
 196
 197         return ar->hif.ops->read32(ar, address);
 198 }
 199
 200 static inline void ath10k_hif_write32(struct ath10k *ar,
 201                                       u32 address, u32 data)
 202 {
 203         if (!ar->hif.ops->write32) {
 204                 ath10k_warn(ar, "hif write32 not supported\n");
 205                 return;
 206         }
 207
 208         ar->hif.ops->write32(ar, address, data);
 209 }
 210
 211 static inline int ath10k_hif_fetch_cal_eeprom(struct ath10k *ar,
 212                                               void **data,
 213                                               size_t *data_len)
 214 {
 215         if (!ar->hif.ops->fetch_cal_eeprom)
 216                 return -EOPNOTSUPP;
 217
 218         return ar->hif.ops->fetch_cal_eeprom(ar, data, data_len);
 219 }
 220
 221 #endif /* _HIF_H_ */