src/plugins/marvell/pp2/pp2.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #define MVCONF_DBG_LEVEL 0
  19 #define MVCONF_PP2_BPOOL_COOKIE_SIZE 32
  20 #define MVCONF_PP2_BPOOL_DMA_ADDR_SIZE 64
  21 #define MVCONF_DMA_PHYS_ADDR_T_SIZE 64
  22 #define MVCONF_SYS_DMA_UIO
  23 #define MVCONF_TYPES_PUBLIC
  24 #define MVCONF_DMA_PHYS_ADDR_T_PUBLIC
  25
  26 #include "mv_std.h"
  27 #include "env/mv_sys_dma.h"
  28 #include "drivers/mv_pp2.h"
  29 #include <drivers/mv_pp2_bpool.h>
  30 #include <drivers/mv_pp2_ppio.h>
  31
  32 typedef struct
  33 {
  34   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  35   u16 size;
  36   struct pp2_bpool *bpool;
  37 } mrvl_pp2_inq_t;
  38
  39 typedef struct
  40 {
  41   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  42   u16 size;
  43   u32 *buffers;
  44   u16 head;
  45   u16 tail;
  46 } mrvl_pp2_outq_t;
  47
  48 typedef struct
  49 {
  50   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  51   u32 flags;
  52 #define MRVL_PP2_IF_F_ADMIN_UP (1 << 0)
  53   struct pp2_ppio *ppio;
  54   u32 per_interface_next_index;
  55
  56   mrvl_pp2_inq_t *inqs;
  57   mrvl_pp2_outq_t *outqs;
  58
  59   u32 dev_instance;
  60   u32 sw_if_index;
  61   u32 hw_if_index;
  62 } mrvl_pp2_if_t;
  63
  64 #define MRVL_PP2_BUFF_BATCH_SZ 64
  65
  66 typedef struct
  67 {
  68   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  69   struct pp2_hif *hif;
  70   struct pp2_ppio_desc *descs;
  71   struct buff_release_entry bre[MRVL_PP2_BUFF_BATCH_SZ];
  72   u32 buffers[VLIB_FRAME_SIZE];
  73 } mrvl_pp2_per_thread_data_t;
  74
  75 typedef struct
  76 {
  77   mrvl_pp2_if_t *interfaces;
  78   mrvl_pp2_per_thread_data_t *per_thread_data;
  79 } mrvl_pp2_main_t;
  80
  81 extern vnet_device_class_t mrvl_pp2_device_class;
  82 extern mrvl_pp2_main_t mrvl_pp2_main;
  83
  84 typedef struct
  85 {
  86   u8 *name;
  87   u16 rx_q_sz;
  88   u16 tx_q_sz;
  89
  90   /* return */
  91   int rv;
  92   clib_error_t *error;
  93 } mrvl_pp2_create_if_args_t;
  94
  95 void mrvl_pp2_create_if (mrvl_pp2_create_if_args_t * args);
  96 void mrvl_pp2_delete_if (mrvl_pp2_if_t * dfif);
  97
  98 /* output.c */
  99
 100 #define foreach_mrvl_pp2_tx_func_error \
 101   _(NO_FREE_SLOTS, "no free tx slots")                  \
 102   _(PPIO_SEND, "pp2_ppio_send errors")                  \
 103   _(PPIO_GET_NUM_OUTQ_DONE, "pp2_ppio_get_num_outq_done errors")
 104
 105 typedef enum
 106 {
 107 #define _(f,s) MRVL_PP2_TX_ERROR_##f,
 108   foreach_mrvl_pp2_tx_func_error
 109 #undef _
 110     MRVL_PP2_TX_N_ERROR,
 111 } mrvl_pp2_tx_func_error_t;
 112
 113 uword mrvl_pp2_interface_tx (vlib_main_t * vm, vlib_node_runtime_t * node,
 114                              vlib_frame_t * frame);
 115
 116 /* input.c */
 117
 118 typedef struct
 119 {
 120   u32 next_index;
 121   u32 hw_if_index;
 122   struct pp2_ppio_desc desc;
 123 } mrvl_pp2_input_trace_t;
 124
 125 extern vlib_node_registration_t mrvl_pp2_input_node;
 126
 127 /* format.c */
 128 format_function_t format_mrvl_pp2_input_trace;
 129 format_function_t format_mrvl_pp2_interface;
 130 format_function_t format_mrvl_pp2_interface_name;
 131
 132
 133 /*
 134  * fd.io coding-style-patch-verification: ON
 135  *
 136  * Local Variables:
 137  * eval: (c-set-style "gnu")
 138  * End:
 139  */