[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 15/45] hw/core: Add documentation and license comments to reset.h
From: |
Peter Maydell |
Subject: |
[PULL 15/45] hw/core: Add documentation and license comments to reset.h |
Date: |
Tue, 27 Feb 2024 13:32:44 +0000 |
Add the usual boilerplate license/copyright comment to reset.h (using
the text from reset.c), and document the existing functions.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-id: 20240220160622.114437-6-peter.maydell@linaro.org
---
include/sysemu/reset.h | 79 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 79 insertions(+)
diff --git a/include/sysemu/reset.h b/include/sysemu/reset.h
index 609e4d50c26..658a7e091e6 100644
--- a/include/sysemu/reset.h
+++ b/include/sysemu/reset.h
@@ -1,3 +1,29 @@
+/*
+ * Reset handlers.
+ *
+ * Copyright (c) 2003-2008 Fabrice Bellard
+ * Copyright (c) 2016 Red Hat, Inc.
+ * Copyright (c) 2024 Linaro, Ltd.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
#ifndef QEMU_SYSEMU_RESET_H
#define QEMU_SYSEMU_RESET_H
@@ -5,9 +31,62 @@
typedef void QEMUResetHandler(void *opaque);
+/**
+ * qemu_register_reset: Register a callback for system reset
+ * @func: function to call
+ * @opaque: opaque data to pass to @func
+ *
+ * Register @func on the list of functions which are called when the
+ * entire system is reset. The functions are called in the order in
+ * which they are registered.
+ *
+ * In general this function should not be used in new code where possible;
+ * for instance, device model reset is better accomplished using the
+ * methods on DeviceState.
+ *
+ * It is not permitted to register or unregister reset functions from
+ * within the @func callback.
+ *
+ * We assume that the caller holds the BQL.
+ */
void qemu_register_reset(QEMUResetHandler *func, void *opaque);
+
+/**
+ * qemu_register_reset_nosnapshotload: Register a callback for system reset
+ * @func: function to call
+ * @opaque: opaque data to pass to @func
+ *
+ * This is the same as qemu_register_reset(), except that @func is
+ * not called if the reason that the system is being reset is to
+ * put it into a clean state prior to loading a snapshot (i.e. for
+ * SHUTDOWN_CAUSE_SNAPSHOT_LOAD).
+ */
void qemu_register_reset_nosnapshotload(QEMUResetHandler *func, void *opaque);
+
+/**
+ * qemu_unregister_reset: Unregister a system reset callback
+ * @func: function registered with qemu_register_reset()
+ * @opaque: the same opaque data that was passed to qemu_register_reset()
+ *
+ * Undo the effects of a qemu_register_reset(). The @func and @opaque
+ * must both match the arguments originally used with qemu_register_reset().
+ *
+ * We assume that the caller holds the BQL.
+ */
void qemu_unregister_reset(QEMUResetHandler *func, void *opaque);
+
+/**
+ * qemu_devices_reset: Perform a complete system reset
+ * @reason: reason for the reset
+ *
+ * This function performs the low-level work needed to do a complete reset
+ * of the system (calling all the callbacks registered with
+ * qemu_register_reset()). It should only be called by the code in a
+ * MachineClass reset method.
+ *
+ * If you want to trigger a system reset from, for instance, a device
+ * model, don't use this function. Use qemu_system_reset_request().
+ */
void qemu_devices_reset(ShutdownCause reason);
#endif
--
2.34.1
- [PULL 01/45] hw/arm/sbsa-ref: Simplify init since PCIe is always enabled, (continued)
- [PULL 01/45] hw/arm/sbsa-ref: Simplify init since PCIe is always enabled, Peter Maydell, 2024/02/27
- [PULL 02/45] target/arm: Advertise Cortex-A53 erratum #843419 fix via REVIDR, Peter Maydell, 2024/02/27
- [PULL 03/45] MAINTAINERS: Cover hw/ide/ahci-allwinner.c with AllWinner A10 machine, Peter Maydell, 2024/02/27
- [PULL 08/45] tests/qtest: Check that EXTI fan-in irqs are correctly connected, Peter Maydell, 2024/02/27
- [PULL 10/45] block: m25p80: Add support of mt35xu02gbba, Peter Maydell, 2024/02/27
- [PULL 04/45] misc: m48t59: replace qemu_system_reset_request() call with watchdog_perform_action(), Peter Maydell, 2024/02/27
- [PULL 06/45] xlnx-versal-ospi: disable reentrancy detection for iomem_dac, Peter Maydell, 2024/02/27
- [PULL 18/45] hw/core/reset: Implement qemu_register_reset via qemu_register_resettable, Peter Maydell, 2024/02/27
- [PULL 17/45] hw/core/reset: Add qemu_{register, unregister}_resettable(), Peter Maydell, 2024/02/27
- [PULL 12/45] arm/ptw: Handle atomic updates of page tables entries in MMIO during PTW., Peter Maydell, 2024/02/27
- [PULL 15/45] hw/core: Add documentation and license comments to reset.h,
Peter Maydell <=
- [PULL 07/45] hw/arm: Use TYPE_OR_IRQ when connecting STM32L4x5 EXTI fan-in IRQs, Peter Maydell, 2024/02/27
- [PULL 11/45] arm: xlnx-versal-virt: Add machine property ospi-flash, Peter Maydell, 2024/02/27
- [PULL 13/45] system/bootdevice: Don't unregister reset handler in restore_boot_order(), Peter Maydell, 2024/02/27
- [PULL 21/45] hw/arm/bcm2836: Split out common part of BCM283X classes, Peter Maydell, 2024/02/27
- [PULL 25/45] hw/arm/bcm2838: Add GIC-400 to BCM2838 SoC, Peter Maydell, 2024/02/27
- [PULL 24/45] hw/arm: Introduce BCM2838 SoC, Peter Maydell, 2024/02/27
- [PULL 20/45] docs/devel/reset: Update to discuss system reset, Peter Maydell, 2024/02/27
- [PULL 30/45] hw/arm: Introduce Raspberry PI 4 machine, Peter Maydell, 2024/02/27
- [PULL 35/45] tests/qtest: Add bcm2838 mailbox test stub, Peter Maydell, 2024/02/27
- [PULL 22/45] hw/arm/bcm2853_peripherals: Split out common part of peripherals, Peter Maydell, 2024/02/27