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] + ((uint16_t)config[1] << 8);
 183         dev->device_id = (uint16_t)config[2] + ((uint16_t)config[3] << 8);
 184         dev->device_class = (uint32_t)config[9] + ((uint32_t)config[10] << 8)
 185           + ((uint16_t)config[11] << 16);
 186         dev->revision = config[8];
 187         dev->subvendor_id = (uint16_t)config[44] + ((uint16_t)config[45] << 8);
 188         dev->subdevice_id = (uint16_t)config[46] + ((uint16_t)config[47] << 8);
 189         dev->irq = config[60];
 190
 191
 192         /* The PCI config registers can be used to obtain information
 193          * about the memory and I/O regions for the device.  However,
 194          * doing so requires some tricky parsing (to correctly handle
 195          * 64-bit memory regions) and requires writing to the config
 196          * registers.  Since we'd like to avoid having to deal with the
 197          * parsing issues and non-root users can write to PCI config
 198          * registers, we use a different file in the device's sysfs
 199          * directory called "resource".
 200          *
 201          * The resource file contains all of the needed information in
 202          * a format that is consistent across all platforms.  Each BAR
 203          * and the expansion ROM have a single line of data containing
 204          * 3, 64-bit hex values:  the first address in the region,
 205          * the last address in the region, and the region's flags.
 206          */
 207         snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/resource",
 208                   SYS_BUS_PCI,
 209                   dev->domain,
 210                   dev->bus,
 211                   dev->dev,
 212                   dev->func );
 213         fd = open( name, O_RDONLY );
 214         if ( fd != -1 ) {
 215             char * next;
 216             pciaddr_t  low_addr;
 217             pciaddr_t  high_addr;
 218             pciaddr_t  flags;
 219
 220
 221             bytes = read( fd, resource, 512 );
 222             resource[511] = '\0';
 223
 224             close( fd );
 225
 226             next = resource;
 227             for ( i = 0 ; i < 6 ; i++ ) {
 228
 229                 dev->regions[i].base_addr = strtoull( next, & next, 16 );
 230                 high_addr = strtoull( next, & next, 16 );
 231                 flags = strtoull( next, & next, 16 );
 232
 233                 if ( dev->regions[i].base_addr != 0 ) {
 234                     dev->regions[i].size = (high_addr
 235                                             - dev->regions[i].base_addr) + 1;
 236
 237                     dev->regions[i].is_IO = (flags & 0x01);
 238                     dev->regions[i].is_64 = (flags & 0x04);
 239                     dev->regions[i].is_prefetchable = (flags & 0x08);
 240                 }
 241             }
 242
 243             low_addr = strtoull( next, & next, 16 );
 244             high_addr = strtoull( next, & next, 16 );
 245             flags = strtoull( next, & next, 16 );
 246             if ( low_addr != 0 ) {
 247                 dev->rom_size = (high_addr - low_addr) + 1;
 248             }
 249         }
 250     }
 251
 252     return err;
 253 }
 254
 255
 256 static int
 257 pci_device_linux_sysfs_read_rom( struct pci_device * dev, void * buffer )
 258 {
 259     char name[256];
 260     int fd;
 261     struct stat  st;
 262     int err = 0;
 263     size_t total_bytes;
 264
 265
 266     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/rom",
 267               SYS_BUS_PCI,
 268               dev->domain,
 269               dev->bus,
 270               dev->dev,
 271               dev->func );
 272
 273     fd = open( name, O_RDWR );
 274     if ( fd == -1 ) {
 275         return errno;
 276     }
 277
 278
 279     if ( fstat( fd, & st ) == -1 ) {
 280         close( fd );
 281         return errno;
 282     }
 283
 284
 285     /* This is a quirky thing on Linux.  Even though the ROM and the file
 286      * for the ROM in sysfs are read-only, the string "1" must be written to
 287      * the file to enable the ROM.  After the data has been read, "0" must be
 288      * written to the file to disable the ROM.
 289      */
 290     write( fd, "1", 1 );
 291     lseek( fd, 0, SEEK_SET );
 292
 293     for ( total_bytes = 0 ; total_bytes < st.st_size ; /* empty */ ) {
 294         const int bytes = read( fd, (char *) buffer + total_bytes,
 295                                 st.st_size - total_bytes );
 296         if ( bytes == -1 ) {
 297             err = errno;
 298             break;
 299         }
 300         else if ( bytes == 0 ) {
 301             break;
 302         }
 303
 304         total_bytes += bytes;
 305     }
 306
 307
 308     lseek( fd, 0, SEEK_SET );
 309     write( fd, "0", 1 );
 310
 311     close( fd );
 312     return err;
 313 }
 314
 315
 316 static int
 317 pci_device_linux_sysfs_read( struct pci_device * dev, void * data,
 318                              pciaddr_t offset, pciaddr_t size,
 319                              pciaddr_t * bytes_read )
 320 {
 321     char name[256];
 322     pciaddr_t temp_size = size;
 323     int err = 0;
 324     int fd;
 325
 326
 327     if ( bytes_read != NULL ) {
 328         *bytes_read = 0;
 329     }
 330
 331     /* Each device has a directory under sysfs.  Within that directory there
 332      * is a file named "config".  This file used to access the PCI config
 333      * space.  It is used here to obtain most of the information about the
 334      * device.
 335      */
 336     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/config",
 337               SYS_BUS_PCI,
 338               dev->domain,
 339               dev->bus,
 340               dev->dev,
 341               dev->func );
 342
 343     fd = open( name, O_RDONLY );
 344     if ( fd == -1 ) {
 345         return errno;
 346     }
 347
 348
 349     while ( temp_size > 0 ) {
 350         const ssize_t bytes = pread64( fd, data, temp_size, offset );
 351
 352         /* If zero bytes were read, then we assume it's the end of the
 353          * config file.
 354          */
 355         if ( bytes <= 0 ) {
 356             err = errno;
 357             break;
 358         }
 359
 360         temp_size -= bytes;
 361         offset += bytes;
 362         data += bytes;
 363     }
 364
 365     if ( bytes_read != NULL ) {
 366         *bytes_read = size - temp_size;
 367     }
 368
 369     close( fd );
 370     return err;
 371 }
 372
 373
 374 static int
 375 pci_device_linux_sysfs_write( struct pci_device * dev, const void * data,
 376                              pciaddr_t offset, pciaddr_t size,
 377                              pciaddr_t * bytes_written )
 378 {
 379     char name[256];
 380     pciaddr_t temp_size = size;
 381     int err = 0;
 382     int fd;
 383
 384
 385     if ( bytes_written != NULL ) {
 386         *bytes_written = 0;
 387     }
 388
 389     /* Each device has a directory under sysfs.  Within that directory there
 390      * is a file named "config".  This file used to access the PCI config
 391      * space.  It is used here to obtain most of the information about the
 392      * device.
 393      */
 394     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/config",
 395               SYS_BUS_PCI,
 396               dev->domain,
 397               dev->bus,
 398               dev->dev,
 399               dev->func );
 400
 401     fd = open( name, O_WRONLY );
 402     if ( fd == -1 ) {
 403         return errno;
 404     }
 405
 406
 407     while ( temp_size > 0 ) {
 408         const ssize_t bytes = pwrite64( fd, data, temp_size, offset );
 409
 410         /* If zero bytes were written, then we assume it's the end of the
 411          * config file.
 412          */
 413         if ( bytes <= 0 ) {
 414             err = errno;
 415             break;
 416         }
 417
 418         temp_size -= bytes;
 419         offset += bytes;
 420         data += bytes;
 421     }
 422
 423     if ( bytes_written != NULL ) {
 424         *bytes_written = size - temp_size;
 425     }
 426
 427     close( fd );
 428     return err;
 429 }
 430
 431
 432 /**
 433  * Map a memory region for a device using the Linux sysfs interface.
 434  *
 435  * \param dev          Device whose memory region is to be mapped.
 436  * \param region       Region, on the range [0, 5], that is to be mapped.
 437  * \param write_enable Map for writing (non-zero).
 438  *
 439  * \return
 440  * Zero on success or an \c errno value on failure.
 441  *
 442  * \sa pci_device_map_region, pci_device_linux_sysfs_unmap_region
 443  *
 444  * \todo
 445  * Some older 2.6.x kernels don't implement the resourceN files.  On those
 446  * systems /dev/mem must be used.  On these systems it is also possible that
 447  * \c mmap64 may need to be used.
 448  */
 449 static int
 450 pci_device_linux_sysfs_map_region( struct pci_device * dev, unsigned region,
 451                                    int write_enable )
 452 {
 453     char name[256];
 454     int fd;
 455     int err = 0;
 456     const int prot = (write_enable) ? (PROT_READ | PROT_WRITE) : PROT_READ;
 457
 458
 459     snprintf( name, 255, "%s/%04x:%02x:%02x.%1u/resource%u",
 460               SYS_BUS_PCI,
 461               dev->domain,
 462               dev->bus,
 463               dev->dev,
 464               dev->func,
 465               region );
 466
 467     fd = open( name, (write_enable) ? O_RDWR : O_RDONLY );
 468     if ( fd == -1 ) {
 469         return errno;
 470     }
 471
 472
 473     dev->regions[ region ].memory = mmap( NULL, dev->regions[ region ].size,
 474                                           prot, MAP_SHARED, fd, 0 );
 475     if ( dev->regions[ region ].memory == MAP_FAILED ) {
 476         err = errno;
 477         dev->regions[ region ].memory = NULL;
 478     }
 479
 480     close( fd );
 481     return err;
 482 }
 483
 484
 485 /**
 486  * Unmap the specified region using the Linux sysfs interface.
 487  *
 488  * \param dev          Device whose memory region is to be mapped.
 489  * \param region       Region, on the range [0, 5], that is to be mapped.
 490  *
 491  * \return
 492  * Zero on success or an \c errno value on failure.
 493  *
 494  * \sa pci_device_unmap_region, pci_device_linux_sysfs_map_region
 495  *
 496  * \todo
 497  * Some older 2.6.x kernels don't implement the resourceN files.  On those
 498  * systems /dev/mem must be used.  On these systems it is also possible that
 499  * \c mmap64 may need to be used.
 500  */
 501 static int
 502 pci_device_linux_sysfs_unmap_region( struct pci_device * dev, unsigned region )
 503 {
 504     int err = 0;
 505
 506     if ( munmap( dev->regions[ region ].memory, dev->regions[ region ].size )
 507          == -1 ) {
 508         err = errno;
 509     }
 510
 511     dev->regions[ region ].memory = NULL;
 512
 513     return err;
 514 }