[coreboot-gerrit] Patch set updated for coreboot: x86 Docs: Enable Serial Output

[Leroy P Leahy (leroy.p.leahy@intel.com)]

Leroy P Leahy (leroy.p.leahy at intel.com) just uploaded a new patch set to gerrit, which you can find at https://review.coreboot.org/13444

-gerrit

commit 230df5e91190d66a775071e317ca2437a2a46194
Author: Lee Leahy <leroy.p.leahy at intel.com>
Date:   Mon Jan 25 11:12:04 2016 -0800

    x86 Docs: Enable Serial Output
    
    Document the steps necessary to enable serial output
    
    BRANCH=none
    BUG=None
    TEST=None
    
    Change-Id: Ifc0e700d7ef54fb1e28ca9bca34b94cccd3633ac
    Signed-off-by: Lee Leahy <leroy.p.leahy at intel.com>
---
 Documentation/x86Board.html       | 25 ++++++++++++++++++++++
 Documentation/x86Development.html | 11 ++++++++++
 Documentation/x86FSP1_1.html      | 14 +++++++++++++
 Documentation/x86SoC.html         | 44 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 94 insertions(+)

diff --git a/Documentation/x86Board.html b/Documentation/x86Board.html
index a974bed..76282a6 100644
--- a/Documentation/x86Board.html
+++ b/Documentation/x86Board.html
@@ -14,6 +14,7 @@
 </p>
 <ol>
   <li><a href="#RequiredFiles">Required Files</a></li>
+  <li>Enable <a href="#SerialOutput">Serial Output</a></li>
 </ol>
 
 
@@ -78,6 +79,30 @@
 
 
 <hr>
+<h1><a name="SerialOutput">Enable Serial Output</a></h1>
+<p>
+  Use the following steps to enable serial output:
+</p>
+<ol>
+  <li>Implement the car_mainboard_pre_console_init routine in the com_init.c
+    file:
+    <ol type="A">
+      <li>Power on and enable the UART controller</li>
+      <li>Connect the UART receive and transmit data lines to the
+        appropriate SoC pins
+      </li>
+    </ol>
+  </li>
+  <li>Add Makefile.inc
+    <ol type="A">
+      <li>Add com_init.c to romstage</li>
+    </ol>
+  </li>
+</ol>
+
+
+
+<hr>
 <p>Modified: 24 January 2016</p>
   </body>
 </html>
\ No newline at end of file
diff --git a/Documentation/x86Development.html b/Documentation/x86Development.html
index 852e1f3..ab797cb 100644
--- a/Documentation/x86Development.html
+++ b/Documentation/x86Development.html
@@ -45,6 +45,17 @@
   <li><a target="_blank" href="x86SoC.html#EarlyDebug">Early Debug</a></li>
   <li>Implement and debug the <a target="_blank" href="x86SoC.html#Bootblock">bootblock</a> code</li>
   <li>Implement and debug the call to <a target="_blank" href="x86SoC.html#TempRamInit">TempRamInit</a></li>
+  <li>Enable the serial port
+    <ol type="A">
+      <li>Power on, enable and configure GPIOs for the
+        <a target="_blank" href="x86Board.html#SerialOutput">debug serial UART</a>
+      </li>
+      <li>Add the <a target="_blank" href="x86SoC.html#SerialOutput">serial outupt</a>
+        support to romstage
+      </li>
+    </ol>
+  </li>
+  <li>Enable <a target="_blank" href="x86FSP1_1.html#CorebootFspDebugging">coreboot/FSP</a> debugging</li>
 </ol>
 
 
diff --git a/Documentation/x86FSP1_1.html b/Documentation/x86FSP1_1.html
index 7a200b0..d314b18 100644
--- a/Documentation/x86FSP1_1.html
+++ b/Documentation/x86FSP1_1.html
@@ -15,6 +15,7 @@
 <ol>
   <li><a href="#RequiredFiles">Required Files</a></li>
   <li>Add the <a href="#FspBinary">FSP Binary File</a> to the Coreboot File System</li>
+  <li>Enable <a href="#CorebootFspDebugging">coreboot/FSP Debugging</a></li>
 </ol>
 
 
@@ -52,6 +53,19 @@
 
 
 <hr>
+<h1><a name="CorebootFspDebugging">Enable coreboot/FSP Debugging</a></h1>
+<p>
+  Set the following Kconfig values:
+</p>
+<ul>
+  <li>CONFIG_DISPLAY_FSP_ENTRY_POINTS - Display the FSP entry points in romstage</li>
+  <li>CONFIG_DISPLAY_HOBS - Display and verify the hand-off-blocks (HOBs) returned by MemoryInit</li>
+  <li>CONFIG_DISPLAY_VBT - Display Video BIOS Table (VBT) used for GOP</li>
+  <li>CONFIG_DISPLAY_UPD_DATA - Display the user specified product data passed to MemoryInit and SiliconInit</li>
+</ul>
+
+
+<hr>
 <p>Modified: 25 January 2016</p>
   </body>
 </html>
\ No newline at end of file
diff --git a/Documentation/x86SoC.html b/Documentation/x86SoC.html
index ebd1ca7..00b78b1 100644
--- a/Documentation/x86SoC.html
+++ b/Documentation/x86SoC.html
@@ -19,6 +19,11 @@
   <li><a href="#EarlyDebug">Early Debug</a></li>
   <li><a href="#BootBlock">Bootblock</a></li>
   <li><a href="#TempRamInit">TempRamInit</a></li>
+  <li><a href="#Romstage">Romstage</a>
+    <ol type="A">
+      <li>Enable <a href="#SerialOutput">Serial Output"</a></li>
+    </ol>
+  </li>
 </ol>
 
 
@@ -252,6 +257,45 @@ mv build/coreboot.rom.new build/coreboot.rom
 
 
 <hr>
+<h1><a name="Romstage">Romstage</a></h1>
+
+<h2><a name="SerialOutput">Serial Output</a></h2>
+<p>
+  The following steps add the serial output support for romstage:
+</p>
+<ol>
+  <li>Create the romstage subdirectory</li>
+  <li>Add romstage/romstage.c
+    <ol type="A">
+      <li>Program the necessary base addresses</li>
+      <li>Disable the TCO</li>
+    </ol>
+  </li>
+  <li>Add romstage/Makefile.inc
+    <ol type="A">
+      <li>Add romstage.c to romstage</li>
+    </ol>
+  </li>
+  <li>Add gpio configuration support if necessary</li>
+  <li>Add the necessary .h files to support the build</li>
+  <li>Update Makefile.inc
+    <ol type="A">
+      <li>Add the romstage subdirectory</li>
+      <li>Add the gpio configuration support file to romstage</li>
+    </ol>
+  </li>
+  <li>Set the necessary Kconfig values to enable serial output:
+    <ul>
+      <li>CONFIG_DRIVERS_UART_<driver>=y</li>
+      <li>CONFIG_CONSOLE_SERIAL=y</li>
+      <li>CONFIG_UART_FOR_CONSOLE=<port></li>
+      <li>CONFIG_CONSOLE_SERIAL_115200=y</li>
+    </ul>
+  </li>
+</ol>
+
+
+<hr>
 <p>Modified: 24 January 2016</p>
   </body>
 </html>
\ No newline at end of file