From: Gabe Black <gblack@eecs.umich.edu>
Date: Mon, 20 Apr 2009 05:00:24 +0000 (-0700)
Subject: Mem: Fill out the comment that describes the LOCKED request flag.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=9e9a34fed1013fa8cd124d3db65c4ca4979bedf2;p=gem5.git

Mem: Fill out the comment that describes the LOCKED request flag.
---

diff --git a/src/mem/request.hh b/src/mem/request.hh
index 64f6ad053..8809b0bd1 100644
--- a/src/mem/request.hh
+++ b/src/mem/request.hh
@@ -75,7 +75,12 @@ class Request : public FastAlloc
     static const FlagsType NO_FAULT                    = 0x00002000;
     /** The request should not cause a memory access. */
     static const FlagsType NO_ACCESS                   = 0x00004000;
-    /** This request will lock or unlock the accessed memory. */
+    /** This request will lock or unlock the accessed memory. When used with
+     * a load, the access locks the particular chunk of memory. When used
+     * with a store, it unlocks. The rule is that locked accesses have to be
+     * made up of a locked load, some operation on the data, and then a locked
+     * store.
+     */
     static const FlagsType LOCKED                      = 0x00008000;
     /** The request should be prefetched into the exclusive state. */
     static const FlagsType PF_EXCLUSIVE                = 0x00010000;