Contradictory comments in boot2_w25q080.S and exit_from_boot2.S

[Kristine1975]

According to the comment boot2_w25q080.S, upon entry lr is 0x10000100:

pico-sdk/src/rp2_common/boot_stage2/boot2_w25q080.S

Lines 95 to 96 in 2062372

	// The exit point is passed in lr. If entered from bootrom, this will be the
	// flash address immediately following this second stage (0x10000100).

According to the comment in exit_from_boot2.S however, it is zero, and that is what the code checks for:

pico-sdk/src/rp2_common/boot_stage2/asminclude/boot2_helpers/exit_from_boot2.S

Lines 12 to 13 in 2062372

	// If entered from the bootrom, lr (which we earlier pushed) will be 0,
	// and we vector through the table at the start of the main flash image.

So my guess is the comment in boot2_w25q080.S is incorrect (as well as the one in boot2_at25sf128a.S).

[lurch]

Perhaps this is related to #10 ? 🤷‍♂️

[Kristine1975]

Perhaps this is related to #10 ? 🤷‍♂️

It doesn't look like it: The 0x10000100 comment already existed in the SDK's initial release 26653ea:

pico-sdk/src/rp2_common/boot_stage2/boot2_w25q080.S

Lines 94 to 95 in 26653ea

	// The exit point is passed in lr. If entered from bootrom, this will be the
	// flash address immediately following this second stage (0x10000100).

#10 merely extracted the code with the second comment to its own file exit_from_boot2.S.