Documentation updates

Author: allRisc

README.md

@@ -2,12 +2,4 @@
 
 A UVM Agent for the AMBA APB Protocol
 
-## Usage
-
-```SystemVerilog
-
-class user_env extends uvm_env;
-
-endclass : user env
-
-```
+Documentation can be found: [https://riscy-lib.github.io/apb_agent/](https://riscy-lib.github.io/apb_agent/)

docs/config/Comments.txt

@@ -22,6 +22,23 @@
 # ------------------------------------------------------------------------
 # The syntax reference is after the definitions.
 
+Alter Comment Type: Class
+
+   SystemVerilog Keywords:
+      package, packages
+
+
+Comment Type: SVInterface
+
+   Display Name: Interface
+   Plural Display Name: Interfaces
+
+   Scope: Start
+
+   SystemVerilog Keywords:
+      svinterface, svinterfaces
+
+
 Comment Type: Signals
 
    Display Name: Signal

docs/config/Languages.txt

@@ -21,6 +21,8 @@
 
 Alter Language: SystemVerilog
 
+   Interface Prototype Ender: ;
+   Property Prototype Ender: ;
    Signals Prototype Enders: ; =
    Instances Prototype Ender: ;
 

docs/config/Project.txt

@@ -6,10 +6,10 @@
 # Project Information
 # ------------------------------------------------------------------------
 
-Title: PADC Common Cells
-Subtitle: A collection of technology agnostic cells and common IP
+Title: RISCY-Lib APB Agent
+Subtitle: A UVM APB Agent which supports Completers and Requesters
 
-Copyright: © 2025 Texas Instruments, Inc
+Copyright: © 2025 RISCY-Lib Contributors
 
 
 # This is where you put general information about your project.  None of these
@@ -74,6 +74,9 @@ Copyright: © 2025 Texas Instruments, Inc
 Source Folder: ../../src
    Name: source
 
+Source Folder 2: ../../include
+   Name: include
+
 
 # This is where you tell Natural Docs which folders it should scan for source
 # files.  If you add any on the command line this section is ignored except

include/apb_agent_macros.svh

@@ -19,6 +19,8 @@
 `ifndef __APB_AGENT_MACROS__SVH__
 `define __APB_AGENT_MACROS__SVH__
 
+// Macro: _APB_AGENT_PARAM_DEFS
+// Macro for instantiating the common parameters used around the agent
 `define _APB_AGENT_PARAM_DEFS \
     parameter int ADDR_WIDTH = 32,  \
     parameter int DATA_WIDTH = 32

src/agent/apb_agent_config.svh

@@ -41,7 +41,7 @@ class apb_agent_config extends uvm_object;
 
     // Reference: vif_handle
     // The uvm_config_db 'field_name' handle to the virtual interface
-    string vif_handle="m_vif";
+    string vif_handle = "m_vif";
 
     // Group: Constructors
     ////////////////////////////////////////////////////////////////////////////////////////////////

src/agent/apb_driver.svh

@@ -85,7 +85,7 @@ class apb_driver#(`_APB_AGENT_PARAM_DEFS) extends uvm_driver#(apb_transaction#(`
         super.run_phase(phase);
 
         if (m_cfg.agent_mode == APB_COMPLETER_AGENT) begin
-            completer_run_phase(phase);
+            completer_run_phase();
         end
         // else if (m_cfg.agent_mode == APB_REQUESTER_AGENT) begin
         //     requester_run_phase(phase);
@@ -103,7 +103,7 @@ class apb_driver#(`_APB_AGENT_PARAM_DEFS) extends uvm_driver#(apb_transaction#(`
 
     // Task: completer_run_phase
     // The UVM Run-Phase for a completer agent
-    virtual task completer_run_phase(uvm_phase phase);
+    virtual task completer_run_phase();
         apb_transaction#(`_APB_AGENT_PARAM_MAP) trans;  // The transaction in the address phase
         apb_phase_e phase;
 
@@ -113,8 +113,8 @@ class apb_driver#(`_APB_AGENT_PARAM_DEFS) extends uvm_driver#(apb_transaction#(`
         m_vif.paddr     = '0;
         m_vif.pprot     = '0;
         m_vif.pwdata    = '0;
-        m_vif.pstrb    = '1;
-        m_vif.write    = 1'b0;
+        m_vif.pstrb     = '1;
+        m_vif.pwrite    = APB_READ;
 
         m_vif.psel      = 1'b0;
         m_vif.penable   = 1'b0;
@@ -135,15 +135,12 @@ class apb_driver#(`_APB_AGENT_PARAM_DEFS) extends uvm_driver#(apb_transaction#(`
                 m_vif.psel = 1'b1;
                 m_vif.paddr = trans.addr;
                 m_vif.pprot = trans.pprot;
+                m_vif.pwrite = trans.write;
 
                 if (trans.write == APB_WRITE) begin
-                    m_vif.write = 1'b1;
                     m_vif.pwdata = trans.data;
                     m_vif.pstrb = trans.wstrb;
                 end
-                else begin
-                    m_vif.write = 1'b0;
-                end
 
                 phase = APB_ACCESS_PHASE;
             end

src/agent/apb_monitor.svh

@@ -96,7 +96,7 @@ class apb_monitor#(`_APB_AGENT_PARAM_DEFS) extends uvm_monitor;
         forever begin
             @(posedge m_vif.pclk);
 
-            if (!m_vif.hreset_n) begin
+            if (!m_vif.preset_n) begin
                 trans = null;
                 continue;
             end

src/apb_agent_pkg.sv

@@ -17,6 +17,7 @@
  ************************************************************************************/
 
 // Package: apb_agent_pkg
+// Package which contains the apb_agent an relevant definitions
 package apb_agent_pkg;
 
     // UVM Imports

src/apb_definitions.svh

@@ -22,7 +22,7 @@ typedef enum {
     APB_REQUESTER_AGENT
 } apb_agent_mode_e;
 
-// Struct: apb_pprot_t
+// Struct: apb_agent_pkg.apb_pprot_t
 typedef struct packed {
     logic privileged;
     logic insecure;