From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Mon, 4 Mar 2019 08:53:06 +0000 (+0000)
Subject: comments and whitespace cleanup
X-Git-Tag: div_pipeline~2365
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=441945dc70929287333c1b9d395eed9f435068df;p=soc.git

comments and whitespace cleanup
---

diff --git a/TLB/src/CamEntry.py b/TLB/src/CamEntry.py
index f8f43b7a..8be65622 100644
--- a/TLB/src/CamEntry.py
+++ b/TLB/src/CamEntry.py
@@ -1,29 +1,31 @@
 from nmigen import Module, Signal
 
-# Content Addressable Memory (CAM) Entry
-# The purpose of this module is to represent an entry within a CAM.
-# This module when given a read command will compare  the given key
-# and output whether a match was found or not. When given a write
-# command it will write the given key and data into internal registers.
 class CamEntry:
-    
-    # Arguments:
-    #  key_size: (bit count) The size of the key 
-    #  data_size: (bit count) The size of the data 
+    """ Content Addressable Memory (CAM) Entry
+
+        The purpose of this module is to represent an entry within a CAM.
+        This module when given a read command will compare  the given key
+        and output whether a match was found or not. When given a write
+        command it will write the given key and data into internal registers.
+    """
+
     def __init__(self, key_size, data_size):
+        """ Arguments:
+            * key_size: (bit count) The size of the key
+            * data_size: (bit count) The size of the data
+        """
         # Internal
         self.key = Signal(key_size)
-        
+
         # Input
         self.command = Signal(2) # 00 => NA 01 => Read 10 => Write 11 => Reset
         self.key_in = Signal(key_size) # Reference key for the CAM
         self.data_in = Signal(data_size) # Data input when writing
-        
+
         # Output
         self.match = Signal(1) # Result of the internal/input key comparison
         self.data = Signal(data_size)
-        
-        
+ 
     def elaborate(self, platform=None):
         m = Module()
         with m.Switch(self.command):
@@ -39,12 +41,12 @@ class CamEntry:
                     self.key.eq(self.key_in),
                     self.data.eq(self.data_in),
                     self.match.eq(0)
-                ] 
+                ]
             with m.Case():
                 m.d.sync += [
                     self.match.eq(0),
                     self.data.eq(0),
                     self.key.eq(0)
                 ]
-        
+
         return m