Driver API for WM8990 codec chip. More...

#include <Driver.h>

Inheritance diagram for AudioDriverWM8960Class:

Public Member Functions
	AudioDriverWM8960Class ()

bool	begin (CodecConfig codecCfg, DriverPins &pins)
	Starts the processing. More...

void	dumpRegisters ()

bool	end (void)
	Ends the processing: shut down dac and adc. More...

virtual int	getI2CAddress ()
	Provides the i2c address. More...

int	getVolume ()
	Determines the actual volume (range: 0-100) More...

bool	isInputVolumeSupported ()
	Determines if setInputVolume() is supported. More...

bool	isVolumeSupported ()
	Determines if setVolume() is suppored. More...

	operator bool ()

virtual DriverPins &	pins ()
	Provides the pin information. More...

virtual bool	setConfig (CodecConfig codecCfg)
	changes the configuration More...

void	setEnablePLL (bool active)
	Configuration: enable/disable PLL (active by default) More...

virtual bool	setI2CAddress (uint16_t adr)
	Defines the i2c address. More...

void	setI2CRetryCount (int cnt)
	Configuration: define retry count (default : 0) More...

bool	setInputVolume (int volume)
	Defines the input volume (range: 0-100) if supported. More...

void	setMclkHz (uint32_t hz)
	Configuration: define master clock frequency (default: 0) More...

bool	setMute (bool enable)
	Mutes all output lines. More...

virtual bool	setMute (bool mute, int line)
	Mute individual lines: only supported for some rare DACs. More...

bool	setPAPower (bool enable)
	Sets the PA Power pin to active or inactive. More...

void	setPins (DriverPins &pins)

void	setupI2CAddress ()
	If no address is defined in the pins we provide it here. More...

bool	setVolume (int volume)
	Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100. More...

Protected Member Functions
virtual bool	configInterface (codec_mode_t mode, I2SDefinition iface)

bool	configure_clocking ()

virtual bool	controlState (codec_mode_t mode)

virtual bool	deinit ()

int	getFeatures (CodecConfig cfg)

virtual i2c_bus_handle_t	getI2C ()
	Determine the TwoWire object from the I2C config or use Wire. More...

virtual bool	init (codec_config_t codec_cfg)

int	limitValue (int volume, int min=0, int max=100)

int	mapVolume (int x, int in_min, int in_max, int out_min, int out_max)

mtb_wm8960_mode_t	modeMasterSlave (bool is_master)
	if microcontroller is master then module is slave More...

mtb_wm8960_adc_dac_sample_rate_t	sampleRate (int rate)

mtb_wm8960_word_length_t	wordLength (int bits)

Protected Attributes
CodecConfig	codec_cfg

int	i2c_default_address = -1

int	i2c_retry_count = 0

DriverPins *	p_pins = nullptr

int	volume_in = 100

int	volume_out = 100

bool	vs1053_enable_pll = true

uint32_t	vs1053_mclk_hz = 0

Detailed Description

Driver API for WM8990 codec chip.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioDriverWM8960Class()

AudioDriverWM8960Class ( )

inline

Member Function Documentation

◆ begin()

bool begin	(	CodecConfig	codecCfg,
		DriverPins &	pins
	)

inlinevirtual

Starts the processing.

Reimplemented from AudioDriver.

◆ configInterface()

virtual bool configInterface	(	codec_mode_t	mode,
		I2SDefinition	iface
	)

inlineprotectedvirtualinherited

Reimplemented in AudioDriverPCM3168Class, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, and AudioDriverAC101Class.

◆ configure_clocking()

bool configure_clocking ( )

inlineprotected

◆ controlState()

virtual bool controlState ( codec_mode_t mode )

inlineprotectedvirtualinherited

Reimplemented in AudioDriverPCM3168Class, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, and AudioDriverAC101Class.

◆ deinit()

virtual bool deinit ( )

inlineprotectedvirtualinherited

Reimplemented in AudioDriverPCM3168Class, AudioDriverWM8994Class, AudioDriverTAS5805MClass, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, AudioDriverCS43l22Class, and AudioDriverAC101Class.

◆ dumpRegisters()

void dumpRegisters ( )

inline

◆ end()

bool end ( void )

inlinevirtual

Ends the processing: shut down dac and adc.

Reimplemented from AudioDriver.

◆ getFeatures()

int getFeatures ( CodecConfig cfg )

inlineprotected

◆ getI2C()

virtual i2c_bus_handle_t getI2C ( )

inlineprotectedvirtualinherited

Determine the TwoWire object from the I2C config or use Wire.

◆ getI2CAddress()

virtual int getI2CAddress ( )

inlinevirtualinherited

Provides the i2c address.

◆ getVolume()

int getVolume ( )

inlinevirtual

Determines the actual volume (range: 0-100)

Implements AudioDriver.

◆ init()

virtual bool init ( codec_config_t codec_cfg )

inlineprotectedvirtualinherited

