1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 6.5.0.0 for Windows">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8
9<TITLE>HIO2ReadAsync</TITLE>
10</HEAD>
11<BODY>
12<H1 align="left">HIO2ReadAsync</H1>
13
14<H2>Syntax</H2>
15<dl><dd><pre class="construction">
16#include &lt;revolution/hio2.h&gt;
17
18BOOL    HIO2ReadAsync ( HIO2Handle handle, u32 addr, void* buffer, s32 size, HIO2DmaCallback callback );
19</pre></dd></dl>
20
21<H2>Arguments</H2>
22<TABLE class="arguments" border="1" >
23  <TBODY>
24    <TR>
25<TH>handle</TH>
26<TD>Handle retrieved using the <CODE>HIO2Open</CODE> function.</TD>
27    </TR>
28    <TR>
29<TH>addr</TH>
30<TD>Read address of shared memory for the EXI-USB interface. Must be 4-byte aligned.</TD>
31    </TR>
32    <TR>
33<TH>buffer</TH>
34<TD>Pointer to the buffer that stores the data to read. Must be 32-byte aligned.</TD>
35    </TR>
36    <TR>
37<TH>size</TH>
38<TD>Size of the data to read. Must be a multiple of 32 bytes.</TD>
39    </TR>
40    <TR>
41<TH>callback</TH>
42<TD>Callback function to call when data transfer completes.</TD>
43    </TR>
44  </TBODY>
45</TABLE>
46
47<H2>Return Values</H2>
48<P>This function returns <CODE>TRUE</CODE> if execution succeeds and <CODE>FALSE</CODE> if execution fails.</P>
49
50<H2>Description</H2>
51<P>The <CODE>HIO2ReadAsync</CODE> function reads the amount of data <SPAN class="argument">size</SPAN> from the start address <SPAN class="argument">addr</SPAN> in the specified shared memory and then stores the data in <SPAN class="argument">buffer</SPAN>. Data are read in 4-byte increments. This function returns immediately and does not wait until data transfer finishes. The specified <SPAN class="argument">callback</SPAN> function is called after all data is read.</P>
52
53<H2>See Also</H2>
54<P class="reference">
55<A href="HIO2DmaCallback.html">HIO2DmaCallback</A>
56</P>
57
58<H2>Revision History</H2>
59<P>
602006/05/29 Added link to <CODE>HIO2DmaCallback</CODE>.<br>2006/03/01 Initial version.<br>
61</P>
62
63<hr><p>CONFIDENTIAL</p></body>
64</HTML>