xref: /openbmc/linux/drivers/net/ipa/ipa_cmd.c (revision 8701cb00d78a41a222fd770691e297c47ecbb218)
1731c46edSAlex Elder // SPDX-License-Identifier: GPL-2.0
2731c46edSAlex Elder 
3731c46edSAlex Elder /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4731c46edSAlex Elder  * Copyright (C) 2019-2020 Linaro Ltd.
5731c46edSAlex Elder  */
6731c46edSAlex Elder 
7731c46edSAlex Elder #include <linux/types.h>
8731c46edSAlex Elder #include <linux/device.h>
9731c46edSAlex Elder #include <linux/slab.h>
10731c46edSAlex Elder #include <linux/bitfield.h>
11731c46edSAlex Elder #include <linux/dma-direction.h>
12731c46edSAlex Elder 
13731c46edSAlex Elder #include "gsi.h"
14731c46edSAlex Elder #include "gsi_trans.h"
15731c46edSAlex Elder #include "ipa.h"
16731c46edSAlex Elder #include "ipa_endpoint.h"
17731c46edSAlex Elder #include "ipa_table.h"
18731c46edSAlex Elder #include "ipa_cmd.h"
19731c46edSAlex Elder #include "ipa_mem.h"
20731c46edSAlex Elder 
21731c46edSAlex Elder /**
22731c46edSAlex Elder  * DOC:  IPA Immediate Commands
23731c46edSAlex Elder  *
24731c46edSAlex Elder  * The AP command TX endpoint is used to issue immediate commands to the IPA.
25731c46edSAlex Elder  * An immediate command is generally used to request the IPA do something
26731c46edSAlex Elder  * other than data transfer to another endpoint.
27731c46edSAlex Elder  *
28731c46edSAlex Elder  * Immediate commands are represented by GSI transactions just like other
29731c46edSAlex Elder  * transfer requests, represented by a single GSI TRE.  Each immediate
30731c46edSAlex Elder  * command has a well-defined format, having a payload of a known length.
31731c46edSAlex Elder  * This allows the transfer element's length field to be used to hold an
32731c46edSAlex Elder  * immediate command's opcode.  The payload for a command resides in DRAM
33731c46edSAlex Elder  * and is described by a single scatterlist entry in its transaction.
34731c46edSAlex Elder  * Commands do not require a transaction completion callback.  To commit
35731c46edSAlex Elder  * an immediate command transaction, either gsi_trans_commit_wait() or
36731c46edSAlex Elder  * gsi_trans_commit_wait_timeout() is used.
37731c46edSAlex Elder  */
38731c46edSAlex Elder 
39731c46edSAlex Elder /* Some commands can wait until indicated pipeline stages are clear */
40731c46edSAlex Elder enum pipeline_clear_options {
41*8701cb00SAlex Elder 	pipeline_clear_hps		= 0x0,
42*8701cb00SAlex Elder 	pipeline_clear_src_grp		= 0x1,
43*8701cb00SAlex Elder 	pipeline_clear_full		= 0x2,
44731c46edSAlex Elder };
45731c46edSAlex Elder 
46731c46edSAlex Elder /* IPA_CMD_IP_V{4,6}_{FILTER,ROUTING}_INIT */
47731c46edSAlex Elder 
48731c46edSAlex Elder struct ipa_cmd_hw_ip_fltrt_init {
49731c46edSAlex Elder 	__le64 hash_rules_addr;
50731c46edSAlex Elder 	__le64 flags;
51731c46edSAlex Elder 	__le64 nhash_rules_addr;
52731c46edSAlex Elder };
53731c46edSAlex Elder 
54731c46edSAlex Elder /* Field masks for ipa_cmd_hw_ip_fltrt_init structure fields */
55731c46edSAlex Elder #define IP_FLTRT_FLAGS_HASH_SIZE_FMASK			GENMASK_ULL(11, 0)
56731c46edSAlex Elder #define IP_FLTRT_FLAGS_HASH_ADDR_FMASK			GENMASK_ULL(27, 12)
57731c46edSAlex Elder #define IP_FLTRT_FLAGS_NHASH_SIZE_FMASK			GENMASK_ULL(39, 28)
58731c46edSAlex Elder #define IP_FLTRT_FLAGS_NHASH_ADDR_FMASK			GENMASK_ULL(55, 40)
59731c46edSAlex Elder 
60731c46edSAlex Elder /* IPA_CMD_HDR_INIT_LOCAL */
61731c46edSAlex Elder 
62731c46edSAlex Elder struct ipa_cmd_hw_hdr_init_local {
63731c46edSAlex Elder 	__le64 hdr_table_addr;
64731c46edSAlex Elder 	__le32 flags;
65731c46edSAlex Elder 	__le32 reserved;
66731c46edSAlex Elder };
67731c46edSAlex Elder 
68731c46edSAlex Elder /* Field masks for ipa_cmd_hw_hdr_init_local structure fields */
69731c46edSAlex Elder #define HDR_INIT_LOCAL_FLAGS_TABLE_SIZE_FMASK		GENMASK(11, 0)
70731c46edSAlex Elder #define HDR_INIT_LOCAL_FLAGS_HDR_ADDR_FMASK		GENMASK(27, 12)
71731c46edSAlex Elder 
72731c46edSAlex Elder /* IPA_CMD_REGISTER_WRITE */
73731c46edSAlex Elder 
74731c46edSAlex Elder /* For IPA v4.0+, this opcode gets modified with pipeline clear options */
75731c46edSAlex Elder 
76731c46edSAlex Elder #define REGISTER_WRITE_OPCODE_SKIP_CLEAR_FMASK		GENMASK(8, 8)
77731c46edSAlex Elder #define REGISTER_WRITE_OPCODE_CLEAR_OPTION_FMASK	GENMASK(10, 9)
78731c46edSAlex Elder 
79731c46edSAlex Elder struct ipa_cmd_register_write {
80731c46edSAlex Elder 	__le16 flags;		/* Unused/reserved for IPA v3.5.1 */
81731c46edSAlex Elder 	__le16 offset;
82731c46edSAlex Elder 	__le32 value;
83731c46edSAlex Elder 	__le32 value_mask;
84731c46edSAlex Elder 	__le32 clear_options;	/* Unused/reserved for IPA v4.0+ */
85731c46edSAlex Elder };
86731c46edSAlex Elder 
87731c46edSAlex Elder /* Field masks for ipa_cmd_register_write structure fields */
88731c46edSAlex Elder /* The next field is present for IPA v4.0 and above */
89731c46edSAlex Elder #define REGISTER_WRITE_FLAGS_OFFSET_HIGH_FMASK		GENMASK(14, 11)
90731c46edSAlex Elder /* The next field is present for IPA v3.5.1 only */
91731c46edSAlex Elder #define REGISTER_WRITE_FLAGS_SKIP_CLEAR_FMASK		GENMASK(15, 15)
92731c46edSAlex Elder 
93731c46edSAlex Elder /* The next field and its values are present for IPA v3.5.1 only */
94731c46edSAlex Elder #define REGISTER_WRITE_CLEAR_OPTIONS_FMASK		GENMASK(1, 0)
95731c46edSAlex Elder 
96731c46edSAlex Elder /* IPA_CMD_IP_PACKET_INIT */
97731c46edSAlex Elder 
98731c46edSAlex Elder struct ipa_cmd_ip_packet_init {
99731c46edSAlex Elder 	u8 dest_endpoint;
100731c46edSAlex Elder 	u8 reserved[7];
101731c46edSAlex Elder };
102731c46edSAlex Elder 
103731c46edSAlex Elder /* Field masks for ipa_cmd_ip_packet_init dest_endpoint field */
104731c46edSAlex Elder #define IPA_PACKET_INIT_DEST_ENDPOINT_FMASK		GENMASK(4, 0)
105731c46edSAlex Elder 
106731c46edSAlex Elder /* IPA_CMD_DMA_SHARED_MEM */
107731c46edSAlex Elder 
108731c46edSAlex Elder /* For IPA v4.0+, this opcode gets modified with pipeline clear options */
109731c46edSAlex Elder 
110731c46edSAlex Elder #define DMA_SHARED_MEM_OPCODE_SKIP_CLEAR_FMASK		GENMASK(8, 8)
111731c46edSAlex Elder #define DMA_SHARED_MEM_OPCODE_CLEAR_OPTION_FMASK	GENMASK(10, 9)
112731c46edSAlex Elder 
113731c46edSAlex Elder struct ipa_cmd_hw_dma_mem_mem {
114731c46edSAlex Elder 	__le16 clear_after_read; /* 0 or DMA_SHARED_MEM_CLEAR_AFTER_READ */
115731c46edSAlex Elder 	__le16 size;
116731c46edSAlex Elder 	__le16 local_addr;
117731c46edSAlex Elder 	__le16 flags;
118731c46edSAlex Elder 	__le64 system_addr;
119731c46edSAlex Elder };
120731c46edSAlex Elder 
121731c46edSAlex Elder /* Flag allowing atomic clear of target region after reading data (v4.0+)*/
122731c46edSAlex Elder #define DMA_SHARED_MEM_CLEAR_AFTER_READ			GENMASK(15, 15)
123731c46edSAlex Elder 
124731c46edSAlex Elder /* Field masks for ipa_cmd_hw_dma_mem_mem structure fields */
125731c46edSAlex Elder #define DMA_SHARED_MEM_FLAGS_DIRECTION_FMASK		GENMASK(0, 0)
126731c46edSAlex Elder /* The next two fields are present for IPA v3.5.1 only. */
127731c46edSAlex Elder #define DMA_SHARED_MEM_FLAGS_SKIP_CLEAR_FMASK		GENMASK(1, 1)
128731c46edSAlex Elder #define DMA_SHARED_MEM_FLAGS_CLEAR_OPTIONS_FMASK	GENMASK(3, 2)
129731c46edSAlex Elder 
130731c46edSAlex Elder /* IPA_CMD_IP_PACKET_TAG_STATUS */
131731c46edSAlex Elder 
132731c46edSAlex Elder struct ipa_cmd_ip_packet_tag_status {
133731c46edSAlex Elder 	__le64 tag;
134731c46edSAlex Elder };
135731c46edSAlex Elder 
136731c46edSAlex Elder #define IP_PACKET_TAG_STATUS_TAG_FMASK			GENMASK_ULL(63, 16)
137731c46edSAlex Elder 
138731c46edSAlex Elder /* Immediate command payload */
139731c46edSAlex Elder union ipa_cmd_payload {
140731c46edSAlex Elder 	struct ipa_cmd_hw_ip_fltrt_init table_init;
141731c46edSAlex Elder 	struct ipa_cmd_hw_hdr_init_local hdr_init_local;
142731c46edSAlex Elder 	struct ipa_cmd_register_write register_write;
143731c46edSAlex Elder 	struct ipa_cmd_ip_packet_init ip_packet_init;
144731c46edSAlex Elder 	struct ipa_cmd_hw_dma_mem_mem dma_shared_mem;
145731c46edSAlex Elder 	struct ipa_cmd_ip_packet_tag_status ip_packet_tag_status;
146731c46edSAlex Elder };
147731c46edSAlex Elder 
148731c46edSAlex Elder static void ipa_cmd_validate_build(void)
149731c46edSAlex Elder {
150731c46edSAlex Elder 	/* The sizes of a filter and route tables need to fit into fields
151731c46edSAlex Elder 	 * in the ipa_cmd_hw_ip_fltrt_init structure.  Although hashed tables
152731c46edSAlex Elder 	 * might not be used, non-hashed and hashed tables have the same
153731c46edSAlex Elder 	 * maximum size.  IPv4 and IPv6 filter tables have the same number
154731c46edSAlex Elder 	 * of entries, as and IPv4 and IPv6 route tables have the same number
155731c46edSAlex Elder 	 * of entries.
156731c46edSAlex Elder 	 */
157731c46edSAlex Elder #define TABLE_SIZE	(TABLE_COUNT_MAX * IPA_TABLE_ENTRY_SIZE)
158731c46edSAlex Elder #define TABLE_COUNT_MAX	max_t(u32, IPA_ROUTE_COUNT_MAX, IPA_FILTER_COUNT_MAX)
159731c46edSAlex Elder 	BUILD_BUG_ON(TABLE_SIZE > field_max(IP_FLTRT_FLAGS_HASH_SIZE_FMASK));
160731c46edSAlex Elder 	BUILD_BUG_ON(TABLE_SIZE > field_max(IP_FLTRT_FLAGS_NHASH_SIZE_FMASK));
161731c46edSAlex Elder #undef TABLE_COUNT_MAX
162731c46edSAlex Elder #undef TABLE_SIZE
163731c46edSAlex Elder }
164731c46edSAlex Elder 
165731c46edSAlex Elder #ifdef IPA_VALIDATE
166731c46edSAlex Elder 
167731c46edSAlex Elder /* Validate a memory region holding a table */
168731c46edSAlex Elder bool ipa_cmd_table_valid(struct ipa *ipa, const struct ipa_mem *mem,
169731c46edSAlex Elder 			 bool route, bool ipv6, bool hashed)
170731c46edSAlex Elder {
171731c46edSAlex Elder 	struct device *dev = &ipa->pdev->dev;
172731c46edSAlex Elder 	u32 offset_max;
173731c46edSAlex Elder 
174731c46edSAlex Elder 	offset_max = hashed ? field_max(IP_FLTRT_FLAGS_HASH_ADDR_FMASK)
175731c46edSAlex Elder 			    : field_max(IP_FLTRT_FLAGS_NHASH_ADDR_FMASK);
176731c46edSAlex Elder 	if (mem->offset > offset_max ||
177731c46edSAlex Elder 	    ipa->mem_offset > offset_max - mem->offset) {
178731c46edSAlex Elder 		dev_err(dev, "IPv%c %s%s table region offset too large "
179731c46edSAlex Elder 			      "(0x%04x + 0x%04x > 0x%04x)\n",
180731c46edSAlex Elder 			      ipv6 ? '6' : '4', hashed ? "hashed " : "",
181731c46edSAlex Elder 			      route ? "route" : "filter",
182731c46edSAlex Elder 			      ipa->mem_offset, mem->offset, offset_max);
183731c46edSAlex Elder 		return false;
184731c46edSAlex Elder 	}
185731c46edSAlex Elder 
186731c46edSAlex Elder 	if (mem->offset > ipa->mem_size ||
187731c46edSAlex Elder 	    mem->size > ipa->mem_size - mem->offset) {
188731c46edSAlex Elder 		dev_err(dev, "IPv%c %s%s table region out of range "
189731c46edSAlex Elder 			      "(0x%04x + 0x%04x > 0x%04x)\n",
190731c46edSAlex Elder 			      ipv6 ? '6' : '4', hashed ? "hashed " : "",
191731c46edSAlex Elder 			      route ? "route" : "filter",
192731c46edSAlex Elder 			      mem->offset, mem->size, ipa->mem_size);
193731c46edSAlex Elder 		return false;
194731c46edSAlex Elder 	}
195731c46edSAlex Elder 
196731c46edSAlex Elder 	return true;
197731c46edSAlex Elder }
198731c46edSAlex Elder 
199731c46edSAlex Elder /* Validate the memory region that holds headers */
200731c46edSAlex Elder static bool ipa_cmd_header_valid(struct ipa *ipa)
201731c46edSAlex Elder {
202731c46edSAlex Elder 	const struct ipa_mem *mem = &ipa->mem[IPA_MEM_MODEM_HEADER];
203731c46edSAlex Elder 	struct device *dev = &ipa->pdev->dev;
204731c46edSAlex Elder 	u32 offset_max;
205731c46edSAlex Elder 	u32 size_max;
206731c46edSAlex Elder 	u32 size;
207731c46edSAlex Elder 
208731c46edSAlex Elder 	offset_max = field_max(HDR_INIT_LOCAL_FLAGS_HDR_ADDR_FMASK);
209731c46edSAlex Elder 	if (mem->offset > offset_max ||
210731c46edSAlex Elder 	    ipa->mem_offset > offset_max - mem->offset) {
211731c46edSAlex Elder 		dev_err(dev, "header table region offset too large "
212731c46edSAlex Elder 			      "(0x%04x + 0x%04x > 0x%04x)\n",
213731c46edSAlex Elder 			      ipa->mem_offset + mem->offset, offset_max);
214731c46edSAlex Elder 		return false;
215731c46edSAlex Elder 	}
216731c46edSAlex Elder 
217731c46edSAlex Elder 	size_max = field_max(HDR_INIT_LOCAL_FLAGS_TABLE_SIZE_FMASK);
218731c46edSAlex Elder 	size = ipa->mem[IPA_MEM_MODEM_HEADER].size;
219731c46edSAlex Elder 	size += ipa->mem[IPA_MEM_AP_HEADER].size;
220731c46edSAlex Elder 	if (mem->offset > ipa->mem_size || size > ipa->mem_size - mem->offset) {
221731c46edSAlex Elder 		dev_err(dev, "header table region out of range "
222731c46edSAlex Elder 			      "(0x%04x + 0x%04x > 0x%04x)\n",
223731c46edSAlex Elder 			      mem->offset, size, ipa->mem_size);
224731c46edSAlex Elder 		return false;
225731c46edSAlex Elder 	}
226731c46edSAlex Elder 
227731c46edSAlex Elder 	return true;
228731c46edSAlex Elder }
229731c46edSAlex Elder 
230731c46edSAlex Elder /* Indicate whether an offset can be used with a register_write command */
231731c46edSAlex Elder static bool ipa_cmd_register_write_offset_valid(struct ipa *ipa,
232731c46edSAlex Elder 						const char *name, u32 offset)
233731c46edSAlex Elder {
234731c46edSAlex Elder 	struct ipa_cmd_register_write *payload;
235731c46edSAlex Elder 	struct device *dev = &ipa->pdev->dev;
236731c46edSAlex Elder 	u32 offset_max;
237731c46edSAlex Elder 	u32 bit_count;
238731c46edSAlex Elder 
239731c46edSAlex Elder 	/* The maximum offset in a register_write immediate command depends
240731c46edSAlex Elder 	 * on the version of IPA.  IPA v3.5.1 supports a 16 bit offset, but
241731c46edSAlex Elder 	 * newer versions allow some additional high-order bits.
242731c46edSAlex Elder 	 */
243731c46edSAlex Elder 	bit_count = BITS_PER_BYTE * sizeof(payload->offset);
244731c46edSAlex Elder 	if (ipa->version != IPA_VERSION_3_5_1)
245731c46edSAlex Elder 		bit_count += hweight32(REGISTER_WRITE_FLAGS_OFFSET_HIGH_FMASK);
246731c46edSAlex Elder 	BUILD_BUG_ON(bit_count > 32);
247731c46edSAlex Elder 	offset_max = ~0 >> (32 - bit_count);
248731c46edSAlex Elder 
249731c46edSAlex Elder 	if (offset > offset_max || ipa->mem_offset > offset_max - offset) {
250731c46edSAlex Elder 		dev_err(dev, "%s offset too large 0x%04x + 0x%04x > 0x%04x)\n",
251731c46edSAlex Elder 				ipa->mem_offset + offset, offset_max);
252731c46edSAlex Elder 		return false;
253731c46edSAlex Elder 	}
254731c46edSAlex Elder 
255731c46edSAlex Elder 	return true;
256731c46edSAlex Elder }
257731c46edSAlex Elder 
258731c46edSAlex Elder /* Check whether offsets passed to register_write are valid */
259731c46edSAlex Elder static bool ipa_cmd_register_write_valid(struct ipa *ipa)
260731c46edSAlex Elder {
261731c46edSAlex Elder 	const char *name;
262731c46edSAlex Elder 	u32 offset;
263731c46edSAlex Elder 
264731c46edSAlex Elder 	offset = ipa_reg_filt_rout_hash_flush_offset(ipa->version);
265731c46edSAlex Elder 	name = "filter/route hash flush";
266731c46edSAlex Elder 	if (!ipa_cmd_register_write_offset_valid(ipa, name, offset))
267731c46edSAlex Elder 		return false;
268731c46edSAlex Elder 
269731c46edSAlex Elder 	offset = IPA_REG_ENDP_STATUS_N_OFFSET(IPA_ENDPOINT_COUNT);
270731c46edSAlex Elder 	name = "maximal endpoint status";
271731c46edSAlex Elder 	if (!ipa_cmd_register_write_offset_valid(ipa, name, offset))
272731c46edSAlex Elder 		return false;
273731c46edSAlex Elder 
274731c46edSAlex Elder 	return true;
275731c46edSAlex Elder }
276731c46edSAlex Elder 
277731c46edSAlex Elder bool ipa_cmd_data_valid(struct ipa *ipa)
278731c46edSAlex Elder {
279731c46edSAlex Elder 	if (!ipa_cmd_header_valid(ipa))
280731c46edSAlex Elder 		return false;
281731c46edSAlex Elder 
282731c46edSAlex Elder 	if (!ipa_cmd_register_write_valid(ipa))
283731c46edSAlex Elder 		return false;
284731c46edSAlex Elder 
285731c46edSAlex Elder 	return true;
286731c46edSAlex Elder }
287731c46edSAlex Elder 
288731c46edSAlex Elder #endif /* IPA_VALIDATE */
289731c46edSAlex Elder 
290731c46edSAlex Elder int ipa_cmd_pool_init(struct gsi_channel *channel, u32 tre_max)
291731c46edSAlex Elder {
292731c46edSAlex Elder 	struct gsi_trans_info *trans_info = &channel->trans_info;
293731c46edSAlex Elder 	struct device *dev = channel->gsi->dev;
294731c46edSAlex Elder 	int ret;
295731c46edSAlex Elder 
296731c46edSAlex Elder 	/* This is as good a place as any to validate build constants */
297731c46edSAlex Elder 	ipa_cmd_validate_build();
298731c46edSAlex Elder 
299731c46edSAlex Elder 	/* Even though command payloads are allocated one at a time,
300731c46edSAlex Elder 	 * a single transaction can require up to tlv_count of them,
301731c46edSAlex Elder 	 * so we treat them as if that many can be allocated at once.
302731c46edSAlex Elder 	 */
303731c46edSAlex Elder 	ret = gsi_trans_pool_init_dma(dev, &trans_info->cmd_pool,
304731c46edSAlex Elder 				      sizeof(union ipa_cmd_payload),
305731c46edSAlex Elder 				      tre_max, channel->tlv_count);
306731c46edSAlex Elder 	if (ret)
307731c46edSAlex Elder 		return ret;
308731c46edSAlex Elder 
309731c46edSAlex Elder 	/* Each TRE needs a command info structure */
310731c46edSAlex Elder 	ret = gsi_trans_pool_init(&trans_info->info_pool,
311731c46edSAlex Elder 				   sizeof(struct ipa_cmd_info),
312731c46edSAlex Elder 				   tre_max, channel->tlv_count);
313731c46edSAlex Elder 	if (ret)
314731c46edSAlex Elder 		gsi_trans_pool_exit_dma(dev, &trans_info->cmd_pool);
315731c46edSAlex Elder 
316731c46edSAlex Elder 	return ret;
317731c46edSAlex Elder }
318731c46edSAlex Elder 
319731c46edSAlex Elder void ipa_cmd_pool_exit(struct gsi_channel *channel)
320731c46edSAlex Elder {
321731c46edSAlex Elder 	struct gsi_trans_info *trans_info = &channel->trans_info;
322731c46edSAlex Elder 	struct device *dev = channel->gsi->dev;
323731c46edSAlex Elder 
324731c46edSAlex Elder 	gsi_trans_pool_exit(&trans_info->info_pool);
325731c46edSAlex Elder 	gsi_trans_pool_exit_dma(dev, &trans_info->cmd_pool);
326731c46edSAlex Elder }
327731c46edSAlex Elder 
328731c46edSAlex Elder static union ipa_cmd_payload *
329731c46edSAlex Elder ipa_cmd_payload_alloc(struct ipa *ipa, dma_addr_t *addr)
330731c46edSAlex Elder {
331731c46edSAlex Elder 	struct gsi_trans_info *trans_info;
332731c46edSAlex Elder 	struct ipa_endpoint *endpoint;
333731c46edSAlex Elder 
334731c46edSAlex Elder 	endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
335731c46edSAlex Elder 	trans_info = &ipa->gsi.channel[endpoint->channel_id].trans_info;
336731c46edSAlex Elder 
337731c46edSAlex Elder 	return gsi_trans_pool_alloc_dma(&trans_info->cmd_pool, addr);
338731c46edSAlex Elder }
339731c46edSAlex Elder 
340731c46edSAlex Elder /* If hash_size is 0, hash_offset and hash_addr ignored. */
341731c46edSAlex Elder void ipa_cmd_table_init_add(struct gsi_trans *trans,
342731c46edSAlex Elder 			    enum ipa_cmd_opcode opcode, u16 size, u32 offset,
343731c46edSAlex Elder 			    dma_addr_t addr, u16 hash_size, u32 hash_offset,
344731c46edSAlex Elder 			    dma_addr_t hash_addr)
345731c46edSAlex Elder {
346731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
347731c46edSAlex Elder 	enum dma_data_direction direction = DMA_TO_DEVICE;
348731c46edSAlex Elder 	struct ipa_cmd_hw_ip_fltrt_init *payload;
349731c46edSAlex Elder 	union ipa_cmd_payload *cmd_payload;
350731c46edSAlex Elder 	dma_addr_t payload_addr;
351731c46edSAlex Elder 	u64 val;
352731c46edSAlex Elder 
353731c46edSAlex Elder 	/* Record the non-hash table offset and size */
354731c46edSAlex Elder 	offset += ipa->mem_offset;
355731c46edSAlex Elder 	val = u64_encode_bits(offset, IP_FLTRT_FLAGS_NHASH_ADDR_FMASK);
356731c46edSAlex Elder 	val |= u64_encode_bits(size, IP_FLTRT_FLAGS_NHASH_SIZE_FMASK);
357731c46edSAlex Elder 
358731c46edSAlex Elder 	/* The hash table offset and address are zero if its size is 0 */
359731c46edSAlex Elder 	if (hash_size) {
360731c46edSAlex Elder 		/* Record the hash table offset and size */
361731c46edSAlex Elder 		hash_offset += ipa->mem_offset;
362731c46edSAlex Elder 		val |= u64_encode_bits(hash_offset,
363731c46edSAlex Elder 				       IP_FLTRT_FLAGS_HASH_ADDR_FMASK);
364731c46edSAlex Elder 		val |= u64_encode_bits(hash_size,
365731c46edSAlex Elder 				       IP_FLTRT_FLAGS_HASH_SIZE_FMASK);
366731c46edSAlex Elder 	}
367731c46edSAlex Elder 
368731c46edSAlex Elder 	cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
369731c46edSAlex Elder 	payload = &cmd_payload->table_init;
370731c46edSAlex Elder 
371731c46edSAlex Elder 	/* Fill in all offsets and sizes and the non-hash table address */
372731c46edSAlex Elder 	if (hash_size)
373731c46edSAlex Elder 		payload->hash_rules_addr = cpu_to_le64(hash_addr);
374731c46edSAlex Elder 	payload->flags = cpu_to_le64(val);
375731c46edSAlex Elder 	payload->nhash_rules_addr = cpu_to_le64(addr);
376731c46edSAlex Elder 
377731c46edSAlex Elder 	gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
378731c46edSAlex Elder 			  direction, opcode);
379731c46edSAlex Elder }
380731c46edSAlex Elder 
381731c46edSAlex Elder /* Initialize header space in IPA-local memory */
382731c46edSAlex Elder void ipa_cmd_hdr_init_local_add(struct gsi_trans *trans, u32 offset, u16 size,
383731c46edSAlex Elder 				dma_addr_t addr)
384731c46edSAlex Elder {
385731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
386731c46edSAlex Elder 	enum ipa_cmd_opcode opcode = IPA_CMD_HDR_INIT_LOCAL;
387731c46edSAlex Elder 	enum dma_data_direction direction = DMA_TO_DEVICE;
388731c46edSAlex Elder 	struct ipa_cmd_hw_hdr_init_local *payload;
389731c46edSAlex Elder 	union ipa_cmd_payload *cmd_payload;
390731c46edSAlex Elder 	dma_addr_t payload_addr;
391731c46edSAlex Elder 	u32 flags;
392731c46edSAlex Elder 
393731c46edSAlex Elder 	offset += ipa->mem_offset;
394731c46edSAlex Elder 
395731c46edSAlex Elder 	/* With this command we tell the IPA where in its local memory the
396731c46edSAlex Elder 	 * header tables reside.  The content of the buffer provided is
397731c46edSAlex Elder 	 * also written via DMA into that space.  The IPA hardware owns
398731c46edSAlex Elder 	 * the table, but the AP must initialize it.
399731c46edSAlex Elder 	 */
400731c46edSAlex Elder 	cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
401731c46edSAlex Elder 	payload = &cmd_payload->hdr_init_local;
402731c46edSAlex Elder 
403731c46edSAlex Elder 	payload->hdr_table_addr = cpu_to_le64(addr);
404731c46edSAlex Elder 	flags = u32_encode_bits(size, HDR_INIT_LOCAL_FLAGS_TABLE_SIZE_FMASK);
405731c46edSAlex Elder 	flags |= u32_encode_bits(offset, HDR_INIT_LOCAL_FLAGS_HDR_ADDR_FMASK);
406731c46edSAlex Elder 	payload->flags = cpu_to_le32(flags);
407731c46edSAlex Elder 
408731c46edSAlex Elder 	gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
409731c46edSAlex Elder 			  direction, opcode);
410731c46edSAlex Elder }
411731c46edSAlex Elder 
412731c46edSAlex Elder void ipa_cmd_register_write_add(struct gsi_trans *trans, u32 offset, u32 value,
413731c46edSAlex Elder 				u32 mask, bool clear_full)
414731c46edSAlex Elder {
415731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
416731c46edSAlex Elder 	struct ipa_cmd_register_write *payload;
417731c46edSAlex Elder 	union ipa_cmd_payload *cmd_payload;
418731c46edSAlex Elder 	u32 opcode = IPA_CMD_REGISTER_WRITE;
419731c46edSAlex Elder 	dma_addr_t payload_addr;
420731c46edSAlex Elder 	u32 clear_option;
421731c46edSAlex Elder 	u32 options;
422731c46edSAlex Elder 	u16 flags;
423731c46edSAlex Elder 
424731c46edSAlex Elder 	/* pipeline_clear_src_grp is not used */
425731c46edSAlex Elder 	clear_option = clear_full ? pipeline_clear_full : pipeline_clear_hps;
426731c46edSAlex Elder 
427731c46edSAlex Elder 	if (ipa->version != IPA_VERSION_3_5_1) {
428731c46edSAlex Elder 		u16 offset_high;
429731c46edSAlex Elder 		u32 val;
430731c46edSAlex Elder 
431731c46edSAlex Elder 		/* Opcode encodes pipeline clear options */
432731c46edSAlex Elder 		/* SKIP_CLEAR is always 0 (don't skip pipeline clear) */
433731c46edSAlex Elder 		val = u16_encode_bits(clear_option,
434731c46edSAlex Elder 				      REGISTER_WRITE_OPCODE_CLEAR_OPTION_FMASK);
435731c46edSAlex Elder 		opcode |= val;
436731c46edSAlex Elder 
437731c46edSAlex Elder 		/* Extract the high 4 bits from the offset */
438731c46edSAlex Elder 		offset_high = (u16)u32_get_bits(offset, GENMASK(19, 16));
439731c46edSAlex Elder 		offset &= (1 << 16) - 1;
440731c46edSAlex Elder 
441731c46edSAlex Elder 		/* Extract the top 4 bits and encode it into the flags field */
442731c46edSAlex Elder 		flags = u16_encode_bits(offset_high,
443731c46edSAlex Elder 				REGISTER_WRITE_FLAGS_OFFSET_HIGH_FMASK);
444731c46edSAlex Elder 		options = 0;	/* reserved */
445731c46edSAlex Elder 
446731c46edSAlex Elder 	} else {
447731c46edSAlex Elder 		flags = 0;	/* SKIP_CLEAR flag is always 0 */
448731c46edSAlex Elder 		options = u16_encode_bits(clear_option,
449731c46edSAlex Elder 					  REGISTER_WRITE_CLEAR_OPTIONS_FMASK);
450731c46edSAlex Elder 	}
451731c46edSAlex Elder 
452731c46edSAlex Elder 	cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
453731c46edSAlex Elder 	payload = &cmd_payload->register_write;
454731c46edSAlex Elder 
455731c46edSAlex Elder 	payload->flags = cpu_to_le16(flags);
456731c46edSAlex Elder 	payload->offset = cpu_to_le16((u16)offset);
457731c46edSAlex Elder 	payload->value = cpu_to_le32(value);
458731c46edSAlex Elder 	payload->value_mask = cpu_to_le32(mask);
459731c46edSAlex Elder 	payload->clear_options = cpu_to_le32(options);
460731c46edSAlex Elder 
461731c46edSAlex Elder 	gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
462731c46edSAlex Elder 			  DMA_NONE, opcode);
463731c46edSAlex Elder }
464731c46edSAlex Elder 
465731c46edSAlex Elder /* Skip IP packet processing on the next data transfer on a TX channel */
466731c46edSAlex Elder static void ipa_cmd_ip_packet_init_add(struct gsi_trans *trans, u8 endpoint_id)
467731c46edSAlex Elder {
468731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
469731c46edSAlex Elder 	enum ipa_cmd_opcode opcode = IPA_CMD_IP_PACKET_INIT;
470731c46edSAlex Elder 	enum dma_data_direction direction = DMA_TO_DEVICE;
471731c46edSAlex Elder 	struct ipa_cmd_ip_packet_init *payload;
472731c46edSAlex Elder 	union ipa_cmd_payload *cmd_payload;
473731c46edSAlex Elder 	dma_addr_t payload_addr;
474731c46edSAlex Elder 
475731c46edSAlex Elder 	/* assert(endpoint_id <
476731c46edSAlex Elder 		  field_max(IPA_PACKET_INIT_DEST_ENDPOINT_FMASK)); */
477731c46edSAlex Elder 
478731c46edSAlex Elder 	cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
479731c46edSAlex Elder 	payload = &cmd_payload->ip_packet_init;
480731c46edSAlex Elder 
481731c46edSAlex Elder 	payload->dest_endpoint = u8_encode_bits(endpoint_id,
482731c46edSAlex Elder 					IPA_PACKET_INIT_DEST_ENDPOINT_FMASK);
483731c46edSAlex Elder 
484731c46edSAlex Elder 	gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
485731c46edSAlex Elder 			  direction, opcode);
486731c46edSAlex Elder }
487731c46edSAlex Elder 
488731c46edSAlex Elder /* Use a DMA command to read or write a block of IPA-resident memory */
489731c46edSAlex Elder void ipa_cmd_dma_shared_mem_add(struct gsi_trans *trans, u32 offset, u16 size,
490731c46edSAlex Elder 				dma_addr_t addr, bool toward_ipa)
491731c46edSAlex Elder {
492731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
493731c46edSAlex Elder 	enum ipa_cmd_opcode opcode = IPA_CMD_DMA_SHARED_MEM;
494731c46edSAlex Elder 	struct ipa_cmd_hw_dma_mem_mem *payload;
495731c46edSAlex Elder 	union ipa_cmd_payload *cmd_payload;
496731c46edSAlex Elder 	enum dma_data_direction direction;
497731c46edSAlex Elder 	dma_addr_t payload_addr;
498731c46edSAlex Elder 	u16 flags;
499731c46edSAlex Elder 
500731c46edSAlex Elder 	/* size and offset must fit in 16 bit fields */
501731c46edSAlex Elder 	/* assert(size > 0 && size <= U16_MAX); */
502731c46edSAlex Elder 	/* assert(offset <= U16_MAX && ipa->mem_offset <= U16_MAX - offset); */
503731c46edSAlex Elder 
504731c46edSAlex Elder 	offset += ipa->mem_offset;
505731c46edSAlex Elder 
506731c46edSAlex Elder 	cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
507731c46edSAlex Elder 	payload = &cmd_payload->dma_shared_mem;
508731c46edSAlex Elder 
509731c46edSAlex Elder 	/* payload->clear_after_read was reserved prior to IPA v4.0.  It's
510731c46edSAlex Elder 	 * never needed for current code, so it's 0 regardless of version.
511731c46edSAlex Elder 	 */
512731c46edSAlex Elder 	payload->size = cpu_to_le16(size);
513731c46edSAlex Elder 	payload->local_addr = cpu_to_le16(offset);
514731c46edSAlex Elder 	/* payload->flags:
515731c46edSAlex Elder 	 *   direction:		0 = write to IPA, 1 read from IPA
516731c46edSAlex Elder 	 * Starting at v4.0 these are reserved; either way, all zero:
517731c46edSAlex Elder 	 *   pipeline clear:	0 = wait for pipeline clear (don't skip)
518731c46edSAlex Elder 	 *   clear_options:	0 = pipeline_clear_hps
519731c46edSAlex Elder 	 * Instead, for v4.0+ these are encoded in the opcode.  But again
520731c46edSAlex Elder 	 * since both values are 0 we won't bother OR'ing them in.
521731c46edSAlex Elder 	 */
522731c46edSAlex Elder 	flags = toward_ipa ? 0 : DMA_SHARED_MEM_FLAGS_DIRECTION_FMASK;
523731c46edSAlex Elder 	payload->flags = cpu_to_le16(flags);
524731c46edSAlex Elder 	payload->system_addr = cpu_to_le64(addr);
525731c46edSAlex Elder 
526731c46edSAlex Elder 	direction = toward_ipa ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
527731c46edSAlex Elder 
528731c46edSAlex Elder 	gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
529731c46edSAlex Elder 			  direction, opcode);
530731c46edSAlex Elder }
531731c46edSAlex Elder 
532731c46edSAlex Elder static void ipa_cmd_ip_tag_status_add(struct gsi_trans *trans, u64 tag)
533731c46edSAlex Elder {
534731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
535731c46edSAlex Elder 	enum ipa_cmd_opcode opcode = IPA_CMD_IP_PACKET_TAG_STATUS;
536731c46edSAlex Elder 	enum dma_data_direction direction = DMA_TO_DEVICE;
537731c46edSAlex Elder 	struct ipa_cmd_ip_packet_tag_status *payload;
538731c46edSAlex Elder 	union ipa_cmd_payload *cmd_payload;
539731c46edSAlex Elder 	dma_addr_t payload_addr;
540731c46edSAlex Elder 
541731c46edSAlex Elder 	/* assert(tag <= field_max(IP_PACKET_TAG_STATUS_TAG_FMASK)); */
542731c46edSAlex Elder 
543731c46edSAlex Elder 	cmd_payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
544731c46edSAlex Elder 	payload = &cmd_payload->ip_packet_tag_status;
545731c46edSAlex Elder 
546731c46edSAlex Elder 	payload->tag = u64_encode_bits(tag, IP_PACKET_TAG_STATUS_TAG_FMASK);
547731c46edSAlex Elder 
548731c46edSAlex Elder 	gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
549731c46edSAlex Elder 			  direction, opcode);
550731c46edSAlex Elder }
551731c46edSAlex Elder 
552731c46edSAlex Elder /* Issue a small command TX data transfer */
553731c46edSAlex Elder static void ipa_cmd_transfer_add(struct gsi_trans *trans, u16 size)
554731c46edSAlex Elder {
555731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
556731c46edSAlex Elder 	enum dma_data_direction direction = DMA_TO_DEVICE;
557731c46edSAlex Elder 	enum ipa_cmd_opcode opcode = IPA_CMD_NONE;
558731c46edSAlex Elder 	union ipa_cmd_payload *payload;
559731c46edSAlex Elder 	dma_addr_t payload_addr;
560731c46edSAlex Elder 
561731c46edSAlex Elder 	/* assert(size <= sizeof(*payload)); */
562731c46edSAlex Elder 
563731c46edSAlex Elder 	/* Just transfer a zero-filled payload structure */
564731c46edSAlex Elder 	payload = ipa_cmd_payload_alloc(ipa, &payload_addr);
565731c46edSAlex Elder 
566731c46edSAlex Elder 	gsi_trans_cmd_add(trans, payload, sizeof(*payload), payload_addr,
567731c46edSAlex Elder 			  direction, opcode);
568731c46edSAlex Elder }
569731c46edSAlex Elder 
570731c46edSAlex Elder void ipa_cmd_tag_process_add(struct gsi_trans *trans)
571731c46edSAlex Elder {
572731c46edSAlex Elder 	struct ipa *ipa = container_of(trans->gsi, struct ipa, gsi);
5732c4bb809SAlex Elder 	struct ipa_endpoint *endpoint;
574731c46edSAlex Elder 
575731c46edSAlex Elder 	endpoint = ipa->name_map[IPA_ENDPOINT_AP_LAN_RX];
5762c4bb809SAlex Elder 
5772c4bb809SAlex Elder 	ipa_cmd_register_write_add(trans, 0, 0, 0, true);
578731c46edSAlex Elder 	ipa_cmd_ip_packet_init_add(trans, endpoint->endpoint_id);
579731c46edSAlex Elder 	ipa_cmd_ip_tag_status_add(trans, 0xcba987654321);
580731c46edSAlex Elder 	ipa_cmd_transfer_add(trans, 4);
581731c46edSAlex Elder }
582731c46edSAlex Elder 
583731c46edSAlex Elder /* Returns the number of commands required for the tag process */
584731c46edSAlex Elder u32 ipa_cmd_tag_process_count(void)
585731c46edSAlex Elder {
586731c46edSAlex Elder 	return 4;
587731c46edSAlex Elder }
588731c46edSAlex Elder 
5896cb63ea6SAlex Elder void ipa_cmd_tag_process(struct ipa *ipa)
5906cb63ea6SAlex Elder {
5916cb63ea6SAlex Elder 	u32 count = ipa_cmd_tag_process_count();
5926cb63ea6SAlex Elder 	struct gsi_trans *trans;
5936cb63ea6SAlex Elder 
5946cb63ea6SAlex Elder 	trans = ipa_cmd_trans_alloc(ipa, count);
5956cb63ea6SAlex Elder 	if (trans) {
5966cb63ea6SAlex Elder 		ipa_cmd_tag_process_add(trans);
5976cb63ea6SAlex Elder 		gsi_trans_commit_wait(trans);
5986cb63ea6SAlex Elder 	} else {
5996cb63ea6SAlex Elder 		dev_err(&ipa->pdev->dev,
6006cb63ea6SAlex Elder 			"error allocating %u entry tag transaction\n", count);
6016cb63ea6SAlex Elder 	}
6026cb63ea6SAlex Elder }
6036cb63ea6SAlex Elder 
604731c46edSAlex Elder static struct ipa_cmd_info *
605731c46edSAlex Elder ipa_cmd_info_alloc(struct ipa_endpoint *endpoint, u32 tre_count)
606731c46edSAlex Elder {
607731c46edSAlex Elder 	struct gsi_channel *channel;
608731c46edSAlex Elder 
609731c46edSAlex Elder 	channel = &endpoint->ipa->gsi.channel[endpoint->channel_id];
610731c46edSAlex Elder 
611731c46edSAlex Elder 	return gsi_trans_pool_alloc(&channel->trans_info.info_pool, tre_count);
612731c46edSAlex Elder }
613731c46edSAlex Elder 
614731c46edSAlex Elder /* Allocate a transaction for the command TX endpoint */
615731c46edSAlex Elder struct gsi_trans *ipa_cmd_trans_alloc(struct ipa *ipa, u32 tre_count)
616731c46edSAlex Elder {
617731c46edSAlex Elder 	struct ipa_endpoint *endpoint;
618731c46edSAlex Elder 	struct gsi_trans *trans;
619731c46edSAlex Elder 
620731c46edSAlex Elder 	endpoint = ipa->name_map[IPA_ENDPOINT_AP_COMMAND_TX];
621731c46edSAlex Elder 
622731c46edSAlex Elder 	trans = gsi_channel_trans_alloc(&ipa->gsi, endpoint->channel_id,
623731c46edSAlex Elder 					tre_count, DMA_NONE);
624731c46edSAlex Elder 	if (trans)
625731c46edSAlex Elder 		trans->info = ipa_cmd_info_alloc(endpoint, tre_count);
626731c46edSAlex Elder 
627731c46edSAlex Elder 	return trans;
628731c46edSAlex Elder }
629