1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-15 01:23:49 +01:00

359 Commits

Author SHA1 Message Date
Marian Buschsieweke
3bede9c734
doc: replace obsolete xitter link with mastodon link 2024-03-01 09:38:46 +01:00
Dylan Laduranty
5b2beea08a
Merge pull request #20426 from maribu/doc/getting-started/windows
doc: Add guide for dev setup on Windows
2024-02-28 09:58:48 +00:00
Marian Buschsieweke
8b088c8d4a
doc: Add guide for dev setup on Windows
This adds a step-by-step guide to install a dev setup based on
WSL2 / Ubuntu and native VS Code with the WSL extension. The guide
uses screenshots and adds annotations on top using Inkscape, so that
every click is documented.

The Inkscape sources are also added to allow adjusting / fixing the
annotations later on without having to record a new set of screenshots.

Co-authored-by: Dylan Laduranty <dylan.laduranty@mesotic.com>
2024-02-28 10:18:39 +01:00
Marian Buschsieweke
dc040a0fdb
build system: Make use of YAML feature list 2024-02-23 15:12:11 +01:00
Marian Buschsieweke
3c5ae563d6
doc/roadmap: update contacts
Hauke has stopped working on RIOT for some time now and other
maintainers agreed to step up to take over the steering / contact job
during the VMA. This change replaces Hauke by benpicco and maribu as
contact as agreed upon.
2024-02-22 09:16:50 +01:00
Koen Zandberg
7b92a1beb2
Roadmap: Add Home-Assistant integration on the roadmap 2024-02-21 11:40:54 +01:00
chrysn
2f5ad41e41 doc/roadmap: Make working 6LBR a goal 2024-02-07 14:54:52 +01:00
Marian Buschsieweke
57ecb896ec
doc/getting-started: point out where to run make 2024-02-04 17:54:02 +01:00
chrysn
50c9d93951 rust/doc: Document make info-rust for IDE/editor setup 2024-02-01 14:39:43 +01:00
chrysn
6724884b93 makefiles/rust: Remove CARGO_CHANNEL special casing
Back when specific control of the Rust version used with RIOT was
needed, CARGO_CHANNEL was added to explicitly set the Rust version with
consideration for CI special cases.

Rust's mechansims of selecting a toolchain can be used instead now.
2024-01-31 12:25:09 +01:00
Benjamin Valentin
ca97f8ab2b doc/mainpage: don't claim to be a microkernel
We are clearly not and this just sets wrong expectations.
2024-01-11 16:59:50 +01:00
Marian Buschsieweke
82b7e10988
dist/tools/zsh-completion: provide completion for zsh
This adds command completion that, when manually installed, provides
RIOT-aware command completion for `make` in zsh. The completion
supports:

- most commonly used `make` goals including a help text
- most commonly used `make` variables (such as `BOARD=`, `LTO=`,
  `BUILD_IN_DOCKER=`, `TOOLCHAIN=`)
    - possible values for these variables, including a list of boards
      detected at runtime to complete `BOARD=`

Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de>
2024-01-08 13:48:17 +01:00
Marian Buschsieweke
25e3bcca3b
roadmap: extend peripheral drivers section 2023-12-07 09:22:40 +01:00
Marian Buschsieweke
e7e50caa53
doc: clean up roadmap
- drop completed tasks
- drop tasks that make no sense anymore (e.g. cleanup up MIPS, as
  MIPS was dropped or improving xtimer, as it was superseded by
  ztimer)
