Files
OpenCellular/include/panic.h
Simon Glass 3977403642 Add a dedicated panic() function
In addition to ASSERT(), it might be useful to panic() sometimes, so add
a tidy way of doing it which will print a message and reset.

BUG=chrome-os-partner:10149
TEST=manual
Build a special version for snow where the 'rw' command calls panic()
See that a message is produced:
> rw 0
read 0x0 = 0x20001048

** PANIC: Address is 0

Change-Id: I4512c0193f4c1d52d0c256b2deefacf551056fd9
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/25413
2012-06-22 11:12:40 -07:00

89 lines
2.5 KiB
C

/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*
* Panic handling, including displaying a message on the panic reporting
* device, which is currently the UART.
*/
#ifndef __PANIC_H
#include <stdarg.h>
/**
* Write a character to the panic reporting device
*
* This function will not return until the character has left the UART
* data register. Any previously queued UART traffic is displayed first.
*
* @param ch Character to write
*/
void panic_putc(int ch);
/**
* Write a string to the panic reporting device
*
* This function will not return until the string has left the UART
* data register. Any previously queued UART traffic is displayed first.
*
* @param ch Character to write
*/
void panic_puts(const char *s);
/**
* Very basic vprintf() for use in panic situations
*
* We only support %s and %nx where n is the number of hex digits to display.
* Currently we don't even support %d, and it is aimed at small code size.
*
* TODO(sjg@chromium.org): Really what we need is a vsnprintf() that is
* shared between the console UART and panic (and is also available as an
* snprintf()). The only downside is that we would then require a large
* printf() implementation to be always present, whereas presumably now we
* can turn it off.
*
* @param format printf-style format string
* @param args List of arguments to process
*/
void panic_vprintf(const char *format, va_list args);
/**
* Very basic printf() for use in panic situations
*
* See panic_vprintf() for full details
*
* @param format printf-style format string
* @param ... Arguments to process
*/
void panic_printf(const char *format, ...);
/**
* Report an assertion failure and reset
*
* @param msg Assertion expression or other message
* @param func Function name where assertion happened
* @param fname File name where assertion happened
* @param linenum Line number where assertion happened
*/
void panic_assert_fail(const char *msg, const char *func, const char *fname,
int linenum);
/**
* Display a panic message and reset
*
* @param msg Panic message
*/
void panic(const char *msg);
/**
* Report a panic to the panic reporting device
*
* This is exported only to permit use from assembler.
*
* @param msg Panic message
* @param lregs Registers from the exception: psp, ipsr, lr, r4-r11
*/
void report_panic(const char *msg, uint32_t *lregs);
#endif