From 3c580b539e5928de7ffed6152a2e28950d28bcb3 Mon Sep 17 00:00:00 2001
From: Stefan Reinauer <stepan@coresystems.de>
Date: Fri, 1 Aug 2008 11:35:46 +0000
Subject: [PATCH] clean up comment in onboard.c (trivial)

Signed-off-by: Stefan Reinauer <stepan@coresystems.de>
Acked-by: Stefan Reinauer <stepan@coresystems.de>


git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3444 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
---
 src/drivers/pci/onboard/onboard.c | 104 +++++++++++++++---------------
 1 file changed, 53 insertions(+), 51 deletions(-)

diff --git a/src/drivers/pci/onboard/onboard.c b/src/drivers/pci/onboard/onboard.c
index 51550803dd..e09c90b0e3 100644
--- a/src/drivers/pci/onboard/onboard.c
+++ b/src/drivers/pci/onboard/onboard.c
@@ -11,57 +11,59 @@
 #include <device/pci_ops.h>
 #include "chip.h"
 
-/*you need to 
-	1.add
-                                                chip drivers/pci/onboard
-                                                        device pci x.0 on end
-                                                        register "rom_address" = "0xfff80000"
-                                                end
-	in your MB mainboard Config.lb
-	2. add 
-		#       48K for SCSI FW or ATI ROM
-		        option ROM_SIZE = 512*1024-48*1024
-	in your MB targets Config.lb, afer romimage "normal"
-	3. create you vgabios.bin under normal bios and put that in dir that targets Config residues.
-		# dd if=/dev/mem of=atix.rom skip=1536 count=96
-	4. after build coreboot.rom
-		# cat ../atix.rom ./normal/coreboot.rom ./fallback/coreboot.rom > coreboot.rom
-	or use nsxv to build you image
-		# time ./nsxv s2850
-
-put following in nsxv and put nsxv in your LBROOT
-
-#!/bin/bash
-MBVENDOR=tyan
-MBMODEL=$1
-LBROOT=/home/yhlu/xx/xx
-
-echo $1
-date
-
-cd "$LBROOT/freebios2/targets"
-rm -rf "$MBVENDOR/$MBMODEL/$MBMODEL"
-./buildtarget "$MBVENDOR/$MBMODEL" &> "$LBROOT/x_b.txt"
-cd "$MBVENDOR/$MBMODEL/$MBMODEL"
-#make clean
-eval make &> "$LBROOT/x_m.txt"
-        if [ $? -eq 0 ]; then
-                echo "ok."
-        else
-                echo "FAILED! Log excerpt:"
-                tail -n 15 "$LBROOT/x_m.txt"
-                exit
-        fi
-cat ../atix.rom ./normal/coreboot.rom ./fallback/coreboot.rom > "$LBROOT/rom/"$MBMODEL"_coreboot.rom"
-cp -f "$LBROOT/rom/"$MBMODEL"_coreboot.rom" /home/yhlu/
-
-date
-
-
-*/
-		
-
-
+/*
+ * How to use the onboard device driver for option rom execution:
+ *
+ * 1. You need to add the driver to your mainboard Config.lb:
+ *
+ *      chip drivers/pci/onboard
+ *	    device pci x.0 on end
+ *          register "rom_address" = "0xfff80000"
+ *      end
+ * 2. Reduce the size of your normal (or fallback) image, by adding the
+ *    following lines to your target Config.lb, after romimage "normal"
+ *      # 48K for SCSI FW or ATI ROM
+ *      option ROM_SIZE = 512*1024-48*1024
+ * 3. Create your vgabios.bin, for example using awardeco and put it in the
+ *    directory of your target Config.lb. You can also read an option rom from
+ *    a running system, but this is unreliable, as some option roms are changed
+ *    during execution:
+ *      #  dd if=/dev/mem of=atix.rom skip=1536 count=96
+ * 4. After you built coreboot.rom, attach the option rom to your coreboot
+ *    image:
+ *      # cat ../atix.rom ./normal/coreboot.rom ./fallback/coreboot.rom > coreboot.rom
+ *
+ * Alternatively you can use the following script "nsxv" to build your image
+ * Usage:
+ * # ./nsxv s2850
+ *     
+ *     #!/bin/bash
+ *     MBVENDOR=tyan
+ *     MBMODEL=$1
+ *     LBROOT=/home/yhlu/xx/xx
+ *     
+ *     echo $1
+ *     date
+ *     
+ *     cd "$LBROOT/freebios2/targets"
+ *     rm -rf "$MBVENDOR/$MBMODEL/$MBMODEL"
+ *     ./buildtarget "$MBVENDOR/$MBMODEL" &> "$LBROOT/x_b.txt"
+ *     cd "$MBVENDOR/$MBMODEL/$MBMODEL"
+ *     #make clean
+ *     eval make &> "$LBROOT/x_m.txt"
+ *             if [ $? -eq 0 ]; then
+ *                     echo "ok."
+ *             else
+ *                     echo "FAILED! Log excerpt:"
+ *                     tail -n 15 "$LBROOT/x_m.txt"
+ *                     exit
+ *             fi
+ *     cat ../atix.rom ./normal/coreboot.rom ./fallback/coreboot.rom > "$LBROOT/rom/"$MBMODEL"_coreboot.rom"
+ *     cp -f "$LBROOT/rom/"$MBMODEL"_coreboot.rom" /home/yhlu/
+ *     
+ *     date
+ *     
+ */
 
 static void onboard_enable(device_t dev) 
 {