coreboot
coreboot is an Open Source project aimed at replacing the proprietary BIOS found in most computers.
pmc.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 
3 #include <arch/io.h>
4 #include <bootstate.h>
5 #include <console/console.h>
6 #include <device/mmio.h>
7 #include <device/device.h>
8 #include <device/pci_ops.h>
9 #include <intelblocks/pmc.h>
10 #include <intelblocks/pmclib.h>
11 #include <intelblocks/rtc.h>
12 #include <soc/pci_devs.h>
13 #include <soc/pm.h>
14 
15 #include "chip.h"
16 
17 /* Fill up PMC resource structure */
19 {
23  cfg->abase_offset = ABASE;
26 
27  return 0;
28 }
29 
30 static void config_deep_sX(uint32_t offset, uint32_t mask, int sx, int enable)
31 {
32  uint32_t reg;
33  uint8_t *pmcbase = pmc_mmio_regs();
34 
35  printk(BIOS_DEBUG, "%sabling Deep S%c\n",
36  enable ? "En" : "Dis", sx + '0');
37  reg = read32(pmcbase + offset);
38  if (enable)
39  reg |= mask;
40  else
41  reg &= ~mask;
42  write32(pmcbase + offset, reg);
43 }
44 
45 static void config_deep_s5(int on_ac, int on_dc)
46 {
47  /* Treat S4 the same as S5. */
52 }
53 
54 static void config_deep_s3(int on_ac, int on_dc)
55 {
58 }
59 
60 static void config_deep_sx(uint32_t deepsx_config)
61 {
62  uint32_t reg;
63  uint8_t *pmcbase = pmc_mmio_regs();
64 
65  reg = read32(pmcbase + DSX_CFG);
66  reg &= ~DSX_CFG_MASK;
67  reg |= deepsx_config;
68  write32(pmcbase + DSX_CFG, reg);
69 }
70 
71 void pmc_soc_init(struct device *dev)
72 {
73  const config_t *config = config_of(dev);
74  uint8_t *const pwrmbase = pmc_mmio_regs();
75  uint32_t reg32;
76 
77  rtc_init();
78 
80  pmc_gpe_init();
81 
82  /* SLP_S4=4s, SLP_S3=50ms, disable SLP_X stretching after SUS loss. */
85 
86  /* Enable SCI and clear SLP requests. */
87  reg32 = inl(ACPI_BASE_ADDRESS + PM1_CNT);
88  reg32 &= ~SLP_TYP;
89  reg32 |= SCI_EN;
90  outl(reg32, ACPI_BASE_ADDRESS + PM1_CNT);
91 
93 
94  config_deep_s3(config->deep_s3_enable_ac, config->deep_s3_enable_dc);
95  config_deep_s5(config->deep_s5_enable_ac, config->deep_s5_enable_dc);
96  config_deep_sx(config->deep_sx_config);
97 
98  /* Clear registers that contain write-1-to-clear bits. */
100  pci_or_config32(dev, GEN_PMCON_B, 0);
101  setbits32(pwrmbase + GBLRST_CAUSE0, 0);
102  setbits32(pwrmbase + GBLRST_CAUSE1, 0);
103 
104  /*
105  * Disable ACPI PM timer based on Kconfig
106  *
107  * Disabling ACPI PM timer is necessary for XTAL OSC shutdown.
108  * Disabling ACPI PM timer also switches off TCO.
109  */
110  if (!CONFIG(USE_PM_ACPI_TIMER))
112 }
113 
114 static void pm1_enable_pwrbtn_smi(void *unused)
115 {
116  /*
117  * Enable power button SMI only before jumping to payload. This ensures
118  * that:
119  * 1. Power button SMI is enabled only after coreboot is done.
120  * 2. On resume path, power button SMI is not enabled and thus avoids
121  * any shutdowns because of power button presses due to power button
122  * press in resume path.
123  */
125 }
126 
128 
129 /*
130  * Check if WAKE# pin is enabled based on DSX_EN_WAKE_PIN setting in
131  * deep_sx_config. If WAKE# pin is not enabled, then PCI Express Wake Disable
132  * bit needs to be set in PM1_EN to avoid unnecessary wakes caused by WAKE#
133  * pin.
134  */
135 static void pm1_handle_wake_pin(void *unused)
136 {
137  const config_t *conf = config_of_soc();
138 
139  /* If WAKE# pin is enabled, bail out early. */
140  if (conf->deep_sx_config & DSX_EN_WAKE_PIN)
141  return;
142 
144 }
145 
#define SCI_EN
Definition: pm.h:30
uint8_t * pmc_mmio_regs(void)
Definition: pmutil.c:142
#define PM1_CNT
Definition: pm.h:27
BOOT_STATE_INIT_ENTRY(BS_DEV_INIT_CHIPS, BS_ON_EXIT, pm1_enable_pwrbtn_smi, NULL)
int pmc_soc_get_resources(struct pmc_resource_config *cfg)
Definition: pmc.c:15
void pmc_soc_init(struct device *dev)
Definition: pmc.c:80
static void write32(void *addr, uint32_t val)
Definition: mmio.h:40
static uint32_t read32(const void *addr)
Definition: mmio.h:22
@ BS_PAYLOAD_LOAD
Definition: bootstate.h:88
@ BS_OS_RESUME
Definition: bootstate.h:86
@ BS_ON_EXIT
Definition: bootstate.h:96
#define PWRBTN_EN
Definition: southbridge.h:36
#define PCIEXPWAK_DIS
Definition: southbridge.h:34
#define printk(level,...)
Definition: stdlib.h:16
u32 inl(u16 port)
void outl(u32 val, u16 port)
@ CONFIG
Definition: dsi_common.h:201
static size_t offset
Definition: flashconsole.c:16
static DEVTREE_CONST void * config_of(const struct device *dev)
Definition: device.h:382
#define config_of_soc()
Definition: device.h:394
#define setbits32(addr, set)
Definition: mmio.h:21
#define setbits8(addr, set)
Definition: mmio.h:19
static __always_inline void pci_or_config32(const struct device *dev, u16 reg, u32 ormask)
Definition: pci_ops.h:191
static __always_inline void pci_update_config32(const struct device *dev, u16 reg, u32 mask, u32 or)
Definition: pci_ops.h:120
#define PCH_PWRM_BASE_ADDRESS
Definition: iomap.h:70
#define PCH_PWRM_BASE_SIZE
Definition: iomap.h:71
#define ACPI_BASE_ADDRESS
Definition: iomap.h:99
#define ACPI_BASE_SIZE
Definition: iomap.h:100
#define S3DC_GATE_SUS
Definition: pmc.h:84
#define S4_PWRGATE_POL
Definition: pmc.h:87
#define S4DC_GATE_SUS
Definition: pmc.h:88
#define ACPI_TIM_DIS
Definition: pmc.h:108
#define S3AC_GATE_SUS
Definition: pmc.h:85
#define GBLRST_CAUSE0
Definition: pmc.h:131
#define S3_PWRGATE_POL
Definition: pmc.h:83
#define GEN_PMCON_B
Definition: pmc.h:53
#define DSX_CFG_MASK
Definition: pmc.h:101
#define S5_PWRGATE_POL
Definition: pmc.h:91
#define S5AC_GATE_SUS
Definition: pmc.h:93
#define DSX_EN_WAKE_PIN
Definition: pmc.h:98
#define S4MAW_MASK
Definition: pmc.h:40
#define PCH_PWRM_ACPI_TMR_CTL
Definition: pmc.h:107
#define SLP_S3_MIN_ASST_WDTH_50MS
Definition: pmc.h:36
#define DIS_SLP_X_STRCH_SUS_UP
Definition: pmc.h:32
#define S4AC_GATE_SUS
Definition: pmc.h:89
#define DSX_CFG
Definition: pmc.h:95
#define GBLRST_CAUSE1
Definition: pmc.h:133
#define ABASE
Definition: pmc.h:11
#define S4MAW_4S
Definition: pmc.h:44
#define S5DC_GATE_SUS
Definition: pmc.h:92
#define PWRMBASE
Definition: pmc.h:10
#define SLP_S3_MIN_ASST_WDTH_MASK
Definition: pmc.h:33
#define SLP_TYP
Definition: pmc.h:64
#define BIOS_DEBUG
BIOS_DEBUG - Verbose output.
Definition: loglevel.h:128
enum board_config config
Definition: memory.c:448
static void pm1_handle_wake_pin(void *unused)
Definition: pmc.c:135
static void config_deep_s5(int on_ac, int on_dc)
Definition: pmc.c:45
static void config_deep_sx(uint32_t deepsx_config)
Definition: pmc.c:60
static void pm1_enable_pwrbtn_smi(void *unused)
Definition: pmc.c:114
static void config_deep_s3(int on_ac, int on_dc)
Definition: pmc.c:54
static void config_deep_sX(uint32_t offset, uint32_t mask, int sx, int enable)
Definition: pmc.c:30
static const int mask[4]
Definition: gpio.c:308
void pmc_set_power_failure_state(bool target_on)
Definition: pmclib.c:623
void pmc_set_acpi_mode(void)
Definition: pmclib.c:754
void pmc_update_pm1_enable(uint16_t events)
Definition: pmclib.c:151
void pmc_gpe_init(void)
Definition: pmclib.c:535
void rtc_init(void)
Definition: rtc.c:29
#define NULL
Definition: stddef.h:19
unsigned int uint32_t
Definition: stdint.h:14
unsigned char uint8_t
Definition: stdint.h:8
Definition: device.h:107
uint8_t abase_offset
Definition: pmc.h:18
size_t abase_size
Definition: pmc.h:22
uintptr_t pwrmbase_addr
Definition: pmc.h:14
uintptr_t abase_addr
Definition: pmc.h:20
size_t pwrmbase_size
Definition: pmc.h:16
uint8_t pwrmbase_offset
Definition: pmc.h:12