Improve pico_use_wifi_firmware_partition docs #2580

2025-07-22T09:58:53-05:00

will-v-pi commented

2025-07-22 09:58:53 -05:00

(Migrated from github.com)

Add instructions about the order of loading the separate UF2 files

kilograham (Migrated from github.com) reviewed

2025-07-22 16:54:38 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -182,0 +184,4 @@

				    # 5.1.17 of the RP2350 datasheet). You will need to flash your chosen version to each

				    # new device once, after loading the partition table. For example using picotool:

				    #

				    # `picotool load TARGET.uf2`;

which is which? it is a bit confusing as "firmware" is the common nomenclature for a program you run on a microcontroller

kilograham (Migrated from github.com) reviewed

2025-07-22 16:54:59 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -182,0 +184,4 @@

				    # 5.1.17 of the RP2350 datasheet). You will need to flash your chosen version to each

				    # new device once, after loading the partition table. For example using picotool:

				    #

				    # `picotool load TARGET.uf2`;

perhaps wifi_firmware in the name instead

perhaps `wifi_firmware` in the name instead

lurch (Migrated from github.com) reviewed

2025-07-23 05:39:18 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

nitpick: Probably don't need to use the word "separate" twice.

lurch (Migrated from github.com) reviewed

2025-07-23 05:44:00 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

"...for the firmware..." and "...for a TBYB version of the firmware..." is pretty confusing. Is one of these the UF2 file containing the WiFi firmware? Is one of them a UF2 file containing the user's executable?
I agree with Graham that this needs to be made clearer.

"...for the firmware..." and "...for a TBYB version of the firmware..." is pretty confusing. Is one of these the UF2 file containing the WiFi firmware? Is one of them a UF2 file containing the user's executable? I agree with Graham that this needs to be made clearer.

will-v-pi (Migrated from github.com) reviewed

2025-07-23 05:51:02 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

You get 3 UF2 files - your normal one, a separate one containing the wifi firmware, and a separate one containing a TBYB version of the wifi firmware

will-v-pi (Migrated from github.com) reviewed

2025-07-23 05:57:15 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -182,0 +184,4 @@

				    # 5.1.17 of the RP2350 datasheet). You will need to flash your chosen version to each

				    # new device once, after loading the partition table. For example using picotool:

				    #

				    # `picotool load TARGET.uf2`;

Have renamed it to TARGET_wifi_firmware

Have renamed it to `TARGET_wifi_firmware`

will-v-pi (Migrated from github.com) reviewed

2025-07-23 06:02:43 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

Have rephrased it to talk about additional UF2 files, as that's probably clearer than separate

lurch (Migrated from github.com) reviewed

2025-07-23 07:38:55 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

This is better, thanks. But somebody reading "You will need to flash one of these" for the first time might not know whether to use the "CYW43 firmware UF2" or the "TBYB version of the CYW43 firmware UF2"? 😕
Perhaps a sentence like "You will only need to use the TBYB firmware if you're using the TBYB feature (see section X.Y of the RP2350 datasheet)." would be helpful?

This is better, thanks. But somebody reading "You will need to flash one of these" for the first time might not know whether to use the "CYW43 firmware UF2" or the "TBYB version of the CYW43 firmware UF2"? :confused: Perhaps a sentence like "You will only need to use the TBYB firmware if you're using the TBYB feature (see section X.Y of the RP2350 datasheet)." would be helpful?

lurch (Migrated from github.com) reviewed

2025-07-23 07:44:26 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

Having just looked at the picotool README, perhaps it's worth suggesting the -u flag here too, so that they don't need to re-write the CYW43 firmware if it has already been written? 🤔

Having just looked at the [picotool README](https://github.com/raspberrypi/picotool/tree/develop?tab=readme-ov-file#load), perhaps it's worth suggesting the `-u` flag here too, so that they don't need to re-write the CYW43 firmware if it has already been written? :thinking:

lurch (Migrated from github.com) reviewed

2025-07-23 07:49:25 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

Also, I dunno if it's just a "me thing" but I always tend to put flags first and filenames last, so personally I'd write this as:

picotool load -x TARGET_wifi_firmware.uf2

Also, I dunno if it's just a "me thing" but I always tend to put flags first and filenames last, so personally I'd write this as: ``` picotool load -x TARGET_wifi_firmware.uf2 ```

will-v-pi (Migrated from github.com) reviewed

2025-07-24 04:41:21 -05:00

src/rp2_common/pico_cyw43_driver/CMakeLists.txt

					
				@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})

				    # NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it

I've rephrased it and added some clarification

kilograham (Migrated from github.com) approved these changes

2025-07-24 16:25:24 -05:00

Sign in to join this conversation.

No reviewers

kilograham

No labels

compiler version issues

needs reporter detail

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!2580

				`@ -179,6 +179,17 @@ if (EXISTS ${PICO_CYW43_DRIVER_PATH}/${CYW43_DRIVER_TEST_FILE})`
				`# NO_EMBEDDED_PT argument (for example, if you need to chain into the binary, it`

Rows
Columns