root/sound/soc/codecs/nau8822.h
/* SPDX-License-Identifier: GPL-2.0 */
/*
 * nau8822.h  --  NAU8822 ALSA SoC Audio driver
 *
 * Copyright 2017 Nuvoton Technology Crop.
 *
 * Author: David Lin <ctlin0@nuvoton.com>
 * Co-author: John Hsu <kchsu0@nuvoton.com>
 * Co-author: Seven Li <wtli@nuvoton.com>
 */

#ifndef __NAU8822_H__
#define __NAU8822_H__

#define NAU8822_REG_RESET                       0x00
#define NAU8822_REG_POWER_MANAGEMENT_1          0x01
#define NAU8822_REG_POWER_MANAGEMENT_2          0x02
#define NAU8822_REG_POWER_MANAGEMENT_3          0x03
#define NAU8822_REG_AUDIO_INTERFACE             0x04
#define NAU8822_REG_COMPANDING_CONTROL          0x05
#define NAU8822_REG_CLOCKING                    0x06
#define NAU8822_REG_ADDITIONAL_CONTROL          0x07
#define NAU8822_REG_GPIO_CONTROL                0x08
#define NAU8822_REG_JACK_DETECT_CONTROL_1       0x09
#define NAU8822_REG_DAC_CONTROL                 0x0A
#define NAU8822_REG_LEFT_DAC_DIGITAL_VOLUME     0x0B
#define NAU8822_REG_RIGHT_DAC_DIGITAL_VOLUME    0x0C
#define NAU8822_REG_JACK_DETECT_CONTROL_2       0x0D
#define NAU8822_REG_ADC_CONTROL                 0x0E
#define NAU8822_REG_LEFT_ADC_DIGITAL_VOLUME     0x0F
#define NAU8822_REG_RIGHT_ADC_DIGITAL_VOLUME    0x10
#define NAU8822_REG_EQ1                         0x12
#define NAU8822_REG_EQ2                         0x13
#define NAU8822_REG_EQ3                         0x14
#define NAU8822_REG_EQ4                         0x15
#define NAU8822_REG_EQ5                         0x16
#define NAU8822_REG_DAC_LIMITER_1               0x18
#define NAU8822_REG_DAC_LIMITER_2               0x19
#define NAU8822_REG_NOTCH_FILTER_1              0x1B
#define NAU8822_REG_NOTCH_FILTER_2              0x1C
#define NAU8822_REG_NOTCH_FILTER_3              0x1D
#define NAU8822_REG_NOTCH_FILTER_4              0x1E
#define NAU8822_REG_ALC_CONTROL_1               0x20
#define NAU8822_REG_ALC_CONTROL_2               0x21
#define NAU8822_REG_ALC_CONTROL_3               0x22
#define NAU8822_REG_NOISE_GATE                  0x23
#define NAU8822_REG_PLL_N                       0x24
#define NAU8822_REG_PLL_K1                      0x25
#define NAU8822_REG_PLL_K2                      0x26
#define NAU8822_REG_PLL_K3                      0x27
#define NAU8822_REG_3D_CONTROL                  0x29
#define NAU8822_REG_RIGHT_SPEAKER_CONTROL       0x2B
#define NAU8822_REG_INPUT_CONTROL               0x2C
#define NAU8822_REG_LEFT_INP_PGA_CONTROL        0x2D
#define NAU8822_REG_RIGHT_INP_PGA_CONTROL       0x2E
#define NAU8822_REG_LEFT_ADC_BOOST_CONTROL      0x2F
#define NAU8822_REG_RIGHT_ADC_BOOST_CONTROL     0x30
#define NAU8822_REG_OUTPUT_CONTROL              0x31
#define NAU8822_REG_LEFT_MIXER_CONTROL          0x32
#define NAU8822_REG_RIGHT_MIXER_CONTROL         0x33
#define NAU8822_REG_LHP_VOLUME                  0x34
#define NAU8822_REG_RHP_VOLUME                  0x35
#define NAU8822_REG_LSPKOUT_VOLUME              0x36
#define NAU8822_REG_RSPKOUT_VOLUME              0x37
#define NAU8822_REG_AUX2_MIXER                  0x38
#define NAU8822_REG_AUX1_MIXER                  0x39
#define NAU8822_REG_POWER_MANAGEMENT_4          0x3A
#define NAU8822_REG_LEFT_TIME_SLOT              0x3B
#define NAU8822_REG_MISC                        0x3C
#define NAU8822_REG_RIGHT_TIME_SLOT             0x3D
#define NAU8822_REG_DEVICE_REVISION             0x3E
#define NAU8822_REG_DEVICE_ID                   0x3F
#define NAU8822_REG_DAC_DITHER                  0x41
#define NAU8822_REG_ALC_ENHANCE_1               0x46
#define NAU8822_REG_ALC_ENHANCE_2               0x47
#define NAU8822_REG_192KHZ_SAMPLING             0x48
#define NAU8822_REG_MISC_CONTROL                0x49
#define NAU8822_REG_INPUT_TIEOFF                0x4A
#define NAU8822_REG_POWER_REDUCTION             0x4B
#define NAU8822_REG_AGC_PEAK2PEAK               0x4C
#define NAU8822_REG_AGC_PEAK_DETECT             0x4D
#define NAU8822_REG_AUTOMUTE_CONTROL            0x4E
#define NAU8822_REG_OUTPUT_TIEOFF               0x4F
#define NAU8822_REG_MAX_REGISTER                NAU8822_REG_OUTPUT_TIEOFF

