Files
OpenCellular/include/panic.h
Randall Spangler fc6b412589 Consolidate emergency debug output
This removes the duplicate uart_emergency_printf() vs. panic_printf()
/ uart_emergency_puts() vs. panic_puts() implementation and saves
~0.5kb of code size.

The other significant change is that uart_flush_output() is now smart
enough to determine if it's in an interrupt; if so, it will spin-flush
the output buffer instead of waiting on the uart interrupt.  This
removes the need for a separate panic_flush().

BUG=chrome-os-partner:15579
BRANCH=none
TEST=crash unaligned; should print well-formatted crash dump

Change-Id: Ifae756203dd1881806be563308077c1d68302e1f
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/36695
2012-10-29 10:36:05 -07:00

104 lines
2.8 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 __CROS_EC_PANIC_H
#define __CROS_EC_PANIC_H
#include <stdarg.h>
/* Data saved across reboots */
struct panic_data {
uint8_t arch; /* Architecture (PANIC_ARCH_*) */
uint8_t struct_version; /* Structure version (currently 1) */
uint8_t flags; /* Flags (PANIC_DATA_FLAG_*) */
uint8_t reserved; /* Reserved; set 0 */
uint32_t regs[11]; /* psp, ipsr, lr, r4-r11 */
uint32_t frame[8]; /* r0-r3, r12, lr, pc, xPSR */
uint32_t mmfs;
uint32_t bfar;
uint32_t mfar;
uint32_t shcsr;
uint32_t hfsr;
uint32_t dfsr;
/*
* These fields go at the END of the struct so we can find it at the
* end of memory.
*/
uint32_t struct_size; /* Size of this struct */
uint32_t magic; /* PANIC_SAVE_MAGIC if valid */
};
#define PANIC_DATA_MAGIC 0x21636e50 /* "Pnc!" */
#define PANIC_ARCH_CORTEX_M 1 /* Cortex-M architecture */
/* Flags for panic_data.flags */
/* panic_data.frame is valid */
#define PANIC_DATA_FLAG_FRAME_VALID (1 << 0)
/* Already printed at console */
#define PANIC_DATA_FLAG_OLD_CONSOLE (1 << 1)
/* Already returned via host command */
#define PANIC_DATA_FLAG_OLD_HOSTCMD (1 << 2)
/**
* 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 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);
/**
* Enable/disable bus fault handler
*
* @param ignored Non-zero if ignoring bus fault
*/
void ignore_bus_fault(int ignored);
/**
* Return a pointer to the saved data from a previous panic.
*
* @param pointer to the panic data, or NULL if none available (for example,
* the last reboot was not caused by a panic).
*/
struct panic_data *panic_get_data(void);
#endif /* __CROS_EC_PANIC_H */