qmk_firmware/docs/audio_driver.md

Audio Driver :id=audio-driver

The Audio feature breaks the hardware specifics out into separate, exchangeable driver units, with a common interface to the audio-"core" - which itself handles playing songs and notes while tracking their progress in an internal state, initializing/starting/stopping the driver as needed.

Not all MCUs support every available driver, either the platform-support is not there (yet?) or the MCU simply does not have the required hardware peripheral.

AVR :id=avr

Boards built around an Atmega32U4 can use two sets of PWM capable pins, each driving a separate speaker. The possible configurations are:

	Timer3	Timer1
one speaker	C4,C5 or C6
one speaker		B4, B5 or B7
two speakers	C4,C5 or C6	B4, B5 or B7

Currently there is only one/default driver for AVR based boards, which is automatically configured to:

AUDIO_DRIVER = pwm_hardware

ARM :id=arm

For Arm based boards, QMK depends on ChibiOS - hence any MCU supported by the later is likely usable, as long as certain hardware peripherals are available.

Supported wiring configurations, with their ChibiOS/MCU peripheral requirement are listed below; piezo speakers are marked with 1️⃣ for the first/primary and 2️⃣ for the secondary.

driver	GPTD6 Tim6	GPTD7 Tim7	GPTD8 Tim8	PWMD11 Tim1_Ch1
dac_basic	A4+DACD1 = 1️⃣	A5+DACD2 = 1️⃣	state
	A4+DACD1 = 1️⃣ + Gnd	A5+DACD2 = 2️⃣ + Gnd	state
	A4+DACD1 = 2️⃣ + Gnd	A5+DACD2 = 1️⃣ + Gnd	state
	A4+DACD1 = 1️⃣ + Gnd		state
		A5+DACD2 = 1️⃣ + Gnd	state
dac_additive	A4+DACD1 = 1️⃣ + Gnd
	A5+DACD2 = 1️⃣ + Gnd
	A4+DACD1 + A5+DACD2 = 1️⃣ 2
pwm_software	state-update			any = 1️⃣
pwm hardware	state-update			A8 = 1️⃣ 3

¹: the routing and alternate functions for PWM differ sometimes between STM32 MCUs, if in doubt consult the data-sheet
²: one piezo connected to A4 and A5, with AUDIO_PIN_ALT_AS_NEGATIVE set
³: TIM1_CH1 = A8 on STM32F103C8, other combinations are possible, see Data-sheet. configured with: AUDIO_PWM_DRIVER and AUDIO_PWM_CHANNEL

DAC basic :id=dac-basic

The default driver for ARM boards, in absence of an overriding configuration. This driver needs one Timer per enabled/used DAC channel, to trigger conversion; and a third timer to trigger state updates with the audio-core.

Additionally, in the board config, you'll want to make changes to enable the DACs, GPT for Timers 6, 7 and 8:

//halconf.h:
#define HAL_USE_DAC                 TRUE
#define HAL_USE_GPT                 TRUE
#include_next <halconf.h>

// mcuconf.h:
#include_next <mcuconf.h>
#undef STM32_DAC_USE_DAC1_CH1
#define STM32_DAC_USE_DAC1_CH1              TRUE
#undef STM32_DAC_USE_DAC1_CH2
#define STM32_DAC_USE_DAC1_CH2              TRUE
#undef STM32_GPT_USE_TIM6
#define STM32_GPT_USE_TIM6                  TRUE
#undef STM32_GPT_USE_TIM7
#define STM32_GPT_USE_TIM7                  TRUE
#undef STM32_GPT_USE_TIM8
#define STM32_GPT_USE_TIM8                  TRUE

?> Note: DAC1 (A4) uses TIM6, DAC2 (A5) uses TIM7, and the audio state timer uses TIM8 (configurable).

You can also change the timer used for the overall audio state by defining the driver. For instance:

#define AUDIO_STATE_TIMER GPTD9

DAC additive :id=dac-additive

only needs one timer (GPTD6, Tim6) to trigger the DAC unit to do a conversion; the audio state updates are in turn triggered during the DAC callback.

Additionally, in the board config, you'll want to make changes to enable the DACs, GPT for Timer 6:

//halconf.h:
#define HAL_USE_DAC                 TRUE
#define HAL_USE_GPT                 TRUE
#include_next <halconf.h>

// mcuconf.h:
#include_next <mcuconf.h>
#undef STM32_DAC_USE_DAC1_CH1
#define STM32_DAC_USE_DAC1_CH1              TRUE
#undef STM32_DAC_USE_DAC1_CH2
#define STM32_DAC_USE_DAC1_CH2              TRUE
#undef STM32_GPT_USE_TIM6
#define STM32_GPT_USE_TIM6                  TRUE

DAC Config

Define	Defaults	Description
AUDIO_DAC_SAMPLE_MAX	4095U	Highest value allowed. Lower value means lower volume. And 4095U is the upper limit, since this is limited to a 12 bit value. Only effects non-pregenerated samples.
AUDIO_DAC_OFF_VALUE	AUDIO_DAC_SAMPLE_MAX / 2	The value of the DAC when not playing anything. Some setups may require a high (AUDIO_DAC_SAMPLE_MAX) or low (0) value here.
AUDIO_MAX_SIMULTANEOUS_TONES	see next table	The number of tones that can be played simultaneously. A value that is too high may freeze the controller or glitch out when too many tones are being played.
AUDIO_DAC_SAMPLE_RATE	see next table	Effective bit rate of the DAC (in hertz), higher limits simultaneous tones, and lower sacrifices quality.
AUDIO_DAC_BUFFER_SIZE	see next table	Number of samples generated every refill. Too few may cause excessive CPU load; too many may cause freezes, RAM or flash exhaustion or lags during matrix scanning.

