Statistics
| Branch: | Tag: | Revision:

amiro-os / core / inc / aos_types.h @ 1678f270

History | View | Annotate | Download (1.54 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
/**
31
 * @brief   Converts a GPIO pad number to a unique event flag.
32
 */
33
#define AOS_IOEVENT_FLAG(pad)                   ((eventflags_t)1 << pad)
34

    
35
/**
36
 * @brief   Error codes used in AMiRo-OS.
37
 */
38
typedef enum {
39
  AOS_OK = 0,                 /**< No error, success. */
40
  AOS_SUCCESS = 0,            /**< No error, success */
41
  AOS_WARNING = 1,            /**< No error, but a warning occurred */
42
  AOS_INVALID_ARGUMENTS = 2,  /**< No error, but given arguments are invalid */
43
  AOS_ERROR = 0x80,           /**< An error occurred */
44
  AOS_FAILURE = 0x80,         /**< An error occurred */
45
} aos_status_t;
46

    
47
#endif /* _AMIROOS_TYPES_H_ */
48

    
49
/** @} */