Nios II Classic Software Developer’s Handbook

ID 683282
Date 5/14/2015
Public
Document Table of Contents

15.3.3. Settings Reference

This section lists all settings for BSPs, software packages, and device drivers.

hal.enable_instruction_related_exceptions_api

  • Identifier: none
  • Type: Boolean definition
  • Default Value: false
  • Destination File: none
  • Description: Enables application program interface (API) for registering handlers to service instruction-related exceptions. These exception types can be generated if various processor options are enabled, such as the memory management unit (MMU), memory protection unit (MPU), or other advanced exception types. Enabling this setting increases the size of the exception entry code.
  • Restrictions: none

hal.max_file_descriptors

  • Identifier: none
  • Type: Decimal number
  • Default Value: 32
  • Destination File: none
  • Description: Determines the number of file descriptors statically allocated.
  • Restriction: If hal.enable_lightweight_device_driver_api is true, there are no file descriptors so this setting is ignored. If hal.enable_lightweight_device_driver_api is false, this setting must be at least 4 because HAL needs a file descriptor for /dev/null, /dev/stdin, /dev/stdout, and /dev/stderr. This setting defines the value of ALT_MAX_FD in system.h.

hal.disable_startup_thread_sync

  • Identifier: ALT_DISABLE_STARTUP_THREAD_SYNC
  • Type: Boolean definition
  • Default Value: false
  • Destination File: system.h
  • Description: Disables thread synchronization checking on startup. By default, startup code in crt0.S assumes that the .rwdata section must be reloaded every time the system is reset. Thread 0 waits until the .rwdata section is reloaded before executing initialization code.
  • The hal.disable_startup_thread_sync setting allows you to disable this restriction in your BSP, if your software is written without initialized global or static variables. This setting might be useful if you develop assembly language, and want to take advantage of initialization code in crt0.S.
  • Restriction: Do not disable startup thread synchronization under the following circumstances:
    • Your code uses initialized global or static variables
    • Your application uses memory management functions such as alt_malloc(), alt_free() and alt_calloc()

hal.enable_small_stack

  • Identifier: none
  • Type:Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: lwhal.enable_small_stack turns off a build warning that indicates the setting 'lwhal.thread_stack_size' might be too small (< 384 for printf) for your application.
  • Restriction: none

hal.exclude_default_exception

  • Identifier: ALT_EXCLUDE_DEFAULT_EXCEPTION
  • Type: Boolean definition
  • Default Value: false
  • Destination File: system.h
  • Description: Excludes default exception vector. If true, this setting defines the macro ALT_EXCLUDE_DEFAULT_EXCEPTION in system.h.
  • Restriction: none

hal.sys_clk_timer

  • Identifier: none
  • Type: Unquoted string
  • Default Value: none
  • Destination File: none
  • Description: Slave descriptor of the system clock timer device. This device provides a periodic interrupt ("tick") and is typically required for RTOS use. This setting defines the value of ALT_SYS_CLK in system.h.
  • Restriction: none

hal.timestamp_timer

  • iIdentifier: none
  • Type: Unquoted string
  • Default Value: none
  • Destination File: none
  • Description: Slave descriptor of timestamp timer device. This device is used by Intel FPGA HAL timestamp drivers for high-resolution time measurement. This setting defines the value of ALT_TIMESTAMP_CLK in system.h.
  • Restriction: none

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

altera_avalon_uart_driver.enable_small_driver

  • Identifier: ALTERA_AVALON_UART_SMALL
  • Type: Boolean definition
  • Default Value: false
  • Destination File: public.mk
  • Description: Small-footprint (polled mode) driver
  • Restriction: none

altera_avalon_uart_driver.enable_ioctl

  • Identifier: ALTERA_AVALON_UART_USE_IOCTL
  • Type: Boolean definition
  • Default Value: false
  • Destination File: public.mk
  • Description: Enable driver ioctl() support. This feature is not compatible with the small driver; ioctl() support is not compiled if either the UART enable_small_driver or the HAL enable_reduced_device_drivers setting is enabled.
  • Restriction: none

altera_avalon_jtag_uart_driver.enable_small_driver

  • Identifier: ALTERA_AVALON_JTAG_UART_SMALL
  • Type: Boolean definition
  • Default Value: false
  • Destination File: public.mk
  • Description: Small-footprint (polled mode) driver
  • Restriction: none

