1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html xmlns="http://www.w3.org/1999/xhtml">
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<title>WFSTableFormat</title>
7<link rel="stylesheet" href="../css/nitro.css" type="text/css" />
8</head>
9
10<body>
11
12<h1>WFSTableFormat</h1>
13<h2>Definition</h2>
14
15<dl>
16  <dd>
17<code>#include &lt;nitro/wfs.h&gt;</code><br />
18  <br />
19<pre>
20<font color="#008000">/* WFS table format array order */</font>
21typedef enum WFSTableRegionType
22{
23    WFS_TABLE_REGION_FAT,
24    WFS_TABLE_REGION_FNT,
25    WFS_TABLE_REGION_OV9,
26    WFS_TABLE_REGION_OV7,
27    WFS_TABLE_REGION_MAX
28}
29WFSTableRegionType;
30
31<font color="#008000">/* ROM file table information */</font>
32typedef struct WFSTableFormat
33{
34    u32             origin;                       <font color="#008000">/* ROM image offset */</font>
35    u8             *buffer;                       <font color="#008000">/* Buffer used to store file table information */</font>
36    u32             length;                       <font color="#008000">/* buffer size */</font>
37    <a href="../card/card_rom_region_type.html">CARDRomRegion</a>   region[WFS_TABLE_REGION_MAX]; <font color="#008000">/* The storage locations of each FAT, FNT, and overlay table */</font>
38} PLATFORM_STRUCT_PADDING_FOOTER
39WFSTableFormat;
40</pre>
41  <br />
42  </dd>
43</dl>
44
45<h2>Elements</h2>
46<table border="1" width="100%">
47  <tbody>
48    <tr>
49      <td>origin</td>
50      <td>Offset value that indicates where address 0 of the ROM image is located within the actual ROM device from the perspective of the child (client).
51      Applications do not particularly need to consider this.</td>
52    </tr>
53    <tr>
54      <td>buffer</td>
55      <td>This memory is used to store information for each table pointed by the region member to be described later.</td>
56    </tr>
57    <tr>
58      <td>length</td>
59      <td>The buffer size.</td>
60    </tr>
61    <tr>
62      <td>region</td>
63      <td>This memory region stores information for each FAT, FNT, and overlay table stored in the buffer.<br />
64      For instance, FNT information can be accessed as described below.
65      <ul>
66      <li>Start Address = buffer + region[WFS_TABLE_REGION_FNT] offset</li>
67      <li>Table Size = region[WFS_TABLE_REGION_FNT].length</li>
68      </ul>
69      </td>
70    </tr>
71  </tbody>
72</table>
73
74
75<h2>Description</h2>
76<p>This structure represents file table information to be retrieved by children (clients) using <a href="client/WFS_GetTableFormat.html"><code>WFS_GetTableFormat</code></a>.</p>
77
78<h2>See Also</h2>
79<p><code>
80
81<a href="../card/card_rom_region_type.html">CARDRomRegion</a>, <a href="client/WFS_GetTableFormat.html">WFS_GetTableFormat</a></code></p>
82
83<h2>Revision History</h2>
84<p>
852007/06/06 Initial version.
86</p>
87<hr><p>CONFIDENTIAL</p></body>
88</html>
89