[U-Boot] [PATCH] README: Give an explicit example of adding a new board.

[U-Boot] [PATCH] README: Give an explicit example of adding a new board.

[Robert P. J. Day]

Explicitly demonstrate an example (BeagleBoard) of what was
added/changed to support a new board.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

  obviously not critical, but it might be useful for readers to see
explicitly what constitutes adding support for a new board, file by
file.  your choice to apply it or not.  i *think* i got everything.


diff --git a/README b/README
index 2c77687..cc701b1 100644
--- a/README
+++ b/README
@@ -2874,6 +2874,73 @@ steps:
     [Of course, this last step is much harder than it sounds.]


+A real-life example of adding a new board
+=========================================
+
+  As a working example of adding a new board, consider the files
+and directories that were added/changed to support the OMAP3-based
+BeagleBoard.
+
+  First, the new files:
+
+  ./board/ti/beagle/
+      beagle.c
+      beagle.h
+      config.mk
+      Makefile
+  ./include/configs/omap3_beagle.h
+
+Followed by changes to existing files:
+
+	Makefile
+	========
+
+  omap3_beagle_config :   unconfig
+        @$(MKCONFIG) $(@:_config=) arm arm_cortexa8 beagle ti omap3
+
+	MAKEALL
+	=======
+
+  LIST_ARM_CORTEX_A8="            \
+        devkit8000              \
+        omap3_beagle            \
+        omap3_overo             \
+        ...
+
+	include/asm-arm-types.h
+	=======================
+
+  #ifdef CONFIG_MACH_OMAP3_BEAGLE
+  # ifdef machine_arch_type
+  #  undef machine_arch_type
+  #  define machine_arch_type     __machine_arch_type
+  # else
+  #  define machine_arch_type     MACH_TYPE_OMAP3_BEAGLE
+  # endif
+  # define machine_is_omap3_beagle() (machine_arch_type == MACH_TYPE_OMAP3_BEAGLE)
+  #else
+  # define machine_is_omap3_beagle()      (0)
+  #endif
+
+	doc/README.omap3
+	================
+
+  Build
+  =====
+
+  * BeagleBoard:
+
+  make omap3_beagle_config
+  make
+
+	MAINTAINERS
+	===========
+
+  Dirk Behme <dirk.behme@gmail.com>
+
+        omap3_beagle    ARM CORTEX-A8 (OMAP3530 SoC)
+
+
 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
 ==============================================================

rday
--

========================================================================
Robert P. J. Day                               Waterloo, Ontario, CANADA

            Linux Consulting, Training and Kernel Pedantry.

Web page:                                          http://crashcourse.ca
Twitter:                                       http://twitter.com/rpjday
========================================================================

[U-Boot] [PATCH] README: Give an explicit example of adding a new board.

[Dirk Behme]

Robert P. J. Day wrote:
> Explicitly demonstrate an example (BeagleBoard) of what was
> added/changed to support a new board.
> 
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> 
> ---
> 
>   obviously not critical, but it might be useful for readers to see
> explicitly what constitutes adding support for a new board, file by
> file.  your choice to apply it or not.  i *think* i got everything.
> 
> 
> diff --git a/README b/README
> index 2c77687..cc701b1 100644
> --- a/README
> +++ b/README
> @@ -2874,6 +2874,73 @@ steps:
>      [Of course, this last step is much harder than it sounds.]
> 
> 
> +A real-life example of adding a new board
> +=========================================
> +
> +  As a working example of adding a new board, consider the files
> +and directories that were added/changed to support the OMAP3-based
> +BeagleBoard.
> +
> +  First, the new files:
> +
> +  ./board/ti/beagle/
> +      beagle.c
> +      beagle.h
> +      config.mk
> +      Makefile
> +  ./include/configs/omap3_beagle.h

Most probably the naming convention guys here want some hints about 
correct directory and config file names ;)

> +Followed by changes to existing files:
> +
> +	Makefile
> +	========
> +
> +  omap3_beagle_config :   unconfig
> +        @$(MKCONFIG) $(@:_config=) arm arm_cortexa8 beagle ti omap3
> +
> +	MAKEALL
> +	=======
> +
> +  LIST_ARM_CORTEX_A8="            \
> +        devkit8000              \
> +        omap3_beagle            \
> +        omap3_overo             \
> +        ...
> +
> +	include/asm-arm-types.h
> +	=======================

No. Never ever touch this file manually. Instead, add an entry to 
Russell's machine registry and then ask ARM maintainer to import this 
file.

Most probably you have to mention that this is ARM specific.

