| CMSIS-RTOS RTX Version 4.51 CMSIS-RTOS RTX: Real-Time Operating System for Cortex-M processor-based devices

- RTX

- Main Page
- Usage and Description
- Reference

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
RTX_Conf_CM.c Configuration File

The file RTX_Conf_CM.c is used to define the configuration parameters of CMSIS-RTOS RTX. This file should be part of every project that is using the CMSIS-RTOS RTX kernel.

    /*----------------------------------------------------------------------------
     *      RL-ARM - RTX
     *----------------------------------------------------------------------------
     *      Name:    RTX_Conf_CM.C
     *      Purpose: Configuration of CMSIS RTX Kernel for Cortex-M
     *      Rev.:    V4.60
     *----------------------------------------------------------------------------
     *
     * Copyright (c) 1999-2009 KEIL, 2009-2012 ARM Germany GmbH
     * All rights reserved.
     * Redistribution and use in source and binary forms, with or without
     * modification, are permitted provided that the following conditions are met:
     *  - Redistributions of source code must retain the above copyright
     *    notice, this list of conditions and the following disclaimer.
     *  - Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     *  - Neither the name of ARM  nor the names of its contributors may be used
     *    to endorse or promote products derived from this software without
     *    specific prior written permission.
     *
     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     * ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
     * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     * POSSIBILITY OF SUCH DAMAGE.
     *---------------------------------------------------------------------------*/

    #include "cmsis_os.h"

    /*----------------------------------------------------------------------------
     *      RTX User configuration part BEGIN
     *---------------------------------------------------------------------------*/

    //-------- <<< Use Configuration Wizard in Context Menu >>> -----------------
    //
    // <h>Thread Configuration
    // =======================
    //
    //   <o>Number of concurrent running threads <0-250>
    //   <i> Defines max. number of threads that will run at the same time.
    //   <i> Default: 6
    #ifndef OS_TASKCNT
     #define OS_TASKCNT     6
    #endif

    //   <o>Default Thread stack size [bytes] <64-4096:8><#/4>
    //   <i> Defines default stack size for threads with osThreadDef stacksz = 0
    //   <i> Default: 200
    #ifndef OS_STKSIZE
     #define OS_STKSIZE     50
    #endif

    //   <o>Main Thread stack size [bytes] <64-4096:8><#/4>
    //   <i> Defines stack size for main thread.
    //   <i> Default: 200
    #ifndef OS_MAINSTKSIZE
     #define OS_MAINSTKSIZE 50
    #endif

    //   <o>Number of threads with user-provided stack size <0-250>
    //   <i> Defines the number of threads with user-provided stack size.
    //   <i> Default: 0
    #ifndef OS_PRIVCNT
     #define OS_PRIVCNT     0
    #endif

    //   <o>Total stack size [bytes] for threads with user-provided stack size <0-4096:8><#/4>
    //   <i> Defines the combined stack size for threads with user-provided stack size.
    //   <i> Default: 0
    #ifndef OS_PRIVSTKSIZE
     #define OS_PRIVSTKSIZE 0
    #endif

    // <q>Check for stack overflow
    // <i> Includes the stack checking code for stack overflow.
    // <i> Note that additional code reduces the Kernel performance.
    #ifndef OS_STKCHECK
     #define OS_STKCHECK    1
    #endif

    // <o>Processor mode for thread execution
    //   <0=> Unprivileged mode
    //   <1=> Privileged mode
    // <i> Default: Privileged mode
    #ifndef OS_RUNPRIV
     #define OS_RUNPRIV     1
    #endif

    // </h>

    // <h>RTX Kernel Timer Tick Configuration
    // ======================================
    // <q> Use Cortex-M SysTick timer as RTX Kernel Timer
    // <i> Use the Cortex-M SysTick timer as a time-base for RTX.
    #ifndef OS_SYSTICK
     #define OS_SYSTICK     1
    #endif
    //
    //   <o>Timer clock value [Hz] <1-1000000000>
    //   <i> Defines the timer clock value.
    //   <i> Default: 12000000  (12MHz)
    #ifndef OS_CLOCK
     #define OS_CLOCK       12000000
    #endif

    //   <o>Timer tick value [us] <1-1000000>
    //   <i> Defines the timer tick value.
    //   <i> Default: 1000  (1ms)
    #ifndef OS_TICK
     #define OS_TICK        1000
    #endif

    // </h>

    // <h>System Configuration
    // =======================
    //
    // <e>Round-Robin Thread switching
    // ===============================
    //
    // <i> Enables Round-Robin Thread switching.
    #ifndef OS_ROBIN
     #define OS_ROBIN       1
    #endif

    //   <o>Round-Robin Timeout [ticks] <1-1000>
    //   <i> Defines how long a thread will execute before a thread switch.
    //   <i> Default: 5
    #ifndef OS_ROBINTOUT
     #define OS_ROBINTOUT   5
    #endif

    // </e>

    // <e>User Timers
    // ==============
    //   <i> Enables user Timers
    #ifndef OS_TIMERS
     #define OS_TIMERS      1
    #endif

    //   <o>Timer Thread Priority
    //                        <1=> Low
    //     <2=> Below Normal  <3=> Normal  <4=> Above Normal
    //                        <5=> High
    //                        <6=> Realtime (highest)
    //   <i> Defines priority for Timer Thread
    //   <i> Default: High
    #ifndef OS_TIMERPRIO
     #define OS_TIMERPRIO   5
    #endif

    //   <o>Timer Thread stack size [bytes] <64-4096:8><#/4>
    //   <i> Defines stack size for Timer thread.
    //   <i> Default: 200
    #ifndef OS_TIMERSTKSZ
     #define OS_TIMERSTKSZ  50
    #endif

    //   <o>Timer Callback Queue size <1-32>
    //   <i> Number of concurrent active timer callback functions.
    //   <i> Default: 4
    #ifndef OS_TIMERCBQSZ
     #define OS_TIMERCBQS   4
    #endif

    // </e>

    //   <o>ISR FIFO Queue size<4=>   4 entries  <8=>   8 entries
    //                         <12=> 12 entries  <16=> 16 entries
    //                         <24=> 24 entries  <32=> 32 entries
    //                         <48=> 48 entries  <64=> 64 entries
    //                         <96=> 96 entries
    //   <i> ISR functions store requests to this buffer,
    //   <i> when they are called from the interrupt handler.
    //   <i> Default: 16 entries
    #ifndef OS_FIFOSZ
     #define OS_FIFOSZ      16
    #endif

    // </h>

    //------------- <<< end of configuration section >>> -----------------------

    // Standard library system mutexes
    // ===============================
    //  Define max. number system mutexes that are used to protect
    //  the arm standard runtime library. For microlib they are not used.
    #ifndef OS_MUTEXCNT
     #define OS_MUTEXCNT    8
    #endif

    /*----------------------------------------------------------------------------
     *      RTX User configuration part END
     *---------------------------------------------------------------------------*/

    #define OS_TRV          ((uint32_t)(((double)OS_CLOCK*(double)OS_TICK)/1E6)-1)

    /*----------------------------------------------------------------------------
     *      Global Functions
     *---------------------------------------------------------------------------*/

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

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

      for (;;) {
        /* HERE: include optional user code to be executed when no thread runs.*/
      }
    }

    #if (OS_SYSTICK == 0)   // Functions for alternative timer as RTX kernel timer

    /*--------------------------- os_tick_init ----------------------------------*/

    // Initialize alternative hardware timer as RTX kernel timer
    // Return: IRQ number of the alternative hardware timer
    int os_tick_init (void) {

      return (-1);  /* Return IRQ number of timer (0..239) */
    }

    /*--------------------------- os_tick_irqack --------------------------------*/

    // Acknowledge alternative hardware timer interrupt
    void os_tick_irqack (void) {
      /* ... */
    }

    #endif   // (OS_SYSTICK == 0)

    /*--------------------------- os_error --------------------------------------*/

    void os_error (uint32_t err_code) {
      /* This function is called when a runtime error is detected. Parameter */
      /* 'err_code' holds the runtime error code (defined in RTL.H).         */

      /* HERE: include optional code to be executed on runtime error. */
      for (;;);
    }

    /*----------------------------------------------------------------------------
     *      RTX Configuration Functions
     *---------------------------------------------------------------------------*/

    #include "RTX_CM_lib.h"

    /*----------------------------------------------------------------------------
     * end of file
     *---------------------------------------------------------------------------*/