1/* SPDX-License-Identifier: GPL-2.0 */
2
3/* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2019-2024 Linaro Ltd.
5 */
6#ifndef _IPA_CMD_H_
7#define _IPA_CMD_H_
8
9#include <linux/types.h>
10
11struct gsi_channel;
12struct gsi_trans;
13struct ipa;
14struct ipa_mem;
15
16/**
17 * enum ipa_cmd_opcode: IPA immediate commands
18 *
19 * @IPA_CMD_IP_V4_FILTER_INIT: Initialize IPv4 filter table
20 * @IPA_CMD_IP_V6_FILTER_INIT: Initialize IPv6 filter table
21 * @IPA_CMD_IP_V4_ROUTING_INIT: Initialize IPv4 routing table
22 * @IPA_CMD_IP_V6_ROUTING_INIT: Initialize IPv6 routing table
23 * @IPA_CMD_HDR_INIT_LOCAL: Initialize IPA-local header memory
24 * @IPA_CMD_REGISTER_WRITE: Register write performed by IPA
25 * @IPA_CMD_IP_PACKET_INIT: Set up next packet's destination endpoint
26 * @IPA_CMD_DMA_SHARED_MEM: DMA command performed by IPA
27 * @IPA_CMD_IP_PACKET_TAG_STATUS: Have next packet generate tag * status
28 * @IPA_CMD_NONE: Special (invalid) "not a command" value
29 *
30 * All immediate commands are issued using the AP command TX endpoint.
31 */
32enum ipa_cmd_opcode {
33 IPA_CMD_NONE = 0x0,
34 IPA_CMD_IP_V4_FILTER_INIT = 0x3,
35 IPA_CMD_IP_V6_FILTER_INIT = 0x4,
36 IPA_CMD_IP_V4_ROUTING_INIT = 0x7,
37 IPA_CMD_IP_V6_ROUTING_INIT = 0x8,
38 IPA_CMD_HDR_INIT_LOCAL = 0x9,
39 IPA_CMD_REGISTER_WRITE = 0xc,
40 IPA_CMD_IP_PACKET_INIT = 0x10,
41 IPA_CMD_DMA_SHARED_MEM = 0x13,
42 IPA_CMD_IP_PACKET_TAG_STATUS = 0x14,
43};
44
45/**
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
50 *
51 * Return: true if region is valid, false otherwise
52 */
53bool ipa_cmd_table_init_valid(struct ipa *ipa, const struct ipa_mem *mem,
54 bool route);
55
56/**
57 * ipa_cmd_pool_init() - initialize command channel pools
58 * @channel: AP->IPA command TX GSI channel pointer
59 * @tre_count: Number of pool elements to allocate
60 *
61 * Return: 0 if successful, or a negative error code
62 */
63int ipa_cmd_pool_init(struct gsi_channel *channel, u32 tre_count);
64
65/**
66 * ipa_cmd_pool_exit() - Inverse of ipa_cmd_pool_init()
67 * @channel: AP->IPA command TX GSI channel pointer
68 */
69void ipa_cmd_pool_exit(struct gsi_channel *channel);
70
71/**
72 * ipa_cmd_table_init_add() - Add table init command to a transaction
73 * @trans: GSI 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
78 * @hash_size: Size of hashed routing table memory
79 * @hash_offset: Offset in IPA shared memory of hashed routing table memory
80 * @hash_addr: DMA address of hashed table data to write
81 *
82 * If hash_size is 0, hash_offset and hash_addr are ignored.
83 */
84void ipa_cmd_table_init_add(struct gsi_trans *trans, enum ipa_cmd_opcode opcode,
85 u16 size, u32 offset, dma_addr_t addr,
86 u16 hash_size, u32 hash_offset,
87 dma_addr_t hash_addr);
88
89/**
90 * ipa_cmd_hdr_init_local_add() - Add a header init command to a transaction
91 * @trans: GSI transaction
92 * @offset: Offset of header memory in IPA local space
93 * @size: Size of header memory
94 * @addr: DMA address of buffer to be written from
95 *
96 * Defines and fills the location in IPA memory to use for headers.
97 */
98void ipa_cmd_hdr_init_local_add(struct gsi_trans *trans, u32 offset, u16 size,
99 dma_addr_t addr);
100
101/**
102 * ipa_cmd_register_write_add() - Add a register write command to a transaction
103 * @trans: GSI transaction
104 * @offset: Offset of register to be written
105 * @value: Value to be written
106 * @mask: Mask of bits in register to update with bits from value
107 * @clear_full: Pipeline clear option; true means full pipeline clear
108 */
109void ipa_cmd_register_write_add(struct gsi_trans *trans, u32 offset, u32 value,
110 u32 mask, bool clear_full);
111
112/**
113 * ipa_cmd_dma_shared_mem_add() - Add a DMA memory command to a transaction
114 * @trans: GSI transaction
115 * @offset: Offset of IPA memory to be read or written
116 * @size: Number of bytes of memory to be transferred
117 * @addr: DMA address of buffer to be read into or written from
118 * @toward_ipa: true means write to IPA memory; false means read
119 */
120void ipa_cmd_dma_shared_mem_add(struct gsi_trans *trans, u32 offset,
121 u16 size, dma_addr_t addr, bool toward_ipa);
122
123/**
124 * ipa_cmd_pipeline_clear_add() - Add pipeline clear commands to a transaction
125 * @trans: GSI transaction
126 */
127void ipa_cmd_pipeline_clear_add(struct gsi_trans *trans);
128
129/**
130 * ipa_cmd_pipeline_clear_count() - # commands required to clear pipeline
131 *
132 * Return: The number of elements to allocate in a transaction
133 * to hold commands to clear the pipeline
134 */
135u32 ipa_cmd_pipeline_clear_count(void);
136
137/**
138 * ipa_cmd_pipeline_clear_wait() - Wait pipeline clear to complete
139 * @ipa: - IPA pointer
140 */
141void ipa_cmd_pipeline_clear_wait(struct ipa *ipa);
142
143/**
144 * ipa_cmd_trans_alloc() - Allocate a transaction for the command TX endpoint
145 * @ipa: IPA pointer
146 * @tre_count: Number of elements in the transaction
147 *
148 * Return: A GSI transaction structure, or a null pointer if all
149 * available transactions are in use
150 */
151struct gsi_trans *ipa_cmd_trans_alloc(struct ipa *ipa, u32 tre_count);
152
153/**
154 * ipa_cmd_init() - Initialize IPA immediate commands
155 * @ipa: - IPA pointer
156 *
157 * Return: 0 if successful, or a negative error code
158 *
159 * There is no need for a matching ipa_cmd_exit() function.
160 */
161int ipa_cmd_init(struct ipa *ipa);
162
163#endif /* _IPA_CMD_H_ */
164

source code of linux/drivers/net/ipa/ipa_cmd.h