altera_hostfs.hostfs_name

  • Identifier: ALTERA_HOSTFS_NAME
  • Type: Quoted string
  • Default Value: /mnt/host
  • Destination File: system.h
  • Description: Mount point
  • Restriction: none

altera_iniche.iniche_default_if

  • Identifier: INICHE_DEFAULT_IF
  • Type: Quoted string
  • Default Value: NOT_USED
  • Destination File: system.h
  • Description: Deprecated setting: Default media access control (MAC) interface. This setting is used in some legacy Intel FPGA networking examples. It is not needed in new projects. If this setting appears in an existing project, Intel FPGA recommends that you make any necessary changes to remove it. This setting might be removed in a future release.
  • Restriction: none

altera_iniche.enable_dhcp_client

  • Identifier: DHCP_CLIENT
  • Type: Boolean definition
  • Default Value: true
  • Destination File: system.h
  • Description: Use dynamic host configuration protocol (DHCP) to automatically assign Internet protocol (IP) address
  • Restriction: none

altera_iniche.enable_ip_fragments

  • Identifier: IP_FRAGMENTS
  • Type: Boolean definition
  • Default Value: true
  • Destination File: system.h
  • Description: Reassemble IP packet fragments
  • Restriction: none

altera_iniche.enable_include_tcp

  • Identifier: INCLUDE_TCP
  • Type: Boolean definition
  • Default Value: true
  • Destination File: system.h
  • Description: Enable Transmission Control Protocol (TCP)
  • Restriction: none

altera_iniche.enable_tcp_zerocopy

  • Identifier: TCP_ZEROCOPY
  • Type: Boolean definition
  • Default Value: false
  • Destination File: system.h
  • Description: Use TCP zero-copy
  • Restriction: none

altera_iniche.enable_net_stats

  • Identifier: NET_STATS
  • Type: Boolean definition
  • Default Value: false
  • Destination File: system.h
  • Description: Enable statistics
  • Restriction: none

altera_ro_zipfs.ro_zipfs_name

  • Identifier: ALTERA_RO_ZIPFS_NAME
  • Type: Quoted string
  • Default Value: /mnt/rozipfs
  • Destination File: system.h
  • Description: Mount point
  • Restriction: none

altera_ro_zipfs.ro_zipfs_offset

  • Identifier: ALTERA_RO_ZIPFS_OFFSET
  • Type: Hexadecimal number
  • Default Value: 0x100000
  • Destination File: system.h
  • Description: Offset of file system from base of flash
  • Restriction: none

altera_ro_zipfs.ro_zipfs_base

  • Identifier: ALTERA_RO_ZIPFS_BASE
  • Type: Hexadecimal number
  • Default Value: 0x0
  • Destination File: system.h
  • Description: Base address of flash memory device
  • Restriction: none

hal.linker.allow_code_at_reset

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: none
  • Description: Indicates if initialization code is allowed at the reset address. If true, defines the macro ALT_ALLOW_CODE_AT_RESET in linker.h.
  • Restriction: This setting is typically false if an external bootloader (e.g. flash bootloader) is present.

hal.linker.enable_alt_load

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: none
  • Description: Enables the alt_load() facility. The alt_load() facility copies sections from the .text memory into RAM. If true, this setting sets up the VMA/LMA (virtual memory address/low memory address) of sections in linker.x to allow them to be loaded into the .text memory.
  • Restriction: This setting is typically false if an external bootloader (e.g. flash bootloader) is present.

hal.linker.enable_alt_load_copy_exceptions

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: none
  • Description: Causes the alt_load() facility to copy the .exceptions section. If true, this setting defines the macro ALT_LOAD_COPY_EXCEPTIONS in linker.h.
  • Restriction: none

hal.linker.enable_alt_load_copy_rodata

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: none
  • Description: Causes the alt_load() facility to copy the .rodata section. If true, this setting defines the macro ALT_LOAD_COPY_RODATA in linker.h.
  • Restriction: none

hal.linker.enable_alt_load_copy_rwdata

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: none
  • Description: Causes the initialization code to copy the .rwdata section. If true, this setting defines the macro ALT_LOAD_COPY_RWDATA in linker.h.
  • Restriction: none

