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_EraseFlashSectorAsync</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CARD_EraseFlashSectorAsync <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>
20  <BR>
21  <CODE>SDK_INLINE void	CARD_EraseFlashSectorAsync(
22	u32 dst, u32 len, MIDmaCallback callback, void *arg);</CODE><br>
23  <br>
24  </dd>
25</dl>
26<h2>Arguments</h2>
27<TABLE border="1" width="100%">
28  <TBODY>
29    <TR>
30      <TD width="13%"><EM><STRONG>dst</STRONG></EM></TD>
31      <TD width="87%">The flash memory address to erase.<br />
32	  <font color="#800000">This must be an integer multiple of the value obtained by the <A href="../common/CARD_GetBackupSectorSize.html"><CODE>CARD_GetBackupSectorSize</CODE></A> function.<br />
33	  For more about the sector size for each device, see <a href="../overview/about_Backup.html">Overview</a>.</font></TD>
34    </TR>
35    <TR>
36      <TD width="13%"><EM><STRONG>len</STRONG></EM></TD>
37      <TD width="87%">Number of bytes to erase.<br />
38	  <font color="#800000">This must be an integer multiple of the value obtained by the <A href="../common/CARD_GetBackupSectorSize.html"><CODE>CARD_GetBackupSectorSize</CODE></A> function.<br />
39	  For more about the sector size for each device, see <a href="../overview/about_Backup.html">Overview</a>.</font></TD>
40    </TR>
41    <TR>
42      <TD width="13%"><EM><STRONG>callback</STRONG></EM></TD>
43      <TD width="87%">Completion callback function.<BR>
44	  Specify <CODE>NULL</CODE> if this is unnecessary.<br>This callback is called from within the interrupt handler.</TD>
45    </TR>
46    <TR>
47      <TD width="13%"><EM><STRONG>arg</STRONG></EM></TD>
48      <TD width="87%">Arguments to pass to the completion callback function.<BR>
49	  This is simply ignored if <CODE>NULL</CODE> was specified for <CODE>callback</CODE>.</TD>
50    </TR>
51  </TBODY>
52</TABLE>
53
54<h2>Return Values</h2>
55<p>None.</p>
56
57<H2>Description</H2>
58<P>Deletes data on a FLASH device in sector units and initializes all data in the sector with 0xFF. This function immediately returns control. Use the <A href="../backup/CARD_WaitBackupAsync.html"><CODE>CARD_WaitBackupAsync</CODE></A> function to wait for processing to end. To determine the processing result, call the <A href="../common/CARD_GetResultCode.html"><CODE>CARD_GetResultCode</CODE></A> function after processing has ended.
59</p>
60<p>
61<font color="#800000">You must use this function in advance to erase the contents of the region specified as the destination for writing with the <A href="CARD_ProgramFlashAsync.html"><CODE>CARD_ProgramFlashAsync</CODE></A> function. We cannot guarantee integrity of the data written to a region that has not been erased.</font>For certain kinds of flash devices you can use the <A href="CARD_WriteFlash.html"><CODE>CARD_WriteFlash</CODE></A> function, which has fewer restrictions than these functions.
62</p>
63<p>
64To use this function, you must first lock the access bus with the <A href="../backup/CARD_LockBackup.html"><CODE>CARD_LockBackup</CODE></A> function.
65</p>
66<h2>Internal Operation</h2>
67<p><CODE><font color="#800000">This function communicates with the ARM7 processor internally via PXI.<br> The process will not end if PXI interrupts are not enabled.<br></font> <br> The function uses an internal thread to execute an asynchronous process. See the description of the <A href="../common/CARD_GetThreadPriority.html"><CODE>CARD_GetThreadPriority</CODE></A> function for more information on this thread.</p>
68<h2>See Also</h2>
69<p><CODE><A href="../backup/CARD_WaitBackupAsync.html">CARD_WaitBackupAsync</A>, <A href="../common/CARD_GetResultCode.html">CARD_GetResultCode</A>, <A href="CARD_IsBackupFlash.html">CARD_IsBackupFlash</A>, <A href="CARD_ProgramFlash.html">CARD_ProgramFlash</A>, <A href="CARD_ProgramFlashAsync.html">CARD_ProgramFlashAsync</A>, <A href="CARD_ProgramAndVerifyFlash.html">CARD_ProgramAndVerifyFlash</A>, <A href="CARD_ProgramAndVerifyFlashAsync.html">CARD_ProgramAndVerifyFlashAsync</A>, <A href="CARD_EraseFlashSector.html">CARD_EraseFlashSector</A>, <A href="CARD_EraseFlashSectorAsync.html">CARD_EraseFlashSectorAsync</A>, <A href="CARD_WriteFlashSector.html">CARD_WriteFlashSector</A>, <A href="CARD_WriteFlashSectorAsync.html">CARD_WriteFlashSectorAsync</A>, <A href="CARD_WriteAndVerifyFlashSector.html">CARD_WriteAndVerifyFlashSector</A>, <A href="CARD_WriteAndVerifyFlashSectorAsync.html">CARD_WriteAndVerifyFlashSectorAsync</A>, <A href="CARD_ReadFlash.html">CARD_ReadFlash</A>, <A href="CARD_WriteFlash.html">CARD_WriteFlash</A>, <A href="CARD_WriteAndVerifyFlash.html">CARD_WriteAndVerifyFlash</A>, <A href="CARD_VerifyFlash.html">CARD_VerifyFlash</A>, <A href="../common/CARD_GetThreadPriority.html">CARD_GetThreadPriority</A></CODE></p>
70
71<H2>Revision History</H2>
72<P>
732007/08/22 Initial version.
74</P>
75<hr><p>CONFIDENTIAL</p></body>
76</html>
77