net/ipa/ipa_cmd.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4  * Copyright (C) 2019-2024 Linaro Ltd.
13 struct ipa;
17  * enum ipa_cmd_opcode:	IPA immediate commands
23  * @IPA_CMD_HDR_INIT_LOCAL:	Initialize IPA-local header memory
24  * @IPA_CMD_REGISTER_WRITE:	Register write performed by IPA
26  * @IPA_CMD_DMA_SHARED_MEM:	DMA command performed by IPA
46  * ipa_cmd_table_init_valid() - Validate a memory region holding a table
47  * @ipa:	- IPA pointer
48  * @mem:	- IPA memory region descriptor
49  * @route:	- Whether the region holds a route or filter table
53 bool ipa_cmd_table_init_valid(struct ipa *ipa, const struct ipa_mem *mem,
57  * ipa_cmd_pool_init() - initialize command channel pools
58  * @channel:	AP->IPA command TX GSI channel pointer
66  * ipa_cmd_pool_exit() - Inverse of ipa_cmd_pool_init()
67  * @channel:	AP->IPA command TX GSI channel pointer
72  * ipa_cmd_table_init_add() - Add table init command to a transaction
74  * @opcode:	IPA immediate command opcode
75  * @size:	Size of non-hashed routing table memory
76  * @offset:	Offset in IPA shared memory of non-hashed routing table memory
77  * @addr:	DMA address of non-hashed table data to write
79  * @hash_offset: Offset in IPA shared memory of hashed routing table memory
90  * ipa_cmd_hdr_init_local_add() - Add a header init command to a transaction
92  * @offset:	Offset of header memory in IPA local space
96  * Defines and fills the location in IPA memory to use for headers.
102  * ipa_cmd_register_write_add() - Add a register write command to a transaction
113  * ipa_cmd_dma_shared_mem_add() - Add a DMA memory command to a transaction
115  * @offset:	Offset of IPA memory to be read or written
118  * @toward_ipa:	true means write to IPA memory; false means read
124  * ipa_cmd_pipeline_clear_add() - Add pipeline clear commands to a transaction
130  * ipa_cmd_pipeline_clear_count() - # commands required to clear pipeline
138  * ipa_cmd_pipeline_clear_wait() - Wait pipeline clear to complete
139  * @ipa:	- IPA pointer
141 void ipa_cmd_pipeline_clear_wait(struct ipa *ipa);
144  * ipa_cmd_trans_alloc() - Allocate a transaction for the command TX endpoint
145  * @ipa:	IPA pointer
151 struct gsi_trans *ipa_cmd_trans_alloc(struct ipa *ipa, u32 tre_count);
154  * ipa_cmd_init() - Initialize IPA immediate commands
155  * @ipa:	- IPA pointer
161 int ipa_cmd_init(struct ipa *ipa);