hal.linker.enable_exception_stack

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: none
  • Description: Enables use of a separate exception stack. If true, defines the macro ALT_EXCEPTION_STACK in linker.h, adds a memory region called exception_stack to linker.x, and provides the symbols __alt_exception_stack_pointer and __alt_exception_stack_limit in linker.x.
  • Restriction: The hal.linker.exception_stack_size and hal.linker.exception_stack_memory_region_name settings must also be valid. This setting must be false for MicroC/OS-II BSPs. The exception stack can be used to improve interrupt and other exception performance if an EIC is not implemented.

hal.linker.exception_stack_memory_region_name

  • Identifier: none
  • Type: Unquoted string
  • Default Value: none
  • Destination File: none
  • Description: Name of the existing memory region to be divided up to create the exception_stack memory region. The selected region name is adjusted automatically when the BSP is generated to create the exception_stack memory region.
  • Restriction: Only used if hal.linker.enable_exception_stack is true.

hal.linker.exception_stack_size

  • Identifier: none
  • Type: Decimal number
  • Default Value: 1024
  • Destination File: none
  • Description: Size of the exception stack in bytes.
  • Restriction: Only used if hal.linker.enable_exception_stack is true. none

hal.linker.enable_interrupt_stack

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: none
  • Description: Enables use of a separate interrupt stack. If true, defines the macro ALT_INTERRUPT_STACK in linker.h, adds a memory region called interrupt_stack to linker.x, and provides the symbols __alt_interrupt_stack_pointer and __alt_interrupt_stack_limit in linker.x.
  • Restriction: The hal.linker.interrupt_stack_size and hal.linker.interrupt_stack_memory_region_name settings must also be valid. This setting must be false for MicroC/OS-II BSPs. Only enable this setting for systems with an EIC. If an EIC is not implemented, use the separate exception stack to improve interrupt and other exception performance.

.linker.interrupt_stack_memory_region_name

  • Identifier: none
  • Type: Unquoted String
  • Default Value: none
  • Destination File: none
  • Description: Name of the existing memory region that is divided up to create the interrupt_stack memory region. The selected region name is adjusted automatically when the BSP is generated to create the interrupt_stack memory region.
  • Restriction: Only used if hal.linker.enable_interrupt_stack is true. none

hal.linker.interrupt_stack_size

  • Identifier: none
  • Type: Decimal Number
  • Default Value: 1024
  • Destination File: none
  • Description: Size of the interrupt stack in bytes.
  • Restriction: Only used if hal.linker.enable_interrupt_stack is true.

hal.make.ar

  • Identifier: AR
  • Type: Unquoted string
  • Default Value: nios2-elf-ar
  • Destination File: BSP makefile
  • Description: Archiver command. Creates library files.
  • Restriction: none

hal.make.ar_post_process

  • Identifier: AR_POST_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed after archiver execution.
  • Restriction: none

hal.make.ar_pre_process

  • Identifier: AR_PRE_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed before archiver execution.
  • Restriction: none

hal.make.as

  • Identifier: AS
  • Type: Unquoted string
  • Default Value: nios2-elf-gcc
  • Destination File: BSP makefile
  • Description: Assembler command. Note that CC is used for Nios II assembly language source files (.S).
  • Restriction: none

hal.make.as_post_process

  • Identifier: AS_POST_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed after each assembly file is compiled.
  • Restriction: none

hal.make.as_pre_process

  • Identifier: AS_PRE_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed before each assembly file is compiled.
  • Restriction: none

hal.make.bsp_arflags

  • Identifier: BSP_ARFLAGS
  • Type: Unquoted string
  • Default Value: -src
  • Destination File: BSP makefile
  • Description: Custom flags only passed to the archiver. This content of this variable is directly passed to the archiver rather than the more standard ARFLAGS. The reason for this is that GNU Make assumes some default content in ARFLAGS.This setting defines the value of BSP_ARFLAGS in Makefile.
  • Restriction: none

hal.make.bsp_asflags

  • Identifier: BSP_ASFLAGS
  • Type: Unquoted string
  • Default Value: -Wa,-gdwarf2
  • Destination File: BSP makefile
  • Description: Custom flags only passed to the assembler. This setting defines the value of BSP_ASFLAGS in Makefile.
  • Restriction: none

