Update docs and such for 1st Gen and big 4th Gen support

This commit is contained in:
Geoffrey D. Bennett
2025-02-21 03:40:55 +10:30
parent ab40037064
commit 5106ed228e
23 changed files with 538 additions and 113 deletions

92
FAQ.md
View File

@@ -1,37 +1,40 @@
# FAQ for the Scarlett2 Mixer Driver and `alsa-scarlett-gui`
# FAQ for the ALSA Scarlett Control Panel (`alsa-scarlett-gui`)
## What is this?
The Scarlett2 Protocol Driver (also known as the Scarlett2 Mixer
Driver) is a part of the Linux kernel, enhancing the ALSA kernel
driver with additional controls for Focusrite Scarlett, Clarett, and
Vocaster interfaces.
The ALSA Scarlett Control Panel (`alsa-scarlett-gui`) is an
easy-to-use application for adjusting the ALSA controls provided by
three Linux kernel drivers for Focusrite USB interfaces:
1. The Scarlett 1st Gen Mixer Driver (for 1st Gen 6i6, 8i6, 18i6, 18i8, 18i20)
2. The Scarlett2 Protocol Driver (for 2nd/3rd Gen interfaces, small 4th Gen, Clarett, and Vocaster)
3. The FCP (Focusrite Control Protocol) Driver (for big 4th Gen interfaces: 16i16, 18i16, 18i20)
To check if your kernel is already up-to-date, and how to upgrade if
not, see the [Control Panel Installation Prerequisites — Linux
Kernel](docs/INSTALL.md).
`alsa-scarlett-gui` is an easy-to-use application to adjust those
controls.
## Do I need these drivers for my Focusrite interface?
## Do I need the driver for my Focusrite interface?
In order to get audio working? No. Focusrite USB interfaces are
For basic audio functionality? No. Focusrite USB interfaces are
“plug-and-play” — they are USB Audio Class Compliant, meaning they
work out-of-the-box with the standard ALSA USB audio driver (to get
full functionality on Scarlett 3rd/4th Gen/Vocaster interfaces, first
deactivate MSD mode by holding down the 48V button while powering it
on).
However, to access the mixer, routing, and hardware-specific features,
you'll need the appropriate driver for your interface model.
## MSD Mode?
MSD Mode is the Mass Storage Device Mode that the Scarlett 3rd and
"MSD Mode" is the "Mass Storage Device Mode" that the Scarlett 3rd and
4th Gen interfaces ship in.
If MSD Mode is enabled, you need to disable it and restart your
interface to get access to its full functionality.
When you plug the interface in, therell be a tiny read-only virtual
When you plug the interface in, there'll be a tiny read-only virtual
disk that has a link to the Focusrite product registration page; until
you turn off MSD Mode not all features of the interface will be
available.
@@ -40,49 +43,62 @@ You can turn off MSD Mode by holding down the 48V button while
powering on the interface, or by clicking the button in
`alsa-scarlett-gui` and rebooting it.
## What is the purpose of the driver if its not needed for audio?
If you do the recommended/required (depending on the model) firmware
update, MSD Mode will automatically be turned off.
This driver is for users who want more control over their interface.
It allows for detailed manipulation of internal audio routing and
settings specific to Scarlett, Clarett, and Vocaster devices, beyond
the basic audio I/O functionality. Also, being able to monitor the
audio levels seen by the interface is really useful.
## What is the purpose of these drivers if they're not needed for basic audio?
These drivers are for users who want more control over their
interface. They allow for detailed manipulation of:
- Internal audio routing
- Hardware-specific settings
- Mixer functionality
- Level monitoring
- Input/output configuration
These controls go beyond the basic audio I/O functionality provided by
the generic ALSA USB audio driver.
## What interfaces are supported?
- All Scarlett 2nd Gen interfaces with software controls (there are no
software controls on the 2nd Gen Solo and 2i2, so the mixer driver
is irrelevant).
The ALSA Scarlett Control Panel supports:
- All Scarlett 3rd Gen interfaces.
- **Scarlett 1st Gen**: 6i6, 8i6, 18i6, 18i8, 18i20
- **Scarlett 2nd Gen**: 6i6, 18i8, 18i20
- **Scarlett 3rd Gen**: Solo, 2i2, 4i4, 8i6, 18i8, 18i20
- **Scarlett 4th Gen**: Solo, 2i2, 4i4, 16i16, 18i16, 18i20
- **Clarett USB and Clarett+**: 2Pre, 4Pre, 8Pre
- **Vocaster**: One, Two
- Scarlett 4th Gen Solo, 2i2, and 4i4.
- All Clarett USB and Clarett+ interfaces.
- Vocaster One and Vocaster Two.
Note: The Scarlett 1st and 2nd Gen small interfaces (Solo, 2i2, 2i4)
don't have any software controls. All the controls are available from
the front panel, so they don't require the specialised drivers or this
GUI.
## Where are the options to set the sample rate and buffer size?
Its important to note that the Scarlett2 driver and
`alsa-scarlett-gui` have nothing to do with audio input/output to and
from the device. This task is managed by the generic part of the ALSA
USB soundcard driver.
The ALSA Scarlett Control Panel doesn't handle audio input/output
settings like sample rate and buffer size. These settings are managed
by the application using the soundcard, typically a sound server such
as PulseAudio, JACK, or PipeWire.
Audio settings like the sample rate and buffer size are chosen by the
application which is using the soundcard. In most cases, that is a
sound server such as PulseAudio, JACK, or PipeWire.
The sample rate shown in the control panel is informative only and
displays the current rate being used by applications. If it shows
“N/A” then no application is using the interface.
Note that not all features are available at higher sample rates; refer
to the user manual of your interface for more information.
## Help?!
For help with the driver:
https://github.com/geoffreybennett/scarlett-gen2/issues
For help with the Scarlett2 and FCP kernel drivers:
https://github.com/geoffreybennett/linux-fcp/issues
For help with the FCP user-space side:
https://github.com/geoffreybennett/fcp-support/issues
For help with `alsa-scarlett-gui`:
https://github.com/geoffreybennett/alsa-scarlett-gui/issues
For general Linux audio help:
https://linuxmusicians.com
For general Linux audio help: https://linuxmusicians.com