From b746178e659df1added87d7f5011f79114fd60b1 Mon Sep 17 00:00:00 2001 From: Jordan Crouse Date: Thu, 28 Aug 2008 23:12:22 +0000 Subject: [PATCH]: libpayload: Document the architecture specific routines No code changes. Signed-off-by: Jordan Crouse Acked-by: Jordan Crouse git-svn-id: svn://svn.coreboot.org/coreboot/trunk@3552 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1 --- payloads/libpayload/include/libpayload.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'payloads/libpayload/include') diff --git a/payloads/libpayload/include/libpayload.h b/payloads/libpayload/include/libpayload.h index 3351fd4927..96eaef2841 100644 --- a/payloads/libpayload/include/libpayload.h +++ b/payloads/libpayload/include/libpayload.h @@ -244,6 +244,7 @@ long int labs(long int j); long long int llabs(long long int j); u8 bin2hex(u8 b); u8 hex2bin(u8 h); +void fatal(const char* msg) __attribute__ ((noreturn)); /** @} */ /** @@ -398,6 +399,8 @@ int lfclose(struct LFILE *file); /** * @defgroup arch Architecture Specific Functions + * This modules contains global architecure specific functions. + * All architectures are expected to define these functions. * @{ */ int get_coreboot_info(struct sysinfo_t *info); @@ -411,9 +414,13 @@ void udelay(unsigned int n); void mdelay(unsigned int n); void delay(unsigned int n); -#define abort() halt() +#define abort() halt() /**< Alias for the halt() function */ + +/** + * Stops executions and halts the processor. This function does + * not return. + */ void halt(void) __attribute__ ((noreturn)); -void fatal(const char* msg) __attribute__ ((noreturn)); /** @} */ /** -- cgit v1.2.3