zephyrproject-rtos/zephyr

Add documentation for the flash simulator

Open

#20,654 opened on Nov 13, 2019

View on GitHub
 (1 comment) (0 reactions) (1 assignee)C (15,249 stars) (9,144 forks)batch import
EnhancementGood first issuearea: Documentationarea: Flash

Description

Is your enhancement proposal related to a problem? Please describe.

Currently there is no documentation about how to use the flash simulator

Describe the solution you'd like

Add documentation about how to use the flash simulator, eg. how to specify the flash size, sector size, features supported via KConfig, ...

Describe alternatives you've considered

Browse the code base

Contributor guide

Tech stack
c
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C programming basicsKConfig systemZephyr flash subsystem
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests adding documentation for the flash simulator. The contributor should explore the flash simulator implementation in the Zephyr codebase, likely in `subsys/dfu` or `drivers/flash`. Documentation should include examples for configuring flash size, sector size, and features via KConfig. Since the issue is assigned, check with the assignee or maintainers before starting.