TMPM4G9  V1.0.0.0
FlashApi_Exported_FunctionPrototypes

Functions

TXZ_WorkState fc_get_status (fc_sr0_t status)
 Get the status of the flash auto operation. More...
 
TXZ_Result fc_write_cdata_flash (uint32_t *src_address, uint32_t *dst_address, uint32_t size)
 
TXZ_Result fc_erase_page_data_flash (fc_data_flash_page_number_t first_page, uint8_t num_of_pages)
 Auro page erase command of the data flash. More...
 
TXZ_Result fc_erase_block_data_flash (fc_data_flash_block_number_t first_block, uint8_t num_of_block)
 Auto block erase command of the data flash. More...
 
TXZ_Result fc_blank_check_block_data_flash (fc_data_flash_block_number_t first_block, fc_data_flash_block_number_t last_block)
 Checks a blank of the data Flash of specified blocks. More...
 
TXZ_Result fc_erase_area_data_flash (fc_data_flash_area_number_t area)
 Auto area erase command of the data flash. More...
 
TXZ_Result fc_blank_check_area_data_flash (fc_data_flash_area_number_t area)
 Checks a blank of the data Flash of specified area. More...
 
TXZ_Result fc_write_data_flash (uint32_t *src_address, uint32_t *dst_address, uint32_t size)
 Auto write command of the data flash. More...
 
TXZ_Result fc_verify_check (uint32_t *src_address, uint32_t *dst_address, uint32_t size)
 Verifies data of the Flash ROM. More...
 
TXZ_Result fc_write_code_flash (uint32_t *src_address, uint32_t *dst_address, uint32_t size)
 Auto write command of the code flash ROM. More...
 
TXZ_Result fc_erase_page_code_flash (fc_code_flash_page_number_t first_page, uint8_t num_of_pages)
 Auro page erase command of the code flash ROM. More...
 
TXZ_Result fc_blank_check_page_code_flash (fc_code_flash_page_number_t first_page, fc_code_flash_page_number_t lasr_page)
 Checks a blank of the code Flash ROM of specified pages. More...
 
TXZ_Result fc_write_user_information_area (uint32_t *src_address, uint32_t size)
 Auto write command of the user information area. More...
 
TXZ_Result fc_erase_user_information_area (void)
 Auro page erase command of the user information area. More...
 
void fc_read_user_information_area (uint32_t *dst_address, uint32_t size)
 Raed of the user information area. More...
 

Detailed Description

Function Documentation

§ fc_blank_check_area_data_flash()

TXZ_Result fc_blank_check_area_data_flash ( fc_data_flash_area_number_t  area)

Checks a blank of the data Flash of specified area.

Parameters
area: The area which checks a blank.
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM.

§ fc_blank_check_block_data_flash()

TXZ_Result fc_blank_check_block_data_flash ( fc_data_flash_block_number_t  first_block,
fc_data_flash_block_number_t  last_block 
)

Checks a blank of the data Flash of specified blocks.

Parameters
first_block: The first block which checks a blank.
last_block: The last block which checks a blank..
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM.

§ fc_blank_check_page_code_flash()

TXZ_Result fc_blank_check_page_code_flash ( fc_code_flash_page_number_t  first_page,
fc_code_flash_page_number_t  last_page 
)

Checks a blank of the code Flash ROM of specified pages.

Parameters
first_page: The first page which checks a blank.
last_page: The last page which checks a blank..
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM.
Parameters
first_page: The first page which checks a blank.
last_page: The last page which checks a blank.
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM.

§ fc_erase_area_data_flash()

TXZ_Result fc_erase_area_data_flash ( fc_data_flash_area_number_t  area)

Auto area erase command of the data flash.

Parameters
area: The area block to erase
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function erases specified block of the data Flash and checks a blank.

§ fc_erase_block_data_flash()

TXZ_Result fc_erase_block_data_flash ( fc_data_flash_block_number_t  first_block,
uint8_t  num_of_block 
)

Auto block erase command of the data flash.

Parameters
first_block: The first block to erase
num_of_block: The number of blocks to erase.
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function erases specified block of the data Flash and checks a blank.

§ fc_erase_page_code_flash()

TXZ_Result fc_erase_page_code_flash ( fc_code_flash_page_number_t  first_page,
uint8_t  num_of_pages 
)

Auro page erase command of the code flash ROM.

Parameters
first_page: The first page to erase
num_of_pages: The number of pages to erase.
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function erases specified page of the code Flash ROM and checks a blank.

§ fc_erase_page_data_flash()

TXZ_Result fc_erase_page_data_flash ( fc_data_flash_page_number_t  first_page,
uint8_t  num_of_pages 
)

Auro page erase command of the data flash.

Parameters
first_page: The first page to erase
num_of_pages: The number of pages to erase.
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function erases specified page of the data Flash and checks a blank.

§ fc_erase_user_information_area()

TXZ_Result fc_erase_user_information_area ( void  )

Auro page erase command of the user information area.

Parameters
-
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function erases specified page of the code Flash ROM and checks a blank.

§ fc_get_status()

TXZ_WorkState fc_get_status ( fc_sr0_t  status)

Get the status of the flash auto operation.

Parameters
status
Returns
Result.
Return values
TXZ_BUSY: Busy.
TXZ_DONE: Done.
Note
It works in the inner RAM.

§ fc_read_user_information_area()

void fc_read_user_information_area ( uint32_t *  dst_address,
uint32_t  size 
)

Raed of the user information area.

Parameters
dst_address
size
Return values
-
Note
It works in the inner RAM.

§ fc_verify_check()

TXZ_Result fc_verify_check ( uint32_t *  src_address,
uint32_t *  dst_address,
uint32_t  size 
)

Verifies data of the Flash ROM.

Parameters
src_address
dst_address
size
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM.

§ fc_write_cdata_flash()

TXZ_Result fc_write_cdata_flash ( uint32_t *  src_address,
uint32_t *  dst_address,
uint32_t  size 
)

§ fc_write_code_flash()

TXZ_Result fc_write_code_flash ( uint32_t *  src_address,
uint32_t *  dst_address,
uint32_t  size 
)

Auto write command of the code flash ROM.

Parameters
src_address
dst_address
size
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function writes 16bytes data to the code Flash ROM.

§ fc_write_data_flash()

TXZ_Result fc_write_data_flash ( uint32_t *  src_address,
uint32_t *  dst_address,
uint32_t  size 
)

Auto write command of the data flash.

Parameters
src_address
dst_address
size
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function writes 16bytes data to the DATA Flash.

§ fc_write_user_information_area()

TXZ_Result fc_write_user_information_area ( uint32_t *  src_address,
uint32_t  size 
)

Auto write command of the user information area.

Parameters
src_address
size
Returns
Result.
Return values
TXZ_SUCCESS:Success.
TXZ_ERROR:Failure.
Note
It works in the inner RAM. This function writes 16bytes data to the code Flash ROM.