/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
/* Copyright (C) 2017-2018 Netronome Systems, Inc. */

#ifndef _NFP_APP_H
#define _NFP_APP_H 1

#include <net/devlink.h>

#include <trace/events/devlink.h>

#include "nfp_net_repr.h"

#define NFP_APP_CTRL_MTU_MAX    U32_MAX

struct bpf_prog;
struct net_device;
struct netdev_bpf;
struct netlink_ext_ack;
struct pci_dev;
struct sk_buff;
struct nfp_app;
struct nfp_cpp;
struct nfp_pf;
struct nfp_repr;
struct nfp_net;

enum nfp_app_id {
        NFP_APP_CORE_NIC        = 0x1,
        NFP_APP_BPF_NIC         = 0x2,
        NFP_APP_FLOWER_NIC      = 0x3,
        NFP_APP_ACTIVE_BUFFER_MGMT_NIC = 0x4,
};

extern const struct nfp_app_type app_nic;
extern const struct nfp_app_type app_bpf;
extern const struct nfp_app_type app_flower;
extern const struct nfp_app_type app_abm;

/**
 * struct nfp_app_type - application definition
 * @id:         application ID
 * @name:       application name
 * @ctrl_cap_mask:  ctrl vNIC capability mask, allows disabling features like
 *                  IRQMOD which are on by default but counter-productive for
 *                  control messages which are often latency-sensitive
 * @ctrl_has_meta:  control messages have prepend of type:5/port:CTRL
 *
 * Callbacks
 * @init:       perform basic app checks and init
 * @clean:      clean app state
 * @extra_cap:  extra capabilities string
 * @ndo_init:   vNIC and repr netdev .ndo_init
 * @ndo_uninit: vNIC and repr netdev .ndo_unint
 * @vnic_alloc: allocate vNICs (assign port types, etc.)
 * @vnic_free:  free up app's vNIC state
 * @vnic_init:  vNIC netdev was registered
 * @vnic_clean: vNIC netdev about to be unregistered
 * @repr_init:  representor about to be registered
 * @repr_preclean:      representor about to unregistered, executed before app
 *                      reference to the it is removed
 * @repr_clean: representor about to be unregistered
 * @repr_open:  representor netdev open callback
 * @repr_stop:  representor netdev stop callback
 * @check_mtu:  MTU change request on a netdev (verify it is valid)
 * @repr_change_mtu:    MTU change request on repr (make and verify change)
 * @port_get_stats:             get extra ethtool statistics for a port
 * @port_get_stats_count:       get count of extra statistics for a port
 * @port_get_stats_strings:     get strings for extra statistics
 * @start:      start application logic
 * @stop:       stop application logic
 * @netdev_event:       Netdevice notifier event
 * @ctrl_msg_rx:    control message handler
 * @ctrl_msg_rx_raw:    handler for control messages from data queues
 * @setup_tc:   setup TC ndo
 * @bpf:        BPF ndo offload-related calls
 * @xdp_offload:    offload an XDP program
 * @eswitch_mode_get:    get SR-IOV eswitch mode
 * @eswitch_mode_set:    set SR-IOV eswitch mode
 * @sriov_enable: app-specific sriov initialisation
 * @sriov_disable: app-specific sriov clean-up
 * @dev_get:    get representor or internal port representing netdev
 */
struct nfp_app_type {
        enum nfp_app_id id;
        const char *name;

        u32 ctrl_cap_mask;
        bool ctrl_has_meta;

        int (*init)(struct nfp_app *app);
        void (*clean)(struct nfp_app *app);

        const char *(*extra_cap)(struct nfp_app *app, struct nfp_net *nn);

        int (*ndo_init)(struct nfp_app *app, struct net_device *netdev);
        void (*ndo_uninit)(struct nfp_app *app, struct net_device *netdev);

        int (*vnic_alloc)(struct nfp_app *app, struct nfp_net *nn,
                          unsigned int id);
        void (*vnic_free)(struct nfp_app *app, struct nfp_net *nn);
        int (*vnic_init)(struct nfp_app *app, struct nfp_net *nn);
        void (*vnic_clean)(struct nfp_app *app, struct nfp_net *nn);

