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_cb {
  25         int (*tx_completion)(struct ath10k *ar,
  26                              struct sk_buff *wbuf,
  27                              unsigned transfer_id);
  28         int (*rx_completion)(struct ath10k *ar,
  29                              struct sk_buff *wbuf,
  30                              u8 pipe_id);
  31 };
  32
  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,
  37                          unsigned int nbytes,
  38                          struct sk_buff *buf);
  39
  40         /*
  41          * API to handle HIF-specific BMI message exchanges, this API is
  42          * synchronous and only allowed to be called from a context that
  43          * can block (sleep)
  44          */
  45         int (*exchange_bmi_msg)(struct ath10k *ar,
  46                                 void *request, u32 request_len,
  47                                 void *response, u32 *response_len);
  48
  49         int (*start)(struct ath10k *ar);
  50
  51         void (*stop)(struct ath10k *ar);
  52
  53         int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id,
  54                                    u8 *ul_pipe, u8 *dl_pipe,
  55                                    int *ul_is_polled, int *dl_is_polled);
  56
  57         void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe);
  58
  59         /*
  60          * Check if prior sends have completed.
  61          *
  62          * Check whether the pipe in question has any completed
  63          * sends that have not yet been processed.
  64          * This function is only relevant for HIF pipes that are configured
  65          * to be polled rather than interrupt-driven.
  66          */
  67         void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force);
  68
  69         void (*init)(struct ath10k *ar,
  70                      struct ath10k_hif_cb *callbacks);
  71
  72         u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id);
  73 };
  74
  75
  76 static inline int ath10k_hif_send_head(struct ath10k *ar, u8 pipe_id,
  77                                        unsigned int transfer_id,
  78                                        unsigned int nbytes,
  79                                        struct sk_buff *buf)
  80 {
  81         return ar->hif.ops->send_head(ar, pipe_id, transfer_id, nbytes, buf);
  82 }
  83
  84 static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar,
  85                                               void *request, u32 request_len,
  86                                               void *response, u32 *response_len)
  87 {
  88         return ar->hif.ops->exchange_bmi_msg(ar, request, request_len,
  89                                              response, response_len);
  90 }
  91
  92 static inline int ath10k_hif_start(struct ath10k *ar)
  93 {
  94         return ar->hif.ops->start(ar);
  95 }
  96
  97 static inline void ath10k_hif_stop(struct ath10k *ar)
  98 {
  99         return ar->hif.ops->stop(ar);
 100 }
 101
 102 static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar,
 103                                                  u16 service_id,
 104                                                  u8 *ul_pipe, u8 *dl_pipe,
 105                                                  int *ul_is_polled,
 106                                                  int *dl_is_polled)
 107 {
 108         return ar->hif.ops->map_service_to_pipe(ar, service_id,
 109                                                 ul_pipe, dl_pipe,
 110                                                 ul_is_polled, dl_is_polled);
 111 }
 112
 113 static inline void ath10k_hif_get_default_pipe(struct ath10k *ar,
 114                                                u8 *ul_pipe, u8 *dl_pipe)
 115 {
 116         ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe);
 117 }
 118
 119 static inline void ath10k_hif_send_complete_check(struct ath10k *ar,
 120                                                   u8 pipe_id, int force)
 121 {
 122         ar->hif.ops->send_complete_check(ar, pipe_id, force);
 123 }
 124
 125 static inline void ath10k_hif_init(struct ath10k *ar,
 126                                    struct ath10k_hif_cb *callbacks)
 127 {
 128         ar->hif.ops->init(ar, callbacks);
 129 }
 130
 131 static inline u16 ath10k_hif_get_free_queue_number(struct ath10k *ar,
 132                                                    u8 pipe_id)
 133 {
 134         return ar->hif.ops->get_free_queue_number(ar, pipe_id);
 135 }
 136
 137 #endif /* _HIF_H_ */