Skip to content

Commit

Permalink
README.md: Update versions, links and indents in README
Browse files Browse the repository at this point in the history 
Signed-off-by: Michał Iwanicki <[email protected]>
  • Loading branch information
@m-iwanicki @macpijan
m-iwanicki authored and macpijan committed Aug 9, 2024
1 parent aa8c094 commit 685c998
Showing 1 changed file with 61 additions and 66 deletions.
127 changes: 61 additions & 66 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,35 @@

## Prerequisites

* Linux PC (tested on `Ubuntu 20.04 LTS`)
* Linux PC (tested on `Fedora 39`)

* [docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) installed
* [docker](https://docs.docker.com/engine/install/fedora/) installed

* [kas-container 2.6.3](https://raw.githubusercontent.com/siemens/kas/2.6.3/kas-container)
script downloaded and available in [PATH](https://en.wikipedia.org/wiki/PATH_(variable))
* [kas-container 3.0.2](https://raw.githubusercontent.com/siemens/kas/3.0.2/kas-container)
script downloaded and available in [PATH](https://en.wikipedia.org/wiki/PATH_(variable))

```bash
wget -O ~/bin/kas-container https://raw.githubusercontent.com/siemens/kas/2.6.3/kas-container
chmod +x ~/bin/kas-container
```
```bash
wget -O ~/bin/kas-container https://raw.githubusercontent.com/siemens/kas/3.0.2/kas-container
chmod +x ~/bin/kas-container
```

* `meta-zarhus` repository cloned

```bash
mkdir yocto
cd yocto
git clone GIT_URL
```
```bash
mkdir yocto
cd yocto
git clone https://github.com/zarhus/meta-zarhus.git
```

* [bmaptool](https://source.tizen.org/documentation/reference/bmaptool) installed
* [bmaptool](https://docs.yoctoproject.org/dev-manual/bmaptool.html) installed

```bash
sudo apt install bmap-tools
```
```bash
sudo dnf install bmap-tools
```

> You can also use `bmap-tools`
> [from github](https://github.com/intel/bmap-tools) if it is not available in
> your distro.
> You can also use `bmap-tools`
> [from GitHub](https://github.com/yoctoproject/bmaptool) if it is not
> available in your distro.
## Build

Expand All @@ -39,19 +39,19 @@ with desired `.yml` file.

* From `yocto` directory run:

```shell
$ SHELL=/bin/bash kas-container build meta-zarhus/kas-debug.yml
```
```shell
SHELL=/bin/bash kas-container build meta-zarhus/kas-debug.yml
```

* Image build takes time, so be patient and after build's finish you should see
something similar to (the exact tasks numbers may differ):

```shell
Initialising tasks: 100% |###########################################################################################| Time: 0:00:01
Sstate summary: Wanted 2 Found 0 Missed 2 Current 931 (0% match, 99% complete)
NOTE: Executing Tasks
NOTE: Tasks Summary: Attempted 2532 tasks of which 2524 didn't need to be rerun and all succeeded.
```
```shell
Initialising tasks: 100% |###########################################################################################| Time: 0:00:01
Sstate summary: Wanted 2 Found 0 Missed 2 Current 931 (0% match, 99% complete)
NOTE: Executing Tasks
NOTE: Tasks Summary: Attempted 2532 tasks of which 2524 didn't need to be rerun and all succeeded.
```
### Private git repositories
Expand Down Expand Up @@ -92,65 +92,60 @@ Host github.com
* From `yocto` directory run:
```shell
$ SHELL=/bin/bash kas-container --ssh-dir ~/ssh-keys build meta-zarhus/kas-debug.yml
```
```shell
$ SHELL=/bin/bash kas-container --ssh-dir ~/ssh-keys build meta-zarhus/kas-debug.yml
```
## Enter docker shell
Some Yocto related work may need to use bitbake environment. The easiest way to
Some Yocto related work may need to use BitBake environment. The easiest way to
achieve that is to start `kas-container` in shell mode. Depending on which
version of build you want to use, replace `kas-debug.yml` with desired `.yml`
file.
* From `yocto` directory run:
```shell
$ SHELL=/bin/bash kas-container shell meta-3mdeb/kas-debug.yml
```
```shell
$ SHELL=/bin/bash kas-container shell meta-3mdeb/kas-debug.yml
```
## Flash
This section assumes that image can be flashed on SD card.
* Find out your device name:
```shell
$ fdisk -l
```
output:
```shell
(...)
Device Boot Start End Sectors Size Id Type
/dev/sdx1 * 8192 131433 123242 60,2M c W95 FAT32 (LBA)
/dev/sdx2 139264 186667 47404 23,2M 83 Linux
```
```shell
$ lsblk
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
sdx 179:0 0 14.8G 0 disk
├─sdx1 179:1 0 4M 0 part
└─sdx2 179:2 0 4M 0 part
```
in this case the device name is `/dev/sdx` **but be aware, in next steps
replace `/dev/sdx` with right device name on your platform or else you can
damage your system!.**
In this case the device name is `/dev/sdx` **but be aware, in next steps
replace `/dev/sdx` with right device name on your platform or else you can
damage your system!.**
* From where you ran image build type:
```shell
$ cd build/tmp/deploy/images/zarhus-machine-cm3
$ sudo umount /dev/sdx*
$ sudo bmaptool copy --bmap zarhus-base-image-zarhus-machine-cm3.wic.bmap zarhus-base-image-zarhus-machine-cm3.wic.gz /dev/sdx
```
```shell
$ cd build/tmp/deploy/images/zarhus-machine-cm3
$ sudo umount /dev/sdx*
$ sudo bmaptool copy zarhus-base-image-zarhus-machine-cm3.wic.gz /dev/sdx
```
and you should see output similar to this (the exact size number may differ):
```shell
zarhus-base-image-zarhus-machine-cm3.wic.bmap zarhus-base-image-zarhus-machine-cm3.wic.gz /dev/sdx
bmaptool: info: block map format version 2.0
bmaptool: info: 74650 blocks of size 4096 (291.6 MiB), mapped 42052 blocks (164.3 MiB or 56.3%)
bmaptool: info: copying image 'zarhus-base-image-zarhus-machine-cm3.wic.gz' to block device '/dev/sdx' using bmap file 'zarhus-base-image-zarhus-machine-cm3.wic.bmap'
bmaptool: WARNING: failed to enable I/O optimization, expect suboptimal speed (reason: cannot switch to the 'noop' I/O scheduler: [Errno 22] Invalid argument)
bmaptool: info: 100% copied
bmaptool: info: synchronizing '/dev/sdx'
bmaptool: info: copying time: 11.0s, copying speed 15.0 MiB/sec
```
```shell
zarhus-base-image-zarhus-machine-cm3.wic.bmap zarhus-base-image-zarhus-machine-cm3.wic.gz /dev/sdx
bmaptool: info: block map format version 2.0
bmaptool: info: 74650 blocks of size 4096 (291.6 MiB), mapped 42052 blocks (164.3 MiB or 56.3%)
bmaptool: info: copying image 'zarhus-base-image-zarhus-machine-cm3.wic.gz' to block device '/dev/sdx' using bmap file 'zarhus-base-image-zarhus-machine-cm3.wic.bmap'
bmaptool: WARNING: failed to enable I/O optimization, expect suboptimal speed (reason: cannot switch to the 'noop' I/O scheduler: [Errno 22] Invalid argument)
bmaptool: info: 100% copied
bmaptool: info: synchronizing '/dev/sdx'
bmaptool: info: copying time: 11.0s, copying speed 15.0 MiB/sec
```
* Boot the platform

0 comments on commit 685c998

Please sign in to comment.