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