<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>Chapter 11. Internal Functions Provided</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="MTD NAND Driver Programming Interface" /><link rel="up" href="index.html" title="MTD NAND Driver Programming Interface" /><link rel="prev" href="re19.html" title="nand_correct_data" /><link rel="next" href="re20.html" title="nand_release_device" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 11. Internal Functions Provided</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re19.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="re20.html">Next</a></td></tr></table><hr /></div><div class="chapter" title="Chapter 11. Internal Functions Provided"><div class="titlepage"><div><div><h2 class="title"><a id="intfunctions"></a>Chapter 11. Internal Functions Provided</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="refentrytitle"><a href="re20.html"><span>nand_release_device</span></a></span><span class="refpurpose"> —
[GENERIC] release chip
</span></dt><dt><span class="refentrytitle"><a href="re21.html"><span>nand_read_byte</span></a></span><span class="refpurpose"> —
[DEFAULT] read one byte from the chip
</span></dt><dt><span class="refentrytitle"><a href="re22.html"><span>nand_read_byte16</span></a></span><span class="refpurpose"> —
[DEFAULT] read one byte endianess aware from the chip
</span></dt><dt><span class="refentrytitle"><a href="re23.html"><span>nand_read_word</span></a></span><span class="refpurpose"> —
[DEFAULT] read one word from the chip
</span></dt><dt><span class="refentrytitle"><a href="re24.html"><span>nand_select_chip</span></a></span><span class="refpurpose"> —
[DEFAULT] control CE line
</span></dt><dt><span class="refentrytitle"><a href="re25.html"><span>nand_write_buf</span></a></span><span class="refpurpose"> —
[DEFAULT] write buffer to chip
</span></dt><dt><span class="refentrytitle"><a href="re26.html"><span>nand_read_buf</span></a></span><span class="refpurpose"> —
[DEFAULT] read chip data into buffer
</span></dt><dt><span class="refentrytitle"><a href="re27.html"><span>nand_verify_buf</span></a></span><span class="refpurpose"> —
[DEFAULT] Verify chip data against buffer
</span></dt><dt><span class="refentrytitle"><a href="re28.html"><span>nand_write_buf16</span></a></span><span class="refpurpose"> —
[DEFAULT] write buffer to chip
</span></dt><dt><span class="refentrytitle"><a href="re29.html"><span>nand_read_buf16</span></a></span><span class="refpurpose"> —
[DEFAULT] read chip data into buffer
</span></dt><dt><span class="refentrytitle"><a href="re30.html"><span>nand_verify_buf16</span></a></span><span class="refpurpose"> —
[DEFAULT] Verify chip data against buffer
</span></dt><dt><span class="refentrytitle"><a href="re31.html"><span>nand_block_bad</span></a></span><span class="refpurpose"> —
[DEFAULT] Read bad block marker from the chip
</span></dt><dt><span class="refentrytitle"><a href="re32.html"><span>nand_default_block_markbad</span></a></span><span class="refpurpose"> —
[DEFAULT] mark a block bad
</span></dt><dt><span class="refentrytitle"><a href="re33.html"><span>nand_check_wp</span></a></span><span class="refpurpose"> —
[GENERIC] check if the chip is write protected
</span></dt><dt><span class="refentrytitle"><a href="re34.html"><span>nand_block_checkbad</span></a></span><span class="refpurpose"> —
[GENERIC] Check if a block is marked bad
</span></dt><dt><span class="refentrytitle"><a href="re35.html"><span>nand_command</span></a></span><span class="refpurpose"> —
[DEFAULT] Send command to NAND device
</span></dt><dt><span class="refentrytitle"><a href="re36.html"><span>nand_command_lp</span></a></span><span class="refpurpose"> —
[DEFAULT] Send command to NAND large page device
</span></dt><dt><span class="refentrytitle"><a href="re37.html"><span>nand_get_device</span></a></span><span class="refpurpose"> —
[GENERIC] Get chip for selected access
</span></dt><dt><span class="refentrytitle"><a href="re38.html"><span>nand_wait</span></a></span><span class="refpurpose"> —
[DEFAULT] wait until the command is done
</span></dt><dt><span class="refentrytitle"><a href="re39.html"><span>nand_read_page_raw</span></a></span><span class="refpurpose"> —
[Intern] read raw page data without ecc
</span></dt><dt><span class="refentrytitle"><a href="re40.html"><span>nand_read_page_raw_syndrome</span></a></span><span class="refpurpose"> —
[Intern] read raw page data without ecc
</span></dt><dt><span class="refentrytitle"><a href="re41.html"><span>nand_read_page_swecc</span></a></span><span class="refpurpose"> —
[REPLACABLE] software ecc based page read function
</span></dt><dt><span class="refentrytitle"><a href="re42.html"><span>nand_read_subpage</span></a></span><span class="refpurpose"> —
[REPLACABLE] software ecc based sub-page read function
</span></dt><dt><span class="refentrytitle"><a href="re43.html"><span>nand_read_page_hwecc</span></a></span><span class="refpurpose"> —
[REPLACABLE] hardware ecc based page read function
</span></dt><dt><span class="refentrytitle"><a href="re44.html"><span>nand_read_page_hwecc_oob_first</span></a></span><span class="refpurpose"> —
[REPLACABLE] hw ecc, read oob first
</span></dt><dt><span class="refentrytitle"><a href="re45.html"><span>nand_read_page_syndrome</span></a></span><span class="refpurpose"> —
[REPLACABLE] hardware ecc syndrom based page read
</span></dt><dt><span class="refentrytitle"><a href="re46.html"><span>nand_transfer_oob</span></a></span><span class="refpurpose"> —
[Internal] Transfer oob to client buffer
</span></dt><dt><span class="refentrytitle"><a href="re47.html"><span>nand_do_read_ops</span></a></span><span class="refpurpose"> —
[Internal] Read data with ECC
</span></dt><dt><span class="refentrytitle"><a href="re48.html"><span>nand_read</span></a></span><span class="refpurpose"> —
[MTD Interface] MTD compability function for nand_do_read_ecc
</span></dt><dt><span class="refentrytitle"><a href="re49.html"><span>nand_read_oob_std</span></a></span><span class="refpurpose"> —
[REPLACABLE] the most common OOB data read function
</span></dt><dt><span class="refentrytitle"><a href="re50.html"><span>nand_read_oob_syndrome</span></a></span><span class="refpurpose"> —
[REPLACABLE] OOB data read function for HW ECC with syndromes
</span></dt><dt><span class="refentrytitle"><a href="re51.html"><span>nand_write_oob_std</span></a></span><span class="refpurpose"> —
[REPLACABLE] the most common OOB data write function
</span></dt><dt><span class="refentrytitle"><a href="re52.html"><span>nand_write_oob_syndrome</span></a></span><span class="refpurpose"> —
[REPLACABLE] OOB data write function for HW ECC with syndrome - only for large page flash !
</span></dt><dt><span class="refentrytitle"><a href="re53.html"><span>nand_do_read_oob</span></a></span><span class="refpurpose"> —
[Intern] NAND read out-of-band
</span></dt><dt><span class="refentrytitle"><a href="re54.html"><span>nand_read_oob</span></a></span><span class="refpurpose"> —
[MTD Interface] NAND read data and/or out-of-band
</span></dt><dt><span class="refentrytitle"><a href="re55.html"><span>nand_write_page_raw</span></a></span><span class="refpurpose"> —
[Intern] raw page write function
</span></dt><dt><span class="refentrytitle"><a href="re56.html"><span>nand_write_page_raw_syndrome</span></a></span><span class="refpurpose"> —
[Intern] raw page write function
</span></dt><dt><span class="refentrytitle"><a href="re57.html"><span>nand_write_page_swecc</span></a></span><span class="refpurpose"> —
[REPLACABLE] software ecc based page write function
</span></dt><dt><span class="refentrytitle"><a href="re58.html"><span>nand_write_page_hwecc</span></a></span><span class="refpurpose"> —
[REPLACABLE] hardware ecc based page write function
</span></dt><dt><span class="refentrytitle"><a href="re59.html"><span>nand_write_page_syndrome</span></a></span><span class="refpurpose"> —
[REPLACABLE] hardware ecc syndrom based page write
</span></dt><dt><span class="refentrytitle"><a href="re60.html"><span>nand_write_page</span></a></span><span class="refpurpose"> —
[REPLACEABLE] write one page
</span></dt><dt><span class="refentrytitle"><a href="re61.html"><span>nand_fill_oob</span></a></span><span class="refpurpose"> —
[Internal] Transfer client buffer to oob
</span></dt><dt><span class="refentrytitle"><a href="re62.html"><span>nand_do_write_ops</span></a></span><span class="refpurpose"> —
[Internal] NAND write with ECC
</span></dt><dt><span class="refentrytitle"><a href="re63.html"><span>nand_write</span></a></span><span class="refpurpose"> —
[MTD Interface] NAND write with ECC
</span></dt><dt><span class="refentrytitle"><a href="re64.html"><span>nand_do_write_oob</span></a></span><span class="refpurpose"> —
[MTD Interface] NAND write out-of-band
</span></dt><dt><span class="refentrytitle"><a href="re65.html"><span>nand_write_oob</span></a></span><span class="refpurpose"> —
[MTD Interface] NAND write data and/or out-of-band
</span></dt><dt><span class="refentrytitle"><a href="re66.html"><span>single_erase_cmd</span></a></span><span class="refpurpose"> —
[GENERIC] NAND standard block erase command function
</span></dt><dt><span class="refentrytitle"><a href="re67.html"><span>multi_erase_cmd</span></a></span><span class="refpurpose"> —
[GENERIC] AND specific block erase command function
</span></dt><dt><span class="refentrytitle"><a href="re68.html"><span>nand_erase</span></a></span><span class="refpurpose"> —
[MTD Interface] erase block(s)
</span></dt><dt><span class="refentrytitle"><a href="re69.html"><span>nand_erase_nand</span></a></span><span class="refpurpose"> —
[Internal] erase block(s)
</span></dt><dt><span class="refentrytitle"><a href="re70.html"><span>nand_sync</span></a></span><span class="refpurpose"> —
[MTD Interface] sync
</span></dt><dt><span class="refentrytitle"><a href="re71.html"><span>nand_block_isbad</span></a></span><span class="refpurpose"> —
[MTD Interface] Check if block at offset is bad
</span></dt><dt><span class="refentrytitle"><a href="re72.html"><span>nand_block_markbad</span></a></span><span class="refpurpose"> —
[MTD Interface] Mark block at the given offset as bad
</span></dt><dt><span class="refentrytitle"><a href="re73.html"><span>nand_suspend</span></a></span><span class="refpurpose"> —
[MTD Interface] Suspend the NAND flash
</span></dt><dt><span class="refentrytitle"><a href="re74.html"><span>nand_resume</span></a></span><span class="refpurpose"> —
[MTD Interface] Resume the NAND flash
</span></dt><dt><span class="refentrytitle"><a href="re75.html"><span>check_pattern</span></a></span><span class="refpurpose"> —
[GENERIC] check if a pattern is in the buffer
</span></dt><dt><span class="refentrytitle"><a href="re76.html"><span>check_short_pattern</span></a></span><span class="refpurpose"> —
[GENERIC] check if a pattern is in the buffer
</span></dt><dt><span class="refentrytitle"><a href="re77.html"><span>read_bbt</span></a></span><span class="refpurpose"> —
[GENERIC] Read the bad block table starting from page
</span></dt><dt><span class="refentrytitle"><a href="re78.html"><span>read_abs_bbt</span></a></span><span class="refpurpose"> —
[GENERIC] Read the bad block table starting at a given page
</span></dt><dt><span class="refentrytitle"><a href="re79.html"><span>read_abs_bbts</span></a></span><span class="refpurpose"> —
[GENERIC] Read the bad block table(s) for all chips starting at a given page
</span></dt><dt><span class="refentrytitle"><a href="re80.html"><span>create_bbt</span></a></span><span class="refpurpose"> —
[GENERIC] Create a bad block table by scanning the device
</span></dt><dt><span class="refentrytitle"><a href="re81.html"><span>search_bbt</span></a></span><span class="refpurpose"> —
[GENERIC] scan the device for a specific bad block table
</span></dt><dt><span class="refentrytitle"><a href="re82.html"><span>search_read_bbts</span></a></span><span class="refpurpose"> —
[GENERIC] scan the device for bad block table(s)
</span></dt><dt><span class="refentrytitle"><a href="re83.html"><span>write_bbt</span></a></span><span class="refpurpose"> —
[GENERIC] (Re)write the bad block table
</span></dt><dt><span class="refentrytitle"><a href="re84.html"><span>nand_memory_bbt</span></a></span><span class="refpurpose"> —
[GENERIC] create a memory based bad block table
</span></dt><dt><span class="refentrytitle"><a href="re85.html"><span>check_create</span></a></span><span class="refpurpose"> —
[GENERIC] create and write bbt(s) if necessary
</span></dt><dt><span class="refentrytitle"><a href="re86.html"><span>mark_bbt_region</span></a></span><span class="refpurpose"> —
[GENERIC] mark the bad block table regions
</span></dt><dt><span class="refentrytitle"><a href="re87.html"><span>nand_update_bbt</span></a></span><span class="refpurpose"> —
[NAND Interface] update bad block table(s)
</span></dt><dt><span class="refentrytitle"><a href="re88.html"><span>nand_isbad_bbt</span></a></span><span class="refpurpose"> —
[NAND Interface] Check if a block is bad
</span></dt></dl></div><p>
This chapter contains the autogenerated documentation of the NAND driver internal functions.
Each function has a short description which is marked with an [XXX] identifier.
See the chapter "Documentation hints" for an explanation.
The functions marked with [DEFAULT] might be relevant for a board driver developer.
</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re19.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="re20.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>nand_correct_data</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>nand_release_device</span></td></tr></table></div></body></html>
