Fawwaz Nadzmy / mbed-dev

Fork of mbed-dev by mbed official

Committer:
fwndz
Date:
Wed Dec 21 13:29:33 2016 +0000
Revision:
153:da99e106a1c2
Parent:
149:156823d33999
init

Who changed what in which revision?

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