1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <title>IBL Configuration: iblStatus_s Struct Reference</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
8 <script type="text/javascript" src="search/search.js"></script>
9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
10 </head>
11 <body onload='searchBox.OnSelectItem(0);'>
12 <!-- Generated by Doxygen 1.7.4 -->
13 <script type="text/javascript"><!--
14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
15 --></script>
16 <div id="top">
17 <div id="titlearea">
18 <table cellspacing="0" cellpadding="0">
19 <tbody>
20 <tr style="height: 56px;">
21 <td style="padding-left: 0.5em;">
22 <div id="projectname">IBL Configuration</div>
23 </td>
24 </tr>
25 </tbody>
26 </table>
27 </div>
28 <div id="navrow1" class="tabs">
29 <ul class="tablist">
30 <li><a href="index.html"><span>Main Page</span></a></li>
31 <li><a href="modules.html"><span>Modules</span></a></li>
32 <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
33 <li><a href="files.html"><span>Files</span></a></li>
34 <li id="searchli">
35 <div id="MSearchBox" class="MSearchBoxInactive">
36 <span class="left">
37 <img id="MSearchSelect" src="search/mag_sel.png"
38 onmouseover="return searchBox.OnSearchSelectShow()"
39 onmouseout="return searchBox.OnSearchSelectHide()"
40 alt=""/>
41 <input type="text" id="MSearchField" value="Search" accesskey="S"
42 onfocus="searchBox.OnSearchFieldFocus(true)"
43 onblur="searchBox.OnSearchFieldFocus(false)"
44 onkeyup="searchBox.OnSearchFieldChange(event)"/>
45 </span><span class="right">
46 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
47 </span>
48 </div>
49 </li>
50 </ul>
51 </div>
52 <div id="navrow2" class="tabs2">
53 <ul class="tablist">
54 <li><a href="annotated.html"><span>Data Structures</span></a></li>
55 <li><a href="classes.html"><span>Data Structure Index</span></a></li>
56 <li><a href="functions.html"><span>Data Fields</span></a></li>
57 </ul>
58 </div>
59 </div>
60 <div class="header">
61 <div class="summary">
62 <a href="#pub-attribs">Data Fields</a> </div>
63 <div class="headertitle">
64 <div class="title">iblStatus_s Struct Reference</div> </div>
65 </div>
66 <div class="contents">
67 <!-- doxytag: class="iblStatus_s" -->
68 <p>Provide status on the boot operation.
69 <a href="structibl_status__s.html#details">More...</a></p>
71 <p><code>#include <<a class="el" href="ibl_8h_source.html">ibl.h</a>></code></p>
72 <table class="memberdecls">
73 <tr><td colspan="2"><h2><a name="pub-attribs"></a>
74 Data Fields</h2></td></tr>
75 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#add5ec733f479909722380a6880995673">iblMagic</a></td></tr>
76 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#ace272327d1658941b98b1e03cee3a402">iblVersion</a></td></tr>
77 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#ac2eda90f13cdbbacb74024fa6f29ab2e">iblFail</a></td></tr>
78 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#aea7e16d9a657dd69c5495664095ed6e4">i2cRetries</a></td></tr>
79 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a440b1f0e50348ab334e7ddcaca43b4ef">i2cDataRetries</a></td></tr>
80 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a6434dbc4e7687cea99f0fa2363476549">spiRetries</a></td></tr>
81 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#af51b00e64de6af48d0b164718dc99593">spiDataRetries</a></td></tr>
82 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a8c93c8e4bc60be25d55b8e43a5aed2b3">magicRetries</a></td></tr>
83 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a6aa1204e7bad49390ea53f9673fd6b2b">mapSizeFail</a></td></tr>
84 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a3c52ce2b066817b2450fac026e1f3d3e">mapRetries</a></td></tr>
85 <tr><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a3be37918da6b342c4bca4441b5f7074b">heartBeat</a></td></tr>
86 <tr><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#af9404b81ae2879cf8119744172a80ae9">activeBoot</a></td></tr>
87 <tr><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#ab97cd270113d9c27f1673e0961ed9f9b">activeDevice</a></td></tr>
88 <tr><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#aeadf4893c19422032edaaf3829c3fe6c">activeFileFormat</a></td></tr>
89 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#aa25657c0354d19c7c6d692582de5c417">autoDetectFailCnt</a></td></tr>
90 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a48ab769750f4203a3f42e615ce6fffb1">nameDetectFailCnt</a></td></tr>
91 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#a385624b1b6a8e1f0bb307c43ed65e467">invalidDataFormatSpec</a></td></tr>
92 <tr><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#afb126a061728cd7cebaf57f59723365e">exitAddress</a></td></tr>
93 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structibl_eth_boot_info__s.html">iblEthBootInfo_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structibl_status__s.html#ac94d4b125bbda1d2d70403b7efdbe4a0">ethParams</a></td></tr>
94 </table>
95 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
96 <div class="textblock"><p>Provide status on the boot operation. </p>
97 <p>Run time status of the IBL is provided to aid in debugging </p>
98 </div><hr/><h2>Field Documentation</h2>
99 <a class="anchor" id="af9404b81ae2879cf8119744172a80ae9"></a><!-- doxytag: member="iblStatus_s::activeBoot" ref="af9404b81ae2879cf8119744172a80ae9" args="" -->
100 <div class="memitem">
101 <div class="memproto">
102 <table class="memname">
103 <tr>
104 <td class="memname">int32 <a class="el" href="structibl_status__s.html#af9404b81ae2879cf8119744172a80ae9">activeBoot</a></td>
105 </tr>
106 </table>
107 </div>
108 <div class="memdoc">
109 <p>Describes the active boot mode <a class="el" href="group__ibl_boot_modes.html">Defines the boot modes supported by the IBL</a> </p>
111 </div>
112 </div>
113 <a class="anchor" id="ab97cd270113d9c27f1673e0961ed9f9b"></a><!-- doxytag: member="iblStatus_s::activeDevice" ref="ab97cd270113d9c27f1673e0961ed9f9b" args="" -->
114 <div class="memitem">
115 <div class="memproto">
116 <table class="memname">
117 <tr>
118 <td class="memname">int32 <a class="el" href="structibl_status__s.html#ab97cd270113d9c27f1673e0961ed9f9b">activeDevice</a></td>
119 </tr>
120 </table>
121 </div>
122 <div class="memdoc">
123 <p>Describes the active boot peripheral device <a class="el" href="group__ibl_active_device.html">IblActiveDevice</a> </p>
125 </div>
126 </div>
127 <a class="anchor" id="aeadf4893c19422032edaaf3829c3fe6c"></a><!-- doxytag: member="iblStatus_s::activeFileFormat" ref="aeadf4893c19422032edaaf3829c3fe6c" args="" -->
128 <div class="memitem">
129 <div class="memproto">
130 <table class="memname">
131 <tr>
132 <td class="memname">int32 <a class="el" href="structibl_status__s.html#aeadf4893c19422032edaaf3829c3fe6c">activeFileFormat</a></td>
133 </tr>
134 </table>
135 </div>
136 <div class="memdoc">
137 <p>Describes the format being decoded </p>
139 </div>
140 </div>
141 <a class="anchor" id="aa25657c0354d19c7c6d692582de5c417"></a><!-- doxytag: member="iblStatus_s::autoDetectFailCnt" ref="aa25657c0354d19c7c6d692582de5c417" args="" -->
142 <div class="memitem">
143 <div class="memproto">
144 <table class="memname">
145 <tr>
146 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#aa25657c0354d19c7c6d692582de5c417">autoDetectFailCnt</a></td>
147 </tr>
148 </table>
149 </div>
150 <div class="memdoc">
151 <p>Counts the number of times an auto detect of the data format failed </p>
153 </div>
154 </div>
155 <a class="anchor" id="ac94d4b125bbda1d2d70403b7efdbe4a0"></a><!-- doxytag: member="iblStatus_s::ethParams" ref="ac94d4b125bbda1d2d70403b7efdbe4a0" args="" -->
156 <div class="memitem">
157 <div class="memproto">
158 <table class="memname">
159 <tr>
160 <td class="memname"><a class="el" href="structibl_eth_boot_info__s.html">iblEthBootInfo_t</a> <a class="el" href="structibl_status__s.html#ac94d4b125bbda1d2d70403b7efdbe4a0">ethParams</a></td>
161 </tr>
162 </table>
163 </div>
164 <div class="memdoc">
165 <p>Last ethernet boot attemp parameters </p>
167 </div>
168 </div>
169 <a class="anchor" id="afb126a061728cd7cebaf57f59723365e"></a><!-- doxytag: member="iblStatus_s::exitAddress" ref="afb126a061728cd7cebaf57f59723365e" args="" -->
170 <div class="memitem">
171 <div class="memproto">
172 <table class="memname">
173 <tr>
174 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#afb126a061728cd7cebaf57f59723365e">exitAddress</a></td>
175 </tr>
176 </table>
177 </div>
178 <div class="memdoc">
179 <p>If non-zero the IBL exited and branched to this address </p>
181 </div>
182 </div>
183 <a class="anchor" id="a3be37918da6b342c4bca4441b5f7074b"></a><!-- doxytag: member="iblStatus_s::heartBeat" ref="a3be37918da6b342c4bca4441b5f7074b" args="" -->
184 <div class="memitem">
185 <div class="memproto">
186 <table class="memname">
187 <tr>
188 <td class="memname">int32 <a class="el" href="structibl_status__s.html#a3be37918da6b342c4bca4441b5f7074b">heartBeat</a></td>
189 </tr>
190 </table>
191 </div>
192 <div class="memdoc">
193 <p>An increasing value as long as the boot code is running </p>
195 </div>
196 </div>
197 <a class="anchor" id="a440b1f0e50348ab334e7ddcaca43b4ef"></a><!-- doxytag: member="iblStatus_s::i2cDataRetries" ref="a440b1f0e50348ab334e7ddcaca43b4ef" args="" -->
198 <div class="memitem">
199 <div class="memproto">
200 <table class="memname">
201 <tr>
202 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#a440b1f0e50348ab334e7ddcaca43b4ef">i2cDataRetries</a></td>
203 </tr>
204 </table>
205 </div>
206 <div class="memdoc">
207 <p>Number of retries while reading block data from the i2c </p>
209 </div>
210 </div>
211 <a class="anchor" id="aea7e16d9a657dd69c5495664095ed6e4"></a><!-- doxytag: member="iblStatus_s::i2cRetries" ref="aea7e16d9a657dd69c5495664095ed6e4" args="" -->
212 <div class="memitem">
213 <div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#aea7e16d9a657dd69c5495664095ed6e4">i2cRetries</a></td>
217 </tr>
218 </table>
219 </div>
220 <div class="memdoc">
221 <p>Count of I2C read retries </p>
223 </div>
224 </div>
225 <a class="anchor" id="ac2eda90f13cdbbacb74024fa6f29ab2e"></a><!-- doxytag: member="iblStatus_s::iblFail" ref="ac2eda90f13cdbbacb74024fa6f29ab2e" args="" -->
226 <div class="memitem">
227 <div class="memproto">
228 <table class="memname">
229 <tr>
230 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#ac2eda90f13cdbbacb74024fa6f29ab2e">iblFail</a></td>
231 </tr>
232 </table>
233 </div>
234 <div class="memdoc">
235 <p>If non-zero the IBL has encountered a fatal error </p>
237 </div>
238 </div>
239 <a class="anchor" id="add5ec733f479909722380a6880995673"></a><!-- doxytag: member="iblStatus_s::iblMagic" ref="add5ec733f479909722380a6880995673" args="" -->
240 <div class="memitem">
241 <div class="memproto">
242 <table class="memname">
243 <tr>
244 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#add5ec733f479909722380a6880995673">iblMagic</a></td>
245 </tr>
246 </table>
247 </div>
248 <div class="memdoc">
249 <p>The ibl_MAGIC_VALUE is placed here to indicate the boot has begun </p>
251 </div>
252 </div>
253 <a class="anchor" id="ace272327d1658941b98b1e03cee3a402"></a><!-- doxytag: member="iblStatus_s::iblVersion" ref="ace272327d1658941b98b1e03cee3a402" args="" -->
254 <div class="memitem">
255 <div class="memproto">
256 <table class="memname">
257 <tr>
258 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#ace272327d1658941b98b1e03cee3a402">iblVersion</a></td>
259 </tr>
260 </table>
261 </div>
262 <div class="memdoc">
263 <p>The version number. MSB = major, SMSB = minor, SLSB = minor minor LSB= tiny </p>
265 </div>
266 </div>
267 <a class="anchor" id="a385624b1b6a8e1f0bb307c43ed65e467"></a><!-- doxytag: member="iblStatus_s::invalidDataFormatSpec" ref="a385624b1b6a8e1f0bb307c43ed65e467" args="" -->
268 <div class="memitem">
269 <div class="memproto">
270 <table class="memname">
271 <tr>
272 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#a385624b1b6a8e1f0bb307c43ed65e467">invalidDataFormatSpec</a></td>
273 </tr>
274 </table>
275 </div>
276 <div class="memdoc">
277 <p>Counts the number of times the main boot found an invalid boot format request </p>
279 </div>
280 </div>
281 <a class="anchor" id="a8c93c8e4bc60be25d55b8e43a5aed2b3"></a><!-- doxytag: member="iblStatus_s::magicRetries" ref="a8c93c8e4bc60be25d55b8e43a5aed2b3" args="" -->
282 <div class="memitem">
283 <div class="memproto">
284 <table class="memname">
285 <tr>
286 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#a8c93c8e4bc60be25d55b8e43a5aed2b3">magicRetries</a></td>
287 </tr>
288 </table>
289 </div>
290 <div class="memdoc">
291 <p>Count of I2C/SPI re-reads because the magic number was incorrect </p>
293 </div>
294 </div>
295 <a class="anchor" id="a3c52ce2b066817b2450fac026e1f3d3e"></a><!-- doxytag: member="iblStatus_s::mapRetries" ref="a3c52ce2b066817b2450fac026e1f3d3e" args="" -->
296 <div class="memitem">
297 <div class="memproto">
298 <table class="memname">
299 <tr>
300 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#a3c52ce2b066817b2450fac026e1f3d3e">mapRetries</a></td>
301 </tr>
302 </table>
303 </div>
304 <div class="memdoc">
305 <p>Number of times the checksum failed on the read of the i2c/spi map </p>
307 </div>
308 </div>
309 <a class="anchor" id="a6aa1204e7bad49390ea53f9673fd6b2b"></a><!-- doxytag: member="iblStatus_s::mapSizeFail" ref="a6aa1204e7bad49390ea53f9673fd6b2b" args="" -->
310 <div class="memitem">
311 <div class="memproto">
312 <table class="memname">
313 <tr>
314 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#a6aa1204e7bad49390ea53f9673fd6b2b">mapSizeFail</a></td>
315 </tr>
316 </table>
317 </div>
318 <div class="memdoc">
319 <p>Number of times an invalid map table size was read from the i2c/spi </p>
321 </div>
322 </div>
323 <a class="anchor" id="a48ab769750f4203a3f42e615ce6fffb1"></a><!-- doxytag: member="iblStatus_s::nameDetectFailCnt" ref="a48ab769750f4203a3f42e615ce6fffb1" args="" -->
324 <div class="memitem">
325 <div class="memproto">
326 <table class="memname">
327 <tr>
328 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#a48ab769750f4203a3f42e615ce6fffb1">nameDetectFailCnt</a></td>
329 </tr>
330 </table>
331 </div>
332 <div class="memdoc">
333 <p>Counts the number of times an name detect of the data format failed </p>
335 </div>
336 </div>
337 <a class="anchor" id="af51b00e64de6af48d0b164718dc99593"></a><!-- doxytag: member="iblStatus_s::spiDataRetries" ref="af51b00e64de6af48d0b164718dc99593" args="" -->
338 <div class="memitem">
339 <div class="memproto">
340 <table class="memname">
341 <tr>
342 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#af51b00e64de6af48d0b164718dc99593">spiDataRetries</a></td>
343 </tr>
344 </table>
345 </div>
346 <div class="memdoc">
347 <p>Number of retries while reading block data from the spi </p>
349 </div>
350 </div>
351 <a class="anchor" id="a6434dbc4e7687cea99f0fa2363476549"></a><!-- doxytag: member="iblStatus_s::spiRetries" ref="a6434dbc4e7687cea99f0fa2363476549" args="" -->
352 <div class="memitem">
353 <div class="memproto">
354 <table class="memname">
355 <tr>
356 <td class="memname">uint32 <a class="el" href="structibl_status__s.html#a6434dbc4e7687cea99f0fa2363476549">spiRetries</a></td>
357 </tr>
358 </table>
359 </div>
360 <div class="memdoc">
361 <p>Count of SPI read retries </p>
363 </div>
364 </div>
365 <hr/>The documentation for this struct was generated from the following file:<ul>
366 <li><a class="el" href="ibl_8h_source.html">ibl.h</a></li>
367 </ul>
368 </div>
369 <!-- window showing the filter options -->
370 <div id="MSearchSelectWindow"
371 onmouseover="return searchBox.OnSearchSelectShow()"
372 onmouseout="return searchBox.OnSearchSelectHide()"
373 onkeydown="return searchBox.OnSearchSelectKey(event)">
374 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Variables</a></div>
376 <!-- iframe showing the search results (closed by default) -->
377 <div id="MSearchResultsWindow">
378 <iframe src="javascript:void(0)" frameborder="0"
379 name="MSearchResults" id="MSearchResults">
380 </iframe>
381 </div>
383 <hr class="footer"/><address class="footer"><small>Generated on Mon May 2 2011 12:50:34 for IBL Configuration by 
384 <a href="http://www.doxygen.org/index.html">
385 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
386 </body>
387 </html>