IAR PowerPac™ File System User Guide PPFS-1 COPYRIGHT NOTICE © Copyright 2006 IAR Systems. All rights reserved. No part of this document may be reproduced without the prior written consent of IAR Systems. The software described in this document is furnished under a license and may only be used or copied in accordance with the terms of such a license. DISCLAIMER The information in this document is subject to change without notice and does not represent a commitment on any part of IAR Systems. While the information contained herein is assumed to be accurate, IAR Systems assumes no responsibility for any errors or omissions. In no event shall IAR Systems, its employees, its contractors, or the authors of this document be liable for special, direct, indirect, or consequential damage, losses, costs, charges, claims, demands, claim for lost profits, fees, or expenses of any nature or kind. TRADEMARKS IAR, IAR Systems, IAR Embedded Workbench, IAR MakeApp, C-SPY, visualSTATE, From Idea To Target, IAR KickStart Kit and IAR PowerPac are trademarks or registered trademarks owned by IAR Systems AB. Microsoft and Windows are registered trademarks of Microsoft Corporation. All other product names are trademarks or registered trademarks of their respective owners. EDITION NOTICE First edition: October 2006 Part number: PPFS-1 Internal reference: 1.10A, 2.60A, Rev.3, ISUD. PPFS-1 Contents Preface .......................................................................................................................................................... 5 Introduction to IAR PowerPac File System.......................................................................................... 7 What is IAR PowerPac File System..............................................................................................7 Features ...........................................................................................................................................7 Basic concepts .................................................................................................................................8 IAR PowerPac File System structure................................................................................................. 8 Initializing the file system.................................................................................................................. 9 Add your device................................................................................................................................. 9 Getting started.......................................................................................................................................... 11 Start with a sample project .........................................................................................................11 Stepping through the Example......................................................................................................... 15 Adding IAR PowerPac File System to an existing project .......................................................21 IAR PowerPac File System libraries................................................................................................ 21 Available prebuilt libraries .............................................................................................................. 21 Add an IAR PowerPac File System library to a project ................................................................. 23 API functions ............................................................................................................................................. 25 API function overview ..................................................................................................................25 File system control functions.......................................................................................................27 File system cache functions .........................................................................................................28 File access functions......................................................................................................................32 Direct input/output functions ......................................................................................................34 File positioning functions .............................................................................................................37 Error handling functions...............................................................................................................40 Operations on files........................................................................................................................42 Directory functions.......................................................................................................................49 Formatting a medium ..................................................................................................................56 Extended functions .......................................................................................................................57 File time functions ........................................................................................................................63 Device drivers........................................................................................................................................... 67 General information .....................................................................................................................67 Default device driver names ............................................................................................................ 67 RAM disk driver.............................................................................................................................67 Supported hardware ......................................................................................................................... 67 Theory of operation.......................................................................................................................... 68 Wear leveling................................................................................................................................... 68 Configuring the driver...................................................................................................................... 68 FS_RAMDISK_Configure()............................................................................................................ 68 Hardware functions.......................................................................................................................... 69 Additional information..................................................................................................................... 69 MMC & SD card SPI mode device driver ...................................................................................69 Supported hardware ......................................................................................................................... 69 Theory of operation.......................................................................................................................... 70 Wear-leveling................................................................................................................................... 70 Configuring the driver...................................................................................................................... 71 PPFS-1 3 Hardware functions .......................................................................................................................... 72 Additional information..................................................................................................................... 77 NOR flash driver ...........................................................................................................................77 Supported hardware ......................................................................................................................... 77 Theory of operation.......................................................................................................................... 77 Wear leveling ................................................................................................................................... 77 Configuring the driver...................................................................................................................... 77 Hardware functions .......................................................................................................................... 78 Formatting NOR flash device .......................................................................................................... 78 Low-level formatting flash device ................................................................................................... 78 High-level formatting NOR flash..................................................................................................... 78 Low level format check.................................................................................................................... 79 CompactFlash card & IDE device driver ....................................................................................80 Supported hardware ......................................................................................................................... 80 Theory of operation.........................................................................................................................