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