/* QLogic Everest network driver.
 *
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 * Copyright 2014 QLogic Corporation
 * The contents of this file are subject to the terms of the
 * QLogic End User License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the License at
 * http://www.qlogic.com/Resources/Documents/DriverDownloadHelp/
 * QLogic_End_User_Software_License.txt
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 *
 * Maintained by: Ariel Elior <ariel.elior@qlogic.com>
 *
 */

#ifndef VF_PF_IF_H
#define VF_PF_IF_H

/***********************************************
 *
 * Common definitions for all HVs
 *
 **/
struct vf_pf_resc_request {
        u8  num_rxqs;
        u8  num_txqs;
        u8  num_sbs;
        u8  num_mac_filters;
        u8  num_vlan_filters;
        u8  num_mc_filters; /* No limit  so superfluous */
};

struct hw_sb_info {
        u8 hw_sb_id;    /* aka absolute igu id, used to ack the sb */
        u8 sb_qid;      /* used to update DHC for sb */
};

/***********************************************
 *
 * HW VF-PF channel definitions
 *
 * A.K.A VF-PF mailbox
 *
 **/
#define TLV_BUFFER_SIZE                 1024
#ifndef BNX2X_UPSTREAM /* ! BNX2X_UPSTREAM */
#define TLV_ALIGN                       sizeof(u64)
#endif
#define PF_VF_BULLETIN_SIZE             512

#define VFPF_QUEUE_FLG_TPA              0x0001
#define VFPF_QUEUE_FLG_TPA_IPV6         0x0002
#define VFPF_QUEUE_FLG_TPA_GRO          0x0004
#define VFPF_QUEUE_FLG_CACHE_ALIGN      0x0008
#define VFPF_QUEUE_FLG_STATS            0x0010
#define VFPF_QUEUE_FLG_OV               0x0020
#define VFPF_QUEUE_FLG_VLAN             0x0040
#define VFPF_QUEUE_FLG_COS              0x0080
#define VFPF_QUEUE_FLG_HC               0x0100
#define VFPF_QUEUE_FLG_DHC              0x0200
#define VFPF_QUEUE_FLG_LEADING_RSS      0x0400

#define VFPF_QUEUE_DROP_IP_CS_ERR       (1 << 0)
#define VFPF_QUEUE_DROP_TCP_CS_ERR      (1 << 1)
#define VFPF_QUEUE_DROP_TTL0            (1 << 2)
#define VFPF_QUEUE_DROP_UDP_CS_ERR      (1 << 3)

#define VFPF_RX_MASK_ACCEPT_NONE                0x00000000
#define VFPF_RX_MASK_ACCEPT_MATCHED_UNICAST     0x00000001
#define VFPF_RX_MASK_ACCEPT_MATCHED_MULTICAST   0x00000002
#define VFPF_RX_MASK_ACCEPT_ALL_UNICAST         0x00000004
#define VFPF_RX_MASK_ACCEPT_ALL_MULTICAST       0x00000008
#define VFPF_RX_MASK_ACCEPT_BROADCAST           0x00000010
/* TODO: #define VFPF_RX_MASK_ACCEPT_ANY_VLAN   0x00000020 */

#define BULLETIN_CONTENT_SIZE           (sizeof(struct pf_vf_bulletin_content))
#define BULLETIN_CONTENT_LEGACY_SIZE    (32)
#define BULLETIN_ATTEMPTS       5 /* crc failures before throwing towel */
#define BULLETIN_CRC_SEED       0

enum {
        PFVF_STATUS_WAITING = 0,
        PFVF_STATUS_SUCCESS,
        PFVF_STATUS_FAILURE,
        PFVF_STATUS_NOT_SUPPORTED,
        PFVF_STATUS_NO_RESOURCE
};

/* vf pf channel tlvs */
/* general tlv header (used for both vf->pf request and pf->vf response) */
struct channel_tlv {
        u16 type;
        u16 length;
};

/* header of first vf->pf tlv carries the offset used to calculate reponse
 * buffer address
 */
struct vfpf_first_tlv {
        struct channel_tlv tl;
        u32 resp_msg_offset;
};

/* header of pf->vf tlvs, carries the status of handling the request */
struct pfvf_tlv {
        struct channel_tlv tl;
        u8 status;
        u8 padding[3];
};

/* response tlv used for most tlvs */
struct pfvf_general_resp_tlv {
        struct pfvf_tlv hdr;
};

/* used to terminate and pad a tlv list */
struct channel_list_end_tlv {
        struct channel_tlv tl;
        u8 padding[4];
};

/* Acquire */
struct vfpf_acquire_tlv {
        struct vfpf_first_tlv first_tlv;

