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