Skip to contentSkip to conversation

README: Give an explicit example of adding a new board.

PATCH New Robert P. J. Day 3 participants 4 messages Nov 17, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 README: Give an explicit example of adding a new board.

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

---

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.

README +67 -0
index 2c77687..cc701b1 100644
@@ -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 <[email protected]>
+
+        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

========================================================================

#1 lore raw

PATCH 1/1 README: Give an explicit example of adding a new board.

Quoted 25 lines · Robert P. J. Day

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

---

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.

README +5 -0
index 2c77687..cc701b1 100644
@@ -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

README steps: · line 2891

Quoted 10 lines
README +10 -0
+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 ;)

Quoted 9 lines
README +9 -0
+Followed by changes to existing files:
+
+	Makefile
+	========
+
+  omap3_beagle_config :   unconfig
+        @$(MKCONFIG) $(@:_config=) arm arm_cortexa8 beagle ti omap3
+
+	MAKEALL

README steps: · line 2911

Quoted 10 lines
README +10 -0
+	=======
+
+  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.

Quoted 12 lines
README +12 -0
+  #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
+

README steps: · line 2934

Quoted 10 lines
README +10 -0
+	doc/README.omap3
+	================
+
+  Build
+  =====
+
+  * BeagleBoard:
+
+  make omap3_beagle_config
+  make

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

Best regards

Dirk

Quoted 27 lines
README +8 -0
+	MAINTAINERS
+	===========
+
+  Dirk Behme <[email protected]>
+
+        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

#2 lore raw

PATCH 1/1 README: Give an explicit example of adding a new board.

Quoted 31 lines · Dirk Behme
Quoted 30 lines · Robert P. J. Day

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

---

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.

README +10 -0
index 2c77687..cc701b1 100644
@@ -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/
Quoted 8 lines

README steps: · line 2891

Quoted 5 lines
README +5 -0
+      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

========================================================================

#3 lore raw

PATCH 1/1 README: Give an explicit example of adding a new board.

Dear "Robert P. J. Day",

Quoted 10 lines · In message <alpine.LFD.2.00.0911170523040.24840@localhost> you wrote:
Quoted 10 lines
Quoted 9 lines
README +8 -0
+  First, the new files:
+
+  ./board/ti/beagle/
+      beagle.c
+      beagle.h
+      config.mk
+      Makefile
+  ./include/configs/omap3_beagle.h
Quoted 8 lines
Quoted 2 lines

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

Signature · 6 lines
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