lean-ftl

A minimal flash translation layer meant for embedded systems (wear leveling+anti tearing).

Sources are hosted on Github: https://github.com/sebastien-riou/lean-ftl.

Contents

• Introduction
  • Overview
  • Key concepts
    • Write unit
    • Erase unit
    • Meta data
    • Slot
    • Area
• Getting started
  • Using pre-built binaries
  • Building
  • Linking with lean-ftl
  • Troubleshooting
• User guide
  • Header to include
  • Enabling helper macros
  • Declaring variables in the NVM
    • Choosing the wear leveling factor
    • Single LFTL area vs many
  • Declaring NVM properties
  • Implementing the callbacks
  • Declaring LFTL areas
  • Library initialization
  • Initial formatting
  • Updating a single variable atomically
  • Updating several variables atomically
• API
  • lftl_version()
  • lftl_version_timestamp()
  • lftl_build_type()
  • lftl_init_lib()
  • lftl_register_area()
  • lftl_format()
  • lftl_get_ctx()
  • lftl_erase_all()
  • lftl_transaction_start()
  • lftl_transaction_commit()
  • lftl_transaction_abort()
  • lftl_write()
  • lftl_read()
  • lftl_read_newer()
  • lftl_memread()
  • lftl_memread_newer()
  • lftl_basic_write()
  • lftl_transaction_write()
  • lftl_transaction_read()
  • lftl_write_any()
  • lftl_transaction_write_any()
  • lftl_nvm_props_t
  • nvm_erase_t
  • nvm_write_t
  • nvm_read_t
  • error_handler_t
  • lftl_ctx_t
  • lftl_dat_t
  • flash_sw_page_t
  • dat
  • lftl_nvm_props_struct
    • lftl_nvm_props_struct::base
    • lftl_nvm_props_struct::size
    • lftl_nvm_props_struct::write_size
    • lftl_nvm_props_struct::erase_size
  • lftl_ctx_struct
    • lftl_ctx_struct::nvm_props
    • lftl_ctx_struct::area
    • lftl_ctx_struct::area_size
    • lftl_ctx_struct::data
    • lftl_ctx_struct::data_size
    • lftl_ctx_struct::erase
    • lftl_ctx_struct::write
    • lftl_ctx_struct::read
    • lftl_ctx_struct::error_handler
    • lftl_ctx_struct::transaction_tracker
    • lftl_ctx_struct::next
  • lftl_wu_struct
    • lftl_wu_struct::dat
• Tests
  • Unit tests
• Internals
  • Conventions
  • Coding style
  • Error reporting
  • Expansion of variables to full write units
  • Memory layout
• Development
  • Vision and principles
    • Mission statement
    • Goals
      • Robustness
      • Simplicity
      • Self-contained
      • Portability
      • Stable API
  • Development dependencies
    • Installing sphinx
  • Tips and tricks
    • Live preview of docs
    • Testing and code coverage
    • Debug preprocessor macros
• Acknowledgement