drivers/net/qede/base/ecore_hw.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright (c) 2016 - 2018 Cavium Inc.
   3  * All rights reserved.
   4  * www.cavium.com
   5  */
   6
   7 #ifndef __ECORE_HW_H__
   8 #define __ECORE_HW_H__
   9
  10 #include "ecore.h"
  11 #include "ecore_dev_api.h"
  12
  13 /* Forward decleration */
  14 struct ecore_ptt;
  15
  16 enum reserved_ptts {
  17         RESERVED_PTT_EDIAG,
  18         RESERVED_PTT_USER_SPACE,
  19         RESERVED_PTT_MAIN,
  20         RESERVED_PTT_DPC,
  21         RESERVED_PTT_MAX
  22 };
  23
  24 /* @@@TMP - in earlier versions of the emulation, the HW lock started from 1
  25  * instead of 0, this should be fixed in later HW versions.
  26  */
  27 #ifndef MISC_REG_DRIVER_CONTROL_0
  28 #define MISC_REG_DRIVER_CONTROL_0       MISC_REG_DRIVER_CONTROL_1
  29 #endif
  30 #ifndef MISC_REG_DRIVER_CONTROL_0_SIZE
  31 #define MISC_REG_DRIVER_CONTROL_0_SIZE  MISC_REG_DRIVER_CONTROL_1_SIZE
  32 #endif
  33
  34 /* Definitions for DMA constants */
  35 #define DMAE_GO_VALUE   0x1
  36
  37 #ifdef __BIG_ENDIAN
  38 #define DMAE_COMPLETION_VAL     0xAED10000
  39 #define DMAE_CMD_ENDIANITY      0x3
  40 #else
  41 #define DMAE_COMPLETION_VAL     0xD1AE
  42 #define DMAE_CMD_ENDIANITY      0x2
  43 #endif
  44
  45 #define DMAE_CMD_SIZE   14
  46 /* size of DMAE command structure to fill.. DMAE_CMD_SIZE-5 */
  47 #define DMAE_CMD_SIZE_TO_FILL   (DMAE_CMD_SIZE - 5)
  48 /* Minimum wait for dmae opertaion to complete 2 milliseconds */
  49 #define DMAE_MIN_WAIT_TIME      0x2
  50 #define DMAE_MAX_CLIENTS        32
  51
  52 /**
  53 * @brief ecore_gtt_init - Initialize GTT windows
  54 *
  55 * @param p_hwfn
  56 * @param p_ptt
  57 */
  58 void ecore_gtt_init(struct ecore_hwfn *p_hwfn,
  59                     struct ecore_ptt *p_ptt);
  60
  61 /**
  62  * @brief ecore_ptt_invalidate - Forces all ptt entries to be re-configured
  63  *
  64  * @param p_hwfn
  65  */
  66 void ecore_ptt_invalidate(struct ecore_hwfn *p_hwfn);
  67
  68 /**
  69  * @brief ecore_ptt_pool_alloc - Allocate and initialize PTT pool
  70  *
  71  * @param p_hwfn
  72  *
  73  * @return _ecore_status_t - success (0), negative - error.
  74  */
  75 enum _ecore_status_t ecore_ptt_pool_alloc(struct ecore_hwfn *p_hwfn);
  76
  77 /**
  78  * @brief ecore_ptt_pool_free -
  79  *
  80  * @param p_hwfn
  81  */
  82 void ecore_ptt_pool_free(struct ecore_hwfn *p_hwfn);
  83
  84 /**
  85  * @brief ecore_ptt_get_bar_addr - Get PPT's external BAR address
  86  *
  87  * @param p_hwfn
  88  * @param p_ptt
  89  *
  90  * @return u32
  91  */
  92 u32 ecore_ptt_get_bar_addr(struct ecore_ptt     *p_ptt);
  93
  94 /**
  95  * @brief ecore_ptt_set_win - Set PTT Window's GRC BAR address
  96  *
  97  * @param p_hwfn
  98  * @param new_hw_addr
  99  * @param p_ptt
 100  */
 101 void ecore_ptt_set_win(struct ecore_hwfn        *p_hwfn,
 102                        struct ecore_ptt         *p_ptt,
 103                        u32                      new_hw_addr);
 104
 105 /**
 106  * @brief ecore_get_reserved_ptt - Get a specific reserved PTT
 107  *
 108  * @param p_hwfn
 109  * @param ptt_idx
 110  *
 111  * @return struct ecore_ptt *
 112  */
 113 struct ecore_ptt *ecore_get_reserved_ptt(struct ecore_hwfn      *p_hwfn,
 114                                          enum reserved_ptts     ptt_idx);
 115
 116 /**
 117  * @brief ecore_wr - Write value to BAR using the given ptt
 118  *
 119  * @param p_hwfn
 120  * @param p_ptt
 121  * @param hw_addr
 122  * @param val
 123  */
 124 void ecore_wr(struct ecore_hwfn *p_hwfn,
 125               struct ecore_ptt  *p_ptt,
 126               u32               hw_addr,
 127               u32               val);
 128
 129 /**
 130  * @brief ecore_rd - Read value from BAR using the given ptt
 131  *
 132  * @param p_hwfn
 133  * @param p_ptt
 134  * @param hw_addr
 135  */
 136 u32 ecore_rd(struct ecore_hwfn  *p_hwfn,
 137              struct ecore_ptt   *p_ptt,
 138              u32                hw_addr);
 139
 140 /**
 141  * @brief ecore_memcpy_from - copy n bytes from BAR using the given
 142  *        ptt
 143  *
 144  * @param p_hwfn
 145  * @param p_ptt
 146  * @param dest
 147  * @param hw_addr
 148  * @param n
 149  */
 150 void ecore_memcpy_from(struct ecore_hwfn        *p_hwfn,
 151                        struct ecore_ptt         *p_ptt,
 152                        void                     *dest,
 153                        u32                      hw_addr,
 154                        osal_size_t              n);
 155
 156 /**
 157  * @brief ecore_memcpy_to - copy n bytes to BAR using the given
 158  *        ptt
 159  *
 160  * @param p_hwfn
 161  * @param p_ptt
 162  * @param hw_addr
 163  * @param src
 164  * @param n
 165  */
 166 void ecore_memcpy_to(struct ecore_hwfn  *p_hwfn,
 167                      struct ecore_ptt   *p_ptt,
 168                      u32                hw_addr,
 169                      void               *src,
 170                      osal_size_t        n);
 171 /**
 172  * @brief ecore_fid_pretend - pretend to another function when
 173  *        accessing the ptt window. There is no way to unpretend
 174  *        a function. The only way to cancel a pretend is to
 175  *        pretend back to the original function.
 176  *
 177  * @param p_hwfn
 178  * @param p_ptt
 179  * @param fid - fid field of pxp_pretend structure. Can contain
 180  *            either pf / vf, port/path fields are don't care.
 181  */
 182 void ecore_fid_pretend(struct ecore_hwfn        *p_hwfn,
 183                        struct ecore_ptt         *p_ptt,
 184                        u16                      fid);
 185
 186 /**
 187  * @brief ecore_port_pretend - pretend to another port when
 188  *        accessing the ptt window
 189  *
 190  * @param p_hwfn
 191  * @param p_ptt
 192  * @param port_id - the port to pretend to
 193  */
 194 void ecore_port_pretend(struct ecore_hwfn       *p_hwfn,
 195                         struct ecore_ptt        *p_ptt,
 196                         u8                      port_id);
 197
 198 /**
 199  * @brief ecore_port_unpretend - cancel any previously set port
 200  *        pretend
 201  *
 202  * @param p_hwfn
 203  * @param p_ptt
 204  */
 205 void ecore_port_unpretend(struct ecore_hwfn     *p_hwfn,
 206                           struct ecore_ptt      *p_ptt);
 207
 208 /**
 209  * @brief ecore_port_fid_pretend - pretend to another port and another function
 210  *        when accessing the ptt window
 211  *
 212  * @param p_hwfn
 213  * @param p_ptt
 214  * @param port_id - the port to pretend to
 215  * @param fid - fid field of pxp_pretend structure. Can contain either pf / vf.
 216  */
 217 void ecore_port_fid_pretend(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 218                             u8 port_id, u16 fid);
 219
 220 /**
 221  * @brief ecore_vfid_to_concrete - build a concrete FID for a
 222  *        given VF ID
 223  *
 224  * @param p_hwfn
 225  * @param p_ptt
 226  * @param vfid
 227  */
 228 u32 ecore_vfid_to_concrete(struct ecore_hwfn *p_hwfn, u8 vfid);
 229
 230 /**
 231 * @brief ecore_dmae_info_alloc - Init the dmae_info structure
 232 * which is part of p_hwfn.
 233 * @param p_hwfn
 234 */
 235 enum _ecore_status_t ecore_dmae_info_alloc(struct ecore_hwfn    *p_hwfn);
 236
 237 /**
 238 * @brief ecore_dmae_info_free - Free the dmae_info structure
 239 * which is part of p_hwfn
 240 *
 241 * @param p_hwfn
 242 */
 243 void ecore_dmae_info_free(struct ecore_hwfn     *p_hwfn);
 244
 245 /**
 246  * @brief ecore_dmae_host2grc - copy data from source address to
 247  * dmae registers using the given ptt
 248  *
 249  * @param p_hwfn
 250  * @param p_ptt
 251  * @param source_addr
 252  * @param grc_addr (dmae_data_offset)
 253  * @param size_in_dwords
 254  * @param p_params (default parameters will be used in case of OSAL_NULL)
 255  *
 256  * @return enum _ecore_status_t
 257  */
 258 enum _ecore_status_t
 259 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn,
 260                     struct ecore_ptt *p_ptt,
 261                     u64 source_addr,
 262                     u32 grc_addr,
 263                     u32 size_in_dwords,
 264                     struct dmae_params *p_params);
 265
 266 /**
 267  * @brief ecore_dmae_grc2host - Read data from dmae data offset
 268  * to source address using the given ptt
 269  *
 270  * @param p_ptt
 271  * @param grc_addr (dmae_data_offset)
 272  * @param dest_addr
 273  * @param size_in_dwords
 274  * @param p_params (default parameters will be used in case of OSAL_NULL)
 275  *
 276  * @return enum _ecore_status_t
 277  */
 278 enum _ecore_status_t
 279 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn,
 280                     struct ecore_ptt *p_ptt,
 281                     u32 grc_addr,
 282                     dma_addr_t dest_addr,
 283                     u32 size_in_dwords,
 284                     struct dmae_params *p_params);
 285
 286 /**
 287  * @brief ecore_dmae_host2host - copy data from to source address
 288  * to a destination address (for SRIOV) using the given ptt
 289  *
 290  * @param p_hwfn
 291  * @param p_ptt
 292  * @param source_addr
 293  * @param dest_addr
 294  * @param size_in_dwords
 295  * @param p_params (default parameters will be used in case of OSAL_NULL)
 296  *
 297  * @return enum _ecore_status_t
 298  */
 299 enum _ecore_status_t
 300 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn,
 301                      struct ecore_ptt *p_ptt,
 302                      dma_addr_t source_addr,
 303                      dma_addr_t dest_addr,
 304                      u32 size_in_dwords,
 305                      struct dmae_params *p_params);
 306
 307 enum _ecore_status_t ecore_dmae_sanity(struct ecore_hwfn *p_hwfn,
 308                                        struct ecore_ptt *p_ptt,
 309                                        const char *phase);
 310
 311 enum _ecore_status_t ecore_init_fw_data(struct ecore_dev *p_dev,
 312                                         const u8 *fw_data);
 313
 314 void ecore_hw_err_notify(struct ecore_hwfn *p_hwfn,
 315                          enum ecore_hw_err_type err_type);
 316
 317 /**
 318  * @brief ecore_ppfid_wr - Write value to BAR using the given ptt while
 319  *      pretending to a PF to which the given PPFID pertains.
 320  *
 321  * @param p_hwfn
 322  * @param p_ptt
 323  * @param abs_ppfid
 324  * @param hw_addr
 325  * @param val
 326  */
 327 void ecore_ppfid_wr(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 328                     u8 abs_ppfid, u32 hw_addr, u32 val);
 329
 330 /**
 331  * @brief ecore_ppfid_rd - Read value from BAR using the given ptt while
 332  *       pretending to a PF to which the given PPFID pertains.
 333  *
 334  * @param p_hwfn
 335  * @param p_ptt
 336  * @param abs_ppfid
 337  * @param hw_addr
 338  */
 339 u32 ecore_ppfid_rd(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 340                    u8 abs_ppfid, u32 hw_addr);
 341
 342 #endif /* __ECORE_HW_H__ */