Todo

Create “tutorial” type documentation for specific subjects not to be covered in more general terms.

Guides

• NFS Client How-To
  • Adding NFS to the NuttX Configuration
  • Mount Interface
  • NFS Mount Command
  • Configuring the NFS server (Ubuntu)
• USB Device Trace
• Simulator
  • Prerequisites For macOS
  • Compiling
  • Accessing the Network
  • Testing / capturing TCP network traffic
  • Stopping
  • Debugging
• How to debug NuttX using QEMU and GDB
  • Compiling
  • Start QEMU
  • Start GDB to connect to QEMU
• How to use RNDIS
  • Compiling
  • Flashing
  • Setup RNDIS in your computer
• Drivers
  • Porting a Driver
  • NuttX Drivers as a Reference
  • Using Chip Datasheets
  • Logic Analyzers
  • DMA Debugging
• Task Trace
  • Task Trace User Guide
    • Installation
      • Install Trace Compass
      • NuttX kernel configuration
    • How to get trace data
      • Quick Guide
        • Getting the trace
        • Displaying the trace result
    • Trace command description
      • trace start
      • trace stop
      • trace cmd
      • trace dump
      • trace mode
      • trace syscall
      • trace irq
  • Task Trace Internals
    • Overview
      • NuttX kernel events collection
      • Filter logic (nuttx/sched/sched_note.c)
      • Noteram device driver (nuttx/drivers/note/noteram_driver.c)
      • Notectl device driver (nuttx/drivers/note/notectl_driver.c)
      • “trace” Built-In Application (apps/system/trace/trace.c)
    • Getting the system call events
      • FLAT build
      • PROTECTED/KERNEL build
• C++ Example using CMake
  • Preparation
  • Creating the project
  • Building
• pysimCoder integration with NuttX
  • Peripheral Support
  • NuttX Configuration
  • Using pysimCoder to design NuttX application
• Custom Boards How-To
  • Add a Custom Board
  • Kconfig Settings
• Custom Apps How-to
  • 1. Replace The Apps/ Directory Completely
    • 1.1 Makefile
    • 1.2 Kconfig
    • 1.3 CustomHello.c
    • 1.4 Building with the CustomApps Directory
  • 2. Extend the apps/ directory to include a new custom directory
    • 2.1 Custom Apps Directory
    • 2.2 Make.defs
    • 2.3 Makefile
    • 2.4 CustomHello App
    • 2.5 CustomHello Make.defs
    • 2.6 CustomHello Makefile
    • 2.7 CustomHello Kconfig
    • 2.8 Build and Run
  • 3. Include an Additional Custom directory Outside of the Main Source Trees
    • 3.1 Create Custom Apps directory and a Symbolic Link
    • 3.2 Make.defs etc.
• Running CI Test Locally
  • Configuring NuttX
  • Running CI Tests
• High Performance: Zero Latency Interrupts, Maskable Nested Interrupts
  • Generic Interrupt Handling
  • Bypassing the Generic Interrupt Handling
  • Getting Back into the Game
  • Maskable Nested Interrupts
  • Nested Interrupt Handling
  • Cortex-M3/4 Implementation
    • Configuration Options
    • Disabling the High Priority Interrupt
    • Dependencies
    • Configuring High Priority Interrupts
    • Example Code
• The Kernel Address Sanitizer (KASAN)
  • Overview
  • Support
    • Architectures
  • Usage
  • Implementation details
  • For developers
    • Ignoring accesses
• Nested Interrupts
  • Are Nested Interrupts Needed?
  • Layered Interrupt Handling Architecture
  • How to Implement Nested Interrupts in the Layered Interrupt Handling Architecture
  • SVCall vs PendSV
  • What Could Go Wrong?
• Analyzing Cortex-M Hardfaults
  • Analyzing the Register Dump
  • Analyzing the Stack Dump
    • The Task Stack
    • The Interrupt Stack
    • Full Stack Analysis
  • Recovering State at the Time of the Hardfault
• Core Dump
  • Overview
    • How to use
• Coresight - HW Assisted Tracing on ARM
  • Overview
  • Acronyms and Classification
  • Framework and implementation
• gdbserver
  • Introduction
  • Usage
  • Log Example
  • Raw file Example
  • Coredump Example
  • Thread awarenes
  • How to add new architecture
• GDB with Python
  • Introduction
  • Usage
  • How to write a GDB python script
• Open Flash Loader
  • Introduce
  • CONFIGURATION
  • Usage
  • Precautions
• Testing TCP/IP Network Stacks
  • SYN Flood Attack
  • Building Packets with Scapy
  • Simulating Packet Loss
  • Fuzz-Testing
• Auto-Mounter
  • General Description
  • Board-Specific Support
  • Example Implementation
• STM32 Null Pointer Detection
  • The NULL Pointer Problem
  • Cortex-M Memory
  • STM32 Memory Aliasing
  • The Cortex-M Memory Protection Unit
  • Using the MPU to Detect Null Pointer Usage
• STM32 CCM Allocator
  • CCM Memory
  • CONFIG_STM32_CCMEXCLUDE
  • CCM Allocator
  • CCM Stacks
• Run time stack statistics
  • Introduce
  • Configuration
  • Example
  • Implementation details
  • Notice
• etc romfs
  • Configuration
  • Start up Scripts
  • Customizing Start up Scripts
  • Customizing ROMFS Image
