amiro-os / core / inc / aos_types.h @ ded1ded7
History | View | Annotate | Download (3.962 KB)
| 1 | e545e620 | Thomas Schöpping | /*
|
|---|---|---|---|
| 2 | AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
|
||
| 3 | 96621a83 | Thomas Schöpping | Copyright (C) 2016..2020 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 | 916f8d28 | Thomas Schöpping | /**
|
| 37 | * @brief Success: no error or warning occurred.
|
||
| 38 | */
|
||
| 39 | #define AOS_OK ((aos_status_t)0x00u) |
||
| 40 | |||
| 41 | /**
|
||
| 42 | * @brief Success: no error or warning occurred.
|
||
| 43 | */
|
||
| 44 | c53ef0b1 | Thomas Schöpping | #define AOS_SUCCESS AOS_OK
|
| 45 | 916f8d28 | Thomas Schöpping | |
| 46 | /**
|
||
| 47 | * @brief Some unspecified waring occurred.
|
||
| 48 | */
|
||
| 49 | #define AOS_WARNING ((aos_status_t)0x01u) |
||
| 50 | |||
| 51 | /**
|
||
| 52 | * @brief Invalid arguments detected.
|
||
| 53 | */
|
||
| 54 | #define AOS_INVALIDARGUMENTS ((aos_status_t)0x02u) |
||
| 55 | |||
| 56 | /**
|
||
| 57 | * @brief An error occurred.
|
||
| 58 | */
|
||
| 59 | c53ef0b1 | Thomas Schöpping | #define AOS_ERROR ((aos_status_t)(1 << ((sizeof(aos_status_t) * 8) - 1))) |
| 60 | 916f8d28 | Thomas Schöpping | |
| 61 | /**
|
||
| 62 | * @brief An error occurred.
|
||
| 63 | */
|
||
| 64 | c53ef0b1 | Thomas Schöpping | #define AOS_FAILURE AOS_ERROR
|
| 65 | 53710ca3 | Marc Rothmann | |
| 66 | f3ac1c96 | Thomas Schöpping | /******************************************************************************/
|
| 67 | ad8a2568 | Thomas Schöpping | /* 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 | f3ac1c96 | Thomas Schöpping | /* MACROS */
|
| 89 | /******************************************************************************/
|
||
| 90 | |||
| 91 | /**
|
||
| 92 | * @brief Converts a GPIO pad number to a unique event flag.
|
||
| 93 | */
|
||
| 94 | cda14729 | Thomas Schöpping | #define AOS_GPIOEVENT_FLAG(pad) ((eventflags_t)1 << pad) |
| 95 | f3ac1c96 | Thomas Schöpping | |
| 96 | /******************************************************************************/
|
||
| 97 | /* EXTERN DECLARATIONS */
|
||
| 98 | /******************************************************************************/
|
||
| 99 | |||
| 100 | /******************************************************************************/
|
||
| 101 | /* INLINE FUNCTIONS */
|
||
| 102 | /******************************************************************************/
|
||
| 103 | |||
| 104 | 6ff06bbf | Thomas Schöpping | #endif /* AMIROOS_TYPES_H */ |
| 105 | f3ac1c96 | Thomas Schöpping | |
| 106 | 53710ca3 | Marc Rothmann | /** @} */ |