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  * prefered 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 "pciaccess.h"
  48 #include "pciaccess_private.h"
  49
  50 static int pci_device_linux_sysfs_read_rom( struct pci_device * dev,
  51     void * buffer );
  52
  53 static int pci_device_linux_sysfs_probe( struct pci_device * dev );
  54
  55 static int pci_device_linux_sysfs_map_region( struct pci_device * dev,
  56     unsigned region, int write_enable );
  57
  58 static int pci_device_linux_sysfs_unmap_region( struct pci_device * dev,
  59     unsigned region );
  60
  61 static int pci_device_linux_sysfs_read( struct pci_device * dev, void * data,
  62     pciaddr_t offset, pciaddr_t size, pciaddr_t * bytes_read );
  63
  64 static int pci_device_linux_sysfs_write( struct pci_device * dev,
  65     const void * data, pciaddr_t offset, pciaddr_t size,
  66     pciaddr_t * bytes_wrtten );
  67
  68 static const struct pci_system_methods linux_sysfs_methods = {
  69     .destroy = NULL,
  70     .destroy_device = NULL,
  71     .read_rom = pci_device_linux_sysfs_read_rom,
  72     .probe = pci_device_linux_sysfs_probe,
  73     .map = pci_device_linux_sysfs_map_region,
  74     .unmap = pci_device_linux_sysfs_unmap_region,
  75
  76     .read = pci_device_linux_sysfs_read,
  77     .write = pci_device_linux_sysfs_write,
  78
  79     .fill_capabilities = pci_fill_capabilities_generic
  80 };
  81
  82 #define SYS_BUS_PCI "/sys/bus/pci/devices"
  83
  84
  85 static void populate_entries( struct pci_system * pci_sys );
  86
  87
  88 /**
  89  * Attempt to access PCI subsystem using Linux's sysfs interface.
  90  */
  91 int
  92 pci_system_linux_sysfs_create( void )
  93 {
  94     int err = 0;
  95     struct stat st;
  96
  97
  98     /* If the directory "/sys/bus/pci/devices" exists, then the PCI subsystem
  99      * can be accessed using this interface.
 100      */
 101
 102     if ( stat( SYS_BUS_PCI, & st ) == 0 ) {
 103         pci_sys = calloc( 1, sizeof( struct pci_system ) );
 104         if ( pci_sys != NULL ) {
 105             pci_sys->methods = & linux_sysfs_methods;
 106             populate_entries( pci_sys );
 107         }
 108         else {
 109             err = ENOMEM;
 110         }
 111     }
 112     else {
 113         err = errno;
 114     }
 115
 116     return err;
 117 }
 118
 119
 120 /**
 121  * Filter out the names "." and ".." from the scanned sysfs entries.
 122  *
 123  * \param d  Directory entry being processed by \c scandir.
 124  *
 125  * \return
 126  * Zero if the entry name matches either "." or "..", non-zero otherwise.
 127  *
 128  * \sa scandir, populate_entries
 129  */
 130 static int
 131 scan_sys_pci_filter( const struct dirent * d )
 132 {
 133     return !((strcmp( d->d_name, "." ) == 0)
 134              || (strcmp( d->d_name, ".." ) == 0));
 135 }
 136
 137
 138 void
 139 populate_entries( struct pci_system * p )
 140 {
 141     struct dirent ** devices;
 142     int n;
 143     int i;
 144
 145
 146     n = scandir( SYS_BUS_PCI, & devices, scan_sys_pci_filter, alphasort );
 147     if ( n > 0 ) {
 148         p->num_devices = n;
 149         p->devices = calloc( n, sizeof( struct pci_device_private ) );
 150
 151
 152         for ( i = 0 ; i < n ; i++ ) {
 153             unsigned dom, bus, dev, func;
 154
 155
 156             sscanf( devices[ i ]->d_name, "%04x:%02x:%02x.%1u",
 157                     & dom, & bus, & dev, & func );
 158
 159             p->devices[ i ].base.domain = dom;
 160             p->devices[ i ].base.bus = bus;
 161             p->devices[ i ].base.dev = dev;
 162             p->devices[ i ].base.func = func;
 163         }
 164     }
 165 }
 166
 167
 168 static int
 169 pci_device_linux_sysfs_probe( struct pci_device * dev )
 170 {
 171     char     name[256];
 172     uint8_t  config[256];
 173     char     resource[512];
 174     int fd;
 175     pciaddr_t bytes;
 176     unsigned i;
 177     int err;
 178
 179
 180     err = pci_device_linux_sysfs_read( dev, config, 0, 256, & bytes );
 181     if ( bytes >= 64 ) {
 182         dev->vendor_id = ((uint16_t *) config)[0];
 183         dev->device_id = ((uint16_t *) config)[1];
 184         dev->device_class = (((uint32_t *) config)[2]) >> 8;
 185         dev->revision = config[8];
 186         dev->subvendor_id = ((uint16_t *) config)[22];
 187         dev->subdevice_id = ((uint16_t *) config)[23];
 188         dev->irq = config[60];
 189
 190
 191         /* The PCI config registers can be used to obtain information
 192          * about the memory and I/O regions for the device.  However,
 193          * doing so requires some tricky parsing (to correctly handle
 194          * 64-bit memory regions) and requires writing to the config
 195          * registers.  Since we'd like to avoid having to deal with the
 196          * parsing issues and non-root users can write to PCI config
 197          * registers, we use a different file in the device's sysfs
 198          * directory called "resource".
 199          *
 200          * The resource file contains all of the needed information in
 201          * a format that is consistent across all platforms.  Each BAR
 202          * and the expansion ROM have a single line of data containing
 203          * 3, 64-bit hex values:  the first address in the region,
 204          * the last address in the region, and the region's flags.
 205          */
 206         snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/resource",
 207                   SYS_BUS_PCI,
 208                   dev->domain,
 209                   dev->bus,
 210                   dev->dev,
 211                   dev->func );
 212         fd = open( name, O_RDONLY );
 213         if ( fd != -1 ) {
 214             char * next;
 215             pciaddr_t  low_addr;
 216             pciaddr_t  high_addr;
 217             pciaddr_t  flags;
 218
 219
 220             bytes = read( fd, resource, 512 );
 221             resource[511] = '\0';
 222
 223             close( fd );
 224
 225             next = resource;
 226             for ( i = 0 ; i < 6 ; i++ ) {
 227
 228                 dev->regions[i].base_addr = strtoull( next, & next, 16 );
 229                 high_addr = strtoull( next, & next, 16 );
 230                 flags = strtoull( next, & next, 16 );
 231
 232                 if ( dev->regions[i].base_addr != 0 ) {
 233                     dev->regions[i].size = (high_addr
 234                                             - dev->regions[i].base_addr) + 1;
 235
 236                     dev->regions[i].is_IO = (flags & 0x01);
 237                     dev->regions[i].is_64 = (flags & 0x04);
 238                     dev->regions[i].is_prefetchable = (flags & 0x08);
 239                 }
 240             }
 241
 242             low_addr = strtoull( next, & next, 16 );
 243             high_addr = strtoull( next, & next, 16 );
 244             flags = strtoull( next, & next, 16 );
 245             if ( low_addr != 0 ) {
 246                 dev->rom_size = (high_addr - low_addr) + 1;
 247             }
 248         }
 249     }
 250
 251     return err;
 252 }
 253
 254
 255 static int
 256 pci_device_linux_sysfs_read_rom( struct pci_device * dev, void * buffer )
 257 {
 258     char name[256];
 259     int fd;
 260     struct stat  st;
 261     int err = 0;
 262     size_t total_bytes;
 263
 264
 265     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/rom",
 266               SYS_BUS_PCI,
 267               dev->domain,
 268               dev->bus,
 269               dev->dev,
 270               dev->func );
 271
 272     fd = open( name, O_RDWR );
 273     if ( fd == -1 ) {
 274         return errno;
 275     }
 276
 277
 278     if ( fstat( fd, & st ) == -1 ) {
 279         close( fd );
 280         return errno;
 281     }
 282
 283
 284     /* This is a quirky thing on Linux.  Even though the ROM and the file
 285      * for the ROM in sysfs are read-only, the string "1" must be written to
 286      * the file to enable the ROM.  After the data has been read, "0" must be
 287      * written to the file to disable the ROM.
 288      */
 289     write( fd, "1", 1 );
 290     lseek( fd, 0, SEEK_SET );
 291
 292     for ( total_bytes = 0 ; total_bytes < st.st_size ; /* empty */ ) {
 293         const int bytes = read( fd, (char *) buffer + total_bytes,
 294                                 st.st_size - total_bytes );
 295         if ( bytes == -1 ) {
 296             err = errno;
 297             break;
 298         }
 299         else if ( bytes == 0 ) {
 300             break;
 301         }
 302
 303         total_bytes += bytes;
 304     }
 305
 306
 307     lseek( fd, 0, SEEK_SET );
 308     write( fd, "0", 1 );
 309
 310     close( fd );
 311     return err;
 312 }
 313
 314
 315 static int
 316 pci_device_linux_sysfs_read( struct pci_device * dev, void * data,
 317                              pciaddr_t offset, pciaddr_t size,
 318                              pciaddr_t * bytes_read )
 319 {
 320     char name[256];
 321     pciaddr_t temp_size = size;
 322     int err = 0;
 323     int fd;
 324
 325
 326     if ( bytes_read != NULL ) {
 327         *bytes_read = 0;
 328     }
 329
 330     /* Each device has a directory under sysfs.  Within that directory there
 331      * is a file named "config".  This file used to access the PCI config
 332      * space.  It is used here to obtain most of the information about the
 333      * device.
 334      */
 335     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/config",
 336               SYS_BUS_PCI,
 337               dev->domain,
 338               dev->bus,
 339               dev->dev,
 340               dev->func );
 341
 342     fd = open( name, O_RDONLY );
 343     if ( fd == -1 ) {
 344         return errno;
 345     }
 346
 347
 348     while ( temp_size > 0 ) {
 349         const ssize_t bytes = pread64( fd, data, temp_size, offset );
 350
 351         /* If zero bytes were read, then we assume it's the end of the
 352          * config file.
 353          */
 354         if ( bytes <= 0 ) {
 355             err = errno;
 356             break;
 357         }
 358
 359         temp_size -= bytes;
 360         offset += bytes;
 361         data += bytes;
 362     }
 363
 364     if ( bytes_read != NULL ) {
 365         *bytes_read = size - temp_size;
 366     }
 367
 368     close( fd );
 369     return err;
 370 }
 371
 372
 373 static int
 374 pci_device_linux_sysfs_write( struct pci_device * dev, const void * data,
 375                              pciaddr_t offset, pciaddr_t size,
 376                              pciaddr_t * bytes_written )
 377 {
 378     char name[256];
 379     pciaddr_t temp_size = size;
 380     int err = 0;
 381     int fd;
 382
 383
 384     if ( bytes_written != NULL ) {
 385         *bytes_written = 0;
 386     }
 387
 388     /* Each device has a directory under sysfs.  Within that directory there
 389      * is a file named "config".  This file used to access the PCI config
 390      * space.  It is used here to obtain most of the information about the
 391      * device.
 392      */
 393     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/config",
 394               SYS_BUS_PCI,
 395               dev->domain,
 396               dev->bus,
 397               dev->dev,
 398               dev->func );
 399
 400     fd = open( name, O_WRONLY );
 401     if ( fd == -1 ) {
 402         return errno;
 403     }
 404
 405
 406     while ( temp_size > 0 ) {
 407         const ssize_t bytes = pwrite64( fd, data, temp_size, offset );
 408
 409         /* If zero bytes were written, then we assume it's the end of the
 410          * config file.
 411          */
 412         if ( bytes <= 0 ) {
 413             err = errno;
 414             break;
 415         }
 416
 417         temp_size -= bytes;
 418         offset += bytes;
 419         data += bytes;
 420     }
 421
 422     if ( bytes_written != NULL ) {
 423         *bytes_written = size - temp_size;
 424     }
 425
 426     close( fd );
 427     return err;
 428 }
 429
 430
 431 /**
 432  * Map a memory region for a device using the Linux sysfs interface.
 433  *
 434  * \param dev          Device whose memory region is to be mapped.
 435  * \param region       Region, on the range [0, 5], that is to be mapped.
 436  * \param write_enable Map for writing (non-zero).
 437  *
 438  * \return
 439  * Zero on success or an \c errno value on failure.
 440  *
 441  * \sa pci_device_map_region, pci_device_linux_sysfs_unmap_region
 442  *
 443  * \todo
 444  * Some older 2.6.x kernels don't implement the resourceN files.  On those
 445  * systems /dev/mem must be used.  On these systems it is also possible that
 446  * \c mmap64 may need to be used.
 447  */
 448 static int
 449 pci_device_linux_sysfs_map_region( struct pci_device * dev, unsigned region,
 450                                    int write_enable )
 451 {
 452     char name[256];
 453     int fd;
 454     int err = 0;
 455     const int prot = (write_enable) ? (PROT_READ | PROT_WRITE) : PROT_READ;
 456
 457
 458     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/resource%u",
 459               SYS_BUS_PCI,
 460               dev->domain,
 461               dev->bus,
 462               dev->dev,
 463               dev->func,
 464               region );
 465
 466     fd = open( name, (write_enable) ? O_RDWR : O_RDONLY );
 467     if ( fd == -1 ) {
 468         return errno;
 469     }
 470
 471
 472     dev->regions[ region ].memory = mmap( NULL, dev->regions[ region ].size,
 473                                           prot, MAP_SHARED, fd, 0 );
 474     if ( dev->regions[ region ].memory == MAP_FAILED ) {
 475         err = errno;
 476         dev->regions[ region ].memory = NULL;
 477     }
 478
 479     close( fd );
 480     return err;
 481 }
 482
 483
 484 /**
 485  * Unmap the specified region using the Linux sysfs interface.
 486  *
 487  * \param dev          Device whose memory region is to be mapped.
 488  * \param region       Region, on the range [0, 5], that is to be mapped.
 489  *
 490  * \return
 491  * Zero on success or an \c errno value on failure.
 492  *
 493  * \sa pci_device_unmap_region, pci_device_linux_sysfs_map_region
 494  *
 495  * \todo
 496  * Some older 2.6.x kernels don't implement the resourceN files.  On those
 497  * systems /dev/mem must be used.  On these systems it is also possible that
 498  * \c mmap64 may need to be used.
 499  */
 500 static int
 501 pci_device_linux_sysfs_unmap_region( struct pci_device * dev, unsigned region )
 502 {
 503     int err = 0;
 504
 505     if ( munmap( dev->regions[ region ].memory, dev->regions[ region ].size )
 506          == -1 ) {
 507         err = errno;
 508     }
 509
 510     dev->regions[ region ].memory = NULL;
 511
 512     return err;
 513 }