4 * Copyright(c) 2017 Cavium, Inc.. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _LIO_STRUCT_H_
35 #define _LIO_STRUCT_H_
39 #include <sys/queue.h>
41 #include <rte_spinlock.h>
42 #include <rte_atomic.h>
44 #include "lio_hw_defs.h"
55 int (*setup_mbox)(struct lio_device *);
56 void (*free_mbox)(struct lio_device *);
58 int (*setup_device_regs)(struct lio_device *);
61 struct lio_pf_vf_hs_word {
62 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
63 /** PKIND value assigned for the DPI interface */
66 /** OCTEON core clock multiplier */
67 uint64_t core_tics_per_us : 16;
69 /** OCTEON coprocessor clock multiplier */
70 uint64_t coproc_tics_per_us : 16;
72 /** app that currently running on OCTEON */
73 uint64_t app_mode : 8;
76 uint64_t reserved : 16;
78 #elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
81 uint64_t reserved : 16;
83 /** app that currently running on OCTEON */
84 uint64_t app_mode : 8;
86 /** OCTEON coprocessor clock multiplier */
87 uint64_t coproc_tics_per_us : 16;
89 /** OCTEON core clock multiplier */
90 uint64_t core_tics_per_us : 16;
92 /** PKIND value assigned for the DPI interface */
97 struct lio_sriov_info {
98 /** Number of rings assigned to VF */
99 uint32_t rings_per_vf;
101 /** Number of VF devices enabled */
105 /* Structure to define the configuration attributes for each Input queue. */
106 struct lio_iq_config {
107 /* Max number of IQs available */
110 /** Pending list size (usually set to the sum of the size of all Input
113 uint32_t pending_list_size;
115 /** Command size - 32 or 64 bytes */
119 /* Structure to define the configuration attributes for each Output queue. */
120 struct lio_oq_config {
121 /* Max number of OQs available */
124 /** If set, the Output queue uses info-pointer mode. (Default: 1 ) */
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.
131 uint32_t refill_threshold;
134 /* Structure to define the configuration. */
137 const char *card_name;
139 /** Input Queue attributes. */
140 struct lio_iq_config iq;
142 /** Output Queue attributes. */
143 struct lio_oq_config oq;
147 int num_def_tx_descs;
149 /* Num of desc for rx rings */
150 int num_def_rx_descs;
155 /* ----------------------- THE LIO DEVICE --------------------------- */
157 * Each lio device has this structure to represent all its
161 /** PCI device pointer */
162 struct rte_pci_device *pci_dev;
164 /** Octeon Chip type */
171 struct lio_fn_list fn_list;
173 struct lio_sriov_info sriov_info;
175 struct lio_pf_vf_hs_word pfvf_hsword;
177 /** Mail Box details of each lio queue. */
178 struct lio_mbox **mbox;
180 char dev_string[LIO_DEVICE_NAME_LEN]; /* Device print string */
182 const struct lio_config *default_config;
184 struct rte_eth_dev *eth_dev;
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;
193 #endif /* _LIO_STRUCT_H_ */