Initial Rev
[mirror/efi/fat/.git] / www / index.html
1 <html>
2 <head>
3   <title>EDK II Fat32 Project Homepage</title>
4   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5 </head>
6 <body>
7 <p><span style="font-size: large; font-weight: bold;">W</span>elcome to the <strong>EDK II FAT-Driver PROJECT</strong>, a project for the EDK II FAT32 File System Driver,  which is based on Microsoft's FAT32 File System Driver Specification. The EDK II Fat Driver is separate from the EDK project only because the terms of use of the code are unique, requiring us to  keep it in a separate code repository (the terms are basically that code developed using the FAT32 Specification must be associated  with EFI). </p>
8 <p>This project is a <em>subproject</em> of the EDK II project, and is only used to house the FAT32 code respository. All development tools in the EDK project are integrated with this project, so come here only to update the CVS repository or to get access to the latest code snapshots. Use the EDK project to post issues, join mailing lists, participate in discussion forums, etc. In short, consider them one project with two code repositories.</p>
9 <a name="stop"></a>
10 <h3>EDK II FAT-Driver News</h3>
11 <p>
12     The EDK II FAT-Driver development team is pleased to announce a new <b>&quot;Enhanced&quot;</b> FAT-Driver.  This project will now be used to develop and maintain both drivers.  
13     From this point on, the original FAT-Driver will be refererred to as <b>FAT-Driver</b> while the new driver will go by the <b>Enhanced-FAT-Driver</b> name.  Both drivers will be 
14     using the same Project Tracer and each have their own <b>module</b> name when creating/modifying TASKs or ENHANCEMENTs.  The enhanced-fat-driver is also published under the same 
15     license as the fat-driver2.  To view more specific information about the enhanced-fat-driver, go to the <a href="#Enhanced_Fat_Driver">Enhanced-FAT-Driver</a> section.
16 </p>
17 <h3>Working with the FAT32 Code</h3>
18 <p>The FAT-Driver project is sponsored by Intel and released under the BSD License with one additional term.  Before using the code please read the license below, paying special attention to the "Additional Terms" section:</p>
19 <form>
20 <textarea cols="100" rows="8">Copyright (c) 2004, Intel Corporation
21 All rights reserved.
22 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
24 Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
25 Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
26 Neither the name of Intel nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
30 Additional terms:
31 In addition to the forgoing, redistribution and use of the code is conditioned upon the FAT 32 File System Driver and all derivative works thereof being used for and designed only to read and/or write to a file system that is directly managed by an Extensible Firmware Interface (EFI) implementation or by an emulator of an EFI implementation.
32 </textarea>
33 </form>
34 <p>To download code, view the <a href="">directory of code snapshots</a> and choose the version (Official Release or Development Version) you are interested in and simply click on it to start the download process. Join this project if you want to contribute code changes (see the next section for guidance). </p>
35 <h3>Enhanced-FAT-Driver<a name="Enhanced_Fat_Driver"></a></h3>
36 <p>
37     The <b>Enhanced-FAT-Driver</b> is a new implementation of the FAT32 filesystem.  It is a near complete rewrite of the original FAT-Driver with over 80% of the code being specific just to the Enhanced-FAT-Driver.  
38     The new driver is faster and takes up only 66% of the original FAT-Driver's memory footprint.
39 </p>
40 <h4>What makes the Enhanced-FAT-Driver better?</h4>
41 <ul>
42     <li>Better Architecture
43         <ul>
44             <li>More modular design thanks to object oriented and hierarchical design</li>
45             <li>Logic directory approach used in place of the physical directory</li>
46             <li>Easier to maintain and debug
47             <li>80% of the code was completely rewritten to make it smaller and faster</li>
48         </ul>
49     </li>
50     <li>Higher Performance
51         <ul>
52             <li>A cache mechanism to cache recently opened directories</li>
53             <li>A more efficient 8.3 name generation algorithm</li>
54             <li>10x, 100x or even 1000x acceleration when creating thousands files/directories</li>
55         </ul>
56     </li>
57     <li>Smaller Size
58         <ul>
59             <li>Simplified the controller name from &quot;FAT File System[FAT16] 200MB&quot; to &quot;FAT File System&quot;</li>
60             <li>Succinct coding style</li>
61             <li>2/3 the image size of the original FAT-Driver</li>
62         </ul>
63     </li>
64 </ul>
65 <h4>So why are there two FAT-Driver implementations in the fat-driver2 project?</h4>
66 <ul>
67     <li>Publish the enhanced FAT implementation so that people can try the new implementation with size and performance benefits</li>
68     <li>Keep the original FAT driver for backward compatibility or avoid potential risk for mature products</li>
69 </ul>
70 <h4>Which driver should I use?</h4>
71 <ul>
72     <li>Enhanced-FAT-Driver
73         <ul>
74             <li>When you need the fastest FAT filesystem driver</li>
75             <li>When space is crucial</li>
76         </ul>
77     </li>
78     <li>FAT-Driver
79         <ul>
80             <li>When you need stability to avoid possible risk of a new implementation</li>
81             <li>When you prefer to keep the original behavior, such as 8.3 name generation algorithm, complete controller name for each volume</li>
82         </ul>
83     </li>
84 </ul>
85 <!-- <p>
86 When making your decision, remember that the Enhanced FAT-Driver is backward compatible with the original FAT-Driver. 
87 It also has a sector allocation mechanism that can make it easier to recover deleted files.
88 </p> -->
89 <h4>What does this mean to you?</h4>
90 <p>
91     Not much.  The source code will be housed in the same repository so there is no need to checkout multiple projects to work on these drivers.  The Project Tracker configuration is setup to allow for 
92     concurrent DEFECT, ENHANCEMENT and TASK management for both projects.  The only real concern for you is to figure out which driver to use when.
93 </p>
94 <h3>Joining the FAT-Driver  Project </h3>
95 <p>To join the FAT-Driver Project simply click on the &quot;Request Project Membership/Role&quot; link above and choose &quot;Observer&quot; as a requested role (that's the default role for all new project members). Upon receipt of your request, the FAT-Driver Maintainer will approve your project membership. Once in the project you'll primarily use the CVS repository located <a href="">here</a>, or access the FAT32-specific documents located <a href="">here</a>. </p>
96     <h3>Managing Changes to the FAT-Driver Source Code</h3>
97     <p>Since the FAT32 Driver Code is actually part of the EDK, changes to it are managed within the EDK issue management system. To make it simple for you, the following links have been developed to help the communication between the two projects. From these links you can enter a FAT32 issue, query  open FAT32 issues, access the DEV mailing list archive and download the FAT32  source code. </p>
98     <ul>
99         <li>Enhanced FAT-Driver
100             <ul>
101                 <li><a href="">Latest Enhanced-FAT-Driver Source Code Snapshot (Development Version)</a></li>
102                 <li><a href="">Latest Enhanced-FAT-Driver Source Code Snapshot (Official Release)</a></li>
103                 <li> <a href="">Query of  Open and Active Enhanced-FAT-Driver Project Defects</a></li>
104             </ul>
105         </li>
106         <li>FAT-Driver
107             <ul>
108                 <li><a href="">Latest FAT-Driver Source Code Snapshot (Development Version)</a></li>
109                 <li><a href="">Latest FAT-Driver Source Code Snapshot (Official Release)</a></li>
110                 <li> <a href="">Query of  Open and Active FAT-Driver Project Defects</a></li>
111             </ul>
112         </li>
113         <li>General
114           <ul>
115               <li><a href="">Query of All FAT-Driver Project Defects</a></li>
116               <li><a href="">Archives of the EDK &quot;Dev&quot; Mailing List</a></li>
117           </ul>
118         </li>
119     </ul>
120 <h3>Other Common Links and Downloads </h3>
121                       <ul><li><a href="">Request for a FAT-Driver Project Role (initial or promotion)</a> </li>
122   <li><a href="">Link to the EDK Project Homepage </a></li>
123   <li><a href="">Link to the TianoCore Community Project</a></li>
124   <li><a href="">Link to the TianoCore Issue Management Process </a></li>
125   <li><a href="">Link to Microsoft's  FAT32 System Driver Specification</a></li>
126 </ul>
127 <h3>Project Points of Contact</h3>
128 <ul>
129   <li>EDK/FAT-Driver Project Maintainer: Rob Rhoads, Intel Corporation, <a href=""></a></li>
130   <li>EDK/FAT-Driver Senior Engineer (US): Andrew Fish, Intel Corporation, <a href=""></a></li>
131   <li>EDK/FAT-Driver Senior Engineer (China): Penny Gao, Intel Corporation, <a href=""></a></li>
132 </ul>
133 <p>&nbsp;</p>
134 </body>
135 </html>