        int (*repr_init)(struct nfp_app *app, struct net_device *netdev);
        void (*repr_preclean)(struct nfp_app *app, struct net_device *netdev);
        void (*repr_clean)(struct nfp_app *app, struct net_device *netdev);

        int (*repr_open)(struct nfp_app *app, struct nfp_repr *repr);
        int (*repr_stop)(struct nfp_app *app, struct nfp_repr *repr);

        int (*check_mtu)(struct nfp_app *app, struct net_device *netdev,
                         int new_mtu);
        int (*repr_change_mtu)(struct nfp_app *app, struct net_device *netdev,
                               int new_mtu);

        u64 *(*port_get_stats)(struct nfp_app *app,
                               struct nfp_port *port, u64 *data);
        int (*port_get_stats_count)(struct nfp_app *app, struct nfp_port *port);
        u8 *(*port_get_stats_strings)(struct nfp_app *app,
                                      struct nfp_port *port, u8 *data);

        int (*start)(struct nfp_app *app);
        void (*stop)(struct nfp_app *app);

        int (*netdev_event)(struct nfp_app *app, struct net_device *netdev,
                            unsigned long event, void *ptr);

        void (*ctrl_msg_rx)(struct nfp_app *app, struct sk_buff *skb);
        void (*ctrl_msg_rx_raw)(struct nfp_app *app, const void *data,
                                unsigned int len);

        int (*setup_tc)(struct nfp_app *app, struct net_device *netdev,
                        enum tc_setup_type type, void *type_data);
        int (*bpf)(struct nfp_app *app, struct nfp_net *nn,
                   struct netdev_bpf *xdp);
        int (*xdp_offload)(struct nfp_app *app, struct nfp_net *nn,
                           struct bpf_prog *prog,
                           struct netlink_ext_ack *extack);

        int (*sriov_enable)(struct nfp_app *app, int num_vfs);
        void (*sriov_disable)(struct nfp_app *app);

        enum devlink_eswitch_mode (*eswitch_mode_get)(struct nfp_app *app);
        int (*eswitch_mode_set)(struct nfp_app *app, u16 mode);
        struct net_device *(*dev_get)(struct nfp_app *app, u32 id,
                                      bool *redir_egress);
};

/**
 * struct nfp_app - NFP application container
 * @pdev:       backpointer to PCI device
 * @pf:         backpointer to NFP PF structure
 * @cpp:        pointer to the CPP handle
 * @ctrl:       pointer to ctrl vNIC struct
 * @reprs:      array of pointers to representors
 * @type:       pointer to const application ops and info
 * @ctrl_mtu:   MTU to set on the control vNIC (set in .init())
 * @netdev_nb:  Netdevice notifier block
 * @priv:       app-specific priv data
 */
struct nfp_app {
        struct pci_dev *pdev;
        struct nfp_pf *pf;
        struct nfp_cpp *cpp;

        struct nfp_net *ctrl;
        struct nfp_reprs __rcu *reprs[NFP_REPR_TYPE_MAX + 1];

        const struct nfp_app_type *type;
        unsigned int ctrl_mtu;

        struct notifier_block netdev_nb;

        void *priv;
};

static inline void assert_nfp_app_locked(struct nfp_app *app)
{
        devl_assert_locked(priv_to_devlink(app->pf));
}

static inline bool nfp_app_is_locked(struct nfp_app *app)
{
        return devl_lock_is_held(priv_to_devlink(app->pf));
}

void nfp_check_rhashtable_empty(void *ptr, void *arg);
bool __nfp_ctrl_tx(struct nfp_net *nn, struct sk_buff *skb);
bool nfp_ctrl_tx(struct nfp_net *nn, struct sk_buff *skb);

static inline int nfp_app_init(struct nfp_app *app)
{
        if (!app->type->init)
                return 0;
        return app->type->init(app);
}

static inline void nfp_app_clean(struct nfp_app *app)
{
        if (app->type->clean)
                app->type->clean(app);
}

