Nios® V Processor Software Developer Handbook

ID 743810
Date 4/01/2024
Public
Document Table of Contents

15.4.3.2. Micrium MicroC/OS-II BSP

ucosii.os_max_tasks

  • Identifier : OS_MAX_TASKS
  • Type: Decimal number
  • Default Value: 10
  • Destination File: system.h
  • Description: Maximum number of tasks
  • Restriction: none

ucosii.os_lowest_prio

  • Identifier: OS_LOWEST_PRIO
  • Type: Decimal number
  • Default Value: 20
  • Destination File: system.h
  • Description: Lowest assignable priority
  • Restriction: none

ucosii.os_thread_safe_newlib

  • Identifier: OS_THREAD_SAFE_NEWLIB
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Thread safe C library
  • Restriction: none

ucosii.miscellaneous.os_arg_chk_en

  • Identifier: OS_ARG_CHK_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable argument checking
  • Restriction: none

ucosii.miscellaneous.os_cpu_hooks_en

  • Identifier: OS_CPU_HOOKS_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable MicroC/OS-II hooks
  • Restriction: none

ucosii.miscellaneous.os_debug_en

  • Identifier: OS_DEBUG_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable debug variables
  • Restriction: none

ucosii.miscellaneous.os_sched_lock_en

  • Identifier: OS_SCHED_LOCK_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSSchedLock() and OSSchedUnlock()
  • Restriction: none

ucosii.miscellaneous.os_task_stat_en

  • Identifier: OS_TASK_STAT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable statistics task
  • Restriction: none

ucosii.miscellaneous.os_task_stat_stk_chk_en

  • Identifier: OS_TASK_STAT_STK_CHK_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Check task stacks from statistics task
  • Restriction: none

ucosii.miscellaneous.os_tick_step_en

  • Identifier: OS_TICK_STEP_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable tick stepping feature for uCOS-View
  • Restriction: none

ucosii.miscellaneous.os_event_name_size

  • Identifier: OS_EVENT_NAME_SIZE
  • Type: Decimal number
  • Default Value: 32
  • Destination File: system.h
  • Description: Size of name of Event Control Block groups
  • Restriction: none

ucosii.miscellaneous.os_max_events

  • Identifier: OS_MAX_EVENTS
  • Type: Decimal number
  • Default Value: 60
  • Destination File: system.h
  • Description: Maximum number of event control blocks
  • Restriction: none

ucosii.miscellaneous.os_task_idle_stk_size

  • Identifier: OS_TASK_IDLE_STK_SIZE
  • Type: Decimal number
  • Default Value: 512
  • Destination File: system.h
  • Description: Idle task stack size
  • Restriction: none

ucosii.miscellaneous.os_task_stat_stk_size

  • Identifier: OS_TASK_STAT_STK_SIZE
  • Type: Decimal number
  • Default Value: 512
  • Destination File: system.h
  • Description: Statistics task stack size
  • Restriction: none

ucosii.task.os_task_change_prio_en

  • Identifier: OS_TASK_CHANGE_PRIO_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTaskChangePrio()
  • Restriction: none

ucosii.task.os_task_create_en

  • Identifier: OS_TASK_CREATE_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTaskCreate()
  • Restriction: none

ucosii.task.os_task_create_ext_en

  • Identifier: OS_TASK_CREATE_EXT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTaskCreateExt()
  • Restriction: none

ucosii.task.os_task_del_en

  • Identifier: OS_TASK_DEL_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTaskDel()
  • Restriction: none

ucosii.task.os_task_name_size

  • Identifier: OS_TASK_NAME_SIZE
  • Type: Decimal number
  • Default Value: 32
  • Destination File: system.h
  • Description: Size of task name
  • Restriction: none

ucosii.task.os_task_profile_en

  • Identifier: OS_TASK_PROFILE_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include data structure for run-time task profiling
  • Restriction: none

ucosii.task.os_task_query_en

  • Identifier: OS_TASK_QUERY_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTaskQuery
  • Restriction: none

ucosii.task.os_task_suspend_en

  • Identifier: OS_TASK_SUSPEND_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTaskSuspend() and OSTaskResume()
  • Restriction: none

