Skip to content

[RTOS] Added idle hook API #1463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions libraries/rtos/rtos/Thread.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
#include "Thread.h"

#include "mbed_error.h"
#include "rtos_idle.h"

namespace rtos {

Expand Down Expand Up @@ -132,6 +133,13 @@ osThreadId Thread::gettid() {
return osThreadGetId();
}

void Thread::attach_idle_hook(void (*fptr)(void)) {
if (fptr != NULL)
rtos_idle_hook_fptr = fptr;
else
rtos_idle_hook_fptr = &rtos_idle_default_hook;
}

Thread::~Thread() {
terminate();
if (_dynamic_stack) {
Expand Down
5 changes: 5 additions & 0 deletions libraries/rtos/rtos/Thread.h
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@ class Thread {
@return thread ID for reference by other functions or NULL in case of error.
*/
static osThreadId gettid();

/** Attach a function to be called by the RTOS idle task
@param fptr pointer to the function to be called
*/
static void attach_idle_hook(void (*fptr)(void));

virtual ~Thread();

Expand Down
33 changes: 33 additions & 0 deletions libraries/rtos/rtos/rtos_idle.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/* mbed Microcontroller Library
* Copyright (c) 2006-2012 ARM Limited
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#include "rtos_idle.h"

void (*rtos_idle_hook_fptr)(void) = &rtos_idle_default_hook;

void rtos_idle_default_hook(void)
{
/* Sleep: ideally, we should put the chip to sleep.
Unfortunately, this usually requires disconnecting the interface chip (debugger).
This can be done, but it would break the local file system.
*/
// sleep();
}
17 changes: 7 additions & 10 deletions libraries/rtos/rtx/TARGET_ARM7/RTX_Conf_CM.c
Original file line number Diff line number Diff line change
Expand Up @@ -204,17 +204,14 @@
/*----------------------------------------------------------------------------
* OS Idle daemon
*---------------------------------------------------------------------------*/
#include "rtos_idle.h"

void os_idle_demon (void) {
/* The idle demon is a system thread, running when no other thread is */
/* ready to run. */

/* Sleep: ideally, we should put the chip to sleep.
Unfortunately, this usually requires disconnecting the interface chip (debugger).
This can be done, but it would break the local file system.
*/
for (;;) {
// sleep();
}
/* The idle demon is a system thread, running when no other thread is */
/* ready to run. */
for (;;) {
rtos_idle_hook_fptr();
}
}

/*----------------------------------------------------------------------------
Expand Down
37 changes: 37 additions & 0 deletions libraries/rtos/rtx/TARGET_ARM7/rtos_idle.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/* mbed Microcontroller Library
* Copyright (c) 2006-2012 ARM Limited
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef RTOS_IDLE_H
#define RTOS_IDLE_H

#ifdef __cplusplus
extern "C" {
#endif

extern void (*rtos_idle_hook_fptr)(void);

void rtos_idle_default_hook(void);

#ifdef __cplusplus
}
#endif

#endif
13 changes: 7 additions & 6 deletions libraries/rtos/rtx/TARGET_CORTEX_A/RTX_Conf_CA.c
Original file line number Diff line number Diff line change
Expand Up @@ -224,13 +224,14 @@

/*--------------------------- os_idle_demon ---------------------------------*/

void os_idle_demon (void) {
/* The idle demon is a system thread, running when no other thread is */
/* ready to run. */
#include "rtos_idle.h"

for (;;) {
/* HERE: include optional user code to be executed when no thread runs.*/
}
void os_idle_demon (void) {
/* The idle demon is a system thread, running when no other thread is */
/* ready to run. */
for (;;) {
rtos_idle_hook_fptr();
}
}

#if (OS_SYSTICK == 0) // Functions for alternative timer as RTX kernel timer
Expand Down
37 changes: 37 additions & 0 deletions libraries/rtos/rtx/TARGET_CORTEX_A/rtos_idle.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/* mbed Microcontroller Library
* Copyright (c) 2006-2012 ARM Limited
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef RTOS_IDLE_H
#define RTOS_IDLE_H

#ifdef __cplusplus
extern "C" {
#endif

extern void (*rtos_idle_hook_fptr)(void);

void rtos_idle_default_hook(void);

#ifdef __cplusplus
}
#endif

#endif
17 changes: 7 additions & 10 deletions libraries/rtos/rtx/TARGET_CORTEX_M/RTX_Conf_CM.c
Original file line number Diff line number Diff line change
Expand Up @@ -299,17 +299,14 @@
/*----------------------------------------------------------------------------
* OS Idle daemon
*---------------------------------------------------------------------------*/
#include "rtos_idle.h"

void os_idle_demon (void) {
/* The idle demon is a system thread, running when no other thread is */
/* ready to run. */

/* Sleep: ideally, we should put the chip to sleep.
Unfortunately, this usually requires disconnecting the interface chip (debugger).
This can be done, but it would break the local file system.
*/
for (;;) {
// sleep();
}
/* The idle demon is a system thread, running when no other thread is */
/* ready to run. */
for (;;) {
rtos_idle_hook_fptr();
}
}

/*----------------------------------------------------------------------------
Expand Down
37 changes: 37 additions & 0 deletions libraries/rtos/rtx/TARGET_CORTEX_M/rtos_idle.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/* mbed Microcontroller Library
* Copyright (c) 2006-2012 ARM Limited
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef RTOS_IDLE_H
#define RTOS_IDLE_H

#ifdef __cplusplus
extern "C" {
#endif

extern void (*rtos_idle_hook_fptr)(void);

void rtos_idle_default_hook(void);

#ifdef __cplusplus
}
#endif

#endif