sys/dev/mlx5/mlx5_core/mlx5_fwdump.c

   1 /*-
   2  * Copyright (c) 2018, 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
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  28
  29 #include <sys/param.h>
  30 #include <sys/systm.h>
  31 #include <sys/conf.h>
  32 #include <sys/fcntl.h>
  33 #include <dev/mlx5/driver.h>
  34 #include <dev/mlx5/device.h>
  35 #include <dev/mlx5/mlx5_core/mlx5_core.h>
  36 #include <dev/mlx5/mlx5io.h>
  37
  38 extern const struct mlx5_crspace_regmap mlx5_crspace_regmap_mt4117[];
  39 extern const struct mlx5_crspace_regmap mlx5_crspace_regmap_mt4115[];
  40 extern const struct mlx5_crspace_regmap mlx5_crspace_regmap_connectx5[];
  41
  42 struct mlx5_dump_data {
  43         const struct mlx5_crspace_regmap *rege;
  44         uint32_t *dump;
  45         unsigned dump_size;
  46         int dump_valid;
  47         struct mtx dump_lock;
  48 };
  49
  50 static MALLOC_DEFINE(M_MLX5_DUMP, "MLX5DUMP", "MLX5 Firmware dump");
  51
  52 static unsigned
  53 mlx5_fwdump_getsize(const struct mlx5_crspace_regmap *rege)
  54 {
  55         const struct mlx5_crspace_regmap *r;
  56         unsigned sz;
  57
  58         for (sz = 0, r = rege; r->cnt != 0; r++)
  59                 sz += r->cnt;
  60         return (sz);
  61 }
  62
  63 static void
  64 mlx5_fwdump_destroy_dd(struct mlx5_dump_data *dd)
  65 {
  66
  67         mtx_destroy(&dd->dump_lock);
  68         free(dd->dump, M_MLX5_DUMP);
  69         free(dd, M_MLX5_DUMP);
  70 }
  71
  72 void
  73 mlx5_fwdump_prep(struct mlx5_core_dev *mdev)
  74 {
  75         struct mlx5_dump_data *dd;
  76         int error;
  77
  78         error = mlx5_vsc_find_cap(mdev);
  79         if (error != 0) {
  80                 /* Inability to create a firmware dump is not fatal. */
  81                 device_printf((&mdev->pdev->dev)->bsddev, "WARN: "
  82                     "mlx5_fwdump_prep failed %d\n", error);
  83                 return;
  84         }
  85         dd = malloc(sizeof(struct mlx5_dump_data), M_MLX5_DUMP, M_WAITOK);
  86         switch (pci_get_device(mdev->pdev->dev.bsddev)) {
  87         case 0x1013:
  88                 dd->rege = mlx5_crspace_regmap_mt4115;
  89                 break;
  90         case 0x1015:
  91                 dd->rege = mlx5_crspace_regmap_mt4117;
  92                 break;
  93         case 0x1017:
  94         case 0x1019:
  95                 dd->rege = mlx5_crspace_regmap_connectx5;
  96                 break;
  97         default:
  98                 free(dd, M_MLX5_DUMP);
  99                 return; /* silently fail, do not prevent driver attach */
 100         }
 101         dd->dump_size = mlx5_fwdump_getsize(dd->rege);
 102         dd->dump = malloc(dd->dump_size * sizeof(uint32_t), M_MLX5_DUMP,
 103             M_WAITOK | M_ZERO);
 104         dd->dump_valid = 0;
 105         mtx_init(&dd->dump_lock, "mlx5dmp", NULL, MTX_DEF | MTX_NEW);
 106         if (atomic_cmpset_rel_ptr((uintptr_t *)&mdev->dump_data, 0,
 107             (uintptr_t)dd) == 0)
 108                 mlx5_fwdump_destroy_dd(dd);
 109 }
 110
 111 void
 112 mlx5_fwdump(struct mlx5_core_dev *mdev)
 113 {
 114         struct mlx5_dump_data *dd;
 115         const struct mlx5_crspace_regmap *r;
 116         uint32_t i, ri;
 117         int error;
 118
 119         dd = (struct mlx5_dump_data *)atomic_load_acq_ptr((uintptr_t *)
 120             &mdev->dump_data);
 121         if (dd == NULL)
 122                 return;
 123         mtx_lock(&dd->dump_lock);
 124         if (dd->dump_valid)
 125                 /* only one dump */
 126                 goto failed;
 127
 128         /* mlx5_vsc already warns, be silent. */
 129         error = mlx5_vsc_lock(mdev);
 130         if (error != 0)
 131                 goto failed;
 132         error = mlx5_vsc_set_space(mdev, MLX5_VSC_DOMAIN_PROTECTED_CRSPACE);
 133         if (error != 0)
 134                 goto unlock_vsc;
 135         for (i = 0, r = dd->rege; r->cnt != 0; r++) {
 136                 for (ri = 0; ri < r->cnt; ri++) {
 137                         error = mlx5_vsc_read(mdev, r->addr + ri * 4,
 138                             &dd->dump[i]);
 139                         if (error != 0)
 140                                 goto unlock_vsc;
 141                         i++;
 142                 }
 143         }
 144         atomic_store_rel_int(&dd->dump_valid, 1);
 145 unlock_vsc:
 146         mlx5_vsc_unlock(mdev);
 147 failed:
 148         mtx_unlock(&dd->dump_lock);
 149 }
 150
 151 void
 152 mlx5_fwdump_clean(struct mlx5_core_dev *mdev)
 153 {
 154         struct mlx5_dump_data *dd;
 155
 156         for (;;) {
 157                 dd = mdev->dump_data;
 158                 if (dd == NULL)
 159                         return;
 160                 if (atomic_cmpset_ptr((uintptr_t *)&mdev->dump_data,
 161                     (uintptr_t)dd, 0) == 1) {
 162                         mlx5_fwdump_destroy_dd(dd);
 163                         return;
 164                 }
 165         }
 166 }
 167
 168 static int
 169 mlx5_dbsf_to_core(const struct mlx5_fwdump_addr *devaddr,
 170     struct mlx5_core_dev **mdev)
 171 {
 172         device_t dev;
 173         struct pci_dev *pdev;
 174
 175         dev = pci_find_dbsf(devaddr->domain, devaddr->bus, devaddr->slot,
 176             devaddr->func);
 177         if (dev == NULL)
 178                 return (ENOENT);
 179         if (device_get_devclass(dev) != mlx5_core_driver.bsdclass)
 180                 return (EINVAL);
 181         pdev = device_get_softc(dev);
 182         *mdev = pci_get_drvdata(pdev);
 183         if (*mdev == NULL)
 184                 return (ENOENT);
 185         return (0);
 186 }
 187
 188 static int
 189 mlx5_fwdump_copyout(struct mlx5_dump_data *dd, struct mlx5_fwdump_get *fwg)
 190 {
 191         const struct mlx5_crspace_regmap *r;
 192         struct mlx5_fwdump_reg rv, *urv;
 193         uint32_t i, ri;
 194         int error;
 195
 196         if (dd == NULL)
 197                 return (ENOENT);
 198         if (fwg->buf == NULL) {
 199                 fwg->reg_filled = dd->dump_size;
 200                 return (0);
 201         }
 202         if (atomic_load_acq_int(&dd->dump_valid) == 0)
 203                 return (ENOENT);
 204
 205         urv = fwg->buf;
 206         for (i = 0, r = dd->rege; r->cnt != 0; r++) {
 207                 for (ri = 0; ri < r->cnt; ri++) {
 208                         if (i >= fwg->reg_cnt)
 209                                 goto out;
 210                         rv.addr = r->addr + ri * 4;
 211                         rv.val = dd->dump[i];
 212                         error = copyout(&rv, urv, sizeof(rv));
 213                         if (error != 0)
 214                                 return (error);
 215                         urv++;
 216                         i++;
 217                 }
 218         }
 219 out:
 220         fwg->reg_filled = i;
 221         return (0);
 222 }
 223
 224 static int
 225 mlx5_fwdump_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
 226     struct thread *td)
 227 {
 228         struct mlx5_core_dev *mdev;
 229         struct mlx5_fwdump_get *fwg;
 230         struct mlx5_fwdump_addr *devaddr;
 231         struct mlx5_dump_data *dd;
 232         int error;
 233
 234         error = 0;
 235         switch (cmd) {
 236         case MLX5_FWDUMP_GET:
 237                 if ((fflag & FREAD) == 0) {
 238                         error = EBADF;
 239                         break;
 240                 }
 241                 fwg = (struct mlx5_fwdump_get *)data;
 242                 devaddr = &fwg->devaddr;
 243                 error = mlx5_dbsf_to_core(devaddr, &mdev);
 244                 if (error != 0)
 245                         break;
 246                 error = mlx5_fwdump_copyout(mdev->dump_data, fwg);
 247                 break;
 248         case MLX5_FWDUMP_RESET:
 249                 if ((fflag & FWRITE) == 0) {
 250                         error = EBADF;
 251                         break;
 252                 }
 253                 devaddr = (struct mlx5_fwdump_addr *)data;
 254                 error = mlx5_dbsf_to_core(devaddr, &mdev);
 255                 if (error != 0)
 256                         break;
 257                 dd = mdev->dump_data;
 258                 if (dd != NULL)
 259                         atomic_store_rel_int(&dd->dump_valid, 0);
 260                 else
 261                         error = ENOENT;
 262                 break;
 263         case MLX5_FWDUMP_FORCE:
 264                 if ((fflag & FWRITE) == 0) {
 265                         error = EBADF;
 266                         break;
 267                 }
 268                 devaddr = (struct mlx5_fwdump_addr *)data;
 269                 error = mlx5_dbsf_to_core(devaddr, &mdev);
 270                 if (error != 0)
 271                         break;
 272                 mlx5_fwdump(mdev);
 273                 break;
 274         default:
 275                 error = ENOTTY;
 276                 break;
 277         }
 278         return (error);
 279 }
 280
 281 static struct cdevsw mlx5_fwdump_devsw = {
 282         .d_version =    D_VERSION,
 283         .d_ioctl =      mlx5_fwdump_ioctl,
 284 };
 285
 286 static struct cdev *mlx5_fwdump_dev;
 287
 288 int
 289 mlx5_fwdump_init(void)
 290 {
 291         struct make_dev_args mda;
 292         int error;
 293
 294         make_dev_args_init(&mda);
 295         mda.mda_flags = MAKEDEV_WAITOK | MAKEDEV_CHECKNAME;
 296         mda.mda_devsw = &mlx5_fwdump_devsw;
 297         mda.mda_uid = UID_ROOT;
 298         mda.mda_gid = GID_OPERATOR;
 299         mda.mda_mode = 0640;
 300         error = make_dev_s(&mda, &mlx5_fwdump_dev, "mlx5ctl");
 301         return (-error);
 302 }
 303
 304 void
 305 mlx5_fwdump_fini(void)
 306 {
 307
 308         if (mlx5_fwdump_dev != NULL)
 309                 destroy_dev(mlx5_fwdump_dev);
 310
 311 }