drivers/net/thunderx/base/nicvf_mbox.h

   1 /*
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (C) Cavium, Inc. 2016.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of Cavium, Inc nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef __THUNDERX_NICVF_MBOX__
  34 #define __THUNDERX_NICVF_MBOX__
  35
  36 #include <stdint.h>
  37
  38 #include "nicvf_plat.h"
  39 #include "../nicvf_struct.h"
  40
  41 /* PF <--> VF Mailbox communication
  42  * Two 64bit registers are shared between PF and VF for each VF
  43  * Writing into second register means end of message.
  44  */
  45
  46 /* PF <--> VF mailbox communication */
  47 #define NIC_PF_VF_MAILBOX_SIZE          2
  48 #define NIC_MBOX_MSG_TIMEOUT            2000    /* ms */
  49
  50 /* Mailbox message types */
  51 #define NIC_MBOX_MSG_INVALID            0x00    /* Invalid message */
  52 #define NIC_MBOX_MSG_READY              0x01    /* Is PF ready to rcv msgs */
  53 #define NIC_MBOX_MSG_ACK                0x02    /* ACK the message received */
  54 #define NIC_MBOX_MSG_NACK               0x03    /* NACK the message received */
  55 #define NIC_MBOX_MSG_QS_CFG             0x04    /* Configure Qset */
  56 #define NIC_MBOX_MSG_RQ_CFG             0x05    /* Configure receive queue */
  57 #define NIC_MBOX_MSG_SQ_CFG             0x06    /* Configure Send queue */
  58 #define NIC_MBOX_MSG_RQ_DROP_CFG        0x07    /* Configure receive queue */
  59 #define NIC_MBOX_MSG_SET_MAC            0x08    /* Add MAC ID to DMAC filter */
  60 #define NIC_MBOX_MSG_SET_MAX_FRS        0x09    /* Set max frame size */
  61 #define NIC_MBOX_MSG_CPI_CFG            0x0A    /* Config CPI, RSSI */
  62 #define NIC_MBOX_MSG_RSS_SIZE           0x0B    /* Get RSS indir_tbl size */
  63 #define NIC_MBOX_MSG_RSS_CFG            0x0C    /* Config RSS table */
  64 #define NIC_MBOX_MSG_RSS_CFG_CONT       0x0D    /* RSS config continuation */
  65 #define NIC_MBOX_MSG_RQ_BP_CFG          0x0E    /* RQ backpressure config */
  66 #define NIC_MBOX_MSG_RQ_SW_SYNC         0x0F    /* Flush inflight pkts to RQ */
  67 #define NIC_MBOX_MSG_BGX_LINK_CHANGE    0x11    /* BGX:LMAC link status */
  68 #define NIC_MBOX_MSG_ALLOC_SQS          0x12    /* Allocate secondary Qset */
  69 #define NIC_MBOX_MSG_LOOPBACK           0x16    /* Set interface in loopback */
  70 #define NIC_MBOX_MSG_RESET_STAT_COUNTER 0x17    /* Reset statistics counters */
  71 #define NIC_MBOX_MSG_CFG_DONE           0xF0    /* VF configuration done */
  72 #define NIC_MBOX_MSG_SHUTDOWN           0xF1    /* VF is being shutdown */
  73 #define NIC_MBOX_MSG_MAX                0x100   /* Maximum number of messages */
  74
  75 /* Get vNIC VF configuration */
  76 struct nic_cfg_msg {
  77         uint8_t    msg;
  78         uint8_t    vf_id;
  79         uint8_t    node_id;
  80         bool       tns_mode:1;
  81         bool       sqs_mode:1;
  82         bool       loopback_supported:1;
  83         uint8_t    mac_addr[NICVF_MAC_ADDR_SIZE];
  84 };
  85
  86 /* Qset configuration */
  87 struct qs_cfg_msg {
  88         uint8_t    msg;
  89         uint8_t    num;
  90         uint8_t    sqs_count;
  91         uint64_t   cfg;
  92 };
  93
  94 /* Receive queue configuration */
  95 struct rq_cfg_msg {
  96         uint8_t    msg;
  97         uint8_t    qs_num;
  98         uint8_t    rq_num;
  99         uint64_t   cfg;
 100 };
 101
 102 /* Send queue configuration */
 103 struct sq_cfg_msg {
 104         uint8_t    msg;
 105         uint8_t    qs_num;
 106         uint8_t    sq_num;
 107         bool       sqs_mode;
 108         uint64_t   cfg;
 109 };
 110
 111 /* Set VF's MAC address */
 112 struct set_mac_msg {
 113         uint8_t    msg;
 114         uint8_t    vf_id;
 115         uint8_t    mac_addr[NICVF_MAC_ADDR_SIZE];
 116 };
 117
 118 /* Set Maximum frame size */
 119 struct set_frs_msg {
 120         uint8_t    msg;
 121         uint8_t    vf_id;
 122         uint16_t   max_frs;
 123 };
 124
 125 /* Set CPI algorithm type */
 126 struct cpi_cfg_msg {
 127         uint8_t    msg;
 128         uint8_t    vf_id;
 129         uint8_t    rq_cnt;
 130         uint8_t    cpi_alg;
 131 };
 132
 133 /* Get RSS table size */
 134 struct rss_sz_msg {
 135         uint8_t    msg;
 136         uint8_t    vf_id;
 137         uint16_t   ind_tbl_size;
 138 };
 139
 140 /* Set RSS configuration */
 141 struct rss_cfg_msg {
 142         uint8_t    msg;
 143         uint8_t    vf_id;
 144         uint8_t    hash_bits;
 145         uint8_t    tbl_len;
 146         uint8_t    tbl_offset;
 147 #define RSS_IND_TBL_LEN_PER_MBX_MSG     8
 148         uint8_t    ind_tbl[RSS_IND_TBL_LEN_PER_MBX_MSG];
 149 };
 150
 151 /* Physical interface link status */
 152 struct bgx_link_status {
 153         uint8_t    msg;
 154         uint8_t    mac_type;
 155         uint8_t    link_up;
 156         uint8_t    duplex;
 157         uint32_t   speed;
 158 };
 159
 160 /* Allocate additional SQS to VF */
 161 struct sqs_alloc {
 162         uint8_t    msg;
 163         uint8_t    spec;
 164         uint8_t    qs_count;
 165         uint8_t    svf[MAX_SQS_PER_VF];
 166 };
 167
 168 /* Set interface in loopback mode */
 169 struct set_loopback {
 170         uint8_t    msg;
 171         uint8_t    vf_id;
 172         bool       enable;
 173 };
 174
 175 /* Reset statistics counters */
 176 struct reset_stat_cfg {
 177         uint8_t    msg;
 178         /* Bitmap to select NIC_PF_VNIC(vf_id)_RX_STAT(0..13) */
 179         uint16_t   rx_stat_mask;
 180         /* Bitmap to select NIC_PF_VNIC(vf_id)_TX_STAT(0..4) */
 181         uint8_t    tx_stat_mask;
 182         /* Bitmap to select NIC_PF_QS(0..127)_RQ(0..7)_STAT(0..1)
 183          * bit14, bit15 NIC_PF_QS(vf_id)_RQ7_STAT(0..1)
 184          * bit12, bit13 NIC_PF_QS(vf_id)_RQ6_STAT(0..1)
 185          * ..
 186          * bit2, bit3 NIC_PF_QS(vf_id)_RQ1_STAT(0..1)
 187          * bit0, bit1 NIC_PF_QS(vf_id)_RQ0_STAT(0..1)
 188          */
 189         uint16_t   rq_stat_mask;
 190         /* Bitmap to select NIC_PF_QS(0..127)_SQ(0..7)_STAT(0..1)
 191          * bit14, bit15 NIC_PF_QS(vf_id)_SQ7_STAT(0..1)
 192          * bit12, bit13 NIC_PF_QS(vf_id)_SQ6_STAT(0..1)
 193          * ..
 194          * bit2, bit3 NIC_PF_QS(vf_id)_SQ1_STAT(0..1)
 195          * bit0, bit1 NIC_PF_QS(vf_id)_SQ0_STAT(0..1)
 196          */
 197         uint16_t   sq_stat_mask;
 198 };
 199
 200 struct nic_mbx {
 201 /* 128 bit shared memory between PF and each VF */
 202 union {
 203         struct { uint8_t msg; } msg;
 204         struct nic_cfg_msg      nic_cfg;
 205         struct qs_cfg_msg       qs;
 206         struct rq_cfg_msg       rq;
 207         struct sq_cfg_msg       sq;
 208         struct set_mac_msg      mac;
 209         struct set_frs_msg      frs;
 210         struct cpi_cfg_msg      cpi_cfg;
 211         struct rss_sz_msg       rss_size;
 212         struct rss_cfg_msg      rss_cfg;
 213         struct bgx_link_status  link_status;
 214         struct sqs_alloc        sqs_alloc;
 215         struct set_loopback     lbk;
 216         struct reset_stat_cfg   reset_stat;
 217 };
 218 };
 219
 220 NICVF_STATIC_ASSERT(sizeof(struct nic_mbx) <= 16);
 221
 222 int nicvf_handle_mbx_intr(struct nicvf *nic);
 223 int nicvf_mbox_check_pf_ready(struct nicvf *nic);
 224 int nicvf_mbox_qset_config(struct nicvf *nic, struct pf_qs_cfg *qs_cfg);
 225 int nicvf_mbox_request_sqs(struct nicvf *nic);
 226 int nicvf_mbox_rq_config(struct nicvf *nic, uint16_t qidx,
 227                          struct pf_rq_cfg *pf_rq_cfg);
 228 int nicvf_mbox_sq_config(struct nicvf *nic, uint16_t qidx);
 229 int nicvf_mbox_rq_drop_config(struct nicvf *nic, uint16_t qidx, bool enable);
 230 int nicvf_mbox_rq_bp_config(struct nicvf *nic, uint16_t qidx, bool enable);
 231 int nicvf_mbox_set_mac_addr(struct nicvf *nic,
 232                             const uint8_t mac[NICVF_MAC_ADDR_SIZE]);
 233 int nicvf_mbox_config_cpi(struct nicvf *nic, uint32_t qcnt);
 234 int nicvf_mbox_get_rss_size(struct nicvf *nic);
 235 int nicvf_mbox_config_rss(struct nicvf *nic);
 236 int nicvf_mbox_update_hw_max_frs(struct nicvf *nic, uint16_t mtu);
 237 int nicvf_mbox_rq_sync(struct nicvf *nic);
 238 int nicvf_mbox_loopback_config(struct nicvf *nic, bool enable);
 239 int nicvf_mbox_reset_stat_counters(struct nicvf *nic, uint16_t rx_stat_mask,
 240         uint8_t tx_stat_mask, uint16_t rq_stat_mask, uint16_t sq_stat_mask);
 241 void nicvf_mbox_shutdown(struct nicvf *nic);
 242 void nicvf_mbox_cfg_done(struct nicvf *nic);
 243
 244 #endif /* __THUNDERX_NICVF_MBOX__ */