lib/sysfs.c

   1 /*
   2  *      The PCI Library -- Configuration Access via /sys/bus/pci
   3  *
   4  *      Copyright (c) 2003 Matthew Wilcox <matthew@wil.cx>
   5  *      Copyright (c) 1997--2008 Martin Mares <mj@ucw.cz>
   6  *
   7  *      Can be freely distributed and used under the terms of the GNU GPL.
   8  */
   9
  10 #define _GNU_SOURCE
  11
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <string.h>
  15 #include <stdarg.h>
  16 #include <unistd.h>
  17 #include <errno.h>
  18 #include <dirent.h>
  19 #include <fcntl.h>
  20 #include <sys/types.h>
  21
  22 #include "internal.h"
  23 #include "pread.h"
  24
  25 static void
  26 sysfs_config(struct pci_access *a)
  27 {
  28   pci_define_param(a, "sysfs.path", PCI_PATH_SYS_BUS_PCI, "Path to the sysfs device tree");
  29 }
  30
  31 static inline char *
  32 sysfs_name(struct pci_access *a)
  33 {
  34   return pci_get_param(a, "sysfs.path");
  35 }
  36
  37 static int
  38 sysfs_detect(struct pci_access *a)
  39 {
  40   if (access(sysfs_name(a), R_OK))
  41     {
  42       a->debug("...cannot open %s", sysfs_name(a));
  43       return 0;
  44     }
  45   a->debug("...using %s", sysfs_name(a));
  46   return 1;
  47 }
  48
  49 static void
  50 sysfs_init(struct pci_access *a)
  51 {
  52   a->fd = -1;
  53 }
  54
  55 static void
  56 sysfs_cleanup(struct pci_access *a)
  57 {
  58   if (a->fd >= 0)
  59     {
  60       close(a->fd);
  61       a->fd = -1;
  62     }
  63 }
  64
  65 #define OBJNAMELEN 1024
  66 static void
  67 sysfs_obj_name(struct pci_dev *d, char *object, char *buf)
  68 {
  69   int n = snprintf(buf, OBJNAMELEN, "%s/devices/%04x:%02x:%02x.%d/%s",
  70                    sysfs_name(d->access), d->domain, d->bus, d->dev, d->func, object);
  71   if (n < 0 || n >= OBJNAMELEN)
  72     d->access->error("File name too long");
  73 }
  74
  75 static int
  76 sysfs_get_value(struct pci_dev *d, char *object)
  77 {
  78   struct pci_access *a = d->access;
  79   int fd, n;
  80   char namebuf[OBJNAMELEN], buf[256];
  81
  82   sysfs_obj_name(d, object, namebuf);
  83   fd = open(namebuf, O_RDONLY);
  84   if (fd < 0)
  85     a->error("Cannot open %s: %s", namebuf, strerror(errno));
  86   n = read(fd, buf, sizeof(buf));
  87   close(fd);
  88   if (n < 0)
  89     a->error("Error reading %s: %s", namebuf, strerror(errno));
  90   if (n >= (int) sizeof(buf))
  91     a->error("Value in %s too long", namebuf);
  92   buf[n] = 0;
  93   return strtol(buf, NULL, 0);
  94 }
  95
  96 static void
  97 sysfs_get_resources(struct pci_dev *d)
  98 {
  99   struct pci_access *a = d->access;
 100   char namebuf[OBJNAMELEN], buf[256];
 101   FILE *file;
 102   int i;
 103
 104   sysfs_obj_name(d, "resource", namebuf);
 105   file = fopen(namebuf, "r");
 106   if (!file)
 107     a->error("Cannot open %s: %s", namebuf, strerror(errno));
 108   for (i = 0; i < 7; i++)
 109     {
 110       unsigned long long start, end, size;
 111       if (!fgets(buf, sizeof(buf), file))
 112         break;
 113       if (sscanf(buf, "%llx %llx", &start, &end) != 2)
 114         a->error("Syntax error in %s", namebuf);
 115       if (start)
 116         size = end - start + 1;
 117       else
 118         size = 0;
 119       if (i < 6)
 120         {
 121           d->base_addr[i] = start;
 122           d->size[i] = size;
 123         }
 124       else
 125         {
 126           d->rom_base_addr = start;
 127           d->rom_size = size;
 128         }
 129     }
 130   fclose(file);
 131 }
 132
 133 static void sysfs_scan(struct pci_access *a)
 134 {
 135   char dirname[1024];
 136   DIR *dir;
 137   struct dirent *entry;
 138   int n;
 139
 140   n = snprintf(dirname, sizeof(dirname), "%s/devices", sysfs_name(a));
 141   if (n < 0 || n >= (int) sizeof(dirname))
 142     a->error("Directory name too long");
 143   dir = opendir(dirname);
 144   if (!dir)
 145     a->error("Cannot open %s", dirname);
 146   while ((entry = readdir(dir)))
 147     {
 148       struct pci_dev *d;
 149       unsigned int dom, bus, dev, func;
 150
 151       /* ".", ".." or a special non-device perhaps */
 152       if (entry->d_name[0] == '.')
 153         continue;
 154
 155       d = pci_alloc_dev(a);
 156       if (sscanf(entry->d_name, "%x:%x:%x.%d", &dom, &bus, &dev, &func) < 4)
 157         a->error("sysfs_scan: Couldn't parse entry name %s", entry->d_name);
 158       d->domain = dom;
 159       d->bus = bus;
 160       d->dev = dev;
 161       d->func = func;
 162       if (!a->buscentric)
 163         {
 164           sysfs_get_resources(d);
 165           d->irq = sysfs_get_value(d, "irq");
 166           /*
 167            *  We could read these faster from the config registers, but we want to give
 168            *  the kernel a chance to fix up ID's and especially classes of broken devices.
 169            */
 170           d->vendor_id = sysfs_get_value(d, "vendor");
 171           d->device_id = sysfs_get_value(d, "device");
 172           d->device_class = sysfs_get_value(d, "class") >> 8;
 173           d->known_fields = PCI_FILL_IDENT | PCI_FILL_CLASS | PCI_FILL_IRQ | PCI_FILL_BASES | PCI_FILL_ROM_BASE | PCI_FILL_SIZES;
 174         }
 175       pci_link_dev(a, d);
 176     }
 177   closedir(dir);
 178 }
 179
 180 static void
 181 sysfs_fill_slots(struct pci_dev *d)
 182 {
 183   struct pci_access *a = d->access;
 184   char dirname[1024];
 185   DIR *dir;
 186   struct dirent *entry;
 187   int n;
 188
 189   n = snprintf(dirname, sizeof(dirname), "%s/slots", sysfs_name(a));
 190   if (n < 0 || n >= (int) sizeof(dirname))
 191     a->error("Directory name too long");
 192   dir = opendir(dirname);
 193   if (!dir)
 194     a->error("Cannot open %s", dirname);
 195   while ((entry = readdir(dir)))
 196     {
 197       char namebuf[OBJNAMELEN], buf[16];
 198       FILE *file;
 199       unsigned int dom, bus, dev;
 200       struct pci_dev *pd;
 201       int n = snprintf(namebuf, OBJNAMELEN, "%s/%s/%s", dirname, entry->d_name, "address");
 202
 203       /* ".", ".." or a special non-device perhaps */
 204       if (entry->d_name[0] == '.')
 205         continue;
 206
 207       if (n < 0 || n >= OBJNAMELEN)
 208         d->access->error("File name too long");
 209       file = fopen(namebuf, "r");
 210       if (!file)
 211         a->error("Cannot open %s: %s", namebuf, strerror(errno));
 212       if (!fgets(buf, sizeof(buf), file))
 213         break;
 214       if (sscanf(buf, "%x:%x:%x", &dom, &bus, &dev) < 3)
 215         a->error("sysfs_scan: Couldn't parse entry address %s", buf);
 216       for (pd = a->devices; pd; pd = pd->next)
 217         {
 218           if (dom == pd->domain && bus == pd->bus && dev == pd->dev && !pd->phy_slot)
 219             {
 220               pd->phy_slot = pci_malloc(a, strlen(entry->d_name) + 1);
 221               strcpy(pd->phy_slot, entry->d_name);
 222             }
 223           pd->known_fields |= PCI_FILL_PHYS_SLOT;
 224         }
 225       fclose(file);
 226     }
 227   closedir(dir);
 228 }
 229
 230 static int
 231 sysfs_fill_info(struct pci_dev *d, int flags)
 232 {
 233   int ret;
 234
 235   ret = pci_generic_fill_info(d, flags);
 236   if (flags & PCI_FILL_PHYS_SLOT && !(d->known_fields & PCI_FILL_PHYS_SLOT))
 237     sysfs_fill_slots(d);
 238
 239   return ret;
 240 }
 241
 242 /* Intent of the sysfs_setup() caller */
 243 enum
 244   {
 245     SETUP_READ_CONFIG = 0,
 246     SETUP_WRITE_CONFIG = 1,
 247     SETUP_READ_VPD = 2
 248   };
 249
 250 static int
 251 sysfs_setup(struct pci_dev *d, int intent)
 252 {
 253   struct pci_access *a = d->access;
 254   char namebuf[OBJNAMELEN];
 255
 256   if (a->cached_dev != d || intent == SETUP_WRITE_CONFIG && !a->fd_rw)
 257     {
 258       if (a->fd >= 0)
 259         close(a->fd);
 260       sysfs_obj_name(d, "config", namebuf);
 261       a->fd_rw = a->writeable || intent == SETUP_WRITE_CONFIG;
 262       a->fd = open(namebuf, a->fd_rw ? O_RDWR : O_RDONLY);
 263       if (a->fd < 0)
 264         a->warning("Cannot open %s", namebuf);
 265       a->fd_pos = 0;
 266     }
 267
 268   if (a->cached_dev != d)
 269     {
 270       if (a->fd_vpd >= 0)
 271         close(a->fd_vpd);
 272       sysfs_obj_name(d, "vpd", namebuf);
 273       a->fd_vpd = open(namebuf, O_RDONLY);
 274       /* No warning on error; vpd may be absent or accessible only to root */
 275     }
 276
 277   a->cached_dev = d;
 278   return intent == SETUP_READ_VPD ? a->fd_vpd : a->fd;
 279 }
 280
 281 static int sysfs_read(struct pci_dev *d, int pos, byte *buf, int len)
 282 {
 283   int fd = sysfs_setup(d, SETUP_READ_CONFIG);
 284   int res;
 285
 286   if (fd < 0)
 287     return 0;
 288   res = do_read(d, fd, buf, len, pos);
 289   if (res < 0)
 290     {
 291       d->access->warning("sysfs_read: read failed: %s", strerror(errno));
 292       return 0;
 293     }
 294   else if (res != len)
 295     return 0;
 296   return 1;
 297 }
 298
 299 static int sysfs_write(struct pci_dev *d, int pos, byte *buf, int len)
 300 {
 301   int fd = sysfs_setup(d, SETUP_WRITE_CONFIG);
 302   int res;
 303
 304   if (fd < 0)
 305     return 0;
 306   res = do_write(d, fd, buf, len, pos);
 307   if (res < 0)
 308     {
 309       d->access->warning("sysfs_write: write failed: %s", strerror(errno));
 310       return 0;
 311     }
 312   else if (res != len)
 313     {
 314       d->access->warning("sysfs_write: tried to write %d bytes at %d, but only %d succeeded", len, pos, res);
 315       return 0;
 316     }
 317   return 1;
 318 }
 319
 320 #ifdef PCI_HAVE_DO_READ
 321
 322 /* pread() is not available and do_read() only works for a single fd, so we
 323  * cannot implement read_vpd properly. */
 324 static int sysfs_read_vpd(struct pci_dev *d, int pos, byte *buf, int len)
 325 {
 326   return 0;
 327 }
 328
 329 #else /* !PCI_HAVE_DO_READ */
 330
 331 static int sysfs_read_vpd(struct pci_dev *d, int pos, byte *buf, int len)
 332 {
 333   int fd = sysfs_setup(d, SETUP_READ_VPD);
 334   int res;
 335
 336   if (fd < 0)
 337     return 0;
 338   res = pread(fd, buf, len, pos);
 339   if (res < 0)
 340     {
 341       d->access->warning("sysfs_read_vpd: read failed: %s", strerror(errno));
 342       return 0;
 343     }
 344   else if (res != len)
 345     return 0;
 346   return 1;
 347 }
 348
 349 #endif /* PCI_HAVE_DO_READ */
 350
 351 static void sysfs_cleanup_dev(struct pci_dev *d)
 352 {
 353   struct pci_access *a = d->access;
 354
 355   if (a->cached_dev == d)
 356     {
 357       a->cached_dev = NULL;
 358       close(a->fd);
 359       a->fd = -1;
 360     }
 361 }
 362
 363 struct pci_methods pm_linux_sysfs = {
 364   "linux-sysfs",
 365   "The sys filesystem on Linux",
 366   sysfs_config,
 367   sysfs_detect,
 368   sysfs_init,
 369   sysfs_cleanup,
 370   sysfs_scan,
 371   sysfs_fill_info,
 372   sysfs_read,
 373   sysfs_write,
 374   sysfs_read_vpd,
 375   NULL,                                 /* init_dev */
 376   sysfs_cleanup_dev
 377 };