Don't try to write boot_vga since that fails with EACCES
[platform/upstream/libpciaccess.git] / src / linux_sysfs.c
1 /*
2  * (C) Copyright IBM Corporation 2006
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * on the rights to use, copy, modify, merge, publish, distribute, sub
9  * license, and/or sell copies of the Software, and to permit persons to whom
10  * the Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
19  * IBM AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24
25 /**
26  * \file linux_sysfs.c
27  * Access PCI subsystem using Linux's sysfs interface.  This interface is
28  * available starting somewhere in the late 2.5.x kernel phase, and is the
29  * preferred method on all 2.6.x kernels.
30  *
31  * \author Ian Romanick <idr@us.ibm.com>
32  */
33
34 #define _GNU_SOURCE
35
36 #include <stdlib.h>
37 #include <string.h>
38 #include <stdio.h>
39 #include <unistd.h>
40 #include <sys/types.h>
41 #include <sys/stat.h>
42 #include <fcntl.h>
43 #include <sys/mman.h>
44 #include <dirent.h>
45 #include <errno.h>
46
47 #include "config.h"
48
49 #ifdef HAVE_MTRR
50 #include <asm/mtrr.h>
51 #include <sys/ioctl.h>
52 #endif
53
54 #include "pciaccess.h"
55 #include "pciaccess_private.h"
56 #include "linux_devmem.h"
57
58 static void pci_device_linux_sysfs_enable(struct pci_device *dev);
59
60 static int pci_device_linux_sysfs_read_rom( struct pci_device * dev,
61     void * buffer );
62
63 static int pci_device_linux_sysfs_probe( struct pci_device * dev );
64
65 static int pci_device_linux_sysfs_map_range(struct pci_device *dev,
66     struct pci_device_mapping *map);
67
68 static int pci_device_linux_sysfs_unmap_range(struct pci_device *dev,
69     struct pci_device_mapping *map);
70
71 static int pci_device_linux_sysfs_read( struct pci_device * dev, void * data,
72     pciaddr_t offset, pciaddr_t size, pciaddr_t * bytes_read );
73
74 static int pci_device_linux_sysfs_write( struct pci_device * dev,
75     const void * data, pciaddr_t offset, pciaddr_t size,
76     pciaddr_t * bytes_written );
77
78 static int pci_device_linux_sysfs_boot_vga( struct pci_device * dev );
79
80 static const struct pci_system_methods linux_sysfs_methods = {
81     .destroy = NULL,
82     .destroy_device = NULL,
83     .read_rom = pci_device_linux_sysfs_read_rom,
84     .probe = pci_device_linux_sysfs_probe,
85     .map_range = pci_device_linux_sysfs_map_range,
86     .unmap_range = pci_device_linux_sysfs_unmap_range,
87
88     .read = pci_device_linux_sysfs_read,
89     .write = pci_device_linux_sysfs_write,
90
91     .fill_capabilities = pci_fill_capabilities_generic,
92     .enable = pci_device_linux_sysfs_enable,
93     .boot_vga = pci_device_linux_sysfs_boot_vga,
94 };
95
96 #define SYS_BUS_PCI "/sys/bus/pci/devices"
97
98
99 static int populate_entries(struct pci_system * pci_sys);
100
101
102 /**
103  * Attempt to access PCI subsystem using Linux's sysfs interface.
104  */
105 _pci_hidden int
106 pci_system_linux_sysfs_create( void )
107 {
108     int err = 0;
109     struct stat st;
110
111
112     /* If the directory "/sys/bus/pci/devices" exists, then the PCI subsystem
113      * can be accessed using this interface.
114      */
115     
116     if ( stat( SYS_BUS_PCI, & st ) == 0 ) {
117         pci_sys = calloc( 1, sizeof( struct pci_system ) );
118         if ( pci_sys != NULL ) {
119             pci_sys->methods = & linux_sysfs_methods;
120 #ifdef HAVE_MTRR
121             pci_sys->mtrr_fd = open("/proc/mtrr", O_WRONLY);
122 #endif
123             err = populate_entries(pci_sys);
124         }
125         else {
126             err = ENOMEM;
127         }
128     }
129     else {
130         err = errno;
131     }
132
133     return err;
134 }
135
136
137 /**
138  * Filter out the names "." and ".." from the scanned sysfs entries.
139  *
140  * \param d  Directory entry being processed by \c scandir.
141  *
142  * \return
143  * Zero if the entry name matches either "." or "..", non-zero otherwise.
144  *
145  * \sa scandir, populate_entries
146  */
147 static int
148 scan_sys_pci_filter( const struct dirent * d )
149 {
150     return !((strcmp( d->d_name, "." ) == 0) 
151              || (strcmp( d->d_name, ".." ) == 0));
152 }
153
154
155 int
156 populate_entries( struct pci_system * p )
157 {
158     struct dirent ** devices;
159     int n;
160     int i;
161     int err = 0;
162
163
164     n = scandir( SYS_BUS_PCI, & devices, scan_sys_pci_filter, alphasort );
165     if ( n > 0 ) {
166         p->num_devices = n;
167         p->devices = calloc( n, sizeof( struct pci_device_private ) );
168
169         if (p->devices != NULL) {
170             for (i = 0 ; i < n ; i++) {
171                 uint8_t config[48];
172                 pciaddr_t bytes;
173                 unsigned dom, bus, dev, func;
174                 struct pci_device_private *device =
175                         (struct pci_device_private *) &p->devices[i];
176
177
178                 sscanf(devices[i]->d_name, "%04x:%02x:%02x.%1u",
179                        & dom, & bus, & dev, & func);
180
181                 device->base.domain = dom;
182                 device->base.bus = bus;
183                 device->base.dev = dev;
184                 device->base.func = func;
185
186
187                 err = pci_device_linux_sysfs_read(& device->base, config, 0,
188                                                   48, & bytes);
189                 if ((bytes == 48) && !err) {
190                     device->base.vendor_id = (uint16_t)config[0]
191                         + ((uint16_t)config[1] << 8);
192                     device->base.device_id = (uint16_t)config[2]
193                         + ((uint16_t)config[3] << 8);
194                     device->base.device_class = (uint32_t)config[9]
195                         + ((uint32_t)config[10] << 8)
196                         + ((uint32_t)config[11] << 16);
197                     device->base.revision = config[8];
198                     device->base.subvendor_id = (uint16_t)config[44]
199                         + ((uint16_t)config[45] << 8);
200                     device->base.subdevice_id = (uint16_t)config[46]
201                         + ((uint16_t)config[47] << 8);
202                 }
203
204                 if (err) {
205                     break;
206                 }
207             }
208         }
209         else {
210             err = ENOMEM;
211         }
212     }
213
214     if (err) {
215         free(p->devices);
216         p->devices = NULL;
217     }
218
219     return err;
220 }
221
222
223 static int
224 pci_device_linux_sysfs_probe( struct pci_device * dev )
225 {
226     char     name[256];
227     uint8_t  config[256];
228     char     resource[512];
229     int fd;
230     pciaddr_t bytes;
231     unsigned i;
232     int err;
233
234
235     err = pci_device_linux_sysfs_read( dev, config, 0, 256, & bytes );
236     if ( bytes >= 64 ) {
237         struct pci_device_private *priv = (struct pci_device_private *) dev;
238
239         dev->irq = config[60];
240         priv->header_type = config[14];
241
242
243         /* The PCI config registers can be used to obtain information
244          * about the memory and I/O regions for the device.  However,
245          * doing so requires some tricky parsing (to correctly handle
246          * 64-bit memory regions) and requires writing to the config
247          * registers.  Since we'd like to avoid having to deal with the
248          * parsing issues and non-root users can write to PCI config
249          * registers, we use a different file in the device's sysfs
250          * directory called "resource".
251          * 
252          * The resource file contains all of the needed information in
253          * a format that is consistent across all platforms.  Each BAR
254          * and the expansion ROM have a single line of data containing
255          * 3, 64-bit hex values:  the first address in the region,
256          * the last address in the region, and the region's flags.
257          */
258         snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/resource",
259                   SYS_BUS_PCI,
260                   dev->domain,
261                   dev->bus,
262                   dev->dev,
263                   dev->func );
264         fd = open( name, O_RDONLY );
265         if ( fd != -1 ) {
266             char * next;
267             pciaddr_t  low_addr;
268             pciaddr_t  high_addr;
269             pciaddr_t  flags;
270
271
272             bytes = read( fd, resource, 512 );
273             resource[511] = '\0';
274
275             close( fd );
276
277             next = resource;
278             for ( i = 0 ; i < 6 ; i++ ) {
279
280                 dev->regions[i].base_addr = strtoull( next, & next, 16 );
281                 high_addr = strtoull( next, & next, 16 );
282                 flags = strtoull( next, & next, 16 );
283                     
284                 if ( dev->regions[i].base_addr != 0 ) {
285                     dev->regions[i].size = (high_addr 
286                                             - dev->regions[i].base_addr) + 1;
287
288                     dev->regions[i].is_IO = (flags & 0x01);
289                     dev->regions[i].is_64 = (flags & 0x04);
290                     dev->regions[i].is_prefetchable = (flags & 0x08);
291                 }
292             }
293
294             low_addr = strtoull( next, & next, 16 );
295             high_addr = strtoull( next, & next, 16 );
296             flags = strtoull( next, & next, 16 );
297             if ( low_addr != 0 ) {
298                 priv->rom_base = low_addr;
299                 dev->rom_size = (high_addr - low_addr) + 1;
300             }
301         }
302     }
303
304     return err;
305 }
306
307
308 static int
309 pci_device_linux_sysfs_read_rom( struct pci_device * dev, void * buffer )
310 {
311     char name[256];
312     int fd;
313     struct stat  st;
314     int err = 0;
315     size_t rom_size;
316     size_t total_bytes;
317
318
319     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/rom",
320               SYS_BUS_PCI,
321               dev->domain,
322               dev->bus,
323               dev->dev,
324               dev->func );
325     
326     fd = open( name, O_RDWR );
327     if ( fd == -1 ) {
328         /* If reading the ROM using sysfs fails, fall back to the old
329          * /dev/mem based interface.
330          */
331         return pci_device_linux_devmem_read_rom(dev, buffer);
332     }
333
334
335     if ( fstat( fd, & st ) == -1 ) {
336         close( fd );
337         return errno;
338     }
339
340     rom_size = st.st_size;
341     if ( rom_size == 0 )
342         rom_size = 0x10000;
343
344     /* This is a quirky thing on Linux.  Even though the ROM and the file
345      * for the ROM in sysfs are read-only, the string "1" must be written to
346      * the file to enable the ROM.  After the data has been read, "0" must be
347      * written to the file to disable the ROM.
348      */
349     write( fd, "1", 1 );
350     lseek( fd, 0, SEEK_SET );
351
352     for ( total_bytes = 0 ; total_bytes < rom_size ; /* empty */ ) {
353         const int bytes = read( fd, (char *) buffer + total_bytes,
354                                 rom_size - total_bytes );
355         if ( bytes == -1 ) {
356             err = errno;
357             break;
358         }
359         else if ( bytes == 0 ) {
360             break;
361         }
362
363         total_bytes += bytes;
364     }
365         
366
367     lseek( fd, 0, SEEK_SET );
368     write( fd, "0", 1 );
369
370     close( fd );
371     return err;
372 }
373
374
375 static int
376 pci_device_linux_sysfs_read( struct pci_device * dev, void * data,
377                              pciaddr_t offset, pciaddr_t size,
378                              pciaddr_t * bytes_read )
379 {
380     char name[256];
381     pciaddr_t temp_size = size;
382     int err = 0;
383     int fd;
384     char *data_bytes = data;
385
386     if ( bytes_read != NULL ) {
387         *bytes_read = 0;
388     }
389
390     /* Each device has a directory under sysfs.  Within that directory there
391      * is a file named "config".  This file used to access the PCI config
392      * space.  It is used here to obtain most of the information about the
393      * device.
394      */
395     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/config",
396               SYS_BUS_PCI,
397               dev->domain,
398               dev->bus,
399               dev->dev,
400               dev->func );
401
402     fd = open( name, O_RDONLY );
403     if ( fd == -1 ) {
404         return errno;
405     }
406
407
408     while ( temp_size > 0 ) {
409         const ssize_t bytes = pread64( fd, data_bytes, temp_size, offset );
410
411         /* If zero bytes were read, then we assume it's the end of the
412          * config file.
413          */
414         if ( bytes <= 0 ) {
415             err = errno;
416             break;
417         }
418
419         temp_size -= bytes;
420         offset += bytes;
421         data_bytes += bytes;
422     }
423     
424     if ( bytes_read != NULL ) {
425         *bytes_read = size - temp_size;
426     }
427
428     close( fd );
429     return err;
430 }
431
432
433 static int
434 pci_device_linux_sysfs_write( struct pci_device * dev, const void * data,
435                              pciaddr_t offset, pciaddr_t size,
436                              pciaddr_t * bytes_written )
437 {
438     char name[256];
439     pciaddr_t temp_size = size;
440     int err = 0;
441     int fd;
442     const char *data_bytes = data;
443
444     if ( bytes_written != NULL ) {
445         *bytes_written = 0;
446     }
447
448     /* Each device has a directory under sysfs.  Within that directory there
449      * is a file named "config".  This file used to access the PCI config
450      * space.  It is used here to obtain most of the information about the
451      * device.
452      */
453     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/config",
454               SYS_BUS_PCI,
455               dev->domain,
456               dev->bus,
457               dev->dev,
458               dev->func );
459
460     fd = open( name, O_WRONLY );
461     if ( fd == -1 ) {
462         return errno;
463     }
464
465
466     while ( temp_size > 0 ) {
467         const ssize_t bytes = pwrite64( fd, data_bytes, temp_size, offset );
468
469         /* If zero bytes were written, then we assume it's the end of the
470          * config file.
471          */
472         if ( bytes <= 0 ) {
473             err = errno;
474             break;
475         }
476
477         temp_size -= bytes;
478         offset += bytes;
479         data_bytes += bytes;
480     }
481     
482     if ( bytes_written != NULL ) {
483         *bytes_written = size - temp_size;
484     }
485
486     close( fd );
487     return err;
488 }
489
490 static int
491 pci_device_linux_sysfs_map_range_wc(struct pci_device *dev,
492                                     struct pci_device_mapping *map)
493 {
494     char name[256];
495     int fd;
496     const int prot = ((map->flags & PCI_DEV_MAP_FLAG_WRITABLE) != 0) 
497         ? (PROT_READ | PROT_WRITE) : PROT_READ;
498     const int open_flags = ((map->flags & PCI_DEV_MAP_FLAG_WRITABLE) != 0) 
499         ? O_RDWR : O_RDONLY;
500     const off_t offset = map->base - dev->regions[map->region].base_addr;
501
502     snprintf(name, 255, "%s/%04x:%02x:%02x.%1u/resource%u_wc",
503              SYS_BUS_PCI,
504              dev->domain,
505              dev->bus,
506              dev->dev,
507              dev->func,
508              map->region);
509     fd = open(name, open_flags);
510     if (fd == -1)
511             return errno;
512
513     map->memory = mmap(NULL, map->size, prot, MAP_SHARED, fd, offset);
514     if (map->memory == MAP_FAILED) {
515         map->memory = NULL;
516         close(fd);
517         return errno;
518     }
519
520     close(fd);
521
522     return 0;
523 }
524
525 /**
526  * Map a memory region for a device using the Linux sysfs interface.
527  * 
528  * \param dev   Device whose memory region is to be mapped.
529  * \param map   Parameters of the mapping that is to be created.
530  * 
531  * \return
532  * Zero on success or an \c errno value on failure.
533  *
534  * \sa pci_device_map_rrange, pci_device_linux_sysfs_unmap_range
535  *
536  * \todo
537  * Some older 2.6.x kernels don't implement the resourceN files.  On those
538  * systems /dev/mem must be used.  On these systems it is also possible that
539  * \c mmap64 may need to be used.
540  */
541 static int
542 pci_device_linux_sysfs_map_range(struct pci_device *dev,
543                                  struct pci_device_mapping *map)
544 {
545     char name[256];
546     int fd;
547     int err = 0;
548     const int prot = ((map->flags & PCI_DEV_MAP_FLAG_WRITABLE) != 0) 
549         ? (PROT_READ | PROT_WRITE) : PROT_READ;
550     const int open_flags = ((map->flags & PCI_DEV_MAP_FLAG_WRITABLE) != 0) 
551         ? O_RDWR : O_RDONLY;
552     const off_t offset = map->base - dev->regions[map->region].base_addr;
553 #ifdef HAVE_MTRR
554     struct mtrr_sentry sentry = {
555         .base = map->base,
556         .size = map->size,
557         .type = MTRR_TYPE_UNCACHABLE
558     };
559 #endif
560
561     /* For WC mappings, try sysfs resourceN_wc file first */
562     if ((map->flags & PCI_DEV_MAP_FLAG_WRITE_COMBINE) &&
563         !pci_device_linux_sysfs_map_range_wc(dev, map))
564             return 0;
565
566     snprintf(name, 255, "%s/%04x:%02x:%02x.%1u/resource%u",
567              SYS_BUS_PCI,
568              dev->domain,
569              dev->bus,
570              dev->dev,
571              dev->func,
572              map->region);
573
574     fd = open(name, open_flags);
575     if (fd == -1) {
576         return errno;
577     }
578
579
580     map->memory = mmap(NULL, map->size, prot, MAP_SHARED, fd, offset);
581     if (map->memory == MAP_FAILED) {
582         map->memory = NULL;
583         close(fd);
584         return errno;
585     }
586
587 #ifdef HAVE_MTRR
588     if ((map->flags & PCI_DEV_MAP_FLAG_CACHABLE) != 0) {
589         sentry.type = MTRR_TYPE_WRBACK;
590     } else if ((map->flags & PCI_DEV_MAP_FLAG_WRITE_COMBINE) != 0) {
591         sentry.type = MTRR_TYPE_WRCOMB;
592     }
593
594     if (pci_sys->mtrr_fd != -1 && sentry.type != MTRR_TYPE_UNCACHABLE) {
595         if (ioctl(pci_sys->mtrr_fd, MTRRIOC_ADD_ENTRY, &sentry) < 0) {
596             /* FIXME: Should we report an error in this case?
597              */
598             fprintf(stderr, "error setting MTRR "
599                     "(base = 0x%08lx, size = 0x%08x, type = %u) %s (%d)\n",
600                     sentry.base, sentry.size, sentry.type,
601                     strerror(errno), errno);
602 /*            err = errno;*/
603         }
604         /* KLUDGE ALERT -- rewrite the PTEs to turn off the CD and WT bits */
605         mprotect (map->memory, map->size, PROT_NONE);
606         err = mprotect (map->memory, map->size, PROT_READ|PROT_WRITE);
607
608         if (err != 0) {
609             fprintf(stderr, "mprotect(PROT_READ | PROT_WRITE) failed: %s\n",
610                     strerror(errno));
611             fprintf(stderr, "remapping without mprotect performance kludge.\n");
612
613             munmap(map->memory, map->size);
614             map->memory = mmap(NULL, map->size, prot, MAP_SHARED, fd, offset);
615             if (map->memory == MAP_FAILED) {
616                 map->memory = NULL;
617                 close(fd);
618                 return errno;
619             }
620         }
621     }
622 #endif
623
624     close(fd);
625
626     return 0;
627 }
628
629 /**
630  * Unmap a memory region for a device using the Linux sysfs interface.
631  * 
632  * \param dev   Device whose memory region is to be unmapped.
633  * \param map   Parameters of the mapping that is to be destroyed.
634  * 
635  * \return
636  * Zero on success or an \c errno value on failure.
637  *
638  * \sa pci_device_map_rrange, pci_device_linux_sysfs_map_range
639  *
640  * \todo
641  * Some older 2.6.x kernels don't implement the resourceN files.  On those
642  * systems /dev/mem must be used.  On these systems it is also possible that
643  * \c mmap64 may need to be used.
644  */
645 static int
646 pci_device_linux_sysfs_unmap_range(struct pci_device *dev,
647                                    struct pci_device_mapping *map)
648 {
649     int err = 0;
650 #ifdef HAVE_MTRR
651     struct mtrr_sentry sentry = {
652         .base = map->base,
653         .size = map->size,
654         .type = MTRR_TYPE_UNCACHABLE
655     };
656 #endif
657
658     err = pci_device_generic_unmap_range (dev, map);
659     if (err)
660         return err;
661     
662 #ifdef HAVE_MTRR
663     if ((map->flags & PCI_DEV_MAP_FLAG_CACHABLE) != 0) {
664         sentry.type = MTRR_TYPE_WRBACK;
665     } else if ((map->flags & PCI_DEV_MAP_FLAG_WRITE_COMBINE) != 0) {
666         sentry.type = MTRR_TYPE_WRCOMB;
667     }
668
669     if (pci_sys->mtrr_fd != -1 && sentry.type != MTRR_TYPE_UNCACHABLE) {
670         if (ioctl(pci_sys->mtrr_fd, MTRRIOC_DEL_ENTRY, &sentry) < 0) {
671             /* FIXME: Should we report an error in this case?
672              */
673             fprintf(stderr, "error setting MTRR "
674                     "(base = 0x%08lx, size = 0x%08x, type = %u) %s (%d)\n",
675                     sentry.base, sentry.size, sentry.type,
676                     strerror(errno), errno);
677 /*            err = errno;*/
678         }
679     }
680 #endif
681
682     return err;
683 }
684
685 static void pci_device_linux_sysfs_enable(struct pci_device *dev)
686 {
687     char name[256];
688     int fd;
689
690     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/enable",
691               SYS_BUS_PCI,
692               dev->domain,
693               dev->bus,
694               dev->dev,
695               dev->func );
696     
697     fd = open( name, O_RDWR );
698     if (fd == -1)
699        return;
700
701     write( fd, "1", 1 );
702     close(fd);
703 }
704
705 static int pci_device_linux_sysfs_boot_vga(struct pci_device *dev)
706 {
707     char name[256];
708     char reply[3];
709     int fd, bytes_read;
710     int ret = 0;
711
712     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/boot_vga",
713               SYS_BUS_PCI,
714               dev->domain,
715               dev->bus,
716               dev->dev,
717               dev->func );
718     
719     fd = open( name, O_RDONLY );
720     if (fd == -1)
721        return 0;
722
723     bytes_read = read(fd, reply, 1);
724     if (bytes_read != 1)
725         goto out;
726     if (reply[0] == '1')
727         ret = 1;
728 out:
729     close(fd);
730     return ret;
731 }