xref: /linux/drivers/net/ethernet/netronome/nfp/bpf/fw.h (revision f412eed9dfdeeb6becd7de2ffe8b5d0a8b3f81ca)
1 /*
2  * Copyright (C) 2017-2018 Netronome Systems, Inc.
3  *
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.
8  *
9  * The BSD 2-Clause License:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      1. Redistributions of source code must retain the above
16  *         copyright notice, this list of conditions and the following
17  *         disclaimer.
18  *
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.
23  *
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
31  * SOFTWARE.
32  */
33 
34 #ifndef NFP_BPF_FW_H
35 #define NFP_BPF_FW_H 1
36 
37 #include <linux/bitops.h>
38 #include <linux/types.h>
39 
40 /* Kernel's enum bpf_reg_type is not uABI so people may change it breaking
41  * our FW ABI.  In that case we will do translation in the driver.
42  */
43 #define NFP_BPF_SCALAR_VALUE		1
44 #define NFP_BPF_MAP_VALUE		4
45 #define NFP_BPF_STACK			6
46 #define NFP_BPF_PACKET_DATA		8
47 
48 enum bpf_cap_tlv_type {
49 	NFP_BPF_CAP_TYPE_FUNC		= 1,
50 	NFP_BPF_CAP_TYPE_ADJUST_HEAD	= 2,
51 	NFP_BPF_CAP_TYPE_MAPS		= 3,
52 	NFP_BPF_CAP_TYPE_RANDOM		= 4,
53 };
54 
55 struct nfp_bpf_cap_tlv_func {
56 	__le32 func_id;
57 	__le32 func_addr;
58 };
59 
60 struct nfp_bpf_cap_tlv_adjust_head {
61 	__le32 flags;
62 	__le32 off_min;
63 	__le32 off_max;
64 	__le32 guaranteed_sub;
65 	__le32 guaranteed_add;
66 };
67 
68 #define NFP_BPF_ADJUST_HEAD_NO_META	BIT(0)
69 
70 struct nfp_bpf_cap_tlv_maps {
71 	__le32 types;
72 	__le32 max_maps;
73 	__le32 max_elems;
74 	__le32 max_key_sz;
75 	__le32 max_val_sz;
76 	__le32 max_elem_sz;
77 };
78 
79 /*
80  * Types defined for map related control messages
81  */
82 #define CMSG_MAP_ABI_VERSION		1
83 
84 enum nfp_bpf_cmsg_type {
85 	CMSG_TYPE_MAP_ALLOC	= 1,
86 	CMSG_TYPE_MAP_FREE	= 2,
87 	CMSG_TYPE_MAP_LOOKUP	= 3,
88 	CMSG_TYPE_MAP_UPDATE	= 4,
89 	CMSG_TYPE_MAP_DELETE	= 5,
90 	CMSG_TYPE_MAP_GETNEXT	= 6,
91 	CMSG_TYPE_MAP_GETFIRST	= 7,
92 	CMSG_TYPE_BPF_EVENT	= 8,
93 	__CMSG_TYPE_MAP_MAX,
94 };
95 
96 #define CMSG_TYPE_MAP_REPLY_BIT		7
97 #define __CMSG_REPLY(req)		(BIT(CMSG_TYPE_MAP_REPLY_BIT) | (req))
98 
99 #define CMSG_MAP_KEY_LW			16
100 #define CMSG_MAP_VALUE_LW		16
101 
102 enum nfp_bpf_cmsg_status {
103 	CMSG_RC_SUCCESS			= 0,
104 	CMSG_RC_ERR_MAP_FD		= 1,
105 	CMSG_RC_ERR_MAP_NOENT		= 2,
106 	CMSG_RC_ERR_MAP_ERR		= 3,
107 	CMSG_RC_ERR_MAP_PARSE		= 4,
108 	CMSG_RC_ERR_MAP_EXIST		= 5,
109 	CMSG_RC_ERR_MAP_NOMEM		= 6,
110 	CMSG_RC_ERR_MAP_E2BIG		= 7,
111 };
112 
113 struct cmsg_hdr {
114 	u8 type;
115 	u8 ver;
116 	__be16 tag;
117 };
118 
119 struct cmsg_reply_map_simple {
120 	struct cmsg_hdr hdr;
121 	__be32 rc;
122 };
123 
124 struct cmsg_req_map_alloc_tbl {
125 	struct cmsg_hdr hdr;
126 	__be32 key_size;		/* in bytes */
127 	__be32 value_size;		/* in bytes */
128 	__be32 max_entries;
129 	__be32 map_type;
130 	__be32 map_flags;		/* reserved */
131 };
132 
133 struct cmsg_reply_map_alloc_tbl {
134 	struct cmsg_reply_map_simple reply_hdr;
135 	__be32 tid;
136 };
137 
138 struct cmsg_req_map_free_tbl {
139 	struct cmsg_hdr hdr;
140 	__be32 tid;
141 };
142 
143 struct cmsg_reply_map_free_tbl {
144 	struct cmsg_reply_map_simple reply_hdr;
145 	__be32 count;
146 };
147 
148 struct cmsg_key_value_pair {
149 	__be32 key[CMSG_MAP_KEY_LW];
150 	__be32 value[CMSG_MAP_VALUE_LW];
151 };
152 
153 struct cmsg_req_map_op {
154 	struct cmsg_hdr hdr;
155 	__be32 tid;
156 	__be32 count;
157 	__be32 flags;
158 	struct cmsg_key_value_pair elem[0];
159 };
160 
161 struct cmsg_reply_map_op {
162 	struct cmsg_reply_map_simple reply_hdr;
163 	__be32 count;
164 	__be32 resv;
165 	struct cmsg_key_value_pair elem[0];
166 };
167 
168 struct cmsg_bpf_event {
169 	struct cmsg_hdr hdr;
170 	__be32 cpu_id;
171 	__be64 map_ptr;
172 	__be32 data_size;
173 	__be32 pkt_size;
174 	u8 data[0];
175 };
176 #endif
177