xref: /freebsd/share/man/man9/device_set_desc.9 (revision 32eef9aeb1f39a1623cea55da147c89abbd5b9a5)
1cefd51ecSDoug Rabson.\" -*- nroff -*-
2cefd51ecSDoug Rabson.\"
3cefd51ecSDoug Rabson.\" Copyright (c) 1998 Doug Rabson
4cefd51ecSDoug Rabson.\"
5cefd51ecSDoug Rabson.\" All rights reserved.
6cefd51ecSDoug Rabson.\"
7cefd51ecSDoug Rabson.\" This program is free software.
8cefd51ecSDoug Rabson.\"
9cefd51ecSDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10cefd51ecSDoug Rabson.\" modification, are permitted provided that the following conditions
11cefd51ecSDoug Rabson.\" are met:
12cefd51ecSDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13cefd51ecSDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14cefd51ecSDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15cefd51ecSDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16cefd51ecSDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17cefd51ecSDoug Rabson.\"
18cefd51ecSDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19cefd51ecSDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20cefd51ecSDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21cefd51ecSDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22cefd51ecSDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23cefd51ecSDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24cefd51ecSDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25cefd51ecSDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26cefd51ecSDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27cefd51ecSDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28cefd51ecSDoug Rabson.\"
297f3dea24SPeter Wemm.\" $FreeBSD$
30cefd51ecSDoug Rabson.\"
31cefd51ecSDoug Rabson.Dd June 16, 1998
32def37e7cSMike Pritchard.Dt DEVICE_SET_DESC 9
333d45e180SRuslan Ermilov.Os
34cefd51ecSDoug Rabson.Sh NAME
35cefd51ecSDoug Rabson.Nm device_set_desc ,
36b99b8460SDoug Rabson.Nm device_set_desc_copy ,
37cefd51ecSDoug Rabson.Nm device_get_desc
38cefd51ecSDoug Rabson.Nd access the description of a device
39cefd51ecSDoug Rabson.Sh SYNOPSIS
4032eef9aeSRuslan Ermilov.In sys/param.h
4132eef9aeSRuslan Ermilov.In sys/bus.h
42cefd51ecSDoug Rabson.Ft void
43cefd51ecSDoug Rabson.Fn device_set_desc "device_t dev" "const char *desc"
44b99b8460SDoug Rabson.Ft void
45b99b8460SDoug Rabson.Fn device_set_desc_copy "device_t dev" "const char *desc"
46cefd51ecSDoug Rabson.Ft const char *
47cefd51ecSDoug Rabson.Fn device_get_desc "device_t dev"
48cefd51ecSDoug Rabson.Sh DESCRIPTION
49cefd51ecSDoug RabsonManipulate the verbose description of a device.  This description (if
50cefd51ecSDoug Rabsonpresent) is printed as part of the message when it is attached during
511111b49cSSheldon Hearnautoconfiguration.
521111b49cSSheldon HearnThe variation
53b99b8460SDoug Rabson.Xr device_set_desc_copy 9
54b99b8460SDoug Rabsonis used to set the description if the string passed is a temporary
551111b49cSSheldon Hearnbuffer which will be overwritten.
561111b49cSSheldon HearnIn this case, the system will copy
57b99b8460SDoug Rabsonthe string, otherwise the pointer passed will be used directly.
58cefd51ecSDoug Rabson.Sh SEE ALSO
59cefd51ecSDoug Rabson.Xr device 9
60cefd51ecSDoug Rabson.Sh AUTHORS
61cefd51ecSDoug RabsonThis man page was written by
62cefd51ecSDoug Rabson.An Doug Rabson .
63