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=utf-8">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>OS_IsRunOnDebugger</TITLE>
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">OS_IsRunOnDebugger <IMG src="../../image/NTR.gif" align="middle"><IMG src="../../image/TWL.gif" align="middle"></H1>
12<H2>Syntax</H2>
13<DL>
14<DD><CODE>#include &lt;nitro/os.h&gt;</CODE><BR> <BR> <CODE>BOOL OS_IsRunOnEmulator( void );</CODE>
15</DL>
16<H2>Arguments</H2>
17<P>None.</P>
18<H2>Return Values</H2>
19<P>If the program is running on IS-NITRO-DEBUGGER or IS-TWL-DEBUGGER, returns <CODE>TRUE</CODE>. Otherwise, returns <CODE>FALSE</CODE>.</P>
20<H2>Description</H2>
21<P>Checks whether the program is running on either IS-NITRO-DEBUGGER or IS-TWL-DEBUGGER.</P>
22<P>Because this is a debugging function, it always returns <code>FALSE</code> in the FINALROM version of the library.</P>
23<H3><BR> Similar Functions</H3>
24<P>The <A href="OS_IsRunOnEmulator.html"><CODE>OS_IsRunOnEmulator</CODE></A> function is also used for finding out the operating environment. It can find out whether the application is running on the Ensata NITRO Software Emulator.</P>
25<H3><BR> Actual Values Due to the Environment or Build</H3>
26<P>The table below shows the differences in the values returned by the <A href="OS_IsRunOnDebugger.html"><CODE>OS_IsRunOnDebugger</CODE></A> and <A href="OS_IsRunOnEmulator.html"><CODE>OS_IsRunOnEmulator</CODE></A> functions due to the operating environment.<BR>
27</P>
28<TABLE border="1">
29  <TBODY>
30    <TR>
31<TH colspan="4" style="background-color:#304040;"><FONT color="#ffffff">For NITRO Mode</FONT></TH>
32    </TR>
33    <TR>
34<TH>Operating Environment</TH>
35<TH>Build</TH>
36<TH>Value of <CODE>OS_IsRunOnDebugger</CODE></TH>
37<TH><CODE>Value of <CODE>OS_IsRunOnEmulator</CODE></CODE></TH>
38    </TR>
39    <TR>
40<TD>NTR system</TD>
41<TD>DEBUG<BR> RELEASE<BR> FINALROM</TD>
42<TD><B>FALSE</B></TD>
43<TD><B>FALSE</B></TD>
44    </TR>
45    <TR>
46<TD>Actual TWL unit</TD>
47<TD>DEBUG<BR> RELEASE<BR> FINALROM</TD>
48<TD><B>FALSE</B></TD>
49<TD><B>FALSE</B></TD>
50    </TR>
51    <TR>
52<TD rowspan="2">IS-NITRO-DEBUGGER<BR> (debugger software<BR> even if not connected)</TD>
53<TD>DEBUG<BR> RELEASE</TD>
54<TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
55<TD><B>FALSE</B></TD>
56    </TR>
57    <TR>
58<TD>FINALROM</TD>
59<TD><B>FALSE</B></TD>
60<TD><B>FALSE</B></TD>
61    </TR>
62    <TR>
63<TD rowspan="2">ENSATA EMULATOR</TD>
64<TD>DEBUG<BR>RELEASE</TD>
65<TD><B>FALSE</B></TD>
66<TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
67    </TR>
68    <TR>
69<TD>FINALROM</TD>
70<TD><B>FALSE</B></TD>
71<TD><B>FALSE</B></TD>
72    </TR>
73    <TR>
74<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For general-purpose development: ARM9)</TD>
75<TD>DEBUG<BR>RELEASE</TD>
76<TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
77<TD><B>FALSE</B></TD>
78    </TR>
79    <TR>
80<TD>FINALROM</TD>
81<TD><B>FALSE</B></TD>
82<TD><B>FALSE</B></TD>
83    </TR>
84    <TR>
85<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For component development:<BR>ARM9 + ARM7)</TD>
86<TD>DEBUG<BR>RELEASE</TD>
87<TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
88<TD><B>FALSE</B></TD>
89    </TR>
90    <TR>
91<TD>FINALROM</TD>
92<TD><B>FALSE</B></TD>
93<TD><B>FALSE</B></TD>
94    </TR>
95    <TR>
96<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For general-purpose development: ARM9)<BR> Debugger software <BR> When not connected</TD>
97<TD>DEBUG<BR>RELEASE</TD>
98<TD><B><CODE>FALSE</CODE></B></TD>
99<TD><B><CODE>FALSE</CODE></B></TD>
100    </TR>
101    <TR>
102<TD>FINALROM</TD>
103<TD><B><CODE>FALSE</CODE></B></TD>
104<TD><B><CODE>FALSE</CODE></B></TD>
105    </TR>
106    <TR>
107<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For component development:<BR>ARM9 + ARM7)<BR> Debugger software<BR> When not connected</TD>
108<TD>DEBUG<BR>RELEASE</TD>
109<TD><B><CODE>FALSE</CODE></B></TD>
110<TD><B><CODE>FALSE</CODE></B></TD>
111    </TR>
112    <TR>
113<TD>FINALROM</TD>
114<TD><B><CODE>FALSE</CODE></B></TD>
115<TD><B><CODE>FALSE</CODE></B></TD>
116    </TR>
117    <TR>
118<TH colspan="4" style="background-color:#304040;"><FONT color="#ffffff">For TWL Mode</FONT></TH>
119    </TR>
120    <TR>
121<TH>Operating Environment</TH>
122<TH>Build</TH>
123<TH>Value of the <CODE>OS_IsRunOnDebugger</CODE> function</TH>
124<TH>Value of <CODE>OS_IsRunOnEmulator</CODE></TH>
125    </TR>
126    <TR>
127<TD>Actual TWL unit</TD>
128<TD>DEBUG<BR>RELEASE<BR>FINALROM</TD>
129<TD><B>FALSE</B></TD>
130<TD><B>FALSE</B></TD>
131    </TR>
132    <TR>
133<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For general-purpose development: ARM9)</TD>
134<TD>DEBUG<BR>RELEASE</TD>
135<TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
136<TD><B>FALSE</B></TD>
137    </TR>
138    <TR>
139<TD>FINALROM</TD>
140<TD><B>FALSE</B></TD>
141<TD><B>FALSE</B></TD>
142    </TR>
143    <TR>
144<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For component development:<BR>ARM9 + ARM7)</TD>
145<TD>DEBUG<BR>RELEASE</TD>
146<TD><B><FONT color="#ff0000">TRUE</FONT></B></TD>
147<TD><B>FALSE</B></TD>
148    </TR>
149    <TR>
150<TD>FINALROM</TD>
151<TD><B>FALSE</B></TD>
152<TD><B>FALSE</B></TD>
153    </TR>
154    <TR>
155<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For general-purpose development: ARM9)<BR> Debugger software<BR> When not connected</TD>
156<TD>DEBUG<BR>RELEASE</TD>
157<TD><B><CODE>FALSE</CODE></B></TD>
158<TD><B><CODE>FALSE</CODE></B></TD>
159    </TR>
160    <TR>
161<TD>FINALROM</TD>
162<TD><B><CODE>FALSE</CODE></B></TD>
163<TD><B><CODE>FALSE</CODE></B></TD>
164    </TR>
165    <TR>
166<TD rowspan="2">IS-TWL-DEBUGGER<BR>(For component development:<BR>ARM9 + ARM7)<BR> Debugger software<BR> When not connected</TD>
167<TD>DEBUG<BR>RELEASE</TD>
168<TD><B><CODE>FALSE</CODE></B></TD>
169<TD><B><CODE>FALSE</CODE></B></TD>
170    </TR>
171    <TR>
172<TD>FINALROM</TD>
173<TD><B><CODE>FALSE</CODE></B></TD>
174<TD><B><CODE>FALSE</CODE></B></TD>
175    </TR>
176  </TBODY>
177</TABLE>
178<H2>Internal Operation</H2>
179<P>Makes a decision based on the logical sum of the the return value of the <A href="OS_GetConsoleType.html"><CODE>OS_GetConsoleType</CODE></A> function and the <CODE>OS_CONSOLE_ISDEBUGGER</CODE> and <CODE>OS_CONSOLE_TWLDEBUGGER</CODE> bits.</P>
180<H2>See Also</H2>
181<P><A href="OS_IsRunOnEmulator.html"><CODE>OS_IsRunOnEmulator</CODE></A><BR> <A href="OS_GetConsoleType.html"><CODE>OS_GetConsoleType</CODE></A></P>
182<H2>Revision History</H2>
183<P>2009/10/30 Added information about operations when a debugger is not connected.<BR>2008/04/15 Table added.<BR> 2007/11/05 Initial version.</P>
184<hr><p>CONFIDENTIAL</p></body>
185</HTML>