Revision ad8a2568

View differences:

core/inc/aos_types.h
33 33
/* CONSTANTS                                                                  */
34 34
/******************************************************************************/
35 35

  
36
/******************************************************************************/
37
/* SETTINGS                                                                   */
38
/******************************************************************************/
39

  
40
/******************************************************************************/
41
/* CHECKS                                                                     */
42
/******************************************************************************/
43

  
44
/******************************************************************************/
45
/* DATA STRUCTURES AND TYPES                                                  */
46
/******************************************************************************/
47

  
48
/**
49
 * @brief   Status type generally used in AMiRo-OS.
50
 * @details By definition, the most significant bit (MSB) indicates whether an error occurred (e.g. the function call failed).
51
 *          All other bits can be used to specify the issue in more detail.
52
 *          If the MSB is unset, all other bits can still be used to indicate and specify non-critical warnings.
53
 *          As a result, a value of 0 (no bit set) indicates a flawles success.
54
 */
55
typedef uint8_t aos_status_t;
56

  
57 36
/**
58 37
 * @brief   Success: no error or warning occurred.
59 38
 */
......
85 64
#define AOS_FAILURE                             AOS_ERROR
86 65

  
87 66
/******************************************************************************/
67
/* SETTINGS                                                                   */
68
/******************************************************************************/
69

  
70
/******************************************************************************/
71
/* CHECKS                                                                     */
72
/******************************************************************************/
73

  
74
/******************************************************************************/
75
/* DATA STRUCTURES AND TYPES                                                  */
76
/******************************************************************************/
77

  
78
/**
79
 * @brief   Status type generally used in AMiRo-OS.
80
 * @details By definition, the most significant bit (MSB) indicates whether an error occurred (e.g. the function call failed).
81
 *          All other bits can be used to specify the issue in more detail.
82
 *          If the MSB is unset, all other bits can still be used to indicate and specify non-critical warnings.
83
 *          As a result, a value of 0 (no bit set) indicates a flawles success.
84
 */
85
typedef uint8_t aos_status_t;
86

  
87
/******************************************************************************/
88 88
/* MACROS                                                                     */
89 89
/******************************************************************************/
90 90

  

Also available in: Unified diff