boards organization #10875

dagar · 2018-11-20T02:58:58Z

As previously discussed in conjunction with #7705, #8777, #7806, #8127, #7318, #8923, I'd like to consolidate all components of a board into a single location.

Why?

effectively creates a board "API" showing all pieces that need to be implemented for a new board
easy board addition
easy board removal
third party boards can live out of tree
direct comparison between boards (ie diff fmu-v2 and fmu-v4)
trivial to create a custom minor board variant without hacking the existing board in a private fork (something I've seen many times).
work towards minimizing what's actually required in a board support package

Example

fmu-v2
- default.cmake
- nuttx-config
- include
  - board_config.h
- src
  - init.c
  - etc

In this current PR I've sorted the boards by VENDOR (eg PX4) and then by MODEL (eg FMU-v2). The downside is it changes the common naming from px4fmu-v2 to px4_fmu-v2. This is somewhat flexible if people feel strongly about it.

Thoughts/comments/concerns/complaints?

% tree -L 3 --dirsfirst boards

boards
├── aerotenna
│   └── ocpoc
│       ├── src
│       └── ubuntu.cmake
├── airmind
│   └── mindpx-v2
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── atlflight
│   ├── cmake_hexagon
│   ├── eagle
│   │   ├── src
│   │   ├── default.cmake
│   │   └── qurt-default.cmake
│   └── excelsior
│       ├── src
│       ├── default.cmake
│       └── qurt-default.cmake
├── atmel
│   └── same70xplained
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── auav
│   ├── esc35-v1
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   └── firmware.prototype
│   └── x21
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── av
│   └── x-v1
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── beaglebone
│   └── blue
│       ├── src
│       ├── cross.cmake
│       └── native.cmake
├── bitcraze
│   └── crazyflie
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── emlid
│   └── navio2
│       ├── src
│       ├── cross.cmake
│       └── native.cmake
├── gumstix
│   └── aerocore2
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── intel
│   └── aerofc-v1
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       ├── firmware.prototype
│       └── rtps.cmake
├── nxp
│   └── hlite-v3
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── omnibus
│   └── f4sd
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
├── parrot
│   └── bebop
│       ├── src
│       └── default.cmake
├── px4
│   ├── cannode-v1
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   └── firmware.prototype
│   ├── esc-v1
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   └── firmware.prototype
│   ├── fmu-v2
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   ├── firmware.prototype
│   │   ├── lpe.cmake
│   │   └── test.cmake
│   ├── fmu-v3
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   ├── firmware.prototype
│   │   ├── rtps.cmake
│   │   └── stackcheck.cmake
│   ├── fmu-v4
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   ├── firmware.prototype
│   │   ├── rtps.cmake
│   │   └── stackcheck.cmake
│   ├── fmu-v4pro
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   ├── firmware.prototype
│   │   └── rtps.cmake
│   ├── fmu-v5
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   ├── firmware.prototype
│   │   ├── rtps.cmake
│   │   └── stackcheck.cmake
│   ├── io-v2
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   └── firmware.prototype
│   ├── raspberrypi
│   │   ├── src
│   │   ├── cross.cmake
│   │   └── native.cmake
│   └── sitl
│       ├── src
│       ├── default.cmake
│       ├── rtps.cmake
│       └── test.cmake
├── stm
│   ├── 32f4discovery
│   │   ├── nuttx-config
│   │   ├── src
│   │   ├── default.cmake
│   │   └── firmware.prototype
│   └── nucleo-F767ZI
│       ├── nuttx-config
│       ├── src
│       ├── default.cmake
│       └── firmware.prototype
└── thiemar
    └── s2740vc-v1
        ├── nuttx-config
        ├── src
        ├── default.cmake
        └── firmware.prototype

97 directories, 67 files

LorenzMeier · 2018-11-20T13:37:11Z

Very cool?

davids5

@dagar I have no issue with the command name changes. I do question the CONFIG_BOARD_NAME changes. What it that motivation? if it has to be can it have a "_" to seperate the vendor and board in it?

dagar · 2018-11-20T16:31:32Z

At the moment CONFIG_BOARD_NAME has to be consistent with BOARD at the PX4 level. I don't really care for it either, but once we transition to nuttx custom boards (instead of tricking it by copying into the tree) it will go away.

davids5 · 2018-11-20T16:34:32Z

At the moment CONFIG_BOARD_NAME has to be consistent with BOARD at the PX4 level. I don't really care for it either, but once we transition to nuttx custom boards (instead of tricking it by copying into the tree) it will go away.

fair enough. What do we need to do to get this in?

mrpollo · 2018-11-20T17:36:35Z

Can we define the testing that needs to happen before this gets merged?

davids5 · 2018-11-20T21:40:41Z

I have tested on v2 HW with uavcan downloading px4cannode. That is all working.

bkueng

Nice, looks good.

bkueng · 2018-11-21T10:58:39Z

.ci/Jenkinsfile-compile

            image: docker_images.nuttx,
            archive: false
          ]

          def rpi_builds = [
-            target: ["posix_rpi_cross", "posix_bebop_default"],
+            target: ["emlidnavio2_cross", "parrotbebop_default"],


It's a bit strange that the company and board are not separated. Is there a reason? I.e. emlid-navio2_cross would already help.

The main reason it's been kept like this so far is to minimize migration pain.

px4fmu-v5_default -> px4_fmu-v5_default

I'd still like to split, but we'll need everyone onboard so that we can do a coordinated documentation update.

My lets fix this once and for all. Let's move forward with the name change. Provide an "is" "was" list in the commit and we can all adjust or fix what it breaks.

bkueng · 2018-11-21T11:00:23Z

.travis.yml

@@ -28,5 +28,5 @@ addons:
      description: "Build submitted via Travis CI"
    notification_email: ci@px4.io
    build_command_prepend: "make distclean"
-    build_command: "make posix_sitl_default"
+    build_command: "make px4sitl_default"


This will need docs update (@hamishwillee fyi)

dagar · 2018-11-22T04:32:26Z

I've pushed a commit to change the naming convention to include an underscore between the vendor and model. The platform prefix is also no longer necessary.

posix_sitl_default -> px4_sitl_default
px4fmu-v2_default -> px4_fmu-v2_default

- explicitly set TOOLCHAIN on all NuttX targets

…mmon_flags

Avysuarez · 2018-11-26T17:25:26Z

Tested on pixhawk 4 and pixhawk 4 mini. No issues, Good flights.
Pixhawk 4.
https://review.px4.io/plot_app?log=a01ee82e-fe67-4755-98d8-649cc51ecd02
Pixhawk 4 mini.
https://review.px4.io/plot_app?log=8b8adf6b-0bcb-49c0-a684-0f23685c4e71

dannyfpv · 2018-11-26T21:06:54Z

tested on pixhawk v4 pro
https://review.px4.io/plot_app?log=e4c6c68a-3dcb-4498-92c8-bf63ec630c11

davids5

@dagar Nice cleanup.

mrpollo · 2018-11-27T01:28:06Z

👏 👏 👏 👏 👏 👏 👏 👏 👏
This community is awesome, thanks for the cleanup guys.

@dagar 13k deletions ❤️

👏 👏 👏 👏 👏 👏 👏 👏 👏

dagar added the Admin: Enhancement (improvement) 💡 label Nov 20, 2018

dagar added this to the Release v1.9.0 milestone Nov 20, 2018

dagar requested a review from davids5 November 20, 2018 02:58

dagar mentioned this pull request Nov 20, 2018

[RFC] boards organization #8923

Closed

dagar force-pushed the pr-boards branch from eb494f7 to 6d70d7d Compare November 20, 2018 03:09

dagar mentioned this pull request Nov 20, 2018

UPstreaming a new port PX4/PX4-Devguide#654

Merged

dagar force-pushed the pr-boards branch 2 times, most recently from e26642b to 101e001 Compare November 20, 2018 15:06

dagar requested review from simonegu, bkueng, jinger26, hamishwillee and mrpollo November 20, 2018 15:15

dagar force-pushed the pr-boards branch from 101e001 to 89dbe00 Compare November 20, 2018 15:50

davids5 reviewed Nov 20, 2018

View reviewed changes

dagar force-pushed the pr-boards branch from 89dbe00 to 3f88a5b Compare November 20, 2018 16:32

dagar force-pushed the pr-boards branch from 3f88a5b to 4a9d501 Compare November 20, 2018 17:05

dagar force-pushed the pr-boards branch 2 times, most recently from e946813 to cc4f554 Compare November 20, 2018 19:30

bkueng reviewed Nov 21, 2018

View reviewed changes

hamishwillee added the Documentation 📑 Anything improving the documentation of the code / ecosystem label Nov 22, 2018

dagar force-pushed the pr-boards branch from cc4f554 to f6d062e Compare November 22, 2018 04:30

dagar force-pushed the pr-boards branch 2 times, most recently from 7620ad0 to da590a3 Compare November 22, 2018 04:58

dagar and others added 17 commits November 25, 2018 20:25

boards organization

13bfadf

boards new split VENDOR_MODEL naming convention

0afd840

px4fmu_test:rcS use correct name for px4io bin

8b5d640

board_common:Use new PX4IO FW name on SD card and remove legacy V1 name

7c8a223

remove BOARD_NAME from board_config.h and set automatically

4d14a39

Makefile add board rename deprecation warning

fedd8c3

cmake remove need for platform px4_add_board_os

621f8c5

- explicitly set TOOLCHAIN on all NuttX targets

cmake px4_add_board document and cleanup

ac640fb

Makefile quick_check switch nuttx target to px4_fmu-v5

9f99d85

cmake split px4_base into px4_add_module, px4_add_library, px4_add_co…

f0eca6f

…mmon_flags

cmake use standard mechanisms for settings flags

7d15539

make vcdevtest a generic cdev test

a76c3fc

muorb test move to modules/muorb/test

6e387d4

move posix/tests/hello to examples/hello and include everywhere

7950436

px4/sitl add replay module

43276e0

move posix/tests/hrt_test to systemcmds/tests/hrt_test

e75e4b1

move dyn_hello to examples and restore testing

5f5712e

dagar force-pushed the pr-boards branch from 6996e8e to 5f5712e Compare November 26, 2018 02:04

davids5 approved these changes Nov 26, 2018

View reviewed changes

davids5 merged commit 48df19c into master Nov 26, 2018

dagar deleted the pr-boards branch November 26, 2018 23:04

hamishwillee mentioned this pull request Nov 27, 2018

Update docs for make/config target changes PX4/PX4-Devguide#670

Merged

hamishwillee mentioned this pull request Nov 27, 2018

Update docs to use new make configs PX4/PX4-user_guide#388

Merged

mrpollo mentioned this pull request Dec 14, 2018

Doc Bug: Building the Code · PX4 Developer Guide PX4/PX4-Devguide#696

Closed

mrpollo mentioned this pull request Jan 9, 2019

v1.9.0 Release notes + Changelog #11175

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

boards organization #10875

boards organization #10875

dagar commented Nov 20, 2018 •

edited by AuterionWrikeBot

Loading

LorenzMeier commented Nov 20, 2018

davids5 left a comment

dagar commented Nov 20, 2018

davids5 commented Nov 20, 2018

mrpollo commented Nov 20, 2018

davids5 commented Nov 20, 2018

bkueng left a comment

bkueng Nov 21, 2018

dagar Nov 21, 2018

davids5 Nov 21, 2018

bkueng Nov 21, 2018

dagar commented Nov 22, 2018

Avysuarez commented Nov 26, 2018

dannyfpv commented Nov 26, 2018

davids5 left a comment

mrpollo commented Nov 27, 2018

boards organization #10875

boards organization #10875

Conversation

dagar commented Nov 20, 2018 • edited by AuterionWrikeBot Loading

LorenzMeier commented Nov 20, 2018

davids5 left a comment

Choose a reason for hiding this comment

dagar commented Nov 20, 2018

davids5 commented Nov 20, 2018

mrpollo commented Nov 20, 2018

davids5 commented Nov 20, 2018

bkueng left a comment

Choose a reason for hiding this comment

bkueng Nov 21, 2018

Choose a reason for hiding this comment

dagar Nov 21, 2018

Choose a reason for hiding this comment

davids5 Nov 21, 2018

Choose a reason for hiding this comment

bkueng Nov 21, 2018

Choose a reason for hiding this comment

dagar commented Nov 22, 2018

Avysuarez commented Nov 26, 2018

dannyfpv commented Nov 26, 2018

davids5 left a comment

Choose a reason for hiding this comment

mrpollo commented Nov 27, 2018

dagar commented Nov 20, 2018 •

edited by AuterionWrikeBot

Loading