hal.make.bsp_cflags_debug

  • Identifier: BSP_CFLAGS_DEBUG
  • Type: Unquoted string
  • Default Value: -g
  • Destination File: BSP makefile
  • Description: C/C++ compiler debug level. -g provides the default set of debug symbols typically required to debug a typical application. Omitting -g removes debug symbols from the .elf file. This setting defines the value of BSP_CFLAGS_DEBUG in Makefile.
  • Restriction: none

hal.make.bsp_cflags_defined_symbols

  • Identifier: BSP_CFLAGS_DEFINED_SYMBOLS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Preprocessor macros to define. A macro definition in this setting has the same effect as a #define in source code. Adding -DALT_DEBUG to this setting has the same effect as #define ALT_DEBUG in a source file. Adding -DFOO=1 to this setting is equivalent to the macro #define FOO 1 in a source file. Macros defined with this setting are applied to all . S , C source ( .c ), and C++ files in the BSP. This setting defines the value of BSP_CFLAGS_DEFINED_SYMBOLS in the BSP makefile.
  • Restriction: none

hal.make.bsp_cflags_optimization

  • Identifier: BSP_CFLAGS_OPTIMIZATION
  • Type: Unquoted string
  • Default Value: -O0
  • Destination File: BSP makefile
  • Description: C/C++ compiler optimization level. -O0 = no optimization, -O2 = normal optimization, etc. -O0 is recommended for code that you want to debug since compiler optimization can remove variables and produce nonsequential execution of code while debugging. This setting defines the value of BSP_CFLAGS_OPTIMIZATION in Makefile.
  • Restriction: none

hal.make.bsp_cflags_undefined_symbols

  • Identifier: BSP_CFLAGS_UNDEFINED_SYMBOLS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Preprocessor macros to undefine. Undefined macros are similar to defined macros, but replicate the #undef directive in source code. To undefine the macro FOO use the syntax -u FOO in this setting. This is equivalent to #undef FOO in a source file. Note: the syntax differs from macro definition (there is a space, i.e. -u FOO versus -DFOO). Macros defined with this setting are applied to all . S , . c , and C++ files in the BSP. This setting defines the value of BSP_CFLAGS_UNDEFINED_SYMBOLS in the BSP Makefile.
  • Restriction: none

hal.make.bsp_cflags_user_flags

  • Identifier: BSP_CFLAGS_USER_FLAGS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Custom flags passed to the compiler when compiling C, C++, and . S files . This setting defines the value of BSP_CFLAGS_USER_FLAGS in Makefile.
  • Restriction: none

hal.make.bsp_cflags_warnings

  • Identifier: BSP_CFLAGS_WARNINGS
  • Type: Unquoted string
  • Default Value: -Wall
  • Destination File: BSP makefile
  • Description: C/C++ compiler warning level. -Wall is commonly used.This setting defines the value of BSP_CFLAGS_WARNINGS in Makefile.
  • Restriction: none

hal.make.bsp_cxx_flags

  • Identifier: BSP_CXXFLAGS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Custom flags only passed to the C++ compiler. This setting defines the value of BSP_CXXFLAGS in Makefile.
  • Restriction: none

hal.make.bsp_inc_dirs

  • Identifier: BSP_INC_DIRS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Space separated list of extra include directories to scan for header files. Directories are relative to the top-level BSP directory. The -I prefix is added by the makefile, therefore you must not include it in the setting value. This setting defines the value of BSP_INC_DIRS in the makefile.
  • Restriction: none

hal.make.build_post_process

  • Identifier: BUILD_POST_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed after BSP built.
  • Restriction: none

hal.make.build_pre_process

  • Identifier: BUILD_PRE_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed before BSP built.
  • Restriction: none

hal.make.cc

  • Identifier: CC
  • Type: Unquoted string
  • Default Value: nios2-elf-gcc -xc
  • Destination File: BSP makefile
  • Description: C compiler command
  • Restriction: none

hal.make.cc_post_process

  • Identifier: CC_POST_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed after each .c or .S file is compiled.
  • Restriction: none

hal.make.cc_pre_process

  • Identifier: CC_PRE_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed before each .c or .S file is compiled.
  • Restriction: none

hal.make.cxx

  • Identifier: CXX
  • Type: Unquoted string
  • Default Value: nios2-elf-gcc -xc++
  • Destination File: BSP makefile
  • Description: C++ compiler command
  • Restriction: none

