Skip to content

Commit 56f3da2

Browse files
loollool
committed
Original release
Signed-off-by: Loïc Minier <[email protected]>
0 parents  commit 56f3da2

File tree

9 files changed

+693
-0
lines changed

9 files changed

+693
-0
lines changed

‎.github/workflows/qualcomm-organization-repolinter.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Qualcomm Organization Repolinter
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
repolinter:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout Repo
10+
uses: actions/checkout@v4
11+
- name: Verify repolinter config file is present
12+
id: check_files
13+
uses: andstor/file-existence-action@v3
14+
with:
15+
files: "repolint.json"
16+
- name: Run Repolinter with local repolint.json
17+
if: steps.check_files.outputs.files_exists == 'true'
18+
uses: todogroup/repolinter-action@v1
19+
with:
20+
config_file: "repolint.json"
21+
- name: Run Repolinter with default ruleset
22+
if: steps.check_files.outputs.files_exists == 'false'
23+
uses: todogroup/repolinter-action@v1
24+
with:
25+
config_url: "https://raw.githubusercontent.com/qualcomm/.github/main/repolint.json"

‎.github/workflows/stale-issues.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Comment on Stale Issues
2+
on:
3+
schedule:
4+
- cron: '30 1 * * *'
5+
6+
jobs:
7+
stale:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/stale@v9
11+
with:
12+
days-before-close: -1
13+
days-before-issue-stale: 30
14+
days-before-pr-stale: 30
15+
stale-pr-message: "This PR is stale. Add a nice message, can mention maintainers or maintainer team to draw attention"
16+
stale-issue-message: "This issue is stale. Add a nice message, can mention maintainers or maintainer team to draw attention"
17+

