lib/librte_pci/rte_pci.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation.
   3  * Copyright 2013-2014 6WIND S.A.
   4  */
   5
   6 #include <string.h>
   7 #include <inttypes.h>
   8 #include <stdint.h>
   9 #include <stdlib.h>
  10 #include <stdio.h>
  11 #include <sys/queue.h>
  12 #include <sys/mman.h>
  13
  14 #include <rte_errno.h>
  15 #include <rte_interrupts.h>
  16 #include <rte_log.h>
  17 #include <rte_bus.h>
  18 #include <rte_per_lcore.h>
  19 #include <rte_memory.h>
  20 #include <rte_eal.h>
  21 #include <rte_string_fns.h>
  22 #include <rte_common.h>
  23 #include <rte_debug.h>
  24
  25 #include "rte_pci.h"
  26
  27 static inline const char *
  28 get_u8_pciaddr_field(const char *in, void *_u8, char dlm)
  29 {
  30         unsigned long val;
  31         uint8_t *u8 = _u8;
  32         char *end;
  33
  34         /* empty string is an error though strtoul() returns 0 */
  35         if (*in == '\0')
  36                 return NULL;
  37
  38         errno = 0;
  39         val = strtoul(in, &end, 16);
  40         if (errno != 0 || end[0] != dlm || val > UINT8_MAX) {
  41                 errno = errno ? errno : EINVAL;
  42                 return NULL;
  43         }
  44         *u8 = (uint8_t)val;
  45         return end + 1;
  46 }
  47
  48 static int
  49 pci_bdf_parse(const char *input, struct rte_pci_addr *dev_addr)
  50 {
  51         const char *in = input;
  52
  53         dev_addr->domain = 0;
  54         in = get_u8_pciaddr_field(in, &dev_addr->bus, ':');
  55         if (in == NULL)
  56                 return -EINVAL;
  57         in = get_u8_pciaddr_field(in, &dev_addr->devid, '.');
  58         if (in == NULL)
  59                 return -EINVAL;
  60         in = get_u8_pciaddr_field(in, &dev_addr->function, '\0');
  61         if (in == NULL)
  62                 return -EINVAL;
  63         return 0;
  64 }
  65
  66 static int
  67 pci_dbdf_parse(const char *input, struct rte_pci_addr *dev_addr)
  68 {
  69         const char *in = input;
  70         unsigned long val;
  71         char *end;
  72
  73         errno = 0;
  74         val = strtoul(in, &end, 16);
  75         if (errno != 0 || end[0] != ':' || val > UINT16_MAX)
  76                 return -EINVAL;
  77         dev_addr->domain = (uint16_t)val;
  78         in = end + 1;
  79         in = get_u8_pciaddr_field(in, &dev_addr->bus, ':');
  80         if (in == NULL)
  81                 return -EINVAL;
  82         in = get_u8_pciaddr_field(in, &dev_addr->devid, '.');
  83         if (in == NULL)
  84                 return -EINVAL;
  85         in = get_u8_pciaddr_field(in, &dev_addr->function, '\0');
  86         if (in == NULL)
  87                 return -EINVAL;
  88         return 0;
  89 }
  90
  91 void
  92 rte_pci_device_name(const struct rte_pci_addr *addr,
  93                 char *output, size_t size)
  94 {
  95         RTE_VERIFY(size >= PCI_PRI_STR_SIZE);
  96         RTE_VERIFY(snprintf(output, size, PCI_PRI_FMT,
  97                             addr->domain, addr->bus,
  98                             addr->devid, addr->function) >= 0);
  99 }
 100
 101 int
 102 rte_pci_addr_cmp(const struct rte_pci_addr *addr,
 103              const struct rte_pci_addr *addr2)
 104 {
 105         uint64_t dev_addr, dev_addr2;
 106
 107         if ((addr == NULL) || (addr2 == NULL))
 108                 return -1;
 109
 110         dev_addr = ((uint64_t)addr->domain << 24) |
 111                 (addr->bus << 16) | (addr->devid << 8) | addr->function;
 112         dev_addr2 = ((uint64_t)addr2->domain << 24) |
 113                 (addr2->bus << 16) | (addr2->devid << 8) | addr2->function;
 114
 115         if (dev_addr > dev_addr2)
 116                 return 1;
 117         else if (dev_addr < dev_addr2)
 118                 return -1;
 119         else
 120                 return 0;
 121 }
 122
 123 int
 124 rte_pci_addr_parse(const char *str, struct rte_pci_addr *addr)
 125 {
 126         if (pci_bdf_parse(str, addr) == 0 ||
 127             pci_dbdf_parse(str, addr) == 0)
 128                 return 0;
 129         return -1;
 130 }
 131
 132
 133 /* map a particular resource from a file */
 134 void *
 135 pci_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
 136                  int additional_flags)
 137 {
 138         void *mapaddr;
 139
 140         /* Map the PCI memory resource of device */
 141         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
 142                         MAP_SHARED | additional_flags, fd, offset);
 143         if (mapaddr == MAP_FAILED) {
 144                 RTE_LOG(ERR, EAL,
 145                         "%s(): cannot mmap(%d, %p, 0x%zx, 0x%llx): %s (%p)\n",
 146                         __func__, fd, requested_addr, size,
 147                         (unsigned long long)offset,
 148                         strerror(errno), mapaddr);
 149         } else
 150                 RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
 151
 152         return mapaddr;
 153 }
 154
 155 /* unmap a particular resource */
 156 void
 157 pci_unmap_resource(void *requested_addr, size_t size)
 158 {
 159         if (requested_addr == NULL)
 160                 return;
 161
 162         /* Unmap the PCI memory resource of device */
 163         if (munmap(requested_addr, size)) {
 164                 RTE_LOG(ERR, EAL, "%s(): cannot munmap(%p, %#zx): %s\n",
 165                         __func__, requested_addr, size,
 166                         strerror(errno));
 167         } else
 168                 RTE_LOG(DEBUG, EAL, "  PCI memory unmapped at %p\n",
 169                                 requested_addr);
 170 }