amiro-os / core / inc / aos_types.h @ 3940ba8a
History | View | Annotate | Download (3.221 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 | e545e620 | Thomas Schöpping | * @brief Error codes used in AMiRo-OS.
|
| 50 | */
|
||
| 51 | typedef enum { |
||
| 52 | AOS_OK = 0, /**< No error, success. */ |
||
| 53 | AOS_SUCCESS = 0, /**< No error, success */ |
||
| 54 | AOS_WARNING = 1, /**< No error, but a warning occurred */ |
||
| 55 | AOS_INVALID_ARGUMENTS = 2, /**< No error, but given arguments are invalid */ |
||
| 56 | AOS_ERROR = 0x80, /**< An error occurred */ |
||
| 57 | AOS_FAILURE = 0x80, /**< An error occurred */ |
||
| 58 | } aos_status_t; |
||
| 59 | |||
| 60 | 53710ca3 | Marc Rothmann | |
| 61 | f3ac1c96 | Thomas Schöpping | /******************************************************************************/
|
| 62 | /* MACROS */
|
||
| 63 | /******************************************************************************/
|
||
| 64 | |||
| 65 | /**
|
||
| 66 | * @brief Converts a GPIO pad number to a unique event flag.
|
||
| 67 | */
|
||
| 68 | #define AOS_IOEVENT_FLAG(pad) ((eventflags_t)1 << pad) |
||
| 69 | |||
| 70 | /******************************************************************************/
|
||
| 71 | /* EXTERN DECLARATIONS */
|
||
| 72 | /******************************************************************************/
|
||
| 73 | |||
| 74 | /******************************************************************************/
|
||
| 75 | /* INLINE FUNCTIONS */
|
||
| 76 | /******************************************************************************/
|
||
| 77 | |||
| 78 | 6ff06bbf | Thomas Schöpping | #endif /* AMIROOS_TYPES_H */ |
| 79 | f3ac1c96 | Thomas Schöpping | |
| 80 | 53710ca3 | Marc Rothmann | /** @} */ |