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