1 /* 2 * Copyright (C) 2017 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_APP_H 35 #define _NFP_APP_H 1 36 37 #include <net/devlink.h> 38 39 #include <trace/events/devlink.h> 40 41 #include "nfp_net_repr.h" 42 43 struct bpf_prog; 44 struct net_device; 45 struct netdev_bpf; 46 struct netlink_ext_ack; 47 struct pci_dev; 48 struct sk_buff; 49 struct sk_buff; 50 struct nfp_app; 51 struct nfp_cpp; 52 struct nfp_pf; 53 struct nfp_repr; 54 struct nfp_net; 55 56 enum nfp_app_id { 57 NFP_APP_CORE_NIC = 0x1, 58 NFP_APP_BPF_NIC = 0x2, 59 NFP_APP_FLOWER_NIC = 0x3, 60 NFP_APP_ACTIVE_BUFFER_MGMT_NIC = 0x4, 61 }; 62 63 extern const struct nfp_app_type app_nic; 64 extern const struct nfp_app_type app_bpf; 65 extern const struct nfp_app_type app_flower; 66 extern const struct nfp_app_type app_abm; 67 68 /** 69 * struct nfp_app_type - application definition 70 * @id: application ID 71 * @name: application name 72 * @ctrl_cap_mask: ctrl vNIC capability mask, allows disabling features like 73 * IRQMOD which are on by default but counter-productive for 74 * control messages which are often latency-sensitive 75 * @ctrl_has_meta: control messages have prepend of type:5/port:CTRL 76 * 77 * Callbacks 78 * @init: perform basic app checks and init 79 * @clean: clean app state 80 * @extra_cap: extra capabilities string 81 * @vnic_alloc: allocate vNICs (assign port types, etc.) 82 * @vnic_free: free up app's vNIC state 83 * @vnic_init: vNIC netdev was registered 84 * @vnic_clean: vNIC netdev about to be unregistered 85 * @repr_init: representor about to be registered 86 * @repr_preclean: representor about to unregistered, executed before app 87 * reference to the it is removed 88 * @repr_clean: representor about to be unregistered 89 * @repr_open: representor netdev open callback 90 * @repr_stop: representor netdev stop callback 91 * @check_mtu: MTU change request on a netdev (verify it is valid) 92 * @repr_change_mtu: MTU change request on repr (make and verify change) 93 * @port_get_stats: get extra ethtool statistics for a port 94 * @port_get_stats_count: get count of extra statistics for a port 95 * @port_get_stats_strings: get strings for extra statistics 96 * @start: start application logic 97 * @stop: stop application logic 98 * @ctrl_msg_rx: control message handler 99 * @setup_tc: setup TC ndo 100 * @bpf: BPF ndo offload-related calls 101 * @xdp_offload: offload an XDP program 102 * @eswitch_mode_get: get SR-IOV eswitch mode 103 * @eswitch_mode_set: set SR-IOV eswitch mode (under pf->lock) 104 * @sriov_enable: app-specific sriov initialisation 105 * @sriov_disable: app-specific sriov clean-up 106 * @repr_get: get representor netdev 107 */ 108 struct nfp_app_type { 109 enum nfp_app_id id; 110 const char *name; 111 112 u32 ctrl_cap_mask; 113 bool ctrl_has_meta; 114 115 int (*init)(struct nfp_app *app); 116 void (*clean)(struct nfp_app *app); 117 118 const char *(*extra_cap)(struct nfp_app *app, struct nfp_net *nn); 119 120 int (*vnic_alloc)(struct nfp_app *app, struct nfp_net *nn, 121 unsigned int id); 122 void (*vnic_free)(struct nfp_app *app, struct nfp_net *nn); 123 int (*vnic_init)(struct nfp_app *app, struct nfp_net *nn); 124 void (*vnic_clean)(struct nfp_app *app, struct nfp_net *nn); 125 126 int (*repr_init)(struct nfp_app *app, struct net_device *netdev); 127 void (*repr_preclean)(struct nfp_app *app, struct net_device *netdev); 128 void (*repr_clean)(struct nfp_app *app, struct net_device *netdev); 129 130 int (*repr_open)(struct nfp_app *app, struct nfp_repr *repr); 131 int (*repr_stop)(struct nfp_app *app, struct nfp_repr *repr); 132 133 int (*check_mtu)(struct nfp_app *app, struct net_device *netdev, 134 int new_mtu); 135 int (*repr_change_mtu)(struct nfp_app *app, struct net_device *netdev, 136 int new_mtu); 137 138 u64 *(*port_get_stats)(struct nfp_app *app, 139 struct nfp_port *port, u64 *data); 140 int (*port_get_stats_count)(struct nfp_app *app, struct nfp_port *port); 141 u8 *(*port_get_stats_strings)(struct nfp_app *app, 142 struct nfp_port *port, u8 *data); 143 144 int (*start)(struct nfp_app *app); 145 void (*stop)(struct nfp_app *app); 146 147 void (*ctrl_msg_rx)(struct nfp_app *app, struct sk_buff *skb); 148 149 int (*setup_tc)(struct nfp_app *app, struct net_device *netdev, 150 enum tc_setup_type type, void *type_data); 151 int (*bpf)(struct nfp_app *app, struct nfp_net *nn, 152 struct netdev_bpf *xdp); 153 int (*xdp_offload)(struct nfp_app *app, struct nfp_net *nn, 154 struct bpf_prog *prog, 155 struct netlink_ext_ack *extack); 156 157 int (*sriov_enable)(struct nfp_app *app, int num_vfs); 158 void (*sriov_disable)(struct nfp_app *app); 159 160 enum devlink_eswitch_mode (*eswitch_mode_get)(struct nfp_app *app); 161 int (*eswitch_mode_set)(struct nfp_app *app, u16 mode); 162 struct net_device *(*repr_get)(struct nfp_app *app, u32 id); 163 }; 164 165 /** 166 * struct nfp_app - NFP application container 167 * @pdev: backpointer to PCI device 168 * @pf: backpointer to NFP PF structure 169 * @cpp: pointer to the CPP handle 170 * @ctrl: pointer to ctrl vNIC struct 171 * @reprs: array of pointers to representors 172 * @type: pointer to const application ops and info 173 * @priv: app-specific priv data 174 */ 175 struct nfp_app { 176 struct pci_dev *pdev; 177 struct nfp_pf *pf; 178 struct nfp_cpp *cpp; 179 180 struct nfp_net *ctrl; 181 struct nfp_reprs __rcu *reprs[NFP_REPR_TYPE_MAX + 1]; 182 183 const struct nfp_app_type *type; 184 void *priv; 185 }; 186 187 bool __nfp_ctrl_tx(struct nfp_net *nn, struct sk_buff *skb); 188 bool nfp_ctrl_tx(struct nfp_net *nn, struct sk_buff *skb); 189 190 static inline int nfp_app_init(struct nfp_app *app) 191 { 192 if (!app->type->init) 193 return 0; 194 return app->type->init(app); 195 } 196 197 static inline void nfp_app_clean(struct nfp_app *app) 198 { 199 if (app->type->clean) 200 app->type->clean(app); 201 } 202 203 static inline int nfp_app_vnic_alloc(struct nfp_app *app, struct nfp_net *nn, 204 unsigned int id) 205 { 206 return app->type->vnic_alloc(app, nn, id); 207 } 208 209 static inline void nfp_app_vnic_free(struct nfp_app *app, struct nfp_net *nn) 210 { 211 if (app->type->vnic_free) 212 app->type->vnic_free(app, nn); 213 } 214 215 static inline int nfp_app_vnic_init(struct nfp_app *app, struct nfp_net *nn) 216 { 217 if (!app->type->vnic_init) 218 return 0; 219 return app->type->vnic_init(app, nn); 220 } 221 222 static inline void nfp_app_vnic_clean(struct nfp_app *app, struct nfp_net *nn) 223 { 224 if (app->type->vnic_clean) 225 app->type->vnic_clean(app, nn); 226 } 227 228 static inline int nfp_app_repr_open(struct nfp_app *app, struct nfp_repr *repr) 229 { 230 if (!app->type->repr_open) 231 return -EINVAL; 232 return app->type->repr_open(app, repr); 233 } 234 235 static inline int nfp_app_repr_stop(struct nfp_app *app, struct nfp_repr *repr) 236 { 237 if (!app->type->repr_stop) 238 return -EINVAL; 239 return app->type->repr_stop(app, repr); 240 } 241 242 static inline int 243 nfp_app_repr_init(struct nfp_app *app, struct net_device *netdev) 244 { 245 if (!app->type->repr_init) 246 return 0; 247 return app->type->repr_init(app, netdev); 248 } 249 250 static inline void 251 nfp_app_repr_preclean(struct nfp_app *app, struct net_device *netdev) 252 { 253 if (app->type->repr_preclean) 254 app->type->repr_preclean(app, netdev); 255 } 256 257 static inline void 258 nfp_app_repr_clean(struct nfp_app *app, struct net_device *netdev) 259 { 260 if (app->type->repr_clean) 261 app->type->repr_clean(app, netdev); 262 } 263 264 static inline int 265 nfp_app_check_mtu(struct nfp_app *app, struct net_device *netdev, int new_mtu) 266 { 267 if (!app || !app->type->check_mtu) 268 return 0; 269 return app->type->check_mtu(app, netdev, new_mtu); 270 } 271 272 static inline int 273 nfp_app_repr_change_mtu(struct nfp_app *app, struct net_device *netdev, 274 int new_mtu) 275 { 276 if (!app || !app->type->repr_change_mtu) 277 return 0; 278 return app->type->repr_change_mtu(app, netdev, new_mtu); 279 } 280 281 static inline int nfp_app_start(struct nfp_app *app, struct nfp_net *ctrl) 282 { 283 app->ctrl = ctrl; 284 if (!app->type->start) 285 return 0; 286 return app->type->start(app); 287 } 288 289 static inline void nfp_app_stop(struct nfp_app *app) 290 { 291 if (!app->type->stop) 292 return; 293 app->type->stop(app); 294 } 295 296 static inline const char *nfp_app_name(struct nfp_app *app) 297 { 298 if (!app) 299 return ""; 300 return app->type->name; 301 } 302 303 static inline bool nfp_app_needs_ctrl_vnic(struct nfp_app *app) 304 { 305 return app && app->type->ctrl_msg_rx; 306 } 307 308 static inline bool nfp_app_ctrl_has_meta(struct nfp_app *app) 309 { 310 return app->type->ctrl_has_meta; 311 } 312 313 static inline const char *nfp_app_extra_cap(struct nfp_app *app, 314 struct nfp_net *nn) 315 { 316 if (!app || !app->type->extra_cap) 317 return ""; 318 return app->type->extra_cap(app, nn); 319 } 320 321 static inline bool nfp_app_has_tc(struct nfp_app *app) 322 { 323 return app && app->type->setup_tc; 324 } 325 326 static inline int nfp_app_setup_tc(struct nfp_app *app, 327 struct net_device *netdev, 328 enum tc_setup_type type, void *type_data) 329 { 330 if (!app || !app->type->setup_tc) 331 return -EOPNOTSUPP; 332 return app->type->setup_tc(app, netdev, type, type_data); 333 } 334 335 static inline int nfp_app_bpf(struct nfp_app *app, struct nfp_net *nn, 336 struct netdev_bpf *bpf) 337 { 338 if (!app || !app->type->bpf) 339 return -EINVAL; 340 return app->type->bpf(app, nn, bpf); 341 } 342 343 static inline int nfp_app_xdp_offload(struct nfp_app *app, struct nfp_net *nn, 344 struct bpf_prog *prog, 345 struct netlink_ext_ack *extack) 346 { 347 if (!app || !app->type->xdp_offload) 348 return -EOPNOTSUPP; 349 return app->type->xdp_offload(app, nn, prog, extack); 350 } 351 352 static inline bool __nfp_app_ctrl_tx(struct nfp_app *app, struct sk_buff *skb) 353 { 354 trace_devlink_hwmsg(priv_to_devlink(app->pf), false, 0, 355 skb->data, skb->len); 356 357 return __nfp_ctrl_tx(app->ctrl, skb); 358 } 359 360 static inline bool nfp_app_ctrl_tx(struct nfp_app *app, struct sk_buff *skb) 361 { 362 trace_devlink_hwmsg(priv_to_devlink(app->pf), false, 0, 363 skb->data, skb->len); 364 365 return nfp_ctrl_tx(app->ctrl, skb); 366 } 367 368 static inline void nfp_app_ctrl_rx(struct nfp_app *app, struct sk_buff *skb) 369 { 370 trace_devlink_hwmsg(priv_to_devlink(app->pf), true, 0, 371 skb->data, skb->len); 372 373 app->type->ctrl_msg_rx(app, skb); 374 } 375 376 static inline int nfp_app_eswitch_mode_get(struct nfp_app *app, u16 *mode) 377 { 378 if (!app->type->eswitch_mode_get) 379 return -EOPNOTSUPP; 380 381 *mode = app->type->eswitch_mode_get(app); 382 383 return 0; 384 } 385 386 static inline int nfp_app_eswitch_mode_set(struct nfp_app *app, u16 mode) 387 { 388 if (!app->type->eswitch_mode_set) 389 return -EOPNOTSUPP; 390 return app->type->eswitch_mode_set(app, mode); 391 } 392 393 static inline int nfp_app_sriov_enable(struct nfp_app *app, int num_vfs) 394 { 395 if (!app || !app->type->sriov_enable) 396 return -EOPNOTSUPP; 397 return app->type->sriov_enable(app, num_vfs); 398 } 399 400 static inline void nfp_app_sriov_disable(struct nfp_app *app) 401 { 402 if (app && app->type->sriov_disable) 403 app->type->sriov_disable(app); 404 } 405 406 static inline struct net_device *nfp_app_repr_get(struct nfp_app *app, u32 id) 407 { 408 if (unlikely(!app || !app->type->repr_get)) 409 return NULL; 410 411 return app->type->repr_get(app, id); 412 } 413 414 struct nfp_app *nfp_app_from_netdev(struct net_device *netdev); 415 416 u64 *nfp_app_port_get_stats(struct nfp_port *port, u64 *data); 417 int nfp_app_port_get_stats_count(struct nfp_port *port); 418 u8 *nfp_app_port_get_stats_strings(struct nfp_port *port, u8 *data); 419 420 struct nfp_reprs * 421 nfp_reprs_get_locked(struct nfp_app *app, enum nfp_repr_type type); 422 struct nfp_reprs * 423 nfp_app_reprs_set(struct nfp_app *app, enum nfp_repr_type type, 424 struct nfp_reprs *reprs); 425 426 const char *nfp_app_mip_name(struct nfp_app *app); 427 struct sk_buff * 428 nfp_app_ctrl_msg_alloc(struct nfp_app *app, unsigned int size, gfp_t priority); 429 430 struct nfp_app *nfp_app_alloc(struct nfp_pf *pf, enum nfp_app_id id); 431 void nfp_app_free(struct nfp_app *app); 432 433 /* Callbacks shared between apps */ 434 435 int nfp_app_nic_vnic_alloc(struct nfp_app *app, struct nfp_net *nn, 436 unsigned int id); 437 int nfp_app_nic_vnic_init_phy_port(struct nfp_pf *pf, struct nfp_app *app, 438 struct nfp_net *nn, unsigned int id); 439 440 #endif 441