ce.h

  1/* SPDX-License-Identifier: BSD-3-Clause-Clear */
  2/*
  3 * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved.
  4 * Copyright (c) 2021-2022, 2024-2025 Qualcomm Innovation Center, Inc. All rights reserved.
  5 */
  6
  7#ifndef ATH12K_CE_H
  8#define ATH12K_CE_H
  9
 10#define CE_COUNT_MAX 16
 11
 12/* Byte swap data words */
 13#define CE_ATTR_BYTE_SWAP_DATA 2
 14
 15/* no interrupt on copy completion */
 16#define CE_ATTR_DIS_INTR		8
 17
 18/* Host software's Copy Engine configuration. */
 19#define CE_ATTR_FLAGS 0
 20
 21/* Threshold to poll for tx completion in case of Interrupt disabled CE's */
 22#define ATH12K_CE_USAGE_THRESHOLD 32
 23
 24/* Directions for interconnect pipe configuration.
 25 * These definitions may be used during configuration and are shared
 26 * between Host and Target.
 27 *
 28 * Pipe Directions are relative to the Host, so PIPEDIR_IN means
 29 * "coming IN over air through Target to Host" as with a WiFi Rx operation.
 30 * Conversely, PIPEDIR_OUT means "going OUT from Host through Target over air"
 31 * as with a WiFi Tx operation. This is somewhat awkward for the "middle-man"
 32 * Target since things that are "PIPEDIR_OUT" are coming IN to the Target
 33 * over the interconnect.
 34 */
 35#define PIPEDIR_NONE		0
 36#define PIPEDIR_IN		1 /* Target-->Host, WiFi Rx direction */
 37#define PIPEDIR_OUT		2 /* Host->Target, WiFi Tx direction */
 38#define PIPEDIR_INOUT		3 /* bidirectional */
 39#define PIPEDIR_INOUT_H2H	4 /* bidirectional, host to host */
 40
 41/* CE address/mask */
 42#define CE_HOST_IE_ADDRESS	0x75804C
 43#define CE_HOST_IE_2_ADDRESS	0x758050
 44#define CE_HOST_IE_3_ADDRESS	CE_HOST_IE_ADDRESS
 45
 46#define CE_HOST_IE_3_SHIFT	0xC
 47
 48#define CE_RING_IDX_INCR(nentries_mask, idx) (((idx) + 1) & (nentries_mask))
 49
 50#define ATH12K_CE_RX_POST_RETRY_JIFFIES 50
 51
 52struct ath12k_base;
 53
 54/* Establish a mapping between a service/direction and a pipe.
 55 * Configuration information for a Copy Engine pipe and services.
 56 * Passed from Host to Target through QMI message and must be in
 57 * little endian format.
 58 */
 59struct service_to_pipe {
 60	__le32 service_id;
 61	__le32 pipedir;
 62	__le32 pipenum;
 63};
 64
 65/* Configuration information for a Copy Engine pipe.
 66 * Passed from Host to Target through QMI message during startup (one per CE).
 67 *
 68 * NOTE: Structure is shared between Host software and Target firmware!
 69 */
 70struct ce_pipe_config {
 71	__le32 pipenum;
 72	__le32 pipedir;
 73	__le32 nentries;
 74	__le32 nbytes_max;
 75	__le32 flags;
 76	__le32 reserved;
 77};
 78
 79struct ce_ie_addr {
 80	u32 ie1_reg_addr;
 81	u32 ie2_reg_addr;
 82	u32 ie3_reg_addr;
 83};
 84
 85struct ce_remap {
 86	u32 base;
 87	u32 size;
 88};
 89
 90struct ce_attr {
 91	/* CE_ATTR_* values */
 92	unsigned int flags;
 93
 94	/* #entries in source ring - Must be a power of 2 */
 95	unsigned int src_nentries;
 96
 97	/* Max source send size for this CE.
 98	 * This is also the minimum size of a destination buffer.
 99	 */
100	unsigned int src_sz_max;
101
102	/* #entries in destination ring - Must be a power of 2 */
103	unsigned int dest_nentries;
104
105	void (*recv_cb)(struct ath12k_base *ab, struct sk_buff *skb);
106};
107
108#define CE_DESC_RING_ALIGN 8
109
110struct ath12k_ce_ring {
111	/* Number of entries in this ring; must be power of 2 */
112	unsigned int nentries;
113	unsigned int nentries_mask;
114
115	/* For dest ring, this is the next index to be processed
116	 * by software after it was/is received into.
117	 *
118	 * For src ring, this is the last descriptor that was sent
119	 * and completion processed by software.
120	 *
121	 * Regardless of src or dest ring, this is an invariant
122	 * (modulo ring size):
123	 *     write index >= read index >= sw_index
124	 */
125	unsigned int sw_index;
126	/* cached copy */
127	unsigned int write_index;
128
129	/* Start of DMA-coherent area reserved for descriptors */
130	/* Host address space */
131	void *base_addr_owner_space_unaligned;
132	/* CE address space */
133	dma_addr_t base_addr_ce_space_unaligned;
134
135	/* Actual start of descriptors.
136	 * Aligned to descriptor-size boundary.
137	 * Points into reserved DMA-coherent area, above.
138	 */
139	/* Host address space */
140	void *base_addr_owner_space;
141
142	/* CE address space */
143	dma_addr_t base_addr_ce_space;
144
145	/* HAL ring id */
146	u32 hal_ring_id;
147
148	/* keep last */
149	struct sk_buff *skb[];
150};
151
152struct ath12k_ce_pipe {
153	struct ath12k_base *ab;
154	u16 pipe_num;
155	unsigned int attr_flags;
156	unsigned int buf_sz;
157	unsigned int rx_buf_needed;
158
159	void (*send_cb)(struct ath12k_ce_pipe *pipe);
160	void (*recv_cb)(struct ath12k_base *ab, struct sk_buff *skb);
161
162	struct work_struct intr_wq;
163	struct ath12k_ce_ring *src_ring;
164	struct ath12k_ce_ring *dest_ring;
165	struct ath12k_ce_ring *status_ring;
166	u64 timestamp;
167};
168
169struct ath12k_ce {
170	struct ath12k_ce_pipe ce_pipe[CE_COUNT_MAX];
171	/* Protects rings of all ce pipes */
172	spinlock_t ce_lock;
173	struct ath12k_hp_update_timer hp_timer[CE_COUNT_MAX];
174};
175
176extern const struct ce_attr ath12k_host_ce_config_qcn9274[];
177extern const struct ce_attr ath12k_host_ce_config_wcn7850[];
178extern const struct ce_attr ath12k_host_ce_config_ipq5332[];
179
180void ath12k_ce_cleanup_pipes(struct ath12k_base *ab);
181void ath12k_ce_rx_replenish_retry(struct timer_list *t);
182void ath12k_ce_per_engine_service(struct ath12k_base *ab, u16 ce_id);
183int ath12k_ce_send(struct ath12k_base *ab, struct sk_buff *skb, u8 pipe_id,
184		   u16 transfer_id);
185void ath12k_ce_rx_post_buf(struct ath12k_base *ab);
186int ath12k_ce_init_pipes(struct ath12k_base *ab);
187int ath12k_ce_alloc_pipes(struct ath12k_base *ab);
188void ath12k_ce_free_pipes(struct ath12k_base *ab);
189int ath12k_ce_get_attr_flags(struct ath12k_base *ab, int ce_id);
190void ath12k_ce_poll_send_completed(struct ath12k_base *ab, u8 pipe_id);
191void ath12k_ce_get_shadow_config(struct ath12k_base *ab,
192				 u32 **shadow_cfg, u32 *shadow_cfg_len);
193#endif