ucosii.task.os_task_sw_hook_en

  • Identifier: OS_TASK_SW_HOOK_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTaskSwHook()
  • Restriction: none

ucosii.time.os_time_tick_hook_en

  • Identifier: OS_TIME_TICK_HOOK_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTimeTickHook()
  • Restriction: none

ucosii.time.os_time_dly_resume_en

  • Identifier: OS_TIME_DLY_RESUME_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTimeDlyResume()
  • Restriction: none

ucosii.time.os_time_dly_hmsm_en

  • Identifier: OS_TIME_DLY_HMSM_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTimeDlyHMSM()
  • Restriction: none

ucosii.time.os_time_get_set_en

  • Identifier: OS_TIME_GET_SET_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSTimeGet and OSTimeSet()
  • Restriction: none

ucosii.os_flag_en

  • Identifier: OS_FLAG_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable code for Event Flags. This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.event_flag.os_flag_wait_clr_en

  • Identifier: OS_FLAG_WAIT_CLR_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for Wait on Clear Event Flags. This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.event_flag.os_flag_accept_en

  • Identifier: OS_FLAG_ACCEPT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSFlagAccept(). This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.event_flag.os_flag_del_en

  • Identifier: OS_FLAG_DEL_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSFlagDel(). This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.event_flag.os_flag_query_en

  • Identifier: OS_FLAG_QUERY_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSFlagQuery(). This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.event_flag.os_flag_name_size

  • Identifier: OS_FLAG_NAME_SIZE
  • Type: Decimal number
  • Default Value: 32
  • Destination File: system.h
  • Description: Size of name of Event Flags group. CAUTION: This is required by the HAL and many Intel FPGA device drivers; use caution in reducing this value.
  • Restriction: none

ucosii.event_flag.os_flags_nbits

  • Identifier: OS_FLAGS_NBITS
  • Type: Decimal number
  • Default Value: 16
  • Destination File: system.h
  • Description: Event Flag bits (8,16,32). CAUTION: This is required by the HAL and many Intel FPGA device drivers; use caution in changing this value.
  • Restriction: none

ucosii.event_flag.os_max_flags

  • Identifier: OS_MAX_FLAGS
  • Type: Decimal number
  • Default Value: 20
  • Destination File: system.h
  • Description: Maximum number of Event Flags groups. CAUTION: This is required by the HAL and many Intel FPGA device drivers; use caution in reducing this value.
  • Restriction: none

ucosii.os_mutex_en

  • Identifier: OS_MUTEX_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable code for Mutex Semaphores
  • Restriction: none

ucosii.mutex.os_mutex_accept_en

  • Identifier: OS_MUTEX_ACCEPT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMutexAccept()
  • Restriction: none

ucosii.mutex.os_mutex_del_en

  • Identifier: OS_MUTEX_DEL_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMutexDel()
  • Restriction: none

ucosii.mutex.os_mutex_query_en

  • Identifier: OS_MUTEX_QUERY_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMutexQuery
  • Restriction: none

ucosii.os_sem_en

  • Identifier: OS_SEM_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable code for semaphores. This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.semaphore.os_sem_accept_en

  • Identifier: OS_SEM_ACCEPT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSSemAccept(). This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.semaphore.os_sem_set_en

  • Identifier: OS_SEM_SET_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSSemSet(). This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.semaphore.os_sem_del_en

  • Identifier: OS_SEM_DEL_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSSemDel(). This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.semaphore.os_sem_query_en

  • Identifier: OS_SEM_QUERY_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSSemQuery(). This setting is enabled by default in MicroC-OS/II BSPs, because it is required for correct functioning of Intel FPGA device drivers and the HAL in a multithreaded environment. Avoid disabling it.
  • Restriction: none

ucosii.os_mbox_en

  • Identifier: OS_MBOX_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable code for mailboxes
  • Restriction: none

ucosii.mailbox.os_mbox_accept_en

  • Identifier: OS_MBOX_ACCEPT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMboxAccept()
  • Restriction: none

ucosii.mailbox.os_mbox_del_en

  • Identifier: OS_MBOX_DEL_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMboxDel()
  • Restriction: none

