Architecture APIs

The file include/nuttx/arch.h identifies by prototype all of the APIs that must be provided by the architecture specific logic. The internal OS APIs that architecture-specific logic must interface with are also identified in include/nuttx/arch.h or in other header files.

• Naming and Header File Conventions
• APIs Exported by Architecture-Specific Logic to NuttX
  • up_initialize()
  • up_idle()
  • up_initial_state()
  • up_create_stack()
  • up_use_stack()
  • up_stack_frame()
  • up_release_stack()
  • up_unblock_task()
  • up_block_task()
  • up_release_pending()
  • up_reprioritize_rtr()
  • noreturn_function
  • up_exit()
  • up_assert()
  • up_schedule_sigaction()
  • up_allocate_heap()
  • up_interrupt_context()
  • up_disable_irq()
  • up_enable_irq()
  • up_prioritize_irq()
  • up_putc()
• APIs Exported by Board-Specific Logic to NuttX
  • board_early_initialize()
  • board_late_initialize()
• System Time and Clock
  • Basic System Timer
  • Hardware
  • System Tick and Time
  • Tickless OS
    • Tickless Platform Support
    • Tickless Configuration Options
    • Tickless Imported Interfaces
      • archname_timer_initialize()
      • up_timer_gettime()
      • up_alarm_cancel()
      • up_alarm_start()
      • up_timer_cancel()
      • up_timer_start()
  • Watchdog Timer Interfaces
    • wd_start()
    • wd_cancel()
    • wd_gettime()
    • wdentry_t
• Work Queues
  • Classes of Work Queues
    • High Priority Kernel Work queue
    • Low Priority Kernel Work Queue
    • User-Mode Work Queue
  • Common Work Queue Interfaces
    • Work Queue IDs
    • Work Queue Interface Types
    • Work Queue Interfaces
      • work_queue()
      • work_cancel()
      • work_signal()
      • work_available()
      • work_usrstart()
      • lpwork_boostpriority()
      • lpwork_restorepriority()
• Address Environments
  • up_addrenv_create()
  • up_addrenv_destroy()
  • up_addrenv_vtext()
  • up_addrenv_vdata()
  • up_addrenv_heapsize()
  • up_addrenv_select()
  • up_addrenv_restore()
  • up_addrenv_clone()
  • up_addrenv_attach()
  • up_addrenv_detach()
  • up_addrenv_ustackalloc()
  • up_addrenv_ustackfree()
  • up_addrenv_vustack()
  • up_addrenv_ustackselect()
  • up_addrenv_kstackalloc()
  • up_addrenv_kstackfree()
• APIs Exported by NuttX to Architecture-Specific Logic
  • nx_start()
  • OS List Management APIs
    • nxsched_process_timer()
    • nxsched_timer_expiration()
    • nxsched_alarm_expiration()
    • irq_dispatch()
• Application OS vs. Internal OS Interfaces
• Symmetric Multiprocessing (SMP) Application
  • up_testset()
  • up_cpu_index()
  • up_cpu_start()
  • up_cpu_pause()
  • up_cpu_resume()
• Shared Memory
  • up_shmat()
  • up_shmdt()
• On-Demand Paging
• LED Support
  • Header Files
  • LED Definitions
  • Common LED interfaces
    • board_autoled_initialize()
    • board_autoled_on()
    • board_autoled_off()
• I/O Buffer Management
  • Configuration Options
  • Throttling
  • Public Types
  • Public Function Prototypes
    • iob_initialize()
    • iob_alloc()
    • iob_tryalloc()
    • iob_free()
    • iob_free_chain()
    • iob_add_queue()
    • iob_tryadd_queue()
    • iob_remove_queue()
    • iob_peek_queue()
    • iob_free_queue()
    • iob_free_queue_qentry()
    • iob_get_queue_size()
    • iob_copyin()
    • iob_trycopyin()
    • iob_copyout()
    • iob_clone()
    • iob_concat()
    • iob_trimhead()
    • iob_trimhead_queue()
    • iob_trimtail()
    • iob_pack()
    • iob_contig()
    • iob_dump()