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> <BR> <CODE>void MI_CancelWram( <A href="../mi_constant.html">MIWramPos</A> wram, <A href="../mi_constant.html">MIWramProc</A> proc )</CODE><br> <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> <BR> <CODE>(#define)<BR> <font color="#7f7f7f">#define MI_CancelWram_A( proc )</font><br> #define MI_CancelWram_B( proc )<BR> #define MI_CancelWram_C( proc )<BR> <font color="#7f7f7f">#define MI_CancelWramSlot_A( slot, size, proc )</font><BR> #define MI_CancelWramSlot_B( slot, size, proc )<BR> #define MI_CancelWramSlot_C( slot, size, proc )</CODE></dd> 20</dl> 21<h2>Arguments</h2> 22<TABLE border="1" width="100%"> 23 <TBODY> 24 <TR> 25<TD width="13%"><EM><STRONG>wram</STRONG></EM></TD> 26<TD width="87%">WRAM to cancel the reservation for.</TD> 27 </TR> 28 <TR> 29<TD><B><I>slot</I></B></TD> 30<TD>Starting WRAM number of the region to cancel the reservation for.</TD> 31 </TR> 32 <TR> 33<TD><B><I>size</I></B></TD> 34<TD>Size of the region to cancel the reservation for.</TD> 35 </TR> 36 <TR> 37<TD><B><I>proc</I></B></TD> 38<TD>Processor to cancel the reservation for.</TD> 39 </TR> 40 </TBODY> 41</TABLE> 42 43<h2>Return Values</h2> 44<p>The number of WRAM slots for which reservations were cancelled. A value of 0 indicates that no reservations were cancelled. A value of -1 indicates a failure.</p> 45 46<H2>Description</H2> 47<P>Cancels the reservation of the specified WRAM for a given processor.</P> 48<P>It cancels a reservation for a region of WRAM that has been reserved with a <A href="MI_ReserveWram.html"><CODE>MI_ReserveWram*</CODE></A> function. It cancels all reservations in the specified WRAM for the specified processor. It cancels reservations even if that region is in use. Even if a reservation is cancelled, the master processor for the given region does not change, and its content is not lost.</P> 49<P>The <SPAN class="argument">wram</SPAN> argument indicates the target WRAM. This is of type <A href="../mi_constant.html"><CODE>MIWramPos</CODE></A> and is <CODE>MI_WRAM_A</CODE>, <CODE>MI_WRAM_B</CODE>, or <CODE>MI_WRAM_C</CODE>.</P> 50<P>The <SPAN class="argument">slot</SPAN> argument is the starting slot number for the region reservations are being cancelled for.</P> 51<P>The <SPAN class="argument">size</SPAN> argument is the size of the region to cancel the reservation for.</P> 52<P>The <SPAN class="argument">proc</SPAN> argument indicates which processor's reservations should be cancelled. This is of type <A href="../mi_constant.html"><CODE>MIWramProc</CODE></A> and is <CODE>MI_WRAM_ARM9</CODE>, <CODE>MI_WRAM_ARM7</CODE>, or <CODE>MI_WRAM_DSP</CODE>.</P> 53<P><CODE><font color="#7f7f7f">MI_CancelWram_A</CODE></font> 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></font> 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> 54<P>The <CODE>MI_CancelWram</CODE> function frees all regions reserved for the specified processor in the specified WRAM.</P> 55<P>The <CODE>MI_CancelWramSlot</CODE> function specifies a region within the specified WRAM by its <SPAN class="argument">slot</SPAN> and <SPAN class="argument">size</SPAN>, and frees all regions contained therein that are reserved for the specified processor.</P> 56<P><BR> Example: Here, we 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> 57</P> 58<P><BR> Example: Here, we 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> 59<P><BR> 60</P> 61<h2>See Also</h2> 62<P><A href="about_Wram.html">Overview: Work RAM</A><BR> <A href="../mi_constant.html">MI-Related Constants</A></P> 63 64 65<H2>Revision History</H2> 66<P>2007/08/20 Initial version.</P> 67<hr><p>CONFIDENTIAL</p></body> 68</html> 69
