/** @file
  Register names for PCH High Definition Audio device.
  Conventions:
  Prefixes:
  Definitions beginning with "R_" are registers
  Definitions beginning with "B_" are bits within registers
  Definitions beginning with "V_" are meaningful values within the bits
  Definitions beginning with "S_" are register sizes
  Definitions beginning with "N_" are the bit position
  In general, PCH registers are denoted by "_PCH_" in register names
  Registers / bits that are different between PCH generations are denoted by
  _PCH_[generation_name]_" in register/bit names.
  Registers / bits that are specific to PCH-H denoted by "_H_" in register/bit names.
  Registers / bits that are specific to PCH-LP denoted by "_LP_" in register/bit names.
  e.g., "_PCH_H_", "_PCH_LP_"
  Registers / bits names without _H_ or _LP_ apply for both H and LP.
  Registers / bits that are different between SKUs are denoted by "_[SKU_name]"
  at the end of the register/bit names
  Registers / bits of new devices introduced in a PCH generation will be just named
  as "_PCH_" without [generation_name] inserted.

  @copyright
  Copyright 1999 - 2021 Intel Corporation. <BR>

  SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#ifndef _PCH_REGS_HDA_H_
#define _PCH_REGS_HDA_H_

//
// HD-A Controller Registers (D31:F3)
//
// PCI Configuration Space Registers
//
#define PCI_DEVICE_NUMBER_PCH_HDA       31
#define PCI_FUNCTION_NUMBER_PCH_HDA     3

#define V_PCH_HDA_VENDOR_ID             V_PCH_INTEL_VENDOR_ID
#define V_PCH_LP_HDA_DEVICE_ID_0                0x9D70
#define V_PCH_LP_HDA_DEVICE_ID_1                0x9D71
#define V_PCH_LP_HDA_DEVICE_ID_2                0x9D72
#define V_PCH_LP_HDA_DEVICE_ID_3                0x9D73
#define V_PCH_LP_HDA_DEVICE_ID_4                0x9D74
#define V_PCH_LP_HDA_DEVICE_ID_5                0x9D75
#define V_PCH_LP_HDA_DEVICE_ID_6                0x9D76
#define V_PCH_LP_HDA_DEVICE_ID_7                0x9D77
#define V_PCH_H_HDA_DEVICE_ID_0                 0xA170
#define V_PCH_H_HDA_DEVICE_ID_1                 0xA171
#define V_PCH_H_HDA_DEVICE_ID_2                 0xA172
#define V_PCH_H_HDA_DEVICE_ID_3                 0xA173
#define V_PCH_H_HDA_DEVICE_ID_4                 0xA174
#define V_PCH_H_HDA_DEVICE_ID_5                 0xA175
#define V_PCH_H_HDA_DEVICE_ID_6                 0xA176
#define V_PCH_H_HDA_DEVICE_ID_7                 0xA177
//
// LBG SSX (Super SKU) DIDs
//
#define V_PCH_LBG_HDA_DEVICE_ID_0               0xA270
#define V_PCH_LBG_HDA_DEVICE_ID_1               0xA271
#define V_PCH_LBG_HDA_DEVICE_ID_2               0xA272
#define V_PCH_LBG_HDA_DEVICE_ID_3               0xA273
#define V_PCH_LBG_HDA_DEVICE_ID_4               0xA274
#define V_PCH_LBG_HDA_DEVICE_ID_5               0xA275
#define V_PCH_LBG_HDA_DEVICE_ID_6               0xA276
#define V_PCH_LBG_HDA_DEVICE_ID_7               0xA277
//
// LBG PRODUCTION (PRQ) DIDs
//
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_0          0xA1F0
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_1          0xA1F1
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_2          0xA1F2
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_3          0xA1F3
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_4          0xA1F4
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_5          0xA1F5
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_6          0xA1F6
#define V_PCH_LBG_PROD_HDA_DEVICE_ID_7          0xA1F7


#define R_PCH_HDA_PI                            0x09
#define V_PCH_HDA_PI_ADSP_UAA                   0x80
#define R_PCH_HDA_SCC                           0x0A
#define V_PCH_HDA_SCC_ADSP                      0x01
#define R_PCH_HDA_HDALBA                0x10
#define B_PCH_HDA_HDALBA_LBA            0xFFFFC000
#define V_PCH_HDA_HDBAR_SIZE            (1 << 14)
#define R_PCH_HDA_HDAUBA                0x14
#define B_PCH_HDA_HDAUBA_UBA            0xFFFFFFFF
#define R_PCH_HDA_CGCTL                 0x48
#define B_PCH_HDA_CGCTL_MEMDCGE         BIT0
#define B_PCH_HDA_CGCTL_ADSPDCGE        BIT1
#define B_PCH_HDA_CGCTL_GPDMADCGE       BIT2
#define B_PCH_HDA_CGCTL_HDALDCGE        BIT3
#define B_PCH_HDA_CGCTL_MISCBDCGE       BIT6
#define B_PCH_HDA_CGCTL_ODMABDCGE       BIT4
#define B_PCH_HDA_CGCTL_IDMABDCGE       BIT5
#define B_PCH_HDA_CGCTL_IOSFBDCGE       BIT7
#define B_PCH_HDA_CGCTL_IOSFSDCGE       BIT8
#define B_PCH_HDA_CGCTL_DMICDCGE        BIT10
#define B_PCH_HDA_CGCTL_I2SDCGE         BIT11
#define B_PCH_HDA_CGCTL_APTCGE          BIT16
#define B_PCH_HDA_CGCTL_XOTCGE          BIT17
#define B_PCH_HDA_CGCTL_SROTCGE         BIT18
#define B_PCH_HDA_CGCTL_IOSFBTCGE       BIT19
#define B_PCH_HDA_CGCTL_IOSFSTCGE       BIT20
#define B_PCH_HDA_CGCTL_FROTCGE         BIT21
#define B_PCH_HDA_CGCTL_APLLSE          BIT31
#define V_PCH_HDA_CGCTL_CGEN           (B_PCH_HDA_CGCTL_MEMDCGE   | \
                                        B_PCH_HDA_CGCTL_ADSPDCGE  | \
                                        B_PCH_HDA_CGCTL_GPDMADCGE | \
                                        B_PCH_HDA_CGCTL_HDALDCGE  | \
                                        B_PCH_HDA_CGCTL_MISCBDCGE | \
                                        B_PCH_HDA_CGCTL_ODMABDCGE | \
                                        B_PCH_HDA_CGCTL_IDMABDCGE | \
                                        B_PCH_HDA_CGCTL_IOSFBDCGE | \
                                        B_PCH_HDA_CGCTL_IOSFSDCGE | \
                                        B_PCH_HDA_CGCTL_DMICDCGE  | \
                                        B_PCH_HDA_CGCTL_I2SDCGE   | \
                                        B_PCH_HDA_CGCTL_APTCGE    | \
                                        B_PCH_HDA_CGCTL_XOTCGE    | \
                                        B_PCH_HDA_CGCTL_SROTCGE   | \
                                        B_PCH_HDA_CGCTL_IOSFBTCGE | \
                                        B_PCH_HDA_CGCTL_IOSFSTCGE | \
                                        B_PCH_HDA_CGCTL_FROTCGE   | \
                                        B_PCH_HDA_CGCTL_APLLSE    )
#define R_PCH_HDA_CGCTL                         0x48
#define B_PCH_HDA_CGCTL_MISCBDCGE               BIT6
#define R_PCH_HDA_PC                    0x52
#define V_PCH_HDA_PC_PMES               0x18
#define N_PCH_HDA_PC_PMES               11
#define R_PCH_HDA_PCS                   0x54
#define B_PCH_HDA_PCS_PMES              BIT15
#define B_PCH_HDA_PCS_PMEE              BIT8
#define B_PCH_HDA_PCS_PS                        (BIT1 | BIT0)
#define R_PCH_HDA_MMC                   0x62
#define B_PCH_HDA_MMC_ME                BIT0
#define R_PCH_HDA_DEVC                          0x78
#define B_PCH_HDA_DEVC_NSNPEN                   BIT11
#define R_PCH_HDA_SEM1                          0xC0
#define B_PCH_HDA_SEM1_LFLCS                    BIT24
#define B_PCH_HDA_SEM1_BLKC3DIS                 BIT17
#define B_PCH_HDA_SEM1_TMODE                    BIT12
#define B_PCH_HDA_SEM1_FIFORDYSEL               (BIT10 | BIT9)
#define R_PCH_HDA_SEM2                          0xC4
#define B_PCH_HDA_SEM2_BSMT                     (BIT27 | BIT26)
#define V_PCH_HDA_SEM2_BSMT                     0x1
#define N_PCH_HDA_SEM2_BSMT                     26
#define B_PCH_HDA_SEM2_VC0PSNR                  BIT24
#define R_PCH_HDA_SEM3L                         0xC8
#define B_PCH_HDA_SEM3L_ISL1EXT2                (BIT21 | BIT20)
#define V_PCH_HDA_SEM3L_ISL1EXT2                0x2
#define N_PCH_HDA_SEM3L_ISL1EXT2                20
#define R_PCH_HDA_SEM4L                         0xD0
#define B_PCH_HDA_SEM4L_OSL1EXT2                (BIT21 | BIT20)
#define V_PCH_HDA_SEM4L_OSL1EXT2                0x3
#define N_PCH_HDA_SEM4L_OSL1EXT2                20

//
// Memory Space Registers
//
//
// Resides in 'HD Audio Global Registers' (0000h)
//
#define R_PCH_HDABA_GCAP                        0x00
#define R_PCH_HDABA_GCTL                        0x08
#define B_PCH_HDABA_GCTL_CRST                   BIT0

#define R_PCH_HDABA_OUTPAY                      0x04
#define R_PCH_HDABA_INPAY                       0x06
#define V_PCH_HDABA_INPAY_DEFAULT               0x1C

#define R_PCH_HDABA_WAKEEN                      0x0C
#define B_PCH_HDABA_WAKEEN_SDI_3                BIT3
#define B_PCH_HDABA_WAKEEN_SDI_2                BIT2
#define B_PCH_HDABA_WAKEEN_SDI_1                BIT1
#define B_PCH_HDABA_WAKEEN_SDI_0                BIT0

#define R_PCH_HDABA_WAKESTS                     0x0E
#define B_PCH_HDABA_WAKESTS_SDIN3               BIT3
#define B_PCH_HDABA_WAKESTS_SDIN2               BIT2
#define B_PCH_HDABA_WAKESTS_SDIN1               BIT1
#define B_PCH_HDABA_WAKESTS_SDIN0               BIT0

//
// Resides in 'HD Audio Controller Registers' (0030h)
//
#define R_PCH_HDABA_IC                          0x60
#define R_PCH_HDABA_IR                          0x64
#define R_PCH_HDABA_ICS                         0x68
#define B_PCH_HDABA_ICS_IRV                     BIT1
#define B_PCH_HDABA_ICS_ICB                     BIT0

//
// Resides in 'HD Audio Processing Pipe Capability Structure' (0800h)
//
#define R_PCH_HDABA_PPC                         0x0800 // Processing Pipe Capability Structure (Memory Space, offset 0800h)
#define R_PCH_HDABA_PPCTL                       (R_PCH_HDABA_PPC + 0x04)
#define B_PCH_HDABA_PPCTL_GPROCEN               BIT30

//
// Resides in 'HD Audio Multiple Links Capability Structure' (0C00h)
//
#define V_PCH_HDA_HDALINK_INDEX                 0
#define V_PCH_HDA_IDISPLINK_INDEX               1

#define R_PCH_HDABA_MLC                         0x0C00 // Multiple Links Capability Structure (Memory Space, offset 0C00h)
#define R_PCH_HDABA_LCTLX(x)                    (R_PCH_HDABA_MLC + (0x40 + (0x40 * (x)) + 0x04)) // x - Link index: 0 - HDA Link, 1 - iDisp Link
#define B_PCH_HDABA_LCTLX_CPA                   BIT23
#define B_PCH_HDABA_LCTLX_SPA                   BIT16
#define N_PCH_HDABA_LCTLX_SCF                   0
#define V_PCH_HDABA_LCTLX_SCF_6MHZ              0x0
#define V_PCH_HDABA_LCTLX_SCF_12MHZ             0x1
#define V_PCH_HDABA_LCTLX_SCF_24MHZ             0x2
#define V_PCH_HDABA_LCTLX_SCF_48MHZ             0x3
#define V_PCH_HDABA_LCTLX_SCF_96MHZ             0x4

//
// Resides in 'HD Audio Vendor Specific Registers' (1000h)
//
#define R_PCH_HDABA_LTRC                        0x1048
#define V_PCH_HDABA_LTRC_GB                     0x29
#define N_PCH_HDABA_LTRC_GB                     0
#define R_PCH_HDABA_PCE                         0x104B
#define B_PCH_HDABA_PCE_D3HE                    BIT2

//
// Private Configuration Space Registers
//
//
// Resides in IOSF & Fabric Configuration Registers (000h)
//
#define R_PCH_PCR_HDA_TTCCFG                    0xE4
#define B_PCH_PCR_HDA_TTCCFG_HCDT               BIT1

//
// Resides in PCI & Codec Configuration Registers (500h)
//
#define R_PCH_PCR_HDA_PCICDCCFG                 0x500 // PCI & Codec Configuration Registers (PCR, offset 500h)
#define B_PCH_PCR_HDA_PCICDCCFG_ACPIIN          0x0000FF00
#define N_PCH_PCR_HDA_PCICDCCFG_ACPIIN          8
#define R_PCH_PCR_HDA_FNCFG                     (R_PCH_PCR_HDA_PCICDCCFG + 0x30)
#define B_PCH_PCR_HDA_FNCFG_PGD                 BIT5
#define B_PCH_PCR_HDA_FNCFG_BCLD                BIT4
#define B_PCH_PCR_HDA_FNCFG_CGD                 BIT3
#define B_PCH_PCR_HDA_FNCFG_ADSPD               BIT2

#define B_PCH_PCR_HDA_FNCFG_HDASPCID            BIT1

#define B_PCH_PCR_HDA_FNCFG_HDASD               BIT0
#define R_PCH_PCR_HDA_CDCCFG                    (R_PCH_PCR_HDA_PCICDCCFG + 0x34)
#define B_PCH_PCR_HDA_CDCCFG_DIS_SDIN2          BIT2

//
// Resides in Power Management & EBB Configuration Registers (600h)
//
#define R_PCH_PCR_HDA_PWRMANCFG                 0x600 // Power Management & EBB Configuration Registers (PCR, offset 600h)
#define R_PCH_PCR_HDA_APLLP0                    (R_PCH_PCR_HDA_PWRMANCFG + 0x10)
#define V_PCH_PCR_HDA_APLLP0                    0xFC1E0000
#define R_PCH_PCR_HDA_APLLP1                    (R_PCH_PCR_HDA_PWRMANCFG + 0x14)
#define V_PCH_PCR_HDA_APLLP1                    0x00003F00
#define R_PCH_PCR_HDA_APLLP2                    (R_PCH_PCR_HDA_PWRMANCFG + 0x18)
#define V_PCH_PCR_HDA_APLLP2                    0x0000011D
#define R_PCH_PCR_HDA_IOBCTL                    (R_PCH_PCR_HDA_PWRMANCFG + 0x1C)
#define B_PCH_PCR_HDA_IOBCTL_OSEL               (BIT9 | BIT8)
#define V_PCH_PCR_HDA_IOBCTL_OSEL_HDALINK       0
#define V_PCH_PCR_HDA_IOBCTL_OSEL_HDALINK_I2S   1
#define V_PCH_PCR_HDA_IOBCTL_OSEL_I2S           3
#define N_PCH_PCR_HDA_IOBCTL_OSEL               8
#define B_PCH_PCR_HDA_IOBCTL_VSEL               BIT1

#endif