Files
OpenCellular/include/panic.h
Randall Spangler e2f851aae2 Enable stack overflow checking on all context switches
Changes somewhere in the recent past have caused I2C operations to
consume more stack space.  The current failure mode is that after some
debug command or infrequent battery operation, the system fails.

Clean up and enable stack overflow detection by default, and add a
debug command (disabled by default) to verify overflow detection
works.

This adds several instructions to each context switch, but it's still
fairly inexpensive, and represents only a few percent increase in the
size of svc_handler().  That's better than silent failures.

BUG=chrome-os-partner:23938
BRANCH=none
TEST=Enable CONFIG_CMD_STACKOVERFLOW, then run the 'stackoverflow' command.
     This should cause a stack overflow to be detected in the CONSOLE task.

Change-Id: I9303aee5bd9318f1d92838b399d15fb8f6a2bbf9
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/176113
Reviewed-by: Bill Richardson <wfrichar@chromium.org>
2013-11-07 22:35:56 +00:00

112 lines
3.0 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 2) */
uint8_t flags; /* Flags (PANIC_DATA_FLAG_*) */
uint8_t reserved; /* Reserved; set 0 */
uint32_t regs[12]; /* psp, ipsr, msp, r4-r11, lr(=exc_return).
* In version 1, that was 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 custom panic message and reset
*
* @param msg Panic message
*/
void panic(const char *msg);
/**
* Display a default message and reset
*/
void panic_reboot(void);
/**
* 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 */