mirror of
https://github.com/riscv-software-src/opensbi.git
synced 2025-08-25 07:41:42 +01:00
6997552ea2
'priv' argument of sbi_hsm_hart_start() and sbi_hsm_hart_suspend() may mislead people to think it stands for 'privilege mode', but it is not. Change it to 'arg1' to clearly indicate the a1 register. Signed-off-by: Bin Meng <bmeng@tinylab.org> Reviewed-by: Samuel Holland <samuel@sholland.org> Tested-by: Samuel Holland <samuel@sholland.org> Reviewed-by: Atish Patra <atishp@rivosinc.com> Reviewed-by: Anup Patel <anup@brainfault.org>
74 lines
2.1 KiB
C
74 lines
2.1 KiB
C
/*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*
|
|
* Copyright (c) 2020 Western Digital Corporation or its affiliates.
|
|
*
|
|
* Authors:
|
|
* Atish Patra <atish.patra@wdc.com>
|
|
*/
|
|
|
|
#ifndef __SBI_HSM_H__
|
|
#define __SBI_HSM_H__
|
|
|
|
#include <sbi/sbi_types.h>
|
|
|
|
/** Hart state managment device */
|
|
struct sbi_hsm_device {
|
|
/** Name of the hart state managment device */
|
|
char name[32];
|
|
|
|
/** Start (or power-up) the given hart */
|
|
int (*hart_start)(u32 hartid, ulong saddr);
|
|
|
|
/**
|
|
* Stop (or power-down) the current hart from running. This call
|
|
* doesn't expect to return if success.
|
|
*/
|
|
int (*hart_stop)(void);
|
|
|
|
/**
|
|
* Put the current hart in platform specific suspend (or low-power)
|
|
* state.
|
|
*
|
|
* For successful retentive suspend, the call will return 0 when
|
|
* the hart resumes normal execution.
|
|
*
|
|
* For successful non-retentive suspend, the hart will resume from
|
|
* the warm boot entry point.
|
|
*/
|
|
int (*hart_suspend)(u32 suspend_type);
|
|
|
|
/**
|
|
* Perform platform-specific actions to resume from a suspended state.
|
|
*
|
|
* This includes restoring any platform state that was lost during
|
|
* non-retentive suspend.
|
|
*/
|
|
void (*hart_resume)(void);
|
|
};
|
|
|
|
struct sbi_domain;
|
|
struct sbi_scratch;
|
|
|
|
const struct sbi_hsm_device *sbi_hsm_get_device(void);
|
|
|
|
void sbi_hsm_set_device(const struct sbi_hsm_device *dev);
|
|
|
|
int sbi_hsm_init(struct sbi_scratch *scratch, u32 hartid, bool cold_boot);
|
|
void __noreturn sbi_hsm_exit(struct sbi_scratch *scratch);
|
|
|
|
int sbi_hsm_hart_start(struct sbi_scratch *scratch,
|
|
const struct sbi_domain *dom,
|
|
u32 hartid, ulong saddr, ulong smode, ulong arg1);
|
|
int sbi_hsm_hart_stop(struct sbi_scratch *scratch, bool exitnow);
|
|
void sbi_hsm_hart_resume_start(struct sbi_scratch *scratch);
|
|
void sbi_hsm_hart_resume_finish(struct sbi_scratch *scratch);
|
|
int sbi_hsm_hart_suspend(struct sbi_scratch *scratch, u32 suspend_type,
|
|
ulong raddr, ulong rmode, ulong arg1);
|
|
int sbi_hsm_hart_get_state(const struct sbi_domain *dom, u32 hartid);
|
|
int sbi_hsm_hart_interruptible_mask(const struct sbi_domain *dom,
|
|
ulong hbase, ulong *out_hmask);
|
|
void sbi_hsm_prepare_next_jump(struct sbi_scratch *scratch, u32 hartid);
|
|
|
|
#endif
|