Skip to content

Conversation

@aniket-l
Copy link
Collaborator

@aniket-l aniket-l commented Nov 11, 2024

Existing page for flashing eMMC devices is out of date... It references a script that is no longer packaged in the Linux SDK Installer. Moreover the script usage may have differed across Jacinto/Sitara SDKs.

Add a new page which serves the same purpose but does not use any such script and hence is easier to maintain.

Update the TOC to reflect this change for applicable platforms. AM68 does not have an eMMC. Remove the page from it's TOC.

Existing Doc (Out of date): https://software-dl.ti.com/jacinto7/esd/processor-sdk-linux-am69/10_00_07_06/exports/docs/linux/How_to_Guides/Target/How_to_flash_emmc_device.html

@github-actions
Copy link

New warnings found with rstcheck:

source/linux/How_to_Guides/Target/How_to_manually_flash_emmc_device.rst:27: (INFO/1) Hyperlink target "flash-emmc-from-wic" is not referenced.

@aniket-l aniket-l force-pushed the bugfix/emmc-partitioning branch from fbde124 to d1cab81 Compare November 11, 2024 15:40
@github-actions
Copy link

New warnings found with rstcheck:

source/linux/How_to_Guides/Target/How_to_manually_flash_emmc_device.rst:27: (INFO/1) Hyperlink target "flash-emmc-from-wic" is not referenced.

@aniket-l
Copy link
Collaborator Author

@StaticRocket This rstcheck error seems to be incorrect? I am referencing the said Hyperlink target within the same page.

@aniket-l
Copy link
Collaborator Author

@cshilwant Let me know if you want me to add the same page (possibly with changes) to AM62X & AM62PX as well. It was disabled for those devices.

@jmenti
Copy link
Collaborator

jmenti commented Nov 11, 2024

There is some duplicate doc here: https://software-dl.ti.com/processor-sdk-linux/esd/AM62X/10_00_07_04/exports/docs/linux/Foundational_Components/U-Boot/UG-Memory.html?highlight=mmc%20sd
But IG your changes would be the most appropriate place to have step by instructions on how to flash eMMC.

Your new doc are specific instructions on how to flash eMMC and boot from UDA, if that was the only intention, then perhaps you need to rename the title and make this obvious. If that was not the intention, then you need to add the following:

  • how to flash and boot from boot0/boot1

Now if this is meant to be a complete how to guide for eMMC flash and boot, then there are other sections missing like:

  • how to enable warm reset

@StaticRocket
Copy link
Member

Ignore it for now:
rstcheck/rstcheck-core#4

@aniket-l
Copy link
Collaborator Author

aniket-l commented Nov 13, 2024

@jmenti

There is some duplicate doc here: https://software-dl.ti.com/processor-sdk-linux/esd/AM62X/10_00_07_04/exports/docs/linux/Foundational_Components/U-Boot/UG-Memory.html?highlight=mmc%20sd But IG your changes would be the most appropriate place to have step by instructions on how to flash eMMC.

Your new doc are specific instructions on how to flash eMMC and boot from UDA, if that was the only intention, then perhaps you need to rename the title and make this obvious. If that was not the intention, then you need to add the following:

Yeah I guess it is intended for the UDA partitions. Will update the titile to reflect the same, as you suggested.

The main intention is to replace an existing page for J7* devices which was completely out of date:
https://software-dl.ti.com/jacinto7/esd/processor-sdk-linux-am69/10_00_07_06/exports/docs/linux/How_to_Guides/Target/How_to_flash_emmc_device.html

This was a doc bug which needs to be fixed. Existing page also only has instructions for the UDA partition, so replacing that with manual steps. More information can be added later if required.

  • how to flash and boot from boot0/boot1

Now if this is meant to be a complete how to guide for eMMC flash and boot, then there are other sections missing like:

  • how to enable warm reset

@aniket-l aniket-l force-pushed the bugfix/emmc-partitioning branch from d1cab81 to 6d3c079 Compare November 13, 2024 05:06
@github-actions
Copy link

New warnings found with rstcheck:

source/linux/How_to_Guides/Target/How_to_manually_flash_emmc_device.rst:33: (INFO/1) Hyperlink target "flash-emmc-from-wic" is not referenced.

Existing page for flashing eMMC devices is out of date... It references
a script that is no longer packaged in the Linux SDK Installer. Moreover
the script usage may have differed across Jacinto/Sitara SDKs.

Add a new page which serves the same purpose but does not use any such
script and hence is easier to maintain.

Update the TOC to reflect this change for applicable platforms.
AM68 does not have an eMMC. Remove the page from it's TOC.

Signed-off-by: Aniket Limaye <[email protected]>
@aniket-l aniket-l force-pushed the bugfix/emmc-partitioning branch from 6d3c079 to 3124473 Compare November 14, 2024 05:08
@github-actions
Copy link

New warnings found with rstcheck:

source/linux/How_to_Guides/Target/How_to_manually_flash_emmc_device.rst:33: (INFO/1) Hyperlink target "flash-emmc-from-wic" is not referenced.

@aniket-l aniket-l closed this Nov 14, 2024
@aniket-l aniket-l reopened this Nov 14, 2024
@github-actions
Copy link

New warnings found with rstcheck:

source/linux/How_to_Guides/Target/How_to_manually_flash_emmc_device.rst:33: (INFO/1) Hyperlink target "flash-emmc-from-wic" is not referenced.

@uditkumarti
Copy link
Collaborator

LGTM for merge

@uditkumarti uditkumarti merged commit 88327c5 into TexasInstruments:master Nov 14, 2024
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants