Statistics
| Branch: | Tag: | Revision:

amiro-os / core / inc / aos_types.h @ e4379628

History | View | Annotate | Download (3.58 KB)

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

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 53710ca3 Marc Rothmann
/**
20
 * @file    aos_types.h
21
 * @brief   Data types used throughout AMiRo-OS
22
 *
23
 * @addtogroup aos_types
24
 * @{
25
 */
26
27 6ff06bbf Thomas Schöpping
#ifndef AMIROOS_TYPES_H
28
#define AMIROOS_TYPES_H
29 e545e620 Thomas Schöpping
30 3940ba8a Thomas Schöpping
#include <amiroos.h>
31 27286ba5 Thomas Schöpping
32 f3ac1c96 Thomas Schöpping
/******************************************************************************/
33
/* CONSTANTS                                                                  */
34
/******************************************************************************/
35
36
/******************************************************************************/
37
/* SETTINGS                                                                   */
38
/******************************************************************************/
39
40
/******************************************************************************/
41
/* CHECKS                                                                     */
42
/******************************************************************************/
43
44
/******************************************************************************/
45
/* DATA STRUCTURES AND TYPES                                                  */
46
/******************************************************************************/
47 dada2194 Thomas Schöpping
48
/**
49 916f8d28 Thomas Schöpping
 * @brief   Error and status type generally used in AMiRo-OS.
50 e545e620 Thomas Schöpping
 */
51 916f8d28 Thomas Schöpping
typedef uint8_t aos_status_t;
52 e545e620 Thomas Schöpping
53 916f8d28 Thomas Schöpping
/**
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 53710ca3 Marc Rothmann
83 f3ac1c96 Thomas Schöpping
/******************************************************************************/
84
/* MACROS                                                                     */
85
/******************************************************************************/
86
87
/**
88
 * @brief   Converts a GPIO pad number to a unique event flag.
89
 */
90 1a8fb642 Thomas Schöpping
#define AOS_GPIOEVENT_FLAG(pad)                 ((eventflags_t)1 << pad)
91 f3ac1c96 Thomas Schöpping
92
/******************************************************************************/
93
/* EXTERN DECLARATIONS                                                        */
94
/******************************************************************************/
95
96
/******************************************************************************/
97
/* INLINE FUNCTIONS                                                           */
98
/******************************************************************************/
99
100 6ff06bbf Thomas Schöpping
#endif /* AMIROOS_TYPES_H */
101 f3ac1c96 Thomas Schöpping
102 53710ca3 Marc Rothmann
/** @} */