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 January 19, 2024 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.Pp 63By default, each 64.Xr pcm 4 65device corresponds to a physical port on the sound card. 66For ADAT ports, 8 channel, 4 channel and 2 channel formats are supported. 67Depending on sample rate and channel format selected, not all pcm channels can 68be mapped to ADAT channels and vice versa. 69.Sh SYSCTL TUNABLES 70These settings and informational values can be accessed at runtime with the 71.Xr sysctl 8 72command. 73If multiple RME HDSPe sound cards are installed, each device has a separate 74configuration. 75To adjust the following sysctl identifiers for a specific sound card, insert 76the respective device number in place of 77.Ql 0 . 78.Bl -tag -width indent 79.It Va dev.hdspe.0.period 80The number of samples processed per interrupt, from 32, 64, 128, up to 4096. 81Setting a lower value here results in less latency, but increases system load 82due to frequent interrupt processing. 83Extreme values may cause audio gaps and glitches. 84.It Va dev.hdspe.0.clock_list 85Lists possible clock sources to sync with, depending on the hardware model. 86This includes internal and external master clocks as well as incoming digital 87audio signals like AES, S/PDIF and ADAT. 88.It Va dev.hdspe.0.clock_preference 89Select a preferred clock source from the clock list. 90HDSPe cards will sync to this clock source when available, but fall back to 91auto-sync with any other digital clock signal they receive. 92Set this to 93.Ql internal 94if the HDSPe card should act as master clock. 95.It Va dev.hdspe.0.clock_source 96Shows the actual clock source in use (read only). 97This differs from what is set as clock preference when in auto-sync mode. 98.It Va dev.hdspe.0.sync_status 99Display the current sync status of all external clock sources. 100Status indications are 101.Ql none 102for no signal at all, 103.Ql lock 104for when a valid signal is present, and 105.Ql sync 106for accurately synchronized signals (required for recording digital 107audio). 108.El 109.Pp 110Where appropriate these sysctl values are modeled after official RME software on 111other platforms, and adopt their terminology. 112Consult the RME user manuals for additional information. 113.Sh SEE ALSO 114.Xr sound 4 115.Sh HISTORY 116The 117.Nm 118device driver first appeared in 119.Fx 10.0 . 120.Sh AUTHORS 121.An -nosplit 122The 123.Nm 124driver was written by 125.An Ruslan Bukin <br@bsdpad.com> . 126.An Florian Walpen <dev@submerge.ch> 127contributed clock source settings and restructured the pcm device mapping. 128