Skip to content

Commit 19330da

Browse files
Matthew MacovskyKyle Kearney
Matthew Macovsky
authored and
Kyle Kearney
committed
Correct typos and formatting
1 parent 91141bb commit 19330da

File tree

2 files changed

+32
-37
lines changed

2 files changed

+32
-37
lines changed

‎components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.cpp

Lines changed: 27 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ using namespace mbed;
3838
#define QSPI_NO_ADDRESS_COMMAND UINT64_MAX
3939
#define QSPI_ALT_DEFAULT_VALUE 0
4040
// Status Register Bits
41-
#define QSPIF_STATUS_BIT_WIP 0x1 //Write In Progress
41+
#define QSPIF_STATUS_BIT_WIP 0x1 // Write In Progress
4242
#define QSPIF_STATUS_BIT_WEL 0x2 // Write Enable Latch
4343

4444
/* SFDP Header Parsing */
@@ -64,14 +64,14 @@ using namespace mbed;
6464
#define QSPIF_BASIC_PARAM_TABLE_QER_BYTE 58
6565
#define QSPIF_BASIC_PARAM_TABLE_444_MODE_EN_SEQ_BYTE 56
6666
// Erase Types Params
67-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_1_BYTE 29
68-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_2_BYTE 31
69-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_3_BYTE 33
70-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_4_BYTE 35
71-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_1_SIZE_BYTE 28
72-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_2_SIZE_BYTE 30
73-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_3_SIZE_BYTE 32
74-
#define QSPIF_BASIC_PARAM_ERASE_TYPE_4_SIZE_BYTE 34
67+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_1_BYTE 29
68+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_2_BYTE 31
69+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_3_BYTE 33
70+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_4_BYTE 35
71+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_1_SIZE_BYTE 28
72+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_2_SIZE_BYTE 30
73+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_3_SIZE_BYTE 32
74+
#define QSPIF_BASIC_PARAM_TABLE_ERASE_TYPE_4_SIZE_BYTE 34
7575
#define QSPIF_BASIC_PARAM_4K_ERASE_TYPE_BYTE 1
7676

7777
#define QSPIF_BASIC_PARAM_TABLE_SOFT_RESET_BYTE 61
@@ -183,7 +183,7 @@ int QSPIFBlockDevice::init()
183183
tr_debug("QSPIFBlockDevice csel: %d", (int)_csel);
184184
} else if (_unique_device_status == -1) {
185185
tr_error("QSPIFBlockDevice with the same csel(%d) already exists", (int)_csel);
186-
return QSPIF_BD_ERROR_DEVICE_NOT_UNIQE;
186+
return QSPIF_BD_ERROR_DEVICE_NOT_UNIQUE;
187187
} else {
188188
tr_error("Too many different QSPIFBlockDevice devices - max allowed: %d", QSPIF_MAX_ACTIVE_FLASH_DEVICES);
189189
return QSPIF_BD_ERROR_DEVICE_MAX_EXCEED;
@@ -223,7 +223,7 @@ int QSPIFBlockDevice::init()
223223
goto exit_point;
224224
}
225225