/* NAU8822_REG_POWER_MANAGEMENT_1 (0x1) */
#define NAU8822_REFIMP_MASK                     0x3
#define NAU8822_REFIMP_80K                      0x1
#define NAU8822_REFIMP_300K                     0x2
#define NAU8822_REFIMP_3K                       0x3
#define NAU8822_IOBUF_EN                        (0x1 << 2)
#define NAU8822_ABIAS_EN                        (0x1 << 3)
#define NAU8822_PLL_EN_MASK                     (0x1 << 5)
#define NAU8822_PLL_ON                          (0x1 << 5)
#define NAU8822_PLL_OFF                         (0x0 << 5)

/* NAU8822_REG_AUDIO_INTERFACE (0x4) */
#define NAU8822_AIFMT_MASK                      (0x3 << 3)
#define NAU8822_WLEN_MASK                       (0x3 << 5)
#define NAU8822_WLEN_20                         (0x1 << 5)
#define NAU8822_WLEN_24                         (0x2 << 5)
#define NAU8822_WLEN_32                         (0x3 << 5)
#define NAU8822_LRP_MASK                        (0x1 << 7)
#define NAU8822_BCLKP_MASK                      (0x1 << 8)

/* NAU8822_REG_COMPANDING_CONTROL (0x5) */
#define NAU8822_ADDAP_SFT                       0
#define NAU8822_ADCCM_SFT                       1
#define NAU8822_DACCM_SFT                       3

/* NAU8822_REG_CLOCKING (0x6) */
#define NAU8822_CLKIOEN_MASK                    0x1
#define NAU8822_CLK_MASTER                      0x1
#define NAU8822_CLK_SLAVE                       0x0
#define NAU8822_MCLKSEL_SFT                     5
#define NAU8822_MCLKSEL_MASK                    (0x7 << 5)
#define NAU8822_BCLKSEL_SFT                     2
#define NAU8822_BCLKSEL_MASK                    (0x7 << 2)
#define NAU8822_BCLKDIV_1                       (0x0 << 2)
#define NAU8822_BCLKDIV_2                       (0x1 << 2)
#define NAU8822_BCLKDIV_4                       (0x2 << 2)
#define NAU8822_BCLKDIV_8                       (0x3 << 2)
#define NAU8822_BCLKDIV_16                      (0x4 << 2)
#define NAU8822_CLKM_MASK                       (0x1 << 8)
#define NAU8822_CLKM_MCLK                       (0x0 << 8)
#define NAU8822_CLKM_PLL                        (0x1 << 8)

