Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[board] Add configuration version for DISCO-F469NI #819

Merged
merged 2 commits into from
Feb 14, 2022
Merged

[board] Add configuration version for DISCO-F469NI #819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52ea9b3
[repo] Add revisions for board configs
salkinium Feb 6, 2022
b18385c
[board] Fix DISCO-F469NI rev B-03 touch sensor address
salkinium Feb 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/src/guide/custom-project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,16 @@ discover all of modm yet. You can now choose from two levels of customization:

## Using a Board Support Package

Use lbuild to discover the specific BSP configuration you want to use:
Use lbuild to discover the specific BSP configuration you want to use.
Some board configurations support different hardware revisions, so check your
hardware to select the right one:

```
$ lbuild discover
Parser(lbuild)
╰── Repository(modm @ ../../ext/modm) modm: a barebone embedded library generator
├── Option(target) = REQUIRED in [stm32f469ngh6, stm32f469nih6, stm32f469vet6, ...
├── Config(modm:disco-f469ni) STM32F469IDISCOVERY
├── Config(modm:disco-f469ni:b-03) in [b-01, b-03] STM32F469IDISCOVERY
...
```

Expand All @@ -113,7 +115,7 @@ cannot remove any inherited modules.
<library>
<repositories>...</repositories>

<extends>modm:disco-f469ni</extends>
<extends>modm:disco-f469ni:b-03</extends>

