Aravind Vadali / mbed-src-AV

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/mbed_error.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
aravindsv 0:ba7650f404af 1 /* mbed Microcontroller Library
aravindsv 0:ba7650f404af 2 * Copyright (c) 2006-2013 ARM Limited
aravindsv 0:ba7650f404af 3 *
aravindsv 0:ba7650f404af 4 * Licensed under the Apache License, Version 2.0 (the "License");
aravindsv 0:ba7650f404af 5 * you may not use this file except in compliance with the License.
aravindsv 0:ba7650f404af 6 * You may obtain a copy of the License at
aravindsv 0:ba7650f404af 7 *
aravindsv 0:ba7650f404af 8 * http://www.apache.org/licenses/LICENSE-2.0
aravindsv 0:ba7650f404af 9 *
aravindsv 0:ba7650f404af 10 * Unless required by applicable law or agreed to in writing, software
aravindsv 0:ba7650f404af 11 * distributed under the License is distributed on an "AS IS" BASIS,
aravindsv 0:ba7650f404af 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
aravindsv 0:ba7650f404af 13 * See the License for the specific language governing permissions and
aravindsv 0:ba7650f404af 14 * limitations under the License.
aravindsv 0:ba7650f404af 15 */
aravindsv 0:ba7650f404af 16 #ifndef MBED_ERROR_H
aravindsv 0:ba7650f404af 17 #define MBED_ERROR_H
aravindsv 0:ba7650f404af 18
aravindsv 0:ba7650f404af 19 /** To generate a fatal compile-time error, you can use the pre-processor #error directive.
aravindsv 0:ba7650f404af 20 *
aravindsv 0:ba7650f404af 21 * @code
aravindsv 0:ba7650f404af 22 * #error "That shouldn't have happened!"
aravindsv 0:ba7650f404af 23 * @endcode
aravindsv 0:ba7650f404af 24 *
aravindsv 0:ba7650f404af 25 * If the compiler evaluates this line, it will report the error and stop the compile.
aravindsv 0:ba7650f404af 26 *
aravindsv 0:ba7650f404af 27 * For example, you could use this to check some user-defined compile-time variables:
aravindsv 0:ba7650f404af 28 *
aravindsv 0:ba7650f404af 29 * @code
aravindsv 0:ba7650f404af 30 * #define NUM_PORTS 7
aravindsv 0:ba7650f404af 31 * #if (NUM_PORTS > 4)
aravindsv 0:ba7650f404af 32 * #error "NUM_PORTS must be less than 4"
aravindsv 0:ba7650f404af 33 * #endif
aravindsv 0:ba7650f404af 34 * @endcode
aravindsv 0:ba7650f404af 35 *
aravindsv 0:ba7650f404af 36 * Reporting Run-Time Errors:
aravindsv 0:ba7650f404af 37 * To generate a fatal run-time error, you can use the mbed error() function.
aravindsv 0:ba7650f404af 38 *
aravindsv 0:ba7650f404af 39 * @code
aravindsv 0:ba7650f404af 40 * error("That shouldn't have happened!");
aravindsv 0:ba7650f404af 41 * @endcode
aravindsv 0:ba7650f404af 42 *
aravindsv 0:ba7650f404af 43 * If the mbed running the program executes this function, it will print the
aravindsv 0:ba7650f404af 44 * message via the USB serial port, and then die with the blue lights of death!
aravindsv 0:ba7650f404af 45 *
aravindsv 0:ba7650f404af 46 * The message can use printf-style formatting, so you can report variables in the
aravindsv 0:ba7650f404af 47 * message too. For example, you could use this to check a run-time condition:
aravindsv 0:ba7650f404af 48 *
aravindsv 0:ba7650f404af 49 * @code
aravindsv 0:ba7650f404af 50 * if(x >= 5) {
aravindsv 0:ba7650f404af 51 * error("expected x to be less than 5, but got %d", x);
aravindsv 0:ba7650f404af 52 * }
aravindsv 0:ba7650f404af 53 * #endcode
aravindsv 0:ba7650f404af 54 */
aravindsv 0:ba7650f404af 55
aravindsv 0:ba7650f404af 56 #ifdef __cplusplus
aravindsv 0:ba7650f404af 57 extern "C" {
aravindsv 0:ba7650f404af 58 #endif
aravindsv 0:ba7650f404af 59
aravindsv 0:ba7650f404af 60 void error(const char* format, ...);
aravindsv 0:ba7650f404af 61
aravindsv 0:ba7650f404af 62 #ifdef __cplusplus
aravindsv 0:ba7650f404af 63 }
aravindsv 0:ba7650f404af 64 #endif
aravindsv 0:ba7650f404af 65
aravindsv 0:ba7650f404af 66 #endif