hal.make.cxx_post_process

  • Identifier: CXX_POST_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed before each C++ file is compiled.
  • Restriction: none

hal.make.cxx_pre_process

  • Identifier: CXX_PRE_PROCESS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: BSP makefile
  • Description: Command executed before each C++ file is compiled.
  • Restriction: none

hal.make.ignore_system_derived.big_endian

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system is big endian. If true ignores export of 'ALT_CFLAGS += -meb' to public.mk if big endian system. If true ignores export of 'ALT_CFLAGS += -mel' if little endian system.
  • Restriction: none

hal.make.ignore_system_derived.fpu_present

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system has FPU present. If true ignores export of 'ALT_CFLAGS += -mhard-float' to public.mk if FPU is found in the system. If true ignores export of 'ALT_CFLAGS += -mhard-soft' if FPU is not found in the system.
  • Restriction: none

hal.make.ignore_system_derived.hardware_divide_present

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system has hardware divide present. If true ignores export of 'ALT_CFLAGS += -mno-hw-div' to public.mk if no division is found in system. If true ignores export of 'ALT_CFLAGS += -mhw-div' if division is found in the system.
  • Restriction: none

hal.make.ignore_system_derived.hardware_fp_cust_inst_divider_present

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system floating point custom instruction with a divider is present. If true ignores export of 'ALT_CFLAGS += -mcustom-fpu-cfg=60-2' and 'ALT_LDFLAGS += -mcustom-fpu-cfg=60-2' to public.mk if the custom instruction is found in the system.
  • Restriction: none

hal.make.ignore_system_derived.hardware_fp_cust_inst_no_divider_present

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system floating point custom instruction without a divider is present. If true ignores export of 'ALT_CFLAGS += -mcustom-fpu-cfg=60-1' and 'ALT_LDFLAGS += -mcustom-fpu-cfg=60-1' to public.mk if the custom instruction is found in the system.
  • Restriction: none

hal.make.ignore_system_derived.sopc_simulation_enabled

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system has simulation enabled. If true ignores export of 'ELF_PATCH_FLAG += --simulation_enabled' to public.mk.
  • Restriction: none

hal.make.ignore_system_derived.debug_core_present

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system has a debug core present. If true ignores export of 'CPU_HAS_DEBUG_CORE = 1' to public.mk if a debug core is found in the system. If true ignores export of 'CPU_HAS_DEBUG_CORE = 0' if no debug core is found in the system.
  • Restriction: none

hal.make.ignore_system_derived.hardware_multiplier_present

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system has multiplier present. If true ignores export of 'ALT_CFLAGS += -mno-hw-mul' to public.mk if no multiplier is found in the system. If true ignores export of 'ALT_CFLAGS += -mhw-mul' if multiplier is found in the system.
  • Restriction: none

hal.make.ignore_system_derived.hardware_mulx_present

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query if SOPC system has hardware mulx present. If true ignores export of 'ALT_CFLAGS += -mno-hw-mulx' to public.mk if no mulx is found in the system. If true ignores export of 'ALT_CFLAGS += -mhw-mulx' if mulx is found in the system.
  • Restriction: none

hal.make.ignore_system_derived.sopc_system_base_address

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query SOPC system for system ID base address. If true ignores export of 'SOPC_SYSID_FLAG += --sidp=<address>' and 'ELF_PATCH_FLAG += --sidp=<address>' to public.mk.
  • Restriction: none

hal.make.ignore_system_derived.sopc_system_id

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query SOPC system for system ID. If true ignores export of 'SOPC_SYSID_FLAG += --id=<sysid>' and 'ELF_PATCH_FLAG += --id=<sysid>' to public.mk.
  • Restriction: none

hal.make.ignore_system_derived.sopc_system_timestamp

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enable BSP generation to query SOPC system for system timestamp. If true ignores export of 'SOPC_SYSID_FLAG += --timestamp=<timestamp>' and 'ELF_PATCH_FLAG += --timestamp=<timestamp>' to public.mk.
  • Restriction: none

hal.make.rm

  • Identifier: RM
  • Type: Unquoted string
  • Default Value: rm -f
  • Destination File: BSP makefile
  • Description: Command used to remove files when building the clean target.
  • Restriction: none

