kernel: document arch_printk_char_out()

Used by very early console drivers.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2020-06-16 19:14:54 -07:00 committed by Ioannis Glaropoulos
parent df38b0911c
commit 4855eaa735
1 changed files with 18 additions and 0 deletions

View File

@ -218,6 +218,24 @@ static inline bool arch_is_in_isr(void);
* @{
*/
/**
* Early boot console output hook
*
* Definition of this function is optional. If implemented, any invocation
* of printk() (or logging calls with CONFIG_LOG_MINIMAL which are backed by
* printk) will default to sending characters to this function. It is
* useful for early boot debugging before main serial or console drivers
* come up.
*
* This can be overridden at runtime with __printk_hook_install().
*
* The default __weak implementation of this does nothing.
*
* @param c Character to print
* @return The character printed
*/
int arch_printk_char_out(int c);
/**
* Architecture-specific kernel initialization hook
*