xref: /freebsd/share/man/man4/man4.i386/vpd.4 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" Copyright (c) 2003 Matthew N. Dodd <winter@jurai.net>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
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.
12.\"
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
23.\" SUCH DAMAGE.
24.\"
25.Dd August 31, 2004
26.Dt VPD 4 i386
27.Os
28.Sh NAME
29.Nm vpd
30.Nd "Vital Product Data kernel interface"
31.Sh SYNOPSIS
32.Cd "device vpd"
33.Sh DESCRIPTION
34.Tn IBM ThinkPad
35notebooks (and most
36.Tn IBM
37desktop PCs) have a 48-byte
38Vital Product Data (VPD) structure located in the BIOS Shadow RAM.
39.Pp
40The VPD provides machine type and model information, the build ID
41(this is roughly the BIOS version) and serial number information.
42.Pp
43The
44.Nm
45driver scans the BIOS area and claims the memory used by the VPD
46structure.
47It provides the
48.Xr sysctl 3
49branch
50.Va hw.vpd
51to allow this information to be accessed by the userland.
52The following variables are provided, one per VPD attachment (there should
53only be one):
54.Pp
55.Bl -tag -width ".Dv MACHINE_MODEL" -compact
56.It Dv MACHINE_TYPE
57.Pq Va machine.type
58Machine type.
59.It Dv MACHINE_MODEL
60.Pq Va machine.model
61Machine model.
62.It Dv BUILD_ID
63.Pq Va build.id
64BIOS Build ID.
65.It Dv SERIAL_BOX
66.Pq Va serial.box
67Box Serial Number.
68.It Dv SERIAL_PLANAR
69.Pq Va serial.planar
70Motherboard Serial Number.
71.El
72.Sh SEE ALSO
73.Rs
74.%T "TP General - Using the BIOS Build ID to identify IBM ThinkPad systems"
75.%N "Reference #: MIGR-45120"
76.%D "November 22, 2002"
77.%U "http://www.ibm.com/support/docview.wss?uid=psg1MIGR-45120"
78.Re
79.Sh HISTORY
80The
81.Nm
82driver first appeared in
83.Fx 5.1 .
84.Sh AUTHORS
85The
86.Nm
87driver and this manual page were written by
88.An Matthew N. Dodd Aq Mt mdodd@FreeBSD.org .
89