hal.custom_newlib_flags

  • Identifier: CUSTOM_NEWLIB_FLAGS
  • Type: Unquoted string
  • Default Value: none
  • Destination File: public.mk
  • Description: Build a custom version of newlib with the specified space-separated compiler flags.
  • Restriction: The custom newlib build is placed in the <bsp root>/newlib directory, and is used only for applications that utilize this BSP.

hal.enable_c_plus_plus

  • Identifier: ALT_NO_C_PLUS_PLUS
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: public.mk
  • Description: Enable support for a subset of the C++ language. This option increases code footprint by adding support for C++ constructors. Certain features, such as multiple inheritance and exceptions are not supported. If false, adds -DALT_NO_C_PLUS_PLUS to ALT_CPPFLAGS in public.mk, and reduces code footprint.
  • Restriction: none

hal.enable_clean_exit

  • Identifier: ALT_NO_CLEAN_EXIT
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: public.mk
  • Description: When your application exits, close file descriptors, call C++ destructors, etc. Code footprint can be reduced by disabling clean exit. If disabled, adds -DALT_NO_CLEAN_EXIT to ALT_CPPFLAGS and -Wl, --defsym, exit=_exit to ALT_LDFLAGS in public.mk.
  • Restriction: none

hal.enable_exit

  • Identifier: ALT_NO_EXIT
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: public.mk
  • Description: Add exit() support. This option increases code footprint if your main() routine returns or calls exit(). If false, adds -DALT_NO_EXIT to ALT_CPPFLAGS in public.mk, and reduces footprint.
  • Restriction: none

hal.enable_gprof

  • Identifier: ALT_PROVIDE_GMON
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Causes code to be compiled with gprof profiling enabled and the application .elf file to be linked with the GPROF library. If true, adds -DALT_PROVIDE_GMON to ALT_CPPFLAGS and -pg to ALT_CFLAGS in public.mk.
  • Restriction: none

hal.enable_lightweight_device_driver_api

  • Identifier: ALT_USE_DIRECT_DRIVERS
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Enables lightweight device driver API. This reduces code and data footprint by removing the HAL layer that maps device names (e.g. /dev/uart0) to file descriptors. Instead, driver routines are called directly. The open(), close(), and lseek() routines always fail if called. The read(), write(), fstat(), ioctl(), and isatty() routines only work for the stdio devices. If true, adds -DALT_USE_DIRECT_DRIVERS to ALT_CPPFLAGS in public.mk.
  • Restriction: The Intel FPGA Host and read-only ZIP file systems cannot be used if hal.enable_lightweight_device_driver_api is true.

hal.enable_mul_div_emulation

  • Identifier: ALT_NO_INSTRUCTION_EMULATION
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Adds code to the BSP to emulate multiply and divide instructions. This code is independent of any emulation code added by the C/C++ compiler. If false, adds -DALT_NO_INSTRUCTION_EMULATION to ALT_CPPFLAGS in public.mk. You do not normally need to enable this option, because the C/C++ compiler detects whether the target Nios II processor core supports the multiply and divide instructions directly. If you compile for a core that lacks support for the instructions, the HAL includes the required software emulation in its run-time libraries. However, you might need to enable hal.enable_mul_div_emulation under the following circumstances:
    • You expect to run the Nios II software on an implementation of the Nios II processor other than the one you compiled for. The best solution is to build your program for the correct Nios II processor implementation. Resort to the hal.enable_mul_div_emulation if it is not possible to determine the processor implementation at compile time.
    • You have assembly language code that uses an implementation-dependent instruction.
  • Restriction: none

hal.enable_reduced_device_drivers

  • Identifier: ALT_USE_SMALL_DRIVERS
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Certain drivers are compiled with reduced functionality to reduce code footprint. Not all drivers observe this setting. If true, adds -DALT_USE_SMALL_DRIVERS to ALT_CPPFLAGS in public.mk. Typically, drivers support this setting with a polled mode. For example, the altera_avalon_uart and altera_avalon_jtag_uart reduced drivers operate in polled mode. Several device drivers are disabled entirely in reduced drivers mode. These include the altera_avalon_cfi_flash, altera_avalon_epcs_flash_controller, and altera_avalon_lcd_16207 drivers. As a result, certain API routines fail (HAL flash access routines). You can define a symbol provided by each driver to prevent it from being removed.
  • Restriction: none

