sys/dev/mlx5/mlx5_core/mlx5_core.h

   1 /*-
   2  * Copyright (c) 2013-2017, Mellanox Technologies, Ltd.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 #ifndef __MLX5_CORE_H__
  29 #define __MLX5_CORE_H__
  30
  31 #include <linux/types.h>
  32 #include <linux/kernel.h>
  33 #include <linux/sched.h>
  34
  35 #include <dev/mlxfw/mlxfw.h>
  36
  37 #define DRIVER_NAME "mlx5_core"
  38 #ifndef DRIVER_VERSION
  39 #define DRIVER_VERSION "3.5.2"
  40 #endif
  41 #define DRIVER_RELDATE "September 2019"
  42
  43 extern int mlx5_core_debug_mask;
  44
  45 #define mlx5_core_dbg(dev, format, ...)                                 \
  46         pr_debug("%s:%s:%d:(pid %d): " format,                          \
  47                  (dev)->priv.name, __func__, __LINE__, curthread->td_proc->p_pid,       \
  48                  ##__VA_ARGS__)
  49
  50 #define mlx5_core_dbg_mask(dev, mask, format, ...)                      \
  51 do {                                                                    \
  52         if ((mask) & mlx5_core_debug_mask)                              \
  53                 mlx5_core_dbg(dev, format, ##__VA_ARGS__);              \
  54 } while (0)
  55
  56 #define mlx5_core_err(_dev, format, ...)                                        \
  57         device_printf((_dev)->pdev->dev.bsddev, "ERR: ""%s:%d:(pid %d): " format, \
  58                 __func__, __LINE__, curthread->td_proc->p_pid, \
  59                 ##__VA_ARGS__)
  60
  61 #define mlx5_core_warn(_dev, format, ...)                               \
  62         device_printf((_dev)->pdev->dev.bsddev, "WARN: ""%s:%d:(pid %d): " format, \
  63                 __func__, __LINE__, curthread->td_proc->p_pid, \
  64                 ##__VA_ARGS__)
  65
  66 #define mlx5_core_info(_dev, format, ...)                                       \
  67         device_printf((_dev)->pdev->dev.bsddev, "INFO: ""%s:%d:(pid %d): " format, \
  68                 __func__, __LINE__, curthread->td_proc->p_pid, \
  69                 ##__VA_ARGS__)
  70
  71 enum {
  72         MLX5_CMD_DATA, /* print command payload only */
  73         MLX5_CMD_TIME, /* print command execution time */
  74 };
  75
  76 enum mlx5_semaphore_space_address {
  77         MLX5_SEMAPHORE_SW_RESET         = 0x20,
  78 };
  79
  80 struct mlx5_core_dev;
  81
  82 int mlx5_query_hca_caps(struct mlx5_core_dev *dev);
  83 int mlx5_query_board_id(struct mlx5_core_dev *dev);
  84 int mlx5_query_qcam_reg(struct mlx5_core_dev *mdev, u32 *qcam,
  85                         u8 feature_group, u8 access_reg_group);
  86 int mlx5_query_pcam_reg(struct mlx5_core_dev *dev, u32 *pcam,
  87                         u8 feature_group, u8 access_reg_group);
  88 int mlx5_query_mcam_reg(struct mlx5_core_dev *dev, u32 *mcap,
  89                         u8 feature_group, u8 access_reg_group);
  90 int mlx5_query_mfrl_reg(struct mlx5_core_dev *mdev, u8 *reset_level);
  91 int mlx5_set_mfrl_reg(struct mlx5_core_dev *mdev, u8 reset_level);
  92 int mlx5_cmd_init_hca(struct mlx5_core_dev *dev);
  93 int mlx5_cmd_teardown_hca(struct mlx5_core_dev *dev);
  94 int mlx5_cmd_force_teardown_hca(struct mlx5_core_dev *dev);
  95 int mlx5_cmd_fast_teardown_hca(struct mlx5_core_dev *dev);
  96 void mlx5_core_event(struct mlx5_core_dev *dev, enum mlx5_dev_event event,
  97                      unsigned long param);
  98 void mlx5_enter_error_state(struct mlx5_core_dev *dev, bool force);
  99 void mlx5_disable_device(struct mlx5_core_dev *dev);
 100 void mlx5_recover_device(struct mlx5_core_dev *dev);
 101
 102 int mlx5_register_device(struct mlx5_core_dev *dev);
 103 void mlx5_unregister_device(struct mlx5_core_dev *dev);
 104
 105 int mlx5_firmware_flash(struct mlx5_core_dev *dev, const struct firmware *fw);
 106
 107 void mlx5e_init(void);
 108 void mlx5e_cleanup(void);
 109
 110 int mlx5_ctl_init(void);
 111 void mlx5_ctl_fini(void);
 112 void mlx5_fwdump_prep(struct mlx5_core_dev *mdev);
 113 int mlx5_fwdump(struct mlx5_core_dev *mdev);
 114 void mlx5_fwdump_clean(struct mlx5_core_dev *mdev);
 115
 116 struct mlx5_crspace_regmap {
 117         uint32_t addr;
 118         unsigned cnt;
 119 };
 120
 121 extern struct pci_driver mlx5_core_driver;
 122
 123 SYSCTL_DECL(_hw_mlx5);
 124
 125 enum {
 126         MLX5_NIC_IFC_FULL               = 0,
 127         MLX5_NIC_IFC_DISABLED           = 1,
 128         MLX5_NIC_IFC_NO_DRAM_NIC        = 2,
 129         MLX5_NIC_IFC_INVALID            = 3,
 130         MLX5_NIC_IFC_SW_RESET           = 7,
 131 };
 132
 133 u8 mlx5_get_nic_state(struct mlx5_core_dev *dev);
 134 void mlx5_set_nic_state(struct mlx5_core_dev *dev, u8 state);
 135
 136 #endif /* __MLX5_CORE_H__ */