xref: /freebsd/share/man/man4/snd_hdspe.4 (revision 8338ea1d3cc705f08674285a884d3aa485bf6290)
1.\" Copyright (c) 2012 Ruslan Bukin <br@bsdpad.com>
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.Dd December 30, 2023
26.Dt SND_HDSPE 4
27.Os
28.Sh NAME
29.Nm snd_hdspe
30.Nd "RME HDSPe bridge device driver"
31.Sh SYNOPSIS
32To compile this driver into the kernel, place the following lines in your
33kernel configuration file:
34.Bd -ragged -offset indent
35.Cd "device sound"
36.Cd "device snd_hdspe"
37.Ed
38.Pp
39Alternatively, to load the driver as a module at boot time, place the
40following line in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43snd_hdspe_load="YES"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48bridge driver allows the generic audio driver
49.Xr sound 4
50to attach to RME HDSPe audio devices.
51.Sh HARDWARE
52The
53.Nm
54driver supports the following audio devices:
55.Pp
56.Bl -bullet -compact
57.It
58RME HDSPe AIO
59.It
60RME HDSPe RayDAT
61.El
62.Sh SYSCTL TUNABLES
63These settings and informational values can be accessed at runtime with the
64.Xr sysctl 8
65command.
66If multiple RME HDSPe sound cards are installed, each device has a separate
67configuration.
68To adjust the following sysctl identifiers for a specific sound card, insert
69the respective device number in place of
70.Ql 0 .
71.Bl -tag -width indent
72.It Va dev.hdspe.0.clock_list
73Lists possible clock sources to sync with, depending on the hardware model.
74This includes internal and external master clocks as well as incoming digital
75audio signals like AES, S/PDIF and ADAT.
76.It Va dev.hdspe.0.clock_preference
77Select a preferred clock source from the clock list.
78HDSPe cards will sync to this clock source when available, but fall back to
79auto-sync with any other digital clock signal they receive.
80Set this to
81.Ql internal
82if the HDSPe card should act as master clock.
83.It Va dev.hdspe.0.clock_source
84Shows the actual clock source in use (read only).
85This differs from what is set as clock preference when in auto-sync mode.
86.It Va dev.hdspe.0.sync_status
87Display the current sync status of all external clock sources.
88Status indications are
89.Ql none
90for no signal at all,
91.Ql lock
92for when a valid signal is present, and
93.Ql sync
94for accurately synchronized signals (required for recording digital
95audio).
96.El
97.Pp
98Where appropriate these sysctl values are modeled after official RME software on
99other platforms, and adopt their terminology.
100Consult the RME user manuals for additional information.
101.Sh SEE ALSO
102.Xr sound 4
103.Sh HISTORY
104The
105.Nm
106device driver first appeared in
107.Fx 10.0 .
108.Sh AUTHORS
109.An -nosplit
110The
111.Nm
112driver was written by
113.An Ruslan Bukin <br@bsdpad.com> .
114