1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>CARD_ReadFlash</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CARD_ReadFlash <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></H1>
15<H2>Syntax</H2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/card.h&gt;</CODE><BR> <BR> <CODE>BOOL	CARD_ReadFlash(u32 src, void *dst, u32 len);</CODE><br> <br>
20  </dd>
21</dl>
22<h2>Arguments</h2>
23<TABLE border="1" width="100%">
24  <TBODY>
25    <TR>
26<TD width="13%"><CODE>src</CODE></TD>
27<TD width="87%">The FLASH address of the transfer source</TD>
28    </TR>
29    <TR>
30<TD width="13%"><CODE>dst</CODE></TD>
31<TD width="87%">Transfer destination memory address.</TD>
32    </TR>
33    <TR>
34<TD width="13%"><CODE>len</CODE></TD>
35<TD width="87%">Length of data being read, in bytes.</TD>
36    </TR>
37  </TBODY>
38</TABLE>
39
40<h2>Return Values</h2>
41<p>TRUE if the process succeeds. FALSE otherwise.</p>
42
43<H2>Description</H2>
44<P>This function synchronously reads out data from the FLASH device. The function does not return control until it has finished processing. It returns TRUE if the process was successful or FALSE if it failed. To get the value when processing fails, call the <A href="../common/CARD_GetResultCode.html"><CODE>CARD_GetResultCode</CODE></A> function. To use this function, you must first lock the access bus with the <A href="../backup/CARD_LockBackup.html"><CODE>CARD_LockBackup</CODE></A> function. <BR> This function communicates with the ARM7 processor internally via PXI.<br> The process will not end if PXI interrupts are not enabled.<br> <br>
45</P>
46<h2>See Also</h2>
47<p><CODE><A href="../common/CARD_GetResultCode.html">CARD_GetResultCode</A><BR> <A href="CARD_IsBackupFlash.html">CARD_IsBackupFlash</A><BR> <A href="CARD_ReadFlashAsync.html">CARD_ReadFlashAsync</A><BR> <A href="CARD_VerifyFlash.html">CARD_VerifyFlash</A><BR> <A href="CARD_WriteAndVerifyFlash.html">CARD_WriteAndVerifyFlash</A><BR> <A href="CARD_WriteFlash.html">CARD_WriteFlash</A></CODE></p>
48
49<H2>Revision History</H2>
50<P>
512004/12/09 Changed &quot;IO processor&quot; to &quot;ARM7 processor&quot;. <br>2004/08/31 Added a description of the <code>CARD_GetResultCode</code> function. <br>2004/08/23 Revised links due to function changes. <BR>2004/08/18 Initial version.<BR>
52</P>
53<hr><p>CONFIDENTIAL</p></body>
54</html>
55