AMiRo-OS

/*

AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.

Copyright (C) 2016..2019  Thomas Schöpping et al.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

/**

 * @file    aos_types.h

 * @brief   Data types used throughout AMiRo-OS

 *

 * @addtogroup aos_types

 * @{

 */

#ifndef AMIROOS_TYPES_H

#define AMIROOS_TYPES_H

#include <amiroos.h>

/******************************************************************************/

/* CONSTANTS                                                                  */

/******************************************************************************/

/******************************************************************************/

/* SETTINGS                                                                   */

/******************************************************************************/

/******************************************************************************/

/* CHECKS                                                                     */

/******************************************************************************/

/******************************************************************************/

/* DATA STRUCTURES AND TYPES                                                  */

/******************************************************************************/

/**

 * @brief   Error codes used in AMiRo-OS.

 */

typedef enum {

  AOS_OK = 0,                 /**< No error, success. */

  AOS_SUCCESS = 0,            /**< No error, success */

  AOS_WARNING = 1,            /**< No error, but a warning occurred */

  AOS_INVALID_ARGUMENTS = 2,  /**< No error, but given arguments are invalid */

  AOS_ERROR = 0x80,           /**< An error occurred */

  AOS_FAILURE = 0x80,         /**< An error occurred */

} aos_status_t;

/******************************************************************************/

/* MACROS                                                                     */

/******************************************************************************/

/**

 * @brief   Converts a GPIO pad number to a unique event flag.

 */

#define AOS_IOEVENT_FLAG(pad)                   ((eventflags_t)1 << pad)

/******************************************************************************/

/* EXTERN DECLARATIONS                                                        */

/******************************************************************************/

/******************************************************************************/

/* INLINE FUNCTIONS                                                           */

/******************************************************************************/

#endif /* AMIROOS_TYPES_H */

/** @} */