bus/fslmc: introduce true and false macros
[dpdk.git] / drivers / bus / fslmc / portal / dpaa2_hw_pvt.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) 2016 Freescale Semiconductor, Inc. All rights reserved.
5  *   Copyright (c) 2016 NXP. 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 Freescale Semiconductor, 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 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 _DPAA2_HW_PVT_H_
35 #define _DPAA2_HW_PVT_H_
36
37 #include <mc/fsl_mc_sys.h>
38 #include <fsl_qbman_portal.h>
39
40 #ifndef false
41 #define false      0
42 #endif
43 #ifndef true
44 #define true       1
45 #endif
46 #define DPAA2_DQRR_RING_SIZE    16
47         /** <Maximum number of slots available in RX ring*/
48
49 #define MC_PORTAL_INDEX         0
50 #define NUM_DPIO_REGIONS        2
51 #define NUM_DQS_PER_QUEUE       2
52
53 /* Maximum release/acquire from QBMAN */
54 #define DPAA2_MBUF_MAX_ACQ_REL  7
55
56 #define MAX_BPID 256
57 #define DPAA2_MBUF_HW_ANNOTATION        64
58 #define DPAA2_FD_PTA_SIZE               64
59
60 #if (DPAA2_MBUF_HW_ANNOTATION + DPAA2_FD_PTA_SIZE) > RTE_PKTMBUF_HEADROOM
61 #error "Annotation requirement is more than RTE_PKTMBUF_HEADROOM"
62 #endif
63
64 /* we will re-use the HEADROOM for annotation in RX */
65 #define DPAA2_HW_BUF_RESERVE    0
66 #define DPAA2_PACKET_LAYOUT_ALIGN       64 /*changing from 256 */
67
68 struct dpaa2_dpio_dev {
69         TAILQ_ENTRY(dpaa2_dpio_dev) next;
70                 /**< Pointer to Next device instance */
71         uint16_t index; /**< Index of a instance in the list */
72         rte_atomic16_t ref_count;
73                 /**< How many thread contexts are sharing this.*/
74         struct fsl_mc_io *dpio; /** handle to DPIO portal object */
75         uint16_t token;
76         struct qbman_swp *sw_portal; /** SW portal object */
77         const struct qbman_result *dqrr[4];
78                 /**< DQRR Entry for this SW portal */
79         void *mc_portal; /**< MC Portal for configuring this device */
80         uintptr_t qbman_portal_ce_paddr;
81                 /**< Physical address of Cache Enabled Area */
82         uintptr_t ce_size; /**< Size of the CE region */
83         uintptr_t qbman_portal_ci_paddr;
84                 /**< Physical address of Cache Inhibit Area */
85         uintptr_t ci_size; /**< Size of the CI region */
86         int32_t vfio_fd; /**< File descriptor received via VFIO */
87         int32_t hw_id; /**< An unique ID of this DPIO device instance */
88 };
89
90 struct dpaa2_dpbp_dev {
91         TAILQ_ENTRY(dpaa2_dpbp_dev) next;
92                 /**< Pointer to Next device instance */
93         struct fsl_mc_io dpbp;  /** handle to DPBP portal object */
94         uint16_t token;
95         rte_atomic16_t in_use;
96         uint32_t dpbp_id; /*HW ID for DPBP object */
97 };
98
99 struct queue_storage_info_t {
100         struct qbman_result *dq_storage[NUM_DQS_PER_QUEUE];
101 };
102
103 struct dpaa2_queue {
104         struct rte_mempool *mb_pool; /**< mbuf pool to populate RX ring. */
105         void *dev;
106         int32_t eventfd;        /*!< Event Fd of this queue */
107         uint32_t fqid;          /*!< Unique ID of this queue */
108         uint8_t tc_index;       /*!< traffic class identifier */
109         uint16_t flow_id;       /*!< To be used by DPAA2 frmework */
110         uint64_t rx_pkts;
111         uint64_t tx_pkts;
112         uint64_t err_pkts;
113         struct queue_storage_info_t *q_storage;
114 };
115
116 /*! Global MCP list */
117 extern void *(*rte_mcp_ptr_list);
118
119 struct dpaa2_dpbp_dev *dpaa2_alloc_dpbp_dev(void);
120 void dpaa2_free_dpbp_dev(struct dpaa2_dpbp_dev *dpbp);
121
122 #endif