• Thread Local Storage
  • Configuration
• Device Tree
  • Overview
  • How to use
• Debugging / flashing NuttX on ARM with hardware debugger (JTAG/SWD)
  • What’s the problem?
  • Solution
    • Work-around
• Changing the System Clock Configuration
  • Question
  • Answer
    • Custom Clock Configuration
    • Peripheral Clocks
    • Reinitializing Peripherals
    • Variable Peripheral Clocking
    • Systick Timer
    • up_mdelay
    • Power Management
      • Power Management
        • Interfaces
        • Callbacks
• Using Kernel Threads
  • Build Configurations
  • Thread Types
  • Kernel Threads
• ARMv7-M Run Time Stack Checking
  • Overview
    • The Stack Monitor
    • Per function Call
    • Details for Support of Per Call Stack Checking
    • Other Considerations
• Disabling the Stack Dump During Debugging
• Including Files in board.h
  • Global Scope of board.h
  • Restricted Scope of Architecture-Specific Header Files
  • Errors due to Mixed Scope of Header Files
  • So How Do I Avoid This?
• Why can’t I put my special stuff in NuttX header files?
  • The Problem
  • A Work-Around
  • When Does It Make Sense?
• Kernel Threads with Custom Stacks
  • Background
  • Example
  • Freeing the TCB
  • Freeing the Custom Stack Memory
• Versioning and Task Names
  • Question
  • Answer
    • Versioning
    • Task Name Size
• Logging to a RAM Buffer
  • Default Debug Output
  • The syslog Device
  • The RAMLOG Device
  • Using the RAMLOG as the syslog Device
• ATM64 MTE extension
  • Introduction
  • Principle
  • Architectural Details
  • Usage
• IPv6
  • Ethernet Driver Requirements
    • Basic Driver Requirements
    • Multicast Address Filtering
    • ICMPv6 Neighbor Discovery Protocol
  • Board Configurations
  • Ping
    • Ping from Host PC
      • Ping from Windows cmd Terminal
      • Ping From Linux shell
    • Ping from the NuttShell (NSH)
  • NSH ifconfig
    • IPv4 Only
    • IPv6 Only
    • Both IPv4 and IPv6
  • Tests, Applications, and Network Utilities
• Integrating with Newlib
  • Built-In C Library
  • Header File Issues
    • math.h
    • cmath
    • alloca.h
  • C++ Issues
    • new Operator
    • uint32_t
    • size_t
• NuttX Protected Build
  • The Traditional “Flat” Build
  • The “Two Pass” Protected Build
  • The Memory Protection Unit
  • Advantages of the Protected Build
  • User-Space Proxies/Kernel-Space Stubs
  • Combining Intel HEX Files
  • Files and Directories
  • Alignment, Regions, and Subregions
  • Memory Management
    • Single User Heap
    • Dual, Partitioned Heaps
    • The Traditional Approach
  • Comparing the “Flat” Build Configuration with the Protected Build Configuration
  • Size Expansion
  • Performance Issues
• Platform Directories
  • 1. arch/<arch>/src/<chip>
  • 2. arch/<arch>/include/<chip>
  • 3. configs/<board>/include
  • 4. configs/<board>/src
  • 5. Application Directory
  • 6. drivers/
  • 7. apps/platform/<board> (maybe)
• Porting Drivers to the STM32 F7
  • Problem Statement
  • Porting Simple Drivers
  • Porting Complex Drivers
  • Cache Coherency
  • DMA
    • DMA Read Accesses
    • DMA Write Accesses
    • Write-back vs. Write-through D-Cache
    • DMA Module
  • Converting an STM32F429 Driver for the STM32F746
    • An Example
    • Reorganize DMA Data Structure
    • Add Cache Operations
• Semihosting
• Run NuttX on Renode
  • stm32f4discovery
  • nucleo-l073rz
  • nrf52840-dk
  • stm32f746g-disco
  • nucleo-h743zi
• Signaling Events from Interrupt Handlers
  • Best way to wake multiple threads from interrupt?
  • Message Queues
  • Semaphores
  • Signals
  • poll()
• Signaling Semaphores and Priority Inheritance
  • Locking vs Signaling Semaphores
    • Locking Semaphores
    • Mutual Exclusion Example
    • Signaling Semaphores
  • Signaling Semaphores and Priority Inheritance details
    • Example
    • Usage in Drivers
    • Priority Inheritance Fails
    • Who’s to Blame
  • Selecting the Semaphore Protocol
    • sem_setprotocol()
    • Why Another Non-Standard OS Interface?
    • pthread_mutexattr_setprotocol()
  • Is this Always a Problem?
• Smaller Vector Tables
  • Software IRQ Remapping
    • irq_attach()
    • irq_dispatch()
    • irq_initialize()
    • g_mapirq[]
  • Hardware Vector Remapping
  • Vector Definitions
    • Interrupt Handler Definitions
    • A Complication
    • Dubious Performance Improvements
    • Complexity and Generalizability
• How to port
  • The diagram of boot sequence
  • The list of related kernel configurations
  • Porting procedure
  • The result of porting procedure
    • The case of ARM CM4 & cxd32xx @NuttX12.4.0
      • Step1 : Add the SoC
      • Step2 : Add the Board
      • Step3 : Configure
      • Step4 : Compile
      • Step5 : Link
      • Step6 : Implement
      • Step7 : Verify
      • Appendix : out-of-tree code