int nfp_app_ndo_init(struct net_device *netdev);
void nfp_app_ndo_uninit(struct net_device *netdev);

static inline int nfp_app_vnic_alloc(struct nfp_app *app, struct nfp_net *nn,
                                     unsigned int id)
{
        return app->type->vnic_alloc(app, nn, id);
}

static inline void nfp_app_vnic_free(struct nfp_app *app, struct nfp_net *nn)
{
        if (app->type->vnic_free)
                app->type->vnic_free(app, nn);
}

static inline int nfp_app_vnic_init(struct nfp_app *app, struct nfp_net *nn)
{
        if (!app->type->vnic_init)
                return 0;
        return app->type->vnic_init(app, nn);
}

static inline void nfp_app_vnic_clean(struct nfp_app *app, struct nfp_net *nn)
{
        if (app->type->vnic_clean)
                app->type->vnic_clean(app, nn);
}

static inline int nfp_app_repr_open(struct nfp_app *app, struct nfp_repr *repr)
{
        if (!app->type->repr_open)
                return -EINVAL;
        return app->type->repr_open(app, repr);
}

static inline int nfp_app_repr_stop(struct nfp_app *app, struct nfp_repr *repr)
{
        if (!app->type->repr_stop)
                return -EINVAL;
        return app->type->repr_stop(app, repr);
}

static inline int
nfp_app_repr_init(struct nfp_app *app, struct net_device *netdev)
{
        if (!app->type->repr_init)
                return 0;
        return app->type->repr_init(app, netdev);
}

static inline void
nfp_app_repr_preclean(struct nfp_app *app, struct net_device *netdev)
{
        if (app->type->repr_preclean)
                app->type->repr_preclean(app, netdev);
}

static inline void
nfp_app_repr_clean(struct nfp_app *app, struct net_device *netdev)
{
        if (app->type->repr_clean)
                app->type->repr_clean(app, netdev);
}

static inline int
nfp_app_check_mtu(struct nfp_app *app, struct net_device *netdev, int new_mtu)
{
        if (!app || !app->type->check_mtu)
                return 0;
        return app->type->check_mtu(app, netdev, new_mtu);
}

static inline int
nfp_app_repr_change_mtu(struct nfp_app *app, struct net_device *netdev,
                        int new_mtu)
{
        if (!app || !app->type->repr_change_mtu)
                return 0;
        return app->type->repr_change_mtu(app, netdev, new_mtu);
}

static inline const char *nfp_app_name(struct nfp_app *app)
{
        if (!app)
                return "";
        return app->type->name;
}

static inline bool nfp_app_needs_ctrl_vnic(struct nfp_app *app)
{
        return app && app->type->ctrl_msg_rx;
}

static inline bool nfp_app_ctrl_has_meta(struct nfp_app *app)
{
        return app->type->ctrl_has_meta;
}

static inline bool nfp_app_ctrl_uses_data_vnics(struct nfp_app *app)
{
        return app && app->type->ctrl_msg_rx_raw;
}

static inline const char *nfp_app_extra_cap(struct nfp_app *app,
                                            struct nfp_net *nn)
{
        if (!app || !app->type->extra_cap)
                return "";
        return app->type->extra_cap(app, nn);
}

static inline bool nfp_app_has_tc(struct nfp_app *app)
{
        return app && app->type->setup_tc;
}

static inline int nfp_app_setup_tc(struct nfp_app *app,
                                   struct net_device *netdev,
                                   enum tc_setup_type type, void *type_data)
{
        if (!app || !app->type->setup_tc)
                return -EOPNOTSUPP;
        return app->type->setup_tc(app, netdev, type, type_data);
}

static inline int nfp_app_bpf(struct nfp_app *app, struct nfp_net *nn,
                              struct netdev_bpf *bpf)
{
        if (!app || !app->type->bpf)
                return -EINVAL;
        return app->type->bpf(app, nn, bpf);
}

