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