        struct vf_pf_vfdev_info {
                /* the following fields are for debug purposes */
                u8 vf_id;       /* ME register value */
                u8 vf_os;       /* e.g. Linux, W2K8 */
#define VF_OS_SUBVERSION_MASK   (0x1f)
#define VF_OS_MASK              (0xe0)
#define VF_OS_SHIFT             (5)
#define VF_OS_UNDEFINED         (0 << VF_OS_SHIFT)
#define VF_OS_WINDOWS           (1 << VF_OS_SHIFT)

                u8 fp_hsi_ver;
                u8 caps;
#define VF_CAP_SUPPORT_EXT_BULLETIN     (1 << 0)
        } vfdev_info;

        struct vf_pf_resc_request resc_request;

        aligned_u64 bulletin_addr;
};

/* simple operation request on queue */
struct vfpf_q_op_tlv {
        struct vfpf_first_tlv   first_tlv;
        u8 vf_qid;
        u8 padding[3];
};

/* receive side scaling tlv */
struct vfpf_rss_tlv {
        struct vfpf_first_tlv   first_tlv;
        u32                     rss_flags;
#define VFPF_RSS_MODE_DISABLED  (1 << 0)
#define VFPF_RSS_MODE_REGULAR   (1 << 1)
#define VFPF_RSS_SET_SRCH       (1 << 2)
#define VFPF_RSS_IPV4           (1 << 3)
#define VFPF_RSS_IPV4_TCP       (1 << 4)
#define VFPF_RSS_IPV4_UDP       (1 << 5)
#define VFPF_RSS_IPV6           (1 << 6)
#define VFPF_RSS_IPV6_TCP       (1 << 7)
#define VFPF_RSS_IPV6_UDP       (1 << 8)
        u8                      rss_result_mask;
        u8                      ind_table_size;
        u8                      rss_key_size;
        u8                      padding;
        u8                      ind_table[T_ETH_INDIRECTION_TABLE_SIZE];
        u32                     rss_key[T_ETH_RSS_KEY]; /* hash values */
};

/* acquire response tlv - carries the allocated resources */
struct pfvf_acquire_resp_tlv {
        struct pfvf_tlv hdr;
        struct pf_vf_pfdev_info {
                u32 chip_num;
                u32 pf_cap;
                #define PFVF_CAP_RSS        0x00000001
                #define PFVF_CAP_DHC        0x00000002
                #define PFVF_CAP_TPA        0x00000004
                #define PFVF_CAP_TPA_UPDATE 0x00000008

#ifndef BNX2X_UPSTREAM /* ! BNX2X_UPSTREAM */
                /* bit set only by ESX hypervisor. This means that a VF *may* be
                 * able to configure its own mac even if the hypervisor has
                 * already set one for it. In linux this is never allowed, but
                 * in ESX it may be allowed. Capabilities such as this which
                 * don't exist in linux will consume bits from the bitmap from
                 * starting from msb
                 */
                #define PFVF_CAP_ALLOW_MAC  0x80000000
#endif

                char fw_ver[32];
                u16 db_size;
                u8  indices_per_sb;
                u8  padding;
        } pfdev_info;
        struct pf_vf_resc {
                /* in case of status NO_RESOURCE in message hdr, pf will fill
                 * this struct with suggested amount of resources for next
                 * acquire request
                 */
                #define PFVF_MAX_QUEUES_PER_VF         16
                #define PFVF_MAX_SBS_PER_VF            16
                struct hw_sb_info hw_sbs[PFVF_MAX_SBS_PER_VF];
                u8      hw_qid[PFVF_MAX_QUEUES_PER_VF];
                u8      num_rxqs;
                u8      num_txqs;
                u8      num_sbs;
                u8      num_mac_filters;
                u8      num_vlan_filters;
                u8      num_mc_filters;
                u8      permanent_mac_addr[ETH_ALEN];
                u8      current_mac_addr[ETH_ALEN];
                u16     pf_link_speed;
                u32     pf_link_supported;
        } resc;
};

struct vfpf_port_phys_id_resp_tlv {
        struct channel_tlv tl;
        u8 id[ETH_ALEN];
        u8 padding[2];
};

#define VFPF_INIT_FLG_STATS_COALESCE    (1 << 0) /* when set the VFs queues
                                                  * stats will be coalesced on
                                                  * the leading RSS queue
                                                  */

/* Init VF */
struct vfpf_init_tlv {
        struct vfpf_first_tlv first_tlv;
        aligned_u64 sb_addr[PFVF_MAX_SBS_PER_VF]; /* vf_sb based */
        aligned_u64 spq_addr;
        aligned_u64 stats_addr;
        u16 stats_stride;
        u32 flags;
        u32 padding [2];
};

