2009-08-16 06:07:24 -07:00
|
|
|
/*
|
2011-03-18 11:38:08 -07:00
|
|
|
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
|
2013-02-02 02:58:09 -08:00
|
|
|
2011,2012,2013 Giovanni Di Sirio.
|
2009-08-16 06:07:24 -07:00
|
|
|
|
|
|
|
This file is part of ChibiOS/RT.
|
|
|
|
|
|
|
|
ChibiOS/RT 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.
|
|
|
|
|
|
|
|
ChibiOS/RT 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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2010-02-06 02:55:53 -08:00
|
|
|
* @file ch.h
|
|
|
|
* @brief ChibiOS/RT main include file.
|
|
|
|
* @details This header includes all the required kernel headers so it is the
|
|
|
|
* only kernel header you usually want to include in your application.
|
|
|
|
*
|
2009-08-29 23:59:43 -07:00
|
|
|
* @addtogroup kernel_info
|
2010-03-16 12:36:21 -07:00
|
|
|
* @details Kernel related info.
|
2009-08-16 06:07:24 -07:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _CH_H_
|
|
|
|
#define _CH_H_
|
|
|
|
|
|
|
|
/**
|
2010-02-20 23:24:53 -08:00
|
|
|
* @brief ChibiOS/RT identification macro.
|
2009-08-16 06:07:24 -07:00
|
|
|
*/
|
|
|
|
#define _CHIBIOS_RT_
|
|
|
|
|
|
|
|
/**
|
2010-02-20 23:24:53 -08:00
|
|
|
* @brief Kernel version string.
|
2009-08-16 06:07:24 -07:00
|
|
|
*/
|
2013-07-22 07:19:09 -07:00
|
|
|
#define CH_KERNEL_VERSION "3.0.0dev"
|
2009-08-16 06:07:24 -07:00
|
|
|
|
2011-08-22 10:18:52 -07:00
|
|
|
/**
|
|
|
|
* @name Kernel version
|
|
|
|
* @{
|
|
|
|
*/
|
2009-08-16 06:07:24 -07:00
|
|
|
/**
|
2010-02-20 23:24:53 -08:00
|
|
|
* @brief Kernel version major number.
|
2009-08-16 06:07:24 -07:00
|
|
|
*/
|
2013-07-22 07:19:09 -07:00
|
|
|
#define CH_KERNEL_MAJOR 3
|
2009-08-16 06:07:24 -07:00
|
|
|
|
|
|
|
/**
|
2010-02-20 23:24:53 -08:00
|
|
|
* @brief Kernel version minor number.
|
2009-08-16 06:07:24 -07:00
|
|
|
*/
|
2013-07-22 07:19:09 -07:00
|
|
|
#define CH_KERNEL_MINOR 0
|
2009-08-16 06:07:24 -07:00
|
|
|
|
|
|
|
/**
|
2010-02-20 23:24:53 -08:00
|
|
|
* @brief Kernel version patch number.
|
2009-08-16 06:07:24 -07:00
|
|
|
*/
|
2013-06-10 04:43:41 -07:00
|
|
|
#define CH_KERNEL_PATCH 0
|
2011-08-22 10:18:52 -07:00
|
|
|
/** @} */
|
2009-08-16 06:07:24 -07:00
|
|
|
|
2012-04-18 09:40:15 -07:00
|
|
|
/**
|
|
|
|
* @name Common constants
|
|
|
|
*/
|
|
|
|
/**
|
|
|
|
* @brief Generic 'false' boolean constant.
|
2009-08-16 06:07:24 -07:00
|
|
|
*/
|
2012-04-18 09:40:15 -07:00
|
|
|
#if !defined(FALSE) || defined(__DOXYGEN__)
|
2013-05-30 09:46:23 -07:00
|
|
|
#define FALSE 0
|
2009-08-16 06:07:24 -07:00
|
|
|
#endif
|
2012-04-18 09:40:15 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Generic 'true' boolean constant.
|
|
|
|
*/
|
|
|
|
#if !defined(TRUE) || defined(__DOXYGEN__)
|
2013-05-30 09:50:03 -07:00
|
|
|
#define TRUE (!FALSE)
|
2009-08-16 06:07:24 -07:00
|
|
|
#endif
|
|
|
|
|
2012-04-18 09:40:15 -07:00
|
|
|
/**
|
|
|
|
* @brief Generic success constant.
|
2013-07-20 00:24:12 -07:00
|
|
|
* @details This constant is functionally equivalent to @p false but more
|
2012-04-18 09:40:15 -07:00
|
|
|
* readable, it can be used as return value of all those functions
|
2013-07-20 00:24:12 -07:00
|
|
|
* returning a @p bool as a status indicator.
|
2012-04-17 11:30:45 -07:00
|
|
|
*/
|
2012-04-18 09:40:15 -07:00
|
|
|
#if !defined(CH_SUCCESS) || defined(__DOXYGEN__)
|
2013-07-20 00:24:12 -07:00
|
|
|
#define CH_SUCCESS false
|
2012-04-17 11:30:45 -07:00
|
|
|
#endif
|
2012-04-18 09:40:15 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Generic failure constant.
|
2013-07-20 00:24:12 -07:00
|
|
|
* @details This constant is functionally equivalent to @p true but more
|
2012-04-18 09:40:15 -07:00
|
|
|
* readable, it can be used as return value of all those functions
|
2013-07-20 00:24:12 -07:00
|
|
|
* returning a @p bool as a status indicator.
|
2012-04-18 09:40:15 -07:00
|
|
|
*/
|
|
|
|
#if !defined(CH_FAILED) || defined(__DOXYGEN__)
|
2013-07-20 00:24:12 -07:00
|
|
|
#define CH_FAILED true
|
2012-04-17 11:30:45 -07:00
|
|
|
#endif
|
2012-04-18 09:40:15 -07:00
|
|
|
/** @} */
|
2012-04-17 11:30:45 -07:00
|
|
|
|
2013-08-10 01:07:43 -07:00
|
|
|
/* Forward declarations.*/
|
2013-07-19 05:22:31 -07:00
|
|
|
typedef struct thread thread_t;
|
2013-08-10 01:07:43 -07:00
|
|
|
typedef struct virtual_timer virtual_timer_t;
|
2013-06-16 09:12:33 -07:00
|
|
|
|
2013-08-19 07:26:38 -07:00
|
|
|
/* This function is special, it must be accessible from all modules.*/
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
void chSysHalt(const char *reason);
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2013-06-16 09:30:00 -07:00
|
|
|
/* Inclusion of all the kernel sub-headers.*/
|
2010-01-17 06:08:48 -08:00
|
|
|
#include "chconf.h"
|
|
|
|
#include "chtypes.h"
|
2013-06-16 05:21:30 -07:00
|
|
|
#include "chdebug.h"
|
2013-07-29 07:31:13 -07:00
|
|
|
#include "chcore.h"
|
2013-07-29 06:36:19 -07:00
|
|
|
#include "chtm.h"
|
2013-07-29 06:28:35 -07:00
|
|
|
#include "chstats.h"
|
2013-07-28 05:15:57 -07:00
|
|
|
#include "chsys.h"
|
2013-08-10 03:17:45 -07:00
|
|
|
#include "chglobal.h"
|
2013-07-28 05:15:57 -07:00
|
|
|
#include "chvt.h"
|
2013-06-16 09:30:00 -07:00
|
|
|
#include "chlists.h"
|
2010-02-27 00:40:21 -08:00
|
|
|
#include "chschd.h"
|
2013-08-16 10:41:56 -07:00
|
|
|
#include "chthreads.h"
|
2013-06-16 09:48:40 -07:00
|
|
|
#include "chregistry.h"
|
2010-02-27 00:40:21 -08:00
|
|
|
#include "chsem.h"
|
2010-10-05 07:05:25 -07:00
|
|
|
#include "chbsem.h"
|
2010-02-27 00:40:21 -08:00
|
|
|
#include "chmtx.h"
|
|
|
|
#include "chcond.h"
|
|
|
|
#include "chevents.h"
|
|
|
|
#include "chmsg.h"
|
|
|
|
#include "chmboxes.h"
|
|
|
|
#include "chmemcore.h"
|
|
|
|
#include "chheap.h"
|
|
|
|
#include "chmempools.h"
|
2010-11-12 10:47:41 -08:00
|
|
|
#include "chdynamic.h"
|
2010-02-27 00:40:21 -08:00
|
|
|
#include "chqueues.h"
|
|
|
|
#include "chstreams.h"
|
2010-08-20 00:40:01 -07:00
|
|
|
|
2009-08-16 06:07:24 -07:00
|
|
|
#endif /* _CH_H_ */
|
|
|
|
|
|
|
|
/** @} */
|