some comment cleanup #3150

Merged
kilograham merged 2 commits from comment-cleanup into develop 2026-08-20 17:11:21 -05:00
kilograham commented 2026-08-19 19:49:03 -05:00 (Migrated from github.com)
No description provided.
Wren6991 (Migrated from github.com) approved these changes 2026-08-19 21:49:29 -05:00
lurch (Migrated from github.com) reviewed 2026-08-20 04:44:09 -05:00
@ -21,0 +28,4 @@
//
// On RP2040 we preserve the original default lock numbers existing since SDK v1.0, since they are a
// compatibility detail that out-of-tree code might rely on.
lurch (Migrated from github.com) commented 2026-08-20 04:44:09 -05:00

The above paragraph explains why/when spinliock numbers are different on RP2350. I'm not sure we need this "On RP2040 we preserve the original default lock numbers" sentence?

The above paragraph explains why/when spinliock numbers are different on RP2350. I'm not sure we need this "On RP2040 we preserve the original default lock numbers" sentence?
lurch (Migrated from github.com) reviewed 2026-08-20 05:02:42 -05:00
lurch (Migrated from github.com) commented 2026-08-20 05:02:41 -05:00

This "0 on RP2040 unless..." wording gives no hint as to what the default value might be on RP2350, so perhaps it's better to explicitly state exactly when it is 0 (with the implication then being that it's 1 in any other situation)? I.e.

// PICO_CONFIG: PICO_RUNTIME_SKIP_INIT_RP2040_GPIO_IE_DISABLE, Skip calling of `runtime_init_rp2040_gpio_ie_disable` function during runtime init, type=bool, default=0 on RP2040 when PICO_IE_26_29_UNCHANGED_ON_RESET is unset, group=pico_runtime_init

P.S. Looks like we might also need a PICO_CONFIG: entry for PICO_IE_26_29_UNCHANGED_ON_RESET ?

$ git grep PICO_IE_26_29_UNCHANGED_ON_RESET
src/rp2_common/pico_runtime_init/include/pico/runtime_init.h:#if !PICO_RP2040 || PICO_IE_26_29_UNCHANGED_ON_RESET
src/rp2_common/pico_runtime_init/runtime_init.c:#if PICO_RP2040 && !PICO_IE_26_29_UNCHANGED_ON_RESET
This "0 on RP2040 unless..." wording gives no hint as to what the default value might be on RP2350, so perhaps it's better to explicitly state exactly when it **is** 0 (with the implication then being that it's 1 in any other situation)? I.e. ```suggestion // PICO_CONFIG: PICO_RUNTIME_SKIP_INIT_RP2040_GPIO_IE_DISABLE, Skip calling of `runtime_init_rp2040_gpio_ie_disable` function during runtime init, type=bool, default=0 on RP2040 when PICO_IE_26_29_UNCHANGED_ON_RESET is unset, group=pico_runtime_init ``` P.S. Looks like we might also need a `PICO_CONFIG:` entry for `PICO_IE_26_29_UNCHANGED_ON_RESET` ? ```console $ git grep PICO_IE_26_29_UNCHANGED_ON_RESET src/rp2_common/pico_runtime_init/include/pico/runtime_init.h:#if !PICO_RP2040 || PICO_IE_26_29_UNCHANGED_ON_RESET src/rp2_common/pico_runtime_init/runtime_init.c:#if PICO_RP2040 && !PICO_IE_26_29_UNCHANGED_ON_RESET ```
Wren6991 (Migrated from github.com) reviewed 2026-08-20 06:57:19 -05:00
@ -21,0 +28,4 @@
//
// On RP2040 we preserve the original default lock numbers existing since SDK v1.0, since they are a
// compatibility detail that out-of-tree code might rely on.
Wren6991 (Migrated from github.com) commented 2026-08-20 06:57:19 -05:00

otherwise we would have just changed the default for all platforms

otherwise we would have just changed the default for all platforms
kilograham (Migrated from github.com) reviewed 2026-08-20 17:11:58 -05:00
kilograham (Migrated from github.com) commented 2026-08-20 17:11:58 -05:00

unset is unclear since it is unset or 0... feel free to make a PR/issue for adding PICO_IE_26_20_UNCHANGED_ON_RESET

unset is unclear since it is unset or 0... feel free to make a PR/issue for adding `PICO_IE_26_20_UNCHANGED_ON_RESET`
lurch (Migrated from github.com) reviewed 2026-08-21 07:24:18 -05:00
lurch (Migrated from github.com) commented 2026-08-21 07:24:18 -05:00

LOL. I was originally going to write "...is 0" since that's more technically accurate, but I thought you'd prefer the "is unset" wording 😆

LOL. I was originally going to write "...is 0" since that's more technically accurate, but I thought you'd prefer the "is unset" wording :laughing:
lurch (Migrated from github.com) reviewed 2026-08-21 07:30:42 -05:00
lurch (Migrated from github.com) commented 2026-08-21 07:30:42 -05:00

I created an issue ( #3153 ) rather than a PR, because I've no idea what the description for PICO_IE_26_20_UNCHANGED_ON_RESET should be (nor where would be a sensible place to add it).

I created an issue ( #3153 ) rather than a PR, because I've no idea what the `description` for `PICO_IE_26_20_UNCHANGED_ON_RESET` should be (nor where would be a sensible place to add it).
Sign in to join this conversation.
No reviewers
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
gh-raspberrypi/pico-sdk!3150
No description provided.