xref: /freebsd/share/man/man9/device_set_desc.9 (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
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.Dd January 9, 2024
30.Dt DEVICE_SET_DESC 9
31.Os
32.Sh NAME
33.Nm device_set_desc ,
34.Nm device_set_descf ,
35.Nm device_set_desc_copy ,
36.Nm device_get_desc
37.Nd access the description of a device
38.Sh SYNOPSIS
39.In sys/param.h
40.In sys/bus.h
41.Ft void
42.Fn device_set_desc "device_t dev" "const char *desc"
43.Ft void
44.Fn device_set_descf "device_t dev" "const char *fmt" "..."
45.Ft void
46.Fn device_set_desc_copy "device_t dev" "const char *desc"
47.Ft const char *
48.Fn device_get_desc "device_t dev"
49.Sh DESCRIPTION
50Manipulate the verbose description of a device.
51This description (if
52present) is printed as part of the message when it is attached during
53autoconfiguration.
54The variation
55.Fn device_set_desc_copy
56is used to set the description if the string passed is a temporary
57buffer which will be overwritten.
58In this case, the system will copy
59the string, otherwise the pointer passed will be used directly.
60.Fn device_set_descf
61is a printf-like version of
62.Fn device_set_desc .
63.Sh SEE ALSO
64.Xr device 9
65.Sh AUTHORS
66This manual page was written by
67.An Doug Rabson .
68