Documentation/filesystems/sysfs-pci.txt

   1 Accessing PCI device resources through sysfs
   2 --------------------------------------------
   3
   4 sysfs, usually mounted at /sys, provides access to PCI resources on platforms
   5 that support it.  For example, a given bus might look like this:
   6
   7      /sys/devices/pci0000:17
   8      |-- 0000:17:00.0
   9      |   |-- class
  10      |   |-- config
  11      |   |-- device
  12      |   |-- enable
  13      |   |-- irq
  14      |   |-- local_cpus
  15      |   |-- resource
  16      |   |-- resource0
  17      |   |-- resource1
  18      |   |-- resource2
  19      |   |-- rom
  20      |   |-- subsystem_device
  21      |   |-- subsystem_vendor
  22      |   `-- vendor
  23      `-- ...
  24
  25 The topmost element describes the PCI domain and bus number.  In this case,
  26 the domain number is 0000 and the bus number is 17 (both values are in hex).
  27 This bus contains a single function device in slot 0.  The domain and bus
  28 numbers are reproduced for convenience.  Under the device directory are several
  29 files, each with their own function.
  30
  31        file                function
  32        ----                --------
  33        class               PCI class (ascii, ro)
  34        config              PCI config space (binary, rw)
  35        device              PCI device (ascii, ro)
  36        enable              Whether the device is enabled (ascii, rw)
  37        irq                 IRQ number (ascii, ro)
  38        local_cpus          nearby CPU mask (cpumask, ro)
  39        resource            PCI resource host addresses (ascii, ro)
  40        resource0..N        PCI resource N, if present (binary, mmap)
  41        resource0_wc..N_wc  PCI WC map resource N, if prefetchable (binary, mmap)
  42        rom                 PCI ROM resource, if present (binary, ro)
  43        subsystem_device    PCI subsystem device (ascii, ro)
  44        subsystem_vendor    PCI subsystem vendor (ascii, ro)
  45        vendor              PCI vendor (ascii, ro)
  46
  47   ro - read only file
  48   rw - file is readable and writable
  49   mmap - file is mmapable
  50   ascii - file contains ascii text
  51   binary - file contains binary data
  52   cpumask - file contains a cpumask type
  53
  54 The read only files are informational, writes to them will be ignored, with
  55 the exception of the 'rom' file.  Writable files can be used to perform
  56 actions on the device (e.g. changing config space, detaching a device).
  57 mmapable files are available via an mmap of the file at offset 0 and can be
  58 used to do actual device programming from userspace.  Note that some platforms
  59 don't support mmapping of certain resources, so be sure to check the return
  60 value from any attempted mmap.
  61
  62 The 'enable' file provides a counter that indicates how many times the device
  63 has been enabled.  If the 'enable' file currently returns '4', and a '1' is
  64 echoed into it, it will then return '5'.  Echoing a '0' into it will decrease
  65 the count.  Even when it returns to 0, though, some of the initialisation
  66 may not be reversed.
  67
  68 The 'rom' file is special in that it provides read-only access to the device's
  69 ROM file, if available.  It's disabled by default, however, so applications
  70 should write the string "1" to the file to enable it before attempting a read
  71 call, and disable it following the access by writing "0" to the file.  Note
  72 that the device must be enabled for a rom read to return data succesfully.
  73 In the event a driver is not bound to the device, it can be enabled using the
  74 'enable' file, documented above.
  75
  76 Accessing legacy resources through sysfs
  77 ----------------------------------------
  78
  79 Legacy I/O port and ISA memory resources are also provided in sysfs if the
  80 underlying platform supports them.  They're located in the PCI class hierarchy,
  81 e.g.
  82
  83         /sys/class/pci_bus/0000:17/
  84         |-- bridge -> ../../../devices/pci0000:17
  85         |-- cpuaffinity
  86         |-- legacy_io
  87         `-- legacy_mem
  88
  89 The legacy_io file is a read/write file that can be used by applications to
  90 do legacy port I/O.  The application should open the file, seek to the desired
  91 port (e.g. 0x3e8) and do a read or a write of 1, 2 or 4 bytes.  The legacy_mem
  92 file should be mmapped with an offset corresponding to the memory offset
  93 desired, e.g. 0xa0000 for the VGA frame buffer.  The application can then
  94 simply dereference the returned pointer (after checking for errors of course)
  95 to access legacy memory space.
  96
  97 Supporting PCI access on new platforms
  98 --------------------------------------
  99
 100 In order to support PCI resource mapping as described above, Linux platform
 101 code must define HAVE_PCI_MMAP and provide a pci_mmap_page_range function.
 102 Platforms are free to only support subsets of the mmap functionality, but
 103 useful return codes should be provided.
 104
 105 Legacy resources are protected by the HAVE_PCI_LEGACY define.  Platforms
 106 wishing to support legacy functionality should define it and provide
 107 pci_legacy_read, pci_legacy_write and pci_mmap_legacy_page_range functions.