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_thread.h

 * @brief   Thread macros and inline functions.

 *

 * @addtogroup aos_threads

 * @{

 */

#ifndef AMIROOS_THREAD_H

#define AMIROOS_THREAD_H

#include <amiroos.h>

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

/* CONSTANTS                                                                  */

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

/**

 * @brief   Minimum thread priority.

 */

#define AOS_THD_LOWPRIO_MIN           ((tprio_t)(LOWPRIO))

/**

 * @brief   Maximum priority for background threads.

 */

#define AOS_THD_LOWPRIO_MAX           ((tprio_t)(LOWPRIO + ((NORMALPRIO - LOWPRIO) / 2)))

/**

 * @brief   Minimum priority for normal/standard threads.

 */

#define AOS_THD_NORMALPRIO_MIN        ((tprio_t)(AOS_THD_LOWPRIO_MAX + 1))

/**

 * @brief   Maximum priority for normal/standard threads.

 */

#define AOS_THD_NORMALPRIO_MAX        ((tprio_t)(NORMALPRIO))

/**

 * @brief   Minimum priority for important threads.

 */

#define AOS_THD_HIGHPRIO_MIN          ((tprio_t)(NORMALPRIO + 1))

/**

 * @brief   Maximum priority for important threads.

 */

#define AOS_THD_HIGHPRIO_MAX          ((tprio_t)(NORMALPRIO + ((HIGHPRIO - NORMALPRIO) / 2)))

/**

 * @brief   Minimum priority for real-time threads.

 */

#define AOS_THD_RTPRIO_MIN            ((tprio_t)(AOS_THD_HIGHPRIO_MAX + 1))

/**

 * @brief   Maximum priority for real-time threads.

 */

#define AOS_THD_RTPRIO_MAX            ((tprio_t)(HIGHPRIO - 1))

/**

 * @brief   Priority for the system control thread.

 */

#define AOS_THD_CTRLPRIO              ((tprio_t)(HIGHPRIO))

/**

 * @brief   Maximum timeframe that can be slept in system ticks.

 */

#define AOS_THD_MAX_SLEEP_ST          TIME_MAX_INTERVAL

/**

 * @brief   Maximum timeframe that can be slept in seconds.

 */

#define AOS_THD_MAX_SLEEP_S           (chTimeI2S(AOS_THD_MAX_SLEEP_ST) - 1)

/**

 * @brief   Maximum timeframe that can be slept in milliseconds.

 */

#define AOS_THD_MAX_SLEEP_MS          (chTimeI2MS(AOS_THD_MAX_SLEEP_ST) - 1)

/**

 * @brief   Maximum timeframe that can be slept in microseconds.

 */

#define AOS_THD_MAX_SLEEP_US          (chTimeI2US(AOS_THD_MAX_SLEEP_ST) - 1)

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

/* SETTINGS                                                                   */

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

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

/* CHECKS                                                                     */

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

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

/* DATA STRUCTURES AND TYPES                                                  */

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

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

/* MACROS                                                                     */

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

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

/* EXTERN DECLARATIONS                                                        */

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

#if defined(__cplusplus)

extern "C" {

#endif /* defined(_cplusplus) */

  void aosThdSleepUntilS(const aos_timestamp_t t);

#if (AMIROOS_CFG_DBG == true) && (CH_DBG_FILL_THREADS == TRUE)

  size_t aosThdGetStackPeakUtilization(thread_t* thread);

#endif /* (AMIROOS_CFG_DBG == true) && (CH_DBG_FILL_THREADS == TRUE) */

#if defined(__cplusplus)

}

#endif /* defined(_cplusplus) */

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

/* INLINE FUNCTIONS                                                           */

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

/**

 * @brief   Lets the calling thread sleep the specified amount of microseconds.

 *

 * @param[in] us    Time to sleep in microseconds.

 */

static inline void aosThdUSleepS(const aos_interval_t us)

{

  aos_timestamp_t ut;

  aosSysGetUptimeX(&ut);

  ut += us;

  aosThdSleepUntilS(ut);

  return;

}

/**

 * @brief   Lets the calling thread sleep the specified amount of milliseconds.

 *

 * @param[in] ms    Time to sleep in milliseconds.

 */

static inline void aosThdMSleepS(const uint32_t ms)

{

  aos_timestamp_t ut;

  aosSysGetUptimeX(&ut);

  ut += (aos_timestamp_t)ms * MICROSECONDS_PER_MILLISECOND;

  aosThdSleepUntilS(ut);

  return;

}

/**

 * @brief   Lets the calling thread sleep the specified amount of seconds.

 *

 * @param[in] s     Time to sleep in seconds.

 */

static inline void aosThdSSleepS(const uint32_t s)

{

  aos_timestamp_t ut;

  aosSysGetUptimeX(&ut);

  ut += (aos_timestamp_t)s * MICROSECONDS_PER_SECOND;

  aosThdSleepUntilS(ut);

  return;

}

/**

 * @brief   Lets the calling thread sleep the specified amount of seconds.

 *

 * @param[in] s     Time to sleep in seconds.

 */

static inline void aosThdSleepS(const float s)

{

  aos_timestamp_t ut;

  aosSysGetUptimeX(&ut);

  ut += (aos_timestamp_t)(s * MICROSECONDS_PER_SECOND);

  aosThdSleepUntilS(ut);

  return;

}

/**

 * @brief   Lets the calling thread sleep the specified amount of microseconds.

 *

 * @param[in] us    Time to sleep in microseconds.

 */

static inline void aosThdUSleep(const uint32_t us)

{

  chSysLock();

  aosThdUSleepS(us);

  chSysUnlock();

  return;

}

/**

 * @brief   Lets the calling thread sleep the specified amount of milliseconds.

 *

 * @param[in] ms    Time to sleep in milliseconds.

 */

static inline void aosThdMSleep(const uint32_t ms)

{

  chSysLock();

  aosThdMSleepS(ms);

  chSysUnlock();

  return;

}

/**

 * @brief   Lets the calling thread sleep the specified amount of seconds.

 *

 * @param[in] s     Time to sleep in seconds.

 */

static inline void aosThdSSleep(const uint32_t s)

{

  chSysLock();

  aosThdSSleepS(s);

  chSysUnlock();

  return;

}

/**

 * @brief   Lets the calling thread sleep the specified amount of seconds.

 *

 * @param[in] s     Time to sleep in seconds.

 */

static inline void aosThdSleep(const float s)

{

  chSysLock();

  aosThdSleepS(s);

  chSysUnlock();

  return;

}

/**

 * @brief   Lets the calling thread sleep until the specifide system uptime.

 *

 * @param[in] t     Deadline until the thread will sleep.

 */

static inline void aosThdSleepUntil(const aos_timestamp_t t)

{

  chSysLock();

  aosThdSleepUntilS(t);

  chSysUnlock();

  return;

}

#if (AMIROOS_CFG_DBG == true) || defined(__DOXYGEN__)

/**

 * @brief   Retrieve the stack size of a specific thread in bytes.

 *

 * @param[in] thread    Thread to retrieve the stack size from.

 *

 * @return  Absolute stack size in bytes.

 */

inline size_t aosThdGetStacksize(thread_t* thread)

{

  aosDbgCheck(thread != NULL);

  /*

   * Working area is structured like:

   *    thread.wabase (LSB)->[ stack | port specific data | thread structure ]

   * See the following macros for details:

   *  - THD_WORKING_AREA

   *  - THD_WORKING_AREA_SIZE

   *  - PORT_WA_SIZE

   */

  return ((uintptr_t)(thread) - (uintptr_t)(thread->wabase)) -

         ((size_t)PORT_GUARD_PAGE_SIZE + sizeof(struct port_intctx) + sizeof(struct port_extctx) + (size_t)PORT_INT_REQUIRED_STACK);

}

#endif /* (AMIROOS_CFG_DBG == true) */

#endif /* AMIROOS_THREAD_H */

/** @} */