226-
//Synchronize Device
226+
// Synchronize Device
227227
if (false == _is_mem_ready()) {
228228
tr_error("Init - _is_mem_ready Failed");
229229
status = QSPIF_BD_ERROR_READY_FAILED;
@@ -513,7 +513,6 @@ bd_size_t QSPIFBlockDevice::get_erase_size(bd_addr_t addr)
513513
int8_t type_mask = ERASE_BITMASK_TYPE1;
514514
int i_ind = 0;
515515

516-
517516
if (region != -1) {
518517
type_mask = 0x01;
519518

@@ -627,10 +626,10 @@ int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_
627626
// Verify SFDP signature for sanity
628627
// Also check that major/minor version is acceptable
629628
if (!(memcmp(&sfdp_header[0], "SFDP", 4) == 0 && sfdp_header[5] == 1)) {
630-
tr_error("Init - _verify SFDP signature and version Failed");
629+
tr_error("Init - Verification of SFDP signature and version failed");
631630
return -1;
632631
} else {
633-
tr_debug("Init - verified SFDP Signature and version Successfully");
632+
tr_debug("Init - Verification of SFDP signature and version succeeded");
634633
}
635634

636635
// Discover Number of Parameter Headers
@@ -641,7 +640,7 @@ int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_
641640
addr += QSPIF_SFDP_HEADER_SIZE;
642641
data_length = QSPIF_PARAM_HEADER_SIZE;
643642

644-
// Loop over Param Headers and parse them (currently supported Basic Param Table and Sector Region Map Table)
643+
// Loop over Param Headers and parse them (currently supports Basic Param Table and Sector Region Map Table)
645644
for (int i_ind = 0; i_ind < number_of_param_headers; i_ind++) {
646645
status = _qspi_send_read_sfdp_command(addr, (char *) param_header, data_length);
647646
if (status != QSPI_STATUS_OK) {
@@ -662,21 +661,18 @@ int QSPIFBlockDevice::_sfdp_parse_sfdp_headers(uint32_t &basic_table_addr, size_
662661
basic_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
663662
// Supporting up to 64 Bytes Table (16 DWORDS)
664663
basic_table_size = ((param_header[3] * 4) < SFDP_DEFAULT_BASIC_PARAMS_TABLE_SIZE_BYTES) ? (param_header[3] * 4) : 64;
665-
666664
} else if ((param_header[0] == 81) && (param_header[7] == 0xFF)) {
667665
// Found Sector Map Table: LSB=0x81, MSB=0xFF
668666
tr_debug("Found Sector Map Table at Table: %d", i_ind + 1);
669667
sector_map_table_addr = ((param_header[6] << 16) | (param_header[5] << 8) | (param_header[4]));
670668
sector_map_table_size = param_header[3] * 4;
671-
672669
}
673670
addr += QSPIF_PARAM_HEADER_SIZE;
674-
675671
}
672+
676673
return 0;
677674
}
678675

679-
680676
int QSPIFBlockDevice::_sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size)
681677
{
682678
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
694690
}
695691

696692
// Get device density (stored in bits - 1)
697-
uint32_t density_bits = (
698-
(param_table[7] << 24) |
699-
(param_table[6] << 16) |
700-
(param_table[5] << 8) |
701-
param_table[4]);
693+
uint32_t density_bits = ((param_table[7] << 24) |
694+
(param_table[6] << 16) |
695+
(param_table[5] << 8) |
696+
param_table[4]);
702697
_device_size_bytes = (density_bits + 1) / 8;
703698

704699
// 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)
778773
tr_debug("Setting QE Bit, Bit 1 of Status Reg 2");
779774
break;
780775
default:
781-
tr_warning("Unsuported QER configuration");
776+
tr_warning("Unsupported QER configuration");
782777
return 0;
783778
}
784779

@@ -856,7 +851,7 @@ int QSPIFBlockDevice::_sfdp_set_qpi_enabled(uint8_t *basic_param_table_ptr)
856851
break;
857852

858853
default:
859-
tr_warning("_sfdp_set_qpi_enabled - Unsuported En Seq 444 configuration");
854+
tr_warning("_sfdp_set_qpi_enabled - Unsupported En Seq 444 configuration");
860855
break;
861856
}
862857
return 0;
@@ -1380,8 +1375,8 @@ qspi_status_t QSPIFBlockDevice::_qspi_update_4byte_ext_addr_reg(bd_addr_t addr)
13801375
return status;
13811376
}
13821377

