<?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 3. Documentation hints</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="ch02.html" title="Chapter 2. Known Bugs And Assumptions" /><link rel="next" href="ch03s02.html" title="Struct member identifiers [XXX]" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Documentation hints</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch03s02.html">Next</a></td></tr></table><hr /></div><div class="chapter" title="Chapter 3. Documentation hints"><div class="titlepage"><div><div><h2 class="title"><a id="dochints"></a>Chapter 3. Documentation hints</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="ch03.html#Function_identifiers_XXX">Function identifiers [XXX]</a></span></dt><dt><span class="sect1"><a href="ch03s02.html">Struct member identifiers [XXX]</a></span></dt></dl></div><p>
The function and structure docs are autogenerated. Each function and
struct member has a short description which is marked with an [XXX] identifier.
The following chapters explain the meaning of those identifiers.
</p><div class="sect1" title="Function identifiers [XXX]"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Function_identifiers_XXX"></a>Function identifiers [XXX]</h2></div></div></div><p>
The functions are marked with [XXX] identifiers in the short
comment. The identifiers explain the usage and scope of the
functions. Following identifiers are used:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
[MTD Interface]</p><p>
These functions provide the interface to the MTD kernel API.
They are not replacable and provide functionality
which is complete hardware independent.
</p></li><li class="listitem"><p>
[NAND Interface]</p><p>
These functions are exported and provide the interface to the NAND kernel API.
</p></li><li class="listitem"><p>
[GENERIC]</p><p>
Generic functions are not replacable and provide functionality
which is complete hardware independent.
</p></li><li class="listitem"><p>
[DEFAULT]</p><p>
Default functions provide hardware related functionality which is suitable
for most of the implementations. These functions can be replaced by the
board driver if neccecary. Those functions are called via pointers in the
NAND chip description structure. The board driver can set the functions which
should be replaced by board dependent functions before calling nand_scan().
If the function pointer is NULL on entry to nand_scan() then the pointer
is set to the default function which is suitable for the detected chip type.
</p></li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch03s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. Known Bugs And Assumptions </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Struct member identifiers [XXX]</td></tr></table></div></body></html>
