2 * Copyright (C) 2017 Netronome Systems, Inc.
4 * This software is dual licensed under the GNU General License Version 2,
5 * June 1991 as shown in the file COPYING in the top-level directory of this
6 * source tree or the BSD 2-Clause License provided below. You have the
7 * option to license this software under the complete terms of either license.
9 * The BSD 2-Clause License:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * 1. Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
19 * 2. Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials
22 * provided with the distribution.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 #ifndef __NFP_FLOWER_H__
35 #define __NFP_FLOWER_H__ 1
39 #include <linux/circ_buf.h>
40 #include <linux/hashtable.h>
41 #include <linux/time64.h>
42 #include <linux/types.h>
43 #include <net/pkt_cls.h>
45 #include <linux/workqueue.h>
50 #define NFP_FL_STATS_ENTRY_RS BIT(20)
51 #define NFP_FL_STATS_ELEM_RS 4
52 #define NFP_FL_REPEATED_HASH_MAX BIT(17)
53 #define NFP_FLOWER_HASH_BITS 19
54 #define NFP_FLOWER_MASK_ENTRY_RS 256
55 #define NFP_FLOWER_MASK_ELEMENT_RS 1
56 #define NFP_FLOWER_MASK_HASH_BITS 10
58 #define NFP_FL_META_FLAG_MANAGE_MASK BIT(7)
60 #define NFP_FL_MASK_REUSE_TIME_NS 40000
61 #define NFP_FL_MASK_ID_LOCATION 1
63 #define NFP_FL_VXLAN_PORT 4789
64 #define NFP_FL_GENEVE_PORT 6081
66 /* Extra features bitmap. */
67 #define NFP_FL_FEATS_GENEVE BIT(0)
68 #define NFP_FL_NBI_MTU_SETTING BIT(1)
70 struct nfp_fl_mask_id {
71 struct circ_buf mask_id_free_list;
72 struct timespec64 *last_used;
76 struct nfp_fl_stats_id {
77 struct circ_buf free_list;
83 * struct nfp_mtu_conf - manage MTU setting
84 * @portnum: NFP port number of repr with requested MTU change
85 * @requested_val: MTU value requested for repr
86 * @ack: Received ack that MTU has been correctly set
87 * @wait_q: Wait queue for MTU acknowledgements
88 * @lock: Lock for setting/reading MTU variables
92 unsigned int requested_val;
94 wait_queue_head_t wait_q;
99 * struct nfp_flower_priv - Flower APP per-vNIC priv data
100 * @app: Back pointer to app
101 * @nn: Pointer to vNIC
102 * @mask_id_seed: Seed used for mask hash table
103 * @flower_version: HW version of flower
104 * @flower_ext_feats: Bitmap of extra features the HW supports
105 * @stats_ids: List of free stats ids
106 * @mask_ids: List of free mask ids
107 * @mask_table: Hash table used to store masks
108 * @flow_table: Hash table used to store flower rules
109 * @cmsg_work: Workqueue for control messages processing
110 * @cmsg_skbs_high: List of higher priority skbs for control message
112 * @cmsg_skbs_low: List of lower priority skbs for control message
114 * @nfp_mac_off_list: List of MAC addresses to offload
115 * @nfp_mac_index_list: List of unique 8-bit indexes for non NFP netdevs
116 * @nfp_ipv4_off_list: List of IPv4 addresses to offload
117 * @nfp_neigh_off_list: List of neighbour offloads
118 * @nfp_mac_off_lock: Lock for the MAC address list
119 * @nfp_mac_index_lock: Lock for the MAC index list
120 * @nfp_ipv4_off_lock: Lock for the IPv4 address list
121 * @nfp_neigh_off_lock: Lock for the neighbour address list
122 * @nfp_mac_off_ids: IDA to manage id assignment for offloaded macs
123 * @nfp_mac_off_count: Number of MACs in address list
124 * @nfp_tun_mac_nb: Notifier to monitor link state
125 * @nfp_tun_neigh_nb: Notifier to monitor neighbour state
126 * @reify_replies: atomically stores the number of replies received
127 * from firmware for repr reify
128 * @reify_wait_queue: wait queue for repr reify response counting
129 * @mtu_conf: Configuration of repr MTU value
131 struct nfp_flower_priv {
136 u64 flower_ext_feats;
137 struct nfp_fl_stats_id stats_ids;
138 struct nfp_fl_mask_id mask_ids;
139 DECLARE_HASHTABLE(mask_table, NFP_FLOWER_MASK_HASH_BITS);
140 DECLARE_HASHTABLE(flow_table, NFP_FLOWER_HASH_BITS);
141 struct work_struct cmsg_work;
142 struct sk_buff_head cmsg_skbs_high;
143 struct sk_buff_head cmsg_skbs_low;
144 struct list_head nfp_mac_off_list;
145 struct list_head nfp_mac_index_list;
146 struct list_head nfp_ipv4_off_list;
147 struct list_head nfp_neigh_off_list;
148 struct mutex nfp_mac_off_lock;
149 struct mutex nfp_mac_index_lock;
150 struct mutex nfp_ipv4_off_lock;
151 spinlock_t nfp_neigh_off_lock;
152 struct ida nfp_mac_off_ids;
153 int nfp_mac_off_count;
154 struct notifier_block nfp_tun_mac_nb;
155 struct notifier_block nfp_tun_neigh_nb;
156 atomic_t reify_replies;
157 wait_queue_head_t reify_wait_queue;
158 struct nfp_mtu_conf mtu_conf;
161 struct nfp_fl_key_ls {
167 struct nfp_fl_rule_metadata {
173 __be64 host_cookie __packed;
174 __be64 flow_version __packed;
178 struct nfp_fl_stats {
184 struct nfp_fl_payload {
185 struct nfp_fl_rule_metadata meta;
186 unsigned long tc_flower_cookie;
187 struct hlist_node link;
189 spinlock_t lock; /* lock stats */
190 struct nfp_fl_stats stats;
191 __be32 nfp_tun_ipv4_addr;
197 struct nfp_fl_stats_frame {
204 int nfp_flower_metadata_init(struct nfp_app *app);
205 void nfp_flower_metadata_cleanup(struct nfp_app *app);
207 int nfp_flower_setup_tc(struct nfp_app *app, struct net_device *netdev,
208 enum tc_setup_type type, void *type_data);
209 int nfp_flower_compile_flow_match(struct tc_cls_flower_offload *flow,
210 struct nfp_fl_key_ls *key_ls,
211 struct net_device *netdev,
212 struct nfp_fl_payload *nfp_flow,
213 enum nfp_flower_tun_type tun_type);
214 int nfp_flower_compile_action(struct tc_cls_flower_offload *flow,
215 struct net_device *netdev,
216 struct nfp_fl_payload *nfp_flow);
217 int nfp_compile_flow_metadata(struct nfp_app *app,
218 struct tc_cls_flower_offload *flow,
219 struct nfp_fl_payload *nfp_flow);
220 int nfp_modify_flow_metadata(struct nfp_app *app,
221 struct nfp_fl_payload *nfp_flow);
223 struct nfp_fl_payload *
224 nfp_flower_search_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
225 struct nfp_fl_payload *
226 nfp_flower_remove_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
228 void nfp_flower_rx_flow_stats(struct nfp_app *app, struct sk_buff *skb);
230 int nfp_tunnel_config_start(struct nfp_app *app);
231 void nfp_tunnel_config_stop(struct nfp_app *app);
232 void nfp_tunnel_write_macs(struct nfp_app *app);
233 void nfp_tunnel_del_ipv4_off(struct nfp_app *app, __be32 ipv4);
234 void nfp_tunnel_add_ipv4_off(struct nfp_app *app, __be32 ipv4);
235 void nfp_tunnel_request_route(struct nfp_app *app, struct sk_buff *skb);
236 void nfp_tunnel_keep_alive(struct nfp_app *app, struct sk_buff *skb);
237 int nfp_flower_setup_tc_egress_cb(enum tc_setup_type type, void *type_data,