coreboot
coreboot is an Open Source project aimed at replacing the proprietary BIOS found in most computers.
gpio.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
3 #include <intelblocks/gpio.h>
4 #include <intelblocks/pcr.h>
5 #include <soc/pcr_ids.h>
6 #include <soc/pmc.h>
7 
8 static const struct reset_mapping rst_map[] = {
9  { .logical = PAD_CFG0_LOGICAL_RESET_RSMRST, .chipset = 0U << 30 },
10  { .logical = PAD_CFG0_LOGICAL_RESET_DEEP, .chipset = 1U << 30 },
11  { .logical = PAD_CFG0_LOGICAL_RESET_PLTRST, .chipset = 2U << 30 },
12 };
13 
14 static const struct reset_mapping rst_map_com0[] = {
15  { .logical = PAD_CFG0_LOGICAL_RESET_PWROK, .chipset = 0U << 30 },
16  { .logical = PAD_CFG0_LOGICAL_RESET_DEEP, .chipset = 1U << 30 },
17  { .logical = PAD_CFG0_LOGICAL_RESET_PLTRST, .chipset = 2U << 30 },
18  { .logical = PAD_CFG0_LOGICAL_RESET_RSMRST, .chipset = 3U << 30 },
19 };
20 
21 /*
22  * The GPIO driver for Cannonlake on Windows/Linux expects 32 GPIOs per pad
23  * group, regardless of whether or not there is a physical pad for each
24  * exposed GPIO number.
25  *
26  * This results in the OS having a sparse GPIO map, and devices that need
27  * to export an ACPI GPIO must use the OS expected number.
28  *
29  * Not all pins are usable as GPIO and those groups do not have a pad base.
30  *
31  * This layout matches the Linux kernel pinctrl map for CNL-LP at:
32  * linux/drivers/pinctrl/intel/pinctrl-cannonlake.c
33  */
34 static const struct pad_group cnl_community0_groups[] = {
35  INTEL_GPP_BASE(GPP_A0, GPP_A0, ESPI_CLK_LOOPBK, 0), /* GPP_A */
36  INTEL_GPP_BASE(GPP_A0, GPP_B0, GSPI1_CLK_LOOPBK, 32), /* GPP_B */
37  INTEL_GPP_BASE(GPP_A0, GPP_G0, GPP_G7, 64), /* GPP_G */
39 };
40 
41 static const struct pad_group cnl_community1_groups[] = {
42  INTEL_GPP_BASE(GPP_D0, GPP_D0, GSPI2_CLK_LOOPBK, 96), /* GPP_D */
43  INTEL_GPP_BASE(GPP_D0, GPP_F0, GPP_F23, 128), /* GPP_F */
44  INTEL_GPP_BASE(GPP_D0, GPP_H0, GPP_H23, 160), /* GPP_H */
45  INTEL_GPP_BASE(GPP_D0, CNV_BTEN, vSD3_CD_B, 192), /* VGPIO */
46 };
47 
48 /* This community is not visible to the OS */
49 static const struct pad_group cnl_community2_groups[] = {
50  INTEL_GPP(GPD0, GPD0, DRAM_RESET_B), /* GPD */
51 };
52 
53 /* This community is not visible to the OS */
54 static const struct pad_group cnl_community3_groups[] = {
55  INTEL_GPP(HDA_BCLK, HDA_BCLK, I2S1_TXD), /* AZA */
57 };
58 
59 static const struct pad_group cnl_community4_groups[] = {
60  INTEL_GPP_BASE(GPP_C0, GPP_C0, GPP_C23, 256), /* GPP_C */
61  INTEL_GPP_BASE(GPP_C0, GPP_E0, GPP_E23, 288), /* GPP_E */
62  INTEL_GPP(GPP_C0, PCH_TDO, ITP_PMODE), /* JTAG */
63  INTEL_GPP(GPP_C0, EDP_BKLTEN, CL_RST_B), /* HVMOS */
64 };
65 
66 static const struct pad_community cnl_communities[TOTAL_GPIO_COMM] = {
67  /* GPP A, B, G, SPI */
68  [COMM_0] = {
69  .port = PID_GPIOCOM0,
70  .first_pad = GPP_A0,
71  .last_pad = SPI0_CLK_LOOPBK,
72  .num_gpi_regs = NUM_GPIO_COM0_GPI_REGS,
73  .pad_cfg_base = PAD_CFG_BASE,
74  .host_own_reg_0 = HOSTSW_OWN_REG_0,
75  .gpi_int_sts_reg_0 = GPI_INT_STS_0,
76  .gpi_int_en_reg_0 = GPI_INT_EN_0,
77  .gpi_smi_sts_reg_0 = GPI_SMI_STS_0,
78  .gpi_smi_en_reg_0 = GPI_SMI_EN_0,
79  .gpi_nmi_sts_reg_0 = GPI_NMI_STS_0,
80  .gpi_nmi_en_reg_0 = GPI_NMI_EN_0,
81  .max_pads_per_group = GPIO_MAX_NUM_PER_GROUP,
82  .name = "GPP_ABG",
83  .acpi_path = "\\_SB.PCI0.GPIO",
84  .reset_map = rst_map_com0,
85  .num_reset_vals = ARRAY_SIZE(rst_map_com0),
86  .groups = cnl_community0_groups,
87  .num_groups = ARRAY_SIZE(cnl_community0_groups),
88  },
89  /* GPP D, F, H, VGPIO */
90  [COMM_1] = {
91  .port = PID_GPIOCOM1,
92  .first_pad = GPP_D0,
93  .last_pad = vSD3_CD_B,
94  .num_gpi_regs = NUM_GPIO_COM1_GPI_REGS,
95  .pad_cfg_base = PAD_CFG_BASE,
96  .host_own_reg_0 = HOSTSW_OWN_REG_0,
97  .gpi_int_sts_reg_0 = GPI_INT_STS_0,
98  .gpi_int_en_reg_0 = GPI_INT_EN_0,
99  .gpi_smi_sts_reg_0 = GPI_SMI_STS_0,
100  .gpi_smi_en_reg_0 = GPI_SMI_EN_0,
101  .gpi_nmi_sts_reg_0 = GPI_NMI_STS_0,
102  .gpi_nmi_en_reg_0 = GPI_NMI_EN_0,
103  .max_pads_per_group = GPIO_MAX_NUM_PER_GROUP,
104  .name = "GPP_DFH",
105  .acpi_path = "\\_SB.PCI0.GPIO",
106  .reset_map = rst_map,
107  .num_reset_vals = ARRAY_SIZE(rst_map),
108  .groups = cnl_community1_groups,
109  .num_groups = ARRAY_SIZE(cnl_community1_groups),
110  },
111  /* GPD */
112  [COMM_2] = {
113  .port = PID_GPIOCOM2,
114  .first_pad = GPD0,
115  .last_pad = DRAM_RESET_B,
116  .num_gpi_regs = NUM_GPIO_COM2_GPI_REGS,
117  .pad_cfg_base = PAD_CFG_BASE,
118  .host_own_reg_0 = HOSTSW_OWN_REG_0,
119  .gpi_int_sts_reg_0 = GPI_INT_STS_0,
120  .gpi_int_en_reg_0 = GPI_INT_EN_0,
121  .gpi_smi_sts_reg_0 = GPI_SMI_STS_0,
122  .gpi_smi_en_reg_0 = GPI_SMI_EN_0,
123  .gpi_nmi_sts_reg_0 = GPI_NMI_STS_0,
124  .gpi_nmi_en_reg_0 = GPI_NMI_EN_0,
125  .max_pads_per_group = GPIO_MAX_NUM_PER_GROUP,
126  .name = "GPD",
127  .acpi_path = "\\_SB.PCI0.GPIO",
128  .reset_map = rst_map,
129  .num_reset_vals = ARRAY_SIZE(rst_map),
130  .groups = cnl_community2_groups,
131  .num_groups = ARRAY_SIZE(cnl_community2_groups),
132  },
133  /* AZA, CPU */
134  [COMM_3] = {
135  .port = PID_GPIOCOM3,
136  .first_pad = HDA_BCLK,
137  .last_pad = TRIGGER_OUT,
138  .num_gpi_regs = NUM_GPIO_COM3_GPI_REGS,
139  .pad_cfg_base = PAD_CFG_BASE,
140  .host_own_reg_0 = HOSTSW_OWN_REG_0,
141  .gpi_int_sts_reg_0 = GPI_INT_STS_0,
142  .gpi_int_en_reg_0 = GPI_INT_EN_0,
143  .gpi_smi_sts_reg_0 = GPI_SMI_STS_0,
144  .gpi_smi_en_reg_0 = GPI_SMI_EN_0,
145  .gpi_nmi_sts_reg_0 = GPI_NMI_STS_0,
146  .gpi_nmi_en_reg_0 = GPI_NMI_EN_0,
147  .max_pads_per_group = GPIO_MAX_NUM_PER_GROUP,
148  .name = "GP_AC",
149  .acpi_path = "\\_SB.PCI0.GPIO",
150  .reset_map = rst_map,
151  .num_reset_vals = ARRAY_SIZE(rst_map),
152  .groups = cnl_community3_groups,
153  .num_groups = ARRAY_SIZE(cnl_community3_groups),
154  },
155  /* GPP C, E, JTAG, HVMOS */
156  [COMM_4] = {
157  .port = PID_GPIOCOM4,
158  .first_pad = GPP_C0,
159  .last_pad = CL_RST_B,
160  .num_gpi_regs = NUM_GPIO_COM4_GPI_REGS,
161  .pad_cfg_base = PAD_CFG_BASE,
162  .host_own_reg_0 = HOSTSW_OWN_REG_0,
163  .gpi_int_sts_reg_0 = GPI_INT_STS_0,
164  .gpi_int_en_reg_0 = GPI_INT_EN_0,
165  .gpi_smi_sts_reg_0 = GPI_SMI_STS_0,
166  .gpi_smi_en_reg_0 = GPI_SMI_EN_0,
167  .gpi_nmi_sts_reg_0 = GPI_NMI_STS_0,
168  .gpi_nmi_en_reg_0 = GPI_NMI_EN_0,
169  .max_pads_per_group = GPIO_MAX_NUM_PER_GROUP,
170  .name = "GPP_CEJ",
171  .acpi_path = "\\_SB.PCI0.GPIO",
172  .reset_map = rst_map,
173  .num_reset_vals = ARRAY_SIZE(rst_map),
174  .groups = cnl_community4_groups,
175  .num_groups = ARRAY_SIZE(cnl_community4_groups),
176  }
177 };
178 
179 const struct pad_community *soc_gpio_get_community(size_t *num_communities)
180 {
181  *num_communities = ARRAY_SIZE(cnl_communities);
182  return cnl_communities;
183 }
184 
185 const struct pmc_to_gpio_route *soc_pmc_gpio_routes(size_t *num)
186 {
187  static const struct pmc_to_gpio_route routes[] = {
188  { PMC_GPP_A, GPP_A },
189  { PMC_GPP_B, GPP_B },
190  { PMC_GPP_C, GPP_C },
191  { PMC_GPP_D, GPP_D },
192  { PMC_GPP_E, GPP_E },
193  { PMC_GPP_F, GPP_F },
194  { PMC_GPP_G, GPP_G },
195  { PMC_GPP_H, GPP_H },
196  { PMC_GPD, GPD },
197  };
198  *num = ARRAY_SIZE(routes);
199  return routes;
200 }
#define GPIO_MAX_NUM_PER_GROUP
Definition: gpio_soc_defs.h:31
#define COMM_0
Definition: gpio_soc_defs.h:33
#define GPP_D
Definition: gpio_soc_defs.h:26
#define GPP_A
Definition: gpio_soc_defs.h:16
#define GPP_E0
#define GPP_F23
#define GPP_F0
#define GPP_B
Definition: gpio_soc_defs.h:14
#define GPD0
#define GPP_C23
#define TOTAL_GPIO_COMM
#define COMM_1
Definition: gpio_soc_defs.h:34
#define GPP_E23
#define GPP_A0
#define COMM_3
Definition: gpio_soc_defs.h:36
#define GPP_H0
#define GPP_C
Definition: gpio_soc_defs.h:28
#define GPP_D0
#define GPP_B0
Definition: gpio_soc_defs.h:53
#define GPP_F
Definition: gpio_soc_defs.h:27
#define GPP_E
Definition: gpio_soc_defs.h:29
#define GPD
Definition: gpio_soc_defs.h:18
#define GPP_H
Definition: gpio_soc_defs.h:24
#define COMM_4
Definition: gpio_soc_defs.h:37
#define GPP_C0
#define COMM_2
Definition: gpio_soc_defs.h:35
#define GPP_H23
#define PID_GPIOCOM4
Definition: pcr_ids.h:19
#define PID_GPIOCOM2
Definition: pcr_ids.h:17
#define PID_GPIOCOM3
Definition: pcr_ids.h:18
#define ARRAY_SIZE(a)
Definition: helpers.h:12
#define CNV_BTEN
#define EDP_BKLTEN
#define I2S1_TXD
#define GPP_G7
Definition: gpio_soc_defs.h:95
#define SPI0_CLK_LOOPBK
#define DRAM_RESET_B
#define CL_RST_B
#define vSD3_CD_B
#define GSPI2_CLK_LOOPBK
#define HDACPU_SDI
#define PCH_TDO
#define SPI0_IO_2
Definition: gpio_soc_defs.h:97
#define ITP_PMODE
#define GSPI1_CLK_LOOPBK
Definition: gpio_soc_defs.h:86
#define GPP_G0
Definition: gpio_soc_defs.h:88
#define TRIGGER_OUT
#define ESPI_CLK_LOOPBK
Definition: gpio_soc_defs.h:59
#define HDA_BCLK
#define GPP_G
Definition: gpio_soc_defs.h:13
@ PID_GPIOCOM0
Definition: pcr.h:17
@ PID_GPIOCOM1
Definition: pcr.h:18
#define PMC_GPP_H
Definition: pmc.h:124
#define PMC_GPP_B
Definition: pmc.h:113
#define PMC_GPD
Definition: pmc.h:117
#define PMC_GPP_F
Definition: pmc.h:127
#define PMC_GPP_D
Definition: pmc.h:125
#define PMC_GPP_E
Definition: pmc.h:129
#define PMC_GPP_A
Definition: pmc.h:115
#define PMC_GPP_C
Definition: pmc.h:128
#define PMC_GPP_G
Definition: pmc.h:137
const struct pmc_to_gpio_route * soc_pmc_gpio_routes(size_t *num)
Definition: gpio.c:247
const struct pad_community * soc_gpio_get_community(size_t *num_communities)
Definition: gpio.c:241
#define NUM_GPIO_COM1_GPI_REGS
Definition: gpio_defs.h:17
#define NUM_GPIO_COM3_GPI_REGS
Definition: gpio_defs.h:19
#define GPI_INT_EN_0
Definition: gpio_defs.h:346
#define GPI_INT_STS_0
Definition: gpio_defs.h:345
#define NUM_GPIO_COM2_GPI_REGS
Definition: gpio_defs.h:18
#define NUM_GPIO_COM4_GPI_REGS
Definition: gpio_defs.h:20
#define HOSTSW_OWN_REG_0
Definition: gpio_defs.h:344
#define NUM_GPIO_COM0_GPI_REGS
Definition: gpio_defs.h:16
#define GPI_SMI_STS_0
Definition: gpio_defs.h:347
#define PAD_CFG_BASE
Definition: gpio_defs.h:349
#define GPI_SMI_EN_0
Definition: gpio_defs.h:348
static const struct pad_group cnl_community1_groups[]
Definition: gpio.c:41
static const struct pad_group cnl_community3_groups[]
Definition: gpio.c:54
static const struct pad_group cnl_community0_groups[]
Definition: gpio.c:34
static const struct reset_mapping rst_map_com0[]
Definition: gpio.c:14
static const struct reset_mapping rst_map[]
Definition: gpio.c:8
static const struct pad_group cnl_community4_groups[]
Definition: gpio.c:59
static const struct pad_community cnl_communities[TOTAL_GPIO_COMM]
Definition: gpio.c:66
static const struct pad_group cnl_community2_groups[]
Definition: gpio.c:49
#define GPI_NMI_EN_0
Definition: gpio_defs.h:240
#define GPI_NMI_STS_0
Definition: gpio_defs.h:239
#define INTEL_GPP_BASE(first_of_community, start_of_group, end_of_group, group_pad_base)
Definition: gpio.h:34
#define INTEL_GPP(first_of_community, start_of_group, end_of_group)
Definition: gpio.h:49
#define PAD_CFG0_LOGICAL_RESET_PWROK
Definition: gpio_defs.h:44
#define PAD_CFG0_LOGICAL_RESET_RSMRST
Definition: gpio_defs.h:47
#define PAD_CFG0_LOGICAL_RESET_PLTRST
Definition: gpio_defs.h:46
#define PAD_CFG0_LOGICAL_RESET_DEEP
Definition: gpio_defs.h:45
uint8_t port
Definition: gpio.h:135
Definition: gpio.h:94
uint32_t logical
Definition: gpio.h:89