2023-12-01 12:40:13 +01:00
chrysn
5542ecd9a7 doc: Extend and take responsibility for 802.15.4 security roadmap 2023-11-30 13:42:57 +01:00
chrysn
7b01d41eca doc: Whitespace cleanup 2023-11-30 11:43:20 +01:00
chrysn
b5b7826b0c doc: Adjust markdown styles from GitHub to doxygen 2023-11-30 11:41:58 +01:00
chrysn
07a26742a4 doc: roadmap now done through pull requests 2023-11-30 11:40:13 +01:00
chrysn
437fb43f12 doc: Move roadmap in from the wiki
This copies the version of 2020-05-29, with only the header line added.
2023-11-30 11:22:29 +01:00
Marian Buschsieweke
61af0f38f8
boards/p-nucleo-wb55: Add pinout and clean up doc 2023-11-16 11:14:45 +01:00
Lena Boeckmann
d4c73d6a30 sys: Add PSA Crypto Module 2023-08-31 14:38:49 +02:00
Marian Buschsieweke
043e8cc88e
boards,sys/arduino: major clean up
- Rename all `arduino_pinmap.h` to `arduino_iomap.h`
    - An empty `arduino_pinmap.h` that just includes `arduino_iomap.h`
      is provided for backward compatibility
    - Move all info from `arduino_board.h` into the new file as trivial
      macros, so that they can also be used outside of sketches
    - The new name reflects the fact not just pin mappings, but also
      other I/O features such as PWMs are mapped
- Drop all `arduino_board.h`
    - `arduino_board.h` and `arduino_iomap.h` now provide the exact
      same information, just in a different format
    - a generic `arduino_board.h` is provided instead that just
      uses the info in `arduinio_iomap.h` and provides them in the
      format the code in `sys/arduino` expects it
- Add fine grained features to indicate for mappings
    - availability of mappings for analog pins, DAC pins, PWM pins,
      UART devices, SPI/I2C buses to the corresponding RIOT
      identification can now be expressed:
        - `arduino_pins`: `ARDUINO_PIN_0` etc. are available
        - `arduino_analog`: `ARDUINO_A0` etc. are available
        - `arduino_pwm`: `ARDUINO_PIN_13_PWM_DEV` etc. are available
        - `arduino_dac`: `ARDUINO_DAC0` etc. are available
        - `arduino_uart`: `ARDUINO_UART_D0D1` or similar are available
        - `arduino_spi`: `ARDUINO_SPI_ISP` or similar are available
        - `arduino_i2c`: `ARDUINO_I2C_UNO` or similar are available
    - mechanical/electrical compatibility with specific form factors
      can now be expressed as features:
        - `aruino_shield_nano`: Arduino NANO compatible headers
        - `aruino_shield_uno`: Arduino UNO compatible headers
        - `aruino_shield_mega`: Arduino MEGA compatible headers
        - `aruino_shield_isp`: ISP header is available

This provides the groundwork to implement shield support as modules
that can rely on the I/O mappings, rather than having to provide a
configuration per board.
2023-06-26 17:24:07 +02:00
bors[bot]
993c10a2a2
Merge #19556 #19662
19556: tools/mspdebug: fix `make debug` and `make debugserver` r=aabadie a=maribu

### Contribution description

The semantics of `make debug` and `make debugserver` have changed in the years since the MSP430 integration. This brings the implementation back into line with the current semantics

- `make debug` now starts both mspdebug and GDB, no need to run `make debugserver` prior to `make debug` anymore
- `make debug` no longer flashes the target to not waste flash erase cycles
- GDB mutliarch support is added
- support for selecting a debug adapter by its serial is added


19662: driver/lc709203f: remove unnecessary use of float r=aabadie a=kfessel

### Contribution description

removes a unnecessary use of float

### Testing procedure