<options>...</options>
<modules>...</modules>
Expand Down
4 changes: 2 additions & 2 deletions docs/src/guide/discover.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ format. The `modm/repo.lb` file must be declared to find all modm modules:
Parser(lbuild)
╰── Repository(modm @ .) modm: a barebone embedded library generator
├── Option(target) = REQUIRED in [stm32f469ngh6, stm32f469nih6, stm32f469vet6, ...
├── Config(modm:disco-f469ni) STM32F469IDISCOVERY
├── Config(modm:disco-f469ni:b-03) in [b-01, b-03] STM32F469IDISCOVERY
...
```

Expand Down Expand Up @@ -54,7 +54,7 @@ modules for this specific target. We will choose the `stm32f469nih6` device:
Parser(lbuild)
╰── Repository(modm @ .) modm: a barebone embedded library generator
├── Option(target) = stm32f469nih6 in [stm32f407vgt6, stm32f469nih6, ...
├── Config(modm:disco-f469ni) STM32F469IDISCOVERY
├── Config(modm:disco-f469ni:b-03) in [b-01, b-03] STM32F469IDISCOVERY
...
├── Module(modm:board) Board Support Packages
│ ╰── Module(modm:board:disco-f469ni) STM32F469IDISCOVERY
Expand Down
2 changes: 1 addition & 1 deletion examples/stm32f469_discovery/game_of_life/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ constexpr modm::MemoryTraits traits = SCALE >= 4 ? modm::MemoryFastData : modm::
void read_touch()
{
static Touch::Data touchData;
static Touch touchSensor(touchData);
static Touch touchSensor(touchData, TouchAddress);
static bool initialized = false;
if (not initialized) {
// Configure the touchscreen to sample with 60Hz in active and monitor mode.
Expand Down
2 changes: 1 addition & 1 deletion examples/stm32f469_discovery/lvgl/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ static lv_color_t* buf;
static constexpr size_t buf_size = LV_HOR_RES_MAX * LV_VER_RES_MAX;

Touch::Data touchData;
Touch touch{touchData};
Touch touch{touchData, TouchAddress};

void my_touchpad_read(lv_indev_drv_t*, lv_indev_data_t* data)
{
Expand Down
2 changes: 1 addition & 1 deletion examples/stm32f469_discovery/touchscreen/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class LineDrawer : public modm::pt::Protothread
{
public:
LineDrawer() :
touch(touchData),
touch(touchData, TouchAddress),
display{Board::getDisplay()},
px{-1, -1}, py{-1, -1},
c{modm::color::html::White, modm::color::html::White}
Expand Down
18 changes: 11 additions & 7 deletions repo.lb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ from os.path import normpath

# Check for miminum required lbuild version
import lbuild
min_lbuild_version = "1.20.0"
min_lbuild_version = "1.21.0"
if StrictVersion(getattr(lbuild, "__version__", "0.1.0")) < StrictVersion(min_lbuild_version):
print("modm requires at least lbuild v{}, please upgrade!\n"
" pip3 install -U lbuild".format(min_lbuild_version))
Expand Down Expand Up @@ -224,15 +224,19 @@ def init(repo):
repo.add_ignore_patterns("*/*.lb", "*/board.xml")

# Add the board configuration files as their module name aliases
for config in Path(repopath("src/modm/board")).glob("*/board.xml"):
name = re.search(r"<module>modm:board:(.*?)</module>", config.read_text()).group(1)
if (config.parent / "module.md").exists():
description = FileReader(str(config.parent / "module.md"))
for module in Path(repopath("src/modm/board")).glob("*/module.lb"):
module_text = module.read_text()
name = re.search(r"\.name += +\".*?:board:(.*?)\"", module_text).group(1)
if (module.parent / "module.md").exists():
description = FileReader(str(module.parent / "module.md"))
else:
description = re.search(r'\.description += +(""".*?"""|".*?")',
(config.parent / "module.lb").read_text(), flags=re.S|re.M)
module_text, flags=re.S|re.M)
description = description.group(1).strip('"\\') if description else None
repo.add_configuration(name, config, description)
versions = re.search(r"#+ +[Rr]evisions? += +\[(.*)\]", module_text)
versions = versions.group(1).split(",") if versions is not None else [""]
config = {v.strip(): (module.parent / "board.xml") for v in versions}
repo.add_configuration(Configuration(name, description, config, versions[0].strip()))

# Backwards compatible move, remove this in 2022.
repo.add_alias(Alias(name="blue-pill", destination=":blue-pill-f103",
Expand Down
1 change: 1 addition & 0 deletions src/modm/board/disco_f469ni/board.hpp → src/modm/board/disco_f469ni/board.hpp.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ using Scl = GpioB8;
using Sda = GpioB9;
using I2cMaster = I2cMaster1;
using Touch = modm::Ft6x06< I2cMaster >;
constexpr uint8_t TouchAddress = {{touch_address}};
}

namespace usb
Expand Down
11 changes: 9 additions & 2 deletions src/modm/board/disco_f469ni/module.lb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
def init(module):
module.name = ":board:disco-f469ni"
module.description = FileReader("module.md")
# Revisions = [b-03, b-01]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But the line is commented out?!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The config is just a named (versioned) alias to a project.xml file inside modm. It must be declared in repo.lb so it can act as a repository option, therefore you need a mechanism to pass the revision to the repo.lb without having a giant table there, which is currently done by regexing the board/*/module.lb files. It's not great, but I don't know a better way. Ideas?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe create a module.revisions file and add one configuration name per line?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's fix it when it becomes a problem. I first would like to see more board revision examples to decide a better way.


def prepare(module, options):
if not options[":target"].partname.startswith("stm32f469nih"):
Expand All @@ -39,10 +40,16 @@ def build(env):
env.outbasepath = "modm/src/modm/board"
env.substitutions = {
"with_logger": True,
"with_assert": env.has_module(":architecture:assert")
"with_assert": env.has_module(":architecture:assert"),
"touch_address": 0x38 if env[":disco-f469ni"] == "b-03" else 0x2a,
}
env.template("../board.cpp.in", "board.cpp")
env.copy('.')
env.copy("board_display.cpp")
env.copy("board_dsi.cpp")
env.copy("board_init.cpp")
env.copy("board_otm8009a.cpp")
env.copy("board_sdram.cpp")
env.template("board.hpp.in")
env.collect(":build:openocd.source", "board/stm32f469discovery.cfg")

env.collect(":platform:cortex-m:linkerscript.memory", linkerscript_memory)
Expand Down
14 changes: 14 additions & 0 deletions src/modm/board/disco_f469ni/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,17 @@ Access to the capacitive touchscreen is provided in the `Board::ft6` namespace.
Call `Board::initializeTouchscreen()` to setup the peripherals.

[Product Link](https://www.st.com/en/evaluation-tools/32f469idiscovery.html)


## Hardware Revisions

The revision B-03 has a different touch sensor address from B-01, which is
provided as `Board::ft6::TouchAddress`:

```cpp
Board::ft6::Touch::Data data;
Board::ft6::Touch touchSensor(data, Board::ft6::TouchAddress);
```

If you have an earlier revision, you can extend your configuration from
`modm:disco-f469ni:b-01`.