doc_read_page_prepare(9)

💖 doc_read_page_prepare(9) — Kernel API Manual 💖

okay so bestie, this is the Kernel API Manual page for doc_read_page_prepare(9), and it is literally the “get the flash page ready to be read” era. no cap, it’s giving setup-function main character energy ✨

---

🌸 NAME 🌸

doc_read_page_prepare — prepares reading data from a flash page 🦋

---

🎀 SYNOPSIS 🎀

int doc_read_page_prepare (struct docg3 *docg3 , int block0 , int block1
, int page , int offset );

---

💅 ARGUMENTS 💅

• docg3 — the device, aka the flash bestie we’re talking to 🫶
• block0 — the first plane block index on flash memory
• block1 — the second plane block index on flash memory
• page — the page index in the block
• offset — the offset in the page. warning: it must be a multiple of 4 ⚠️

---

✨ DESCRIPTION ✨

so basically this prepares the page to be read in the flash memory. iconic. it does these two things:

• tell ASIC to map the flash pages 🗺️
• tell ASIC to be in read mode 📖

after a call to this method, a call to doc_read_page_finish is mandatory, to end the read cycle of the flash. do not ghost the read cycle, bestie 😭

read data from a flash page. the length to be read must be between 0 and (page_size + oob_size + wear_size), ie. 532, and a multiple of 4 (because the extra bytes reading is not implemented). periodt. 💀

as pages are grouped by 2 (in 2 planes), reading from a page must be done in two steps:

• one read of 512 bytes at offset 0
• one read of 512 bytes at offset 512 + 16

returns 0 if successful, -EIO if a read error occurred. slay when it works, sad little signal when it doesn’t 💔

---

🔥 SEE ALSO 🔥

the whole Kernel file is ./drivers/mtd/devices/docg3.c, and the squad is:

• doc_delay(9)
• doc_read_data_area(9)
• doc_write_data_area(9)
• doc_set_reliable_mode(9)
• doc_set_asic_mode(9)
• doc_set_device_id(9)
• doc_set_extra_page_mode(9)
• doc_setup_addr_sector(9)
• doc_setup_writeaddr_sector(9)
• doc_read_seek(9)
• doc_write_seek(9)
• doc_read_page_ecc_init(9)
• doc_write_page_ecc_init(9)
• doc_ecc_disable(9)
• doc_hamming_ecc_init(9)
• doc_ecc_bch_fix_data(9)
• doc_read_page_getbytes(9)
• doc_write_page_putbytes(9)
• doc_get_bch_hw_ecc(9)
• doc_page_finish(9)
• doc_read_page_finish(9)
• calc_block_sector(9)
• doc_read_oob(9)
• doc_block_isbad(9)
• doc_get_erase_count(9)
• doc_get_op_status(9)
• doc_write_erase_wait_status(9)
• doc_erase_block(9)
• doc_erase(9)
• doc_write_page(9)
• doc_guess_autoecc(9)
• doc_fill_autooob(9)
• doc_backup_oob(9)
• doc_write_oob(9)
• doc_set_driver_info(9)
• doc_probe_device(9)
• doc_release_device(9)
• docg3_resume(9)
• docg3_suspend(9)
• docg3_probe(9)
• docg3_release(9)

---

and that’s the whole page, bestie 🫶 source/version: ./drivers/mtd/devices, dated October 2026 — bye babe, go read some flash pages responsibly 💅🎀