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