]> git.proxmox.com Git - mirror_linux-firmware.git/blame - README.md
qca: add bluetooth firmware for WCN3988
[mirror_linux-firmware.git] / README.md
CommitLineData
408eb34a
ML
1
2# Linux firmware
3
4This repository contains all these firmware images which have been
5extracted from older drivers, as well various new firmware images which
6we were never permitted to include in a GPL'd work, but which we _have_
7been permitted to redistribute under separate cover.
8
9The upstream repository is located at <https://gitlab.com/kernel-firmware/linux-firmware.git>.
10
11## Submitting firmware
12
13To submit firmware to this repository, please do one of the following:
14
15* open a MR [upstream](https://gitlab.com/kernel-firmware/linux-firmware)
16* send a git binary diff to `linux-firmware@kernel.org`
17* send a git pull request to: `linux-firmware@kernel.org`
18
19## Quality
20
21If your commit adds new firmware, it must update the `WHENCE` file to
22clearly state the license under which the firmware is available, and
23that it is redistributable. Being redistributable includes ensuring
24the firmware license provided includes an implicit or explicit
25patent grant to end users to ensure full functionality of device
26operation with the firmware. If the license is long and involved, it's
27permitted to include it in a separate file and refer to it from the
28`WHENCE` file (IE _'See `LICENSE.foo` for details.'_).
29And if it were possible, a changelog of the firmware itself.
30
31To maintain consistent quality on the repository, please run the following
32before submitting a patch:
33
34```shell
35make check
36```
37
38If you don't have pre-commit installed, you can install it with:
39
40```shell
41pip install pre-commit
42```
43
44Your commit **must** contain a `Signed-Off-By:` from someone authoritative on
45the licensing of the firmware in question (i.e. from within the company
46that owns the code).
47
48## Warnings
49
501. Don't send any `CONFIDENTIALITY STATEMENT` in your e-mail, patch or
51request. Otherwise your firmware _will never be accepted_.
522. Maintainers are really busy, so don't expect a prompt reply.