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