Jump to main content

##

# DRV_SST26_BulkErase Function

## C

    bool DRV_SST26_BulkErase( const DRV_HANDLE handle, uint32_t address );

## Summary

Erase a block from the specified block start address.

## Description

This function schedules a non-blocking block erase operation of flash memory. The block size can be 8 KByte, 32KByte or 64 KByte.

The requesting client should call DRV_SST26_TransferStatusGet() API to know the current status of the request.

## Preconditions

The DRV_SST26_Open() routine must have been called for the specified SST26 driver instance.

## Parameters

Param | Description
--- | ---
handle | A valid open-instance handle, returned from the driver's open routine
address | block start address to be erased.

## Returns

true

- if the erase request is successfully sent to the flash

false

- if Write enable fails before sending sector erase command to flash
- if block erase command itself fails

## Example

    DRV_HANDLE handle; // Returned from DRV_SST26_Open
    uint32_t blockStart = 0;

    if(DRV_SST26_SectorErase(handle, blockStart) == false)
    {
        // Error handling here
    }

    // Wait for erase to be completed
    while(DRV_SST26_TransferStatusGet(handle) == DRV_SST26_TRANSFER_BUSY);

## Remarks

None.