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>MI_CancelWram</title> 9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13 14<h1 align="left">MI_CancelWram* <IMG src="../../image/TWL.gif" align="middle"></h1> 15<h2>Syntax</h2> 16 17<dl> 18 <dd> 19<CODE>#include <twl/mi.h></CODE><BR> 20 <BR> 21 <CODE>void MI_CancelWram( <A href="../mi_constant.html">MIWramPos</A> wram, <A href="../mi_constant.html">MIWramProc</A> proc )</CODE><br> 22 <CODE>void MI_CancelWramSlot( <A href="../mi_constant.html">MIWramPos</A> wram, int slot, MIWramSize size, <A href="../mi_constant.html">MIWramProc</A> proc )</CODE><br> 23 <BR> 24 <CODE>(#define)<BR> 25 <font color="#7f7f7f">MI_CancelWram_A( proc )</font><br> 26 MI_CancelWram_B( proc )<BR> 27 MI_CancelWram_C( proc )<BR> 28 <font color="#7f7f7f">MI_CancelWramSlot_A( slot, size, proc )</font><BR> 29 MI_CancelWramSlot_B( slot, size, proc )<BR> 30 MI_CancelWramSlot_C( slot, size, proc )</CODE></dd> 31</dl> 32<h2>Arguments</h2> 33<TABLE border="1" width="100%"> 34 <TBODY> 35 <TR> 36 <TD width="13%"><EM><STRONG>wram</STRONG></EM></TD> 37 <TD width="87%">WRAM to cancel the reservation for.</TD> 38 </TR> 39 <TR> 40 <TD><B><I>slot</I></B></TD> 41 <TD>Starting WRAM number of the region to cancel the reservation for.</TD> 42 </TR> 43 <TR> 44 <TD><B><I>size</I></B></TD> 45 <TD>Size of the region to cancel the reservation for.</TD> 46 </TR> 47 <TR> 48 <TD><B><I>proc</I></B></TD> 49 <TD>Processor to cancel the reservation for.</TD> 50 </TR> 51 </TBODY> 52</TABLE> 53 54<h2>Return Values</h2> 55<p>The number of WRAM slots for which reservations were cancelled. 0 indicates that no reservations were cancelled. -1 indicates a failure.</p> 56 57<H2>Description</H2> 58<P>Cancels the reservation of the specified WRAM for a given processor.</P> 59<P>It cancels a reservation for a region of WRAM that has been reserved with a <CODE><A href="MI_ReserveWram.html">MI_ReserveWram*</A></CODE> function. It will cancel all reservations within the specified WRAM for the specified processor. It will cancel reservations even if that region is in use. Even if a reservation is cancelled, the master processor for the given region will not change, and its content will not be lost.</P> 60<P>The <B><I>wram</I></B> argument indicates the target WRAM. This is of type <A href="../mi_constant.html"><CODE>MIWramPos</CODE></A>, and will be <CODE>MI_WRAM_A</CODE>, <CODE>MI_WRAM_B</CODE>, or <CODE>MI_WRAM_C</CODE>.</P> 61<P>The <B><I>slot</I></B> argument is the starting slot number for the region reservations are being cancelled for.</P> 62<P>The <B><I>size</I></B> argument is the size of the region to cancel the reservation for.</P> 63<P>The <B><I>proc</I></B> argument indicates which processor's reservations should be cancelled. This is of type <A href="../mi_constant.html"><CODE>MIWramProc</CODE></A> and will be <CODE>MI_WRAM_ARM9</CODE>, <CODE>MI_WRAM_ARM7</CODE>, or <CODE>MI_WRAM_DSP</CODE>.</P> 64<P><CODE><font color="#7f7f7f">MI_CancelWram_A</CODE> is the #define directive of <CODE><font color="#7f7f7f">MI_CancelWram( MI_WRAM_A, ... )</CODE>. </font><BR><CODE>MI_CancelWram_B</CODE> is the #define directive of <CODE>MI_CancelWram( MI_WRAM_B, ... )</CODE>. <BR><CODE>MI_CancelWram_C</CODE> is the #define directive of <CODE>MI_CancelWram( MI_WRAM_C, ... )</CODE>. <BR><font color="#7f7f7f"><CODE>MI_CancelWramSlot_A</CODE> is the #define directive of <font color="#7f7f7f"><CODE>MI_CancelWramSlot( MI_WRAM_A, ... )</CODE>. </font><BR><CODE>MI_CancelWramSlot_B</CODE> is the #define directive of <CODE>MI_CancelWramSlot( MI_WRAM_B, ... )</CODE>. <BR><CODE>MI_CancelWramSlot_C</CODE> is the #define directive of <CODE>MI_CancelWramSlot( MI_WRAM_C, ... )</CODE>. <BR></P> 65<P><CODE>MI_CancelWram() </CODE> frees all regions reserved for the specified processor within the specified WRAM.</P> 66<P><CODE>MI_CancelWramSlot() </CODE> specifies a region within the specified WRAM by its <B><I>slot</I></B> and <B><I>size</I></B>, and frees all regions contained therein that are reserved for the specified processor.</P> 67<P><BR> (Example) Here, we will cancel all reservations for the DSP in WRAM-C.<BR> <BR> <CODE>MI_CancelWram( MI_WRAM_C, MI_WRAM_DSP );</CODE><BR> OR <BR> <CODE>MI_CancelWram_C( MI_WRAM_DSP );</CODE><BR> 68</P> 69<P><BR> (Example) Here, we will cancel all reservations for the DSP in the 96 KB area of WRAM-C that starts with slot 2.<BR> <BR> <CODE>MI_CancelWramSlot( MI_WRAM_C, 2, MI_WRAM_SIZE_96KB, MI_WRAM_DSP );</CODE><BR> OR <BR> <CODE>MI_CancelWramSlot_C( 2, MI_WRAM_SIZE_96KB, MI_WRAM_DSP );</CODE></P> 70<P><BR> 71</P> 72<h2>See Also</h2> 73<P><A href="about_Wram.html">Overview (Work RAM)</A>, <A href="../mi_constant.html">MI-Related Constants</A></P> 74 75 76<H2>Revision History</H2> 77<P>2007/08/20 Initial version.</P> 78<hr><p>CONFIDENTIAL</p></body> 79</html> 80
