]> git.proxmox.com Git - mirror_edk2.git/blame - Vlv2DeviceRefCodePkg/ValleyView2Soc/SouthCluster/Include/PchRegs/PchRegsSata.h
Upload BSD-licensed Vlv2TbltDevicePkg and Vlv2DeviceRefCodePkg to
[mirror_edk2.git] / Vlv2DeviceRefCodePkg / ValleyView2Soc / SouthCluster / Include / PchRegs / PchRegsSata.h
CommitLineData
3cbfba02
DW
1/**\r
2\r
3Copyright (c) 2012 - 2014, Intel Corporation. All rights reserved\r
4\r
5 This program and the accompanying materials are licensed and made available under\r
6 the terms and conditions of the BSD License that accompanies this distribution.\r
7 The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php.\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13\r
14\r
15 @file\r
16 PchRegsSata.h\r
17\r
18 @brief\r
19 Register names for VLV SATA controllers\r
20\r
21 Conventions:\r
22\r
23 - Prefixes:\r
24 Definitions beginning with "R_" are registers\r
25 Definitions beginning with "B_" are bits within registers\r
26 Definitions beginning with "V_" are meaningful values of bits within the registers\r
27 Definitions beginning with "S_" are register sizes\r
28 Definitions beginning with "N_" are the bit position\r
29 - In general, PCH registers are denoted by "_PCH_" in register names\r
30 - Registers / bits that are different between PCH generations are denoted by\r
31 "_PCH_<generation_name>_" in register/bit names. e.g., "_PCH_VLV_"\r
32 - Registers / bits that are different between SKUs are denoted by "_<SKU_name>"\r
33 at the end of the register/bit names\r
34 - Registers / bits of new devices introduced in a PCH generation will be just named\r
35 as "_PCH_" without <generation_name> inserted.\r
36\r
37**/\r
38#ifndef _PCH_REGS_SATA_H_\r
39#define _PCH_REGS_SATA_H_\r
40\r
41///\r
42/// VLV SATA Message Bus\r
43///\r
44#define PCH_SATA_PHY_PORT_ID 0xA3 // SATA PHY Port ID\r
45#define PCH_SATA_PHY_MMIO_READ_OPCODE 0x00 // CUnit to SATA PHY MMIO Read Opcode\r
46#define PCH_SATA_PHY_MMIO_WRITE_OPCODE 0x01 // CUnit to SATA PHY MMIO Write Opcode\r
47\r
48///\r
49/// SATA Controller Registers (D19:F0)\r
50///\r
51#define PCI_DEVICE_NUMBER_PCH_SATA 19\r
52#define PCI_FUNCTION_NUMBER_PCH_SATA 0\r
53\r
54#define R_PCH_SATA_ID 0x00 // Identifiers\r
55#define B_PCH_SATA_ID_DID 0xFFFF0000 // Device ID\r
56#define B_PCH_SATA_ID_VID 0x0000FFFF // Vendor ID\r
57#define V_PCH_SATA_VENDOR_ID V_PCH_INTEL_VENDOR_ID\r
58#define V_PCH_SATA_DEVICE_ID_D_IDE 0x0F20 // Desktop IDE Mode (Ports 0 and 1)\r
59#define V_PCH_SATA_DEVICE_ID_D_AHCI 0x0F22 // Desktop AHCI Mode (Ports 0 and 1)\r
60#define V_PCH_SATA_DEVICE_ID_D_RAID 0x2822 // Desktop RAID 0/1/5/10 Mode, based on D19:F0:9Ch[7]\r
61\r
62#define V_PCH_SATA_DEVICE_ID_M_IDE 0x0F21 // Mobile IDE Mode (Ports 0 and 1)\r
63#define V_PCH_SATA_DEVICE_ID_M_AHCI 0x0F23 // Mobile AHCI Mode (Ports 0 and 1)\r
64#define V_PCH_SATA_DEVICE_ID_M_RAID 0x282A // Mobile RAID 0/1/5/10 Mode, based on D19:F0:9Ch[7]\r
65\r
66#define R_PCH_SATA_COMMAND 0x04 // Command\r
67#define B_PCH_SATA_COMMAND_INT_DIS BIT10 // Interrupt Disable\r
68#define B_PCH_SATA_COMMAND_FBE BIT9 // Fast Back-to-back Enable\r
69#define B_PCH_SATA_COMMAND_SERR_EN BIT8 // SERR# Enable\r
70#define B_PCH_SATA_COMMAND_WCC BIT7 // Wait Cycle Enable\r
71#define B_PCH_SATA_COMMAND_PER BIT6 // Parity Error Response Enable\r
72#define B_PCH_SATA_COMMAND_VPS BIT5 // VGA Palette Snooping Enable\r
73#define B_PCH_SATA_COMMAND_PMWE BIT4 // Memory Write and Invalidate Enable\r
74#define B_PCH_SATA_COMMAND_SCE BIT3 // Special Cycle Enable\r
75#define B_PCH_SATA_COMMAND_BME BIT2 // Bus Master Enable\r
76#define B_PCH_SATA_COMMAND_MSE BIT1 // Memory Space Enable\r
77#define B_PCH_SATA_COMMAND_IOSE BIT0 // I/O Space Enable\r
78\r
79#define R_PCH_SATA_PCISTS 0x06 // Device Status\r
80#define B_PCH_SATA_PCISTS_DPE BIT15 // Detected Parity Error\r
81#define B_PCH_SATA_PCISTS_SSE BIT14 // Signaled System Error\r
82#define B_PCH_SATA_PCISTS_RMA BIT13 // Received Master-Abort Status\r
83#define B_PCH_SATA_PCISTS_RTA BIT12 // Received Target-Abort Status\r
84#define B_PCH_SATA_PCISTS_STA BIT11 // Signaled Target-Abort Status\r
85#define B_PCH_SATA_PCISTS_DEV_STS_MASK (BIT10 | BIT9) // DEVSEL# Timing Status\r
86#define B_PCH_SATA_PCISTS_DPED BIT8 // Master Data Parity Error Detected\r
87#define B_PCH_SATA_PCISTS_CAP_LIST BIT4 // Capabilities List\r
88#define B_PCH_SATA_PCISTS_ITNS BIT3 // Interrupt Status\r
89\r
90#define R_PCH_SATA_RID 0x08 // Revision ID (8 bits)\r
91\r
92#define R_PCH_SATA_PI_REGISTER 0x09 // Programming Interface (8 bits)\r
93#define B_PCH_SATA_PI_REGISTER_SNC BIT3 // Secondary Mode Native Capable\r
94#define B_PCH_SATA_PI_REGISTER_SNE BIT2 // Secondary Mode Native Enable\r
95#define B_PCH_SATA_PI_REGISTER_PNC BIT1 // Primary Mode Native Capable\r
96#define B_PCH_SATA_PI_REGISTER_PNE BIT0 // Primary Mode Native Enable\r
97\r
98#define R_PCH_SATA_CC 0x0A // Class Code\r
99#define B_PCH_SATA_CC_BCC 0xFF00 // Base Class Code\r
100#define B_PCH_SATA_CC_SCC 0x00FF // Sub Class Code\r
101#define V_PCH_SATA_CC_SCC_IDE 0x01\r
102#define V_PCH_SATA_CC_SCC_AHCI 0x06\r
103#define V_PCH_SATA_CC_SCC_RAID 0x04\r
104\r
105#define R_PCH_SATA_CLS 0x0C // Cache Line Size (8 bits)\r
106#define B_PCH_SATA_CLS 0xFF\r
107\r
108#define R_PCH_SATA_MLT 0x0D // Master Latency Timer (8 bits)\r
109#define B_PCH_SATA_MLT 0xFF\r
110\r
111#define R_PCH_SATA_HTYPE 0x0E // Header Type\r
112#define B_PCH_SATA_HTYPE_MFD BIT7 // Multi-function Device\r
113#define B_PCH_SATA_HTYPE_HL 0x7F // Header Layout\r
114\r
115#define R_PCH_SATA_PCMD_BAR 0x10 // Primary Command Block Base Address\r
116#define B_PCH_SATA_PCMD_BAR_BA 0x0000FFF8 // Base Address\r
117#define B_PCH_SATA_PCMD_BAR_RTE BIT0 // Resource Type Indicator\r
118\r
119#define R_PCH_SATA_PCTL_BAR 0x14 // Primary Control Block Base Address\r
120#define B_PCH_SATA_PCTL_BAR_BA 0x0000FFFC // Base Address\r
121#define B_PCH_SATA_PCTL_BAR_RTE BIT0 // Resource Type Indicator\r
122\r
123#define R_PCH_SATA_SCMD_BAR 0x18 // Secondary Command Block Base Address\r
124#define B_PCH_SATA_SCMD_BAR_BA 0x0000FFF8 // Base Address\r
125#define B_PCH_SATA_SCMD_BAR_RTE BIT0 // Resource Type Indicator\r
126\r
127#define R_PCH_SATA_SCTL_BAR 0x1C // Secondary Control Block Base Address\r
128#define B_PCH_SATA_SCTL_BAR_BA 0x0000FFFC // Base Address\r
129#define B_PCH_SATA_SCTL_BAR_RTE BIT0 // Resource Type Indicator\r
130\r
131#define R_PCH_SATA_LBAR 0x20 // Legacy IDE Base Address / AHCI Index Data Pair Base Address\r
132#define B_PCH_SATA_LBAR_BA 0x0000FFE0 // Base Address\r
133#define B_PCH_SATA_LBAR_BA4 BIT4 // Base Address 4\r
134#define B_PCH_SATA_LBAR_RTE BIT0 // Resource Type Indicator\r
135\r
136#define R_PCH_SATA_SIDPBA 0x24 // Serial ATA Index Data Pair Base Address\r
137#define R_PCH_SATA_ABAR 0x24 // AHCI Base Address\r
138#define B_PCH_SATA_ABAR_BA 0xFFFFF800 // AHCI Memory Base Address (When CC.SCC not equal 0x01)\r
139#define V_PCH_SATA_ABAR_LENGTH 0x800 // AHCI Memory Length (When CC.SCC not equal 0x01)\r
140#define N_PCH_SATA_ABAR_ALIGNMENT 11 // AHCI Base Address Alignment (When CC.SCC not equal 0x01)\r
141#define B_PCH_SATA_SIDPBA_BA 0x0000FFF0 // Serial ATA Index Data Pair IO Base Address (When CC.SCC equal 0x01)\r
142#define V_PCH_SATA_SIDPBA_LENGTH 0x10 // Serial ATA Index Data Pair IO Length (When CC.SCC equal 0x01)\r
143#define N_PCH_SATA_SIDPBA_ALIGNMENT 4 // Serial ATA Index Data Pair Base Address Alignment (When CC.SCC not equal 0x01)\r
144#define B_PCH_SATA_ABAR_PF BIT3 // Prefetchable\r
145#define B_PCH_SATA_ABAR_TP (BIT2 | BIT1) // Type\r
146#define B_PCH_SATA_ABAR_RTE BIT0 // Resource Type Indicator\r
147\r
148#define R_PCH_SATA_SS 0x2C // Sub System Identifiers\r
149#define B_PCH_SATA_SS_SSID 0xFFFF0000 // Subsystem ID\r
150#define B_PCH_SATA_SS_SSVID 0x0000FFFF // Subsystem Vendor ID\r
151\r
152#define R_PCH_SATA_AHCI_CAP_PTR 0x34 // Capabilities Pointer (8 bits)\r
153#define B_PCH_SATA_AHCI_CAP_PTR 0xFF\r
154\r
155#define R_PCH_SATA_INTR 0x3C // Interrupt Information\r
156#define B_PCH_SATA_INTR_IPIN 0xFFFF0000 // Interrupt Pin\r
157#define B_PCH_SATA_INTR_ILINE 0x0000FFFF // Interrupt Line\r
158\r
159#define R_PCH_SATA_PMCS 0x74 // PCI Power Management Control and Status\r
160#define B_PCH_SATA_PMCS_PMES BIT15 // PME Status\r
161#define B_PCH_SATA_PMCS_PMEE BIT8 // PME Enable\r
162#define B_PCH_SATA_PMCS_NSFRST BIT3 // No Soft Reset\r
163#define V_PCH_SATA_PMCS_NSFRST_1 0x01\r
164#define V_PCH_SATA_PMCS_NSFRST_0 0x00\r
165#define B_PCH_SATA_PMCS_PS (BIT1 | BIT0) // Power State\r
166#define V_PCH_SATA_PMCS_PS_3 0x03\r
167#define V_PCH_SATA_PMCS_PS_0 0x00\r
168\r
169#define R_PCH_SATA_MAP 0x90 // Port Mapping Register\r
170#define B_PCH_SATA_MAP_SPD (BIT14 | BIT13 | BIT12 | BIT11 | BIT10 | BIT9 | BIT8) // SATA Port Disable\r
171#define B_PCH_SATA_PORT6_DISABLED BIT14\r
172#define B_PCH_SATA_PORT5_DISABLED BIT13\r
173#define B_PCH_SATA_PORT4_DISABLED BIT12\r
174#define B_PCH_SATA_PORT3_DISABLED BIT11\r
175#define B_PCH_SATA_PORT2_DISABLED BIT10\r
176#define B_PCH_SATA_PORT1_DISABLED BIT9\r
177#define B_PCH_SATA_PORT0_DISABLED BIT8\r
178#define B_PCH_SATA_MAP_SMS_MASK (BIT7 | BIT6) // SATA Mode Select\r
179#define V_PCH_SATA_MAP_SMS_IDE 0x00\r
180#define V_PCH_SATA_MAP_SMS_AHCI 0x40\r
181#define V_PCH_SATA_MAP_SMS_RAID 0x80\r
182#define B_PCH_SATA_PORT_TO_CONTROLLER_CFG BIT5 // SATA Port-to-Controller Configuration\r
183\r
184#define R_PCH_SATA_PCS 0x92 // Port Control and Status\r
185#define S_PCH_SATA_PCS 0x2\r
186#define B_PCH_SATA_PCS_OOB_RETRY BIT15 // OOB Retry Mode\r
187#define B_PCH_SATA_PCS_PORT6_DET BIT14 // Port 6 Present\r
188#define B_PCH_SATA_PCS_PORT5_DET BIT13 // Port 5 Present\r
189#define B_PCH_SATA_PCS_PORT4_DET BIT12 // Port 4 Present\r
190#define B_PCH_SATA_PCS_PORT3_DET BIT11 // Port 3 Present\r
191#define B_PCH_SATA_PCS_PORT2_DET BIT10 // Port 2 Present\r
192#define B_PCH_SATA_PCS_PORT1_DET BIT9 // Port 1 Present\r
193#define B_PCH_SATA_PCS_PORT0_DET BIT8 // Port 0 Present\r
194#define B_PCH_SATA_PCS_PORT5_EN BIT5 // Port 5 Enabled\r
195#define B_PCH_SATA_PCS_PORT4_EN BIT4 // Port 4 Enabled\r
196#define B_PCH_SATA_PCS_PORT3_EN BIT3 // Port 3 Enabled\r
197#define B_PCH_SATA_PCS_PORT2_EN BIT2 // Port 2 Enabled\r
198#define B_PCH_SATA_PCS_PORT1_EN BIT1 // Port 1 Enabled\r
199#define B_PCH_SATA_PCS_PORT0_EN BIT0 // Port 0 Enabled\r
200\r
201#define R_PCH_SATA_AHCI_PI 0x0C // Ports Implemented\r
202#define B_PCH_SATA_PORT_MASK 0x3F\r
203#define B_PCH_SATA_PORT5_IMPLEMENTED BIT5 // Port 5 Implemented\r
204#define B_PCH_SATA_PORT4_IMPLEMENTED BIT4 // Port 4 Implemented\r
205#define B_PCH_SATA_PORT3_IMPLEMENTED BIT3 // Port 3 Implemented\r
206#define B_PCH_SATA_PORT2_IMPLEMENTED BIT2 // Port 2 Implemented\r
207#define B_PCH_SATA_PORT1_IMPLEMENTED BIT1 // Port 1 Implemented\r
208#define B_PCH_SATA_PORT0_IMPLEMENTED BIT0 // Port 0 Implemented\r
209\r
210#define R_PCH_SATA_AHCI_P0SSTS 0x128 // Port 0 Serial ATA Status\r
211#define R_PCH_SATA_AHCI_P1SSTS 0x1A8 // Port 1 Serial ATA Status\r
212#define B_PCH_SATA_AHCI_PXSSTS_IPM 0x00000F00 // Interface Power Management\r
213#define B_PCH_SATA_AHCI_PXSSTS_IPM_0 0x00000000\r
214#define B_PCH_SATA_AHCI_PXSSTS_IPM_1 0x00000100\r
215#define B_PCH_SATA_AHCI_PXSSTS_IPM_2 0x00000200\r
216#define B_PCH_SATA_AHCI_PXSSTS_IPM_6 0x00000600\r
217#define B_PCH_SATA_AHCI_PXSSTS_SPD 0x000000F0 // Current Interface Speed\r
218#define B_PCH_SATA_AHCI_PXSSTS_SPD_0 0x00000000\r
219#define B_PCH_SATA_AHCI_PXSSTS_SPD_1 0x00000010\r
220#define B_PCH_SATA_AHCI_PXSSTS_SPD_2 0x00000020\r
221#define B_PCH_SATA_AHCI_PXSSTS_SPD_3 0x00000030\r
222#define B_PCH_SATA_AHCI_PXSSTS_DET 0x0000000F // Device Detection\r
223#define B_PCH_SATA_AHCI_PXSSTS_DET_0 0x00000000\r
224#define B_PCH_SATA_AHCI_PXSSTS_DET_1 0x00000001\r
225#define B_PCH_SATA_AHCI_PXSSTS_DET_3 0x00000003\r
226#define B_PCH_SATA_AHCI_PXSSTS_DET_4 0x00000004\r
227\r
228//\r
229// Macros of VLV capabilities for SATA controller which are used by SATA controller driver\r
230//\r
231//\r
232//\r
233// Define the individual capabilities of each SATA controller\r
234//\r
235#define PCH_SATA_MAX_CONTROLLERS 1 // Max SATA controllers number supported\r
236#define PCH_SATA_MAX_DEVICES 2 // Max SATA devices number of single SATA channel\r
237#define PCH_IDE_MAX_CHANNELS 2 // Max IDE channels number of single SATA controller\r
238#define PCH_IDE_MAX_DEVICES 2 // Max IDE devices number of single SATA channel\r
239#define PCH_AHCI_MAX_PORTS 2 // Max number of SATA ports in VLV\r
240#define PCH_IDE_MAX_PORTS 2 // Max number of IDE ports in VLV\r
241\r
242//\r
243// GPIOS_14 SATA0GP is the SATA port 0 reset pin.\r
244//\r
245#define PCH_GPIO_SATA_PORT0_RESET 14\r
246//\r
247// GPIOS_15 SATA1GP is the SATA port 1 reset pin.\r
248//\r
249#define PCH_GPIO_SATA_PORT1_RESET 15\r
250\r
251#endif\r