1189251Ssam/* SPDX-License-Identifier: BSD-3-Clause-Clear */
2189251Ssam/*
3189251Ssam * Copyright (c) 2019-2021 The Linux Foundation. All rights reserved.
4281806Srpaulo * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
5281806Srpaulo */
6346981Scy
7189251Ssam#ifndef ATH12K_HIF_H
8189251Ssam#define ATH12K_HIF_H
9252726Srpaulo
10252726Srpaulo#include "core.h"
11189251Ssam
12252726Srpaulostruct ath12k_hif_ops {
13189251Ssam	u32 (*read32)(struct ath12k_base *ab, u32 address);
14252726Srpaulo	void (*write32)(struct ath12k_base *ab, u32 address, u32 data);
15252726Srpaulo	void (*irq_enable)(struct ath12k_base *ab);
16189251Ssam	void (*irq_disable)(struct ath12k_base *ab);
17189251Ssam	int (*start)(struct ath12k_base *ab);
18189251Ssam	void (*stop)(struct ath12k_base *ab);
19189251Ssam	int (*power_up)(struct ath12k_base *ab);
20189251Ssam	void (*power_down)(struct ath12k_base *ab);
21281806Srpaulo	int (*suspend)(struct ath12k_base *ab);
22281806Srpaulo	int (*resume)(struct ath12k_base *ab);
23281806Srpaulo	int (*map_service_to_pipe)(struct ath12k_base *ab, u16 service_id,
24281806Srpaulo				   u8 *ul_pipe, u8 *dl_pipe);
25281806Srpaulo	int (*get_user_msi_vector)(struct ath12k_base *ab, char *user_name,
26281806Srpaulo				   int *num_vectors, u32 *user_base_data,
27281806Srpaulo				   u32 *base_vector);
28189251Ssam	void (*get_msi_address)(struct ath12k_base *ab, u32 *msi_addr_lo,
29189251Ssam				u32 *msi_addr_hi);
30189251Ssam	void (*ce_irq_enable)(struct ath12k_base *ab);
31189251Ssam	void (*ce_irq_disable)(struct ath12k_base *ab);
32189251Ssam	void (*get_ce_msi_idx)(struct ath12k_base *ab, u32 ce_id, u32 *msi_idx);
33281806Srpaulo};
34281806Srpaulo
35189251Ssamstatic inline int ath12k_hif_map_service_to_pipe(struct ath12k_base *ab, u16 service_id,
36346981Scy						 u8 *ul_pipe, u8 *dl_pipe)
37346981Scy{
38189251Ssam	return ab->hif.ops->map_service_to_pipe(ab, service_id,
39189251Ssam						ul_pipe, dl_pipe);
40189251Ssam}
41189251Ssam
42189251Ssamstatic inline int ath12k_hif_get_user_msi_vector(struct ath12k_base *ab,
43189251Ssam						 char *user_name,
44189251Ssam						 int *num_vectors,
45189251Ssam						 u32 *user_base_data,
46189251Ssam						 u32 *base_vector)
47189251Ssam{
48189251Ssam	if (!ab->hif.ops->get_user_msi_vector)
49189251Ssam		return -EOPNOTSUPP;
50189251Ssam
51189251Ssam	return ab->hif.ops->get_user_msi_vector(ab, user_name, num_vectors,
52252726Srpaulo						user_base_data,
53252726Srpaulo						base_vector);
54252726Srpaulo}
55252726Srpaulo
56252726Srpaulostatic inline void ath12k_hif_get_msi_address(struct ath12k_base *ab,
57252726Srpaulo					      u32 *msi_addr_lo,
58252726Srpaulo					      u32 *msi_addr_hi)
59252726Srpaulo{
60252726Srpaulo	if (!ab->hif.ops->get_msi_address)
61252726Srpaulo		return;
62252726Srpaulo
63252726Srpaulo	ab->hif.ops->get_msi_address(ab, msi_addr_lo, msi_addr_hi);
64252726Srpaulo}
65252726Srpaulo
66252726Srpaulostatic inline void ath12k_hif_get_ce_msi_idx(struct ath12k_base *ab, u32 ce_id,
67252726Srpaulo					     u32 *msi_data_idx)
68252726Srpaulo{
69252726Srpaulo	if (ab->hif.ops->get_ce_msi_idx)
70252726Srpaulo		ab->hif.ops->get_ce_msi_idx(ab, ce_id, msi_data_idx);
71252726Srpaulo	else
72189251Ssam		*msi_data_idx = ce_id;
73189251Ssam}
74
75static inline void ath12k_hif_ce_irq_enable(struct ath12k_base *ab)
76{
77	if (ab->hif.ops->ce_irq_enable)
78		ab->hif.ops->ce_irq_enable(ab);
79}
80
81static inline void ath12k_hif_ce_irq_disable(struct ath12k_base *ab)
82{
83	if (ab->hif.ops->ce_irq_disable)
84		ab->hif.ops->ce_irq_disable(ab);
85}
86
87static inline void ath12k_hif_irq_enable(struct ath12k_base *ab)
88{
89	ab->hif.ops->irq_enable(ab);
90}
91
92static inline void ath12k_hif_irq_disable(struct ath12k_base *ab)
93{
94	ab->hif.ops->irq_disable(ab);
95}
96
97static inline int ath12k_hif_suspend(struct ath12k_base *ab)
98{
99	if (ab->hif.ops->suspend)
100		return ab->hif.ops->suspend(ab);
101
102	return 0;
103}
104
105static inline int ath12k_hif_resume(struct ath12k_base *ab)
106{
107	if (ab->hif.ops->resume)
108		return ab->hif.ops->resume(ab);
109
110	return 0;
111}
112
113static inline int ath12k_hif_start(struct ath12k_base *ab)
114{
115	return ab->hif.ops->start(ab);
116}
117
118static inline void ath12k_hif_stop(struct ath12k_base *ab)
119{
120	ab->hif.ops->stop(ab);
121}
122
123static inline u32 ath12k_hif_read32(struct ath12k_base *ab, u32 address)
124{
125	return ab->hif.ops->read32(ab, address);
126}
127
128static inline void ath12k_hif_write32(struct ath12k_base *ab, u32 address,
129				      u32 data)
130{
131	ab->hif.ops->write32(ab, address, data);
132}
133
134static inline int ath12k_hif_power_up(struct ath12k_base *ab)
135{
136	return ab->hif.ops->power_up(ab);
137}
138
139static inline void ath12k_hif_power_down(struct ath12k_base *ab)
140{
141	ab->hif.ops->power_down(ab);
142}
143
144#endif /* ATH12K_HIF_H */
145