This function erases the specified address range in the flash device.
The number of bytes to erase can be any number as long as it is within the bounds of the device(s).
The device is polled until an error or the operation completes successfully.
Note: Due to flash memory design, the range actually erased may be larger than what was specified by the Offset & Bytes parameters. This will occur if the parameters do not align to block boundaries.
Prototype
int XFlash_Erase(XFlash *InstancePtr, u32 Offset, u32 Bytes);Parameters
The following table lists the XFlash_Erase function arguments.
| Type | Name | Description |
|---|---|---|
| XFlash * | InstancePtr | Pointer to the XFlash instance. |
| u32 | Offset | Offset into the device(s) address space from which to begin erasure. |
| u32 | Bytes | Number of bytes to erase. |
Returns
- XST_SUCCESS if successful.
- XFLASH_ADDRESS_ERROR if the destination address range is not completely within the addressable areas of the device(s).