zephyr/lib/cmsis_rtos_v2/Kconfig
Andy Ross 7832738ae9 kernel/timeout: Make timeout arguments an opaque type
Add a k_timeout_t type, and use it everywhere that kernel API
functions were accepting a millisecond timeout argument.  Instead of
forcing milliseconds everywhere (which are often not integrally
representable as system ticks), do the conversion to ticks at the
point where the timeout is created.  This avoids an extra unit
conversion in some application code, and allows us to express the
timeout in units other than milliseconds to achieve greater precision.

The existing K_MSEC() et. al. macros now return initializers for a
k_timeout_t.

The K_NO_WAIT and K_FOREVER constants have now become k_timeout_t
values, which means they cannot be operated on as integers.
Applications which have their own APIs that need to inspect these
vs. user-provided timeouts can now use a K_TIMEOUT_EQ() predicate to
test for equality.

Timer drivers, which receive an integer tick count in ther
z_clock_set_timeout() functions, now use the integer-valued
K_TICKS_FOREVER constant instead of K_FOREVER.

For the initial release, to preserve source compatibility, a
CONFIG_LEGACY_TIMEOUT_API kconfig is provided.  When true, the
k_timeout_t will remain a compatible 32 bit value that will work with
any legacy Zephyr application.

Some subsystems present timeout (or timeout-like) values to their own
users as APIs that would re-use the kernel's own constants and
conventions.  These will require some minor design work to adapt to
the new scheme (in most cases just using k_timeout_t directly in their
own API), and they have not been changed in this patch, instead
selecting CONFIG_LEGACY_TIMEOUT_API via kconfig.  These subsystems
include: CAN Bus, the Microbit display driver, I2S, LoRa modem
drivers, the UART Async API, Video hardware drivers, the console
subsystem, and the network buffer abstraction.

k_sleep() now takes a k_timeout_t argument, with a k_msleep() variant
provided that works identically to the original API.

Most of the changes here are just type/configuration management and
documentation, but there are logic changes in mempool, where a loop
that used a timeout numerically has been reworked using a new
z_timeout_end_calc() predicate.  Also in queue.c, a (when POLL was
enabled) a similar loop was needlessly used to try to retry the
k_poll() call after a spurious failure.  But k_poll() does not fail
spuriously, so the loop was removed.

Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-03-31 19:40:47 -04:00

106 lines
3.3 KiB
Plaintext

# Copyright (c) 2018 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
config CMSIS_RTOS_V2
bool "CMSIS RTOS v2 API"
depends on POLL
depends on THREAD_NAME
depends on THREAD_STACK_INFO
depends on THREAD_MONITOR
depends on INIT_STACKS
depends on NUM_PREEMPT_PRIORITIES >= 56
select LEGACY_TIMEOUT_API
help
This enables CMSIS RTOS v2 API support. This is an OS-integration
layer which allows applications using CMSIS RTOS V2 APIs to build
on Zephyr.
if CMSIS_RTOS_V2
config CMSIS_V2_THREAD_MAX_COUNT
int "Maximum thread count in CMSIS RTOS V2 application"
default 15
range 0 255
help
Mention max number of threads in CMSIS RTOS V2 compliant application.
There's a limitation on the number of threads due to memory
related constraints.
config CMSIS_V2_THREAD_DYNAMIC_MAX_COUNT
int "Maximum dynamic thread count in CMSIS RTOS V2 application"
default 0
range 0 255
help
Mention max number of dynamic threads in CMSIS RTOS V2 compliant
application. There's a limitation on the number of threads due to memory
related constraints. Dynamic threads are a subset of all other CMSIS
threads i.e. they also count towards that maximum too.
config CMSIS_V2_THREAD_MAX_STACK_SIZE
int "Max stack size threads can be allocated in CMSIS RTOS V2 application"
default 4096 if COVERAGE
default 512
help
Mention max stack size threads can be allocated in CMSIS RTOS V2 application.
config CMSIS_V2_THREAD_DYNAMIC_STACK_SIZE
int "Dynamic stack size threads are allocated in CMSIS RTOS V2 application"
default 4096 if COVERAGE
default 512
help
Mention dynamic stack size threads are allocated in CMSIS RTOS V2 application.
config CMSIS_V2_TIMER_MAX_COUNT
int "Maximum timer count in CMSIS RTOS V2 application"
default 5
range 0 255
help
Mention maximum number of timers in CMSIS RTOS V2 compliant application.
config CMSIS_V2_MUTEX_MAX_COUNT
int "Maximum mutex count in CMSIS RTOS V2 application"
default 5
range 0 255
help
Mention max number of mutexes in CMSIS RTOS V2 compliant application.
config CMSIS_V2_SEMAPHORE_MAX_COUNT
int "Maximum semaphore count in CMSIS RTOS V2 application"
default 5
range 0 255
help
Mention max number of semaphores in CMSIS RTOS V2 compliant application.
config CMSIS_V2_MEM_SLAB_MAX_COUNT
int "Maximum mem slab count in CMSIS RTOS V2 application"
default 5
range 0 255
help
Mention maximum number of memory slabs in CMSIS RTOS V2 compliant application.
config CMSIS_V2_MEM_SLAB_MAX_DYNAMIC_SIZE
int "Maximum dynamic mem slab/pool size in CMSIS RTOS V2 application"
default 0
help
Mention maximum dynamic size of memory slabs/pools in CMSIS RTOS V2 compliant application.
config CMSIS_V2_MSGQ_MAX_COUNT
int "Maximum message queue count in CMSIS RTOS V2 application"
default 5
range 0 255
help
Mention maximum number of message queues in CMSIS RTOS V2 compliant application.
config CMSIS_V2_MSGQ_MAX_DYNAMIC_SIZE
int "Maximum dynamic message queue size in CMSIS RTOS V2 application"
default 0
help
Mention maximum dynamic size of message queues in CMSIS RTOS V2 compliant application.
config CMSIS_V2_EVT_FLAGS_MAX_COUNT
int "Maximum event flags count in CMSIS RTOS V2 application"
default 5
range 0 255
help
Mention maximum number of event flags in CMSIS RTOS V2 compliant application.
endif