Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/hal/api/mbed_error.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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