mcci-catena / arduino-boards

Arduino board-support packages for MCCI-Catena
6 stars 3 forks source link

Naming of ARDUINO_... symbols for boards is inconsistent #11

Open terrillmoore opened 5 years ago

terrillmoore commented 5 years ago

In our SAMD BSPs, we (correctly) use ARDUINO_MCCI_CATENA_44xx as the board name. This is because we have (for example):

mcci_catena_4420.build.board=MCCI_CATENA_4420

The Arduiino framework automatically generates ARDUINO_MCCI_CATENA_4420 based on the value of build.board.

But in our STM32 BSPs, we have:

mcci_catena_4551.build.board=CATENA_4551

This results in names of the form ARDUINO_CATENA_4551, etc.

The ARDUINO_[board] symbol has to be unique, distinctive and consistent.

It's an arbitrary decision, but the trademark is “MCCI Catena”, not “Catena”, and this makes for an easy equivalent when we don't use "Catena" in the branding (as in "Model 3201") -- we definitely want ARDUINO_MCCI_MODEL_3201 rather than ARDUINO_MODEL_3201.

In all our boards.txt, the *.build.board={something} line should be of the form:

              *.build.board=MCCI_{something}

For Catenas, this should be:

          *.build.board=MCCI_CATENA_{something}

For connection exercisers, this is

          *.build.board=MCCI_MODEL_{something}

This need to be fixed in the STM32 BSPs. Please check the 4801 as well.