]> mj.ucw.cz Git - pciutils.git/blob - lib/sysfs.c
Detection of module aliases (Linux sysfs only)
[pciutils.git] / 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   a->fd_vpd = -1;
54 }
55
56 static void
57 sysfs_flush_cache(struct pci_access *a)
58 {
59   if (a->fd >= 0)
60     {
61       close(a->fd);
62       a->fd = -1;
63     }
64   if (a->fd_vpd >= 0)
65     {
66       close(a->fd_vpd);
67       a->fd_vpd = -1;
68     }
69   a->cached_dev = NULL;
70 }
71
72 static void
73 sysfs_cleanup(struct pci_access *a)
74 {
75   sysfs_flush_cache(a);
76 }
77
78 #define OBJNAMELEN 1024
79 static void
80 sysfs_obj_name(struct pci_dev *d, char *object, char *buf)
81 {
82   int n = snprintf(buf, OBJNAMELEN, "%s/devices/%04x:%02x:%02x.%d/%s",
83                    sysfs_name(d->access), d->domain, d->bus, d->dev, d->func, object);
84   if (n < 0 || n >= OBJNAMELEN)
85     d->access->error("File name too long");
86 }
87
88 #define OBJBUFSIZE 1024
89
90 static int
91 sysfs_get_string(struct pci_dev *d, char *object, char *buf, int mandatory)
92 {
93   struct pci_access *a = d->access;
94   int fd, n;
95   char namebuf[OBJNAMELEN];
96
97   sysfs_obj_name(d, object, namebuf);
98   fd = open(namebuf, O_RDONLY);
99   if (fd < 0)
100     {
101       if (mandatory)
102         a->error("Cannot open %s: %s", namebuf, strerror(errno));
103       return 0;
104     }
105   n = read(fd, buf, OBJBUFSIZE);
106   close(fd);
107   if (n < 0)
108     a->error("Error reading %s: %s", namebuf, strerror(errno));
109   if (n >= OBJBUFSIZE)
110     a->error("Value in %s too long", namebuf);
111   buf[n] = 0;
112   return 1;
113 }
114
115 static int
116 sysfs_get_value(struct pci_dev *d, char *object)
117 {
118   char buf[OBJBUFSIZE];
119
120   sysfs_get_string(d, object, buf, 1);
121   return strtol(buf, NULL, 0);
122 }
123
124 static void
125 sysfs_get_resources(struct pci_dev *d)
126 {
127   struct pci_access *a = d->access;
128   char namebuf[OBJNAMELEN], buf[256];
129   FILE *file;
130   int i;
131
132   sysfs_obj_name(d, "resource", namebuf);
133   file = fopen(namebuf, "r");
134   if (!file)
135     a->error("Cannot open %s: %s", namebuf, strerror(errno));
136   for (i = 0; i < 7; i++)
137     {
138       unsigned long long start, end, size, flags;
139       if (!fgets(buf, sizeof(buf), file))
140         break;
141       if (sscanf(buf, "%llx %llx %llx", &start, &end, &flags) != 3)
142         a->error("Syntax error in %s", namebuf);
143       if (end > start)
144         size = end - start + 1;
145       else
146         size = 0;
147       flags &= PCI_ADDR_FLAG_MASK;
148       if (i < 6)
149         {
150           d->base_addr[i] = start | flags;
151           d->size[i] = size;
152         }
153       else
154         {
155           d->rom_base_addr = start | flags;
156           d->rom_size = size;
157         }
158     }
159   fclose(file);
160 }
161
162 static void sysfs_scan(struct pci_access *a)
163 {
164   char dirname[1024];
165   DIR *dir;
166   struct dirent *entry;
167   int n;
168
169   n = snprintf(dirname, sizeof(dirname), "%s/devices", sysfs_name(a));
170   if (n < 0 || n >= (int) sizeof(dirname))
171     a->error("Directory name too long");
172   dir = opendir(dirname);
173   if (!dir)
174     a->error("Cannot open %s", dirname);
175   while ((entry = readdir(dir)))
176     {
177       struct pci_dev *d;
178       unsigned int dom, bus, dev, func;
179
180       /* ".", ".." or a special non-device perhaps */
181       if (entry->d_name[0] == '.')
182         continue;
183
184       d = pci_alloc_dev(a);
185       if (sscanf(entry->d_name, "%x:%x:%x.%d", &dom, &bus, &dev, &func) < 4)
186         a->error("sysfs_scan: Couldn't parse entry name %s", entry->d_name);
187       d->domain = dom;
188       d->bus = bus;
189       d->dev = dev;
190       d->func = func;
191       if (!a->buscentric)
192         {
193           sysfs_get_resources(d);
194           d->irq = sysfs_get_value(d, "irq");
195           /*
196            *  We could read these faster from the config registers, but we want to give
197            *  the kernel a chance to fix up ID's and especially classes of broken devices.
198            */
199           d->vendor_id = sysfs_get_value(d, "vendor");
200           d->device_id = sysfs_get_value(d, "device");
201           d->device_class = sysfs_get_value(d, "class") >> 8;
202           d->known_fields = PCI_FILL_IDENT | PCI_FILL_CLASS | PCI_FILL_IRQ | PCI_FILL_BASES | PCI_FILL_ROM_BASE | PCI_FILL_SIZES;
203         }
204       pci_link_dev(a, d);
205     }
206   closedir(dir);
207 }
208
209 static void
210 sysfs_fill_slots(struct pci_access *a)
211 {
212   char dirname[1024];
213   DIR *dir;
214   struct dirent *entry;
215   int n;
216
217   n = snprintf(dirname, sizeof(dirname), "%s/slots", sysfs_name(a));
218   if (n < 0 || n >= (int) sizeof(dirname))
219     a->error("Directory name too long");
220   dir = opendir(dirname);
221   if (!dir)
222     return;
223
224   while (entry = readdir(dir))
225     {
226       char namebuf[OBJNAMELEN], buf[16];
227       FILE *file;
228       unsigned int dom, bus, dev;
229       struct pci_dev *d;
230
231       /* ".", ".." or a special non-device perhaps */
232       if (entry->d_name[0] == '.')
233         continue;
234
235       n = snprintf(namebuf, OBJNAMELEN, "%s/%s/%s", dirname, entry->d_name, "address");
236       if (n < 0 || n >= OBJNAMELEN)
237         a->error("File name too long");
238       file = fopen(namebuf, "r");
239       /*
240        * Old versions of Linux had a fakephp which didn't have an 'address'
241        * file.  There's no useful information to be gleaned from these
242        * devices, pretend they're not there.
243        */
244       if (!file)
245         continue;
246
247       if (!fgets(buf, sizeof(buf), file) || sscanf(buf, "%x:%x:%x", &dom, &bus, &dev) < 3)
248         a->warning("sysfs_fill_slots: Couldn't parse entry address %s", buf);
249       else
250         {
251           for (d = a->devices; d; d = d->next)
252             if (dom == d->domain && bus == d->bus && dev == d->dev && !d->phy_slot)
253               d->phy_slot = pci_strdup(a, entry->d_name);
254         }
255       fclose(file);
256     }
257   closedir(dir);
258 }
259
260 static int
261 sysfs_fill_info(struct pci_dev *d, int flags)
262 {
263   if ((flags & PCI_FILL_PHYS_SLOT) && !(d->known_fields & PCI_FILL_PHYS_SLOT))
264     {
265       struct pci_dev *pd;
266       sysfs_fill_slots(d->access);
267       for (pd = d->access->devices; pd; pd = pd->next)
268         pd->known_fields |= PCI_FILL_PHYS_SLOT;
269     }
270
271   if ((flags & PCI_FILL_MODULE_ALIAS) && !(d->known_fields & PCI_FILL_MODULE_ALIAS))
272     {
273       char buf[OBJBUFSIZE];
274       if (sysfs_get_string(d, "modalias", buf, 0))
275         d->module_alias = pci_strdup(d->access, buf);
276     }
277
278   return pci_generic_fill_info(d, flags);
279 }
280
281 /* Intent of the sysfs_setup() caller */
282 enum
283   {
284     SETUP_READ_CONFIG = 0,
285     SETUP_WRITE_CONFIG = 1,
286     SETUP_READ_VPD = 2
287   };
288
289 static int
290 sysfs_setup(struct pci_dev *d, int intent)
291 {
292   struct pci_access *a = d->access;
293   char namebuf[OBJNAMELEN];
294
295   if (a->cached_dev != d || (intent == SETUP_WRITE_CONFIG && !a->fd_rw))
296     {
297       sysfs_flush_cache(a);
298       a->cached_dev = d;
299     }
300
301   if (intent == SETUP_READ_VPD)
302     {
303       if (a->fd_vpd < 0)
304         {
305           sysfs_obj_name(d, "vpd", namebuf);
306           a->fd_vpd = open(namebuf, O_RDONLY);
307           /* No warning on error; vpd may be absent or accessible only to root */
308         }
309       return a->fd_vpd;
310     }
311
312   if (a->fd < 0)
313     {
314       sysfs_obj_name(d, "config", namebuf);
315       a->fd_rw = a->writeable || intent == SETUP_WRITE_CONFIG;
316       a->fd = open(namebuf, a->fd_rw ? O_RDWR : O_RDONLY);
317       if (a->fd < 0)
318         a->warning("Cannot open %s", namebuf);
319       a->fd_pos = 0;
320     }
321   return a->fd;
322 }
323
324 static int sysfs_read(struct pci_dev *d, int pos, byte *buf, int len)
325 {
326   int fd = sysfs_setup(d, SETUP_READ_CONFIG);
327   int res;
328
329   if (fd < 0)
330     return 0;
331   res = do_read(d, fd, buf, len, pos);
332   if (res < 0)
333     {
334       d->access->warning("sysfs_read: read failed: %s", strerror(errno));
335       return 0;
336     }
337   else if (res != len)
338     return 0;
339   return 1;
340 }
341
342 static int sysfs_write(struct pci_dev *d, int pos, byte *buf, int len)
343 {
344   int fd = sysfs_setup(d, SETUP_WRITE_CONFIG);
345   int res;
346
347   if (fd < 0)
348     return 0;
349   res = do_write(d, fd, buf, len, pos);
350   if (res < 0)
351     {
352       d->access->warning("sysfs_write: write failed: %s", strerror(errno));
353       return 0;
354     }
355   else if (res != len)
356     {
357       d->access->warning("sysfs_write: tried to write %d bytes at %d, but only %d succeeded", len, pos, res);
358       return 0;
359     }
360   return 1;
361 }
362
363 #ifdef PCI_HAVE_DO_READ
364
365 /* pread() is not available and do_read() only works for a single fd, so we
366  * cannot implement read_vpd properly. */
367 static int sysfs_read_vpd(struct pci_dev *d, int pos, byte *buf, int len)
368 {
369   return 0;
370 }
371
372 #else /* !PCI_HAVE_DO_READ */
373
374 static int sysfs_read_vpd(struct pci_dev *d, int pos, byte *buf, int len)
375 {
376   int fd = sysfs_setup(d, SETUP_READ_VPD);
377   int res;
378
379   if (fd < 0)
380     return 0;
381   res = pread(fd, buf, len, pos);
382   if (res < 0)
383     {
384       d->access->warning("sysfs_read_vpd: read failed: %s", strerror(errno));
385       return 0;
386     }
387   else if (res != len)
388     return 0;
389   return 1;
390 }
391
392 #endif /* PCI_HAVE_DO_READ */
393
394 static void sysfs_cleanup_dev(struct pci_dev *d)
395 {
396   struct pci_access *a = d->access;
397
398   if (a->cached_dev == d)
399     sysfs_flush_cache(a);
400 }
401
402 struct pci_methods pm_linux_sysfs = {
403   "linux-sysfs",
404   "The sys filesystem on Linux",
405   sysfs_config,
406   sysfs_detect,
407   sysfs_init,
408   sysfs_cleanup,
409   sysfs_scan,
410   sysfs_fill_info,
411   sysfs_read,
412   sysfs_write,
413   sysfs_read_vpd,
414   NULL,                                 /* init_dev */
415   sysfs_cleanup_dev
416 };