drivers/net/qede/base/ecore_hw.h

   1 /*
   2  * Copyright (c) 2016 QLogic Corporation.
   3  * All rights reserved.
   4  * www.qlogic.com
   5  *
   6  * See LICENSE.qede_pmd for copyright and licensing details.
   7  */
   8
   9 #ifndef __ECORE_HW_H__
  10 #define __ECORE_HW_H__
  11
  12 #include "ecore.h"
  13 #include "ecore_dev_api.h"
  14
  15 /* Forward decleration */
  16 struct ecore_ptt;
  17
  18 enum reserved_ptts {
  19         RESERVED_PTT_EDIAG,
  20         RESERVED_PTT_USER_SPACE,
  21         RESERVED_PTT_MAIN,
  22         RESERVED_PTT_DPC,
  23         RESERVED_PTT_MAX
  24 };
  25
  26 /* @@@TMP - in earlier versions of the emulation, the HW lock started from 1
  27  * instead of 0, this should be fixed in later HW versions.
  28  */
  29 #ifndef MISC_REG_DRIVER_CONTROL_0
  30 #define MISC_REG_DRIVER_CONTROL_0       MISC_REG_DRIVER_CONTROL_1
  31 #endif
  32 #ifndef MISC_REG_DRIVER_CONTROL_0_SIZE
  33 #define MISC_REG_DRIVER_CONTROL_0_SIZE  MISC_REG_DRIVER_CONTROL_1_SIZE
  34 #endif
  35
  36 enum _dmae_cmd_dst_mask {
  37         DMAE_CMD_DST_MASK_NONE = 0,
  38         DMAE_CMD_DST_MASK_PCIE = 1,
  39         DMAE_CMD_DST_MASK_GRC = 2
  40 };
  41
  42 enum _dmae_cmd_src_mask {
  43         DMAE_CMD_SRC_MASK_PCIE = 0,
  44         DMAE_CMD_SRC_MASK_GRC = 1
  45 };
  46
  47 enum _dmae_cmd_crc_mask {
  48         DMAE_CMD_COMP_CRC_EN_MASK_NONE = 0,
  49         DMAE_CMD_COMP_CRC_EN_MASK_SET = 1
  50 };
  51
  52 /* definitions for DMA constants */
  53 #define DMAE_GO_VALUE   0x1
  54
  55 #ifdef __BIG_ENDIAN
  56 #define DMAE_COMPLETION_VAL     0xAED10000
  57 #define DMAE_CMD_ENDIANITY      0x3
  58 #else
  59 #define DMAE_COMPLETION_VAL     0xD1AE
  60 #define DMAE_CMD_ENDIANITY      0x2
  61 #endif
  62
  63 #define DMAE_CMD_SIZE   14
  64 /* size of DMAE command structure to fill.. DMAE_CMD_SIZE-5 */
  65 #define DMAE_CMD_SIZE_TO_FILL   (DMAE_CMD_SIZE - 5)
  66 /* Minimum wait for dmae opertaion to complete 2 milliseconds */
  67 #define DMAE_MIN_WAIT_TIME      0x2
  68 #define DMAE_MAX_CLIENTS        32
  69
  70 /**
  71 * @brief ecore_gtt_init - Initialize GTT windows
  72 *
  73 * @param p_hwfn
  74 */
  75 void ecore_gtt_init(struct ecore_hwfn *p_hwfn);
  76
  77 /**
  78  * @brief ecore_ptt_invalidate - Forces all ptt entries to be re-configured
  79  *
  80  * @param p_hwfn
  81  */
  82 void ecore_ptt_invalidate(struct ecore_hwfn *p_hwfn);
  83
  84 /**
  85  * @brief ecore_ptt_pool_alloc - Allocate and initialize PTT pool
  86  *
  87  * @param p_hwfn
  88  *
  89  * @return _ecore_status_t - success (0), negative - error.
  90  */
  91 enum _ecore_status_t ecore_ptt_pool_alloc(struct ecore_hwfn *p_hwfn);
  92
  93 /**
  94  * @brief ecore_ptt_pool_free -
  95  *
  96  * @param p_hwfn
  97  */
  98 void ecore_ptt_pool_free(struct ecore_hwfn *p_hwfn);
  99
 100 /**
 101  * @brief ecore_ptt_get_hw_addr - Get PTT's GRC/HW address
 102  *
 103  * @param p_hwfn
 104  * @param p_ptt
 105  *
 106  * @return u32
 107  */
 108 u32 ecore_ptt_get_hw_addr(struct ecore_hwfn     *p_hwfn,
 109                           struct ecore_ptt      *p_ptt);
 110
 111 /**
 112  * @brief ecore_ptt_get_bar_addr - Get PPT's external BAR address
 113  *
 114  * @param p_hwfn
 115  * @param p_ptt
 116  *
 117  * @return u32
 118  */
 119 u32 ecore_ptt_get_bar_addr(struct ecore_ptt     *p_ptt);
 120
 121 /**
 122  * @brief ecore_ptt_set_win - Set PTT Window's GRC BAR address
 123  *
 124  * @param p_hwfn
 125  * @param new_hw_addr
 126  * @param p_ptt
 127  */
 128 void ecore_ptt_set_win(struct ecore_hwfn        *p_hwfn,
 129                        struct ecore_ptt         *p_ptt,
 130                        u32                      new_hw_addr);
 131
 132 /**
 133  * @brief ecore_get_reserved_ptt - Get a specific reserved PTT
 134  *
 135  * @param p_hwfn
 136  * @param ptt_idx
 137  *
 138  * @return struct ecore_ptt *
 139  */
 140 struct ecore_ptt *ecore_get_reserved_ptt(struct ecore_hwfn      *p_hwfn,
 141                                          enum reserved_ptts     ptt_idx);
 142
 143 /**
 144  * @brief ecore_wr - Write value to BAR using the given ptt
 145  *
 146  * @param p_hwfn
 147  * @param p_ptt
 148  * @param val
 149  * @param hw_addr
 150  */
 151 void ecore_wr(struct ecore_hwfn *p_hwfn,
 152               struct ecore_ptt  *p_ptt,
 153               u32               hw_addr,
 154               u32               val);
 155
 156 /**
 157  * @brief ecore_rd - Read value from BAR using the given ptt
 158  *
 159  * @param p_hwfn
 160  * @param p_ptt
 161  * @param val
 162  * @param hw_addr
 163  */
 164 u32 ecore_rd(struct ecore_hwfn  *p_hwfn,
 165              struct ecore_ptt   *p_ptt,
 166              u32                hw_addr);
 167
 168 /**
 169  * @brief ecore_memcpy_from - copy n bytes from BAR using the given
 170  *        ptt
 171  *
 172  * @param p_hwfn
 173  * @param p_ptt
 174  * @param dest
 175  * @param hw_addr
 176  * @param n
 177  */
 178 void ecore_memcpy_from(struct ecore_hwfn        *p_hwfn,
 179                        struct ecore_ptt         *p_ptt,
 180                        void                     *dest,
 181                        u32                      hw_addr,
 182                        osal_size_t              n);
 183
 184 /**
 185  * @brief ecore_memcpy_to - copy n bytes to BAR using the given
 186  *        ptt
 187  *
 188  * @param p_hwfn
 189  * @param p_ptt
 190  * @param hw_addr
 191  * @param src
 192  * @param n
 193  */
 194 void ecore_memcpy_to(struct ecore_hwfn  *p_hwfn,
 195                      struct ecore_ptt   *p_ptt,
 196                      u32                hw_addr,
 197                      void               *src,
 198                      osal_size_t        n);
 199 /**
 200  * @brief ecore_fid_pretend - pretend to another function when
 201  *        accessing the ptt window. There is no way to unpretend
 202  *        a function. The only way to cancel a pretend is to
 203  *        pretend back to the original function.
 204  *
 205  * @param p_hwfn
 206  * @param p_ptt
 207  * @param fid - fid field of pxp_pretend structure. Can contain
 208  *            either pf / vf, port/path fields are don't care.
 209  */
 210 void ecore_fid_pretend(struct ecore_hwfn        *p_hwfn,
 211                        struct ecore_ptt         *p_ptt,
 212                        u16                      fid);
 213
 214 /**
 215  * @brief ecore_port_pretend - pretend to another port when
 216  *        accessing the ptt window
 217  *
 218  * @param p_hwfn
 219  * @param p_ptt
 220  * @param port_id - the port to pretend to
 221  */
 222 void ecore_port_pretend(struct ecore_hwfn       *p_hwfn,
 223                         struct ecore_ptt        *p_ptt,
 224                         u8                      port_id);
 225
 226 /**
 227  * @brief ecore_port_unpretend - cancel any previously set port
 228  *        pretend
 229  *
 230  * @param p_hwfn
 231  * @param p_ptt
 232  */
 233 void ecore_port_unpretend(struct ecore_hwfn     *p_hwfn,
 234                           struct ecore_ptt      *p_ptt);
 235
 236 /**
 237  * @brief ecore_vfid_to_concrete - build a concrete FID for a
 238  *        given VF ID
 239  *
 240  * @param p_hwfn
 241  * @param p_ptt
 242  * @param vfid
 243  */
 244 u32 ecore_vfid_to_concrete(struct ecore_hwfn *p_hwfn, u8 vfid);
 245
 246 /**
 247 * @brief ecore_dmae_info_alloc - Init the dmae_info structure
 248 * which is part of p_hwfn.
 249 * @param p_hwfn
 250 */
 251 enum _ecore_status_t ecore_dmae_info_alloc(struct ecore_hwfn    *p_hwfn);
 252
 253 /**
 254 * @brief ecore_dmae_info_free - Free the dmae_info structure
 255 * which is part of p_hwfn
 256 *
 257 * @param p_hwfn
 258 */
 259 void ecore_dmae_info_free(struct ecore_hwfn     *p_hwfn);
 260
 261 union ecore_qm_pq_params {
 262         struct {
 263                 u8 q_idx;
 264         } iscsi;
 265
 266         struct {
 267                 u8 tc;
 268         } core;
 269
 270         struct {
 271                 u8 is_vf;
 272                 u8 vf_id;
 273                 u8 tc;
 274         } eth;
 275
 276         struct {
 277                 u8 dcqcn;
 278                 u8 qpid; /* roce relative */
 279         } roce;
 280
 281         struct {
 282                 u8 qidx;
 283         } iwarp;
 284 };
 285
 286 u16 ecore_get_qm_pq(struct ecore_hwfn   *p_hwfn,
 287                     enum protocol_type  proto,
 288                     union ecore_qm_pq_params *params);
 289
 290 enum _ecore_status_t ecore_init_fw_data(struct ecore_dev *p_dev,
 291                                         const u8 *fw_data);
 292
 293 void ecore_hw_err_notify(struct ecore_hwfn *p_hwfn,
 294                          enum ecore_hw_err_type err_type);
 295
 296 #endif /* __ECORE_HW_H__ */