summaryrefslogtreecommitdiff
path: root/include/system.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/system.h')
-rw-r--r--include/system.h83
1 files changed, 49 insertions, 34 deletions
diff --git a/include/system.h b/include/system.h
index 0fc0206bb3..f55e091e90 100644
--- a/include/system.h
+++ b/include/system.h
@@ -1,4 +1,4 @@
-/* Copyright 2012 The Chromium OS Authors. All rights reserved.
+/* Copyright 2012 The ChromiumOS Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
@@ -89,6 +89,12 @@ void system_enter_hibernate(uint32_t seconds, uint32_t microseconds);
__test_only void system_common_reset_state(void);
/**
+ * Return the value of reboot_at_shutdown and reset its value, useful for
+ * testing.
+ */
+__test_only enum ec_reboot_cmd system_common_get_reset_reboot_at_shutdown(void);
+
+/**
* @brief Allow tests to manually set the jump data address.
*
* This function allows an override of the location of the jump data (which is
@@ -328,17 +334,17 @@ const char *system_get_build_info(void);
* Hard reset. Cuts power to the entire system. If not present, does a soft
* reset which just resets the core and on-chip peripherals.
*/
-#define SYSTEM_RESET_HARD BIT(0)
+#define SYSTEM_RESET_HARD BIT(0)
/*
* Preserve existing reset flags. Used by flash pre-init when it discovers it
* needs to do a hard reset to clear write protect registers.
*/
-#define SYSTEM_RESET_PRESERVE_FLAGS BIT(1)
+#define SYSTEM_RESET_PRESERVE_FLAGS BIT(1)
/*
* Leave AP off on next reboot, instead of powering it on to do EC software
* sync.
*/
-#define SYSTEM_RESET_LEAVE_AP_OFF BIT(2)
+#define SYSTEM_RESET_LEAVE_AP_OFF BIT(2)
/*
* Indicate that this was a manually triggered reset.
*/
@@ -346,30 +352,33 @@ const char *system_get_build_info(void);
/*
* Wait for reset pin to be driven, rather that resetting ourselves.
*/
-#define SYSTEM_RESET_WAIT_EXT BIT(4)
+#define SYSTEM_RESET_WAIT_EXT BIT(4)
/*
* Indicate that this reset was triggered by an AP watchdog
*/
-#define SYSTEM_RESET_AP_WATCHDOG BIT(5)
+#define SYSTEM_RESET_AP_WATCHDOG BIT(5)
/*
* Stay in RO next reboot, instead of potentially selecting RW during EFS.
*/
-#define SYSTEM_RESET_STAY_IN_RO BIT(6)
+#define SYSTEM_RESET_STAY_IN_RO BIT(6)
/*
* Hibernate reset. Reset EC when wake up from hibernate mode
* (the most power saving mode).
*/
-#define SYSTEM_RESET_HIBERNATE BIT(7)
+#define SYSTEM_RESET_HIBERNATE BIT(7)
/**
* Reset the system.
*
* @param flags Reset flags; see SYSTEM_RESET_* above.
*/
-#ifndef TEST_FUZZ
+#if (defined(TEST_FUZZ) || defined(CONFIG_ZTEST))
+test_mockable
+#else
noreturn
#endif
-void system_reset(int flags);
+ void
+ system_reset(int flags);
/**
* Set a scratchpad register to the specified value.
@@ -440,7 +449,6 @@ __override_proto const char *board_read_serial(void);
*/
__override_proto int board_write_serial(const char *serial);
-
/**
* Optional board-level callback functions to read a unique MAC address per
* chip. Default implementation reads from flash.
@@ -525,7 +533,9 @@ timestamp_t system_get_rtc(void);
#ifdef CONFIG_RTC
void print_system_rtc(enum console_channel channel);
#else
-static inline void print_system_rtc(enum console_channel channel) { }
+static inline void print_system_rtc(enum console_channel channel)
+{
+}
#endif /* !defined(CONFIG_RTC) */
/**
@@ -538,32 +548,31 @@ enum {
/*
* Sleep masks to prevent going in to deep sleep.
*/
- SLEEP_MASK_AP_RUN = BIT(0), /* the main CPU is running */
- SLEEP_MASK_UART = BIT(1), /* UART communication ongoing */
+ SLEEP_MASK_AP_RUN = BIT(0), /* the main CPU is running */
+ SLEEP_MASK_UART = BIT(1), /* UART communication ongoing */
SLEEP_MASK_I2C_CONTROLLER = BIT(2), /* I2C controller comms ongoing */
- SLEEP_MASK_CHARGING = BIT(3), /* Charging loop ongoing */
- SLEEP_MASK_USB_PWR = BIT(4), /* USB power loop ongoing */
- SLEEP_MASK_USB_PD = BIT(5), /* USB PD device connected */
- SLEEP_MASK_SPI = BIT(6), /* SPI communications ongoing */
+ SLEEP_MASK_CHARGING = BIT(3), /* Charging loop ongoing */
+ SLEEP_MASK_USB_PWR = BIT(4), /* USB power loop ongoing */
+ SLEEP_MASK_USB_PD = BIT(5), /* USB PD device connected */
+ SLEEP_MASK_SPI = BIT(6), /* SPI communications ongoing */
SLEEP_MASK_I2C_PERIPHERAL = BIT(7), /* I2C peripheral comms ongoing */
- SLEEP_MASK_FAN = BIT(8), /* Fan control loop ongoing */
+ SLEEP_MASK_FAN = BIT(8), /* Fan control loop ongoing */
SLEEP_MASK_USB_DEVICE = BIT(9), /* Generic USB device in use */
- SLEEP_MASK_PWM = BIT(10), /* PWM output is enabled */
- SLEEP_MASK_PHYSICAL_PRESENCE = BIT(11), /* Physical presence
- * detection ongoing */
- SLEEP_MASK_PLL = BIT(12), /* High-speed PLL in-use */
- SLEEP_MASK_ADC = BIT(13), /* ADC conversion ongoing */
- SLEEP_MASK_EMMC = BIT(14), /* eMMC emulation ongoing */
- SLEEP_MASK_FORCE_NO_DSLEEP = BIT(15), /* Force disable. */
-
+ SLEEP_MASK_PWM = BIT(10), /* PWM output is enabled */
+ SLEEP_MASK_PHYSICAL_PRESENCE = BIT(11), /* Physical presence
+ * detection ongoing */
+ SLEEP_MASK_PLL = BIT(12), /* High-speed PLL in-use */
+ SLEEP_MASK_ADC = BIT(13), /* ADC conversion ongoing */
+ SLEEP_MASK_EMMC = BIT(14), /* eMMC emulation ongoing */
+ SLEEP_MASK_FORCE_NO_DSLEEP = BIT(15), /* Force disable. */
/*
* Sleep masks to prevent using slow speed clock in deep sleep.
*/
- SLEEP_MASK_JTAG = BIT(16), /* JTAG is in use. */
- SLEEP_MASK_CONSOLE = BIT(17), /* Console is in use. */
+ SLEEP_MASK_JTAG = BIT(16), /* JTAG is in use. */
+ SLEEP_MASK_CONSOLE = BIT(17), /* Console is in use. */
- SLEEP_MASK_FORCE_NO_LOW_SPEED = BIT(31) /* Force disable. */
+ SLEEP_MASK_FORCE_NO_LOW_SPEED = BIT(31) /* Force disable. */
};
/*
@@ -578,10 +587,9 @@ extern atomic_t sleep_mask;
*/
#ifndef CONFIG_LOW_POWER_S0
-#define DEEP_SLEEP_ALLOWED (!(sleep_mask & 0x0000ffff))
+#define DEEP_SLEEP_ALLOWED (!(sleep_mask & 0x0000ffff))
#else
-#define DEEP_SLEEP_ALLOWED (!(sleep_mask & 0x0000ffff & \
- (~SLEEP_MASK_AP_RUN)))
+#define DEEP_SLEEP_ALLOWED (!(sleep_mask & 0x0000ffff & (~SLEEP_MASK_AP_RUN)))
#endif
#define LOW_SPEED_DEEP_SLEEP_ALLOWED (!(sleep_mask & 0xffff0000))
@@ -650,6 +658,13 @@ void disable_deep_sleep(void);
void enable_deep_sleep(void);
/**
+ * This function is made visible for tests only, it allows overriding the RTC.
+ *
+ * @param seconds
+ */
+void system_set_rtc(uint32_t seconds);
+
+/**
* Use hibernate module to set up an RTC interrupt at a given
* time from now
*
@@ -761,4 +776,4 @@ uint32_t flash_get_rw_offset(enum ec_image copy);
*/
void system_compensate_rtc(void);
-#endif /* __CROS_EC_SYSTEM_H */
+#endif /* __CROS_EC_SYSTEM_H */