1 /* SPDX-License-Identifier: ISC */
3 * Copyright (c) 2005-2011 Atheros Communications Inc.
4 * Copyright (c) 2011-2015,2017 Qualcomm Atheros, Inc.
10 #include <linux/kernel.h>
15 /* Types of fw logging mode */
17 ATH10K_ENABLE_FW_LOG_DIAG,
18 ATH10K_ENABLE_FW_LOG_CE,
21 struct ath10k_hif_sg_item {
23 void *transfer_context; /* NULL = tx completion callback not called */
24 void *vaddr; /* for debugging mostly */
29 struct ath10k_hif_ops {
30 /* send a scatter-gather list to the target */
31 int (*tx_sg)(struct ath10k *ar, u8 pipe_id,
32 struct ath10k_hif_sg_item *items, int n_items);
34 /* read firmware memory through the diagnose interface */
35 int (*diag_read)(struct ath10k *ar, u32 address, void *buf,
38 int (*diag_write)(struct ath10k *ar, u32 address, const void *data,
41 * API to handle HIF-specific BMI message exchanges, this API is
42 * synchronous and only allowed to be called from a context that
45 int (*exchange_bmi_msg)(struct ath10k *ar,
46 void *request, u32 request_len,
47 void *response, u32 *response_len);
49 /* Post BMI phase, after FW is loaded. Starts regular operation */
50 int (*start)(struct ath10k *ar);
52 /* Clean up what start() did. This does not revert to BMI phase. If
53 * desired so, call power_down() and power_up()
55 void (*stop)(struct ath10k *ar);
57 int (*start_post)(struct ath10k *ar);
59 int (*get_htt_tx_complete)(struct ath10k *ar);
61 int (*map_service_to_pipe)(struct ath10k *ar, u16 service_id,
62 u8 *ul_pipe, u8 *dl_pipe);
64 void (*get_default_pipe)(struct ath10k *ar, u8 *ul_pipe, u8 *dl_pipe);
67 * Check if prior sends have completed.
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.
74 void (*send_complete_check)(struct ath10k *ar, u8 pipe_id, int force);
76 u16 (*get_free_queue_number)(struct ath10k *ar, u8 pipe_id);
78 u32 (*read32)(struct ath10k *ar, u32 address);
80 void (*write32)(struct ath10k *ar, u32 address, u32 value);
82 /* Power up the device and enter BMI transfer mode for FW download */
83 int (*power_up)(struct ath10k *ar, enum ath10k_firmware_mode fw_mode);
85 /* Power down the device and free up resources. stop() must be called
86 * before this if start() was called earlier
88 void (*power_down)(struct ath10k *ar);
90 int (*suspend)(struct ath10k *ar);
91 int (*resume)(struct ath10k *ar);
93 /* fetch calibration data from target eeprom */
94 int (*fetch_cal_eeprom)(struct ath10k *ar, void **data,
97 int (*get_target_info)(struct ath10k *ar,
98 struct bmi_target_info *target_info);
99 int (*set_target_log_mode)(struct ath10k *ar, u8 fw_log_mode);
102 static inline int ath10k_hif_tx_sg(struct ath10k *ar, u8 pipe_id,
103 struct ath10k_hif_sg_item *items,
106 return ar->hif.ops->tx_sg(ar, pipe_id, items, n_items);
109 static inline int ath10k_hif_diag_read(struct ath10k *ar, u32 address, void *buf,
112 return ar->hif.ops->diag_read(ar, address, buf, buf_len);
115 static inline int ath10k_hif_diag_write(struct ath10k *ar, u32 address,
116 const void *data, int nbytes)
118 if (!ar->hif.ops->diag_write)
121 return ar->hif.ops->diag_write(ar, address, data, nbytes);
124 static inline int ath10k_hif_exchange_bmi_msg(struct ath10k *ar,
125 void *request, u32 request_len,
126 void *response, u32 *response_len)
128 return ar->hif.ops->exchange_bmi_msg(ar, request, request_len,
129 response, response_len);
132 static inline int ath10k_hif_start(struct ath10k *ar)
134 return ar->hif.ops->start(ar);
137 static inline void ath10k_hif_stop(struct ath10k *ar)
139 return ar->hif.ops->stop(ar);
142 static inline int ath10k_hif_start_post(struct ath10k *ar)
144 if (ar->hif.ops->start_post)
145 return ar->hif.ops->start_post(ar);
149 static inline int ath10k_hif_get_htt_tx_complete(struct ath10k *ar)
151 if (ar->hif.ops->get_htt_tx_complete)
152 return ar->hif.ops->get_htt_tx_complete(ar);
156 static inline int ath10k_hif_map_service_to_pipe(struct ath10k *ar,
158 u8 *ul_pipe, u8 *dl_pipe)
160 return ar->hif.ops->map_service_to_pipe(ar, service_id,
164 static inline void ath10k_hif_get_default_pipe(struct ath10k *ar,
165 u8 *ul_pipe, u8 *dl_pipe)
167 ar->hif.ops->get_default_pipe(ar, ul_pipe, dl_pipe);
170 static inline void ath10k_hif_send_complete_check(struct ath10k *ar,
171 u8 pipe_id, int force)
173 if (ar->hif.ops->send_complete_check)
174 ar->hif.ops->send_complete_check(ar, pipe_id, force);
177 static inline u16 ath10k_hif_get_free_queue_number(struct ath10k *ar,
180 return ar->hif.ops->get_free_queue_number(ar, pipe_id);
183 static inline int ath10k_hif_power_up(struct ath10k *ar,
184 enum ath10k_firmware_mode fw_mode)
186 return ar->hif.ops->power_up(ar, fw_mode);
189 static inline void ath10k_hif_power_down(struct ath10k *ar)
191 ar->hif.ops->power_down(ar);
194 static inline int ath10k_hif_suspend(struct ath10k *ar)
196 if (!ar->hif.ops->suspend)
199 return ar->hif.ops->suspend(ar);
202 static inline int ath10k_hif_resume(struct ath10k *ar)
204 if (!ar->hif.ops->resume)
207 return ar->hif.ops->resume(ar);
210 static inline u32 ath10k_hif_read32(struct ath10k *ar, u32 address)
212 if (!ar->hif.ops->read32) {
213 ath10k_warn(ar, "hif read32 not supported\n");
217 return ar->hif.ops->read32(ar, address);
220 static inline void ath10k_hif_write32(struct ath10k *ar,
221 u32 address, u32 data)
223 if (!ar->hif.ops->write32) {
224 ath10k_warn(ar, "hif write32 not supported\n");
228 ar->hif.ops->write32(ar, address, data);
231 static inline int ath10k_hif_fetch_cal_eeprom(struct ath10k *ar,
235 if (!ar->hif.ops->fetch_cal_eeprom)
238 return ar->hif.ops->fetch_cal_eeprom(ar, data, data_len);
241 static inline int ath10k_hif_get_target_info(struct ath10k *ar,
242 struct bmi_target_info *tgt_info)
244 if (!ar->hif.ops->get_target_info)
247 return ar->hif.ops->get_target_info(ar, tgt_info);
250 static inline int ath10k_hif_set_target_log_mode(struct ath10k *ar,
253 if (!ar->hif.ops->set_target_log_mode)
256 return ar->hif.ops->set_target_log_mode(ar, fw_log_mode);