Jason Engelman
/
IAP_2368
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Embed:
(wiki syntax)
IAP Class Reference
#include <IAP.h>
Public Member Functions | |
| IAP () | |
| Constructor for IAP. | |
| int | read_ID (void) |
| Read part identification number. | |
| int | read_serial (void) |
| Read device serial number. | |
| int | blank_check (int start, int end) |
| Blank check sector(s) | |
| int | erase (int start, int end) |
| Erase Sector(s) | |
| int | prepare (int start, int end) |
| Prepare sector(s) for write operation. | |
| int | write (char *source_addr, char *target_addr, int size) |
| Copy RAM to Flash. | |
| int | compare (char *source_addr, char *target_addr, int size) |
| Compare <address1> <address2> <no of="" bytes>=""> | |
| char * | reserved_flash_area_start (void) |
| Get user reserved flash start address. | |
| int | reserved_flash_area_size (void) |
| Get user reserved flash size. | |
Detailed Description
IAP class.
Interface for internal flash memory access
Definition at line 227 of file IAP.h.
Constructor & Destructor Documentation
Member Function Documentation
| int blank_check | ( | int | start, |
| int | end | ||
| ) |
| int compare | ( | char * | source_addr, |
| char * | target_addr, | ||
| int | size | ||
| ) |
Compare <address1> <address2> <no of="" bytes>="">
- Parameters:
-
source_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary. target_addr Starting flash or RAM address of data bytes to be compared. This address should be a word boundary. size Number of bytes to be compared; should be a multiple of 4.
- Returns:
- error code: CMD_SUCCESS | COMPARE_ERROR | COUNT_ERROR (Byte count is not a multiple of 4) | ADDR_ERROR | ADDR_NOT_MAPPED
| int erase | ( | int | start, |
| int | end | ||
| ) |
| int prepare | ( | int | start, |
| int | end | ||
| ) |
| int read_ID | ( | void | ) |
| int read_serial | ( | void | ) |
| int reserved_flash_area_size | ( | void | ) |
Get user reserved flash size.
- Returns:
- size of user reserved flash memory
- See also:
- reserved_flash_area_start()
| char * reserved_flash_area_start | ( | void | ) |
Get user reserved flash start address.
- Returns:
- start address of user reserved flash memory
- See also:
- reserved_flash_area_size()
| int write | ( | char * | source_addr, |
| char * | target_addr, | ||
| int | size | ||
| ) |
Copy RAM to Flash.
- Parameters:
-
source_addr Source RAM address from which data bytes are to be read. This address should be a word boundary. target_addr Destination flash address where data bytes are to be written. This address should be a 256 byte boundary. size Number of bytes to be written. Should be 256 | 512 | 1024 | 4096.
- Returns:
- error code: CMD_SUCCESS | SRC_ADDR_ERROR (Address not a word boundary) | DST_ADDR_ERROR (Address not on correct boundary) | SRC_ADDR_NOT_MAPPED | DST_ADDR_NOT_MAPPED | COUNT_ERROR (Byte count is not 256 | 512 | 1024 | 4096) | SECTOR_NOT_PREPARED_FOR_WRITE_OPERATION | BUSY
Generated on Wed Jul 20 2022 12:22:50 by
1.7.2