drivers/net/liquidio/lio_struct.h

   1 /*
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Cavium, Inc.. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Cavium, Inc. nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _LIO_STRUCT_H_
  35 #define _LIO_STRUCT_H_
  36
  37 #include <stdio.h>
  38 #include <stdint.h>
  39 #include <sys/queue.h>
  40
  41 #include <rte_spinlock.h>
  42 #include <rte_atomic.h>
  43
  44 #include "lio_hw_defs.h"
  45
  46 struct lio_version {
  47         uint16_t major;
  48         uint16_t minor;
  49         uint16_t micro;
  50         uint16_t reserved;
  51 };
  52
  53 struct lio_device;
  54 struct lio_fn_list {
  55         int (*setup_mbox)(struct lio_device *);
  56         void (*free_mbox)(struct lio_device *);
  57
  58         int (*setup_device_regs)(struct lio_device *);
  59 };
  60
  61 struct lio_pf_vf_hs_word {
  62 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
  63         /** PKIND value assigned for the DPI interface */
  64         uint64_t pkind : 8;
  65
  66         /** OCTEON core clock multiplier */
  67         uint64_t core_tics_per_us : 16;
  68
  69         /** OCTEON coprocessor clock multiplier */
  70         uint64_t coproc_tics_per_us : 16;
  71
  72         /** app that currently running on OCTEON */
  73         uint64_t app_mode : 8;
  74
  75         /** RESERVED */
  76         uint64_t reserved : 16;
  77
  78 #elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
  79
  80         /** RESERVED */
  81         uint64_t reserved : 16;
  82
  83         /** app that currently running on OCTEON */
  84         uint64_t app_mode : 8;
  85
  86         /** OCTEON coprocessor clock multiplier */
  87         uint64_t coproc_tics_per_us : 16;
  88
  89         /** OCTEON core clock multiplier */
  90         uint64_t core_tics_per_us : 16;
  91
  92         /** PKIND value assigned for the DPI interface */
  93         uint64_t pkind : 8;
  94 #endif
  95 };
  96
  97 struct lio_sriov_info {
  98         /** Number of rings assigned to VF */
  99         uint32_t rings_per_vf;
 100
 101         /** Number of VF devices enabled */
 102         uint32_t num_vfs;
 103 };
 104
 105 /* Structure to define the configuration attributes for each Input queue. */
 106 struct lio_iq_config {
 107         /* Max number of IQs available */
 108         uint8_t max_iqs;
 109
 110         /** Pending list size (usually set to the sum of the size of all Input
 111          *  queues)
 112          */
 113         uint32_t pending_list_size;
 114
 115         /** Command size - 32 or 64 bytes */
 116         uint32_t instr_type;
 117 };
 118
 119 /* Structure to define the configuration attributes for each Output queue. */
 120 struct lio_oq_config {
 121         /* Max number of OQs available */
 122         uint8_t max_oqs;
 123
 124         /** If set, the Output queue uses info-pointer mode. (Default: 1 ) */
 125         uint32_t info_ptr;
 126
 127         /** The number of buffers that were consumed during packet processing by
 128          *  the driver on this Output queue before the driver attempts to
 129          *  replenish the descriptor ring with new buffers.
 130          */
 131         uint32_t refill_threshold;
 132 };
 133
 134 /* Structure to define the configuration. */
 135 struct lio_config {
 136         uint16_t card_type;
 137         const char *card_name;
 138
 139         /** Input Queue attributes. */
 140         struct lio_iq_config iq;
 141
 142         /** Output Queue attributes. */
 143         struct lio_oq_config oq;
 144
 145         int num_nic_ports;
 146
 147         int num_def_tx_descs;
 148
 149         /* Num of desc for rx rings */
 150         int num_def_rx_descs;
 151
 152         int def_rx_buf_size;
 153 };
 154
 155 /* -----------------------  THE LIO DEVICE  --------------------------- */
 156 /** The lio device.
 157  *  Each lio device has this structure to represent all its
 158  *  components.
 159  */
 160 struct lio_device {
 161         /** PCI device pointer */
 162         struct rte_pci_device *pci_dev;
 163
 164         /** Octeon Chip type */
 165         uint16_t chip_id;
 166         uint16_t pf_num;
 167         uint16_t vf_num;
 168
 169         uint8_t *hw_addr;
 170
 171         struct lio_fn_list fn_list;
 172
 173         struct lio_sriov_info sriov_info;
 174
 175         struct lio_pf_vf_hs_word pfvf_hsword;
 176
 177         /** Mail Box details of each lio queue. */
 178         struct lio_mbox **mbox;
 179
 180         char dev_string[LIO_DEVICE_NAME_LEN]; /* Device print string */
 181
 182         const struct lio_config *default_config;
 183
 184         struct rte_eth_dev      *eth_dev;
 185
 186         uint8_t max_rx_queues;
 187         uint8_t max_tx_queues;
 188         uint8_t nb_rx_queues;
 189         uint8_t nb_tx_queues;
 190         uint8_t port_configured;
 191         uint8_t port_id;
 192 };
 193 #endif /* _LIO_STRUCT_H_ */