1383-
qspi_status_t QSPIFBlockDevice::_qspi_send_read_command(qspi_inst_t read_inst, void *buffer, bd_addr_t addr,
1384-
bd_size_t size)
1378+
qspi_status_t QSPIFBlockDevice::_qspi_send_read_command(qspi_inst_t read_inst, void *buffer,
1379+
bd_addr_t addr, bd_size_t size)
13851380
{
13861381
tr_debug("Inst: 0x%xh, addr: %llu, size: %llu", read_inst, addr, size);
13871382

@@ -1421,8 +1416,8 @@ qspi_status_t QSPIFBlockDevice::_qspi_send_read_command(qspi_inst_t read_inst, v
14211416
return QSPI_STATUS_OK;
14221417
}
14231418

1424-
qspi_status_t QSPIFBlockDevice::_qspi_send_program_command(qspi_inst_t progInst, const void *buffer, bd_addr_t addr,
1425-
bd_size_t *size)
1419+
qspi_status_t QSPIFBlockDevice::_qspi_send_program_command(qspi_inst_t prog_inst, const void *buffer,
1420+
bd_addr_t addr, bd_size_t *size)
14261421
{
14271422
tr_debug("Inst: 0x%xh, addr: %llu, size: %llu", prog_inst, addr, *size);
14281423

@@ -1466,8 +1461,8 @@ qspi_status_t QSPIFBlockDevice::_qspi_send_erase_command(qspi_inst_t erase_inst,
14661461
}
14671462

14681463
qspi_status_t QSPIFBlockDevice::_qspi_send_general_command(qspi_inst_t instruction, bd_addr_t addr,
1469-
const char *tx_buffer,
1470-
mbed::bd_size_t tx_length, const char *rx_buffer, mbed::bd_size_t rx_length)
1464+
const char *tx_buffer, bd_size_t tx_length,
1465+
const char *rx_buffer, bd_size_t rx_length)
14711466
{
14721467
tr_debug("Inst: 0x%xh, addr: %llu, tx length: %llu, rx length: %llu", instruction, addr, tx_length, rx_length);
14731468

‎components/storage/blockdevice/COMPONENT_QSPIF/QSPIFBlockDevice.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ enum qspif_bd_error {
2727
QSPIF_BD_ERROR_OK = 0, /*!< no error */
2828
QSPIF_BD_ERROR_DEVICE_ERROR = BD_ERROR_DEVICE_ERROR, /*!< device specific error -4001 */
2929
QSPIF_BD_ERROR_PARSING_FAILED = -4002, /* SFDP Parsing failed */
30-
QSPIF_BD_ERROR_READY_FAILED = -4003, /* Wait for Mem Ready failed */
30+
QSPIF_BD_ERROR_READY_FAILED = -4003, /* Wait for Mem Ready failed */
3131
QSPIF_BD_ERROR_WREN_FAILED = -4004, /* Write Enable Failed */
3232
QSPIF_BD_ERROR_INVALID_ERASE_PARAMS = -4005, /* Erase command not on sector aligned addresses or exceeds device size */
33-
QSPIF_BD_ERROR_DEVICE_NOT_UNIQE = -4006, /* Only one instance per csel is allowed */
34-
QSPIF_BD_ERROR_DEVICE_MAX_EXCEED = -4007 /* Max active QSPIF devices exceeded */
33+
QSPIF_BD_ERROR_DEVICE_NOT_UNIQUE = -4006, /* Only one instance per csel is allowed */
34+
QSPIF_BD_ERROR_DEVICE_MAX_EXCEED = -4007 /* Max active QSPIF devices exceeded */
3535
};
3636

3737
/** Enum qspif polarity mode
@@ -285,7 +285,7 @@ class QSPIFBlockDevice : public mbed::BlockDevice {
285285
// Parse and Detect required Basic Parameters from Table
286286
int _sfdp_parse_basic_param_table(uint32_t basic_table_addr, size_t basic_table_size);
287287

288-
// Parse and read information required by Regions Secotr Map
288+
// Parse and read information required by Regions Sector Map
289289
int _sfdp_parse_sector_map_table(uint32_t sector_map_table_addr, size_t sector_map_table_size);
290290

291291
// Detect the soft reset protocol and reset - returns error if soft reset is not supported
@@ -298,7 +298,7 @@ class QSPIFBlockDevice : public mbed::BlockDevice {
298298
// Enable Quad mode if supported (1-1-4, 1-4-4, 4-4-4 bus modes)
299299
int _sfdp_set_quad_enabled(uint8_t *basic_param_table_ptr);
300300

301-
// Enable QPI mode (4-4-4) is supported
301+
// Enable QPI mode (4-4-4)
302302
int _sfdp_set_qpi_enabled(uint8_t *basic_param_table_ptr);
303303

304304
// Set Page size for program

0 commit comments

Comments
 (0)