/**
 * @file shutdown.h
 *
 * @brief NVRISC-V Shutdown API
 *
 * Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of NVIDIA CORPORATION nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS`` AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef CPU__SHUTDOWN_H
#define CPU__SHUTDOWN_H
#define FSP__CPU__SHUTDOWN_H    1

/*
 * NVRISC-V Shutdown
 * Functionality to halt or shutdown the NVRISC-V core.
 */

#include <misc/gcc_attrs.h>

/**
 * @brief Panic, fatal
 *
 * Halt or shut down the NVRISC-V core. Depending on the configured
 * operating mode the code will either directly modify the registers (M)
 * or use the SBI interface to send a request to the Separation Kernel (S).
 * In the scenario that a proper shutdown fails the function will
 * resort to an infinite loop in place.
 *
 * For additional security, the function is required to not use any
 * stack memory.
 */
void riscv_panic(void) GCC_ATTR_NORETURN;

/**
 * @brief Gentle shutdown
 *
 * Properly shut down the NVRISC-V core. Depending on the configured
 * operating mode the code will either directly modify the registers (M)
 * or use the SBI interface to send a request to the Separation Kernel (S).
 * In the scenario that a proper shutdown fails the function will
 * resort to an infinite loop in place.
 *
 * For additional security, the function is required to not use any
 * stack memory in M-mode.
 */
void riscv_shutdown(void) GCC_ATTR_NORETURN;

#endif /* CPU__SHUTDOWN_H */
/** end of file **/