/* Setup Queue */
struct vfpf_setup_q_tlv {
        struct vfpf_first_tlv first_tlv;

        struct vf_pf_rxq_params {
                /* physical addresses */
                aligned_u64 rcq_addr;
                aligned_u64 rcq_np_addr;
                aligned_u64 rxq_addr;
                aligned_u64 sge_addr;

                /* sb + hc info */
                u8  vf_sb;              /* index in hw_sbs[] */
                u8  sb_index;           /* Index in the SB */
                u16 hc_rate;            /* desired interrupts per sec. */
                                        /* valid iff VFPF_QUEUE_FLG_HC */
                /* rx buffer info */
                u16 mtu;
                u16 buf_sz;
                u16 flags;              /* VFPF_QUEUE_FLG_X flags */
                u16 stat_id;            /* valid iff VFPF_QUEUE_FLG_STATS */

                /* valid iff VFPF_QUEUE_FLG_TPA */
                u16 sge_buf_sz;
                u16 tpa_agg_sz;
                u8 max_sge_pkt;

                u8 drop_flags;          /* VFPF_QUEUE_DROP_X, for Linux VMs
                                         * all the flags are turned off
                                         */

                u8 cache_line_log;      /* VFPF_QUEUE_FLG_CACHE_ALIGN */
                u8 padding;
        } rxq;

        struct vf_pf_txq_params {
                /* physical addresses */
                aligned_u64 txq_addr;

                /* sb + hc info */
                u8  vf_sb;              /* index in hw_sbs[] */
                u8  sb_index;           /* Index in the SB */
                u16 hc_rate;            /* desired interrupts per sec. */
                                        /* valid iff VFPF_QUEUE_FLG_HC */
                u32 flags;              /* VFPF_QUEUE_FLG_X flags */
                u16 stat_id;            /* valid iff VFPF_QUEUE_FLG_STATS */
                u8  traffic_type;       /* see in setup_context() */
                u8  padding;
        } txq;

        u8 vf_qid;                      /* index in hw_qid[] */
        u8 param_valid;
        #define VFPF_RXQ_VALID          0x01
        #define VFPF_TXQ_VALID          0x02
        u8 padding[2];
};

/* Set Queue Filters */
struct vfpf_q_mac_vlan_filter {
        u32 flags;
        #define VFPF_Q_FILTER_DEST_MAC_VALID    0x01
        #define VFPF_Q_FILTER_VLAN_TAG_VALID    0x02
        #define VFPF_Q_FILTER_SET_MAC           0x100   /* set/clear */
        u8  mac[ETH_ALEN];
        u16 vlan_tag;
};

#ifndef BNX2X_UPSTREAM /* ! BNX2X_UPSTREAM */
#define _UP_ETH_ALEN    (6)
#endif

/* configure queue filters */
struct vfpf_set_q_filters_tlv {
        struct vfpf_first_tlv first_tlv;

        u32 flags;
        #define VFPF_SET_Q_FILTERS_MAC_VLAN_CHANGED     0x01
        #define VFPF_SET_Q_FILTERS_MULTICAST_CHANGED    0x02
        #define VFPF_SET_Q_FILTERS_RX_MASK_CHANGED      0x04

        u8 vf_qid;                      /* index in hw_qid[] */
        u8 n_mac_vlan_filters;
        u8 n_multicast;
        u8 padding;

        #define PFVF_MAX_MAC_FILTERS                    16
        #define PFVF_MAX_VLAN_FILTERS                   16
        #define PFVF_MAX_FILTERS                        (PFVF_MAX_MAC_FILTERS +\
                                                         PFVF_MAX_VLAN_FILTERS)
        struct vfpf_q_mac_vlan_filter filters[PFVF_MAX_FILTERS];

        #define PFVF_MAX_MULTICAST_PER_VF               32
        u8  multicast[PFVF_MAX_MULTICAST_PER_VF][_UP_ETH_ALEN];

        u32 rx_mask;    /* see mask constants at the top of the file */
};

struct vfpf_tpa_tlv {
        struct vfpf_first_tlv   first_tlv;

        struct vf_pf_tpa_client_info {
                aligned_u64 sge_addr[PFVF_MAX_QUEUES_PER_VF];
                u8 update_ipv4;
                u8 update_ipv6;
                u8 max_tpa_queues;
                u8 max_sges_for_packet;
                u8 complete_on_both_clients;
                u8 dont_verify_thr;
                u8 tpa_mode;
                u16 sge_buff_size;
                u16 max_agg_size;
                u16 sge_pause_thr_low;
                u16 sge_pause_thr_high;
        } tpa_client_info;
};

/* close VF (disable VF) */
struct vfpf_close_tlv {
        struct vfpf_first_tlv   first_tlv;
        u16                     vf_id;  /* for debug */
        u8 padding[2];
};

