drivers/misc/habanalabs/common/pci.c

   1 // SPDX-License-Identifier: GPL-2.0
   2
   3 /*
   4  * Copyright 2016-2019 HabanaLabs, Ltd.
   5  * All Rights Reserved.
   6  */
   7
   8 #include "habanalabs.h"
   9 #include "../include/hw_ip/pci/pci_general.h"
  10
  11 #include <linux/pci.h>
  12
  13 #define HL_PLDM_PCI_ELBI_TIMEOUT_MSEC   (HL_PCI_ELBI_TIMEOUT_MSEC * 10)
  14
  15 #define IATU_REGION_CTRL_REGION_EN_MASK         BIT(31)
  16 #define IATU_REGION_CTRL_MATCH_MODE_MASK        BIT(30)
  17 #define IATU_REGION_CTRL_NUM_MATCH_EN_MASK      BIT(19)
  18 #define IATU_REGION_CTRL_BAR_NUM_MASK           GENMASK(10, 8)
  19
  20 /**
  21  * hl_pci_bars_map() - Map PCI BARs.
  22  * @hdev: Pointer to hl_device structure.
  23  * @name: Array of BAR names.
  24  * @is_wc: Array with flag per BAR whether a write-combined mapping is needed.
  25  *
  26  * Request PCI regions and map them to kernel virtual addresses.
  27  *
  28  * Return: 0 on success, non-zero for failure.
  29  */
  30 int hl_pci_bars_map(struct hl_device *hdev, const char * const name[3],
  31                         bool is_wc[3])
  32 {
  33         struct pci_dev *pdev = hdev->pdev;
  34         int rc, i, bar;
  35
  36         rc = pci_request_regions(pdev, HL_NAME);
  37         if (rc) {
  38                 dev_err(hdev->dev, "Cannot obtain PCI resources\n");
  39                 return rc;
  40         }
  41
  42         for (i = 0 ; i < 3 ; i++) {
  43                 bar = i * 2; /* 64-bit BARs */
  44                 hdev->pcie_bar[bar] = is_wc[i] ?
  45                                 pci_ioremap_wc_bar(pdev, bar) :
  46                                 pci_ioremap_bar(pdev, bar);
  47                 if (!hdev->pcie_bar[bar]) {
  48                         dev_err(hdev->dev, "pci_ioremap%s_bar failed for %s\n",
  49                                         is_wc[i] ? "_wc" : "", name[i]);
  50                         rc = -ENODEV;
  51                         goto err;
  52                 }
  53         }
  54
  55         return 0;
  56
  57 err:
  58         for (i = 2 ; i >= 0 ; i--) {
  59                 bar = i * 2; /* 64-bit BARs */
  60                 if (hdev->pcie_bar[bar])
  61                         iounmap(hdev->pcie_bar[bar]);
  62         }
  63
  64         pci_release_regions(pdev);
  65
  66         return rc;
  67 }
  68
  69 /**
  70  * hl_pci_bars_unmap() - Unmap PCI BARS.
  71  * @hdev: Pointer to hl_device structure.
  72  *
  73  * Release all PCI BARs and unmap their virtual addresses.
  74  */
  75 static void hl_pci_bars_unmap(struct hl_device *hdev)
  76 {
  77         struct pci_dev *pdev = hdev->pdev;
  78         int i, bar;
  79
  80         for (i = 2 ; i >= 0 ; i--) {
  81                 bar = i * 2; /* 64-bit BARs */
  82                 iounmap(hdev->pcie_bar[bar]);
  83         }
  84
  85         pci_release_regions(pdev);
  86 }
  87
  88 /**
  89  * hl_pci_elbi_write() - Write through the ELBI interface.
  90  * @hdev: Pointer to hl_device structure.
  91  * @addr: Address to write to
  92  * @data: Data to write
  93  *
  94  * Return: 0 on success, negative value for failure.
  95  */
  96 static int hl_pci_elbi_write(struct hl_device *hdev, u64 addr, u32 data)
  97 {
  98         struct pci_dev *pdev = hdev->pdev;
  99         ktime_t timeout;
 100         u64 msec;
 101         u32 val;
 102
 103         if (hdev->pldm)
 104                 msec = HL_PLDM_PCI_ELBI_TIMEOUT_MSEC;
 105         else
 106                 msec = HL_PCI_ELBI_TIMEOUT_MSEC;
 107
 108         /* Clear previous status */
 109         pci_write_config_dword(pdev, mmPCI_CONFIG_ELBI_STS, 0);
 110
 111         pci_write_config_dword(pdev, mmPCI_CONFIG_ELBI_ADDR, (u32) addr);
 112         pci_write_config_dword(pdev, mmPCI_CONFIG_ELBI_DATA, data);
 113         pci_write_config_dword(pdev, mmPCI_CONFIG_ELBI_CTRL,
 114                                 PCI_CONFIG_ELBI_CTRL_WRITE);
 115
 116         timeout = ktime_add_ms(ktime_get(), msec);
 117         for (;;) {
 118                 pci_read_config_dword(pdev, mmPCI_CONFIG_ELBI_STS, &val);
 119                 if (val & PCI_CONFIG_ELBI_STS_MASK)
 120                         break;
 121                 if (ktime_compare(ktime_get(), timeout) > 0) {
 122                         pci_read_config_dword(pdev, mmPCI_CONFIG_ELBI_STS,
 123                                                 &val);
 124                         break;
 125                 }
 126
 127                 usleep_range(300, 500);
 128         }
 129
 130         if ((val & PCI_CONFIG_ELBI_STS_MASK) == PCI_CONFIG_ELBI_STS_DONE)
 131                 return 0;
 132
 133         if (val & PCI_CONFIG_ELBI_STS_ERR) {
 134                 dev_err(hdev->dev, "Error writing to ELBI\n");
 135                 return -EIO;
 136         }
 137
 138         if (!(val & PCI_CONFIG_ELBI_STS_MASK)) {
 139                 dev_err(hdev->dev, "ELBI write didn't finish in time\n");
 140                 return -EIO;
 141         }
 142
 143         dev_err(hdev->dev, "ELBI write has undefined bits in status\n");
 144         return -EIO;
 145 }
 146
 147 /**
 148  * hl_pci_iatu_write() - iatu write routine.
 149  * @hdev: Pointer to hl_device structure.
 150  * @addr: Address to write to
 151  * @data: Data to write
 152  *
 153  * Return: 0 on success, negative value for failure.
 154  */
 155 int hl_pci_iatu_write(struct hl_device *hdev, u32 addr, u32 data)
 156 {
 157         struct asic_fixed_properties *prop = &hdev->asic_prop;
 158         u32 dbi_offset;
 159         int rc;
 160
 161         dbi_offset = addr & 0xFFF;
 162
 163         rc = hl_pci_elbi_write(hdev, prop->pcie_aux_dbi_reg_addr, 0x00300000);
 164         rc |= hl_pci_elbi_write(hdev, prop->pcie_dbi_base_address + dbi_offset,
 165                                 data);
 166
 167         if (rc)
 168                 return -EIO;
 169
 170         return 0;
 171 }
 172
 173 /**
 174  * hl_pci_reset_link_through_bridge() - Reset PCI link.
 175  * @hdev: Pointer to hl_device structure.
 176  */
 177 static void hl_pci_reset_link_through_bridge(struct hl_device *hdev)
 178 {
 179         struct pci_dev *pdev = hdev->pdev;
 180         struct pci_dev *parent_port;
 181         u16 val;
 182
 183         parent_port = pdev->bus->self;
 184         pci_read_config_word(parent_port, PCI_BRIDGE_CONTROL, &val);
 185         val |= PCI_BRIDGE_CTL_BUS_RESET;
 186         pci_write_config_word(parent_port, PCI_BRIDGE_CONTROL, val);
 187         ssleep(1);
 188
 189         val &= ~(PCI_BRIDGE_CTL_BUS_RESET);
 190         pci_write_config_word(parent_port, PCI_BRIDGE_CONTROL, val);
 191         ssleep(3);
 192 }
 193
 194 /**
 195  * hl_pci_set_inbound_region() - Configure inbound region
 196  * @hdev: Pointer to hl_device structure.
 197  * @region: Inbound region number.
 198  * @pci_region: Inbound region parameters.
 199  *
 200  * Configure the iATU inbound region.
 201  *
 202  * Return: 0 on success, negative value for failure.
 203  */
 204 int hl_pci_set_inbound_region(struct hl_device *hdev, u8 region,
 205                 struct hl_inbound_pci_region *pci_region)
 206 {
 207         struct asic_fixed_properties *prop = &hdev->asic_prop;
 208         u64 bar_phys_base, region_base, region_end_address;
 209         u32 offset, ctrl_reg_val;
 210         int rc = 0;
 211
 212         /* region offset */
 213         offset = (0x200 * region) + 0x100;
 214
 215         if (pci_region->mode == PCI_ADDRESS_MATCH_MODE) {
 216                 bar_phys_base = hdev->pcie_bar_phys[pci_region->bar];
 217                 region_base = bar_phys_base + pci_region->offset_in_bar;
 218                 region_end_address = region_base + pci_region->size - 1;
 219
 220                 rc |= hl_pci_iatu_write(hdev, offset + 0x8,
 221                                 lower_32_bits(region_base));
 222                 rc |= hl_pci_iatu_write(hdev, offset + 0xC,
 223                                 upper_32_bits(region_base));
 224                 rc |= hl_pci_iatu_write(hdev, offset + 0x10,
 225                                 lower_32_bits(region_end_address));
 226         }
 227
 228         /* Point to the specified address */
 229         rc |= hl_pci_iatu_write(hdev, offset + 0x14,
 230                         lower_32_bits(pci_region->addr));
 231         rc |= hl_pci_iatu_write(hdev, offset + 0x18,
 232                         upper_32_bits(pci_region->addr));
 233         rc |= hl_pci_iatu_write(hdev, offset + 0x0, 0);
 234
 235         /* Enable + bar/address match + match enable + bar number */
 236         ctrl_reg_val = FIELD_PREP(IATU_REGION_CTRL_REGION_EN_MASK, 1);
 237         ctrl_reg_val |= FIELD_PREP(IATU_REGION_CTRL_MATCH_MODE_MASK,
 238                         pci_region->mode);
 239         ctrl_reg_val |= FIELD_PREP(IATU_REGION_CTRL_NUM_MATCH_EN_MASK, 1);
 240
 241         if (pci_region->mode == PCI_BAR_MATCH_MODE)
 242                 ctrl_reg_val |= FIELD_PREP(IATU_REGION_CTRL_BAR_NUM_MASK,
 243                                 pci_region->bar);
 244
 245         rc |= hl_pci_iatu_write(hdev, offset + 0x4, ctrl_reg_val);
 246
 247         /* Return the DBI window to the default location */
 248         rc |= hl_pci_elbi_write(hdev, prop->pcie_aux_dbi_reg_addr, 0);
 249         rc |= hl_pci_elbi_write(hdev, prop->pcie_aux_dbi_reg_addr + 4, 0);
 250
 251         if (rc)
 252                 dev_err(hdev->dev, "failed to map bar %u to 0x%08llx\n",
 253                                 pci_region->bar, pci_region->addr);
 254
 255         return rc;
 256 }
 257
 258 /**
 259  * hl_pci_set_outbound_region() - Configure outbound region 0
 260  * @hdev: Pointer to hl_device structure.
 261  * @pci_region: Outbound region parameters.
 262  *
 263  * Configure the iATU outbound region 0.
 264  *
 265  * Return: 0 on success, negative value for failure.
 266  */
 267 int hl_pci_set_outbound_region(struct hl_device *hdev,
 268                 struct hl_outbound_pci_region *pci_region)
 269 {
 270         struct asic_fixed_properties *prop = &hdev->asic_prop;
 271         u64 outbound_region_end_address;
 272         int rc = 0;
 273
 274         /* Outbound Region 0 */
 275         outbound_region_end_address =
 276                         pci_region->addr + pci_region->size - 1;
 277         rc |= hl_pci_iatu_write(hdev, 0x008,
 278                                 lower_32_bits(pci_region->addr));
 279         rc |= hl_pci_iatu_write(hdev, 0x00C,
 280                                 upper_32_bits(pci_region->addr));
 281         rc |= hl_pci_iatu_write(hdev, 0x010,
 282                                 lower_32_bits(outbound_region_end_address));
 283         rc |= hl_pci_iatu_write(hdev, 0x014, 0);
 284
 285         if ((hdev->power9_64bit_dma_enable) && (hdev->dma_mask == 64))
 286                 rc |= hl_pci_iatu_write(hdev, 0x018, 0x08000000);
 287         else
 288                 rc |= hl_pci_iatu_write(hdev, 0x018, 0);
 289
 290         rc |= hl_pci_iatu_write(hdev, 0x020,
 291                                 upper_32_bits(outbound_region_end_address));
 292         /* Increase region size */
 293         rc |= hl_pci_iatu_write(hdev, 0x000, 0x00002000);
 294         /* Enable */
 295         rc |= hl_pci_iatu_write(hdev, 0x004, 0x80000000);
 296
 297         /* Return the DBI window to the default location */
 298         rc |= hl_pci_elbi_write(hdev, prop->pcie_aux_dbi_reg_addr, 0);
 299         rc |= hl_pci_elbi_write(hdev, prop->pcie_aux_dbi_reg_addr + 4, 0);
 300
 301         return rc;
 302 }
 303
 304 /**
 305  * hl_pci_set_dma_mask() - Set DMA masks for the device.
 306  * @hdev: Pointer to hl_device structure.
 307  *
 308  * This function sets the DMA masks (regular and consistent) for a specified
 309  * value. If it doesn't succeed, it tries to set it to a fall-back value
 310  *
 311  * Return: 0 on success, non-zero for failure.
 312  */
 313 static int hl_pci_set_dma_mask(struct hl_device *hdev)
 314 {
 315         struct pci_dev *pdev = hdev->pdev;
 316         int rc;
 317
 318         /* set DMA mask */
 319         rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(hdev->dma_mask));
 320         if (rc) {
 321                 dev_err(hdev->dev,
 322                         "Failed to set pci dma mask to %d bits, error %d\n",
 323                         hdev->dma_mask, rc);
 324                 return rc;
 325         }
 326
 327         rc = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(hdev->dma_mask));
 328         if (rc) {
 329                 dev_err(hdev->dev,
 330                         "Failed to set pci consistent dma mask to %d bits, error %d\n",
 331                         hdev->dma_mask, rc);
 332                 return rc;
 333         }
 334
 335         return 0;
 336 }
 337
 338 /**
 339  * hl_pci_init() - PCI initialization code.
 340  * @hdev: Pointer to hl_device structure.
 341  *
 342  * Set DMA masks, initialize the PCI controller and map the PCI BARs.
 343  *
 344  * Return: 0 on success, non-zero for failure.
 345  */
 346 int hl_pci_init(struct hl_device *hdev)
 347 {
 348         struct pci_dev *pdev = hdev->pdev;
 349         int rc;
 350
 351         if (hdev->reset_pcilink)
 352                 hl_pci_reset_link_through_bridge(hdev);
 353
 354         rc = pci_enable_device_mem(pdev);
 355         if (rc) {
 356                 dev_err(hdev->dev, "can't enable PCI device\n");
 357                 return rc;
 358         }
 359
 360         pci_set_master(pdev);
 361
 362         rc = hdev->asic_funcs->pci_bars_map(hdev);
 363         if (rc) {
 364                 dev_err(hdev->dev, "Failed to initialize PCI BARs\n");
 365                 goto disable_device;
 366         }
 367
 368         rc = hdev->asic_funcs->init_iatu(hdev);
 369         if (rc) {
 370                 dev_err(hdev->dev, "Failed to initialize iATU\n");
 371                 goto unmap_pci_bars;
 372         }
 373
 374         rc = hl_pci_set_dma_mask(hdev);
 375         if (rc)
 376                 goto unmap_pci_bars;
 377
 378         return 0;
 379
 380 unmap_pci_bars:
 381         hl_pci_bars_unmap(hdev);
 382 disable_device:
 383         pci_clear_master(pdev);
 384         pci_disable_device(pdev);
 385
 386         return rc;
 387 }
 388
 389 /**
 390  * hl_fw_fini() - PCI finalization code.
 391  * @hdev: Pointer to hl_device structure
 392  *
 393  * Unmap PCI bars and disable PCI device.
 394  */
 395 void hl_pci_fini(struct hl_device *hdev)
 396 {
 397         hl_pci_bars_unmap(hdev);
 398
 399         pci_clear_master(hdev->pdev);
 400         pci_disable_device(hdev->pdev);
 401 }