VSF Documented
vsf_es8389.c File Reference

Data Structures

struct  vk_es8389_coeff_t
 

Macros

#define __VSF_AUDIO_CLASS_INHERIT__
 
#define __VSF_AUDIO_I2S_CLASS_INHERIT__
 
#define __VSF_EDA_CLASS_INHERIT__
 
#define __VSF_ES8389_CLASS_IMPLEMENT
 
#define ES8389_REG_RESET   0x00
 
#define ES8389_REG_MISC   0x01
 
#define ES8389_REG_CLK_STATE   0x02
 
#define ES8389_REG_CLK_SYS_DIV   0x03
 
#define ES8389_REG_CLK_PLL1   0x04
 
#define ES8389_REG_CLK_PLL2   0x05
 
#define ES8389_REG_CLK_PLL3   0x06
 
#define ES8389_REG_CLK_PLL4   0x07
 
#define ES8389_REG_CLK_PLL5   0x08
 
#define ES8389_REG_CLK_PLL6   0x09
 
#define ES8389_REG_CLK_DIV_L   0x0A
 
#define ES8389_REG_CLK_DIV_M   0x0B
 
#define ES8389_REG_FMT_DACADC   0x0C
 
#define ES8389_REG_CLK_ADC   0x0F
 
#define ES8389_REG_CLK_DAC   0x10
 
#define ES8389_REG_CLK_ADCDIV1   0x11
 
#define ES8389_REG_CLK_DACDIV1   0x12
 
#define ES8389_REG_CLK_DACDIV2   0x13
 
#define ES8389_REG_CLK_ADCDIV3   0x14
 
#define ES8389_REG_CLK_ADCDIV4   0x15
 
#define ES8389_REG_ADC_MCLK   0x16
 
#define ES8389_REG_ADC_DIV_L   0x17
 
#define ES8389_REG_ADC_DIV_M   0x18
 
#define ES8389_REG_ADC_DIV_H   0x19
 
#define ES8389_REG_ADC_DACLRC   0x1A
 
#define ES8389_REG_DAC_DACLRC   0x1B
 
#define ES8389_REG_ADC_SP   0x20
 
#define ES8389_REG_ADC_ALC1   0x21
 
#define ES8389_REG_ADC_ALC2   0x22
 
#define ES8389_REG_ADC_ALC3   0x23
 
#define ES8389_REG_ADC_NG   0x24
 
#define ES8389_REG_ADC_DRC   0x25
 
#define ES8389_REG_ADC_DRC_VOL1   0x26
 
#define ES8389_REG_ADC_DRC_VOL2   0x27
 
#define ES8389_REG_ADC_DRC_VOL3   0x28
 
#define ES8389_REG_ADC_ALC4   0x2A
 
#define ES8389_REG_DAC_CTRL   0x30
 
#define ES8389_REG_DAC_SP   0x40
 
#define ES8389_REG_DAC_FILTER   0x41
 
#define ES8389_REG_DAC_VOL_MIX   0x42
 
#define ES8389_REG_DAC_VOL_L   0x46
 
#define ES8389_REG_DAC_VOL_R   0x47
 
#define ES8389_REG_DAC_VOL_MIXC   0x48
 
#define ES8389_REG_DAC_CLKFREE   0x4D
 
#define ES8389_REG_VMID   0x60
 
#define ES8389_REG_ANA1   0x61
 
#define ES8389_REG_ANA2   0x62
 
#define ES8389_REG_ANA3   0x63
 
#define ES8389_REG_ANA4   0x64
 
#define ES8389_REG_ANA5   0x69
 
#define ES8389_REG_PGA_L   0x72
 
#define ES8389_REG_PGA_R   0x73
 
#define ES8389_REG_CHIP_MISC   0xF0
 
#define ES8389_REG_CSM_STATE   0xF1
 
#define ES8389_REG_PULL_DOWN   0xF2
 
#define ES8389_REG_ISOLATION   0xF3
 
#define ES8389_FMT_I2S   (0 << 2)
 
#define ES8389_DATALEN_S16   (3 << 5)
 
#define ES8389_DATALEN_MSK   (7 << 5)
 
#define ES8389_FMT_MSK   (7 << 2)
 
#define ES8389_VOL_HALFDB_BIAS   191
 
#define __VK_ES8389_I2C_TIMEOUT_TICK   vsf_systimer_ms_to_tick(1000)
 

