1 /* SPDX-License-Identifier: BSD-3-Clause-Clear */
2 /*
3  * Copyright (c) 2019-2020 The Linux Foundation. All rights reserved.
4  * Copyright (c) 2022-2024 Qualcomm Innovation Center, Inc. All rights reserved.
5  */
6 
7 #ifndef _HIF_H_
8 #define _HIF_H_
9 
10 #include "core.h"
11 
12 struct ath11k_hif_ops {
13 	u32 (*read32)(struct ath11k_base *ab, u32 address);
14 	void (*write32)(struct ath11k_base *ab, u32 address, u32 data);
15 	int (*read)(struct ath11k_base *ab, void *buf, u32 start, u32 end);
16 	void (*irq_enable)(struct ath11k_base *ab);
17 	void (*irq_disable)(struct ath11k_base *ab);
18 	int (*start)(struct ath11k_base *ab);
19 	void (*stop)(struct ath11k_base *ab);
20 	int (*power_up)(struct ath11k_base *ab);
21 	void (*power_down)(struct ath11k_base *ab);
22 	int (*suspend)(struct ath11k_base *ab);
23 	int (*resume)(struct ath11k_base *ab);
24 	int (*map_service_to_pipe)(struct ath11k_base *ab, u16 service_id,
25 				   u8 *ul_pipe, u8 *dl_pipe);
26 	int (*get_user_msi_vector)(struct ath11k_base *ab, char *user_name,
27 				   int *num_vectors, u32 *user_base_data,
28 				   u32 *base_vector);
29 	void (*get_msi_address)(struct ath11k_base *ab, u32 *msi_addr_lo,
30 				u32 *msi_addr_hi);
31 	void (*ce_irq_enable)(struct ath11k_base *ab);
32 	void (*ce_irq_disable)(struct ath11k_base *ab);
33 	void (*get_ce_msi_idx)(struct ath11k_base *ab, u32 ce_id, u32 *msi_idx);
34 	void (*coredump_download)(struct ath11k_base *ab);
35 };
36 
ath11k_hif_ce_irq_enable(struct ath11k_base * ab)37 static inline void ath11k_hif_ce_irq_enable(struct ath11k_base *ab)
38 {
39 	if (ab->hif.ops->ce_irq_enable)
40 		ab->hif.ops->ce_irq_enable(ab);
41 }
42 
ath11k_hif_ce_irq_disable(struct ath11k_base * ab)43 static inline void ath11k_hif_ce_irq_disable(struct ath11k_base *ab)
44 {
45 	if (ab->hif.ops->ce_irq_disable)
46 		ab->hif.ops->ce_irq_disable(ab);
47 }
48 
ath11k_hif_start(struct ath11k_base * ab)49 static inline int ath11k_hif_start(struct ath11k_base *ab)
50 {
51 	return ab->hif.ops->start(ab);
52 }
53 
ath11k_hif_stop(struct ath11k_base * ab)54 static inline void ath11k_hif_stop(struct ath11k_base *ab)
55 {
56 	ab->hif.ops->stop(ab);
57 }
58 
ath11k_hif_irq_enable(struct ath11k_base * ab)59 static inline void ath11k_hif_irq_enable(struct ath11k_base *ab)
60 {
61 	ab->hif.ops->irq_enable(ab);
62 }
63 
ath11k_hif_irq_disable(struct ath11k_base * ab)64 static inline void ath11k_hif_irq_disable(struct ath11k_base *ab)
65 {
66 	ab->hif.ops->irq_disable(ab);
67 }
68 
ath11k_hif_power_up(struct ath11k_base * ab)69 static inline int ath11k_hif_power_up(struct ath11k_base *ab)
70 {
71 	return ab->hif.ops->power_up(ab);
72 }
73 
ath11k_hif_power_down(struct ath11k_base * ab)74 static inline void ath11k_hif_power_down(struct ath11k_base *ab)
75 {
76 	ab->hif.ops->power_down(ab);
77 }
78 
ath11k_hif_suspend(struct ath11k_base * ab)79 static inline int ath11k_hif_suspend(struct ath11k_base *ab)
80 {
81 	if (ab->hif.ops->suspend)
82 		return ab->hif.ops->suspend(ab);
83 
84 	return 0;
85 }
86 
ath11k_hif_resume(struct ath11k_base * ab)87 static inline int ath11k_hif_resume(struct ath11k_base *ab)
88 {
89 	if (ab->hif.ops->resume)
90 		return ab->hif.ops->resume(ab);
91 
92 	return 0;
93 }
94 
ath11k_hif_read32(struct ath11k_base * ab,u32 address)95 static inline u32 ath11k_hif_read32(struct ath11k_base *ab, u32 address)
96 {
97 	return ab->hif.ops->read32(ab, address);
98 }
99 
ath11k_hif_write32(struct ath11k_base * ab,u32 address,u32 data)100 static inline void ath11k_hif_write32(struct ath11k_base *ab, u32 address, u32 data)
101 {
102 	ab->hif.ops->write32(ab, address, data);
103 }
104 
ath11k_hif_read(struct ath11k_base * ab,void * buf,u32 start,u32 end)105 static inline int ath11k_hif_read(struct ath11k_base *ab, void *buf,
106 				  u32 start, u32 end)
107 {
108 	if (!ab->hif.ops->read)
109 		return -EOPNOTSUPP;
110 
111 	return ab->hif.ops->read(ab, buf, start, end);
112 }
113 
ath11k_hif_map_service_to_pipe(struct ath11k_base * ab,u16 service_id,u8 * ul_pipe,u8 * dl_pipe)114 static inline int ath11k_hif_map_service_to_pipe(struct ath11k_base *ab, u16 service_id,
115 						 u8 *ul_pipe, u8 *dl_pipe)
116 {
117 	return ab->hif.ops->map_service_to_pipe(ab, service_id, ul_pipe, dl_pipe);
118 }
119 
ath11k_get_user_msi_vector(struct ath11k_base * ab,char * user_name,int * num_vectors,u32 * user_base_data,u32 * base_vector)120 static inline int ath11k_get_user_msi_vector(struct ath11k_base *ab, char *user_name,
121 					     int *num_vectors, u32 *user_base_data,
122 					     u32 *base_vector)
123 {
124 	if (!ab->hif.ops->get_user_msi_vector)
125 		return -EOPNOTSUPP;
126 
127 	return ab->hif.ops->get_user_msi_vector(ab, user_name, num_vectors,
128 						user_base_data,
129 						base_vector);
130 }
131 
ath11k_get_msi_address(struct ath11k_base * ab,u32 * msi_addr_lo,u32 * msi_addr_hi)132 static inline void ath11k_get_msi_address(struct ath11k_base *ab, u32 *msi_addr_lo,
133 					  u32 *msi_addr_hi)
134 {
135 	if (!ab->hif.ops->get_msi_address)
136 		return;
137 
138 	ab->hif.ops->get_msi_address(ab, msi_addr_lo, msi_addr_hi);
139 }
140 
ath11k_get_ce_msi_idx(struct ath11k_base * ab,u32 ce_id,u32 * msi_data_idx)141 static inline void ath11k_get_ce_msi_idx(struct ath11k_base *ab, u32 ce_id,
142 					 u32 *msi_data_idx)
143 {
144 	if (ab->hif.ops->get_ce_msi_idx)
145 		ab->hif.ops->get_ce_msi_idx(ab, ce_id, msi_data_idx);
146 	else
147 		*msi_data_idx = ce_id;
148 }
149 
ath11k_hif_coredump_download(struct ath11k_base * ab)150 static inline void ath11k_hif_coredump_download(struct ath11k_base *ab)
151 {
152 	if (ab->hif.ops->coredump_download)
153 		ab->hif.ops->coredump_download(ab);
154 }
155 
156 #endif /* _HIF_H_ */
157