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_device;
  47 struct lio_fn_list {
  48         int (*setup_device_regs)(struct lio_device *);
  49 };
  50
  51 struct lio_sriov_info {
  52         /** Number of rings assigned to VF */
  53         uint32_t rings_per_vf;
  54
  55         /** Number of VF devices enabled */
  56         uint32_t num_vfs;
  57 };
  58
  59 /* Structure to define the configuration attributes for each Input queue. */
  60 struct lio_iq_config {
  61         /* Max number of IQs available */
  62         uint8_t max_iqs;
  63
  64         /** Pending list size (usually set to the sum of the size of all Input
  65          *  queues)
  66          */
  67         uint32_t pending_list_size;
  68
  69         /** Command size - 32 or 64 bytes */
  70         uint32_t instr_type;
  71 };
  72
  73 /* Structure to define the configuration attributes for each Output queue. */
  74 struct lio_oq_config {
  75         /* Max number of OQs available */
  76         uint8_t max_oqs;
  77
  78         /** If set, the Output queue uses info-pointer mode. (Default: 1 ) */
  79         uint32_t info_ptr;
  80
  81         /** The number of buffers that were consumed during packet processing by
  82          *  the driver on this Output queue before the driver attempts to
  83          *  replenish the descriptor ring with new buffers.
  84          */
  85         uint32_t refill_threshold;
  86 };
  87
  88 /* Structure to define the configuration. */
  89 struct lio_config {
  90         uint16_t card_type;
  91         const char *card_name;
  92
  93         /** Input Queue attributes. */
  94         struct lio_iq_config iq;
  95
  96         /** Output Queue attributes. */
  97         struct lio_oq_config oq;
  98
  99         int num_nic_ports;
 100
 101         int num_def_tx_descs;
 102
 103         /* Num of desc for rx rings */
 104         int num_def_rx_descs;
 105
 106         int def_rx_buf_size;
 107 };
 108
 109 /* -----------------------  THE LIO DEVICE  --------------------------- */
 110 /** The lio device.
 111  *  Each lio device has this structure to represent all its
 112  *  components.
 113  */
 114 struct lio_device {
 115         /** PCI device pointer */
 116         struct rte_pci_device *pci_dev;
 117
 118         /** Octeon Chip type */
 119         uint16_t chip_id;
 120         uint16_t pf_num;
 121         uint16_t vf_num;
 122
 123         uint8_t *hw_addr;
 124
 125         struct lio_fn_list fn_list;
 126
 127         struct lio_sriov_info sriov_info;
 128
 129         char dev_string[LIO_DEVICE_NAME_LEN]; /* Device print string */
 130
 131         const struct lio_config *default_config;
 132
 133         struct rte_eth_dev      *eth_dev;
 134
 135         uint8_t max_rx_queues;
 136         uint8_t max_tx_queues;
 137         uint8_t nb_rx_queues;
 138         uint8_t nb_tx_queues;
 139         uint8_t port_configured;
 140         uint8_t port_id;
 141 };
 142 #endif /* _LIO_STRUCT_H_ */