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-2022 Linaro Ltd.
10 #include <linux/dma-direction.h>
15 struct ipa;
21  * enum ipa_cmd_opcode:	IPA immediate commands
27  * @IPA_CMD_HDR_INIT_LOCAL:	Initialize IPA-local header memory
28  * @IPA_CMD_REGISTER_WRITE:	Register write performed by IPA
30  * @IPA_CMD_DMA_SHARED_MEM:	DMA command performed by IPA
50  * ipa_cmd_table_init_valid() - Validate a memory region holding a table
51  * @ipa:	- IPA pointer
52  * @mem:	- IPA memory region descriptor
53  * @route:	- Whether the region holds a route or filter table
57 bool ipa_cmd_table_init_valid(struct ipa *ipa, const struct ipa_mem *mem,
61  * ipa_cmd_data_valid() - Validate command-realted configuration is valid
62  * @ipa:	- IPA pointer
66 bool ipa_cmd_data_valid(struct ipa *ipa);
69  * ipa_cmd_pool_init() - initialize command channel pools
70  * @channel:	AP->IPA command TX GSI channel pointer
78  * ipa_cmd_pool_exit() - Inverse of ipa_cmd_pool_init()
79  * @channel:	AP->IPA command TX GSI channel pointer
84  * ipa_cmd_table_init_add() - Add table init command to a transaction
86  * @opcode:	IPA immediate command opcode
87  * @size:	Size of non-hashed routing table memory
88  * @offset:	Offset in IPA shared memory of non-hashed routing table memory
89  * @addr:	DMA address of non-hashed table data to write
91  * @hash_offset: Offset in IPA shared memory of hashed routing table memory
102  * ipa_cmd_hdr_init_local_add() - Add a header init command to a transaction
104  * @offset:	Offset of header memory in IPA local space
108  * Defines and fills the location in IPA memory to use for headers.
114  * ipa_cmd_register_write_add() - Add a register write command to a transaction
125  * ipa_cmd_dma_shared_mem_add() - Add a DMA memory command to a transaction
127  * @offset:	Offset of IPA memory to be read or written
130  * @toward_ipa:	true means write to IPA memory; false means read
136  * ipa_cmd_pipeline_clear_add() - Add pipeline clear commands to a transaction
142  * ipa_cmd_pipeline_clear_count() - # commands required to clear pipeline
150  * ipa_cmd_pipeline_clear_wait() - Wait pipeline clear to complete
151  * @ipa:	- IPA pointer
153 void ipa_cmd_pipeline_clear_wait(struct ipa *ipa);
156  * ipa_cmd_trans_alloc() - Allocate a transaction for the command TX endpoint
157  * @ipa:	IPA pointer
163 struct gsi_trans *ipa_cmd_trans_alloc(struct ipa *ipa, u32 tre_count);
166  * ipa_cmd_init() - Initialize IPA immediate commands
167  * @ipa:	- IPA pointer
173 int ipa_cmd_init(struct ipa *ipa);