Fix up doxygen.
authorSteve Reinhardt <stever@eecs.umich.edu>
Mon, 14 Aug 2006 23:25:07 +0000 (19:25 -0400)
committerSteve Reinhardt <stever@eecs.umich.edu>
Mon, 14 Aug 2006 23:25:07 +0000 (19:25 -0400)
--HG--
rename : docs/footer.html => src/doxygen/footer.html
rename : docs/stl.hh => src/doxygen/stl.hh
extra : convert_revision : 2b2e5637930843c1be07deaa708fd4126213cda2

39 files changed:
docs/footer.html [deleted file]
docs/stl.hh [deleted file]
src/Doxyfile
src/arch/sparc/ua2005.cc
src/base/chunk_generator.hh
src/base/loader/symtab.hh
src/dev/io_device.hh
src/dev/isa_fake.hh
src/dev/tsunami.hh
src/dev/tsunami_io.hh
src/doxygen/footer.html [new file with mode: 0644]
src/doxygen/stl.hh [new file with mode: 0644]
src/mem/bridge.cc
src/mem/bridge.hh
src/mem/bus.cc
src/mem/bus.hh
src/mem/cache/base_cache.hh
src/mem/cache/cache.hh
src/mem/cache/coherence/coherence_protocol.hh
src/mem/cache/coherence/simple_coherence.hh
src/mem/cache/coherence/uni_coherence.hh
src/mem/cache/miss/blocking_buffer.hh
src/mem/cache/miss/miss_queue.hh
src/mem/cache/miss/mshr.hh
src/mem/cache/miss/mshr_queue.hh
src/mem/cache/tags/fa_lru.hh
src/mem/cache/tags/iic.hh
src/mem/cache/tags/lru.hh
src/mem/cache/tags/split.hh
src/mem/cache/tags/split_blk.hh
src/mem/cache/tags/split_lifo.hh
src/mem/cache/tags/split_lru.hh
src/mem/mem_object.hh
src/mem/page_table.hh
src/mem/port.cc
src/mem/port.hh
src/mem/request.hh
src/mem/vport.cc
src/mem/vport.hh

diff --git a/docs/footer.html b/docs/footer.html
deleted file mode 100644 (file)
index 6ef5293..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
-<hr size="1"><address style="align: right;"><small>
-Generated on $datetime for $projectname by <a href="http://www.doxygen.org/index.html"> doxygen</a> $doxygenversion</small></address>
-
-</body>
-</html>
diff --git a/docs/stl.hh b/docs/stl.hh
deleted file mode 100644 (file)
index fd9f681..0000000
+++ /dev/null
@@ -1,69 +0,0 @@
-/*
- * Copyright (c) 2003-2005 The Regents of The University of Michigan
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer;
- * redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution;
- * neither the name of the copyright holders nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * Authors: Erik Hallnor
- *          Nathan Binkert
- */
-
-/**
- * @file
- * Dummy definitions of STL classes to pick up relationships in doxygen.
- */
-
-namespace std {
-
-/** STL vector class*/
-template <class T> class vector {
-  public:
-    /** Dummy Item */
-    T item;
-};
-
-/** STL deque class */
-template <class T> class deque {
-  public:
-    /** Dummy Item */
-    T item;
-};
-
-/** STL list class */
-template <class T> class list {
-  public:
-    /** Dummy Item */
-    T item;
-};
-
-/** STL pair class */
-template <class X, class Y> class pair {
-  public:
-    /** Dummy Item */
-    X item1;
-    /** Dummy Item */
-    Y item2;
-};
-
-}
index 38116f6b01114230b15fa40baa05313bcbd91ca5..ed4245dd21ccf494ee1ac849328989bc960c48a6 100644 (file)
@@ -30,7 +30,7 @@ PROJECT_NUMBER         =
 # If a relative path is entered, it will be relative to the location 
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docs/doxygen
+OUTPUT_DIRECTORY       = doxygen
 
 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
 # documentation generated by doxygen is written. Doxygen will use this 
@@ -570,7 +570,7 @@ HTML_HEADER            =
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard footer.
 
-HTML_FOOTER            = docs/footer.html
+HTML_FOOTER            = doxygen/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
 # style sheet that is used by each HTML page. It can be used to 
