Statistics
| Branch: | Tag: | Revision:

amiro-os / core / inc / aos_types.h @ 916f8d28

History | View | Annotate | Download (3.58 KB)

1
/*
2
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
3
Copyright (C) 2016..2019  Thomas Schöpping et al.
4

5
This program is free software: you can redistribute it and/or modify
6
it under the terms of the GNU General Public License as published by
7
the Free Software Foundation, either version 3 of the License, or
8
(at your option) any later version.
9

10
This program is distributed in the hope that it will be useful,
11
but WITHOUT ANY WARRANTY; without even the implied warranty of
12
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
GNU General Public License for more details.
14

15
You should have received a copy of the GNU General Public License
16
along with this program.  If not, see <http://www.gnu.org/licenses/>.
17
*/
18

    
19
/**
20
 * @file    aos_types.h
21
 * @brief   Data types used throughout AMiRo-OS
22
 *
23
 * @addtogroup aos_types
24
 * @{
25
 */
26

    
27
#ifndef AMIROOS_TYPES_H
28
#define AMIROOS_TYPES_H
29

    
30
#include <amiroos.h>
31

    
32
/******************************************************************************/
33
/* CONSTANTS                                                                  */
34
/******************************************************************************/
35

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

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

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

    
48
/**
49
 * @brief   Error and status type generally used in AMiRo-OS.
50
 */
51
typedef uint8_t aos_status_t;
52

    
53
/**
54
 * @brief   Success: no error or warning occurred.
55
 */
56
#define AOS_OK                                  ((aos_status_t)0x00u)
57

    
58
/**
59
 * @brief   Success: no error or warning occurred.
60
 */
61
#define AOS_SUCCESS                             ((aos_status_t)0x00u)
62

    
63
/**
64
 * @brief   Some unspecified waring occurred.
65
 */
66
#define AOS_WARNING                             ((aos_status_t)0x01u)
67

    
68
/**
69
 * @brief   Invalid arguments detected.
70
 */
71
#define AOS_INVALIDARGUMENTS                    ((aos_status_t)0x02u)
72

    
73
/**
74
 * @brief   An error occurred.
75
 */
76
#define AOS_ERROR                               ((aos_status_t)0x80u)
77

    
78
/**
79
 * @brief   An error occurred.
80
 */
81
#define AOS_FAILURE                             ((aos_status_t)0x80u)
82

    
83
/******************************************************************************/
84
/* MACROS                                                                     */
85
/******************************************************************************/
86

    
87
/**
88
 * @brief   Converts a GPIO pad number to a unique event flag.
89
 */
90
#define AOS_IOEVENT_FLAG(pad)                   ((eventflags_t)1 << pad)
91

    
92
/******************************************************************************/
93
/* EXTERN DECLARATIONS                                                        */
94
/******************************************************************************/
95

    
96
/******************************************************************************/
97
/* INLINE FUNCTIONS                                                           */
98
/******************************************************************************/
99

    
100
#endif /* AMIROOS_TYPES_H */
101

    
102
/** @} */