Software APIs
Data Fields
transaction_params Struct Reference

Flash transaction parameters. More...

Data Fields

uint32_t addr
 Start address of a flash transaction. More...
 
uint32_t op_type
 Operation type. More...
 
flash_ctrl_erase_type_t erase_type
 Whether to erase a bank or a single page. More...
 
flash_ctrl_partition_t partition
 Partition to operate on.
 
uint32_t word_count
 Number of 32-bit words. More...
 

Detailed Description

Flash transaction parameters.

Definition at line 47 of file flash_ctrl.c.

Field Documentation

◆ addr

uint32_t transaction_params::addr

Start address of a flash transaction.

Must be the full byte address. For read and write operations flash controller will truncate to the closest 32-bit word aligned address. For page erases, the controller will truncate to the closest lower page aligned address. For bank erases, the controller will truncate to the closest lower bank aligned address.

Definition at line 57 of file flash_ctrl.c.

◆ erase_type

flash_ctrl_erase_type_t transaction_params::erase_type

Whether to erase a bank or a single page.

Only applies to erase operations.

Definition at line 69 of file flash_ctrl.c.

◆ op_type

uint32_t transaction_params::op_type

Operation type.

Must be set to one of FLASH_CTRL_CONTROL_OP_VALUE_*.

Definition at line 63 of file flash_ctrl.c.

◆ partition

flash_ctrl_partition_t transaction_params::partition

Partition to operate on.

Definition at line 73 of file flash_ctrl.c.

◆ word_count

uint32_t transaction_params::word_count

Number of 32-bit words.

Only applies to read and write operations.

Definition at line 79 of file flash_ctrl.c.