GNUBoot
/
coreboot-kgpe-d16
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Most of the changes here are trivial, but the white space changes would be harder to undo than to do over. 

I changed all groups of 8 spaces to tabs, then all tabs to two spaces so more of the device tree fits on the page.  It could have been three or possibly four, but the largest indents I found were 6 tabs, so 4 is a lot of the space on the page.

Signed-off-by: Myles Watson <mylesgw@gmail.com>
Acked-by: Ronald G. Minnich <rminnich@gmail.com>



git-svn-id: svn://svn.coreboot.org/coreboot/trunk@4543 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1
This commit is contained in:
Myles Watson 2009-08-13 16:02:24 +00:00 committed by Ronald G. Minnich
parent fabde37cb8
commit 10c41fa008
1 changed files with 302 additions and 302 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
documentation/Kconfig.tex
View File

@ -41,17 +41,17 @@ Sources all Kconfig files in the vendor directories.
\input{ mainboardkconfig.tex} \input{ mainboardkconfig.tex}
\subsection{mainboard/Makefile.inc} \subsection{mainboard/Makefile.inc}
There is none at this time. There is none at this time.
\subsection{mainboard/<vendor>/Kconfig} \subsection{mainboard/$<$vendor$>$/Kconfig}
We use the amd as a model. The only action currently taken is to source all Kconfig's in the We use the amd as a model. The only action currently taken is to source all Kconfig's in the
subdirectories. subdirectories.
\subsection{mainboard/<vendor>/Makefile.inc} \subsection{mainboard/$<$vendor$>$/Makefile.inc}
We use amd as a model. There is currently no Makefile.inc at this level. We use amd as a model. There is currently no Makefile.inc at this level.
\subsection{mainboard/<vendor>/<board>/Kconfig} \subsection{mainboard/$<$vendor$>$/$<$board$>$/Kconfig}
The mainboard Kconfig and Makefile.inc are designed to be the heart of the build. The defines The mainboard Kconfig and Makefile.inc are designed to be the heart of the build. The defines
and rules in here determine everything about how a mainboard target is built. and rules in here determine everything about how a mainboard target is built.
We will use serengeti\_cheetah as a model. It defines these variables. We will use serengeti\_cheetah as a model. It defines these variables.
\input{ mainboardkconfig.tex} \input{ mainboardkconfig.tex}
\subsection{mainboard/<vendor>/<board>/Makefile.inc} \subsection{mainboard/$<$vendor$>$/$<$board$>$/Makefile.inc}
This is a fairly complex Makefile.inc. Because this is such a critical component, we are going to excerpt and take it piece by piece. This is a fairly complex Makefile.inc. Because this is such a critical component, we are going to excerpt and take it piece by piece.
Note that this is the mainboard as of August, 2009, and it may change over time. Note that this is the mainboard as of August, 2009, and it may change over time.
\subsubsection{objects} \subsubsection{objects}
@ -164,7 +164,7 @@ somewhere, since it runs memory.
What is the APIC? Northbridges always have an Advanced Programmable Interrupt Controller, and that {\it APIC cluster} is a topological connection to the What is the APIC? Northbridges always have an Advanced Programmable Interrupt Controller, and that {\it APIC cluster} is a topological connection to the
CPU socket. So the tree is rooted at the northbridge, which has a link to an apic cluster, and then the CPU. The CPU contains CPU socket. So the tree is rooted at the northbridge, which has a link to an apic cluster, and then the CPU. The CPU contains
its own APIC, and will define any parameters needed. In this case, we have a northbridge of type its own APIC, and will define any parameters needed. In this case, we have a northbridge of type
{\it northbridge/amd/amdk8/root\_complex}, with its won apic\_cluster device which we turn on, {\it northbridge/amd/amdk8/root\_complex}, with its own apic\_cluster device which we turn on,
which connects to a {\it cpu/amd/socket\_F}, which connects to a {\it cpu/amd/socket\_F},
which has an apic, which is on. which has an apic, which is on.
@ -368,17 +368,17 @@ The CPU socket is the key link from mainboard to its CPUs. Since many models of
the socket, and the socket, in turn, references the various model CPUs which can be plugged into it. The socket is thus the focus the socket, and the socket, in turn, references the various model CPUs which can be plugged into it. The socket is thus the focus
of all defines and Makefile controls for building the CPU components of a board. of all defines and Makefile controls for building the CPU components of a board.
\subsubsection{ /cpu/Kconfig} \subsubsection{ cpu/Kconfig}
Defines variables. Current variables are: Defines variables. Current variables are:
\input{cpukconfig.tex} \input{cpukconfig.tex}
Sources all Kconfig files in the vendor directories. Sources all Kconfig files in the vendor directories.
\subsubsection{ /cpu/Makefile.inc} \subsubsection{ cpu/Makefile.inc}
Unconditionally sources all Makefile.inc in the vendor directories. Unconditionally sources all Makefile.inc in the vendor directories.
\subsection{cpu/<vendor>/Kconfig} \subsection{cpu/$<$vendor$>$/Kconfig}
The only action currently taken is to source all Kconfig's in the The only action currently taken is to source all Kconfig's in the
subdirectories. subdirectories.
\subsection{cpu/<vendor>/Makefile.inc} \subsection{cpu/$<$vendor$>$/Makefile.inc}
{\em Conditionally} source the socket directories. {\em Conditionally} source the socket directories.
Example: Example:
\begin{verbatim} \begin{verbatim}
@ -387,7 +387,7 @@ subdirs-$(CONFIG_CPU_AMD_SOCKET_F) += socket_F
. .
CONFIG\_CPU\_AMD\_SOCKET\_F is set in a mainboard file. CONFIG\_CPU\_AMD\_SOCKET\_F is set in a mainboard file.
\subsection{cpu/<vendor>/<socket>/Kconfig} \subsection{cpu/$<$vendor$>$/$<$socket$>$/Kconfig}
Set variables that relate to this {\em socket}, and {\em any models that plug into this socket}. Note that Set variables that relate to this {\em socket}, and {\em any models that plug into this socket}. Note that
the socket, as much as possible, should control the models, because the models may plug into many sockets. the socket, as much as possible, should control the models, because the models may plug into many sockets.
Socket\_F currently sets: Socket\_F currently sets:
@ -395,10 +395,10 @@ Socket\_F currently sets:
It sources only those Kconfigs that relate to this particular socket, i.e. not all possible models are sourced. It sources only those Kconfigs that relate to this particular socket, i.e. not all possible models are sourced.
\subsection{cpu/<vendor>/<model>/Kconfig} \subsection{cpu/$<$vendor$>$/$<$model$>$/Kconfig}
CPU Model Kconfigs only set variables, We do not expect that they will source any other Kconfig. The socket Kconfig should do that CPU Model Kconfigs only set variables, We do not expect that they will source any other Kconfig. The socket Kconfig should do that
if needed. if needed.
\subsection{cpu/<vendor>/<model>/Makefile.inc} \subsection{cpu/$<$vendor$>$/$<$model$>$/Makefile.inc}
The Makefile.inc {\em unconditionally} specifies drivers and objects to be included in the build. There is no conditional The Makefile.inc {\em unconditionally} specifies drivers and objects to be included in the build. There is no conditional
compilation at this point. IF a socket is included, it includes the models. If a model is included, it should include {em all} compilation at this point. IF a socket is included, it includes the models. If a model is included, it should include {em all}
objects, because it is not possible to determine at build time what options may be needed for a given model CPU. objects, because it is not possible to determine at build time what options may be needed for a given model CPU.
@ -407,18 +407,18 @@ This Makefile.inc includes no other Makefile.inc files; any inclusion should be
\subsection{northbridge} \subsection{northbridge}
\subsubsection{northbridge/Kconfig} \subsubsection{northbridge/Kconfig}
No variables. Source all vendor directory Kconfigs. No variables. Source all vendor directory Kconfigs.
\subsubsection{northbridge/Kconfig} \subsubsection{northbridge/Makefile.inc}
No variables. unconditionally include all vendor Makefile.inc No variables. unconditionally include all vendor Makefile.inc
\subsubsection{northbridge/<vendor>/Kconfig} \subsubsection{northbridge/$<$vendor$>$/Kconfig}
No variables. Source all chip directory Kconfigs. No variables. Source all chip directory Kconfigs.
\subsubsection{northbridge/<vendor>/Makefile.inc} \subsubsection{northbridge/$<$vendor$>$/Makefile.inc}
No variables. {\em Conditionally} include all chipset Makefile.inc. The variable No variables. {\em Conditionally} include all chipset Makefile.inc. The variable
is the name of the part, e.g. is the name of the part, e.g.
\begin{verbatim} \begin{verbatim}
subdirs-$(CONFIG_NORTHBRIDGE_AMD_AMDK8) += amdk8 subdirs-$(CONFIG_NORTHBRIDGE_AMD_AMDK8) += amdk8
\end{verbatim} \end{verbatim}
. .
\subsubsection{northbridge/<vendor>/<chip>/Kconfig} \subsubsection{northbridge/$<$vendor$>$/$<$chip$>$/Kconfig}
Typically a small number of variables. One defines the part name. Here is an example Typically a small number of variables. One defines the part name. Here is an example
of the variables defined for the K8. of the variables defined for the K8.
\begin{verbatim} \begin{verbatim}
@ -434,7 +434,7 @@ config HAVE_HIGH_TABLES
int int
default 1 default 1
\end{verbatim} \end{verbatim}
\subsubsection{northbridge/<vendor>/<chip>/Makefile.inc} \subsubsection{northbridge/$<$vendor$>$/$<$chip$>$/Makefile.inc}
Typically very small set of rules, and very simple. Typically very small set of rules, and very simple.
Since this file is already conditionally included, Since this file is already conditionally included,
we don't need to test for the chipset CONFIG variable. We we don't need to test for the chipset CONFIG variable. We
@ -459,7 +459,7 @@ obj-$(CONFIG_HAVE_ACPI_TABLES) += amdk8_acpi.o
\subsubsection{vendor and part} \subsubsection{vendor and part}
\subsection{superio} \subsection{superio}
\subsection{drivers/i2c} \subsection{drivers/i2c}
This is a rather special case. There are no Kconfig files or Makefile.inc files here. They are notneeed. This is a rather special case. There are no Kconfig files or Makefile.inc files here. They are not needed.
To compile in one of these files, name the .o directory. E.g. in serengeti\_cheetah we have: To compile in one of these files, name the .o directory. E.g. in serengeti\_cheetah we have:
\begin{verbatim} \begin{verbatim}
\end{verbatim} \end{verbatim}