---
name: "MODULE_PNP_INFO"
section: "9"
platform: "freebsd"
package: "base"
version: "16.0-CURRENT-20261027-61c70dc16a79"
release: "FreeBSD 16.0-CURRENT (2026-10-27)"
platforms: ["freebsd"]
url: "https://new.carta.tech/MODULE_PNP_INFO"
---

# MODULE\_PNP\_INFO(9)

register plug and play information for device matching

## NAME

**MODULE\_PNP\_INFO** – register plug and play information for device matching

## SYNOPSIS

**#include \<sys/module.h\>**

**MODULE\_PNP\_INFO**(*const char \*descriptor\_string*, *bus*, *module*, *void \*table*, *size\_t num\_entries*);

## DESCRIPTION

The **MODULE\_PNP\_INFO**() macro registers a *table* of device-identifying data for use by [devmatch(8)](/devmatch/8.md). Since it is built off module marking macros, it must follow a [DRIVER\_MODULE(9)](/DRIVER_MODULE/9.md) line.

The macro takes a *descriptor\_string* that describes the memory layout of table entries. The string is a series of members separated by semi-colons. Members are identified by a type and a name. They are encoded in the descriptor string by concatenating the type with a colon, followed by the name. (The special type *W32* represents two members. The first name is encoded like any other type. The second name is encoded by appending a forward slash and the second name after the first.)

Types are one of the following:

- “*U8*”

  *uint8\_t* element.

- “*V8*”

  Same as *U8*, except that the sentinel value 0xFF matches any.

- “*G16*”

  *uint16\_t* element; any value greater than or equal matches.

- “*L16*”

  *uint16\_t* element; any value less than or equal matches.

- “*M16*”

  *uint16\_t* element; mask of which of the following fields to use.

- “*U16*”

  *uint16\_t* element.

- “*V16*”

  Same as *U16*, except that the sentinel value 0xFFFF matches any.

- “*U32*”

  *uint32\_t* element.

- “*V32*”

  Same as *U32*, except that the sentinel value 0xFFFFFFFF matches any.

- “*W32*”

  Two *uint16\_t* values; the first named member is in the least significant word and the second named member is in the most significant word.

- “*Z*”

  A pointer to a string to match exactly.

- “*D*”

  A pointer to a human readable description for the device.

- “*P*”

  A pointer that should be ignored.

- “*E*”

  EISA PNP Identifier.

- “*T*”

  PNP info that is true for the whole table. The driver code checks for these condition pragmatically before using this table to match devices. This item must come last in the list.

The pseudo-name “#” is reserved for fields that should be ignored. Any member that does not match the parent device's pnpinfo output must be ignored.

The *bus* parameter is an unquoted word naming the parent bus of the driver. For example, “pci”.

The *module* parameter is also an unquoted word. It must be unique to the driver. Usually the driver's name is used.

The *table* parameter points to the device matching data with entries matching the *descriptor\_string*.

The *num\_entries* parameter is the number of entries in the table, i.e., ‘nitems(table)’. Note that only valid entries should be included. If the table contains trailing zero or bogus values, they should not be included in *num\_entries*.

## EXAMPLES

- **Example** **1:** Using W32 for vendor/device pair

  The following example shows usage of *W32* type when vendor/device values are combined into single *uint32\_t* value:

  ```
  #include <sys/param.h>
  #include <sys/module.h>
  static struct my_pciids {
  	uint32_t devid;
  	const char *desc;
  } my_ids[] = {
  	{ 0x12345678, "Foo bar" },
  	{ 0x9abcdef0, "Baz fizz" },
  };
  MODULE_PNP_INFO("W32:vendor/device;D:#", pci, my_driver, my_ids,
      nitems(my_ids));
  ```

- **Example** **2:** Using T for common vendor value

  The following example shows usage of *T* type when all entries in the table have the same vendor value:

  ```
  #include <sys/param.h>
  #include <sys/module.h>
  static struct my_pciids {
  	uint16_t device;
  	const char *desc;
  } my_ids[] = {
  	{ 0x9abc, "Foo bar" },
  	{ 0xdef0, "Baz fizz" },
  };
  MODULE_PNP_INFO("U16:device;D:#;T:vendor=0x1234", pci, my_driver,
      my_ids, nitems(my_ids));
  ```

## BUGS

The **MODULE\_PNP\_INFO** macro must follow DRIVER\_MODULE invocations due to limitations in the linker.hints file format.

## SEE ALSO

[devmatch(8)](/devmatch/8.md), [DRIVER\_MODULE(9)](/DRIVER_MODULE/9.md), [module(9)](/module/9.md)

## HISTORY

The macro **MODULE\_PNP\_INFO** appeared in FreeBSD 11.0.

## AUTHORS

The PNP framework and [devmatch(8)](/devmatch/8.md) utility were written by Warner Losh ⟨*imp@FreeBSD.org*⟩.