12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016 |
- /** @file
- Instance of the SBI ecall library.
- It allows calling an SBI function via an ecall from S-Mode.
- The legacy extensions are not included because they are not necessary.
- They would be:
- - SbiLegacySetTimer -> Use SbiSetTimer
- - SbiLegacyConsolePutChar -> No replacement - Use regular UEFI functions
- - SbiLegacyConsoleGetChar -> No replacement - Use regular UEFI functions
- - SbiLegacyClearIpi -> Write 0 to SSIP
- - SbiLegacySendIpi -> Use SbiSendIpi
- - SbiLegacyRemoteFenceI -> Use SbiRemoteFenceI
- - SbiLegacyRemoteSfenceVma -> Use SbiRemoteSfenceVma
- - SbiLegacyRemoteSfenceVmaAsid -> Use SbiRemoteSfenceVmaAsid
- - SbiLegacyShutdown -> Wait for new System Reset extension
- Copyright (c) 2021-2022, Hewlett Packard Development LP. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- @par Revision Reference:
- - OpenSBI Version 0.6
- **/
- #include <IndustryStandard/RiscVOpensbi.h>
- #include <Library/BaseMemoryLib.h>
- #include <Library/DebugLib.h>
- #include <Library/RiscVEdk2SbiLib.h>
- #include <sbi/riscv_asm.h>
- #include <sbi/sbi_hart.h>
- #include <sbi/sbi_types.h>
- #include <sbi/sbi_init.h>
- //
- // Maximum arguments for SBI ecall
- // It's possible to pass more but no SBI call uses more as of SBI 0.2.
- // The additional arguments would have to be passed on the stack instead of as
- // registers, like it's done now.
- //
- #define SBI_CALL_MAX_ARGS 6
- /**
- Call SBI call using ecall instruction.
- Asserts when NumArgs exceeds SBI_CALL_MAX_ARGS.
- @param[in] ExtId SBI extension ID.
- @param[in] FuncId SBI function ID.
- @param[in] NumArgs Number of arguments to pass to the ecall.
- @param[in] ... Argument list for the ecall.
- @retval Returns SBI_RET structure with value and error code.
- **/
- STATIC
- SBI_RET
- EFIAPI
- SbiCall (
- IN UINTN ExtId,
- IN UINTN FuncId,
- IN UINTN NumArgs,
- ...
- )
- {
- UINTN I;
- SBI_RET Ret;
- UINTN Args[SBI_CALL_MAX_ARGS];
- VA_LIST ArgList;
- VA_START (ArgList, NumArgs);
- ASSERT (NumArgs <= SBI_CALL_MAX_ARGS);
- for (I = 0; I < SBI_CALL_MAX_ARGS; I++) {
- if (I < NumArgs) {
- Args[I] = VA_ARG (ArgList, UINTN);
- } else {
- // Default to 0 for all arguments that are not given
- Args[I] = 0;
- }
- }
- VA_END (ArgList);
- register UINTN a0 asm ("a0") = Args[0];
- register UINTN a1 asm ("a1") = Args[1];
- register UINTN a2 asm ("a2") = Args[2];
- register UINTN a3 asm ("a3") = Args[3];
- register UINTN a4 asm ("a4") = Args[4];
- register UINTN a5 asm ("a5") = Args[5];
- register UINTN a6 asm ("a6") = (UINTN)(FuncId);
- register UINTN a7 asm ("a7") = (UINTN)(ExtId);
- asm volatile ("ecall" \
- : "+r" (a0), "+r" (a1) \
- : "r" (a2), "r" (a3), "r" (a4), "r" (a5), "r" (a6), "r" (a7) \
- : "memory"); \
- Ret.Error = a0;
- Ret.Value = a1;
- return Ret;
- }
- /**
- Translate SBI error code to EFI status.
- @param[in] SbiError SBI error code
- @retval EFI_STATUS
- **/
- STATIC
- EFI_STATUS
- EFIAPI
- TranslateError (
- IN UINTN SbiError
- )
- {
- switch (SbiError) {
- case SBI_SUCCESS:
- return EFI_SUCCESS;
- case SBI_ERR_FAILED:
- return EFI_DEVICE_ERROR;
- break;
- case SBI_ERR_NOT_SUPPORTED:
- return EFI_UNSUPPORTED;
- break;
- case SBI_ERR_INVALID_PARAM:
- return EFI_INVALID_PARAMETER;
- break;
- case SBI_ERR_DENIED:
- return EFI_ACCESS_DENIED;
- break;
- case SBI_ERR_INVALID_ADDRESS:
- return EFI_LOAD_ERROR;
- break;
- case SBI_ERR_ALREADY_AVAILABLE:
- return EFI_ALREADY_STARTED;
- break;
- default:
- //
- // Reaches here only if SBI has defined a new error type
- //
- ASSERT (FALSE);
- return EFI_UNSUPPORTED;
- break;
- }
- }
- //
- // OpenSBI library interface function for the base extension
- //
- /**
- Get the implemented SBI specification version
- The minor number of the SBI specification is encoded in the low 24 bits,
- with the major number encoded in the next 7 bits. Bit 32 must be 0 and is
- reserved for future expansion.
- @param[out] SpecVersion The Version of the SBI specification.
- **/
- VOID
- EFIAPI
- SbiGetSpecVersion (
- OUT UINTN *SpecVersion
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_GET_SPEC_VERSION, 0);
- if (!Ret.Error) {
- *SpecVersion = (UINTN)Ret.Value;
- }
- }
- /**
- Get the SBI implementation ID
- This ID is used to identify a specific SBI implementation in order to work
- around any quirks it might have.
- @param[out] ImplId The ID of the SBI implementation.
- **/
- VOID
- EFIAPI
- SbiGetImplId (
- OUT UINTN *ImplId
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_GET_IMP_ID, 0);
- *ImplId = (UINTN)Ret.Value;
- }
- /**
- Get the SBI implementation version
- The version of this SBI implementation.
- The encoding of this number is determined by the specific SBI implementation.
- @param[out] ImplVersion The version of the SBI implementation.
- **/
- VOID
- EFIAPI
- SbiGetImplVersion (
- OUT UINTN *ImplVersion
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_GET_IMP_VERSION, 0);
- *ImplVersion = (UINTN)Ret.Value;
- }
- /**
- Probe whether an SBI extension is available
- ProbeResult is set to 0 if the extension is not available or to an extension
- specified value if it is available.
- @param[in] ExtensionId The extension ID.
- @param[out] ProbeResult The return value of the probe.
- **/
- VOID
- EFIAPI
- SbiProbeExtension (
- IN INTN ExtensionId,
- OUT INTN *ProbeResult
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_PROBE_EXT, 0);
- *ProbeResult = (UINTN)Ret.Value;
- }
- /**
- Get the CPU's vendor ID
- Reads the mvendorid CSR.
- @param[out] MachineVendorId The CPU's vendor ID.
- **/
- VOID
- EFIAPI
- SbiGetMachineVendorId (
- OUT UINTN *MachineVendorId
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_GET_MVENDORID, 0);
- *MachineVendorId = (UINTN)Ret.Value;
- }
- /**
- Get the CPU's architecture ID
- Reads the marchid CSR.
- @param[out] MachineArchId The CPU's architecture ID.
- **/
- VOID
- EFIAPI
- SbiGetMachineArchId (
- OUT UINTN *MachineArchId
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_GET_MARCHID, 0);
- *MachineArchId = (UINTN)Ret.Value;
- }
- /**
- Get the CPU's architecture ID
- Reads the marchid CSR.
- @param[out] MachineImplId The CPU's implementation ID.
- **/
- VOID
- EFIAPI
- SbiGetMachineImplId (
- OUT UINTN *MachineImplId
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_BASE, SBI_EXT_BASE_GET_MIMPID, 0);
- *MachineImplId = (UINTN)Ret.Value;
- }
- //
- // SBI interface function for the hart state management extension
- //
- /**
- Politely ask the SBI to start a given hart.
- This call may return before the hart has actually started executing, if the
- SBI implementation can guarantee that the hart is actually going to start.
- Before the hart jumps to StartAddr, the hart MUST configure PMP if present
- and switch to S-mode.
- @param[in] HartId The id of the hart to start.
- @param[in] StartAddr The physical address, where the hart starts
- executing from.
- @param[in] Priv An XLEN-bit value, which will be in register
- a1 when the hart starts.
- @retval EFI_SUCCESS Hart was stopped and will start executing from StartAddr.
- @retval EFI_LOAD_ERROR StartAddr is not valid, possibly due to following reasons:
- - It is not a valid physical address.
- - The address is prohibited by PMP to run in
- supervisor mode.
- @retval EFI_INVALID_PARAMETER HartId is not a valid hart id
- @retval EFI_ALREADY_STARTED The hart is already running.
- @retval other The start request failed for unknown reasons.
- **/
- EFI_STATUS
- EFIAPI
- SbiHartStart (
- IN UINTN HartId,
- IN UINTN StartAddr,
- IN UINTN Priv
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_HSM,
- SBI_EXT_HSM_HART_START,
- 3,
- HartId,
- StartAddr,
- Priv
- );
- return TranslateError (Ret.Error);
- }
- /**
- Return execution of the calling hart to SBI.
- MUST be called in S-Mode with user interrupts disabled.
- This call is not expected to return, unless a failure occurs.
- @retval EFI_SUCCESS Never occurs. When successful, the call does not return.
- @retval other Failed to stop hard for an unknown reason.
- **/
- EFI_STATUS
- EFIAPI
- SbiHartStop (
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_HSM, SBI_EXT_HSM_HART_STOP, 0);
- return TranslateError (Ret.Error);
- }
- /**
- Get the current status of a hart.
- Since harts can transition between states at any time, the status retrieved
- by this function may already be out of date, once it returns.
- Possible values for HartStatus are:
- 0: STARTED
- 1: STOPPED
- 2: START_REQUEST_PENDING
- 3: STOP_REQUEST_PENDING
- @param[out] HartStatus The pointer in which the hart's status is
- stored.
- @retval EFI_SUCCESS The operation succeeds.
- @retval EFI_INVALID_PARAMETER A parameter is invalid.
- **/
- EFI_STATUS
- EFIAPI
- SbiHartGetStatus (
- IN UINTN HartId,
- OUT UINTN *HartStatus
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EXT_HSM, SBI_EXT_HSM_HART_GET_STATUS, 1, HartId);
- if (!Ret.Error) {
- *HartStatus = (UINTN)Ret.Value;
- }
- return TranslateError (Ret.Error);
- }
- /**
- Clear pending timer interrupt bit and set timer for next event after Time.
- To clear the timer without scheduling a timer event, set Time to a
- practically infinite value or mask the timer interrupt by clearing sie.STIE.
- @param[in] Time The time offset to the next scheduled timer interrupt.
- **/
- VOID
- EFIAPI
- SbiSetTimer (
- IN UINT64 Time
- )
- {
- SbiCall (SBI_EXT_TIME, SBI_EXT_TIME_SET_TIMER, 1, Time);
- }
- EFI_STATUS
- EFIAPI
- SbiSendIpi (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_IPI,
- SBI_EXT_IPI_SEND_IPI,
- 2,
- (UINTN)HartMask,
- HartMaskBase
- );
- return TranslateError (Ret.Error);
- }
- /**
- Instructs remote harts to execute a FENCE.I instruction.
- @param[in] HartMask Scalar bit-vector containing hart ids
- @param[in] HartMaskBase The starting hartid from which the bit-vector
- must be computed. If set to -1, HartMask is
- ignored and all harts are considered.
- @retval EFI_SUCCESS IPI was sent to all the targeted harts.
- @retval EFI_INVALID_PARAMETER Either hart_mask_base or any of the hartid
- from hart_mask is not valid i.e. either the
- hartid is not enabled by the platform or is
- not available to the supervisor.
- **/
- EFI_STATUS
- EFIAPI
- SbiRemoteFenceI (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_RFENCE,
- SBI_EXT_RFENCE_REMOTE_FENCE_I,
- 2,
- (UINTN)HartMask,
- HartMaskBase
- );
- return TranslateError (Ret.Error);
- }
- /**
- Instructs the remote harts to execute one or more SFENCE.VMA instructions.
- The SFENCE.VMA covers the range of virtual addresses between StartAddr and Size.
- The remote fence function acts as a full tlb flush if * StartAddr and size
- are both 0 * size is equal to 2^XLEN-1
- @param[in] HartMask Scalar bit-vector containing hart ids
- @param[in] HartMaskBase The starting hartid from which the bit-vector
- must be computed. If set to -1, HartMask is
- ignored and all harts are considered.
- @param[in] StartAddr The first address of the affected range.
- @param[in] Size How many addresses are affected.
- @retval EFI_SUCCESS IPI was sent to all the targeted harts.
- @retval EFI_LOAD_ERROR StartAddr or Size is not valid.
- @retval EFI_INVALID_PARAMETER Either hart_mask_base or any of the hartid
- from hart_mask is not valid i.e. either the
- hartid is not enabled by the platform or is
- not available to the supervisor.
- **/
- EFI_STATUS
- EFIAPI
- SbiRemoteSfenceVma (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase,
- IN UINTN StartAddr,
- IN UINTN Size
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_RFENCE,
- SBI_EXT_RFENCE_REMOTE_SFENCE_VMA,
- 4,
- (UINTN)HartMask,
- HartMaskBase,
- StartAddr,
- Size
- );
- return TranslateError (Ret.Error);
- }
- /**
- Instructs the remote harts to execute one or more SFENCE.VMA instructions.
- The SFENCE.VMA covers the range of virtual addresses between StartAddr and Size.
- Covers only the given ASID.
- The remote fence function acts as a full tlb flush if * StartAddr and size
- are both 0 * size is equal to 2^XLEN-1
- @param[in] HartMask Scalar bit-vector containing hart ids
- @param[in] HartMaskBase The starting hartid from which the bit-vector
- must be computed. If set to -1, HartMask is
- ignored and all harts are considered.
- @param[in] StartAddr The first address of the affected range.
- @param[in] Size How many addresses are affected.
- @retval EFI_SUCCESS IPI was sent to all the targeted harts.
- @retval EFI_LOAD_ERROR StartAddr or Size is not valid.
- @retval EFI_INVALID_PARAMETER Either hart_mask_base or any of the hartid
- from hart_mask is not valid i.e. either the
- hartid is not enabled by the platform or is
- not available to the supervisor.
- **/
- EFI_STATUS
- EFIAPI
- SbiRemoteSfenceVmaAsid (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase,
- IN UINTN StartAddr,
- IN UINTN Size,
- IN UINTN Asid
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_RFENCE,
- SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID,
- 5,
- (UINTN)HartMask,
- HartMaskBase,
- StartAddr,
- Size,
- Asid
- );
- return TranslateError (Ret.Error);
- }
- /**
- Instructs the remote harts to execute one or more SFENCE.GVMA instructions.
- The SFENCE.GVMA covers the range of virtual addresses between StartAddr and Size.
- Covers only the given VMID.
- This function call is only valid for harts implementing the hypervisor extension.
- The remote fence function acts as a full tlb flush if * StartAddr and size
- are both 0 * size is equal to 2^XLEN-1
- @param[in] HartMask Scalar bit-vector containing hart ids
- @param[in] HartMaskBase The starting hartid from which the bit-vector
- must be computed. If set to -1, HartMask is
- ignored and all harts are considered.
- @param[in] StartAddr The first address of the affected range.
- @param[in] Size How many addresses are affected.
- @retval EFI_SUCCESS IPI was sent to all the targeted harts.
- @retval EFI_LOAD_ERROR StartAddr or Size is not valid.
- @retval EFI_UNSUPPORTED SBI does not implement this function or one
- of the target harts does not support the
- hypervisor extension.
- @retval EFI_INVALID_PARAMETER Either hart_mask_base or any of the hartid
- from hart_mask is not valid i.e. either the
- hartid is not enabled by the platform or is
- not available to the supervisor.
- **/
- EFI_STATUS
- EFIAPI
- SbiRemoteHFenceGvmaVmid (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase,
- IN UINTN StartAddr,
- IN UINTN Size,
- IN UINTN Vmid
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_RFENCE,
- SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA,
- 5,
- (UINTN)HartMask,
- HartMaskBase,
- StartAddr,
- Size,
- Vmid
- );
- return TranslateError (Ret.Error);
- }
- /**
- Instructs the remote harts to execute one or more SFENCE.GVMA instructions.
- The SFENCE.GVMA covers the range of virtual addresses between StartAddr and Size.
- This function call is only valid for harts implementing the hypervisor extension.
- The remote fence function acts as a full tlb flush if * StartAddr and size
- are both 0 * size is equal to 2^XLEN-1
- @param[in] HartMask Scalar bit-vector containing hart ids
- @param[in] HartMaskBase The starting hartid from which the bit-vector
- must be computed. If set to -1, HartMask is
- ignored and all harts are considered.
- @param[in] StartAddr The first address of the affected range.
- @param[in] Size How many addresses are affected.
- @retval EFI_SUCCESS IPI was sent to all the targeted harts.
- @retval EFI_LOAD_ERROR StartAddr or Size is not valid.
- @retval EFI_UNSUPPORTED SBI does not implement this function or one
- of the target harts does not support the
- hypervisor extension.
- @retval EFI_INVALID_PARAMETER Either hart_mask_base or any of the hartid
- from hart_mask is not valid i.e. either the
- hartid is not enabled by the platform or is
- not available to the supervisor.
- **/
- EFI_STATUS
- EFIAPI
- SbiRemoteHFenceGvma (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase,
- IN UINTN StartAddr,
- IN UINTN Size
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_RFENCE,
- SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA_VMID,
- 4,
- (UINTN)HartMask,
- HartMaskBase,
- StartAddr,
- Size
- );
- return TranslateError (Ret.Error);
- }
- /**
- Instructs the remote harts to execute one or more SFENCE.VVMA instructions.
- The SFENCE.GVMA covers the range of virtual addresses between StartAddr and Size.
- Covers only the given ASID.
- This function call is only valid for harts implementing the hypervisor extension.
- The remote fence function acts as a full tlb flush if * StartAddr and size
- are both 0 * size is equal to 2^XLEN-1
- @param[in] HartMask Scalar bit-vector containing hart ids
- @param[in] HartMaskBase The starting hartid from which the bit-vector
- must be computed. If set to -1, HartMask is
- ignored and all harts are considered.
- @param[in] StartAddr The first address of the affected range.
- @param[in] Size How many addresses are affected.
- @retval EFI_SUCCESS IPI was sent to all the targeted harts.
- @retval EFI_LOAD_ERROR StartAddr or Size is not valid.
- @retval EFI_UNSUPPORTED SBI does not implement this function or one
- of the target harts does not support the
- hypervisor extension.
- @retval EFI_INVALID_PARAMETER Either hart_mask_base or any of the hartid
- from hart_mask is not valid i.e. either the
- hartid is not enabled by the platform or is
- not available to the supervisor.
- **/
- EFI_STATUS
- EFIAPI
- SbiRemoteHFenceVvmaAsid (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase,
- IN UINTN StartAddr,
- IN UINTN Size,
- IN UINTN Asid
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_RFENCE,
- SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA,
- 5,
- (UINTN)HartMask,
- HartMaskBase,
- StartAddr,
- Size,
- Asid
- );
- return TranslateError (Ret.Error);
- }
- /**
- Instructs the remote harts to execute one or more SFENCE.VVMA instructions.
- The SFENCE.GVMA covers the range of virtual addresses between StartAddr and Size.
- This function call is only valid for harts implementing the hypervisor extension.
- The remote fence function acts as a full tlb flush if * StartAddr and size
- are both 0 * size is equal to 2^XLEN-1
- @param[in] HartMask Scalar bit-vector containing hart ids
- @param[in] HartMaskBase The starting hartid from which the bit-vector
- must be computed. If set to -1, HartMask is
- ignored and all harts are considered.
- @param[in] StartAddr The first address of the affected range.
- @param[in] Size How many addresses are affected.
- @retval EFI_SUCCESS IPI was sent to all the targeted harts.
- @retval EFI_LOAD_ERROR StartAddr or Size is not valid.
- @retval EFI_UNSUPPORTED SBI does not implement this function or one
- of the target harts does not support the
- hypervisor extension.
- @retval EFI_INVALID_PARAMETER Either hart_mask_base or any of the hartid
- from hart_mask is not valid i.e. either the
- hartid is not enabled by the platform or is
- not available to the supervisor.
- **/
- EFI_STATUS
- EFIAPI
- SbiRemoteHFenceVvma (
- IN UINTN *HartMask,
- IN UINTN HartMaskBase,
- IN UINTN StartAddr,
- IN UINTN Size
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_RFENCE,
- SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA_ASID,
- 4,
- (UINTN)HartMask,
- HartMaskBase,
- StartAddr,
- Size
- );
- return TranslateError (Ret.Error);
- }
- /**
- Reset the system
- The System Reset Extension provides a function that allow the supervisor
- software to request system-level reboot or shutdown. The term "system" refers
- to the world-view of supervisor software and the underlying SBI
- implementation could be machine mode firmware or hypervisor.
- Valid parameters for ResetType and ResetReason are defined in sbi_ecall_interface.h
- #define SBI_SRST_RESET_TYPE_SHUTDOWN 0x0
- #define SBI_SRST_RESET_TYPE_COLD_REBOOT 0x1
- #define SBI_SRST_RESET_TYPE_WARM_REBOOT 0x2
- #define SBI_SRST_RESET_REASON_NONE 0x0
- #define SBI_SRST_RESET_REASON_SYSFAIL 0x1
- When the call is successful, it will not return.
- @param[in] ResetType Typ of reset: Shutdown, cold-, or warm-reset.
- @param[in] ResetReason Why the system resets. No reason or system failure.
- @retval EFI_INVALID_PARAMETER Either ResetType or ResetReason is invalid.
- @retval EFI_UNSUPPORTED ResetType is valid but not implemented on the platform.
- @retval EFI_DEVICE_ERROR Unknown error.
- **/
- EFI_STATUS
- EFIAPI
- SbiSystemReset (
- IN UINTN ResetType,
- IN UINTN ResetReason
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EXT_SRST,
- SBI_EXT_SRST_RESET,
- 2,
- ResetType,
- ResetReason
- );
- return TranslateError (Ret.Error);
- }
- //
- // SBI interface function for the vendor extension
- //
- /**
- Call a function in a vendor defined SBI extension
- ASSERT() if the ExtensionId is not in the designated SBI Vendor Extension
- Space or NumArgs exceeds SBI_CALL_MAX_ARGS.
- @param[in] ExtensionId The SBI vendor extension ID.
- @param[in] FunctionId The function ID to call in this extension.
- @param[in] NumArgs How many arguments are passed.
- @param[in] ... Actual Arguments to the function.
- @retval EFI_SUCCESS if the SBI function was called and it was successful
- @retval others if the called SBI function returns an error
- **/
- EFI_STATUS
- EFIAPI
- SbiVendorCall (
- IN UINTN ExtensionId,
- IN UINTN FunctionId,
- IN UINTN NumArgs,
- ...
- )
- {
- SBI_RET Ret;
- VA_LIST Args;
- VA_START (Args, NumArgs);
- ASSERT (ExtensionId >= SBI_EXT_VENDOR_START && ExtensionId <= SBI_EXT_VENDOR_END);
- ASSERT (NumArgs <= SBI_CALL_MAX_ARGS);
- switch (NumArgs) {
- case 0:
- Ret = SbiCall (ExtensionId, FunctionId, NumArgs);
- break;
- case 1:
- Ret = SbiCall (ExtensionId, FunctionId, NumArgs, VA_ARG (Args, UINTN));
- break;
- case 2:
- Ret = SbiCall (
- ExtensionId,
- FunctionId,
- NumArgs,
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN)
- );
- break;
- case 3:
- Ret = SbiCall (
- ExtensionId,
- FunctionId,
- NumArgs,
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN)
- );
- break;
- case 4:
- Ret = SbiCall (
- ExtensionId,
- FunctionId,
- NumArgs,
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN)
- );
- break;
- case 5:
- Ret = SbiCall (
- ExtensionId,
- FunctionId,
- NumArgs,
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN)
- );
- break;
- case 6:
- Ret = SbiCall (
- ExtensionId,
- FunctionId,
- NumArgs,
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN),
- VA_ARG (Args, UINTN)
- );
- break;
- default:
- // Too many args. In theory SBI can handle more arguments when they are
- // passed on the stack but no SBI extension uses this, therefore it's
- // not yet implemented here.
- return EFI_INVALID_PARAMETER;
- }
- VA_END (Args);
- return TranslateError (Ret.Error);
- }
- //
- // SBI Firmware extension
- //
- /**
- Get scratch space of the current hart.
- Please consider using the wrapper SbiGetFirmwareContext if you only need to
- access the firmware context.
- @param[out] ScratchSpace The scratch space pointer.
- **/
- VOID
- EFIAPI
- SbiGetMscratch (
- OUT SBI_SCRATCH **ScratchSpace
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (SBI_EDK2_FW_EXT, SBI_EXT_FW_MSCRATCH_FUNC, 0);
- // Our ecall handler never returns an error, only when the func id is invalid
- ASSERT (Ret.Error == SBI_OK);
- *ScratchSpace = (SBI_SCRATCH *)Ret.Value;
- }
- /**
- Get scratch space of the given hart id.
- @param[in] HartId The hart id.
- @param[out] ScratchSpace The scratch space pointer.
- **/
- VOID
- EFIAPI
- SbiGetMscratchHartid (
- IN UINTN HartId,
- OUT SBI_SCRATCH **ScratchSpace
- )
- {
- SBI_RET Ret;
- Ret = SbiCall (
- SBI_EDK2_FW_EXT,
- SBI_EXT_FW_MSCRATCH_HARTID_FUNC,
- 1,
- HartId
- );
- // Our ecall handler never returns an error, only when the func id is invalid
- ASSERT (Ret.Error == SBI_OK);
- *ScratchSpace = (SBI_SCRATCH *)Ret.Value;
- }
- /**
- Get firmware context of the calling hart.
- @param[out] FirmwareContext The firmware context pointer.
- @retval EFI_SUCCESS The operation succeeds.
- **/
- VOID
- EFIAPI
- SbiGetFirmwareContext (
- OUT EFI_RISCV_OPENSBI_FIRMWARE_CONTEXT **FirmwareContext
- )
- {
- SBI_SCRATCH *ScratchSpace;
- SBI_PLATFORM *SbiPlatform;
- SbiGetMscratch (&ScratchSpace);
- SbiPlatform = (SBI_PLATFORM *)sbi_platform_ptr (ScratchSpace);
- *FirmwareContext = (EFI_RISCV_OPENSBI_FIRMWARE_CONTEXT *)SbiPlatform->firmware_context;
- }
- /**
- Set firmware context of the calling hart.
- @param[in] FirmwareContext The firmware context pointer.
- **/
- VOID
- EFIAPI
- SbiSetFirmwareContext (
- IN EFI_RISCV_OPENSBI_FIRMWARE_CONTEXT *FirmwareContext
- )
- {
- SBI_SCRATCH *ScratchSpace;
- SBI_PLATFORM *SbiPlatform;
- SbiGetMscratch (&ScratchSpace);
- SbiPlatform = (SBI_PLATFORM *)sbi_platform_ptr (ScratchSpace);
- SbiPlatform->firmware_context = (UINTN)FirmwareContext;
- }
|