-
Notifications
You must be signed in to change notification settings - Fork 6
Update README file for buildroot external tree #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
README.md
Outdated
| This `BR2_EXTERNAL` tree provides two Buildroot configurations: | ||
|
|
||
| 1. `ti_release_am62x_sk_defconfig`, configuration to support the | ||
| [SK-AM62](https://www.ti.com/tool/SK-AM62) board. It builds and packages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add all three variants of AM62x EVM we support on ti.com,
README.md
Outdated
| minimal user-space composed of Busybox and weston. | ||
|
|
||
| 2. `ti_release_am62x_sk_rt_defconfig`, configuration to support the | ||
| [SK-AM62](https://www.ti.com/tool/SK-AM62) board. It builds and packages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README.md
Outdated
| * [Buildroot](https://buildroot.org/) | ||
| * [Buildroot reference manual](https://buildroot.org/downloads/manual/manual.html) | ||
| * [Buildroot system development training course](https://bootlin.com/training/buildroot/) | ||
| * [External Buildroot tree ST](https://github.com/bootlin/buildroot-external-st) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What have we referred from STM??
Ideally we should only refer Buildroot official steps
README.md
Outdated
|
|
||
| 1. `ti_release_am62x_sk_defconfig`, configuration to support the | ||
| [SK-AM62](https://www.ti.com/tool/SK-AM62) board. It builds and packages | ||
| TF-A, optee, ti-linux-firmware, ti-u-boot bootloader, ti-linux-kernel, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better we link to individual git.ti.com/github repositories for all
|
|
||
| ```bash | ||
| $ sudo apt install debianutils sed make binutils build-essential gcc g++ bash patch gzip bzip2 perl tar cpio unzip rsync file bc git | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see few packages missing from Buildroot's recommended list - https://buildroot.org/downloads/manual/manual.html#requirement
Eg: which, diffutils, wget..
README.md
Outdated
| For detailed information refer | ||
| [corresponding manual section](https://buildroot.org/downloads/manual/manual.html#requirement-optional). | ||
|
|
||
| ### Steps to Build the Image |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Steps to Build the SD card Image
README.md
Outdated
| For further customize the Buildroot configuration, run `make menuconfig`. | ||
| This step is optional but useful if you need to make specific adjustments. | ||
|
|
||
| Build the Image: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Build the SD card Image:
README.md
Outdated
| time, depending on your system's resources and the complexity of | ||
| the configuration. | ||
|
|
||
| ## Flashing and booting the image |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Flashing and booting the SD card image
README.md
Outdated
| buildroot/ $ sudo dd if=output/images/sdcard.img of=/dev/sdX | ||
| ``` | ||
|
|
||
| (Note: Replace /dev/sdX with the appropriate device identifier for your SD card. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For Note insert a blockquote and add a unicode character 📝
Refer - https://github.com/TexasInstruments/ti-docker-images/blob/main/README.md?plain=1#L83
README.md
Outdated
| (Note: Replace /dev/sdX with the appropriate device identifier for your SD card. | ||
| ) | ||
|
|
||
| Tools like balena-ethcer can also be used to flash this image. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add Link to balena-etcher tool
README.md
Outdated
| (Note: Replace /dev/sdX with the appropriate device identifier for your SD card. | ||
| ) | ||
|
|
||
| Tools like balena-ethcer can also be used to flash this image. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tools like balena-ethcer can also be used to flash the SD card image.
README.md
Outdated
| (Note: Replace /dev/sdX with the appropriate device identifier for your SD card. | ||
| ) | ||
|
|
||
| Tools like balena-ethcer can also be used to flash this image. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does balena support .img format?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
README.md
Outdated
|
|
||
| Tools like balena-ethcer can also be used to flash this image. | ||
|
|
||
| Insert the SD Card in SD Card slot and power on the board (ex. AM62X-SK). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also guide users to switch boot pins to SD card boot mode.
README.md
Outdated
|
|
||
| Tools like balena-ethcer can also be used to flash this image. | ||
|
|
||
| Insert the SD Card in SD Card slot and power on the board (ex. AM62X-SK). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(ex. AM62X-SK)
Same comment as https://github.com/TexasInstruments/buildroot-external-TI/pull/2/files#r1703526320
| [SK-AM62](https://www.ti.com/tool/SK-AM62) board. It builds and packages | ||
| TF-A, optee, ti-linux-firmware, ti-u-boot bootloader, ti-linux-kernel (RT-Linux), | ||
| a minimal user-space composed of Busybox and weston. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a section which says the prebuilt SD card image is already available to ti.com if users want to avoid building the entire image from sources.
README.md
Outdated
| * [Buildroot](https://buildroot.org/) | ||
| * [Buildroot reference manual](https://buildroot.org/downloads/manual/manual.html) | ||
| * [Buildroot system development training course](https://bootlin.com/training/buildroot/) | ||
| * [External Buildroot tree ST](https://github.com/bootlin/buildroot-external-st) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a section for support with E2E as reference
cshilwant
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs work
837f6d4 to
774dd90
Compare
|
you can view the readme here https://github.com/TexasInstruments/buildroot-external-TI/tree/readme |
5367a89 to
847b038
Compare
README.md
Outdated
|
|
||
| ## Prebuild SD card images | ||
|
|
||
| Pre-build buildroot SD card images are available at: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pre-build => Pre-built
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment on line 36 as well
README.md
Outdated
| ``` | ||
|
|
||
| Optional dependencies are available for enabling Buildroot features such as | ||
| interface configuration, legal information or documentation. For detailed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or => and
|
|
||
| - The directories for `buildroot` directory and `buildroot-external-ti` are now | ||
| located side by side. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't need the 2nd "directory" there.
Also side-by-side.
README.md
Outdated
| ``` | ||
|
|
||
| - This process compiles the necessary components and creates the root filesystem, | ||
| kernel, and bootloader. The build process can take sometime, depending on your |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sometime => some time
|
@TexasInstruments/sitara-mpu-linux-sdk The documentation preview is available at https://github.com/TexasInstruments/buildroot-external-TI/tree/readme |
a2435a1 to
4dd1806
Compare
README.md
Outdated
|
|
||
| This `BR2_EXTERNAL` tree provides two Buildroot configurations: | ||
|
|
||
| 1. `ti_release_am62x_sk_defconfig` for non-RT-Linux |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ti_release_am62x_sk_defconfigfor Linux
cshilwant
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs Work
README.md
Outdated
| - [ti-linux-firmware](https://git.ti.com/cgit/processor-firmware/ti-linux-firmware) | ||
| - [busybox](https://git.busybox.net/busybox/) | ||
|
|
||
| ## Prebuild SD card images |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Prebuilt
Add overview about buildroot and buildroot external tree, steps to build a configuration and then flash and build an image. Signed-off-by: Paresh Bhagat <p-bhagat@ti.com>
cshilwant
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Add overview about buildroot and buildroot external tree, steps to build a configuration and then flash and build an image.