Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MODULE_PNP_INFO(9)     FreeBSD Kernel Developer's Manual    MODULE_PNP_INFO(9)

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).  Since it is built	off module marking macros, it
     must follow a DRIVER_MODULE(9) 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 ap-
     pending 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 signifi-
	  cant 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 ig-
     nored.

     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 in-
     cluded 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 ta-
       ble 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));

SEE ALSO
     devmatch(8), DRIVER_MODULE(9), module(9)

HISTORY
     The macro MODULE_PNP_INFO appeared	in FreeBSD 11.0.

AUTHORS
     The PNP framework and devmatch(8) utility were written by Warner Losh
     <imp@FreeBSD.org>.

FreeBSD	13.0			October	5, 2018			  FreeBSD 13.0

NAME | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO | HISTORY | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=MODULE_PNP_INFO&sektion=9&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help