drivers/common/cnxk/roc_platform.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(C) 2021 Marvell.
   3  */
   4
   5 #ifndef _ROC_PLATFORM_H_
   6 #define _ROC_PLATFORM_H_
   7
   8 #include <rte_alarm.h>
   9 #include <rte_bitmap.h>
  10 #include <rte_bus_pci.h>
  11 #include <rte_byteorder.h>
  12 #include <rte_common.h>
  13 #include <rte_cycles.h>
  14 #include <rte_ether.h>
  15 #include <rte_interrupts.h>
  16 #include <rte_io.h>
  17 #include <rte_log.h>
  18 #include <rte_malloc.h>
  19 #include <rte_memzone.h>
  20 #include <rte_pci.h>
  21 #include <rte_spinlock.h>
  22 #include <rte_string_fns.h>
  23 #include <rte_telemetry.h>
  24
  25 #include "roc_bits.h"
  26
  27 #if defined(__ARM_FEATURE_SVE)
  28 #define PLT_CPU_FEATURE_PREAMBLE                                               \
  29         ".arch_extension crc\n"                                                \
  30         ".arch_extension lse\n"                                                \
  31         ".arch_extension sve\n"
  32 #else
  33 #define PLT_CPU_FEATURE_PREAMBLE                                               \
  34         ".arch_extension crc\n"                                                \
  35         ".arch_extension lse\n"
  36 #endif
  37
  38 #define PLT_ASSERT               RTE_ASSERT
  39 #define PLT_MEMZONE_NAMESIZE     RTE_MEMZONE_NAMESIZE
  40 #define PLT_STD_C11              RTE_STD_C11
  41 #define PLT_PTR_ADD              RTE_PTR_ADD
  42 #define PLT_PTR_DIFF             RTE_PTR_DIFF
  43 #define PLT_MAX_RXTX_INTR_VEC_ID RTE_MAX_RXTX_INTR_VEC_ID
  44 #define PLT_INTR_VEC_RXTX_OFFSET RTE_INTR_VEC_RXTX_OFFSET
  45 #define PLT_MIN                  RTE_MIN
  46 #define PLT_MAX                  RTE_MAX
  47 #define PLT_DIM                  RTE_DIM
  48 #define PLT_SET_USED             RTE_SET_USED
  49 #define PLT_SWAP                 RTE_SWAP
  50 #define PLT_STATIC_ASSERT(s)     _Static_assert(s, #s)
  51 #define PLT_ALIGN                RTE_ALIGN
  52 #define PLT_ALIGN_MUL_CEIL       RTE_ALIGN_MUL_CEIL
  53 #define PLT_MODEL_MZ_NAME        "roc_model_mz"
  54 #define PLT_CACHE_LINE_SIZE      RTE_CACHE_LINE_SIZE
  55 #define BITMASK_ULL              GENMASK_ULL
  56 #define PLT_ALIGN_CEIL           RTE_ALIGN_CEIL
  57 #define PLT_INIT                 RTE_INIT
  58
  59 #ifndef PLT_ETHER_ADDR_LEN
  60 #define PLT_ETHER_ADDR_LEN RTE_ETHER_ADDR_LEN
  61 #endif
  62 /** Divide ceil */
  63 #define PLT_DIV_CEIL(x, y)                      \
  64         ({                                      \
  65                 __typeof(x) __x = x;            \
  66                 __typeof(y) __y = y;            \
  67                 (__x + __y - 1) / __y;          \
  68         })
  69
  70 #define __plt_cache_aligned __rte_cache_aligned
  71 #define __plt_always_inline __rte_always_inline
  72 #define __plt_packed        __rte_packed
  73 #define __plt_unused        __rte_unused
  74 #define __roc_api           __rte_internal
  75 #define plt_iova_t          rte_iova_t
  76
  77 #define plt_pci_addr                rte_pci_addr
  78 #define plt_pci_device              rte_pci_device
  79 #define plt_pci_read_config         rte_pci_read_config
  80 #define plt_pci_find_ext_capability rte_pci_find_ext_capability
  81
  82 #define plt_log2_u32     rte_log2_u32
  83 #define plt_cpu_to_be_16 rte_cpu_to_be_16
  84 #define plt_be_to_cpu_16 rte_be_to_cpu_16
  85 #define plt_cpu_to_be_32 rte_cpu_to_be_32
  86 #define plt_be_to_cpu_32 rte_be_to_cpu_32
  87 #define plt_cpu_to_be_64 rte_cpu_to_be_64
  88 #define plt_be_to_cpu_64 rte_be_to_cpu_64
  89
  90 #define plt_aligned         __rte_aligned
  91 #define plt_align32pow2     rte_align32pow2
  92 #define plt_align32prevpow2 rte_align32prevpow2
  93
  94 #define plt_bitmap                      rte_bitmap
  95 #define plt_bitmap_init                 rte_bitmap_init
  96 #define plt_bitmap_reset                rte_bitmap_reset
  97 #define plt_bitmap_free                 rte_bitmap_free
  98 #define plt_bitmap_clear                rte_bitmap_clear
  99 #define plt_bitmap_set                  rte_bitmap_set
 100 #define plt_bitmap_get                  rte_bitmap_get
 101 #define plt_bitmap_scan_init            __rte_bitmap_scan_init
 102 #define plt_bitmap_scan                 rte_bitmap_scan
 103 #define plt_bitmap_get_memory_footprint rte_bitmap_get_memory_footprint
 104
 105 #define plt_spinlock_t      rte_spinlock_t
 106 #define plt_spinlock_init   rte_spinlock_init
 107 #define plt_spinlock_lock   rte_spinlock_lock
 108 #define plt_spinlock_unlock rte_spinlock_unlock
 109
 110 #define plt_intr_callback_register   rte_intr_callback_register
 111 #define plt_intr_callback_unregister rte_intr_callback_unregister
 112 #define plt_intr_disable             rte_intr_disable
 113 #define plt_thread_is_intr           rte_thread_is_intr
 114 #define plt_intr_callback_fn         rte_intr_callback_fn
 115
 116 #define plt_intr_efd_counter_size_get   rte_intr_efd_counter_size_get
 117 #define plt_intr_efd_counter_size_set   rte_intr_efd_counter_size_set
 118 #define plt_intr_vec_list_index_get     rte_intr_vec_list_index_get
 119 #define plt_intr_vec_list_index_set     rte_intr_vec_list_index_set
 120 #define plt_intr_vec_list_alloc         rte_intr_vec_list_alloc
 121 #define plt_intr_vec_list_free          rte_intr_vec_list_free
 122 #define plt_intr_fd_set                 rte_intr_fd_set
 123 #define plt_intr_fd_get                 rte_intr_fd_get
 124 #define plt_intr_dev_fd_get             rte_intr_dev_fd_get
 125 #define plt_intr_dev_fd_set             rte_intr_dev_fd_set
 126 #define plt_intr_type_get               rte_intr_type_get
 127 #define plt_intr_type_set               rte_intr_type_set
 128 #define plt_intr_instance_alloc         rte_intr_instance_alloc
 129 #define plt_intr_instance_dup           rte_intr_instance_dup
 130 #define plt_intr_instance_free          rte_intr_instance_free
 131 #define plt_intr_event_list_update      rte_intr_event_list_update
 132 #define plt_intr_max_intr_get           rte_intr_max_intr_get
 133 #define plt_intr_max_intr_set           rte_intr_max_intr_set
 134 #define plt_intr_nb_efd_get             rte_intr_nb_efd_get
 135 #define plt_intr_nb_efd_set             rte_intr_nb_efd_set
 136 #define plt_intr_nb_intr_get            rte_intr_nb_intr_get
 137 #define plt_intr_nb_intr_set            rte_intr_nb_intr_set
 138 #define plt_intr_efds_index_get         rte_intr_efds_index_get
 139 #define plt_intr_efds_index_set         rte_intr_efds_index_set
 140 #define plt_intr_elist_index_get        rte_intr_elist_index_get
 141 #define plt_intr_elist_index_set        rte_intr_elist_index_set
 142
 143 #define plt_alarm_set    rte_eal_alarm_set
 144 #define plt_alarm_cancel rte_eal_alarm_cancel
 145
 146 #define plt_intr_handle rte_intr_handle
 147
 148 #define plt_zmalloc(sz, align) rte_zmalloc("cnxk", sz, align)
 149 #define plt_free               rte_free
 150
 151 #define plt_read64(addr) rte_read64_relaxed((volatile void *)(addr))
 152 #define plt_write64(val, addr)                                                 \
 153         rte_write64_relaxed((val), (volatile void *)(addr))
 154
 155 #define plt_wmb()               rte_wmb()
 156 #define plt_rmb()               rte_rmb()
 157 #define plt_io_wmb()            rte_io_wmb()
 158 #define plt_io_rmb()            rte_io_rmb()
 159 #define plt_atomic_thread_fence rte_atomic_thread_fence
 160
 161 #define plt_mmap       mmap
 162 #define PLT_PROT_READ  PROT_READ
 163 #define PLT_PROT_WRITE PROT_WRITE
 164 #define PLT_MAP_SHARED MAP_SHARED
 165
 166 #define plt_memzone        rte_memzone
 167 #define plt_memzone_lookup rte_memzone_lookup
 168 #define plt_memzone_reserve_cache_align(name, sz)                              \
 169         rte_memzone_reserve_aligned(name, sz, 0, 0, RTE_CACHE_LINE_SIZE)
 170 #define plt_memzone_free rte_memzone_free
 171 #define plt_memzone_reserve_aligned(name, len, flags, align)                   \
 172         rte_memzone_reserve_aligned((name), (len), 0, (flags), (align))
 173
 174 #define plt_tsc_hz   rte_get_tsc_hz
 175 #define plt_delay_ms rte_delay_ms
 176 #define plt_delay_us rte_delay_us
 177
 178 #define plt_lcore_id rte_lcore_id
 179
 180 #define plt_strlcpy rte_strlcpy
 181
 182 #define PLT_TEL_INT_VAL              RTE_TEL_INT_VAL
 183 #define PLT_TEL_STRING_VAL           RTE_TEL_STRING_VAL
 184 #define plt_tel_data                 rte_tel_data
 185 #define plt_tel_data_start_array     rte_tel_data_start_array
 186 #define plt_tel_data_add_array_int   rte_tel_data_add_array_int
 187 #define plt_tel_data_add_array_string rte_tel_data_add_array_string
 188 #define plt_tel_data_start_dict      rte_tel_data_start_dict
 189 #define plt_tel_data_add_dict_int    rte_tel_data_add_dict_int
 190 #define plt_tel_data_add_dict_ptr(d, n, v)                      \
 191         rte_tel_data_add_dict_u64(d, n, (uint64_t)v)
 192 #define plt_tel_data_add_dict_string rte_tel_data_add_dict_string
 193 #define plt_tel_data_add_dict_u64    rte_tel_data_add_dict_u64
 194 #define plt_telemetry_register_cmd   rte_telemetry_register_cmd
 195
 196 /* Log */
 197 extern int cnxk_logtype_base;
 198 extern int cnxk_logtype_mbox;
 199 extern int cnxk_logtype_cpt;
 200 extern int cnxk_logtype_npa;
 201 extern int cnxk_logtype_nix;
 202 extern int cnxk_logtype_npc;
 203 extern int cnxk_logtype_sso;
 204 extern int cnxk_logtype_tim;
 205 extern int cnxk_logtype_tm;
 206 extern int cnxk_logtype_ree;
 207
 208 #define plt_err(fmt, args...)                                                  \
 209         RTE_LOG(ERR, PMD, "%s():%u " fmt "\n", __func__, __LINE__, ##args)
 210 #define plt_info(fmt, args...) RTE_LOG(INFO, PMD, fmt "\n", ##args)
 211 #define plt_warn(fmt, args...) RTE_LOG(WARNING, PMD, fmt "\n", ##args)
 212 #define plt_print(fmt, args...) RTE_LOG(INFO, PMD, fmt "\n", ##args)
 213 #define plt_dump(fmt, ...)      fprintf(stderr, fmt "\n", ##__VA_ARGS__)
 214
 215 /**
 216  * Log debug message if given subsystem logging is enabled.
 217  */
 218 #define plt_dbg(subsystem, fmt, args...)                                       \
 219         rte_log(RTE_LOG_DEBUG, cnxk_logtype_##subsystem,                       \
 220                 "[%s] %s():%u " fmt "\n", #subsystem, __func__, __LINE__,      \
 221 ##args)
 222
 223 #define plt_base_dbg(fmt, ...)  plt_dbg(base, fmt, ##__VA_ARGS__)
 224 #define plt_cpt_dbg(fmt, ...)   plt_dbg(cpt, fmt, ##__VA_ARGS__)
 225 #define plt_mbox_dbg(fmt, ...)  plt_dbg(mbox, fmt, ##__VA_ARGS__)
 226 #define plt_npa_dbg(fmt, ...)   plt_dbg(npa, fmt, ##__VA_ARGS__)
 227 #define plt_nix_dbg(fmt, ...)   plt_dbg(nix, fmt, ##__VA_ARGS__)
 228 #define plt_npc_dbg(fmt, ...)   plt_dbg(npc, fmt, ##__VA_ARGS__)
 229 #define plt_sso_dbg(fmt, ...)   plt_dbg(sso, fmt, ##__VA_ARGS__)
 230 #define plt_tim_dbg(fmt, ...)   plt_dbg(tim, fmt, ##__VA_ARGS__)
 231 #define plt_tm_dbg(fmt, ...)    plt_dbg(tm, fmt, ##__VA_ARGS__)
 232 #define plt_ree_dbg(fmt, ...)   plt_dbg(ree, fmt, ##__VA_ARGS__)
 233
 234 /* Datapath logs */
 235 #define plt_dp_err(fmt, args...)                                               \
 236         RTE_LOG_DP(ERR, PMD, "%s():%u " fmt "\n", __func__, __LINE__, ##args)
 237 #define plt_dp_info(fmt, args...)                                              \
 238         RTE_LOG_DP(INFO, PMD, "%s():%u " fmt "\n", __func__, __LINE__, ##args)
 239
 240 #ifdef __cplusplus
 241 #define CNXK_PCI_ID(subsystem_dev, dev)                                        \
 242 {                                                                      \
 243         RTE_CLASS_ANY_ID, PCI_VENDOR_ID_CAVIUM, (dev), RTE_PCI_ANY_ID, \
 244         (subsystem_dev),                                       \
 245 }
 246 #else
 247 #define CNXK_PCI_ID(subsystem_dev, dev)                                        \
 248 {                                                                      \
 249         .class_id = RTE_CLASS_ANY_ID,                                  \
 250         .vendor_id = PCI_VENDOR_ID_CAVIUM, .device_id = (dev),         \
 251         .subsystem_vendor_id = RTE_PCI_ANY_ID,                         \
 252         .subsystem_device_id = (subsystem_dev),                        \
 253 }
 254 #endif
 255
 256 __rte_internal
 257 int roc_plt_init(void);
 258
 259 /* Init callbacks */
 260 typedef int (*roc_plt_init_cb_t)(void);
 261 int __roc_api roc_plt_init_cb_register(roc_plt_init_cb_t cb);
 262
 263 static inline const void *
 264 plt_lmt_region_reserve_aligned(const char *name, size_t len, uint32_t align)
 265 {
 266         /* To ensure returned memory is physically contiguous, bounding
 267          * the start and end address in 2M range.
 268          */
 269         return rte_memzone_reserve_bounded(name, len, SOCKET_ID_ANY,
 270                                            RTE_MEMZONE_IOVA_CONTIG,
 271                                            align, RTE_PGSIZE_2M);
 272 }
 273
 274 #endif /* _ROC_PLATFORM_H_ */