Visible to Intel only — GUID: mwh1416947015473
Ixiasoft
Product Discontinuance Notification
1. Nios® II Software Developer's Handbook Revision History
2. Overview of Nios® II Embedded Development
3. Getting Started with the Graphical User Interface
4. Getting Started from the Command Line
5. Nios® II Software Build Tools
6. Overview of the Hardware Abstraction Layer
7. Developing Programs Using the Hardware Abstraction Layer
8. Developing Device Drivers for the Hardware Abstraction Layer
9. Exception Handling
10. Cache and Tightly-Coupled Memory
11. MicroC/OS-II Real-Time Operating System
12. Ethernet and the NicheStack TCP/IP Stack
13. Read-Only Zip File System
14. Publishing Component Information to Embedded Software
15. HAL API Reference
16. Nios® II Software Build Tools Reference
17. Nios® II Software Developer's Handbook Archives
1.1. Overview of Nios® II Embedded Development Revision History
1.2. Getting Started with the Graphical User Interface Revision History
1.3. Getting Started from the Command Line Revision History
1.4. Nios® II Software Build Tools Revision History
1.5. Overview of the Hardware Abstraction Layer Revision History
1.6. Developing Programs Using the Hardware Abstraction Layer Revision History
1.7. Developing Device Drivers for the Hardware Abstraction Layer Revision History
1.8. Exception Handling Revision History
1.9. Cache and Tightly-Coupled Memory Revision History
1.10. MicroC/OS-II Real-Time Operating System Revision History
1.11. Ethernet and the NicheStack TCP/IP Stack - Nios® II Edition Revision History
1.12. Read-Only Zip File System Revision History
1.13. Publishing Component Information to Embedded Software Revision History
1.14. HAL API Reference Revision History
1.15. Nios® II Software Build Tools Reference Revision History
2.1. Windows* Subsystem for Linux* (WSL 1) on Windows Requirements for Nios® II EDS
2.2. Prerequisites for Understanding the Nios® II Embedded Design Suite
2.3. Finding Nios II EDS Files
2.4. Nios® II Software Development Environment
2.5. Nios® II EDS Development Flows
2.6. Nios® II Programs
2.7. Intel FPGA Software Packages for Embedded Systems
2.8. Nios® II Embedded Design Examples
2.9. Third-Party Embedded Tools Support
2.10. Additional Nios® II Information
3.1. Installing Eclipse IDE into Nios® II EDS
3.2. Getting Started with Nios II Software in Eclipse
3.3. Makefiles and the Nios® II SBT for Eclipse
3.4. Using the BSP Editor
3.5. Run Configurations in the SBT for Eclipse
3.6. Optimizing Project Build Time
3.7. Importing a Command-Line Project
3.8. Packaging a Library for Reuse
3.9. Creating a Software Package
3.10. Programming Flash in Intel FPGA Embedded Systems
3.11. Creating Memory Initialization Files
3.12. Running a Nios® II System with ModelSim
3.13. Eclipse Usage Notes
3.13.1. Configuring Application and Library Properties
3.13.2. Configuring BSP Properties
3.13.3. Exclude from Build Not Supported
3.13.4. Selecting the Correct Launch Configuration Type
3.13.5. Target Connection Options
3.13.6. Renaming Nios® II Projects
3.13.7. Running Shell Scripts from the SBT for Eclipse
3.13.8. Must Use Nios® II Build Configuration
3.13.9. CDT Limitations
3.13.10. Enhancements for Build Configurations in SBT and SBT for Eclipse
5.1. Road Map for the SBT
5.2. Makefiles
5.3. Nios® II Embedded Software Projects
5.4. Common BSP Tasks
5.5. Details of BSP Creation
5.6. Tcl Scripts for BSP Settings
5.7. Revising Your BSP
5.8. Specifying BSP Defaults
5.9. Device Drivers and Software Packages
5.10. Boot Configurations for Intel FPGA Embedded Software
5.11. Intel FPGA-Provided Embedded Development Tools
5.12. Restrictions
7.1. HAL BSP Settings
7.2. The Nios® II Embedded Project Structure
7.3. The system.h System Description File
7.4. Data Widths and the HAL Type Definitions
7.5. UNIX-Style Interface
7.6. File System
7.7. Using Character-Mode Devices
7.8. Using File Subsystems
7.9. Using Timer Devices
7.10. Using Flash Devices
7.11. Using DMA Devices
7.12. Using Interrupt Controllers
7.13. Reducing Code Footprint in Embedded Systems
7.14. Boot Sequence and Entry Point
7.15. Memory Usage
7.16. Working with HAL Source Files
7.13.1. Enable Compiler Optimizations
7.13.2. Use Reduced Device Drivers
7.13.3. Reduce the File Descriptor Pool
7.13.4. Use /dev/null
7.13.5. Use a Smaller File I/O Library
7.13.6. Use the Lightweight Device Driver API
7.13.7. Use the Minimal Character-Mode API
7.13.8. Eliminate Unused Device Drivers
7.13.9. Eliminate Unneeded Exit Code
7.13.10. Turn off C++ Support
8.1. Driver Integration in the HAL API
8.2. The HAL Peripheral-Specific API
8.3. Preparing for HAL Driver Development
8.4. Development Flow for Creating Device Drivers
8.5. Nios® II Hardware Design Concepts
8.6. Accessing Hardware
8.7. Creating Embedded Drivers for HAL Device Classes
8.8. Integrating a Device Driver in the HAL
8.9. Creating a Custom Device Driver for the HAL
8.10. Reducing Code Footprint in HAL Embedded Drivers
8.11. HAL Namespace Allocation
8.12. Overriding the HAL Default Device Drivers
8.8.5.2.1. Creating and Naming the Driver or Package
8.8.5.2.2. Identifying the Hardware Component Class
8.8.5.2.3. Setting the BSP Type
8.8.5.2.4. Specifying an Operating System
8.8.5.2.5. Specifying Source Files
8.8.5.2.6. Specifying a Subdirectory
8.8.5.2.7. Enabling Software Initialization
8.8.5.2.8. Adding Include Paths
8.8.5.2.9. Version Compatibility
9.2.1. HAL APIs for Hardware Interrupts
9.2.2. HAL ISR Restrictions
9.2.3. Writing an ISR
9.2.4. Registering an ISR with the Enhanced Interrupt API
9.2.5. Enabling and Disabling Interrupts
9.2.6. Configuring an External Interrupt Controller
9.2.7. C Example
9.2.8. Upgrading to the Enhanced HAL Interrupt API
9.3.1.1. Execute Time-Intensive Algorithms in the Application Context
9.3.1.2. Implement Time-Intensive Algorithms in Hardware
9.3.1.3. Increase Buffer Size
9.3.1.4. Use Double Buffering
9.3.1.5. Keep Interrupts Enabled
9.3.1.6. Use Fast Memory
9.3.1.7. Use a Separate Exception Stack
9.3.1.8. Use Nested Hardware Interrupts
9.3.1.9. Locate ISR Body in Vector Table
9.3.1.10. Use Compiler Optimization
10.1. Nios® II Cache Implementation
10.2. HAL API Functions for Managing Cache
10.3. Initializing the Nios® II Cache after Reset
10.4. Nios® II Device Driver Cache Considerations
10.5. Cache Considerations for Writing Program Loaders
10.6. Managing Cache in Multi-Master and Multi-Processor Systems
10.7. Nios® II Tightly-Coupled Memory
15.1.1. _exit()
15.1.2. _rename()
15.1.3. alt_dcache_flush()
15.1.4. alt_dcache_flush_all()
15.1.5. alt_dcache_flush_no_writeback()
15.1.6. alt_uncached_malloc()
15.1.7. alt_uncached_free()
15.1.8. alt_remap_uncached()
15.1.9. alt_remap_cached()
15.1.10. alt_icache_flush_all()
15.1.11. alt_icache_flush()
15.1.12. alt_alarm_start()
15.1.13. alt_alarm_stop()
15.1.14. alt_dma_rxchan_depth()
15.1.15. alt_dma_rxchan_close()
15.1.16. alt_dev_reg()
15.1.17. alt_dma_rxchan_open()
15.1.18. alt_dma_rxchan_prepare()
15.1.19. alt_dma_rxchan_reg()
15.1.20. alt_dma_txchan_close()
15.1.21. alt_dma_txchan_ioctl()
15.1.22. alt_dma_txchan_open()
15.1.23. alt_dma_txchan_reg()
15.1.24. alt_flash_close_dev()
15.1.25. alt_exception_cause_generated_bad_addr()
15.1.26. alt_erase_flash_block()
15.1.27. alt_dma_rxchan_ioctl()
15.1.28. alt_dma_txchan_space()
15.1.29. alt_dma_txchan_send()
15.1.30. alt_flash_open_dev()
15.1.31. alt_fs_reg()
15.1.32. alt_get_flash_info()
15.1.33. alt_ic_irq_disable()
15.1.34. alt_ic_irq_enabled()
15.1.35. alt_ic_isr_register()
15.1.36. alt_ic_irq_enable()
15.1.37. alt_instruction_exception_register()
15.1.38. alt_irq_disable()
15.1.39. alt_irq_cpu_enable_interrupts ()
15.1.40. alt_irq_disable_all()
15.1.41. alt_irq_enable()
15.1.42. alt_irq_enable_all()
15.1.43. alt_irq_enabled()
15.1.44. alt_irq_init()
15.1.45. alt_irq_pending ()
15.1.46. alt_irq_register()
15.1.47. alt_llist_insert()
15.1.48. alt_llist_remove()
15.1.49. alt_load_section()
15.1.50. alt_nticks()
15.1.51. alt_read_flash()
15.1.52. alt_tick()
15.1.53. alt_ticks_per_second()
15.1.54. alt_timestamp()
15.1.55. alt_timestamp_freq()
15.1.56. alt_timestamp_start()
15.1.57. alt_write_flash()
15.1.58. alt_write_flash_block()
15.1.59. close()
15.1.60. fstat()
15.1.61. fork()
15.1.62. fcntl()
15.1.63. execve()
15.1.64. getpid()
15.1.65. kill()
15.1.66. stat()
15.1.67. settimeofday()
15.1.68. wait()
15.1.69. unlink()
15.1.70. sbrk()
15.1.71. link()
15.1.72. lseek()
15.1.73. alt_sysclk_init()
15.1.74. open()
15.1.75. times()
15.1.76. read()
15.1.77. write()
15.1.78. usleep()
15.1.79. alt_lock_flash()
15.1.80. gettimeofday()
15.1.81. ioctl()
15.1.82. isatty()
15.3.1. adc_stop
15.3.2. adc_start
15.3.3. adc_set_mode_run_once
15.3.4. adc_set_mode_run_continuously
15.3.5. adc_recalibrate
15.3.6. adc_interrupt_enable
15.3.7. adc_interrupt_disable
15.3.8. adc_clear_interrupt_status
15.3.9. adc_wait_for_interrupt - ADC Sample Storage Status Register
15.3.10. adc_interrupt_asserted
15.3.11. adc_wait_for interrupt - IRQ Status Register
15.3.12. alt_adc_word_read
16.1.1. Logging Levels
16.1.2. Setting Values
16.1.3. Utility and Script Summary
16.1.4. nios2-app-generate-makefile
16.1.5. nios2-bsp-create-settings
16.1.6. nios2-bsp-generate-files
16.1.7. nios2-bsp-query-settings
16.1.8. nios2-bsp-update-settings
16.1.9. nios2-lib-generate-makefile
16.1.10. nios2-bsp-editor
16.1.11. nios2-app-update-makefile
16.1.12. nios2-lib-update-makefile
16.1.13. nios2-swexample-create
16.1.14. nios2-elf-insert
16.1.15. nios2-elf-query
16.1.16. nios2-flash-programmer-generate
16.1.17. nios2-bsp
16.1.18. nios2-bsp-console
16.1.19. alt-file-convert (BETA)
16.3.1. Overview of BSP Settings
16.3.2. Overview of Component and Driver Settings
16.3.3. Settings Reference
hal.enable_instruction_related_exceptions_api
hal.max_file_descriptors
hal.disable_startup_thread_sync
hal.enable_small_stack
hal.exclude_default_exception
hal.sys_clk_timer
hal.timestamp_timer
ucosii.os_max_tasks
ucosii.os_lowest_prio
ucosii.os_thread_safe_newlib
ucosii.miscellaneous.os_arg_chk_en
ucosii.miscellaneous.os_cpu_hooks_en
ucosii.miscellaneous.os_debug_en
ucosii.miscellaneous.os_sched_lock_en
ucosii.miscellaneous.os_task_stat_en
ucosii.miscellaneous.os_task_stat_stk_chk_en
ucosii.miscellaneous.os_tick_step_en
ucosii.miscellaneous.os_event_name_size
ucosii.miscellaneous.os_max_events
ucosii.miscellaneous.os_task_idle_stk_size
ucosii.miscellaneous.os_task_stat_stk_size
ucosii.task.os_task_change_prio_en
ucosii.task.os_task_create_en
ucosii.task.os_task_create_ext_en
ucosii.task.os_task_del_en
ucosii.task.os_task_name_size
ucosii.task.os_task_profile_en
ucosii.task.os_task_query_en
ucosii.task.os_task_suspend_en
ucosii.task.os_task_sw_hook_en
ucosii.time.os_time_tick_hook_en
ucosii.time.os_time_dly_resume_en
ucosii.time.os_time_dly_hmsm_en
ucosii.time.os_time_get_set_en
ucosii.os_flag_en
ucosii.event_flag.os_flag_wait_clr_en
ucosii.event_flag.os_flag_accept_en
ucosii.event_flag.os_flag_del_en
ucosii.event_flag.os_flag_query_en
ucosii.event_flag.os_flag_name_size
ucosii.event_flag.os_flags_nbits
ucosii.event_flag.os_max_flags
ucosii.os_mutex_en
ucosii.mutex.os_mutex_accept_en
ucosii.mutex.os_mutex_del_en
ucosii.mutex.os_mutex_query_en
ucosii.os_sem_en
ucosii.semaphore.os_sem_accept_en
ucosii.semaphore.os_sem_set_en
ucosii.semaphore.os_sem_del_en
ucosii.semaphore.os_sem_query_en
ucosii.os_mbox_en
ucosii.mailbox.os_mbox_accept_en
ucosii.mailbox.os_mbox_del_en
ucosii.mailbox.os_mbox_post_en
ucosii.mailbox.os_mbox_post_opt_en
ucosii.mailbox.os_mbox_query_en
ucosii.os_q_en
ucosii.queue.os_q_accept_en
ucosii.queue.os_q_del_en
ucosii.queue.os_q_flush_en
ucosii.queue.os_q_post_en
ucosii.queue.os_q_post_front_en
ucosii.queue.os_q_post_opt_en
ucosii.queue.os_q_query_en
ucosii.queue.os_max_qs
ucosii.os_mem_en
ucosii.memory.os_mem_query_en
ucosii.memory.os_mem_name_size
ucosii.memory.os_max_mem_part
ucosii.os_tmr_en
ucosii.timer.os_task_tmr_stk_size
ucosii.timer.os_task_tmr_prio
ucosii.timer.os_tmr_cfg_max
ucosii.timer.os_tmr_cfg_name_size
ucosii.timer.os_tmr_cfg_ticks_per_sec
ucosii.timer.os_tmr_cfg_wheel_size
altera_avalon_uart_driver.enable_small_driver
altera_avalon_uart_driver.enable_ioctl
altera_avalon_jtag_uart_driver.enable_small_driver
altera_avalon_uart_driver.enable_jtag_uart_ignore_fifo_full_error
altera_hostfs.hostfs_name
altera_ro_zipfs.ro_zipfs_name
altera_ro_zipfs.ro_zipfs_offset
altera_ro_zipfs.ro_zipfs_base
hal.linker.allow_code_at_reset
hal.linker.enable_alt_load
hal.linker.enable_alt_load_copy_exceptions
hal.linker.enable_alt_load_copy_rodata
hal.linker.enable_alt_load_copy_rwdata
hal.linker.enable_exception_stack
hal.linker.exception_stack_memory_region_name
hal.linker.exception_stack_size
hal.linker.enable_interrupt_stack
hal.linker.interrupt_stack_memory_region_name
hal.linker.interrupt_stack_size
hal.make.ar
hal.make.ar_post_process
hal.make.ar_pre_process
hal.make.as
hal.make.as_post_process
hal.make.as_pre_process
hal.make.bsp_arflags
hal.make.bsp_asflags
hal.make.bsp_cflags_debug
hal.make.bsp_cflags_defined_symbols
hal.make.bsp_cflags_optimization
hal.make.bsp_cflags_undefined_symbols
hal.make.bsp_cflags_user_flags
hal.make.bsp_cflags_warnings
hal.make.bsp_cxx_flags
hal.make.bsp_inc_dirs
hal.make.build_post_process
hal.make.build_pre_process
hal.make.cc
hal.make.cc_post_process
hal.make.cc_pre_process
hal.make.cxx
hal.make.cxx_post_process
hal.make.cxx_pre_process
hal.make.enable_cflag_fstack_protector_strong
hal.make.enable_cflag_wformat_security
hal.make.ignore_system_derived.big_endian
hal.make.ignore_system_derived.fpu_present
hal.make.ignore_system_derived.hardware_divide_present
hal.make.ignore_system_derived.hardware_fp_cust_inst_divider_present
hal.make.ignore_system_derived.hardware_fp_cust_inst_no_divider_present
hal.make.ignore_system_derived.sopc_simulation_enabled
hal.make.ignore_system_derived.debug_core_present
hal.make.ignore_system_derived.hardware_multiplier_present
hal.make.ignore_system_derived.hardware_mulx_present
hal.make.ignore_system_derived.sopc_system_base_address
hal.make.ignore_system_derived.sopc_system_id
hal.make.ignore_system_derived.sopc_system_timestamp
hal.make.rm
hal.custom_newlib_flags
hal.enable_c_plus_plus
hal.enable_clean_exit
hal.enable_exit
hal.enable_gprof
hal.enable_lightweight_device_driver_api
hal.enable_mul_div_emulation
hal.enable_reduced_device_drivers
hal.enable_runtime_stack_checking
hal.enable_sim_optimize
hal.enable_small_c_library
hal.enable_sopc_sysid_check
hal.log_port
hal.log_flags
hal.stderr
hal.stdin
hal.stdout
hal.thread_stack_size
16.5.2.1. add_memory_device
16.5.2.2. add_memory_region
16.5.2.3. add_section_mapping
16.5.2.4. are_same_resource
16.5.2.5. delete_memory_region
16.5.2.6. delete_section_mapping
16.5.2.7. disable_sw_package
16.5.2.8. enable_sw_package
16.5.2.9. get_addr_span
16.5.2.10. get_assignment
16.5.2.11. get_available_drivers
16.5.2.12. get_available_sw_packages
16.5.2.13. get_base_addr
16.5.2.14. get_break_offset
16.5.2.15. get_break_slave_desc
16.5.2.16. get_cpu_name
16.5.2.17. get_current_memory_regions
16.5.2.18. get_current_section_mappings
16.5.2.19. get_default_memory_regions
16.5.2.20. get_driver
16.5.2.21. get_enabled_sw_packages
16.5.2.22. get_exception_offset
16.5.2.23. get_exception_slave_desc
16.5.2.24. get_fast_tlb_miss_exception_offset
16.5.2.25. get_fast_tlb_miss_exception_slave_desc
16.5.2.26. get_interrupt_controller_id
16.5.2.27. get_irq_interrupt_controller_id
16.5.2.28. get_irq_number
16.5.2.29. get_memory_region
16.5.2.30. get_module_class_name
16.5.2.31. get_module_name
16.5.2.32. get_reset_offset
16.5.2.33. get_reset_slave_desc
16.5.2.34. get_section_mapping
16.5.2.35. get_setting
16.5.2.36. get_setting_desc
16.5.2.37. get_slave_descs
16.5.2.38. is_char_device
16.5.2.39. is_connected_interrupt_controller_device
16.5.2.40. is_connected_to_data_master
16.5.2.41. is_connected_to_instruction_master
16.5.2.42. is_ethernet_mac_device
16.5.2.43. is_flash
16.5.2.44. is_memory_device
16.5.2.45. is_non_volatile_storage
16.5.2.46. is_timer_device
16.5.2.47. log_debug
16.5.2.48. log_default
16.5.2.49. log_error
16.5.2.50. log_verbose
16.5.2.51. set_driver
16.5.2.52. set_ignore_file
16.5.2.53. set_setting
16.5.2.54. update_memory_region
16.5.2.55. update_section_mapping
16.5.2.56. add_default_memory_regions
16.5.2.57. create_bsp
16.5.2.58. generate_bsp
16.5.2.59. get_available_bsp_type_versions
16.5.2.60. get_available_bsp_types
16.5.2.61. get_available_cpu_architectures
16.5.2.62. get_available_cpu_names
16.5.2.63. get_available_software
16.5.2.64. get_available_software_setting_properties
16.5.2.65. get_available_software_settings
16.5.2.66. get_bsp_version
16.5.2.67. get_cpu_architecture
16.5.2.68. get_nios2_dpx_thread_num
16.5.2.69. get_sopcinfo_file
16.5.2.70. get_supported_bsp_types
16.5.2.71. is_bsp_hal_extension
16.5.2.72. is_bsp_lwhal_extension
16.5.2.73. open_bsp
16.5.2.74. save_bsp
16.5.2.75. set_bsp_version
16.5.2.76. set_logging_mode
16.5.3.1. add_class_sw_setting
16.5.3.2. add_class_systemh_line
16.5.3.3. add_module_sw_property
16.5.3.4. add_module_sw_setting
16.5.3.5. add_module_systemh_line
16.5.3.6. add_systemh_line
16.5.3.7. get_class_peripheral
16.5.3.8. get_module_assignment
16.5.3.9. get_module_name
16.5.3.10. get_module_peripheral
16.5.3.11. get_module_sw_setting_value
16.5.3.12. get_peripheral_property
16.5.3.13. remove_class_systemh_line
16.5.3.14. remove_module_systemh_line
16.5.3.15. set_class_sw_setting_property
16.5.3.16. set_module_sw_setting_property
Visible to Intel only — GUID: mwh1416947015473
Ixiasoft
16.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
- Identifier: 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_avalon_uart_driver.enable_jtag_uart_ignore_fifo_full_error
- Identifier: ALTERA_AVALON_JTAG_UART_IGNORE_FIFO_FULL_ERROR
- Type: Boolean definition
- Default Value: false
- Destination File: altera_avalon_jtag_uart.h
- Description: JTAG UART FIFO full error after timeout
- 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_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.
hal.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 non-sequential 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.enable_cflag_fstack_protector_strong
- Identifier: none
- Type: Boolean assignment
- Default Value: 0
- Destination File: public.mk
- Description: Enable the fstack-protector-strong compiler flag in public.mk. If true: ALT_CFLAGS += -fstack-protector-strong.
- Restriction: none
hal.make.enable_cflag_wformat_security
- Identifier: none
- Type: Boolean assignment
- Default Value: 0
- Destination File: public.mk
- Description: Enable the Wformat and Wformat-security compiler flags in public.mk to warn against security problems when using format functions. If true: ALT_CFLAGS += -Wformat -Wformat-security.
- 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. This setting is intended for big endian Nios® II processor and has no effect to default little endian Nios® II processor.
- Restriction: none
Note: The hal.make.ignore_system_derived.big_endian setting is only available in Nios® II EDS Standard version.
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
- DDestination 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