index b89d486634e02b567b3b46e2b530e179abdea535..6493ddfd582b1022947a437b799e2d55b38aee83 100644 (file)
@@ -37,7 +37,7 @@ SparcISA::MiscRegFile::setFSRegWithEffect(int miscReg, const MiscReg &val,
     int64_t time;
     SparcSystem *sys;
     switch (miscReg) {
-        /** Full system only ASRs */
+        /* Full system only ASRs */
         case MISCREG_SOFTINT:
           if (isNonPriv())
               return new PrivilegedOpcode;
@@ -94,7 +94,7 @@ SparcISA::MiscRegFile::setFSRegWithEffect(int miscReg, const MiscReg &val,
               sTickCompare.schedule(time * Clock::Int::ns);
           return NoFault;
 
-        /** Fullsystem only Priv registers. */
+        /* Fullsystem only Priv registers. */
         case MISCREG_PIL:
           if (FULL_SYSTEM) {
               setReg(miscReg, val);
@@ -104,7 +104,7 @@ SparcISA::MiscRegFile::setFSRegWithEffect(int miscReg, const MiscReg &val,
           } else
               panic("PIL not implemented for syscall emulation\n");
 
-        /** Hyper privileged registers */
+        /* Hyper privileged registers */
         case MISCREG_HPSTATE:
         case MISCREG_HINTP:
           setReg(miscReg, val);
@@ -147,7 +147,7 @@ MiscRegFile::readFSRegWithEffect(int miscReg, Fault &fault, ThreadContext * tc)
 {
     switch (miscReg) {
 
-        /** Privileged registers. */
+        /* Privileged registers. */
         case MISCREG_SOFTINT:
            if (isNonPriv()) {
                fault = new PrivilegedOpcode;
@@ -177,7 +177,7 @@ MiscRegFile::readFSRegWithEffect(int miscReg, Fault &fault, ThreadContext * tc)
            return readReg(miscReg);
 
 
-        /** Hyper privileged registers */
+        /* Hyper privileged registers */
         case MISCREG_HPSTATE:
         case MISCREG_HINTP:
           return readReg(miscReg);
index e9d5355ca3d9d2fad47b0da84fbe90f2f2ce78f4..e8238464be94b129636ac7b3ff831a6476c2cd29 100644 (file)
@@ -72,7 +72,7 @@ class ChunkGenerator
   public:
     /**
      * Constructor.
-     * @param startAddr The starting address of the region.
+     * @param _startAddr The starting address of the region.
      * @param totalSize The total size of the region.
      * @param _chunkSize The size/alignment of chunks into which
      *    the region should be decomposed.
index 55ff0c86f6a41fc9fa7ad86cf474cb2c1931d144..184c0a996a356f7c22d0d894ece6d2e24fb8aa09 100644 (file)
@@ -104,11 +104,11 @@ class SymbolTable
 
     /// Find the nearest symbol equal to or less than the supplied
     /// address (e.g., the label for the enclosing function).
-    /// @param address The address to look up.
-    /// @param symbol  Return reference for symbol string.
-    /// @param sym_address Return reference for symbol address.
-    /// @param next_sym_address Address of following symbol (for
-    /// determining valid range of symbol).
+    /// @param addr     The address to look up.
+    /// @param symbol   Return reference for symbol string.
+    /// @param symaddr  Return reference for symbol address.
+    /// @param nextaddr Address of following symbol (for
+    ///                 determining valid range of symbol).
     /// @retval True if a symbol was found.
     bool
     findNearestSymbol(Addr addr, std::string &symbol, Addr &symaddr,
@@ -126,7 +126,7 @@ class SymbolTable
     }
 
     /// Overload for findNearestSymbol() for callers who don't care
-    /// about next_sym_address.
+    /// about nextaddr.
     bool
     findNearestSymbol(Addr addr, std::string &symbol, Addr &symaddr) const
     {
index 22a32e73ae2960ae9eb691b5289ce4adf7d45987..710b22b2c4ed031979d02ed58998dd779860c6e7 100644 (file)
@@ -259,7 +259,7 @@ class BasicPioDevice : public PioDevice
     {}
 
     /** return the address ranges that this device responds to.
-     * @params range_list range list to populate with ranges
+     * @param range_list range list to populate with ranges
      */
     void addressRanges(AddrRangeList &range_list);
 
index a7a469e17a6bed9b1ff7782327205350bf71c384..5166882f8fc1c00781c8ed2c4700e0dbf4c3f939 100644 (file)
@@ -65,14 +65,14 @@ class IsaFake : public BasicPioDevice
 
     /**
      * This read always returns -1.
-     * @param req The memory request.
+     * @param pkt The memory request.
      * @param data Where to put the data.
      */
     virtual Tick read(Packet *pkt);
 
     /**
      * All writes are simply ignored.
-     * @param req The memory request.
+     * @param pkt The memory request.
      * @param data the data to not write.
      */
     virtual Tick write(Packet *pkt);
index 8bb66e9143584bc45dcddb3e13e37062f394f31e..6fbfac85132ceb71d2e83f77e94d158668b537ce 100644 (file)
@@ -83,7 +83,8 @@ class Tsunami : public Platform
     /**
      * Constructor for the Tsunami Class.
      * @param name name of the object
-     * @param intrctrl pointer to the interrupt controller
+     * @param s system the object belongs to
+     * @param intctrl pointer to the interrupt controller
      */
     Tsunami(const std::string &name, System *s, IntrControl *intctrl);
 
index ee25bbdfd497835c27d70a26b5f5ab7fdae1751b..9084a1be8017949d95797cf004d42a4baf736e13 100644 (file)
@@ -126,12 +126,14 @@ class TsunamiIO : public BasicPioDevice
 
         /**
           * Serialize this object to the given output stream.
+          * @param base The base name of the counter object.
           * @param os The stream to serialize to.
           */
         void serialize(const std::string &base, std::ostream &os);
 
         /**
          * Reconstruct the state of this object from a checkpoint.
+          * @param base The base name of the counter object.
          * @param cp The checkpoint use.
          * @param section The section name of this object
          */
@@ -221,12 +223,14 @@ class TsunamiIO : public BasicPioDevice
 
             /**
              * Serialize this object to the given output stream.
-             * @param os The stream to serialize to.
+             * @param base The base name of the counter object.
+             * @param os   The stream to serialize to.
              */
             void serialize(const std::string &base, std::ostream &os);
 
             /**
              * Reconstruct the state of this object from a checkpoint.
+             * @param base The base name of the counter object.
              * @param cp The checkpoint use.
              * @param section The section name of this object
              */
@@ -254,12 +258,14 @@ class TsunamiIO : public BasicPioDevice
 
         /**
          * Serialize this object to the given output stream.
+         * @param base The base name of the counter object.
          * @param os The stream to serialize to.
          */
         void serialize(const std::string &base, std::ostream &os);
 
         /**
          * Reconstruct the state of this object from a checkpoint.
+         * @param base The base name of the counter object.
          * @param cp The checkpoint use.
          * @param section The section name of this object
          */
diff --git a/src/doxygen/footer.html b/src/doxygen/footer.html
new file mode 100644 (file)
index 0000000..6ef5293
--- /dev/null
@@ -0,0 +1,5 @@
+<hr size="1"><address style="align: right;"><small>
+Generated on $datetime for $projectname by <a href="http://www.doxygen.org/index.html"> doxygen</a> $doxygenversion</small></address>
+
+</body>
+</html>
diff --git a/src/doxygen/stl.hh b/src/doxygen/stl.hh
new file mode 100644 (file)
index 0000000..fd9f681
--- /dev/null
@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2003-2005 The Regents of The University of Michigan
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Erik Hallnor
+ *          Nathan Binkert
+ */
+
+/**
+ * @file
+ * Dummy definitions of STL classes to pick up relationships in doxygen.
+ */
+
+namespace std {
+
+/** STL vector class*/
+template <class T> class vector {
+  public:
+    /** Dummy Item */
+    T item;
+};
+
+/** STL deque class */
+template <class T> class deque {
+  public:
+    /** Dummy Item */
+    T item;
+};
+
+/** STL list class */
+template <class T> class list {
+  public:
+    /** Dummy Item */
+    T item;
+};
+
+/** STL pair class */
+template <class X, class Y> class pair {
+  public:
+    /** Dummy Item */
+    X item1;
+    /** Dummy Item */
+    Y item2;
+};
+
+}
index 29ea2e12f4181dea33cd8c9427835369b5d65de2..9c14e7ee243acdd517e97ce2a3c19260ac366253 100644 (file)
@@ -31,7 +31,8 @@
  */
 
 /**
- * @file Definition of a simple bus bridge without buffering.
+ * @file
+ * Definition of a simple bus bridge without buffering.
  */
 
 #include <algorithm>
index b3525d3e0ffbcf1031ec675e50fcecabe4990595..2ab9799c71fd3f649adf0ea3a7d25bf0549181e2 100644 (file)
@@ -30,7 +30,8 @@
  */
 
 /**
- * @file Decleration of a simple bus bridge object with no buffering
+ * @file
+ * Declaration of a simple bus bridge object with no buffering
  */
 
 #ifndef __MEM_BRIDGE_HH__
@@ -49,7 +50,7 @@
 class Bridge : public MemObject
 {
   protected:
-    /** Decleration of the buses port type, one will be instantiated for each
+    /** Declaration of the buses port type, one will be instantiated for each
         of the interfaces connecting to the bus. */
     class BridgePort : public Port
     {
index 31271106bb755892b36032df2753e612a34451ef..b945f93b324432ca1e462bb49b5a539371b76885 100644 (file)
@@ -29,7 +29,8 @@
  */
 
 /**
- * @file Definition of a bus object.
+ * @file
+ * Definition of a bus object.
  */
 
 
index 3a2896886025dd28fd2e42fa9444b5f6d2c7c378..cd25fab2c43c1bb7c36202a261717d3a617f446d 100644 (file)
@@ -30,7 +30,8 @@
  */
 
 /**
- * @file Decleration of a bus object.
+ * @file
+ * Declaration of a bus object.
  */
 
 #ifndef __MEM_BUS_HH__
@@ -97,7 +98,7 @@ class Bus : public MemObject
     void addressRanges(AddrRangeList &resp, AddrRangeList &snoop, int id);
 
 
-    /** Decleration of the buses port type, one will be instantiated for each
+    /** Declaration of the buses port type, one will be instantiated for each
         of the interfaces connecting to the bus. */
     class BusPort : public Port
     {
index 0d1bfdfdbd5a8a1061525a4fe066cf5c69479d97..7f0cb56f2f344b98b04ec57384bd531fbd750bdd 100644 (file)
@@ -488,7 +488,7 @@ class BaseCache : public MemObject
 
     /**
      * Send a response to the slave interface.
-     * @param req The request being responded to.
+     * @param pkt The request being responded to.
      * @param time The time the response is ready.
      */
     void respond(Packet *pkt, Tick time)
@@ -501,7 +501,7 @@ class BaseCache : public MemObject
 
     /**
      * Send a reponse to the slave interface and calculate miss latency.
-     * @param req The request to respond to.
+     * @param pkt The request to respond to.
      * @param time The time the response is ready.
      */
     void respondToMiss(Packet *pkt, Tick time)
@@ -517,7 +517,7 @@ class BaseCache : public MemObject
 
     /**
      * Suppliess the data if cache to cache transfers are enabled.
-     * @param req The bus transaction to fulfill.
+     * @param pkt The bus transaction to fulfill.
      */
     void respondToSnoop(Packet *pkt)
     {
index ec5b800a8e74e90145fe5dd707e28e71ff76ef75..a26d9170989992b2bfc3709349965d72598de44c 100644 (file)
@@ -159,7 +159,7 @@ class Cache : public BaseCache
 
     /**
      * Performs the access specified by the request.
-     * @param req The request to perform.
+     * @param pkt The request to perform.
      * @return The result of the access.
      */
     bool access(Packet * &pkt);
@@ -172,26 +172,26 @@ class Cache : public BaseCache
 
     /**
      * Was the request was sent successfully?
-     * @param req The request.
+     * @param pkt The request.
      * @param success True if the request was sent successfully.
      */
     virtual void sendResult(Packet * &pkt, bool success);
 
     /**
      * Handles a response (cache line fill/write ack) from the bus.
-     * @param req The request being responded to.
+     * @param pkt The request being responded to.
      */
     void handleResponse(Packet * &pkt);
 
     /**
      * Start handling a copy transaction.
-     * @param req The copy request to perform.
+     * @param pkt The copy request to perform.
      */
     void startCopy(Packet * &pkt);
 
     /**
      * Handle a delayed copy transaction.
-     * @param req The delayed copy request to continue.
+     * @param pkt The delayed copy request to continue.
      * @param addr The address being responded to.
      * @param blk The block of the current response.
      * @param mshr The mshr being handled.
@@ -206,7 +206,7 @@ class Cache : public BaseCache
 
     /**
      * Snoops bus transactions to maintain coherence.
-     * @param req The current bus transaction.
+     * @param pkt The current bus transaction.
      */
     void snoop(Packet * &pkt);
 
@@ -221,9 +221,9 @@ class Cache : public BaseCache
     void invalidateBlk(Addr addr, int asid);
 
     /**
-     * Aquash all requests associated with specified thread.
+     * Squash all requests associated with specified thread.
      * intended for use by I-cache.
-     * @param req->getThreadNum()ber The thread to squash.
+     * @param threadNum The thread to squash.
      */
     void squash(int threadNum)
     {
@@ -246,7 +246,7 @@ class Cache : public BaseCache
      * time of completion. This function can either update the hierarchy state
      * or just perform the access wherever the data is found depending on the
      * state of the update flag.
-     * @param req The memory request to satisfy
+     * @param pkt The memory request to satisfy
      * @param update If true, update the hierarchy, otherwise just perform the
      * request.
      * @return The estimated completion time.
@@ -257,7 +257,7 @@ class Cache : public BaseCache
      * Snoop for the provided request in the cache and return the estimated
      * time of completion.
      * @todo Can a snoop probe not change state?
-     * @param req The memory request to satisfy
+     * @param pkt The memory request to satisfy
      * @param update If true, update the hierarchy, otherwise just perform the
      * request.
      * @return The estimated completion time.
index 21351ace46a8e014c12a7914110e7fd061419d95..b5d7d80aa0ef093841815c05ff435a2457a5108d 100644 (file)
@@ -85,7 +85,7 @@ class CoherenceProtocol : public SimObject
 
     /**
      * Return the proper state given the current state and the bus response.
-     * @param req The bus response.
+     * @param pkt The bus response.
      * @param oldState The current block state.
      * @return The new state.
      */
@@ -95,7 +95,7 @@ class CoherenceProtocol : public SimObject
     /**
      * Handle snooped bus requests.
      * @param cache The cache that snooped the request.
-     * @param req The snooped bus request.
+     * @param pkt The snooped bus request.
      * @param blk The cache block corresponding to the request, if any.
      * @param mshr The MSHR corresponding to the request, if any.
      * @param new_state The new coherence state of the block.
index ca9d18bebd21322cb9263c597fc610d7c4d5d9e1..71d8f36f401369ae86d82b46bdf44813412b04de 100644 (file)
@@ -96,7 +96,7 @@ class SimpleCoherence
 
     /**
      * Return the proper state given the current state and the bus response.
-     * @param req The bus response.
+     * @param pkt The bus response.
      * @param current The current block state.
      * @return The new state.
      */
@@ -107,7 +107,7 @@ class SimpleCoherence
 
     /**
      * Handle snooped bus requests.
-     * @param req The snooped bus request.
+     * @param pkt The snooped bus request.
      * @param blk The cache block corresponding to the request, if any.
      * @param mshr The MSHR corresponding to the request, if any.
      * @param new_state Return the new state for the block.
index 764bf6276159c4157a4a01eb6d48a1941377646b..27b6c7fb56a9f51e8ca5c84f548426a22e585a57 100644 (file)
@@ -88,7 +88,7 @@ class UniCoherence
 
     /**
      * Just return readable and writeable.
-     * @param req The bus response.
+     * @param pkt The bus response.
      * @param current The current block state.
      * @return The new state.
      */
@@ -116,7 +116,7 @@ class UniCoherence
 
     /**
      * Handle snooped bus requests.
-     * @param req The snooped bus request.
+     * @param pkt The snooped bus request.
      * @param blk The cache block corresponding to the request, if any.
      * @param mshr The MSHR corresponding to the request, if any.
      * @param new_state The new coherence state of the block.
index 39a06a3779afb53db1a2070ab17f0f855d3e7d33..a6261f62c07d95ef0f6b7219f5bc35e868c3cb6f 100644 (file)
@@ -107,7 +107,7 @@ public:
     /**
      * Handle a cache miss properly. Requests the bus and marks the cache as
      * blocked.
-     * @param req The request that missed in the cache.
+     * @param pkt The request that missed in the cache.
      * @param blk_size The block size of the cache.
      * @param time The time the miss is detected.
      */
@@ -128,43 +128,43 @@ public:
     }
 
     /**
-     * Selects a outstanding request to service.
-     * @return The request to service, NULL if none found.
+     * Selects a outstanding pktuest to service.
+     * @return The pktuest to service, NULL if none found.
      */
     Packet * getPacket();
 
     /**
      * Set the command to the given bus command.
-     * @param req The request to update.
+     * @param pkt The request to update.
      * @param cmd The bus command to use.
      */
     void setBusCmd(Packet * &pkt, Packet::Command cmd);
 
     /**
      * Restore the original command in case of a bus transmission error.
-     * @param req The request to reset.
+     * @param pkt The request to reset.
      */
     void restoreOrigCmd(Packet * &pkt);
 
     /**
-     * Marks a request as in service (sent on the bus). This can have side
+     * Marks a pktuest as in service (sent on the bus). This can have side
      * effect since storage for no response commands is deallocated once they
      * are successfully sent.
-     * @param req The request that was sent on the bus.
+     * @param pkt The request that was sent on the bus.
      */
     void markInService(Packet * &pkt);
 
     /**
-     * Frees the resources of the request and unblock the cache.
-     * @param req The request that has been satisfied.
-     * @param time The time when the request is satisfied.
+     * Frees the resources of the pktuest and unblock the cache.
+     * @param pkt The request that has been satisfied.
+     * @param time The time when the pktuest is satisfied.
      */
     void handleResponse(Packet * &pkt, Tick time);
 
     /**
-     * Removes all outstanding requests for a given thread number. If a request
+     * Removes all outstanding pktuests for a given thread number. If a request
      * has been sent to the bus, this function removes all of its targets.
-     * @param req->getThreadNum()ber The thread number of the requests to squash.
+     * @param threadNum The thread number of the requests to squash.
      */
     void squash(int threadNum);
 
@@ -220,14 +220,14 @@ public:
                      int size, uint8_t *data, bool compressed);
 
     /**
-     * Perform a writeback request.
-     * @param req The writeback request.
+     * Perform a writeback pktuest.
+     * @param pkt The writeback request.
      */
     void doWriteback(Packet * &pkt);
 
     /**
-     * Returns true if there are outstanding requests.
-     * @return True if there are outstanding requests.
+     * Returns true if there are outstanding pktuests.
+     * @return True if there are outstanding pktuests.
      */
     bool havePending()
     {
@@ -237,7 +237,7 @@ public:
     /**
      * Add a target to the given MSHR. This assumes it is in the miss queue.
      * @param mshr The mshr to add a target to.
-     * @param req The target to add.
+     * @param pkt The target to add.
      */
     void addTarget(MSHR *mshr, Packet * &pkt)
     {
index b88b7038c6aba003708488f561bd2409777a770b..c558df956ada5b4339378dbef564f1b4d7c88d2a 100644 (file)
@@ -77,7 +77,7 @@ class MissQueue
     /** The block size of the parent cache. */
     int blkSize;
 
-    /** Increasing order number assigned to each incoming request. */
+    /** Increasing order number assigned to each incoming pktuest. */
     uint64_t order;
 
     bool prefetchMiss;
@@ -164,7 +164,7 @@ class MissQueue
 
     /**
      * Allocate a new MSHR to handle the provided miss.
-     * @param req The miss to buffer.
+     * @param pkt The miss to buffer.
      * @param size The number of bytes to fetch.
      * @param time The time the miss occurs.
      * @return A pointer to the new MSHR.
@@ -173,7 +173,7 @@ class MissQueue
 
     /**
      * Allocate a new WriteBuffer to handle the provided write.
-     * @param req The write to handle.
+     * @param pkt The write to handle.
      * @param size The number of bytes to write.
      * @param time The time the write occurs.
      * @return A pointer to the new write buffer.
@@ -212,9 +212,9 @@ class MissQueue
     void setPrefetcher(BasePrefetcher *_prefetcher);
 
     /**
-     * Handle a cache miss properly. Either allocate an MSHR for the request,
+     * Handle a cache miss properly. Either allocate an MSHR for the pktuest,
      * or forward it through the write buffer.
-     * @param req The request that missed in the cache.
+     * @param pkt The request that missed in the cache.
      * @param blk_size The block size of the cache.
      * @param time The time the miss is detected.
      */
@@ -232,43 +232,43 @@ class MissQueue
                      Packet * &target);
 
     /**
-     * Selects a outstanding request to service.
-     * @return The request to service, NULL if none found.
+     * Selects a outstanding pktuest to service.
+     * @return The pktuest to service, NULL if none found.
      */
     Packet * getPacket();
 
     /**
      * Set the command to the given bus command.
-     * @param req The request to update.
+     * @param pkt The request to update.
      * @param cmd The bus command to use.
      */
     void setBusCmd(Packet * &pkt, Packet::Command cmd);
 
     /**
      * Restore the original command in case of a bus transmission error.
-     * @param req The request to reset.
+     * @param pkt The request to reset.
      */
     void restoreOrigCmd(Packet * &pkt);
 
     /**
-     * Marks a request as in service (sent on the bus). This can have side
+     * Marks a pktuest as in service (sent on the bus). This can have side
      * effect since storage for no response commands is deallocated once they
      * are successfully sent.
-     * @param req The request that was sent on the bus.
+     * @param pkt The request that was sent on the bus.
      */
     void markInService(Packet * &pkt);
 
     /**
-     * Collect statistics and free resources of a satisfied request.
-     * @param req The request that has been satisfied.
-     * @param time The time when the request is satisfied.
+     * Collect statistics and free resources of a satisfied pktuest.
+     * @param pkt The request that has been satisfied.
+     * @param time The time when the pktuest is satisfied.
      */
     void handleResponse(Packet * &pkt, Tick time);
 
     /**
-     * Removes all outstanding requests for a given thread number. If a request
+     * Removes all outstanding pktuests for a given thread number. If a request
      * has been sent to the bus, this function removes all of its targets.
-     * @param req->getThreadNum()ber The thread number of the requests to squash.
+     * @param threadNum The thread number of the requests to squash.
      */
     void squash(int threadNum);
 
@@ -313,21 +313,21 @@ class MissQueue
                      int size, uint8_t *data, bool compressed);
 
     /**
-     * Perform the given writeback request.
-     * @param req The writeback request.
+     * Perform the given writeback pktuest.
+     * @param pkt The writeback request.
      */
     void doWriteback(Packet * &pkt);
 
     /**
-     * Returns true if there are outstanding requests.
-     * @return True if there are outstanding requests.
+     * Returns true if there are outstanding pktuests.
+     * @return True if there are outstanding pktuests.
      */
     bool havePending();
 
     /**
      * Add a target to the given MSHR. This assumes it is in the miss queue.
      * @param mshr The mshr to add a target to.
-     * @param req The target to add.
+     * @param pkt The target to add.
      */
     void addTarget(MSHR *mshr, Packet * &pkt)
     {
index 167aa26cd135217aa3b7a6f99b8c1b5f037e1d93..ad286597392844387d3754910800dda31684abb8 100644 (file)
@@ -44,7 +44,7 @@ class MSHR;
 
 /**
  * Miss Status and handling Register. This class keeps all the information
- * needed to handle a cache miss including a list of target requests.
+ * needed to handle a cache miss including a list of target pktuests.
  */
 class MSHR {
   public:
@@ -63,15 +63,15 @@ class MSHR {
     Addr addr;
     /** Adress space id of the miss. */
     short asid;
-    /** True if the request has been sent to the bus. */
+    /** True if the pktuest has been sent to the bus. */
     bool inService;
     /** Thread number of the miss. */
     int threadNum;
-    /** The request that is forwarded to the next level of the hierarchy. */
+    /** The pktuest that is forwarded to the next level of the hierarchy. */
     Packet * pkt;
     /** The number of currently allocated targets. */
     short ntargets;
-    /** The original requesting command. */
+    /** The original pktuesting command. */
     Packet::Command originalCmd;
     /** Order number of assigned by the miss queue. */
     uint64_t order;
@@ -88,24 +88,24 @@ class MSHR {
     Iterator allocIter;
 
 private:
-    /** List of all requests that match the address */
+    /** List of all pktuests that match the address */
     TargetList targets;
 
 public:
     /**
      * Allocate a miss to this MSHR.
-     * @param cmd The requesting command.
+     * @param cmd The pktuesting command.
      * @param addr The address of the miss.
      * @param asid The address space id of the miss.
-     * @param size The number of bytes to request.
-     * @param req  The original miss.
+     * @param size The number of bytes to pktuest.
+     * @param pkt  The original miss.
      */
     void allocate(Packet::Command cmd, Addr addr, int asid, int size,
                   Packet * &pkt);
 
     /**
-     * Allocate this MSHR as a buffer for the given request.
-     * @param target The memory request to buffer.
+     * Allocate this MSHR as a buffer for the given pktuest.
+     * @param target The memory pktuest to buffer.
      */
     void allocateAsBuffer(Packet * &target);
 
@@ -115,7 +115,7 @@ public:
     void deallocate();
 
     /**
-     * Add a request to the list of targets.
+     * Add a pktuest to the list of targets.
      * @param target The target.
      */
     void allocateTarget(Packet * &target);
index a67f1b9a6f1b89b1d329e8fed00fdf691e1f313f..02b6a026d9c510f949150c32b0a740a899293078 100644 (file)
@@ -39,7 +39,7 @@
 #include "mem/cache/miss/mshr.hh"
 
 /**
- * A Class for maintaining a list of pending and allocated memory requests.
+ * A Class for maintaining a list of pending and allocated memory pktuests.
  */
 class MSHRQueue {
   private:
@@ -55,7 +55,7 @@ class MSHRQueue {
     // Parameters
     /**
      * The total number of MSHRs in this queue. This number is set as the
-     * number of MSHRs requested plus (numReserve - 1). This allows for
+     * number of MSHRs pktuested plus (numReserve - 1). This allows for
      * the same number of effective MSHRs while still maintaining the reserve.
      */
     const int numMSHRs;
@@ -103,16 +103,16 @@ class MSHRQueue {
     bool findMatches(Addr addr, int asid, std::vector<MSHR*>& matches) const;
 
     /**
-     * Find any pending requests that overlap the given request.
-     * @param req The request to find.
+     * Find any pending pktuests that overlap the given request.
+     * @param pkt The request to find.
      * @return A pointer to the earliest matching MSHR.
      */
     MSHR* findPending(Packet * &pkt) const;
 
     /**
-     * Allocates a new MSHR for the request and size. This places the request
+     * Allocates a new MSHR for the pktuest and size. This places the request
      * as the first target in the MSHR.
-     * @param req The request to handle.
+     * @param pkt The request to handle.
      * @param size The number in bytes to fetch from memory.
      * @return The a pointer to the MSHR allocated.
      *
@@ -121,12 +121,12 @@ class MSHRQueue {
     MSHR* allocate(Packet * &pkt, int size = 0);
 
     /**
-     * Allocate a read request for the given address, and places the given
+     * Allocate a read pktuest for the given address, and places the given
      * target on the target list.
      * @param addr The address to fetch.
      * @param asid The address space for the fetch.
-     * @param size The number of bytes to request.
-     * @param target The first target for the request.
+     * @param size The number of bytes to pktuest.
+     * @param target The first target for the pktuest.
      * @return Pointer to the new MSHR.
      */
     MSHR* allocateFetch(Addr addr, int asid, int size, Packet * &target);
@@ -135,7 +135,7 @@ class MSHRQueue {
      * Allocate a target list for the given address.
      * @param addr The address to fetch.
      * @param asid The address space for the fetch.
-     * @param size The number of bytes to request.
+     * @param size The number of bytes to pktuest.
      * @return Pointer to the new MSHR.
      */
     MSHR* allocateTargetList(Addr addr, int asid, int size);
@@ -151,7 +151,7 @@ class MSHRQueue {
      * Allocates a target to the given MSHR. Used to keep track of the number
      * of outstanding targets.
      * @param mshr The MSHR to allocate the target to.
-     * @param req The target request.
+     * @param pkt The target request.
      */
     void allocateTarget(MSHR* mshr, Packet * &pkt)
     {
@@ -181,22 +181,22 @@ class MSHRQueue {
     void markInService(MSHR* mshr);
 
     /**
-     * Mark an in service mshr as pending, used to resend a request.
+     * Mark an in service mshr as pending, used to resend a pktuest.
      * @param mshr The MSHR to resend.
      * @param cmd The command to resend.
      */
     void markPending(MSHR* mshr, Packet::Command cmd);
 
     /**
-     * Squash outstanding requests with the given thread number. If a request
+     * Squash outstanding pktuests with the given thread number. If a request
      * is in service, just squashes the targets.
-     * @param req->getThreadNum()ber The thread to squash.
+     * @param threadNum The thread to squash.
      */
     void squash(int threadNum);
 
     /**
      * Returns true if the pending list is not empty.
-     * @return True if there are outstanding requests.
+     * @return True if there are outstanding pktuests.
      */
     bool havePending() const
     {
@@ -213,8 +213,8 @@ class MSHRQueue {
     }
 
     /**
-     * Returns the request at the head of the pendingList.
-     * @return The next request to service.
+     * Returns the pktuest at the head of the pendingList.
+     * @return The next pktuest to service.
      */
     Packet * getReq() const
     {
index 566e36c2776c4431da1026e8dc5e6e64f672b7c6..444954917c93bb608a9c4da184743d91bde5d64c 100644 (file)
@@ -193,7 +193,7 @@ public:
     /**
      * Find the block in the cache and update the replacement data. Returns
      * the access latency and the in cache flags as a side effect
-     * @param req The req whose block to find
+     * @param pkt The req whose block to find
      * @param lat The latency of the access.
      * @param inCache The FALRUBlk::inCache flags.
      * @return Pointer to the cache block.
@@ -210,7 +210,7 @@ public:
 
     /**
      * Find a replacement block for the address provided.
-     * @param req The request to a find a replacement candidate for.
+     * @param pkt The request to a find a replacement candidate for.
      * @param writebacks List for any writebacks to be performed.
      * @param compress_blocks List of blocks to compress, for adaptive comp.
      * @return The block to place the replacement in.
@@ -328,7 +328,7 @@ public:
      * @param source The block aligned source address.
      * @param dest The block aligned destination adddress.
      * @param asid The address space ID.
-     * @param writebacks List for any generated writeback requests.
+     * @param writebacks List for any generated writeback pktuests.
      */
     void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks)
     {
index 6628f7e7a9debc31ff454dfe275f72c61850321d..514d16bdd14aa4ed819e2ac05988e908f243e144 100644 (file)
@@ -454,7 +454,7 @@ class IIC : public BaseTags
     /**
      * Find the block and update the replacement data. This call also returns
      * the access latency as a side effect.
-     * @param req The req whose block to find
+     * @param pkt The req whose block to find
      * @param lat The access latency.
      * @return A pointer to the block found, if any.
      */
@@ -470,7 +470,7 @@ class IIC : public BaseTags
 
     /**
      * Find a replacement block for the address provided.
-     * @param req The request to a find a replacement candidate for.
+     * @param pkt The request to a find a replacement candidate for.
      * @param writebacks List for any writebacks to be performed.
      * @param compress_blocks List of blocks to compress, for adaptive comp.
      * @return The block to place the replacement in.
@@ -502,14 +502,14 @@ class IIC : public BaseTags
      * @param source The block-aligned source address.
      * @param dest The block-aligned destination address.
      * @param asid The address space DI.
-     * @param writebacks List for any generated writeback requests.
+     * @param writebacks List for any generated writeback pktuests.
      */
     void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);
 
     /**
      * If a block is currently marked copy on write, copy it before writing.
-     * @param req The write request.
-     * @param writebacks List for any generated writeback requests.
+     * @param pkt The write request.
+     * @param writebacks List for any generated writeback pktuests.
      */
     void fixCopy(Packet * &pkt, PacketList &writebacks);
 
index 437244660e5db53f187ebb2da5cf0f0d5666aed3..8f0f3ae27819bdb26e1c2369edb4d0f68dc28ea7 100644 (file)
@@ -170,7 +170,7 @@ public:
     /**
      * Finds the given address in the cache and update replacement data.
      * Returns the access latency as a side effect.
-     * @param req The request whose block to find.
+     * @param pkt The request whose block to find.
      * @param lat The access latency.
      * @return Pointer to the cache block if found.
      */
@@ -196,7 +196,7 @@ public:
 
     /**
      * Find a replacement block for the address provided.
-     * @param req The request to a find a replacement candidate for.
+     * @param pkt The request to a find a replacement candidate for.
      * @param writebacks List for any writebacks to be performed.
      * @param compress_blocks List of blocks to compress, for adaptive comp.
      * @return The block to place the replacement in.
@@ -307,7 +307,7 @@ public:
      * @param source The block-aligned source address.
      * @param dest The block-aligned destination address.
      * @param asid The address space DI.
-     * @param writebacks List for any generated writeback requests.
+     * @param writebacks List for any generated writeback pktuests.
      */
     void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);
 
index 5e034026909670347d6544370ac1d33c549778cd..25180a02b54f7734329038a1f95d8671dffa3286 100644 (file)
@@ -71,13 +71,13 @@ class Split : public BaseTags
 
     Addr blkMask;
 
-    /** Number of NIC requests that hit in the NIC partition */
+    /** Number of NIC pktuests that hit in the NIC partition */
     Stats::Scalar<> NR_NP_hits;
-    /** Number of NIC requests that hit in the CPU partition */
+    /** Number of NIC pktuests that hit in the CPU partition */
     Stats::Scalar<> NR_CP_hits;
-    /** Number of CPU requests that hit in the NIC partition */
+    /** Number of CPU pktuests that hit in the NIC partition */
     Stats::Scalar<> CR_NP_hits;
-    /** Number of CPU requests that hit in the CPU partition */
+    /** Number of CPU pktuests that hit in the CPU partition */
     Stats::Scalar<> CR_CP_hits;
     /** The number of nic replacements (i.e. misses) */
     Stats::Scalar<> nic_repl;
@@ -203,7 +203,7 @@ class Split : public BaseTags
     /**
      * Finds the given address in the cache and update replacement data.
      * Returns the access latency as a side effect.
-     * @param req The memory request whose block to find
+     * @param pkt The memory request whose block to find
      * @param lat The access latency.
      * @return Pointer to the cache block if found.
      */
@@ -219,7 +219,7 @@ class Split : public BaseTags
 
     /**
      * Find a replacement block for the address provided.
-     * @param req The request to a find a replacement candidate for.
+     * @param pkt The request to a find a replacement candidate for.
      * @param writebacks List for any writebacks to be performed.
      * @param compress_blocks List of blocks to compress, for adaptive comp.
      * @return The block to place the replacement in.
@@ -315,7 +315,7 @@ class Split : public BaseTags
      * @param source The block-aligned source address.
      * @param dest The block-aligned destination address.
      * @param asid The address space DI.
-     * @param writebacks List for any generated writeback requests.
+     * @param writebacks List for any generated writeback pktuests.
      */
     void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);
 
index f38516180aefbc9d361e7396d3ac7473fae4a42e..64d903579971a7adddcf69e2149b7b59ccbb6363 100644 (file)
@@ -47,7 +47,7 @@ class SplitBlk : public CacheBlk {
     bool isTouched;
     /** Has this block been used after being brought in? (for LIFO partition) */
     bool isUsed;
-    /** is this blk a NIC block? (i.e. requested by the NIC) */
+    /** is this blk a NIC block? (i.e. pktuested by the NIC) */
     bool isNIC;
     /** timestamp of the arrival of this block into the cache */
     Tick ts;
index dfcaa0b679fb670c8ab400413de7de11e2677615..52956b192dcb9c4e3974592a4e7c76c81c73b623 100644 (file)
@@ -203,7 +203,7 @@ public:
     /**
      * Finds the given address in the cache and update replacement data.
      * Returns the access latency as a side effect.
-     * @param req The req whose block to find
+     * @param pkt The req whose block to find
      * @param lat The access latency.
      * @return Pointer to the cache block if found.
      */
@@ -219,7 +219,7 @@ public:
 
     /**
      * Find a replacement block for the address provided.
-     * @param req The request to a find a replacement candidate for.
+     * @param pkt The request to a find a replacement candidate for.
      * @param writebacks List for any writebacks to be performed.
      * @param compress_blocks List of blocks to compress, for adaptive comp.
      * @return The block to place the replacement in.
@@ -330,7 +330,7 @@ public:
      * @param source The block-aligned source address.
      * @param dest The block-aligned destination address.
      * @param asid The address space DI.
-     * @param writebacks List for any generated writeback requests.
+     * @param writebacks List for any generated writeback pktuests.
      */
     void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);
 
index 03886b1d8da5c13ed97e1336a7568e6d0f368643..6d370c5ddc6e1431216d5acf554ad86fc3f6fff9 100644 (file)
@@ -186,7 +186,7 @@ public:
     /**
      * Finds the given address in the cache and update replacement data.
      * Returns the access latency as a side effect.
-     * @param req The req whose block to find.
+     * @param pkt The req whose block to find.
      * @param lat The access latency.
      * @return Pointer to the cache block if found.
      */
@@ -202,7 +202,7 @@ public:
 
     /**
      * Find a replacement block for the address provided.
-     * @param req The request to a find a replacement candidate for.
+     * @param pkt The request to a find a replacement candidate for.
      * @param writebacks List for any writebacks to be performed.
      * @param compress_blocks List of blocks to compress, for adaptive comp.
      * @return The block to place the replacement in.
@@ -313,7 +313,7 @@ public:
      * @param source The block-aligned source address.
      * @param dest The block-aligned destination address.
      * @param asid The address space DI.
-     * @param writebacks List for any generated writeback requests.
+     * @param writebacks List for any generated writeback pktuests.
      */
     void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);
 
index c81ea03d832fee79ca2180fa164c2a844cb1cc1e..d12eeffe062a3c7e4a2ce87356ee4bcff78170b7 100644 (file)
@@ -30,7 +30,7 @@
 
 /**
  * @file
- * Base Memory Object decleration.
+ * Base Memory Object declaration.
  */
 
 #ifndef __MEM_MEM_OBJECT_HH__
index eac824ddf7eb22f1801d55b681ce0740cf1587be..12d4ec6033f8d353a351743f0ad026fdfccfd02b 100644 (file)
@@ -49,7 +49,7 @@
 class System;
 
 /**
- * Page Table Decleration.
+ * Page Table Declaration.
  */
 class PageTable
 {
index bec9d22748cbd90daf88b67df9b1078c530ce5ed..17924b7597a8c4ef0f3dfca7d3cac8fef15b4c56 100644 (file)
@@ -29,7 +29,8 @@
  */
 
 /**
- * @file Port object definitions.
+ * @file
+ * Port object definitions.
  */
 
 #include "base/chunk_generator.hh"
index 17b1f4a00de475145d5abb68bb457cdae818092c..42e369205a94460870e3cea3724474132349911e 100644 (file)
@@ -30,7 +30,7 @@
 
 /**
  * @file
- * Port Object Decleration. Ports are used to interface memory objects to
+ * Port Object Declaration. Ports are used to interface memory objects to
  * each other.  They will always come in pairs, and we refer to the other
  * port object as the peer.  These are used to make the design more
  * modular so that a specific interface between every type of objcet doesn't
index a62fe2a202f67eedaff266c192e2482100b2bbac..91b1c3408a42933023d72ce9c10cb421d3de0e50 100644 (file)
@@ -31,7 +31,8 @@
  */
 
 /**
- * @file Decleration of a request, the overall memory request consisting of
+ * @file
+ * Declaration of a request, the overall memory request consisting of
  the parts of the request that are persistent throughout the transaction.
  */
 
index cd297bb8e58ce9f4d66c652b0fe473a5eeb4ffb1..8030c5a15a63c050e0add74e9b5152a3bafca89c 100644 (file)
@@ -29,7 +29,8 @@
  */
 
 /**
- * @file Port object definitions.
+ * @file
+ * Port object definitions.
  */
 
 #include "base/chunk_generator.hh"
index 697c8e5f3db917659d5b4b9bbbcc950c2d6c7614..c838362588dafc1c76a742c1665c2a0efce1e6ae 100644 (file)
@@ -30,7 +30,7 @@
 
 /**
  * @file
- * Virtual Port Object Decleration. These ports incorporate some translation
+ * Virtual Port Object Declaration. These ports incorporate some translation
  * into their access methods. Thus you can use one to read and write data
  * to/from virtual addresses.
  */