/* rlease the VF's acquired resources */
struct vfpf_release_tlv {
        struct vfpf_first_tlv   first_tlv;
        u16                     vf_id;  /* for debug */
        u8 padding[2];
};

struct tlv_buffer_size {
        u8 tlv_buffer[TLV_BUFFER_SIZE];
};

union vfpf_tlvs {
        struct vfpf_first_tlv           first_tlv;
        struct vfpf_acquire_tlv         acquire;
        struct vfpf_init_tlv            init;
        struct vfpf_close_tlv           close;
        struct vfpf_q_op_tlv            q_op;
        struct vfpf_setup_q_tlv         setup_q;
        struct vfpf_set_q_filters_tlv   set_q_filters;
        struct vfpf_release_tlv         release;
        struct vfpf_rss_tlv             update_rss;
        struct vfpf_tpa_tlv             update_tpa;
        struct channel_list_end_tlv     list_end;
        struct tlv_buffer_size          tlv_buf_size;
};

union pfvf_tlvs {
        struct pfvf_general_resp_tlv    general_resp;
        struct pfvf_acquire_resp_tlv    acquire_resp;
        struct channel_list_end_tlv     list_end;
        struct tlv_buffer_size          tlv_buf_size;
};

/* This is a structure which is allocated in the VF, which the PF may update
 * when it deems it necessary to do so. The bulletin board is sampled
 * periodically by the VF. A copy per VF is maintained in the PF (to prevent
 * loss of data upon multiple updates (or the need for read modify write)).
 */
struct pf_vf_bulletin_size {
        u8 size [PF_VF_BULLETIN_SIZE];
};

struct pf_vf_bulletin_content {
        u32 crc;                        /* crc of structure to ensure is not in
                                         * mid-update
                                         */
        u16 version;
        u16 length;

        aligned_u64 valid_bitmap;       /* bitmap indicating wich fields
                                         * hold valid values
                                         */

#define MAC_ADDR_VALID          0       /* alert the vf that a new mac address
                                         * is available for it
                                         */
#define VLAN_VALID              1       /* when set, the vf should no access the
                                         * vfpf channel
                                         */
#define CHANNEL_DOWN            2       /* vfpf channel is disabled. VFs are not
                                         * to attempt to send messages on the
                                         * channel after this bit is set
                                         */
#define LINK_VALID              3       /* alert the VF thet a new link status
                                         * update is available for it
                                         */
        u8 mac[ETH_ALEN];
        u8 mac_padding[2];

        u16 vlan;
        u8 vlan_padding[6];

        u16 link_speed;                  /* Effective line speed */
        u8 link_speed_padding[6];
        u32 link_flags;                  /* VFPF_LINK_REPORT_XXX flags */
#define VFPF_LINK_REPORT_LINK_DOWN       (1 << 0)
#define VFPF_LINK_REPORT_FULL_DUPLEX     (1 << 1)
#define VFPF_LINK_REPORT_RX_FC_ON        (1 << 2)
#define VFPF_LINK_REPORT_TX_FC_ON        (1 << 3)
        u8 link_flags_padding[4];
};

union pf_vf_bulletin {
        struct pf_vf_bulletin_content content;
        struct pf_vf_bulletin_size size;
};
#define MAX_TLVS_IN_LIST 50
#ifndef print_enum /* BNX2X_UPSTREAM */
enum channel_tlvs {
#else
print_enum (channel_tlvs,
#endif
        CHANNEL_TLV_NONE, /* ends tlv sequence */
        CHANNEL_TLV_ACQUIRE,
        CHANNEL_TLV_INIT,
        CHANNEL_TLV_SETUP_Q,
        CHANNEL_TLV_SET_Q_FILTERS,
        CHANNEL_TLV_ACTIVATE_Q,
        CHANNEL_TLV_DEACTIVATE_Q,
        CHANNEL_TLV_TEARDOWN_Q,
        CHANNEL_TLV_CLOSE,
        CHANNEL_TLV_RELEASE,
        CHANNEL_TLV_UPDATE_RSS_DEPRECATED,
        CHANNEL_TLV_PF_RELEASE_VF,
        CHANNEL_TLV_LIST_END,
        CHANNEL_TLV_FLR,
        CHANNEL_TLV_PF_SET_MAC,
        CHANNEL_TLV_PF_SET_VLAN,
        CHANNEL_TLV_UPDATE_RSS,
        CHANNEL_TLV_PHYS_PORT_ID,
        CHANNEL_TLV_UPDATE_TPA,
        CHANNEL_TLV_MAX
#ifndef print_enum /* BNX2X_UPSTREAM */
};
#else
);
#endif

#endif /* VF_PF_IF_H */