ucosii.mailbox.os_mbox_post_en

  • Identifier: OS_MBOX_POST_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMboxPost()
  • Restriction: none

ucosii.mailbox.os_mbox_post_opt_en

  • Identifier: OS_MBOX_POST_OPT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMboxPostOpt()
  • Restriction: none

ucosii.mailbox.os_mbox_query_en

  • Identifier: OS_MBOX_QUERY_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMboxQuery()
  • Restriction: none

ucosii.os_q_en

  • Identifier: OS_Q_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable code for Queues
  • Restriction: none

ucosii.queue.os_q_accept_en

  • Identifier: OS_Q_ACCEPT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSQAccept()
  • Restriction: none

ucosii.queue.os_q_del_en

  • Identifier: OS_Q_DEL_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSQDel()
  • Restriction: none

ucosii.queue.os_q_flush_en

  • Identifier: OS_Q_FLUSH_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSQFlush()
  • Restriction: none

ucosii.queue.os_q_post_en

  • Identifier: OS_Q_POST_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code of OSQFlush()
  • Restriction: none

ucosii.queue.os_q_post_front_en

  • Identifier: OS_Q_POST_FRONT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSQPostFront()
  • Restriction: none

ucosii.queue.os_q_post_opt_en

  • Identifier: OS_Q_POST_OPT_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSQPostOpt()
  • Restriction: none

ucosii.queue.os_q_query_en

  • Identifier: OS_Q_QUERY_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSQQuery()
  • Restriction: none

ucosii.queue.os_max_qs

  • Identifier: OS_MAX_QS
  • Type: Decimal number
  • Default Value: 20
  • Destination File: system.h
  • Description: Maximum number of Queue Control Blocks
  • Restriction: none

ucosii.os_mem_en

  • Identifier: OS_MEM_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Enable code for memory management
  • Restriction: none

ucosii.memory.os_mem_query_en

  • Identifier: OS_MEM_QUERY_EN
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: system.h
  • Description: Include code for OSMemQuery()
  • Restriction: none

ucosii.memory.os_mem_name_size

  • Identifier: OS_MEM_NAME_SIZE
  • Type: Decimal number
  • Default Value: 32
  • Destination File: system.h
  • Description: Size of memory partition name
  • Restriction: none

ucosii.memory.os_max_mem_part

  • Identifier: OS_MAX_MEM_PART
  • Type: Decimal number
  • Default Value: 60
  • Destination File: system.h
  • Description: Maximum number of memory partitions
  • Restriction: none

ucosii.os_tmr_en

  • Identifier: OS_TMR_EN
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: system.h
  • Description: Enable code for timers
  • Restriction: none

ucosii.timer.os_task_tmr_stk_size

  • Identifier: OS_TASK_TMR_STK_SIZE
  • Type: Decimal number
  • Default Value: 512
  • Destination File: system.h
  • Description: Stack size for timer task
  • Restriction: none

ucosii.timer.os_task_tmr_prio

  • Identifier: OS_TASK_TMR_PRIO
  • Type: Decimal number
  • Default Value: 2
  • Destination File: system.h
  • Description: Priority of timer task (0=highest)
  • Restriction: none

ucosii.timer.os_tmr_cfg_max

  • Identifier: OS_TMR_CFG_MAX
  • Type: Decimal number
  • Default Value: 16
  • Destination File: system.h
  • Description: Maximum number of timers
  • Restriction: none

ucosii.timer.os_tmr_cfg_name_size

  • Identifier: OS_TMR_CFG_NAME_SIZE
  • Type: Decimal number
  • Default Value: 16
  • Destination File: system.h
  • Description: Size of timer name
  • Restriction: none

ucosii.timer.os_tmr_cfg_ticks_per_sec

  • Identifier: OS_TMR_CFG_TICKS_PER_SEC
  • Type: Decimal number
  • Default Value: 10
  • Destination File: system.h
  • Description: Rate at which timer management task runs (Hz)
  • Restriction: none

ucosii.timer.os_tmr_cfg_wheel_size

  • Identifier: OS_TMR_CFG_WHEEL_SIZE
  • Type: Decimal number
  • Default Value: 2
  • Destination File: system.h
  • Description: Size of timer wheel (number of spokes)
  • Restriction: none