Reimplemented in AudioDriverPCM3168Class, AudioDriverTAS5805MClass, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, and AudioDriverAC101Class.

◆ isInputVolumeSupported()

bool isInputVolumeSupported ( )

inlinevirtual

Determines if setInputVolume() is supported.

Reimplemented from AudioDriver.

◆ isVolumeSupported()

bool isVolumeSupported ( )

inlinevirtual

Determines if setVolume() is suppored.

Reimplemented from AudioDriver.

◆ limitValue()

int limitValue	(	int	volume,
		int	min = `0`,
		int	max = `100`
	)

inlineprotectedinherited

make sure that value is in range

Parameters

volume

Returns

◆ mapVolume()

int mapVolume	(	int	x,
		int	in_min,
		int	in_max,
		int	out_min,
		int	out_max
	)

inlineprotectedinherited

◆ modeMasterSlave()

mtb_wm8960_mode_t modeMasterSlave ( bool is_master )

inlineprotected

if microcontroller is master then module is slave

◆ operator bool()

operator bool ( )

inlineinherited

◆ pins()

virtual DriverPins& pins ( )

inlinevirtualinherited

Provides the pin information.

Reimplemented in AudioDriverCS42448Class.

◆ sampleRate()

mtb_wm8960_adc_dac_sample_rate_t sampleRate ( int rate )

inlineprotected

◆ setConfig()

virtual bool setConfig ( CodecConfig codecCfg )

inlinevirtual

changes the configuration

Reimplemented from AudioDriver.

◆ setEnablePLL()

void setEnablePLL ( bool active )

inline

Configuration: enable/disable PLL (active by default)

◆ setI2CAddress()

virtual bool setI2CAddress ( uint16_t adr )

inlinevirtualinherited

Defines the i2c address.

◆ setI2CRetryCount()

void setI2CRetryCount ( int cnt )

inline

Configuration: define retry count (default : 0)

◆ setInputVolume()

bool setInputVolume ( int volume )

inlinevirtual

Defines the input volume (range: 0-100) if supported.

Reimplemented from AudioDriver.

◆ setMclkHz()

void setMclkHz ( uint32_t hz )

inline

Configuration: define master clock frequency (default: 0)

◆ setMute() [1/2]

bool setMute ( bool enable )

inlinevirtual

Mutes all output lines.

Implements AudioDriver.

◆ setMute() [2/2]

virtual bool setMute	(	bool	mute,
		int	line
	)

inlinevirtualinherited

Mute individual lines: only supported for some rare DACs.

Reimplemented in AudioDriverWM8978Class, AudioDriverPCM3168Class, AudioDriverES8388Class, and AudioDriverCS42448Class.

◆ setPAPower()

bool setPAPower ( bool enable )

inlineinherited

Sets the PA Power pin to active or inactive.

◆ setPins()

void setPins ( DriverPins & pins )

inlineinherited

◆ setupI2CAddress()

void setupI2CAddress ( )

inlineinherited

If no address is defined in the pins we provide it here.

◆ setVolume()

bool setVolume ( int volume )

inlinevirtual

Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100.

Implements AudioDriver.

◆ wordLength()

mtb_wm8960_word_length_t wordLength ( int bits )

inlineprotected

Member Data Documentation

◆ codec_cfg

CodecConfig codec_cfg

protectedinherited

◆ i2c_default_address

int i2c_default_address = -1

protectedinherited

◆ i2c_retry_count

int i2c_retry_count = 0

protected

◆ p_pins

DriverPins* p_pins = nullptr

protectedinherited

◆ volume_in

int volume_in = 100

protected

◆ volume_out

int volume_out = 100

protected

◆ vs1053_enable_pll

bool vs1053_enable_pll = true

protected

◆ vs1053_mclk_hz

uint32_t vs1053_mclk_hz = 0

protected

The documentation for this class was generated from the following file:

src/Driver.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioDriverWM8960Class()

Member Function Documentation

◆ begin()

◆ configInterface()

◆ configure_clocking()

◆ controlState()

◆ deinit()

◆ dumpRegisters()

◆ end()

◆ getFeatures()

◆ getI2C()

◆ getI2CAddress()

◆ getVolume()

◆ init()

◆ isInputVolumeSupported()

◆ isVolumeSupported()

◆ limitValue()

◆ mapVolume()

◆ modeMasterSlave()

◆ operator bool()

◆ pins()

◆ sampleRate()

◆ setConfig()

◆ setEnablePLL()

◆ setI2CAddress()

◆ setI2CRetryCount()

◆ setInputVolume()

◆ setMclkHz()

◆ setMute() [1/2]

◆ setMute() [2/2]

◆ setPAPower()

◆ setPins()

◆ setupI2CAddress()

◆ setVolume()

◆ wordLength()

Member Data Documentation

◆ codec_cfg

◆ i2c_default_address

◆ i2c_retry_count

◆ p_pins

◆ volume_in

◆ volume_out

◆ vs1053_enable_pll

◆ vs1053_mclk_hz