‎CODE-OF-CONDUCT.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[GitHub.QuIC.CoC](mailto:[email protected]?subject=GitHub%20QuIC%20Code%20of%20Conduct%20Report).
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
## Contributing to Qualcomm Linux deb images
2+
3+
Hi there!
4+
We’re thrilled that you’d like to contribute to this project.
5+
Your help is essential for keeping this project great and for making it better.
6+
7+
## Branching Strategy
8+
9+
In general, contributors should develop on branches based off of `main` and pull requests should be made against `main`.
10+
11+
## Submitting a pull request
12+
13+
1. Please read our [code of conduct](CODE-OF-CONDUCT.md) and [license](LICENSE.txt).
14+
1. [Fork](https://github.com/qualcomm-linux/qcom-deb-images/fork) and clone the repository.
15+
16+
```bash
17+
git clone https://github.com/<username>/qcom-deb-images.git
18+
```
19+
20+
1. Create a new branch based on `main`:
21+
22+
```bash
23+
git checkout -b <my-branch-name> main
24+
```
25+
26+
1. Create an upstream `remote` to make it easier to keep your branches up-to-date:
27+
28+
```bash
29+
git remote add upstream https://github.com/qualcomm-linux/qcom-deb-images.git
30+
```
31+
32+
1. Make your changes, add tests, and make sure the tests still pass.
33+
1. Commit your changes using the [DCO](https://developercertificate.org/). You can attest to the DCO by commiting with the **-s** or **--signoff** options or manually adding the "Signed-off-by":
34+
35+
```bash
36+
git commit -s -m "Really useful commit message"`
37+
```
38+
39+
1. After committing your changes on the topic branch, sync it with the upstream branch:
40+
41+
```bash
42+
git pull --rebase upstream main
43+
```
44+
45+
1. Push to your fork.
46+
47+
```bash
48+
git push -u origin <my-branch-name>
49+
```
50+
51+
The `-u` is shorthand for `--set-upstream`. This will set up the tracking reference so subsequent runs of `git push` or `git pull` can omit the remote and branch.
52+
53+
1. [Submit a pull request](https://github.com/qualcomm-linux/qcom-deb-images/pulls) from your branch to `main`.
54+
1. Pat yourself on the back and wait for your pull request to be reviewed.
55+
56+
Here are a few things you can do that will increase the likelihood of your pull request to be accepted:
57+
58+
- Follow the existing style where possible.
59+
- Write tests.
60+
- Keep your change as focused as possible.
61+
If you want to make multiple independent changes, please consider submitting them as separate pull requests.
62+
- Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
63+
- It's a good idea to arrange a discussion with other developers to ensure there is consensus on large features, architecture changes, and other core code changes. PR reviews will go much faster when there are no surprises.

‎LICENSE.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright (c) 2025 Qualcomm Innovation Center, Inc. All rights reserved.
2+
3+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4+
5+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
6+
7+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
8+
9+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
10+
11+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
12+
13+
SPDX-License-Identifier: BSD-3-Clause

‎README.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Qualcomm Linux deb images
2+
3+
A collection of recipes to build Qualcomm Linux images for deb based operating systems. The current focus of this project is to provide mainline centric images for Qualcomm® IoT platforms as to demonstrate the state of upstream open source software, help developers getting started, and support continuous development and continuous testing efforts.
4+
5+
Initially, this repository provides [debos](https://github.com/go-debos/debos) recipes based on Debian trixie for boards such as the Qualcomm RB3 Gen 2.
6+
7+
We are also working towards providing ready-to-use, pre-built images – stay tuned!
8+
9+
## Branches
10+
11+
main: Primary development branch. Contributors should develop submissions based on this branch, and submit pull requests to this branch.
12+
13+
## Requirements
14+
15+
[debos](https://github.com/go-debos/debos) is required to build the debos recipes. Recent debos packages should be available in Debian and Ubuntu repositories; there are
16+
[debos installation instructions](https://github.com/go-debos/debos?tab=readme-ov-file#installation-from-source-under-debian) on the project's page, notably for Docker images and to build debos from source.
17+
18+
[qdl](https://github.com/linux-msm/qdl) is typically used for flashing. While recent versions are available in Debian and Ubuntu, make sure you have at least version 2.1 as it contains important fixes.
19+
20+
## Usage
21+
22+
To build a disk image, run debos as follows:
23+
```bash
24+
debos debos-recipes/qualcomm-linux-debian.yaml
25+
```
26+
27+
### Build backends
28+
29+
By default, debos will try to pick a fast build backend; it will try to use its KVM backend ("-b kvm") when available, and otherwise an UML environment ("-b uml"). If none of these work, a solid backend is QEMU ("-b qemu"). Because the target images are arm64, this can be really slow, especially when building from another architecture such as amd64.
30+
31+
To build large images, the debos resource defaults might not be sufficient. Consider raising the default debos memory and scratchsize settings. This should provide a good set of minimum defaults:
32+
```bash
33+
debos --fakemachine-backend qemu --memory 1GiB --scratchsize 4GiB debos-recipes/qualcomm-linux-debian.yaml
34+
```
35+
36+
### Build options
37+
38+
A few options are provided in the debos recipe:
39+
- image: set the output disk image filename; default: `disk.img`
40+
- imagesize: set the output disk image size; default: `4GiB`
41+
- dtb: override the firmware provided device tree with one from the linux kernel, e.g. `qcom/qcs6490-rb3gen2.dtb`; default: don't override
42+
- xfcedesktop: install a Xfce desktop environment; default: console only environment
43+
- experimentalkernel: update the linux kernel to the version from experimental; default: don't update the kernel
44+
45+
These can be passed as follows:
46+
```bash
47+
debos -t dtb:qcom/qcs6490-rb3gen2.dtb -t xfcedesktop:true -t experimentalkernel:true debos-recipes/qualcomm-linux-debian.yaml
48+
```
49+
50+
## Flashing Instructions
51+
### Overview
52+
53+
Once a disk image is created, it is suitable for putting on an SD card, albeit most Qualcomm boards boot from internal storage by default. The disk image can also be flashed on the internal storage of your board with [qdl](https://github.com/linux-msm/qdl).
54+
55+
These images don't currently ambition to provide early boot assets such as boot firmware or data for other partitions containing board specific configuration or coprocessor firmware. Instead, start by provisioning an image with these early boot assets, such as the Yocto-based Qualcomm Linux images, and then flashing a debos generated image on top. Standalone, ready to flash (but probably not Debian based) images of the boot assets are planned to be made available publicly – stay tuned!
56+
57+
Depending on the target board and target boot media, it's also necessary to use the right sector size for the image: typically 512B vs 4096B. SD cards and eMMC typically use the historical 512B sector size, while UFS storage uses 4096B sector size. debos has just gained support for configurable sector sizes, but that requires building it from source; alernatively, you can post-process the image with a conversation script as explained below.
58+
59+
### RB3 Gen2 instructions
60+
61+
The RB3 Gen2 board boots from UFS by default. To flash a disk image to the UFS storage of the RB3 Gen2 board:
62+
1. provision some known good early boot assets by flashing the Yocto edition of [Qualcomm Linux](https://www.qualcomm.com/developer/software/qualcomm-linux)
63+
1. unless you've got a recent debos that supports creating images with a 4096B sector size, convert the debos disk image from 512B to 4096B sector sizes; this sample script can be used as a workaround until [debos gains support for setting the sector size](https://github.com/go-debos/debos/issues/537) but it's a britle approach which requires root, the workaround script is also full of hardcoded expectations and might need local tweaks:
64+
```bash
65+
sudo scripts/workaround-convert-sector-size disk.img disk-4096.img 4096
66+
```
67+
1. create a `rawprogram-ufs.xml` file instructing QDL to flash to the first UFS LUN (LUN0):
68+
```xml
69+
<?xml version="1.0" ?>
70+
<data>
71+
<program SECTOR_SIZE_IN_BYTES="4096" file_sector_offset="0" filename="disk-4096.img" label="image" num_partition_sectors="0" partofsingleimage="false" physical_partition_number="0" start_sector="0"/>
72+
</data>
73+
```
74+
1. put the board in "emergency download" mode (EDL) by removing any cable from the USB type-C port, and pressing the `F_DL` button while turning the power on
75+
1. connect a cable from the flashing host to the USB type-C port on the board
76+
1. run qdl to flash the image:
77+
```bash
78+
qdl prog_firehose_ddr.elf rawprogram-ufs.xml
79+
```
80+
The `prog_firehose_ddr.elf` payload is part of the the Yocto Qualcomm Linux image download.
81+
82+
## Development
83+
84+
Want to join in the development? Changes welcome! See [CONTRIBUTING.md file](CONTRIBUTING.md) for step by step instructions.
85+
86+
## Reporting Issues
87+
88+
We'd love to hear if you run into issues or have ideas for improvements. [Report an Issue on GitHub](../../issues) to discuss, and try to include as much information as possible on your specific environment.
89+
90+
## License
91+
92+
This project is licensed under the [BSD-3-clause License](https://spdx.org/licenses/BSD-3-Clause.html). See [LICENSE.txt](LICENSE.txt) for the full license text.

‎SECURITY.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
How to Report a Potential Vulnerability?
2+
========================================
3+
4+
If you would like to report a public issue (for example, one with a released
5+
CVE number), please report it as a
6+
[GitHub issue](https://github.com/qualcomm-linux/qcom-deb-images/issues/new).
7+
If you have a patch ready, submit it following the same procedure as any
8+
other patch as described in [CONTRIBUTING.md](CONTRIBUTING.md).
9+
10+
If you are dealing with a not-yet released or urgent issue, please contact us
11+
via our [Product Security team](mailto:[email protected]) or
12+
see our
13+
[Report a Bug](https://www.qualcomm.com/company/product-security/report-a-bug)
14+
page, including as many details as
15+
possible: including the version, and any example code, if available.

0 commit comments

Comments
 (0)