| Abdellatif El Khlifi | 857360c | 2023-04-17 10:11:52 +0100 | [diff] [blame^] | 1 | .. SPDX-License-Identifier: GPL-2.0+ |
| 2 | |
| 3 | NVM XIP Block Storage Emulation Driver |
| 4 | ======================================= |
| 5 | |
| 6 | Summary |
| 7 | ------- |
| 8 | |
| 9 | Non-Volatile Memory devices with addressable memory (e.g: QSPI NOR flash) could |
| 10 | be used for block storage needs (e.g: parsing a GPT layout in a raw QSPI NOR flash). |
| 11 | |
| 12 | The NVMXIP Uclass provides this functionality and can be used for any 64-bit platform. |
| 13 | |
| 14 | The NVMXIP Uclass provides the following drivers: |
| 15 | |
| 16 | nvmxip-blk block driver: |
| 17 | |
| 18 | A generic block driver allowing to read from the XIP flash. |
| 19 | The driver belongs to UCLASS_BLK. |
| 20 | The driver implemented by drivers/mtd/nvmxip/nvmxip.c |
| 21 | |
| 22 | nvmxip Uclass driver: |
| 23 | |
| 24 | When a device is described in the DT and associated with UCLASS_NVMXIP, |
| 25 | the Uclass creates a block device and binds it with the nvmxip-blk. |
| 26 | The Uclass driver implemented by drivers/mtd/nvmxip/nvmxip-uclass.c |
| 27 | |
| 28 | The implementation is generic and can be used by different platforms. |
| 29 | |
| 30 | Supported hardware |
| 31 | -------------------------------- |
| 32 | |
| 33 | Any 64-bit plaform. |
| 34 | |
| 35 | Configuration |
| 36 | ---------------------- |
| 37 | |
| 38 | config NVMXIP |
| 39 | This option allows the emulation of a block storage device |
| 40 | on top of a direct access non volatile memory XIP flash devices. |
| 41 | This support provides the read operation. |
| 42 | This option provides the block storage driver nvmxip-blk which |
| 43 | handles the read operation. This driver is HW agnostic and can support |
| 44 | multiple flash devices at the same time. |
| 45 | |
| 46 | Contributors |
| 47 | ------------ |
| 48 | * Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> |