Add more docs, this time for southbridge.
authorRonald G. Minnich <rminnich@gmail.com>
Mon, 17 Aug 2009 15:42:18 +0000 (15:42 +0000)
committerRonald G. Minnich <rminnich@gmail.com>
Mon, 17 Aug 2009 15:42:18 +0000 (15:42 +0000)
No real difference from northbridge.

Signed-off-by: Ronald G. Minnich <rminnich@gmail.com>
Acked-by: Ronald G. Minnich <rminnich@gmail.com>
git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4548 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

documentation/Kconfig.tex

index cecf33dd36704b35b1e6be870184aea74add8eb5..25f54621b55cb354f11d582435cadeda2809edef 100644 (file)
@@ -449,10 +449,50 @@ obj-y +=  get_sblk_pci1234.o
 obj-$(CONFIG_HAVE_ACPI_TABLES) +=  amdk8_acpi.o
 \end{verbatim}
 
-\subsubsection{northbridge/Kconfig}
-
-
+\subsection{southbridge}
+\subsubsection{southbridge/Kconfig}
+No variables. Source all vendor directory Kconfigs.
+\subsubsection{southbridge/Makefile.inc}
+No variables. {\em Unconditionally} include all vendor Makefile.inc
+\subsubsection{southbridge/$<$vendor$>$/Kconfig}
+No variables. Source all chip directory Kconfigs.
+\subsubsection{southbridge/$<$vendor$>$/Makefile.inc}
+No variables. {\em Conditionally} include all chipset Makefile.inc. The variable
+is the name of the part, e.g.
+\begin{verbatim}
+subdirs-$(CONFIG_SOUTHBRIDGE_AMD_AMD8111) += amd8111
+\end{verbatim}
+.
+\subsubsection{southbridge/$<$vendor$>$/$<$chip$>$/Kconfig}
+Typically a small number of variables. One defines the part name. Here is an example
+of the variables defined for the K8.
+\begin{verbatim}
+config SOUTHBRIDGE_AMD_AMD8111
+       bool
+       default n
 
+\end{verbatim}
+\subsubsection{southbridge/$<$vendor$>$/$<$chip$>$/Makefile.inc}
+Typically very small set of rules, and very simple.
+Since this file is already conditionally included,
+we don't need to test for the chipset CONFIG variable. We
+can therefore test other variables (which is part of the reason
+we set up conditional inclusion of this file, instead
+of unconditionally including it). Here is an example from AMD 8111.
+No conditionals in this one yet. 
+\begin{verbatim}
+driver-y += amd8111.o
+driver-y += amd8111_usb.o
+driver-y += amd8111_lpc.o
+driver-y += amd8111_ide.o
+driver-y += amd8111_acpi.o
+driver-y += amd8111_usb2.o
+driver-y += amd8111_ac97.o
+driver-y += amd8111_nic.o
+driver-y += amd8111_pci.o
+driver-y += amd8111_smbus.o
+obj-y += amd8111_reset.o
+\end{verbatim}
 
 \subsubsection{vendor and part}
 \subsection{southbridge}