/* NAU8822_REG_ADDITIONAL_CONTROL (0x08) */
#define NAU8822_SMPLR_SFT                       1
#define NAU8822_SMPLR_MASK                      (0x7 << 1)
#define NAU8822_SMPLR_48K                       (0x0 << 1)
#define NAU8822_SMPLR_32K                       (0x1 << 1)
#define NAU8822_SMPLR_24K                       (0x2 << 1)
#define NAU8822_SMPLR_16K                       (0x3 << 1)
#define NAU8822_SMPLR_12K                       (0x4 << 1)
#define NAU8822_SMPLR_8K                        (0x5 << 1)

/* NAU8822_REG_EQ1 (0x12) */
#define NAU8822_EQ1GC_SFT                       0
#define NAU8822_EQ1CF_SFT                       5
#define NAU8822_EQM_SFT                         8

/* NAU8822_REG_EQ2 (0x13) */
#define NAU8822_EQ2GC_SFT                       0
#define NAU8822_EQ2CF_SFT                       5
#define NAU8822_EQ2BW_SFT                       8

/* NAU8822_REG_EQ3 (0x14) */
#define NAU8822_EQ3GC_SFT                       0
#define NAU8822_EQ3CF_SFT                       5
#define NAU8822_EQ3BW_SFT                       8

/* NAU8822_REG_EQ4 (0x15) */
#define NAU8822_EQ4GC_SFT                       0
#define NAU8822_EQ4CF_SFT                       5
#define NAU8822_EQ4BW_SFT                       8

/* NAU8822_REG_EQ5 (0x16) */
#define NAU8822_EQ5GC_SFT                       0
#define NAU8822_EQ5CF_SFT                       5

/* NAU8822_REG_ALC_CONTROL_1 (0x20) */
#define NAU8822_ALCMINGAIN_SFT                  0
#define NAU8822_ALCMXGAIN_SFT                   3
#define NAU8822_ALCEN_SFT                       7

/* NAU8822_REG_ALC_CONTROL_2 (0x21) */
#define NAU8822_ALCSL_SFT                       0
#define NAU8822_ALCHT_SFT                       4

/* NAU8822_REG_ALC_CONTROL_3 (0x22) */
#define NAU8822_ALCATK_SFT                      0
#define NAU8822_ALCDCY_SFT                      4
#define NAU8822_ALCM_SFT                        8

/* NAU8822_REG_PLL_N (0x24) */
#define NAU8822_PLLMCLK_DIV2                    (0x1 << 4)
#define NAU8822_PLLN_MASK                       0xF

#define NAU8822_PLLK1_SFT                       18
#define NAU8822_PLLK1_MASK                      0x3F

/* NAU8822_REG_PLL_K2 (0x26) */
#define NAU8822_PLLK2_SFT                       9
#define NAU8822_PLLK2_MASK                      0x1FF

/* NAU8822_REG_PLL_K3 (0x27) */
#define NAU8822_PLLK3_MASK                      0x1FF

/* NAU8822_REG_RIGHT_SPEAKER_CONTROL (0x2B) */
#define NAU8822_RMIXMUT                         0x20
#define NAU8822_RSUBBYP                         0x10

#define NAU8822_RAUXRSUBG_SFT                   1
#define NAU8822_RAUXRSUBG_MASK                  0x0E

#define NAU8822_RAUXSMUT                        0x01

/* System Clock Source */
enum {
        NAU8822_CLK_MCLK,
        NAU8822_CLK_PLL,
};

struct nau8822_pll {
        int pre_factor;
        int mclk_scaler;
        int pll_frac;
        int pll_int;
        int freq_in;
        int freq_out;
};

/* Codec Private Data */
struct nau8822 {
        struct device *dev;
        struct regmap *regmap;
        struct clk *mclk;
        struct nau8822_pll pll;
        int sysclk;
        int div_id;
};

#endif  /* __NAU8822_H__ */