Virtualization
/
opensbi
mirror of https://gitlab.com/qemu-project/opensbi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

lib: Add documentation for sbi_init() API 

This patch adds doxygen style documentation for sbi_init() API.

Signed-off-by: Anup Patel <anup.patel@wdc.com>
This commit is contained in:
Anup Patel 2019-01-14 13:58:29 +05:30 committed by Anup Patel
parent 5ef104062d
commit 5f097cbf07
2 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/sbi/sbi_init.h
View File

@ -14,6 +14,6 @@
struct sbi_scratch; struct sbi_scratch;
void __attribute__((noreturn)) sbi_init(struct sbi_scratch *scratch); void __noreturn sbi_init(struct sbi_scratch *scratch);
#endif #endif

19
lib/sbi_init.c
View File

@ -27,8 +27,7 @@ static const char *logo =
" | |\n" " | |\n"
" |_|\n"; " |_|\n";
static void __attribute__((noreturn)) init_coldboot(struct sbi_scratch *scratch, static void __noreturn init_coldboot(struct sbi_scratch *scratch, u32 hartid)
u32 hartid)
{ {
int rc; int rc;
char str[64]; char str[64];
@ -93,8 +92,7 @@ static void __attribute__((noreturn)) init_coldboot(struct sbi_scratch *scratch,
scratch->next_addr, scratch->next_mode); scratch->next_addr, scratch->next_mode);
} }
static void __attribute__((noreturn)) init_warmboot(struct sbi_scratch *scratch, static void __noreturn init_warmboot(struct sbi_scratch *scratch, u32 hartid)
u32 hartid)
{ {
int rc; int rc;
struct sbi_platform *plat = sbi_platform_ptr(scratch); struct sbi_platform *plat = sbi_platform_ptr(scratch);
@ -141,7 +139,18 @@ static void __attribute__((noreturn)) init_warmboot(struct sbi_scratch *scratch,
static atomic_t coldboot_lottery = ATOMIC_INITIALIZER(0); static atomic_t coldboot_lottery = ATOMIC_INITIALIZER(0);
void __attribute__((noreturn)) sbi_init(struct sbi_scratch *scratch) /**
* Initialize OpenSBI library for current HART and jump to next
* booting stage.
*
* The function expects following:
* 1. The 'mscratch' CSR is pointing to sbi_scratch of current HART
* 2. Stack pointer (SP) is setup for current HART
* 3. All interrupts are disabled in MIE CSR except MSIP
*
* @param scratch pointer to sbi_scratch of current HART
*/
void __noreturn sbi_init(struct sbi_scratch *scratch)
{ {
bool coldboot = FALSE; bool coldboot = FALSE;
u32 hartid = sbi_current_hartid(); u32 hartid = sbi_current_hartid();