1<html><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.78.1"><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="bugs.html" title="Chapter 2. Known Bugs And Assumptions"><link rel="next" href="Struct_member_identifiers_XXX.html" title="Struct member identifiers [XXX]"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><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="bugs.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="Struct_member_identifiers_XXX.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="dochints"></a>Chapter 3. Documentation hints</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="dochints.html#Function_identifiers_XXX">Function identifiers [XXX]</a></span></dt><dt><span class="sect1"><a href="Struct_member_identifiers_XXX.html">Struct member identifiers [XXX]</a></span></dt></dl></div><p> 2 The function and structure docs are autogenerated. Each function and 3 struct member has a short description which is marked with an [XXX] identifier. 4 The following chapters explain the meaning of those identifiers. 5 </p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="Function_identifiers_XXX"></a>Function identifiers [XXX]</h2></div></div></div><p> 6 The functions are marked with [XXX] identifiers in the short 7 comment. The identifiers explain the usage and scope of the 8 functions. Following identifiers are used: 9 </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> 10 [MTD Interface]</p><p> 11 These functions provide the interface to the MTD kernel API. 12 They are not replaceable and provide functionality 13 which is complete hardware independent. 14 </p></li><li class="listitem"><p> 15 [NAND Interface]</p><p> 16 These functions are exported and provide the interface to the NAND kernel API. 17 </p></li><li class="listitem"><p> 18 [GENERIC]</p><p> 19 Generic functions are not replaceable and provide functionality 20 which is complete hardware independent. 21 </p></li><li class="listitem"><p> 22 [DEFAULT]</p><p> 23 Default functions provide hardware related functionality which is suitable 24 for most of the implementations. These functions can be replaced by the 25 board driver if necessary. Those functions are called via pointers in the 26 NAND chip description structure. The board driver can set the functions which 27 should be replaced by board dependent functions before calling nand_scan(). 28 If the function pointer is NULL on entry to nand_scan() then the pointer 29 is set to the default function which is suitable for the detected chip type. 30 </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="bugs.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="Struct_member_identifiers_XXX.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> 31