There are a number of predefined quality settings that you can use, with "sane minimum" being the default. You can use custom values by simply defining the sample rate, number of simultaneous tones and buffer size, instead of using one of the listed presets.

Define	Sample Rate	Simultaneous tones	Buffer size
AUDIO_DAC_QUALITY_VERY_LOW	11025U	8	64U
AUDIO_DAC_QUALITY_LOW	22050U	4	128U
AUDIO_DAC_QUALITY_HIGH	44100U	2	256U
AUDIO_DAC_QUALITY_VERY_HIGH	88200U	1	256U
AUDIO_DAC_QUALITY_SANE_MINIMUM	16384U	8	64U

Notes on buffer size :id=buffer-size

By default, the buffer size attempts to keep to these constraints:

• The interval between buffer refills can't be too short, since the microcontroller would then only be servicing buffer refills and would freeze up.
• On the additive driver, the interval between buffer refills can't be too long, since matrix scanning would suffer lengthy pauses every so often, which would delay key presses or releases or lose some short taps altogether.
• The interval between buffer refills is kept to a minimum, which allows notes to stop as soon as possible after they should.
• For greater compatibility, the buffer size should be a power of 2.
• The buffer size being too large causes resource exhaustion leading to build failures or freezing at runtime: RAM usage (on the additive driver) or flash usage (on the basic driver).

You can lower the buffer size if you need a bit more space in your firmware, or raise it if your keyboard freezes up.

        /* zero crossing (or approach, whereas zero == DAC_OFF_VALUE, which can be configured to anything from 0 to DAC_SAMPLE_MAX)
         * ============================*=*========================== AUDIO_DAC_SAMPLE_MAX
         *                          *       *
         *                        *           *
         * ---------------------------------------------------------
         *                     *                 *                  } AUDIO_DAC_SAMPLE_MAX/100
         * --------------------------------------------------------- AUDIO_DAC_OFF_VALUE
         *                  *                       *               } AUDIO_DAC_SAMPLE_MAX/100
         * ---------------------------------------------------------
         *               *
         * *           *
         *   *       *
         * =====*=*================================================= 0x0
         */

PWM hardware :id=pwm-hardware

This driver uses the ChibiOS-PWM system to produce a square-wave on specific output pins that are connected to the PWM hardware. The hardware directly toggles the pin via its alternate function. See your MCU's data-sheet for which pin can be driven by what timer - looking for TIMx_CHy and the corresponding alternate function.

A configuration example for the STM32F103C8 would be:

//halconf.h:
#define HAL_USE_PWM                 TRUE
#define HAL_USE_PAL                 TRUE
#include_next <halconf.h>

// mcuconf.h:
#include_next <mcuconf.h>
#undef STM32_PWM_USE_TIM1
#define STM32_PWM_USE_TIM1                  TRUE

If we now target pin A8, looking through the data-sheet of the STM32F103C8, for the timers and alternate functions

• TIM1_CH1 = PA8 <- alternate0
• TIM1_CH2 = PA9
• TIM1_CH3 = PA10
• TIM1_CH4 = PA11

with all this information, the configuration would contain these lines:

//config.h:
#define AUDIO_PIN A8
#define AUDIO_PWM_DRIVER PWMD1
#define AUDIO_PWM_CHANNEL 1

ChibiOS uses GPIOv1 for the F103, which only knows of one alternate function. On 'larger' STM32s, GPIOv2 or GPIOv3 are used; with them it is also necessary to configure AUDIO_PWM_PAL_MODE to the correct alternate function for the selected pin, timer and timer-channel.

PWM software :id=pwm-software

This driver uses the PWM callbacks from PWMD1 with TIM1_CH1 to toggle the selected AUDIO_PIN in software. During the same callback, with AUDIO_PIN_ALT_AS_NEGATIVE set, the AUDIO_PIN_ALT is toggled inversely to AUDIO_PIN. This is useful for setups that drive a piezo from two pins (instead of one and Gnd).

You can also change the timer used for software PWM by defining the driver. For instance:

#define AUDIO_STATE_TIMER GPTD8

Testing Notes :id=testing-notes

While not an exhaustive list, the following table provides the scenarios that have been partially validated:

	DAC basic	DAC additive	PWM hardware	PWM software
Atmega32U4	⭕	⭕	✔️	⭕
RP2040	❌	❌	✔️	?
STM32F103C8 (bluepill)	❌	❌	✔️	✔️
STM32F303CCT6 (proton-c)	✔️	✔️	?	✔️
STM32F405VG	✔️	✔️	✔️	✔️
L0xx	❌ (no Tim8)	?	?	?

✔️ : works and was tested
⭕ : does not apply
❌ : not supported by MCU

Other supported ChibiOS boards and/or pins may function, it will be highly chip and configuration dependent.