read and test if you got that hardware (I don't)

### Issues/PRs references

#19614 

Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de>
Co-authored-by: Karl Fessel <karl.fessel@ovgu.de>
2023-05-24 15:54:23 +00:00
Marian Buschsieweke
ca15b1e1f8
tools/mspdebug: fix make debug and make debugserver
The semantics of `make debug` and `make debugserver` have changed in
the years since the MSP430 integration. This brings the implementation
back into line with the current semantics

- `make debug` now starts both mspdebug and GDB, no need to
  run `make debugserver` prior to `make debug` anymore
- `make debug` no longer flashes the target to not waste flash erase
  cycles
- GDB mutliarch support is added
- support for selecting a debug adapter by its serial is added
2023-05-24 17:00:38 +02:00
Alexandre Abadie
22fda62623
doc/mainpage: fix punctuation 2023-05-17 14:51:48 +02:00
Alexandre Abadie
a1c60faa2a
doc/mainpage: point to supported board on main website
The wiki page is fairly outdated
2023-05-17 14:51:11 +02:00
Marian Buschsieweke
5457014c4a
build-system: Allow out of tree BUILD_DIR
- Replace all users of `$(RIOTBASE)/build` with the already present
  `$(BUILD_DIR)` variable
- Replace all users of `$(BUILD_DIR)/pkg` with the already present
  `$(PKGDIRBASE)` variable
- Create a `CACHEDIR.TAG` file in the `$(BUILD_DIR)`
2023-05-16 22:23:03 +02:00
bors[bot]
4b4d77a0fe
Merge #19588
19588: doc: Remove ANSI r=benpicco a=bergzand

### Contribution description

> We moved to C11. And before that, we were at C99.

(When can we add Rust to this list?)

### Testing procedure

Check the docs

### Issues/PRs references

None


Co-authored-by: Koen Zandberg <koen@bergzand.net>
2023-05-15 12:09:24 +00:00
Alexandre Abadie
0cdeafd85d
doc: fix path to build system related test applications 2023-05-13 19:08:38 +02:00
Alexandre Abadie
5f3a9de7fa
treewide: fix path to ztimer test applications 2023-05-13 19:08:38 +02:00
Koen Zandberg
953f233e82
doc: Remove ANSI 2023-05-12 11:45:37 +02:00
Marian Buschsieweke
b671ee7cae
doc/doxygen/src/flashing.md: work around Doxygen bug
Doxygen fails to render inline code in headers correctly in the
version the CI uses. So, work around the issue by not typestetting
`stm32flash` as inline code but as regular text.
2023-05-11 13:45:28 +02:00
Marian Buschsieweke
29ec91fed3
boards/nucleo64: Add pinout diagrams from UM1724
ST's UM1724 user manual provides pinout diagrams for many Nucleo-64
boards. This adds them to the doc for easy of use.
2023-03-17 15:16:31 +01:00
Koen Zandberg
aa29646c0e
doxygen: Point to contributing.md document
Shortcuts a referral on the wiki
2023-03-14 16:00:55 +01:00
Marian Buschsieweke
8a4b4fb8dd
boards/common/blxxxpill: Update pinout
Also document the OSC32 connection of PC14/PC15 in the pinout.
2023-02-28 08:35:17 +01:00
Koen Zandberg
68bc404f94
doc: Add out of tree RIOT app documentation 2023-02-27 14:48:47 +01:00
Marian Buschsieweke
015ee050f2
makefiles/tools/serial.inc.mk: Allow detection of debug adapter
Boards with an integrated debugger/programmer that also provides the
serial as UART <--> USB adapter, the TTY serial matches the serial of
the programmer.

This adapts the `serial.inc.mk` to set the `DEBUG_ADAPTER_ID` to the
TTY serial if (and only if) `MOST_RECENT_PORT` *and*
`DEBUG_ADAPTER_ID_IS_TTY_SERIAL` both have a value of `1`. Boards with
an integrated programmer are expected to set
`DEBUG_ADAPTER_ID_IS_TTY_SERIAL` to `1` in their `Makefile.include`.
2023-02-24 16:50:56 +01:00
Marian Buschsieweke
660990afd3
boards/common/blxxxpill: Fix mixup in pinout
TX0 and RX0 in the pinout got mixed up. This swaps them back.
2023-02-08 14:54:45 +01:00
Koen Zandberg
fc471d659d
Doc: document generate-makefile.ci 2023-02-03 10:56:05 +01:00
krzysztof-cabaj
dba9c2729f doc/porting-boards.md: fix code snippets in Riot web page/doxygen 2023-01-30 15:05:12 -05:00
krzysztof-cabaj
9f0cf1c384 doc/porting-boards.md: fix code snippets in md view 2023-01-26 15:02:37 -05:00
Marian Buschsieweke
208bf7eef3
build system: improve MOST_RECENT_PORT=1 handling
Allow overriding the shell command used to auto-detect the TTY of a
board with `MOST_RECENT_PORT=1` via the `TTY_SELECT_CMD` variable.
The use case is to also detect Arduino Mega 2560 clones with cheap
USB UART bridges (for which the filter command may yield false
positives) while preferring genuine Arduino Mega 2560 boards (if
found) over the clones (as the filter for genuine boards does not yield
false positives).
2022-12-11 18:58:18 +01:00
Marian Buschsieweke
26d5b7ca0b
Merge pull request #18839 from chrysn-pull-requests/rust-use-stable
rust: Use stable Rust
2022-11-24 20:41:51 +01:00
chrysn
75836268e6 doc/rust: Nightly is not needed any more 2022-11-24 11:07:45 +01:00
Gregory Holder
7de170cf27
docs/kconfig: not longer -> no longer typo 2022-11-17 08:35:26 +00:00
benpicco
ed1d8e0a3d
Merge pull request #18785 from maribu/boards/blxxxpill/periph_conf
boards/common/blxxxpill: Fix pin conflicts in periph_conf
2022-10-27 21:22:10 +02:00
Marian Buschsieweke
051a1f1e32
boards/common/blxxxpill: rework periph configuration
The peripheral configuration has been completely reworked to resolve
pin conflicts while provided as much of the peripherals as possible.
The changes include:

- Move `I2C_DEV(0)` from PB6/PB7 to PB8/PB9 to solve pin conflict with
  `QDEC_DEV(2)`.
- Use pins PB0, PB1, PB4, and PB5 for PWM instead PA8, PA9, PA10, and
  PA11
    - PA9 and PA10 is in pin conflict with `UART_DEV(0)` which is used
      for stdio with `stdio_uart`, PA8 was in conflict with
      `QDEC_DEV(0)`, PA11 was in conflict with USB D-
- Use PB6, PB7 as `QDEC_DEV(0)` (previously `QDEC_DEV(2)`), as this is
  the only completely conflict free setting
- Use PB4/PB5 instead of PA6/PA7 for QDEC_DEV(1)
    - This fixes a pin conflict with `SPI_DEV(0)` MISO (and
      `ADC_LINE(4)`)
- Only provide QDEC at PB4/PB5 when PWM is not used to avoid conflict
- Only provide QDEC at PA8/PA9 when UART is not used to avoid conflict
- Use SPI2 (PB15, PB14, PB13, PB12) as `SPI_DEV(0)` instead of SPI1,
  use SPI1 (PA7, PA6, PA5, PA4) as `SPI_DEV(1)`
- Only provide `SPI_DEV(1)` if the ADC is not in used to resolve a
  pin conflict
- Move PB0 and PB1 at the end of the ADC lines (previously
  `ADC_LINE(6)` and `ADC_LINE(7)`, now `ADC_LINE(8)` and `ADC_LINE(9)`)
   - Only provide them when PWM is not in use (to resolve pin conflict
     with PWM)
   - Also do not provide them for the Blackpill boards, which are
     missing pins PB0 and PB1 on the headers

To make life of users easier, a Pinout diagram with the new
configuration was added.
2022-10-27 14:28:07 +02:00
Teufelchen1
35a06c4806 boards/native: Remove macOS as native target 2022-10-25 19:11:23 +02:00
MrKevinWeiss
6cad5d2477
cpu/mips: Remove all mips 2022-09-27 13:42:37 +02:00
chrysn
95c540058d doc/getting-started: Add C++ standard library to the list 2022-09-20 16:42:19 +02:00