amiro-os / core / inc / aos_types.h @ c53ef0b1
History | View | Annotate | Download (3.962 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 Status type generally used in AMiRo-OS.
|
| 50 |
* @details By definition, the most significant bit (MSB) indicates whether an error occurred (e.g. the function call failed).
|
| 51 |
* All other bits can be used to specify the issue in more detail.
|
| 52 |
* If the MSB is unset, all other bits can still be used to indicate and specify non-critical warnings.
|
| 53 |
* As a result, a value of 0 (no bit set) indicates a flawles success.
|
| 54 |
*/
|
| 55 |
typedef uint8_t aos_status_t;
|
| 56 |
|
| 57 |
/**
|
| 58 |
* @brief Success: no error or warning occurred.
|
| 59 |
*/
|
| 60 |
#define AOS_OK ((aos_status_t)0x00u) |
| 61 |
|
| 62 |
/**
|
| 63 |
* @brief Success: no error or warning occurred.
|
| 64 |
*/
|
| 65 |
#define AOS_SUCCESS AOS_OK
|
| 66 |
|
| 67 |
/**
|
| 68 |
* @brief Some unspecified waring occurred.
|
| 69 |
*/
|
| 70 |
#define AOS_WARNING ((aos_status_t)0x01u) |
| 71 |
|
| 72 |
/**
|
| 73 |
* @brief Invalid arguments detected.
|
| 74 |
*/
|
| 75 |
#define AOS_INVALIDARGUMENTS ((aos_status_t)0x02u) |
| 76 |
|
| 77 |
/**
|
| 78 |
* @brief An error occurred.
|
| 79 |
*/
|
| 80 |
#define AOS_ERROR ((aos_status_t)(1 << ((sizeof(aos_status_t) * 8) - 1))) |
| 81 |
|
| 82 |
/**
|
| 83 |
* @brief An error occurred.
|
| 84 |
*/
|
| 85 |
#define AOS_FAILURE AOS_ERROR
|
| 86 |
|
| 87 |
/******************************************************************************/
|
| 88 |
/* MACROS */
|
| 89 |
/******************************************************************************/
|
| 90 |
|
| 91 |
/**
|
| 92 |
* @brief Converts a GPIO pad number to a unique event flag.
|
| 93 |
*/
|
| 94 |
#define AOS_GPIOEVENT_FLAG(pad) ((eventflags_t)1 << pad) |
| 95 |
|
| 96 |
/******************************************************************************/
|
| 97 |
/* EXTERN DECLARATIONS */
|
| 98 |
/******************************************************************************/
|
| 99 |
|
| 100 |
/******************************************************************************/
|
| 101 |
/* INLINE FUNCTIONS */
|
| 102 |
/******************************************************************************/
|
| 103 |
|
| 104 |
#endif /* AMIROOS_TYPES_H */ |
| 105 |
|
| 106 |
/** @} */
|