From: Daniel Benusovich <flyingmonkeys1996@gmail.com>
Date: Thu, 14 Feb 2019 06:22:48 +0000 (-0800)
Subject: Adding header comments for validator
X-Git-Tag: div_pipeline~2406
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=4dbad4f7d5340fdcaa42dbfe486a99cea1ddba82;p=soc.git

Adding header comments for validator
---

diff --git a/TLB/PermissionValidator.py b/TLB/PermissionValidator.py
index 4e4b7918..7cc12d93 100644
--- a/TLB/PermissionValidator.py
+++ b/TLB/PermissionValidator.py
@@ -1,15 +1,18 @@
 from nmigen import Signal
 from nmigen.cli import main
 
-# The expected form of the data is
-# Item (Bits)
-# Tag (N - 79) / ASID (78 - 64) / PTE (63 - 0)
-
 # The purpose of this Module is to check the Permissions of a given PTE 
 # against the requested access permissions. 
 # This module will either validate (by setting the valid bit HIGH) the request
 # or find a permission fault and invalidate (by setting the valid bit LOW) 
 # the request
+#
+# Arguments:
+#  data_size: (bit count) The size of the data words being processed
+#
+# Return:
+#  1. Data is valid ->  valid is HIGH
+#  2. Data is not valid -> valid is LOW
 class PermissionValidator():
     def __init__(self, data_size):
         # Input