xref: /linux-6.15/drivers/net/ipa/ipa_table.h (revision 8defab8b)
12b9feef2SAlex Elder /* SPDX-License-Identifier: GPL-2.0 */
22b9feef2SAlex Elder 
32b9feef2SAlex Elder /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4a4388da5SAlex Elder  * Copyright (C) 2019-2022 Linaro Ltd.
52b9feef2SAlex Elder  */
62b9feef2SAlex Elder #ifndef _IPA_TABLE_H_
72b9feef2SAlex Elder #define _IPA_TABLE_H_
82b9feef2SAlex Elder 
92b9feef2SAlex Elder #include <linux/types.h>
102b9feef2SAlex Elder 
112b9feef2SAlex Elder struct ipa;
122b9feef2SAlex Elder 
132b9feef2SAlex Elder /* The maximum number of filter table entries (IPv4, IPv6; hashed or not) */
142b9feef2SAlex Elder #define IPA_FILTER_COUNT_MAX	14
152b9feef2SAlex Elder 
162b9feef2SAlex Elder /**
172b9feef2SAlex Elder  * ipa_filter_map_valid() - Validate a filter table endpoint bitmap
182b9feef2SAlex Elder  * @ipa:	IPA pointer
19862d3f2cSAlex Elder  * @filter_mask: Filter table endpoint bitmap to check
202b9feef2SAlex Elder  *
21e3eea08eSAlex Elder  * Return:	true if all regions are valid, false otherwise
222b9feef2SAlex Elder  */
232b9feef2SAlex Elder bool ipa_filter_map_valid(struct ipa *ipa, u32 filter_mask);
242b9feef2SAlex Elder 
252b9feef2SAlex Elder /**
26a266ad6bSAlex Elder  * ipa_table_hash_support() - Return true if hashed tables are supported
27a266ad6bSAlex Elder  * @ipa:	IPA pointer
28a266ad6bSAlex Elder  */
290f13b5e6SAlex Elder static inline bool ipa_table_hash_support(struct ipa *ipa)
300f13b5e6SAlex Elder {
310f13b5e6SAlex Elder 	return ipa->version != IPA_VERSION_4_2;
320f13b5e6SAlex Elder }
33a266ad6bSAlex Elder 
34a266ad6bSAlex Elder /**
352b9feef2SAlex Elder  * ipa_table_reset() - Reset filter and route tables entries to "none"
362b9feef2SAlex Elder  * @ipa:	IPA pointer
372b9feef2SAlex Elder  * @modem:	Whether to reset modem or AP entries
382b9feef2SAlex Elder  */
392b9feef2SAlex Elder void ipa_table_reset(struct ipa *ipa, bool modem);
402b9feef2SAlex Elder 
412b9feef2SAlex Elder /**
422b9feef2SAlex Elder  * ipa_table_hash_flush() - Synchronize hashed filter and route updates
432b9feef2SAlex Elder  * @ipa:	IPA pointer
442b9feef2SAlex Elder  */
452b9feef2SAlex Elder int ipa_table_hash_flush(struct ipa *ipa);
462b9feef2SAlex Elder 
472b9feef2SAlex Elder /**
482b9feef2SAlex Elder  * ipa_table_setup() - Set up filter and route tables
492b9feef2SAlex Elder  * @ipa:	IPA pointer
5074858b63SAlex Elder  *
5174858b63SAlex Elder  * There is no need for a matching ipa_table_teardown() function.
522b9feef2SAlex Elder  */
532b9feef2SAlex Elder int ipa_table_setup(struct ipa *ipa);
542b9feef2SAlex Elder 
552b9feef2SAlex Elder /**
562b9feef2SAlex Elder  * ipa_table_config() - Configure filter and route tables
572b9feef2SAlex Elder  * @ipa:	IPA pointer
5874858b63SAlex Elder  *
5974858b63SAlex Elder  * There is no need for a matching ipa_table_deconfig() function.
602b9feef2SAlex Elder  */
612b9feef2SAlex Elder void ipa_table_config(struct ipa *ipa);
622b9feef2SAlex Elder 
632b9feef2SAlex Elder /**
642b9feef2SAlex Elder  * ipa_table_init() - Do early initialization of filter and route tables
652b9feef2SAlex Elder  * @ipa:	IPA pointer
662b9feef2SAlex Elder  */
672b9feef2SAlex Elder int ipa_table_init(struct ipa *ipa);
682b9feef2SAlex Elder 
692b9feef2SAlex Elder /**
702b9feef2SAlex Elder  * ipa_table_exit() - Inverse of ipa_table_init()
712b9feef2SAlex Elder  * @ipa:	IPA pointer
722b9feef2SAlex Elder  */
732b9feef2SAlex Elder void ipa_table_exit(struct ipa *ipa);
742b9feef2SAlex Elder 
7573da9cacSAlex Elder /**
7673da9cacSAlex Elder  * ipa_table_mem_valid() - Validate sizes of table memory regions
7773da9cacSAlex Elder  * @ipa:	IPA pointer
78*8defab8bSAlex Elder  * @filter:	Whether to check filter or routing tables
7973da9cacSAlex Elder  */
80*8defab8bSAlex Elder bool ipa_table_mem_valid(struct ipa *ipa, bool filter);
8173da9cacSAlex Elder 
822b9feef2SAlex Elder #endif /* _IPA_TABLE_H_ */
83