Flash Access Service

API Reference

---

The Flash Access service APIs are applied in Firmware-Over-the-Air (FOTA) to flash MTD partitions or UBI volumes.

IPC interfaces binding

All the functions of this API are provided by the tafUpdateSvc service.

The following sample illustrates how to bind to Flash Access service.

bindings:
{
    clientExe.clientComponent.taf_flash -> tafUpdateSvc.taf_flash
}

Flash access initialization

• taf_flash_Init() – Initiates flash access reference map and memory pool.

MTD partition Flash Access

• taf_flash_MtdOpen() – Opens MTD partition for read or write.
• taf_flash_MtdClose() – Closes MTD partition.
• taf_flash_MtdInformation() – Gets MTD partition information.
• taf_flash_MtdIsBlockGood() – Checks if an MTD block is good.
• taf_flash_MtdEraseBlock() – Erases an MTD block.
• taf_flash_MtdReadPage() – Reads data from an MTD page.
• taf_flash_MtdWritePage() – Writes the date to an MTD page.

The following example illustrates reading an MTD block.

// Open MTD partition.
taf_flash_MtdOpen(partitionName, TAF_FLASH_READ_WRITE, &partitionRef);

// Read MTD block.
taf_flash_MtdReadBlock(partitionRef, blockIndex, data, &dataSize);

// Close MTD partition.
taf_flash_MtdClose(partitionRef);

UBI volume flash access

• taf_flash_UbiOpen() – Opens UBI volume for read or write.
• taf_flash_UbiClose() – Closes UBI volume.
• taf_flash_UbiInformation() – Gets UBI volume information
• taf_flash_UbiRead() – Reads data from UBI volume.
• taf_flash_UbiInitWrite() – Initiates write size of UBI volume.
• taf_flash_UbiWrite() – Writes data to UBI volume.

The following example illustrates writing UBI volume.

// Open UBI volume.
taf_flash_UbiOpen(volumeName, TAF_FLASH_READ_WRITE, &volumeRef);

// Write UBI volume.
taf_flash_UbiInitWrite(volumeRef, volumeSize);

taf_flash_UbiWrite(volumeRef, data, dataSize);

// Close UBI volume.
taf_flash_UbiClose(volumeRef);

---