net/hinic: create and destroy flow director filter
[dpdk.git] / drivers / net / hinic / hinic_pmd_ethdev.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017 Huawei Technologies Co., Ltd
3  */
4
5 #ifndef _HINIC_PMD_ETHDEV_H_
6 #define _HINIC_PMD_ETHDEV_H_
7
8 #include <rte_ethdev.h>
9 #include <rte_ethdev_core.h>
10
11 #include "base/hinic_compat.h"
12 #include "base/hinic_pmd_cfg.h"
13
14 #define HINIC_DEV_NAME_LEN      32
15 #define HINIC_MAX_RX_QUEUES     64
16
17 /* mbuf pool for copy invalid mbuf segs */
18 #define HINIC_COPY_MEMPOOL_DEPTH        128
19 #define HINIC_COPY_MBUF_SIZE            4096
20
21 #define SIZE_8BYTES(size)       (ALIGN((u32)(size), 8) >> 3)
22
23 #define HINIC_ETH_DEV_TO_PRIVATE_NIC_DEV(dev) \
24         ((struct hinic_nic_dev *)(dev)->data->dev_private)
25
26 #define HINIC_MAX_QUEUE_DEPTH           4096
27 #define HINIC_MIN_QUEUE_DEPTH           128
28 #define HINIC_TXD_ALIGN                 1
29 #define HINIC_RXD_ALIGN                 1
30
31 #define HINIC_UINT32_BIT_SIZE      (CHAR_BIT * sizeof(uint32_t))
32 #define HINIC_VFTA_SIZE            (4096 / HINIC_UINT32_BIT_SIZE)
33
34 enum hinic_dev_status {
35         HINIC_DEV_INIT,
36         HINIC_DEV_CLOSE,
37         HINIC_DEV_START,
38         HINIC_DEV_INTR_EN,
39 };
40
41 #define HINIC_MAX_Q_FILTERS     64 /* hinic just support 64 filter types */
42 #define HINIC_PKT_TYPE_FIND_ID(pkt_type) ((pkt_type) - HINIC_MAX_Q_FILTERS)
43
44 /* 5tuple filter info */
45 struct hinic_5tuple_filter_info {
46         uint32_t dst_ip;
47         uint32_t src_ip;
48         uint16_t dst_port;
49         uint16_t src_port;
50         uint8_t proto; /* l4 protocol. */
51         /*
52          * seven levels (001b-111b), 111b is highest,
53          * used when more than one filter matches.
54          */
55         uint8_t priority;
56         uint8_t dst_ip_mask:1, /* if mask is 1b, do not compare dst ip. */
57                 src_ip_mask:1, /* if mask is 1b, do not compare src ip. */
58                 dst_port_mask:1, /* if mask is 1b, do not compare dst port. */
59                 src_port_mask:1, /* if mask is 1b, do not compare src port. */
60                 proto_mask:1; /* if mask is 1b, do not compare protocol. */
61 };
62
63 /* 5tuple filter structure */
64 struct hinic_5tuple_filter {
65         TAILQ_ENTRY(hinic_5tuple_filter) entries;
66         uint16_t index;       /* the index of 5tuple filter */
67         struct hinic_5tuple_filter_info filter_info;
68         uint16_t queue;       /* rx queue assigned to */
69 };
70
71 TAILQ_HEAD(hinic_5tuple_filter_list, hinic_5tuple_filter);
72
73 /*
74  * If this filter is added by configuration,
75  * it should not be removed.
76  */
77 struct hinic_pkt_filter {
78         uint16_t pkt_proto;
79         uint8_t qid;
80         bool    enable;
81 };
82
83 /* Structure to store filters' info. */
84 struct hinic_filter_info {
85         uint8_t pkt_type;
86         uint8_t qid;
87         uint64_t type_mask;  /* Bit mask for every used filter */
88         struct hinic_5tuple_filter_list fivetuple_list;
89         struct hinic_pkt_filter pkt_filters[HINIC_MAX_Q_FILTERS];
90 };
91
92 /* Information about the fdir mode. */
93 struct hinic_hw_fdir_mask {
94         uint32_t src_ipv4_mask;
95         uint32_t dst_ipv4_mask;
96         uint16_t src_port_mask;
97         uint16_t dst_port_mask;
98 };
99
100 /* Flow Director attribute */
101 struct hinic_atr_input {
102         u32 dst_ip;
103         u32 src_ip;
104         u16 src_port;
105         u16 dst_port;
106 };
107
108 struct hinic_fdir_rule {
109         struct hinic_hw_fdir_mask mask;
110         struct hinic_atr_input hinic_fdir; /* key of fdir filter */
111         uint8_t queue; /* queue assigned when matched */
112 };
113
114 /* ntuple filter list structure */
115 struct hinic_ntuple_filter_ele {
116         TAILQ_ENTRY(hinic_ntuple_filter_ele) entries;
117         struct rte_eth_ntuple_filter filter_info;
118 };
119
120 /* ethertype filter list structure */
121 struct hinic_ethertype_filter_ele {
122         TAILQ_ENTRY(hinic_ethertype_filter_ele) entries;
123         struct rte_eth_ethertype_filter filter_info;
124 };
125
126 /* fdir filter list structure */
127 struct hinic_fdir_rule_ele {
128         TAILQ_ENTRY(hinic_fdir_rule_ele) entries;
129         struct hinic_fdir_rule filter_info;
130 };
131
132 struct rte_flow {
133         enum rte_filter_type filter_type;
134         void *rule;
135 };
136
137 /* hinic_flow memory list structure */
138 struct hinic_flow_mem {
139         TAILQ_ENTRY(hinic_flow_mem) entries;
140         struct rte_flow *flow;
141 };
142
143 TAILQ_HEAD(hinic_ntuple_filter_list, hinic_ntuple_filter_ele);
144 TAILQ_HEAD(hinic_ethertype_filter_list, hinic_ethertype_filter_ele);
145 TAILQ_HEAD(hinic_fdir_rule_filter_list, hinic_fdir_rule_ele);
146 TAILQ_HEAD(hinic_flow_mem_list, hinic_flow_mem);
147
148 extern const struct rte_flow_ops hinic_flow_ops;
149
150 /* hinic nic_device */
151 struct hinic_nic_dev {
152         /* hardware device */
153         struct hinic_hwdev *hwdev;
154         struct hinic_txq **txqs;
155         struct hinic_rxq **rxqs;
156         struct rte_mempool *cpy_mpool;
157         u16 num_qps;
158         u16 num_sq;
159         u16 num_rq;
160         u16 mtu_size;
161         u8 rss_tmpl_idx;
162         u8 rss_indir_flag;
163         u8 num_rss;
164         u8 rx_queue_list[HINIC_MAX_RX_QUEUES];
165
166         u32 vfta[HINIC_VFTA_SIZE];      /* VLAN bitmap */
167
168         struct rte_ether_addr default_addr;
169         struct rte_ether_addr *mc_list;
170         /* info */
171         unsigned int flags;
172         struct nic_service_cap nic_cap;
173         u32 rx_mode_status;     /* promisc or allmulticast */
174         unsigned long dev_status;
175
176         /* dpdk only */
177         char proc_dev_name[HINIC_DEV_NAME_LEN];
178         /* PF0->COS4, PF1->COS5, PF2->COS6, PF3->COS7,
179          * vf: the same with associate pf
180          */
181         u32 default_cos;
182
183         struct hinic_filter_info    filter;
184         struct hinic_ntuple_filter_list filter_ntuple_list;
185         struct hinic_ethertype_filter_list filter_ethertype_list;
186         struct hinic_fdir_rule_filter_list filter_fdir_rule_list;
187         struct hinic_flow_mem_list hinic_flow_list;
188 };
189
190 #endif /* _HINIC_PMD_ETHDEV_H_ */