hal.enable_runtime_stack_checking

  • Identifier: ALT_STACK_CHECK
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Turns on HAL runtime stack checking feature. Enabling this setting causes additional code to be placed into each subroutine call to generate an exception if a stack collision occurs with the heap or statically allocated data. If true, adds -DALT_STACK_CHECK and -fstack-check to ALT_CPPFLAGS in public.mk.
  • Restriction: none

hal.enable_sim_optimize

  • Identifier: ALT_SIM_OPTIMIZE
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: The BSP is compiled with optimizations to speedup HDL simulation such as initializing the cache, clearing the .bss section, and skipping long delay loops. If true, adds -DALT_SIM_OPTIMIZE to ALT_CPPFLAGS in public.mk.
  • Restriction: When this setting is true, the BSP cannot run on hardware.

hal.enable_small_c_library

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 0
  • Destination File: public.mk
  • Description: Causes the small newlib (C library) to be used. This reduces code and data footprint at the expense of reduced functionality. Several newlib features are removed such as floating-point support in printf(), stdin input routines, and buffered I/O. The small C library is not compatible with Micrium 
MicroC/OS-II. If true, adds -msmallc to ALT_LDFLAGS and adds -DSMALL_C_LIB to ALT_CPPFLAGS in public.mk.
  • Restriction: none

hal.enable_sopc_sysid_check

  • Identifier: none
  • Type: Boolean assignment
  • Default Value: 1
  • Destination File: public.mk
  • Description: Enables system ID check. If a System ID component is connected to the processor associated with this BSP, the system ID check is enabled in the creation of command-line arguments to download an .elf file to the target. Otherwise, system ID and timestamp values are left out of public.mk for the application makefile download-elf target definition. With the system ID check disabled, the Nios II EDS tools do not automatically ensure that the application ..elf file (and BSP it is linked against) corresponds to the hardware design on the target. If false, adds --accept-bad-sysid to SOPC_SYSID_FLAG in public.mk. Intel FPGA strongly recommends leaving hal.enable_sopc_sysid_check enabled. This setting is exposed to support rare cases in which FPGA logic resources are in extremely short supply. When the system ID check is disabled, the software is unable to detect whether the software is running on the correct hardware version. This situation can lead to subtle errors that are difficult to diagnose.
  • Restriction: none

hal.log_port

  • Identifier: LOG_PORT
  • Type: Unquoted string
  • Default Value: none
  • Destination File: system.h
  • Description: Slave descriptor of debug logging character-mode device. If defined, it enables extra debug messages in the HAL source. This setting is used by the Intel FPGA logging functions.

hal.log_flags

  • Identifier: ALT_LOG_FLAGS
  • Type: Decimal Number
  • Default Value: 0
  • Destination File: public.mk
  • Description: The value is assigned to ALT_LOG_FLAGS in the generated public.mk. Refer to hal.log_port for further details. The valid range of this setting is -1 through 3.

hal.stderr

  • Identifier: STDERR
  • Type: Unquoted string
  • Default Value: none
  • Destination File: public.mk
  • Description: Slave descriptor of STDERR character-mode device. This setting is used by the ALT_STDERR family of defines in system.h.

hal.stdin

  • Identifier: STDIN
  • Type: Unquoted string
  • Default Value: none
  • Destination File: system.h
  • Description: Slave descriptor of STDIN character-mode device. This setting is used by the ALT_STDIN family of defines in system.h.

hal.stdout

  • Identifier: STDOUT
  • Type: Unquoted string
  • Default Value: none
  • Destination File: system.h
  • Description: Slave descriptor of STDOUT character-mode device. This setting is used by the ALT_STDOUT family of defines in system.h.

hal.thread_stack_size

  • Identifier: ALT_THREAD_STACK_SIZE
  • Type: Decimal number
  • Default Value: The default value of lwhal.thread_stack_size is selected by the default Tcl script launched when a LWHAL BSP is created. lwhal.thread_stack_size is set to 3/4 of the size of the memory region to which the .stack section is assigned, if the region is shared with other sections (the default case).
  • Destination File: system.h
  • Description: Defines stack size for a thread (in bytes). This setting defines the value of ALT_THREAD_STACK_SIZE in system.h.
  • Restriction: none