Typedefs

typedef struct vk_es8389_coeff_t vk_es8389_coeff_t
 

Enumerations

enum  {
  __VK_ES8389_DIR_PLAYBACK ,
  __VK_ES8389_DIR_CAPTURE ,
  __VK_ES8389_PLAYBACK_MASK = 1 << __VK_ES8389_DIR_PLAYBACK ,
  __VK_ES8389_CAPTURE_MASK = 1 << __VK_ES8389_DIR_CAPTURE
}
 
enum  {
  __VK_ES8389_WAIT_CMD ,
  __VK_ES8389_WAIT_I2C ,
  __VK_ES8389_WAIT_RETRY ,
  __VK_ES8389_WAIT_RECOVER
}
 
enum  {
  __VK_ES8389_WORK_NONE ,
  __VK_ES8389_WORK_OPEN ,
  __VK_ES8389_WORK_OPEN_TAIL ,
  __VK_ES8389_WORK_SET_FS ,
  __VK_ES8389_WORK_ENABLE_PLAYBACK ,
  __VK_ES8389_WORK_ENABLE_BIAS ,
  __VK_ES8389_WORK_DEFAULT_VOLUME ,
  __VK_ES8389_WORK_ENABLE_CAPTURE ,
  __VK_ES8389_WORK_CONTROL ,
  __VK_ES8389_WORK_QUIESCE
}
 
enum  {
  __VK_ES8389_XFER_WRITE ,
  __VK_ES8389_XFER_READ_ADDR ,
  __VK_ES8389_XFER_READ_DATA
}
 

