Skip to content

Commit

Permalink
Fix support for CircuitPython block device (Fat) and add full Flash T…
Browse files Browse the repository at this point in the history 
…ranslation Layer (prevents doing lots of erases)

Change Fat sector size back to 512, and consequently add in flash translation error - wasn't needed before with 4096 sector size

Also enable LFN support
  • Loading branch information
@will-v-pi
will-v-pi committed Dec 19, 2024
1 parent 693f3b3 commit ba574e8
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 42 deletions.
1 change: 1 addition & 0 deletions lib/oofatfs/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ cc_library(
name = "fatfs",
srcs = [
"src/ff.c",
"src/ffunicode.c",
],
hdrs = [
"src/ff.h",
Expand Down
3 changes: 2 additions & 1 deletion lib/oofatfs/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
add_library(fatfs INTERFACE)

target_sources(fatfs INTERFACE
${CMAKE_CURRENT_LIST_DIR}/src/ff.c)
${CMAKE_CURRENT_LIST_DIR}/src/ff.c
${CMAKE_CURRENT_LIST_DIR}/src/ffunicode.c)

target_include_directories(fatfs INTERFACE ${CMAKE_CURRENT_LIST_DIR}/src)
8 changes: 4 additions & 4 deletions lib/oofatfs/src/ffconf.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
*/


#define FF_USE_LFN 0
#define FF_USE_LFN 1
#define FF_MAX_LFN 255
/* The FF_USE_LFN switches the support for LFN (long file name).
/
Expand Down Expand Up @@ -198,8 +198,8 @@
/ funciton will be available. */


#define FF_MIN_SS 4096
#define FF_MAX_SS 4096
#define FF_MIN_SS 512
#define FF_MAX_SS 512
/* This set of options configures the range of sector size to be supported. (512,
/ 1024, 2048 or 4096) Always set both 512 for most systems, generic memory card and
/ harddisk. But a larger value may be required for on-board flash memory and some
Expand All @@ -208,7 +208,7 @@
/ GET_SECTOR_SIZE command. */


#define FF_USE_TRIM 0
#define FF_USE_TRIM 1
/* This option switches support for ATA-TRIM. (0:Disable or 1:Enable)
/ To enable Trim function, also CTRL_TRIM command should be implemented to the
/ disk_ioctl() function. */
Expand Down
115 changes: 78 additions & 37 deletions main.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2083,34 +2083,45 @@ struct picoboot_memory_access : public memory_access {
vector<uint8_t> write_data; // used when erasing flash
if (flash == get_memory_type(address, model)) {
connection.exit_xip();
if (erase) {
// Do automatically erase flash, and make it aligned
// we have to erase in whole pages
range aligned_range(address & ~(FLASH_SECTOR_ERASE_SIZE - 1),
((address + size) & ~(FLASH_SECTOR_ERASE_SIZE - 1)) + FLASH_SECTOR_ERASE_SIZE);
assert(aligned_range.contains(address));
assert(aligned_range.contains(address + size));

uint32_t pre_len = address - aligned_range.from;
uint32_t post_len = aligned_range.to - (address + size);
assert(pre_len + size + post_len == aligned_range.len());

// save data before the changing data
write_data.resize(pre_len);
if (pre_len) read(aligned_range.from, write_data.data(), write_data.size(), false);
// now add the data that is changing
write_data.insert(write_data.end(), buffer, buffer + size);
// save data after the changing data
write_data.resize(aligned_range.len());
if (post_len) read(address + size, write_data.data() + pre_len + size, post_len, false);

// Do the erase
connection.flash_erase(aligned_range.from, aligned_range.len());

// Update what will now be written
address = aligned_range.from;
buffer = write_data.data();
size = aligned_range.len();
// Flash Translation Layer - auto-erase, and only write changed data
if (enable_ftl) {
// Check what's there already
write_data.resize(size);
read(address, write_data.data(), size, false);
// Check if we even need to write
if (std::equal(write_data.cbegin(), write_data.cend(), buffer)) {
return;
}
// Check if we need to erase (ie check for non 0xff)
if (!std::all_of(write_data.cbegin(), write_data.cend(), [](uint8_t v) { return v == 0xff; })) {
// Do automatically erase flash, and make it aligned
// we have to erase in whole pages
range aligned_range(address & ~(FLASH_SECTOR_ERASE_SIZE - 1),
((address + size) & ~(FLASH_SECTOR_ERASE_SIZE - 1)) + FLASH_SECTOR_ERASE_SIZE);
assert(aligned_range.contains(address));
assert(aligned_range.contains(address + size));

uint32_t pre_len = address - aligned_range.from;
uint32_t post_len = aligned_range.to - (address + size);
assert(pre_len + size + post_len == aligned_range.len());

// save data before the changing data
write_data.resize(pre_len);
if (pre_len) read(aligned_range.from, write_data.data(), write_data.size(), false);
// now add the data that is changing
write_data.insert(write_data.end(), buffer, buffer + size);
// save data after the changing data
write_data.resize(aligned_range.len());
if (post_len) read(address + size, write_data.data() + pre_len + size, post_len, false);

// Do the erase
connection.flash_erase(aligned_range.from, aligned_range.len());

// Update what will now be written
address = aligned_range.from;
buffer = write_data.data();
size = aligned_range.len();
}
}
}
if (is_transfer_aligned(address, model) && is_transfer_aligned(address + size, model)) {
Expand All @@ -2128,7 +2139,8 @@ struct picoboot_memory_access : public memory_access {
write(addr, (uint8_t *)v.data(), v.size() * sizeof(typename raw_type_mapping<T>::access_type));
}

bool erase = false;
// Enable Flash Translation Layer, which performs automatic erase, and only writes changed data
bool enable_ftl = false;
private:
picoboot::connection& connection;
};
Expand Down Expand Up @@ -4122,7 +4134,7 @@ bool config_command::execute(device_map &devices) {
picoboot::connection connection(std::get<2>(handles), std::get<0>(handles));
picoboot_memory_access access(connection);
// Enable auto-erase
access.erase = true;
access.enable_ftl = true;
auto partitions = get_partitions(connection);
vector<uint32_t> starts;
if (partitions) {
Expand Down Expand Up @@ -5395,7 +5407,12 @@ void setup_bdevfs(picoboot::connection con) {
string s = ss.str();
fos << "embedded drive: " << s << "\n";

bdevfs_setup.base_addr = bi_bdev.address;
if (bi_bdev.address < FLASH_START) {
// Some devices have the block device address relative to the start of flash
bdevfs_setup.base_addr = bi_bdev.address + FLASH_START;
} else {
bdevfs_setup.base_addr = bi_bdev.address;
}
bdevfs_setup.size = bi_bdev.size;
});
visitor.visit(access, hdr);
Expand Down Expand Up @@ -5452,15 +5469,17 @@ DWORD get_fattime (void) {
return fattime;
}

static_assert(FF_MAX_SS == FF_MIN_SS, "FF_MAX_SS must be equal to FF_MIN_SS");
#define SECTOR_SIZE FF_MAX_SS

DRESULT disk_read (void *drv, BYTE* buff, DWORD sector, UINT count) {
bdevfs_setup.access->read(bdevfs_setup.base_addr + (sector * FF_MAX_SS), (uint8_t*)buff, count * FF_MAX_SS, false);
bdevfs_setup.access->read(bdevfs_setup.base_addr + (sector * SECTOR_SIZE), (uint8_t*)buff, count * SECTOR_SIZE, false);
return RES_OK;
}

DRESULT disk_write (void *drv, const BYTE* buff, DWORD sector, UINT count) {
if (bdevfs_setup.writeable) {
bdevfs_setup.access->write(bdevfs_setup.base_addr + (sector * FF_MAX_SS), (uint8_t*)buff, count * FF_MAX_SS);
bdevfs_setup.access->write(bdevfs_setup.base_addr + (sector * SECTOR_SIZE), (uint8_t*)buff, count * SECTOR_SIZE);
return RES_OK;
} else {
fail(ERROR_NOT_POSSIBLE, "This block device is not writeable");
Expand All @@ -5474,11 +5493,15 @@ DRESULT disk_ioctl (void *drv, BYTE cmd, void* buff) {
return RES_OK;

case GET_SECTOR_COUNT:
*(DWORD*)buff = bdevfs_setup.size / FF_MAX_SS;
*(DWORD*)buff = bdevfs_setup.size / SECTOR_SIZE;
return RES_OK;

case GET_SECTOR_SIZE:
*(DWORD*)buff = SECTOR_SIZE;
return RES_OK;

case GET_BLOCK_SIZE:
*(DWORD*)buff = FLASH_SECTOR_ERASE_SIZE / FF_MAX_SS;
*(DWORD*)buff = FLASH_SECTOR_ERASE_SIZE / SECTOR_SIZE;
return RES_OK;

case IOCTL_INIT:
Expand All @@ -5488,6 +5511,24 @@ DRESULT disk_ioctl (void *drv, BYTE cmd, void* buff) {
return RES_OK;
}

case CTRL_TRIM: {
if (bdevfs_setup.writeable) {
DWORD* p = (DWORD*)buff;
uint32_t start = (*p * SECTOR_SIZE) + bdevfs_setup.base_addr;
uint32_t end = (*(p + 1) * SECTOR_SIZE) + bdevfs_setup.base_addr;
// Only trim complete flash sectors
if (start % FLASH_SECTOR_ERASE_SIZE) start += FLASH_SECTOR_ERASE_SIZE - (start % FLASH_SECTOR_ERASE_SIZE);
end -= end % FLASH_SECTOR_ERASE_SIZE;
for (uint32_t addr = start; addr < end; addr += FLASH_SECTOR_ERASE_SIZE) {
bdevfs_setup.con->flash_erase(addr, FLASH_SECTOR_ERASE_SIZE);
}
return RES_OK;
} else {
fail(ERROR_NOT_POSSIBLE, "This block device is not writeable");
return RES_WRPRT;
}
}

default:
fail(ERROR_NOT_POSSIBLE, "Unknown ioctl %d", cmd);
return RES_PARERR;
Expand Down Expand Up @@ -5559,14 +5600,14 @@ void do_fatfs_op(fatfs_op_fn fatfs_op) {
FATFS fatfs;

// Enable auto-erase, as FatFS has no Flash Translation Layer
bdevfs_setup.access->erase = true;
bdevfs_setup.access->enable_ftl = true;

int err = f_mount(&fatfs);
if (err == FR_NO_FILESYSTEM) {
if (settings.bdev.format) {
if (bdevfs_setup.formattable) {
fos << "Formatting FatFS file system\n";
uint8_t work_buf[FF_MAX_SS];
uint8_t work_buf[SECTOR_SIZE];
err = f_mkfs(&fatfs, FM_ANY | FM_SFD, 0, work_buf, sizeof(work_buf));
if (err) {
fail(ERROR_CONNECTION, "FatFS Format Error %d", err);
Expand Down

0 comments on commit ba574e8

Please sign in to comment.