Correct typos and formatting

pull/11894/head
Matthew Macovsky 2019-08-30 03:21:24 -07:00 committed by adbridge
parent a8ac9ffeae
commit a9a9a6ca14
2 changed files with 32 additions and 37 deletions

View File

@ -38,7 +38,7 @@ using namespace mbed;
#define QSPI_NO_ADDRESS_COMMAND UINT64_MAX #define QSPI_NO_ADDRESS_COMMAND UINT64_MAX
#define QSPI_ALT_DEFAULT_VALUE 0 #define QSPI_ALT_DEFAULT_VALUE 0
// Status Register Bits // Status Register Bits
#define QSPIF_STATUS_BIT_WIP 0x1 //Write In Progress #define QSPIF_STATUS_BIT_WIP 0x1 // Write In Progress
#define QSPIF_STATUS_BIT_WEL 0x2 // Write Enable Latch #define QSPIF_STATUS_BIT_WEL 0x2 // Write Enable Latch
/* SFDP Header Parsing */ /* SFDP Header Parsing */
@ -64,14 +64,14 @@ using namespace mbed;
#define QSPIF_BASIC_PARAM_TABLE_QER_BYTE 58 #define QSPIF_BASIC_PARAM_TABLE_QER_BYTE 58
#define QSPIF_BASIC_PARAM_TABLE_444_MODE_EN_SEQ_BYTE 56 #define QSPIF_BASIC_PARAM_TABLE_444_MODE_EN_SEQ_BYTE 56
// Erase Types Params // Erase Types Params
#define QSPIF_BASIC_PARAM_ERASE_TYPE_1_BYTE 29 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_1_BYTE 29
#define QSPIF_BASIC_PARAM_ERASE_TYPE_2_BYTE 31 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_2_BYTE 31
#define QSPIF_BASIC_PARAM_ERASE_TYPE_3_BYTE 33 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_3_BYTE 33
#define QSPIF_BASIC_PARAM_ERASE_TYPE_4_BYTE 35 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_4_BYTE 35
#define QSPIF_BASIC_PARAM_ERASE_TYPE_1_SIZE_BYTE 28 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_1_SIZE_BYTE 28
#define QSPIF_BASIC_PARAM_ERASE_TYPE_2_SIZE_BYTE 30 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_2_SIZE_BYTE 30
#define QSPIF_BASIC_PARAM_ERASE_TYPE_3_SIZE_BYTE 32 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_3_SIZE_BYTE 32
#define QSPIF_BASIC_PARAM_ERASE_TYPE_4_SIZE_BYTE 34 #define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_4_SIZE_BYTE 34
#define QSPIF_BASIC_PARAM_4K_ERASE_TYPE_BYTE 1 #define QSPIF_BASIC_PARAM_4K_ERASE_TYPE_BYTE 1
#define QSPIF_BASIC_PARAM_TABLE_SOFT_RESET_BYTE 61 #define QSPIF_BASIC_PARAM_TABLE_SOFT_RESET_BYTE 61
@ -183,7 +183,7 @@ int QSPIFBlockDevice::init()
tr_debug("QSPIFBlockDevice csel: %d", (int)_csel); tr_debug("QSPIFBlockDevice csel: %d", (int)_csel);
} else if (_unique_device_status == -1) { } else if (_unique_device_status == -1) {
tr_error("QSPIFBlockDevice with the same csel(%d) already exists", (int)_csel); tr_error("QSPIFBlockDevice with the same csel(%d) already exists", (int)_csel);
return QSPIF_BD_ERROR_DEVICE_NOT_UNIQE; return QSPIF_BD_ERROR_DEVICE_NOT_UNIQUE;
} else { } else {
tr_error("Too many different QSPIFBlockDevice devices - max allowed: %d", QSPIF_MAX_ACTIVE_FLASH_DEVICES); tr_error("Too many different QSPIFBlockDevice devices - max allowed: %d", QSPIF_MAX_ACTIVE_FLASH_DEVICES);
return QSPIF_BD_ERROR_DEVICE_MAX_EXCEED; return QSPIF_BD_ERROR_DEVICE_MAX_EXCEED;
@ -223,7 +223,7 @@ int QSPIFBlockDevice::init()
goto exit_point; goto exit_point;
} }
//Synchronize Device // Synchronize Device
if (false == _is_mem_ready()) { if (false == _is_mem_ready()) {
tr_error("Init - _is_mem_ready Failed"); tr_error("Init - _is_mem_ready Failed");
status = QSPIF_BD_ERROR_READY_FAILED; status = QSPIF_BD_ERROR_READY_FAILED;
@ -513,7 +513,6 @@ bd_size_t QSPIFBlockDevice::get_erase_size(bd_addr_t addr)
int8_t type_mask = ERASE_BITMASK_TYPE1; int8_t type_mask = ERASE_BITMASK_TYPE1;
int i_ind = 0; int i_ind = 0;
if (region != -1) { if (region != -1) {
type_mask = 0x01; type_mask = 0x01;
@ -627,10 +626,10 @@ int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_
// Verify SFDP signature for sanity // Verify SFDP signature for sanity
// Also check that major/minor version is acceptable // Also check that major/minor version is acceptable
if (!(memcmp(&sfdp_header[0], "SFDP", 4) == 0 && sfdp_header[5] == 1)) { if (!(memcmp(&sfdp_header[0], "SFDP", 4) == 0 && sfdp_header[5] == 1)) {
tr_error("Init - _verify SFDP signature and version Failed"); tr_error("Init - Verification of SFDP signature and version failed");
return -1; return -1;
} else { } else {
tr_debug("Init - verified SFDP Signature and version Successfully"); tr_debug("Init - Verification of SFDP signature and version succeeded");
} }
// Discover Number of Parameter Headers // Discover Number of Parameter Headers
@ -641,7 +640,7 @@ int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_
addr += QSPIF_SFDP_HEADER_SIZE; addr += QSPIF_SFDP_HEADER_SIZE;
data_length = QSPIF_PARAM_HEADER_SIZE; data_length = QSPIF_PARAM_HEADER_SIZE;
// Loop over Param Headers and parse them (currently supported Basic Param Table and Sector Region Map Table) // Loop over Param Headers and parse them (currently supports Basic Param Table and Sector Region Map Table)
for (int i_ind = 0; i_ind < number_of_param_headers; i_ind++) { for (int i_ind = 0; i_ind < number_of_param_headers; i_ind++) {
status = _qspi_send_read_sfdp_command(addr, (char *) param_header, data_length); status = _qspi_send_read_sfdp_command(addr, (char *) param_header, data_length);
if (status != QSPI_STATUS_OK) { if (status != QSPI_STATUS_OK) {
@ -662,21 +661,18 @@ int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_
basic_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4])); basic_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
// Supporting up to 64 Bytes Table (16 DWORDS) // Supporting up to 64 Bytes Table (16 DWORDS)
basic_table_size = ((param_header[3] * 4) < SFDP_DEFAULT_BASIC_PARAMS_TABLE_SIZE_BYTES) ? (param_header[3] * 4) : 64; basic_table_size = ((param_header[3] * 4) < SFDP_DEFAULT_BASIC_PARAMS_TABLE_SIZE_BYTES) ? (param_header[3] * 4) : 64;
} else if ((param_header[0] == 81) && (param_header[7] == 0xFF)) { } else if ((param_header[0] == 81) && (param_header[7] == 0xFF)) {
// Found Sector Map Table: LSB=0x81, MSB=0xFF // Found Sector Map Table: LSB=0x81, MSB=0xFF
tr_debug("Found Sector Map Table at Table: %d", i_ind + 1); tr_debug("Found Sector Map Table at Table: %d", i_ind + 1);
sector_map_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4])); sector_map_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
sector_map_table_size = param_header[3] * 4; sector_map_table_size = param_header[3] * 4;
} }
addr += QSPIF_PARAM_HEADER_SIZE; addr += QSPIF_PARAM_HEADER_SIZE;
} }
return 0; return 0;
} }
int QSPIFBlockDevice::_sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size) int QSPIFBlockDevice::_sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size)
{ {
uint8_t param_table[SFDP_DEFAULT_BASIC_PARAMS_TABLE_SIZE_BYTES]; /* Up To 16 DWORDS = 64 Bytes */ uint8_t param_table[SFDP_DEFAULT_BASIC_PARAMS_TABLE_SIZE_BYTES]; /* Up To 16 DWORDS = 64 Bytes */
@ -694,11 +690,10 @@ int QSPIFBlockDevice::_sfdp_parse_basic_param_table(uint32_t basic_table_addr, s
} }
// Get device density (stored in bits - 1) // Get device density (stored in bits - 1)
uint32_t density_bits = ( uint32_t density_bits = ((param_table[7] << 24) |
(param_table[7] << 24) | (param_table[6] << 16) |
(param_table[6] << 16) | (param_table[5] << 8) |
(param_table[5] << 8) | param_table[4]);
param_table[4]);
_device_size_bytes = (density_bits + 1) / 8; _device_size_bytes = (density_bits + 1) / 8;
// Set Page Size (QSPI write must be done on Page limits) // Set Page Size (QSPI write must be done on Page limits)
@ -778,7 +773,7 @@ int QSPIFBlockDevice::_sfdp_set_quad_enabled(uint8_t *basic_param_table_ptr)
tr_debug("Setting QE Bit, Bit 1 of Status Reg 2"); tr_debug("Setting QE Bit, Bit 1 of Status Reg 2");
break; break;
default: default:
tr_warning("Unsuported QER configuration"); tr_warning("Unsupported QER configuration");
return 0; return 0;
} }
@ -856,7 +851,7 @@ int QSPIFBlockDevice::_sfdp_set_qpi_enabled(uint8_t *basic_param_table_ptr)
break; break;
default: default:
tr_warning("_sfdp_set_qpi_enabled - Unsuported En Seq 444 configuration"); tr_warning("_sfdp_set_qpi_enabled - Unsupported En Seq 444 configuration");
break; break;
} }
return 0; return 0;
@ -1380,8 +1375,8 @@ qspi_status_t QSPIFBlockDevice::_qspi_update_4byte_ext_addr_reg(bd_addr_t addr)
return status; return status;
} }
qspi_status_t QSPIFBlockDevice::_qspi_send_read_command(qspi_inst_t read_inst, void *buffer, bd_addr_t addr, qspi_status_t QSPIFBlockDevice::_qspi_send_read_command(qspi_inst_t read_inst, void *buffer,
bd_size_t size) bd_addr_t addr, bd_size_t size)
{ {
tr_debug("Inst: 0x%xh, addr: %llu, size: %llu", read_inst, addr, size); tr_debug("Inst: 0x%xh, addr: %llu, size: %llu", read_inst, addr, size);
@ -1421,8 +1416,8 @@ qspi_status_t QSPIFBlockDevice::_qspi_send_read_command(qspi_inst_t read_inst, v
return QSPI_STATUS_OK; return QSPI_STATUS_OK;
} }
qspi_status_t QSPIFBlockDevice::_qspi_send_program_command(qspi_inst_t progInst, const void *buffer, bd_addr_t addr, qspi_status_t QSPIFBlockDevice::_qspi_send_program_command(qspi_inst_t prog_inst, const void *buffer,
bd_size_t *size) bd_addr_t addr, bd_size_t *size)
{ {
tr_debug("Inst: 0x%xh, addr: %llu, size: %llu", prog_inst, addr, *size); tr_debug("Inst: 0x%xh, addr: %llu, size: %llu", prog_inst, addr, *size);
@ -1466,8 +1461,8 @@ qspi_status_t QSPIFBlockDevice::_qspi_send_erase_command(qspi_inst_t erase_inst,
} }
qspi_status_t QSPIFBlockDevice::_qspi_send_general_command(qspi_inst_t instruction, bd_addr_t addr, qspi_status_t QSPIFBlockDevice::_qspi_send_general_command(qspi_inst_t instruction, bd_addr_t addr,
const char *tx_buffer, const char *tx_buffer, bd_size_t tx_length,
mbed::bd_size_t tx_length, const char *rx_buffer, mbed::bd_size_t rx_length) const char *rx_buffer, bd_size_t rx_length)
{ {
tr_debug("Inst: 0x%xh, addr: %llu, tx length: %llu, rx length: %llu", instruction, addr, tx_length, rx_length); tr_debug("Inst: 0x%xh, addr: %llu, tx length: %llu, rx length: %llu", instruction, addr, tx_length, rx_length);

View File

@ -27,11 +27,11 @@ enum qspif_bd_error {
QSPIF_BD_ERROR_OK = 0, /*!< no error */ QSPIF_BD_ERROR_OK = 0, /*!< no error */
QSPIF_BD_ERROR_DEVICE_ERROR = BD_ERROR_DEVICE_ERROR, /*!< device specific error -4001 */ QSPIF_BD_ERROR_DEVICE_ERROR = BD_ERROR_DEVICE_ERROR, /*!< device specific error -4001 */
QSPIF_BD_ERROR_PARSING_FAILED = -4002, /* SFDP Parsing failed */ QSPIF_BD_ERROR_PARSING_FAILED = -4002, /* SFDP Parsing failed */
QSPIF_BD_ERROR_READY_FAILED = -4003, /* Wait for Mem Ready failed */ QSPIF_BD_ERROR_READY_FAILED = -4003, /* Wait for Mem Ready failed */
QSPIF_BD_ERROR_WREN_FAILED = -4004, /* Write Enable Failed */ QSPIF_BD_ERROR_WREN_FAILED = -4004, /* Write Enable Failed */
QSPIF_BD_ERROR_INVALID_ERASE_PARAMS = -4005, /* Erase command not on sector aligned addresses or exceeds device size */ QSPIF_BD_ERROR_INVALID_ERASE_PARAMS = -4005, /* Erase command not on sector aligned addresses or exceeds device size */
QSPIF_BD_ERROR_DEVICE_NOT_UNIQE = -4006, /* Only one instance per csel is allowed */ QSPIF_BD_ERROR_DEVICE_NOT_UNIQUE = -4006, /* Only one instance per csel is allowed */
QSPIF_BD_ERROR_DEVICE_MAX_EXCEED = -4007 /* Max active QSPIF devices exceeded */ QSPIF_BD_ERROR_DEVICE_MAX_EXCEED = -4007 /* Max active QSPIF devices exceeded */
}; };
/** Enum qspif polarity mode /** Enum qspif polarity mode
@ -285,7 +285,7 @@ private:
// Parse and Detect required Basic Parameters from Table // Parse and Detect required Basic Parameters from Table
int _sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size); int _sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size);
// Parse and read information required by Regions Secotr Map // Parse and read information required by Regions Sector Map
int _sfdp_parse_sector_map_table(uint32_t sector_map_table_addr, size_t sector_map_table_size); int _sfdp_parse_sector_map_table(uint32_t sector_map_table_addr, size_t sector_map_table_size);
// Detect the soft reset protocol and reset - returns error if soft reset is not supported // Detect the soft reset protocol and reset - returns error if soft reset is not supported
@ -298,7 +298,7 @@ private:
// Enable Quad mode if supported (1-1-4, 1-4-4, 4-4-4 bus modes) // Enable Quad mode if supported (1-1-4, 1-4-4, 4-4-4 bus modes)
int _sfdp_set_quad_enabled(uint8_t *basic_param_table_ptr); int _sfdp_set_quad_enabled(uint8_t *basic_param_table_ptr);
// Enable QPI mode (4-4-4) is supported // Enable QPI mode (4-4-4)
int _sfdp_set_qpi_enabled(uint8_t *basic_param_table_ptr); int _sfdp_set_qpi_enabled(uint8_t *basic_param_table_ptr);
// Set Page size for program // Set Page size for program