Functions

 dcl_vsf_peda_methods (dcl_vsf_peda_methods(static, __vk_es8389_init)
 
 __vsf_component_peda_ifs_entry (__vk_es8389_playback_control, vk_audio_control)
 
 __vsf_component_peda_ifs_entry (__vk_es8389_playback_start, vk_audio_start)
 
 __vsf_component_peda_ifs_entry (__vk_es8389_playback_stop, vk_audio_stop)
 
 __vsf_component_peda_ifs_entry (__vk_es8389_capture_control, vk_audio_control)
 
 __vsf_component_peda_ifs_entry (__vk_es8389_capture_start, vk_audio_start)
 
 __vsf_component_peda_ifs_entry (__vk_es8389_capture_stop, vk_audio_stop)
 
 __vsf_component_peda_ifs_entry (__vk_es8389_init, vk_audio_init)
 

Macro Definition Documentation

◆ __VSF_AUDIO_CLASS_INHERIT__

#define __VSF_AUDIO_CLASS_INHERIT__
Note
ES8389 stereo audio codec control plane(i2c slave 0x20 default). Register facts + sequences learned from esp_codec_dev v1.6.2 (Apache-2.0, device/es8389/es8389.c) and re-expressed in vsf terms - no SDK text copied. The codec runs as i2s SLAVE with its clock recovered from BCLK(no MCLK pad), which is how the vendor reference boards wire it. The device stacks on vk_audio_i2s_dev_t: the audio data plane is entirely the generic i2s adapter's, this file only adds the codec register plane.

◆ __VSF_AUDIO_I2S_CLASS_INHERIT__

#define __VSF_AUDIO_I2S_CLASS_INHERIT__

◆ __VSF_EDA_CLASS_INHERIT__

#define __VSF_EDA_CLASS_INHERIT__

◆ __VSF_ES8389_CLASS_IMPLEMENT

#define __VSF_ES8389_CLASS_IMPLEMENT

◆ ES8389_REG_RESET

#define ES8389_REG_RESET   0x00

◆ ES8389_REG_MISC

#define ES8389_REG_MISC   0x01

◆ ES8389_REG_CLK_STATE

#define ES8389_REG_CLK_STATE   0x02

◆ ES8389_REG_CLK_SYS_DIV

#define ES8389_REG_CLK_SYS_DIV   0x03

◆ ES8389_REG_CLK_PLL1

#define ES8389_REG_CLK_PLL1   0x04

◆ ES8389_REG_CLK_PLL2

#define ES8389_REG_CLK_PLL2   0x05

◆ ES8389_REG_CLK_PLL3

#define ES8389_REG_CLK_PLL3   0x06

◆ ES8389_REG_CLK_PLL4

#define ES8389_REG_CLK_PLL4   0x07

◆ ES8389_REG_CLK_PLL5

#define ES8389_REG_CLK_PLL5   0x08

◆ ES8389_REG_CLK_PLL6

#define ES8389_REG_CLK_PLL6   0x09

◆ ES8389_REG_CLK_DIV_L

#define ES8389_REG_CLK_DIV_L   0x0A

◆ ES8389_REG_CLK_DIV_M

#define ES8389_REG_CLK_DIV_M   0x0B

◆ ES8389_REG_FMT_DACADC

#define ES8389_REG_FMT_DACADC   0x0C

◆ ES8389_REG_CLK_ADC

#define ES8389_REG_CLK_ADC   0x0F

◆ ES8389_REG_CLK_DAC

#define ES8389_REG_CLK_DAC   0x10

◆ ES8389_REG_CLK_ADCDIV1

#define ES8389_REG_CLK_ADCDIV1   0x11

◆ ES8389_REG_CLK_DACDIV1

#define ES8389_REG_CLK_DACDIV1   0x12

◆ ES8389_REG_CLK_DACDIV2

#define ES8389_REG_CLK_DACDIV2   0x13

◆ ES8389_REG_CLK_ADCDIV3

#define ES8389_REG_CLK_ADCDIV3   0x14

◆ ES8389_REG_CLK_ADCDIV4

#define ES8389_REG_CLK_ADCDIV4   0x15

◆ ES8389_REG_ADC_MCLK

#define ES8389_REG_ADC_MCLK   0x16

◆ ES8389_REG_ADC_DIV_L

#define ES8389_REG_ADC_DIV_L   0x17

◆ ES8389_REG_ADC_DIV_M

#define ES8389_REG_ADC_DIV_M   0x18

◆ ES8389_REG_ADC_DIV_H

#define ES8389_REG_ADC_DIV_H   0x19

◆ ES8389_REG_ADC_DACLRC

#define ES8389_REG_ADC_DACLRC   0x1A

◆ ES8389_REG_DAC_DACLRC

#define ES8389_REG_DAC_DACLRC   0x1B

◆ ES8389_REG_ADC_SP

#define ES8389_REG_ADC_SP   0x20

◆ ES8389_REG_ADC_ALC1

#define ES8389_REG_ADC_ALC1   0x21

◆ ES8389_REG_ADC_ALC2

#define ES8389_REG_ADC_ALC2   0x22

◆ ES8389_REG_ADC_ALC3

#define ES8389_REG_ADC_ALC3   0x23

◆ ES8389_REG_ADC_NG

#define ES8389_REG_ADC_NG   0x24

◆ ES8389_REG_ADC_DRC

#define ES8389_REG_ADC_DRC   0x25

◆ ES8389_REG_ADC_DRC_VOL1

#define ES8389_REG_ADC_DRC_VOL1   0x26

◆ ES8389_REG_ADC_DRC_VOL2

#define ES8389_REG_ADC_DRC_VOL2   0x27

◆ ES8389_REG_ADC_DRC_VOL3

#define ES8389_REG_ADC_DRC_VOL3   0x28

◆ ES8389_REG_ADC_ALC4

#define ES8389_REG_ADC_ALC4   0x2A

◆ ES8389_REG_DAC_CTRL

#define ES8389_REG_DAC_CTRL   0x30

◆ ES8389_REG_DAC_SP

#define ES8389_REG_DAC_SP   0x40

◆ ES8389_REG_DAC_FILTER

#define ES8389_REG_DAC_FILTER   0x41

◆ ES8389_REG_DAC_VOL_MIX

#define ES8389_REG_DAC_VOL_MIX   0x42

◆ ES8389_REG_DAC_VOL_L

#define ES8389_REG_DAC_VOL_L   0x46

◆ ES8389_REG_DAC_VOL_R

#define ES8389_REG_DAC_VOL_R   0x47

◆ ES8389_REG_DAC_VOL_MIXC

#define ES8389_REG_DAC_VOL_MIXC   0x48

◆ ES8389_REG_DAC_CLKFREE

#define ES8389_REG_DAC_CLKFREE   0x4D

◆ ES8389_REG_VMID

#define ES8389_REG_VMID   0x60

◆ ES8389_REG_ANA1

#define ES8389_REG_ANA1   0x61

◆ ES8389_REG_ANA2

#define ES8389_REG_ANA2   0x62

◆ ES8389_REG_ANA3

#define ES8389_REG_ANA3   0x63

◆ ES8389_REG_ANA4

#define ES8389_REG_ANA4   0x64

◆ ES8389_REG_ANA5

#define ES8389_REG_ANA5   0x69

◆ ES8389_REG_PGA_L

#define ES8389_REG_PGA_L   0x72

◆ ES8389_REG_PGA_R

#define ES8389_REG_PGA_R   0x73

◆ ES8389_REG_CHIP_MISC

#define ES8389_REG_CHIP_MISC   0xF0

◆ ES8389_REG_CSM_STATE

#define ES8389_REG_CSM_STATE   0xF1

◆ ES8389_REG_PULL_DOWN

#define ES8389_REG_PULL_DOWN   0xF2

◆ ES8389_REG_ISOLATION

#define ES8389_REG_ISOLATION   0xF3

◆ ES8389_FMT_I2S

#define ES8389_FMT_I2S   (0 << 2)

◆ ES8389_DATALEN_S16

#define ES8389_DATALEN_S16   (3 << 5)

◆ ES8389_DATALEN_MSK

#define ES8389_DATALEN_MSK   (7 << 5)

◆ ES8389_FMT_MSK

#define ES8389_FMT_MSK   (7 << 2)

◆ ES8389_VOL_HALFDB_BIAS

#define ES8389_VOL_HALFDB_BIAS   191

◆ __VK_ES8389_I2C_TIMEOUT_TICK

#define __VK_ES8389_I2C_TIMEOUT_TICK   vsf_systimer_ms_to_tick(1000)

Typedef Documentation

◆ vk_es8389_coeff_t

typedef struct vk_es8389_coeff_t vk_es8389_coeff_t

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
__VK_ES8389_DIR_PLAYBACK 
__VK_ES8389_DIR_CAPTURE 
__VK_ES8389_PLAYBACK_MASK 
__VK_ES8389_CAPTURE_MASK 

◆ anonymous enum

anonymous enum
Enumerator
__VK_ES8389_WAIT_CMD 
__VK_ES8389_WAIT_I2C 
__VK_ES8389_WAIT_RETRY 
__VK_ES8389_WAIT_RECOVER 

◆ anonymous enum

anonymous enum
Enumerator
__VK_ES8389_WORK_NONE 
__VK_ES8389_WORK_OPEN 
__VK_ES8389_WORK_OPEN_TAIL 
__VK_ES8389_WORK_SET_FS 
__VK_ES8389_WORK_ENABLE_PLAYBACK 
__VK_ES8389_WORK_ENABLE_BIAS 
__VK_ES8389_WORK_DEFAULT_VOLUME 
__VK_ES8389_WORK_ENABLE_CAPTURE 
__VK_ES8389_WORK_CONTROL 
__VK_ES8389_WORK_QUIESCE 

◆ anonymous enum

anonymous enum
Enumerator
__VK_ES8389_XFER_WRITE 
__VK_ES8389_XFER_READ_ADDR 
__VK_ES8389_XFER_READ_DATA 

Function Documentation

◆ dcl_vsf_peda_methods()

dcl_vsf_peda_methods ( dcl_vsf_peda_methods( static,
__vk_es8389_init  )

◆ __vsf_component_peda_ifs_entry() [1/7]

__vsf_component_peda_ifs_entry ( __vk_es8389_playback_control ,
vk_audio_control  )

◆ __vsf_component_peda_ifs_entry() [2/7]

__vsf_component_peda_ifs_entry ( __vk_es8389_playback_start ,
vk_audio_start  )

◆ __vsf_component_peda_ifs_entry() [3/7]

__vsf_component_peda_ifs_entry ( __vk_es8389_playback_stop ,
vk_audio_stop  )

◆ __vsf_component_peda_ifs_entry() [4/7]

__vsf_component_peda_ifs_entry ( __vk_es8389_capture_control ,
vk_audio_control  )

◆ __vsf_component_peda_ifs_entry() [5/7]

__vsf_component_peda_ifs_entry ( __vk_es8389_capture_start ,
vk_audio_start  )

◆ __vsf_component_peda_ifs_entry() [6/7]

__vsf_component_peda_ifs_entry ( __vk_es8389_capture_stop ,
vk_audio_stop  )

◆ __vsf_component_peda_ifs_entry() [7/7]

__vsf_component_peda_ifs_entry ( __vk_es8389_init ,
vk_audio_init  )
Generated from commit: vsfteam/vsf@b7e0147