From: Ian Romanick <idr@us.ibm.com>
Date: Fri, 31 Aug 2007 19:40:03 +0000 (-0700)
Subject: Update / add comments in struct pci_mem_region.
X-Git-Tag: libpciaccess-0.10~17^2~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ebc618e7508847307713a59aeeed337a9277629d;p=platform%2Fupstream%2Flibpciaccess.git

Update / add comments in struct pci_mem_region.
---

diff --git a/include/pciaccess.h b/include/pciaccess.h
index 3146a35..4bd3672 100644
--- a/include/pciaccess.h
+++ b/include/pciaccess.h
@@ -201,10 +201,35 @@ struct pci_slot_match {
 struct pci_mem_region {
     /**
      * When the region is mapped, this is the pointer to the memory.
+     *
+     * This field is \b only set when the deprecated \c pci_device_map_region
+     * interface is used.  Use \c pci_device_map_range instead.
+     *
+     * \deprecated
      */
     void *memory;
 
+
+    /**
+     * Base physical address of the region within its bus / domain.
+     *
+     * \warning
+     * This address is really only useful to other devices in the same
+     * domain.  It's probably \b not the address applications will ever
+     * use.
+     * 
+     * \warning
+     * Most (all?) platform back-ends leave this field unset.
+     */
     pciaddr_t bus_addr;
+
+
+    /**
+     * Base physical address of the region from the CPU's point of view.
+     * 
+     * This address is typically passed to \c pci_device_map_range to create
+     * a mapping of the region to the CPU's virtual address space.
+     */
     pciaddr_t base_addr;