From ec1ad94d4aeee285380ef32fc5f0c149f0ac9b51 Mon Sep 17 00:00:00 2001
From: tangxifan <tangxifan@gmail.com>
Date: Tue, 25 Jun 2024 13:06:47 -0700
Subject: [PATCH] [doc] add syntax about internal drivers

---
 .../manual/file_formats/clock_network.rst     | 31 ++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/docs/source/manual/file_formats/clock_network.rst b/docs/source/manual/file_formats/clock_network.rst
index fe6d89b79..d998c63a9 100644
--- a/docs/source/manual/file_formats/clock_network.rst
+++ b/docs/source/manual/file_formats/clock_network.rst
@@ -25,7 +25,9 @@ Using the clock network description language, users can define multiple clock ne
   <clock_networks default_segment="<string>" default_tap_switch="<string>" default_driver_switch="<string>"> 
     <clock_network name="<string>" width="<int>"> 
       <spine name="<string>" start_x="<int>" start_y="<int>" end_x="<int>" end_y="<int>"> 
-        <switch_point tap="<string>" x="<int>" y="<int>"/> 
+        <switch_point tap="<string>" x="<int>" y="<int>"> 
+          <internal_driver tile_pin="<string>"/>
+        </switch_point>
       </spine>  
       <taps>
         <tap tile_pin="<string>"/>
@@ -175,6 +177,33 @@ For example,
 
 where clock spine ``spine0`` will drive another clock spine ``spine1`` at (1, 1). 
 
+For each switch point, outputs of neighbouring programmable blocks are allowed to drive the spine at next level, through syntax ``internal_driver``.
+
+.. option:: tile_pin="<string>"
+
+  Define the pin of a programmable block as an internal driver to a clock network. The pin must be a valid pin defined in the VPR architecture description file.
+
+For example, 
+
+.. code-block:: xml
+
+  <spine name="spine0" start_x="1" start_y="1" end_x="2" end_y="1">
+    <switch_point tap="spine1" x="1" y="1">
+      <internal_driver tile_pin="clb.O[0:1]"/>
+    </switch_point>
+  <spine>
+
+where the clock routing can be driven at (x=1,y=1) by the output pins ``O[0:3]`` of tile ``clb`` in a VPR architecture description file:
+
+.. code-block:: xml
+
+  <tile name="clb">
+   <sub_tile name="clb">
+     <output name="O" num_pins="8"/>
+   </sub_tile>
+  </tile>
+
+
 .. _file_formats_clock_network_tap_point:
 
 Tap Point Settings