1 .\" Copyright (c) 2018 Conrad Meyer <cem@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd register plug and play information for device matching
37 .Fa "const char *descriptor_string"
41 .Fa "size_t entry_len"
42 .Fa "size_t num_entries"
50 of device-identifying data for use by
52 Since it is built off module marking macros, it must follow a
58 that describes the memory layout of table entries.
59 The string is a series of members separated by semi-colons.
60 Members are identified by a type and a name.
61 They are encoded in the descriptor string by concatenating the type with a
62 colon, followed by the name.
65 represents two members.
66 The first name is encoded like any other type.
67 The second name is encoded by appending a forward slash and the second
68 name after the first.)
70 Types are one of the following:
78 except that the sentinel value 0xFF matches any.
81 element; any value greater than or equal matches.
84 element; any value less than or equal matches.
87 element; mask of which of the following fields to use.
94 except that the sentinel value 0xFFFF matches any.
101 except that the sentinel value 0xFFFFFFFF matches any.
105 values; the first named member is in the least significant word and the second
106 named member is in the most significant word.
108 A pointer to a string to match exactly.
110 A pointer to a human readable description for the device.
112 A pointer that should be ignored.
116 PNP info that's true for the for the whole table.
117 The driver code checks for these condition pragmatically before using
118 this table to match devices.
119 This item must come last in the list.
124 is reserved for fields that should be ignored.
125 Any member that does not match the parent device's pnpinfo output must be
130 parameter is an unquoted word naming the parent bus of the driver.
136 parameter is also an unquoted word.
137 It must be unique to the driver.
138 Usually the driver's name is used.
142 parameter points to the device matching data with entries matching the
143 .Fa descriptor_string .
147 parameter is the size of each table entry, i.e.,
148 .Ql sizeof(table[0]) .
152 parameter is the number of entries in the table, i.e.,
154 Note that only valid entries should be included.
155 If the table contains trailing zero or bogus values, they should not be
160 .Bd -literal -offset indent -compact
161 #include <sys/param.h>
162 #include <sys/module.h>
163 static struct my_pciids {
167 { 0x12345678, "Foo bar" },
168 { 0x9abcdef0, "Baz fizz" },
171 MODULE_PNP_INFO("W32:vendor/device", pci, my_driver, my_ids, sizeof(my_ids[0]),
177 .Xr DRIVER_MODULE 9 ,
185 The PNP framework and
187 utility were written by
188 .An Warner Losh Aq Mt imp@FreeBSD.org .