static inline int nfp_app_xdp_offload(struct nfp_app *app, struct nfp_net *nn,
                                      struct bpf_prog *prog,
                                      struct netlink_ext_ack *extack)
{
        if (!app || !app->type->xdp_offload)
                return -EOPNOTSUPP;
        return app->type->xdp_offload(app, nn, prog, extack);
}

static inline bool __nfp_app_ctrl_tx(struct nfp_app *app, struct sk_buff *skb)
{
        trace_devlink_hwmsg(priv_to_devlink(app->pf), false, 0,
                            skb->data, skb->len);

        return __nfp_ctrl_tx(app->ctrl, skb);
}

static inline bool nfp_app_ctrl_tx(struct nfp_app *app, struct sk_buff *skb)
{
        trace_devlink_hwmsg(priv_to_devlink(app->pf), false, 0,
                            skb->data, skb->len);

        return nfp_ctrl_tx(app->ctrl, skb);
}

static inline void nfp_app_ctrl_rx(struct nfp_app *app, struct sk_buff *skb)
{
        trace_devlink_hwmsg(priv_to_devlink(app->pf), true, 0,
                            skb->data, skb->len);

        app->type->ctrl_msg_rx(app, skb);
}

static inline void
nfp_app_ctrl_rx_raw(struct nfp_app *app, const void *data, unsigned int len)
{
        if (!app || !app->type->ctrl_msg_rx_raw)
                return;

        trace_devlink_hwmsg(priv_to_devlink(app->pf), true, 0, data, len);
        app->type->ctrl_msg_rx_raw(app, data, len);
}

static inline int nfp_app_eswitch_mode_get(struct nfp_app *app, u16 *mode)
{
        if (!app->type->eswitch_mode_get)
                return -EOPNOTSUPP;

        *mode = app->type->eswitch_mode_get(app);

        return 0;
}

static inline int nfp_app_eswitch_mode_set(struct nfp_app *app, u16 mode)
{
        if (!app->type->eswitch_mode_set)
                return -EOPNOTSUPP;
        return app->type->eswitch_mode_set(app, mode);
}

static inline int nfp_app_sriov_enable(struct nfp_app *app, int num_vfs)
{
        if (!app || !app->type->sriov_enable)
                return -EOPNOTSUPP;
        return app->type->sriov_enable(app, num_vfs);
}

static inline void nfp_app_sriov_disable(struct nfp_app *app)
{
        if (app && app->type->sriov_disable)
                app->type->sriov_disable(app);
}

static inline
struct net_device *nfp_app_dev_get(struct nfp_app *app, u32 id,
                                   bool *redir_egress)
{
        if (unlikely(!app || !app->type->dev_get))
                return NULL;

        return app->type->dev_get(app, id, redir_egress);
}

struct nfp_app *nfp_app_from_netdev(struct net_device *netdev);

u64 *nfp_app_port_get_stats(struct nfp_port *port, u64 *data);
int nfp_app_port_get_stats_count(struct nfp_port *port);
u8 *nfp_app_port_get_stats_strings(struct nfp_port *port, u8 *data);

struct nfp_reprs *
nfp_reprs_get_locked(struct nfp_app *app, enum nfp_repr_type type);
struct nfp_reprs *
nfp_app_reprs_set(struct nfp_app *app, enum nfp_repr_type type,
                  struct nfp_reprs *reprs);

const char *nfp_app_mip_name(struct nfp_app *app);
struct sk_buff *
nfp_app_ctrl_msg_alloc(struct nfp_app *app, unsigned int size, gfp_t priority);

struct nfp_app *nfp_app_alloc(struct nfp_pf *pf, enum nfp_app_id id);
void nfp_app_free(struct nfp_app *app);
int nfp_app_start(struct nfp_app *app, struct nfp_net *ctrl);
void nfp_app_stop(struct nfp_app *app);

/* Callbacks shared between apps */

int nfp_app_nic_vnic_alloc(struct nfp_app *app, struct nfp_net *nn,
                           unsigned int id);
int nfp_app_nic_vnic_init_phy_port(struct nfp_pf *pf, struct nfp_app *app,
                                   struct nfp_net *nn, unsigned int id);

#endif