> +  #ifdef CONFIG_MACH_OMAP3_BEAGLE
> +  # ifdef machine_arch_type
> +  #  undef machine_arch_type
> +  #  define machine_arch_type     __machine_arch_type
> +  # else
> +  #  define machine_arch_type     MACH_TYPE_OMAP3_BEAGLE
> +  # endif
> +  # define machine_is_omap3_beagle() (machine_arch_type == MACH_TYPE_OMAP3_BEAGLE)
> +  #else
> +  # define machine_is_omap3_beagle()      (0)
> +  #endif
> +
> +	doc/README.omap3
> +	================
> +
> +  Build
> +  =====
> +
> +  * BeagleBoard:
> +
> +  make omap3_beagle_config
> +  make

Or './MAKEALL omap3_beagle' to easily catch compiler warnings.

Best regards

Dirk

> +	MAINTAINERS
> +	===========
> +
> +  Dirk Behme <dirk.behme@gmail.com>
> +
> +        omap3_beagle    ARM CORTEX-A8 (OMAP3530 SoC)
> +
> +
>  Testing of U-Boot Modifications, Ports to New Hardware, etc.:
>  ==============================================================
> 
> rday
> --
> 
> ========================================================================
> Robert P. J. Day                               Waterloo, Ontario, CANADA
> 
>             Linux Consulting, Training and Kernel Pedantry.
> 
> Web page:                                          http://crashcourse.ca
> Twitter:                                       http://twitter.com/rpjday
> ========================================================================
> _______________________________________________
> U-Boot mailing list
> U-Boot at lists.denx.de
> http://lists.denx.de/mailman/listinfo/u-boot
> 

[U-Boot] [PATCH] README: Give an explicit example of adding a new board.

[Robert P. J. Day]

On Tue, 17 Nov 2009, Dirk Behme wrote:

> Robert P. J. Day wrote:
> > Explicitly demonstrate an example (BeagleBoard) of what was
> > added/changed to support a new board.
> >
> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> >
> > ---
> >
> >   obviously not critical, but it might be useful for readers to see
> > explicitly what constitutes adding support for a new board, file by
> > file.  your choice to apply it or not.  i *think* i got everything.
> >
> >
> > diff --git a/README b/README
> > index 2c77687..cc701b1 100644
> > --- a/README
> > +++ b/README
> > @@ -2874,6 +2874,73 @@ steps:
> >      [Of course, this last step is much harder than it sounds.]
> >
> >
> > +A real-life example of adding a new board
> > +=========================================
> > +
> > +  As a working example of adding a new board, consider the files
> > +and directories that were added/changed to support the OMAP3-based
> > +BeagleBoard.
> > +
> > +  First, the new files:
> > +
> > +  ./board/ti/beagle/
> > +      beagle.c
> > +      beagle.h
> > +      config.mk
> > +      Makefile
> > +  ./include/configs/omap3_beagle.h
>
> Most probably the naming convention guys here want some hints about correct
> directory and config file names ;)

  just to be clear, i wasn't trying to give methodical directions for
*how* to add a board, just a summary of what the *end result* might be
if someone wanted to see them.  so, in a sense, i'm not trying to
duplicate the instructions for how to add a board, just let people see
what it ultimately represents.

  i just threw this together since *i* was curious about what ended up
in the code base to support a single board and i figured others might
want a summary, that's all.

rday
--


========================================================================
Robert P. J. Day                               Waterloo, Ontario, CANADA

            Linux Consulting, Training and Kernel Pedantry.

Web page:                                          http://crashcourse.ca
Twitter:                                       http://twitter.com/rpjday
========================================================================

[U-Boot] [PATCH] README: Give an explicit example of adding a new board.

[Wolfgang Denk]

Dear "Robert P. J. Day",

In message <alpine.LFD.2.00.0911170523040.24840@localhost> you wrote:
> 
> > > +  First, the new files:
> > > +
> > > +  ./board/ti/beagle/
> > > +      beagle.c
> > > +      beagle.h
> > > +      config.mk
> > > +      Makefile
> > > +  ./include/configs/omap3_beagle.h
> >
> > Most probably the naming convention guys here want some hints about correct
> > directory and config file names ;)
> 
>   just to be clear, i wasn't trying to give methodical directions for
> *how* to add a board, just a summary of what the *end result* might be
> if someone wanted to see them.  so, in a sense, i'm not trying to
> duplicate the instructions for how to add a board, just let people see
> what it ultimately represents.

Then please use an example that does not lead people into doing bad
things.


Best regards,

Wolfgang Denk

-- 
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
"Though a program be but three lines long,
someday it will have to be maintained."
- The Tao of Programming