xref: /openbmc/linux/drivers/net/ipa/ipa_table.h (revision 43ffe817)
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_TABLE_H_
7 #define _IPA_TABLE_H_
8 
9 #include <linux/types.h>
10 
11 struct ipa;
12 
13 /* The size of a filter or route table entry */
14 #define IPA_TABLE_ENTRY_SIZE	sizeof(__le64)	/* Holds a physical address */
15 
16 /* The maximum number of filter table entries (IPv4, IPv6; hashed or not) */
17 #define IPA_FILTER_COUNT_MAX	14
18 
19 /* The maximum number of route table entries (IPv4, IPv6; hashed or not) */
20 #define IPA_ROUTE_COUNT_MAX	15
21 
22 #ifdef IPA_VALIDATE
23 
24 /**
25  * ipa_table_valid() - Validate route and filter table memory regions
26  * @ipa:	IPA pointer
27 
28  * Return:	true if all regions are valid, false otherwise
29  */
30 bool ipa_table_valid(struct ipa *ipa);
31 
32 /**
33  * ipa_filter_map_valid() - Validate a filter table endpoint bitmap
34  * @ipa:	IPA pointer
35  *
36  * Return:	true if all regions are valid, false otherwise
37  */
38 bool ipa_filter_map_valid(struct ipa *ipa, u32 filter_mask);
39 
40 #else /* !IPA_VALIDATE */
41 
42 static inline bool ipa_table_valid(struct ipa *ipa)
43 {
44 	return true;
45 }
46 
47 static inline bool ipa_filter_map_valid(struct ipa *ipa, u32 filter_mask)
48 {
49 	return true;
50 }
51 
52 #endif /* !IPA_VALIDATE */
53 
54 /**
55  * ipa_table_reset() - Reset filter and route tables entries to "none"
56  * @ipa:	IPA pointer
57  * @modem:	Whether to reset modem or AP entries
58  */
59 void ipa_table_reset(struct ipa *ipa, bool modem);
60 
61 /**
62  * ipa_table_hash_flush() - Synchronize hashed filter and route updates
63  * @ipa:	IPA pointer
64  */
65 int ipa_table_hash_flush(struct ipa *ipa);
66 
67 /**
68  * ipa_table_setup() - Set up filter and route tables
69  * @ipa:	IPA pointer
70  */
71 int ipa_table_setup(struct ipa *ipa);
72 
73 /**
74  * ipa_table_teardown() - Inverse of ipa_table_setup()
75  * @ipa:	IPA pointer
76  */
77 void ipa_table_teardown(struct ipa *ipa);
78 
79 /**
80  * ipa_table_config() - Configure filter and route tables
81  * @ipa:	IPA pointer
82  */
83 void ipa_table_config(struct ipa *ipa);
84 
85 /**
86  * ipa_table_deconfig() - Inverse of ipa_table_config()
87  * @ipa:	IPA pointer
88  */
89 void ipa_table_deconfig(struct ipa *ipa);
90 
91 /**
92  * ipa_table_init() - Do early initialization of filter and route tables
93  * @ipa:	IPA pointer
94  */
95 int ipa_table_init(struct ipa *ipa);
96 
97 /**
98  * ipa_table_exit() - Inverse of ipa_table_init()
99  * @ipa:	IPA pointer
100  */
101 void ipa_table_exit(struct ipa *ipa);
102 
103 #endif /* _IPA_TABLE_H_ */
104