Add new mouse DPI databse for udev
[oweals/hwids.git] / README.md
1 Combined hardware identification databases
2 ==========================================
3
4 This repository contain a specially re-packaged copy of the pci.ids
5 and usb.ids files, as well as a copy of IEEE's databases for the
6 Organizationally Unique Identifiers (OUI) and Individual Address Block
7 (IAB).
8
9 The two IDs databases are maintained by Martin Mares and Michal Vaner
10 (pci.ids) and Stephen J. Gowdy (usb.ids) through the help of
11 volunteers who can submit them to the two submission web applications:
12
13  * [pci.ids](http://pci-ids.ucw.cz/)
14  * [usb.ids](https://usb-ids.gowdy.us/index.html)
15
16 The OUI and IAB databases are two officially maintained indexes by
17 IEEE, and can be accessed at:
18
19  * [OUI](http://standards.ieee.org/develop/regauth/oui/public.html)
20  * [IAB](http://standards.ieee.org/develop/regauth/iab/public.html)
21
22 The reason to repackage the files together is to make it simpler for
23 applications to require them, without having to bring in either
24 pciutils or usbutils, that might be unnecessary for most installs.
25
26 Updates
27 -------
28
29 The hwids tarball is updated generally on the weekends, and tagged if
30 there are new files available. You can download the tags in form of
31 tarballs directly from [the GitHub
32 repository](https://github.com/gentoo/hwids).
33
34 udev
35 ----
36
37 Since version 196 and later, `udev` does not consume the hwid files
38 directly. Instead, it only access a specific binary representation,
39 which is further generated starting from intermediate representations.
40
41 The Makefile will accept a `UDEV=yes` parameter to build and install
42 these representations. Furthermore upon install, the binary
43 representation will also be generated.
44
45 License
46 -------
47
48 The pci.ids and usb.ids files are both released under dual-license,
49 and you can choose which one to apply to your needs. The options are
50 either the GNU General Public License, version 2 or later (which
51 you'll find in the archive, in the file named gpl-2.0.txt), or the
52 3-clause BSD license that follows:
53
54     Redistribution and use in source and binary forms, with or without
55     modification, are permitted provided that the following conditions are met:
56         * Redistributions of source code must retain the above copyright
57           notice, this list of conditions and the following disclaimer.
58         * Redistributions in binary form must reproduce the above copyright
59           notice, this list of conditions and the following disclaimer in the
60           documentation and/or other materials provided with the distribution.
61         * Neither the name of the <organization> nor the
62           names of its contributors may be used to endorse or promote products
63           derived from this software without specific prior written permission.
64    
65     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
66     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
67     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
68     DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
69     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
70     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
71     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
72     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
73     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
74     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
75
76 The IEEE datafiles for OUI and IAB assignments are provided by the
77 IEEE without an explicit license, but are considered in all effect as
78 public domain, as they are simple representation of factual
79 information, which would then fail the threshold of originality test.