sys/dev/mlx5/mlx5_core/mlx5_vsc.c

   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 #include <dev/mlx5/driver.h>
  29 #include <dev/mlx5/device.h>
  30 #include <dev/mlx5/mlx5_core/mlx5_core.h>
  31
  32 #define MLX5_SEMAPHORE_SPACE_DOMAIN 0xA
  33
  34 struct mlx5_ifc_vsc_space_bits {
  35         u8 status[0x3];
  36         u8 reserved0[0xd];
  37         u8 space[0x10];
  38 };
  39
  40 struct mlx5_ifc_vsc_addr_bits {
  41         u8 flag[0x1];
  42         u8 reserved0[0x1];
  43         u8 address[0x1e];
  44 };
  45
  46 int mlx5_vsc_lock(struct mlx5_core_dev *mdev)
  47 {
  48         device_t dev = mdev->pdev->dev.bsddev;
  49         int vsc_addr = mdev->vsc_addr;
  50         int retries = 0;
  51         u32 lock_val;
  52         u32 counter;
  53
  54         if (!vsc_addr) {
  55                 mlx5_core_warn(mdev, "Unable to acquire vsc lock, vsc_addr not initialized\n");
  56                 return EINVAL;
  57         }
  58
  59         while (true) {
  60                 if (retries > MLX5_VSC_MAX_RETRIES)
  61                         return EBUSY;
  62
  63                 if (pci_read_config(dev, vsc_addr + MLX5_VSC_SEMA_OFFSET, 4)) {
  64                         retries++;
  65                         /*
  66                          * The PRM suggests random 0 - 10ms to prevent multiple
  67                          * waiters on the same interval in order to avoid starvation
  68                          */
  69                         DELAY((random() % 11) * 1000);
  70                         continue;
  71                 }
  72
  73                 counter = pci_read_config(dev, vsc_addr + MLX5_VSC_COUNTER_OFFSET, 4);
  74                 pci_write_config(dev, vsc_addr + MLX5_VSC_SEMA_OFFSET, counter, 4);
  75                 lock_val = pci_read_config(dev, vsc_addr + MLX5_VSC_SEMA_OFFSET, 4);
  76
  77                 if (lock_val == counter)
  78                         break;
  79
  80                 retries++;
  81         }
  82
  83         return 0;
  84 }
  85
  86 void mlx5_vsc_unlock(struct mlx5_core_dev *mdev)
  87 {
  88         device_t dev = mdev->pdev->dev.bsddev;
  89         int vsc_addr = mdev->vsc_addr;
  90
  91         if (!vsc_addr) {
  92                 mlx5_core_warn(mdev, "Unable to release vsc lock, vsc_addr not initialized\n");
  93                 return;
  94         }
  95
  96         pci_write_config(dev, vsc_addr + MLX5_VSC_SEMA_OFFSET, 0, 4);
  97 }
  98
  99 int
 100 mlx5_vsc_wait_on_flag(struct mlx5_core_dev *mdev, u32 expected)
 101 {
 102         device_t dev = mdev->pdev->dev.bsddev;
 103         int vsc_addr = mdev->vsc_addr;
 104         int retries = 0;
 105         u32 flag;
 106
 107         while (true) {
 108                 if (retries > MLX5_VSC_MAX_RETRIES)
 109                         return EBUSY;
 110
 111                 flag = pci_read_config(dev, vsc_addr + MLX5_VSC_ADDR_OFFSET, 4);
 112                 if (expected == MLX5_VSC_GET(vsc_addr, &flag, flag))
 113                         break;
 114
 115                 retries++;
 116                 DELAY(10);
 117         }
 118
 119         return 0;
 120 }
 121
 122 int mlx5_vsc_set_space(struct mlx5_core_dev *mdev, u16 space)
 123 {
 124         device_t dev = mdev->pdev->dev.bsddev;
 125         int vsc_addr = mdev->vsc_addr;
 126         u32 vsc_space = 0;
 127
 128         if (!vsc_addr) {
 129                 mlx5_core_warn(mdev, "Unable to set vsc space, vsc_addr not initialized\n");
 130                 return EINVAL;
 131         }
 132
 133         MLX5_VSC_SET(vsc_space, &vsc_space, space, space);
 134         pci_write_config(dev, vsc_addr + MLX5_VSC_SPACE_OFFSET, vsc_space, 4);
 135         vsc_space = pci_read_config(dev, vsc_addr + MLX5_VSC_SPACE_OFFSET, 4);
 136
 137         if (MLX5_VSC_GET(vsc_space, &vsc_space, status) != MLX5_VSC_SPACE_SUPPORTED) {
 138                 mlx5_core_warn(mdev, "Space 0x%x is not supported.\n", space);
 139                 return ENOTSUP;
 140         }
 141
 142         return 0;
 143 }
 144
 145 int mlx5_vsc_write(struct mlx5_core_dev *mdev, u32 addr, const u32 *data)
 146 {
 147         device_t dev = mdev->pdev->dev.bsddev;
 148         int vsc_addr = mdev->vsc_addr;
 149         u32 in = 0;
 150         int err;
 151
 152         if (!vsc_addr) {
 153                 mlx5_core_warn(mdev, "Unable to call vsc write, vsc_addr not initialized\n");
 154                 return EINVAL;
 155         }
 156
 157         MLX5_VSC_SET(vsc_addr, &in, address, addr);
 158         MLX5_VSC_SET(vsc_addr, &in, flag, 1);
 159         pci_write_config(dev, vsc_addr + MLX5_VSC_DATA_OFFSET, *data, 4);
 160         pci_write_config(dev, vsc_addr + MLX5_VSC_ADDR_OFFSET, in, 4);
 161
 162         err = mlx5_vsc_wait_on_flag(mdev, 0);
 163         if (err)
 164                 mlx5_core_warn(mdev, "Failed waiting for write flag!\n");
 165
 166         return err;
 167 }
 168
 169 int mlx5_vsc_read(struct mlx5_core_dev *mdev, u32 addr, u32 *data)
 170 {
 171         device_t dev = mdev->pdev->dev.bsddev;
 172         int vsc_addr = mdev->vsc_addr;
 173         int err;
 174         u32 in;
 175
 176         if (!vsc_addr) {
 177                 mlx5_core_warn(mdev, "Unable to call vsc read, vsc_addr not initialized\n");
 178                 return EINVAL;
 179         }
 180
 181         MLX5_VSC_SET(vsc_addr, &in, address, addr);
 182         pci_write_config(dev, vsc_addr + MLX5_VSC_ADDR_OFFSET, in, 4);
 183
 184         err = mlx5_vsc_wait_on_flag(mdev, 1);
 185         if (err) {
 186                 mlx5_core_warn(mdev, "Failed waiting for read complete flag!\n");
 187                 return err;
 188         }
 189
 190         *data = pci_read_config(dev, vsc_addr + MLX5_VSC_DATA_OFFSET, 4);
 191
 192         return 0;
 193 }
 194
 195 int mlx5_vsc_lock_addr_space(struct mlx5_core_dev *mdev, u32 addr)
 196 {
 197         device_t dev = mdev->pdev->dev.bsddev;
 198         int vsc_addr = mdev->vsc_addr;
 199         u32 data;
 200         int ret;
 201         u32 id;
 202
 203         ret = mlx5_vsc_set_space(mdev, MLX5_SEMAPHORE_SPACE_DOMAIN);
 204         if (ret)
 205                 return ret;
 206
 207         /* Get a unique ID based on the counter */
 208         id = pci_read_config(dev, vsc_addr + MLX5_VSC_COUNTER_OFFSET, 4);
 209
 210         /* Try to modify lock */
 211         ret = mlx5_vsc_write(mdev, addr, &id);
 212         if (ret)
 213                 return ret;
 214
 215         /* Verify */
 216         ret = mlx5_vsc_read(mdev, addr, &data);
 217         if (ret)
 218                 return ret;
 219         if (data != id)
 220                 return EBUSY;
 221
 222         return 0;
 223 }
 224
 225 int mlx5_vsc_unlock_addr_space(struct mlx5_core_dev *mdev, u32 addr)
 226 {
 227         u32 data = 0;
 228         int ret;
 229
 230         ret = mlx5_vsc_set_space(mdev, MLX5_SEMAPHORE_SPACE_DOMAIN);
 231         if (ret)
 232                 return ret;
 233
 234         /* Try to modify lock */
 235         ret = mlx5_vsc_write(mdev, addr, &data);
 236         if (ret)
 237                 return ret;
 238
 239         /* Verify */
 240         ret = mlx5_vsc_read(mdev, addr, &data);
 241         if (ret)
 242                 return ret;
 243         if (data != 0)
 244                 return EBUSY;
 245
 246         return 0;
 247 }
 248
 249 int mlx5_vsc_find_cap(struct mlx5_core_dev *mdev)
 250 {
 251         int *capreg = &mdev->vsc_addr;
 252         int err;
 253
 254         err = pci_find_cap(mdev->pdev->dev.bsddev, PCIY_VENDOR, capreg);
 255
 256         if (err)
 257                 *capreg = 0;
 258
 259         return err;
 260 }
 261