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
 25struct 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
 33struct 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	void (*stop)(struct ath10k *ar);
 59
 60	int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id,
 61				   u8 *ul_pipe, u8 *dl_pipe);
 62
 63	void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe);
 64
 65	/*
 66	 * Check if prior sends have completed.
 67	 *
 68	 * Check whether the pipe in question has any completed
 69	 * sends that have not yet been processed.
 70	 * This function is only relevant for HIF pipes that are configured
 71	 * to be polled rather than interrupt-driven.
 72	 */
 73	void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force);
 74
 75	u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id);
 76
 77	u32 (*read32)(struct ath10k *ar, u32 address);
 78
 79	void (*write32)(struct ath10k *ar, u32 address, u32 value);
 80
 81	/* Power up the device and enter BMI transfer mode for FW download */
 82	int (*power_up)(struct ath10k *ar);
 83
 84	/* Power down the device and free up resources. stop() must be called
 85	 * before this if start() was called earlier */
 86	void (*power_down)(struct ath10k *ar);
 87
 88	int (*suspend)(struct ath10k *ar);
 89	int (*resume)(struct ath10k *ar);
 90
 91	/* fetch calibration data from target eeprom */
 92	int (*fetch_cal_eeprom)(struct ath10k *ar, void **data,
 93				size_t *data_len);
 94};
 95
 96static inline int ath10k_hif_tx_sg(struct ath10k *ar, u8 pipe_id,
 97				   struct ath10k_hif_sg_item *items,
 98				   int n_items)
 99{
100	return ar->hif.ops->tx_sg(ar, pipe_id, items, n_items);
101}
102
103static inline int ath10k_hif_diag_read(struct ath10k *ar, u32 address, void *buf,
104				       size_t buf_len)
105{
106	return ar->hif.ops->diag_read(ar, address, buf, buf_len);
107}
108
109static inline int ath10k_hif_diag_write(struct ath10k *ar, u32 address,
110					const void *data, int nbytes)
111{
112	if (!ar->hif.ops->diag_write)
113		return -EOPNOTSUPP;
114
115	return ar->hif.ops->diag_write(ar, address, data, nbytes);
116}
117
118static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar,
119					      void *request, u32 request_len,
120					      void *response, u32 *response_len)
121{
122	return ar->hif.ops->exchange_bmi_msg(ar, request, request_len,
123					     response, response_len);
124}
125
126static inline int ath10k_hif_start(struct ath10k *ar)
127{
128	return ar->hif.ops->start(ar);
129}
130
131static inline void ath10k_hif_stop(struct ath10k *ar)
132{
133	return ar->hif.ops->stop(ar);
134}
135
136static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar,
137						 u16 service_id,
138						 u8 *ul_pipe, u8 *dl_pipe)
139{
140	return ar->hif.ops->map_service_to_pipe(ar, service_id,
141						ul_pipe, dl_pipe);
142}
143
144static inline void ath10k_hif_get_default_pipe(struct ath10k *ar,
145					       u8 *ul_pipe, u8 *dl_pipe)
146{
147	ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe);
148}
149
150static inline void ath10k_hif_send_complete_check(struct ath10k *ar,
151						  u8 pipe_id, int force)
152{
153	ar->hif.ops->send_complete_check(ar, pipe_id, force);
154}
155
156static inline u16 ath10k_hif_get_free_queue_number(struct ath10k *ar,
157						   u8 pipe_id)
158{
159	return ar->hif.ops->get_free_queue_number(ar, pipe_id);
160}
161
162static inline int ath10k_hif_power_up(struct ath10k *ar)
163{
164	return ar->hif.ops->power_up(ar);
165}
166
167static inline void ath10k_hif_power_down(struct ath10k *ar)
168{
169	ar->hif.ops->power_down(ar);
170}
171
172static inline int ath10k_hif_suspend(struct ath10k *ar)
173{
174	if (!ar->hif.ops->suspend)
175		return -EOPNOTSUPP;
176
177	return ar->hif.ops->suspend(ar);
178}
179
180static inline int ath10k_hif_resume(struct ath10k *ar)
181{
182	if (!ar->hif.ops->resume)
183		return -EOPNOTSUPP;
184
185	return ar->hif.ops->resume(ar);
186}
187
188static inline u32 ath10k_hif_read32(struct ath10k *ar, u32 address)
189{
190	if (!ar->hif.ops->read32) {
191		ath10k_warn(ar, "hif read32 not supported\n");
192		return 0xdeaddead;
193	}
194
195	return ar->hif.ops->read32(ar, address);
196}
197
198static inline void ath10k_hif_write32(struct ath10k *ar,
199				      u32 address, u32 data)
200{
201	if (!ar->hif.ops->write32) {
202		ath10k_warn(ar, "hif write32 not supported\n");
203		return;
204	}
205
206	ar->hif.ops->write32(ar, address, data);
207}
208
209static inline int ath10k_hif_fetch_cal_eeprom(struct ath10k *ar,
210					      void **data,
211					      size_t *data_len)
212{
213	if (!ar->hif.ops->fetch_cal_eeprom)
214		return -EOPNOTSUPP;
215
216	return ar->hif.ops->fetch_cal_eeprom(ar, data, data_len);
217}
218
219#endif /* _HIF_H_ */