User Guide. Micron NAND Flash Simulator (NSIM)

Transcription

1 Introduction User Guide Micron NAND Flash Simulator (NSIM) Introduction Nonvolatile NAND Flash memory devices are high data throughput devices that permanently store data or code. This capability is ideal for portable devices such as digital cameras which store pictures, MP3 players which store music, or PDAs which store personal files and settings (time, date, etc.). Due to the special structure of NAND Flash memory, software used for these devices is complicated and hard to develop since the developer cannot know what happens in the internal NAND Flash device. For this reason, Micron provides a software tool called NAND Flash Simulator (NSIM) that uses a data file to simulate a physical NAND Flash device and to view data/status changes of the device when running applications. Developers using NSIM no longer have to worry about physical NAND (and board) availability or integrity and can easily debug when problems arise during the development process. In all, NSIM will help developers design software for NAND Flash memory in a quick and easy way. NSIM is a PC software application that runs on a Windows operating system using Visual C (abbreviated as VC). For an application to run on NSIM, the developer should build a VC project for the software and add library files (SimulatorTool_DLL.lib, etc.) offered by NSIM. Application Examples on page 20provides examples that show how to work with NSIM. Operations in NAND Flash memory should follow several rules to prevent certain unwanted actions from occurring (for example, re-programming operations). While the physical NAND Flash memory cannot reflect these improper operations on its own, by using NSIM the operation that may cause potential risk is verified and recorded in a log file. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

2 Table of Contents Introduction Reference Information NAND Flash Devices and Their Command Sets Reference Documentation and Technical Support Overview NAND Flash Viewer NANDConfig.dat SimulatorTool_DLL Library NANDSimulator.dat NANDWarning.log User Programs System Requirements Main features NAND Flash Viewer NAND Device Configuration NAND Status/Data Viewer Block Status Miscellaneous Functions SimulatorTool_DLL Library Constructor Function Functions Application Examples Building a VC Project and Using the NSIM Create a New VC Project Using the NAND Flash Viewer to Visualize Changes Replacing a NAND Driver in a User Project Revision History Disclaimer UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

3 Reference Information UM0265 NAND Flash Simulator (NSIM) Reference Information This section lists the Micron NAND Flash devices simulated by the NSIM and available documentation. NAND Flash Devices and Their Command Sets The NSIM can be used to simulate the NAND Flash devices listed in the following table. The table also lists the corresponding command sets for each device. Table 1: Devices and CMD Set Covered by NSIM Family CMD Set 1 Part Number Description NANDXXX-A Read A, Read B, Read C, Read NAND128W3A 128Mb, 1.8V/3V, x8/ Electronic Signature, Read NAND128R3A x16 Status Register 1, Page NAND128W4A Program, Copy Back Program, Block Erase, Reset NAND128R4A NAND256W3A 256Mb, 1.8V/3V, x8/ NAND256R3A x16 NAND256W4A NAND256R4A NAND512W3A 512Mb, 1.8V/3V, x8/ NAND512R3A x16 NAND512W4A NAND512R4A NAND01GW3A 01GMb, 1.8V/3V, x8/ NAND01GR3A x16 NAND01GW4A NAND01GR4A NANDXXX-B Read, Random Data Output, Cache Read, Exit Cache Read, Page Program, Random Data Input, Copy Back Program, Cache Program 3, Block Erase, Reset, Read Electronic Signature 2, Read Status Register, Read Block Lock Status, Block Unlock, Block Lock, Block Lock-Down NAND01GW3B 1Gb, 1.8V/3V, x8/ NAND01GR3B x16 NAND01GW4B NAND01GR4B NAND02GW3B 2Gb, 1.8V/3V, x8/ NAND02GR3B x16 NAND02GW4B NAND02GR4B NAND04GW3B 4Gb, 1.8V/3V, x8/ NAND04GR3B x16 NAND04GW4B NAND04GR4B NAND08GW3B 8Gb, 1.8V/3V, x8/ NAND08GR3B x16 NAND08GW4B NAND08GR4B UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

4 Reference Information Table 1: Devices and CMD Set Covered by NSIM Notes: Family CMD Set 1 Part Number Description NANDXXX-C Read, Random Data Output, NAND04GW3C 4Gb, Core 3V, I/O Cache Read, Exit Cache Read, NAND04GA3C 1.8V/3V, x8/x16 Page Program, Random Data NAND04GW4C Input, Block Erase, Reset, Read Electronic Signature 3, Read NAND04GA4C Status Register NAND08GW3C 8Gb, Core 3V, I/O NAND08GA3C 1.8V/3V, x8/x16 NAND08GW4C 16Gb, Core 3V, I/O 1.8V/3V, x8/x16 NAND08GA4C NAND16GW3C NAND16GA3C NAND16GW4C NAND16GA4C 1. To learn in detail about these CMD sets, please refer to the corresponding data sheet. See Reference Documentation and Technical Support on page Only in 1Gb devices. Add multiplane features (4)(4) only on 2/4/8Gb devices. 3. When using CMD Read Electronic Signature to get the device ID, it will only return device ID of 3V NAND Flash. Reference Documentation and Technical Support The following technical documents are available from either or your Micron distributor: NAND128-A, NAND256-A, NAND512-A and NAND01G-A specifications NAND01G-B and NAND02G-B specifications NAND04GW3B specifications NAND04Gx3C2A and NAND08Gx3C2A specifications UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

5 Overview Overview NSIM offers two main modules: 1. The Nand Flash Viewer (NANDAbstractor.exe) file, which contains the software used to define the features of the NAND Flash device that the developer wants to simulate (capacity, bus width, etc.). It also displays the block status, page status and page data of the virtual NAND Flash memory. 2. The SimulatorTool_DLL library files, which includes SimulatorTool_DLL.lib, SimulatorTool_DLL.dll and SimulatorTool_DLL.h. This library provides a class named CSimulatorTool_DLL that enables developers to generate a virtual NAND Flash memory and execute the operations listed in Table 1 on page 3. Figure 1 shows the NSIM software design architecture and main modules. This section describes the files used or generated in NSIM and the relationships between them. Figure 1: Design Architecture User Program (VC Project) call SimulatorTool_DLL Library (SimulatorTool_DLL.lib SimulatorTool_DLL.dll SimulatorTool_DLL.h) Application Program Interface (APIs) (CommandInput, AddressInput, DataInput, DataOutput, BlocksUnlockDown) call call call call Internal Functions NANDAbstractor.exe create NANDConfig.dat reference Constructor Function create operate on create view Virtual NAND Data File (NANDSimulator.dat) Warning Log File (NANDWarning.log) UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

6 NAND Flash Viewer UM0265 NAND Flash Simulator (NSIM) Overview The NAND Flash Viewer (NANDAbstractor.exe) is responsible for two functions. Its graphical user interface (GUI) first enables the developer to define virtual NAND Flash configurations and then records them in the NANDConfig.dat file. After having creating the virtual NAND Flash data file, the developer can use the Viewer to display its block status, page status and page data. For more information, please see NAND Flash Viewer on page 10. NANDConfig.dat NANDConfig.dat is a configuration file generated by NANDAbstractor.exe and used by the SimulatorTool_DLL library. It records all virtual NAND Flash configurations defined by the developer using the NAND Flash Viewer. Available configuration parameters include capacity, bus width, NAND type, number of bad blocks, path and name of the data file that simulates the NAND Flash and whether or not to erase all good blocks at the beginning. SimulatorTool_DLL Library NANDSimulator.dat The SimulatorTool_DLL library consists of three files: SimulatorTool_DLL.lib SimulatorTool_DLL.dll SimulatorTool_DLL.h. This library offers a class named CSimulatorTool_DLL, which is used by the developer to create a data file to simulate a NAND Flash device. It also executes the operations listed in Table 1 on page 3 on the virtual NAND Flash device using four public APIs: CommandInput() AddressInput() DataInput() DataOutput(). It can also generate a log file named NANDWarning.log, which records all operations detected in the virtual NAND Flash device used in the developer s program that result in an error or warning. NANDSimulator.dat is a data file used to simulate a NAND Flash device configured in the constructor function of class CSimulatorTool_DLL. In another words, it is created when the developer defines an object of class CSimulatorTool_DLL. The content of this file includes the attribute information of all blocks and pages, and data information of each bit of the virtual NAND Flash device. The file size is nearly equal to the size of the virtual NAND Flash device that the developer wants to simulate. All information contained in this file can be viewed using the NAND Flash Viewer. The developer can also use the NAND Flash Viewer to specify a different name for this file. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

7 Overview NANDWarning.log User Programs The NANDWarning.log file is a log file that records all out of specification operations (not indicated by status register) performed on the virtual NAND Flash device. An example of an out of specification operation is an overflow of the number of partial Page Programs on the same page. For the 1Gbit NAND FLASH large page memory, the maximum number of consecutive partial Page Program operations allowed on the same page is eight. This means that the ninth Page Program on the same page will be recorded in the NANDWarning log file. The term User Program refers to the program designed by the developer to run on the NAND Flash device (for example: NFTL program). It may be developed for a non-x86 platform (for example: ARM platform). It can also be developed if a VC6 project is built for the user program and the SimulatorTool_DLL library files are added into this project, replacing original low-level operation functions in the user program with public APIs offered by class CSimulatorTool_DLL: CommandInput, AddressInput, DataInput, DataOutput. Detailed examples are provided in Application Examples on page 20. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

8 System Requirements UM0265 NAND Flash Simulator (NSIM) System Requirements NSIM is a software application that runs on a Windows operating system using Visual C Regardless of the platform that the user program will run on, a VC project must be built. Since NSIM simulates a physical NAND Flash using a standard PC data file, developers do not need a physical NAND Flash device or a development board. Table 2 lists system requirements for NSIM according to the NAND memory type. Table 2: System Requirements for NSIM NAND Type Notes: Disk Space Required (in MB) Total Heap Size with file create 1 (in bytes) Total Heap Size without file create 2 (in bytes) Memory Allocation (in bytes) Page Buffer Page Attribute Buffer 1. It records the total heap size if a new virtual data file needs to be created. 2. It records the total heap size if a virtual data file does not need to be created. Block Attribute Buffer NAND128XX-A NAND256XX-A NAND512XX-A NAND01GXX-A NAND01GXX-B NAND02GXX-B NAND04GXX-B NAND08GXX-B NAND04GXX-C NAND08GXX-C NAND16GXX-C UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

9 Main features Main features The NAND Flash Simulator (NSIM) features make it an ideal software solution to help develop applications designed for NAND Flash devices. Developers no longer have to worry about physical NAND Flash (and board) availability or integrity and can easily find bugs when problems occur in the user program. NSIM includes the following features: Hardware Independent - When developing software for NAND Flash devices using the NSIM, the developer does not need a physical NAND Flash and its corresponding development board and can start work before the hardware platform is available and working well. Configurable - NSIM offers a GUI that lets the user customize virtual NAND Flash parameters. This enables the developer to simulate almost all types of Micron NAND Flash memory. This feature includes the use of user-specific bad block numbers. Direct view - When the user program executes certain operations on physical NAND Flash, it is difficult to know what happens exactly in the memory device. Is the correct data really programmed in the correct place when executing the page program command? With NSIM, developers can use the NAND Flash Viewer to view the internal changes of each bit of the virtual NAND Flash memory. Abundant debug tools - When using NSIM to develop programs, the debug tools offered in Visual C are also available to the developer. Automatic bug checking - Most NAND Flash operations should obey several rules to prevent certain unwanted actions from occurring. If incorrect NAND Flash operations are included in the user program, the NSIM can check and record them in a log file. High execution speed - Operations on physical NAND Flash are usually slow due to both the CPU frequency and physical NAND Flash properties. This means that if certain time-consuming programs need to keep executing on physical NAND Flash devices (for example: pressure test case), the developer must wait a long time. When using the NSIM, the executing speed is increased and the development cycle is shortened. The primary NSIM features are summarized in Table 3. Table 3: NSIM main features Features Hardware Independent Configurable Direct View Abundant Debug Tools Automatic Bug Checking High Executing Speed Benefits No need to consider hardware platform availability and integrity. Simulates almost any type of Micron NAND Flash at will. Views internal NAND Flash conditions when running the user program. Easy to debug. Enhances user program s robustness. Shortens development cycles. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

10 NAND Flash Viewer Caution NAND Device Configuration UM0265 NAND Flash Simulator (NSIM) NAND Flash Viewer The NAND Flash Viewer is executed by the NANDAbstractor.exe. It offers a graphical user interface (GUI) for the developer to implement the following functions: Configure the virtual NAND Flash parameters (capacity, bus width, etc.) according to developer requirements and save them in the NANDConfig.dat configuration file. Display block status, page status and data information in virtual NAND Flash devices. By default, the NSIM creates the NANDConfig.dat file in the same folder as the NANDAbstractor.exe file. Since the SimulatorTool_DLL library will search for NANDConfig.dat in the Simulator folder by default in the VC project (for user program) root directory, ensure that the NANDAbstractor.exe is also located in the Simulator folder. When the developer runs NANDAbstractor.exe for the first time, the NAND Device Configuration interface (Figure 2) appears. This interface enables the developer to configure parameters for the virtual NAND Flash device. If a configuration file already exists when running NANDAbstractor.exe, the parameters recorded in the configuration file are displayed in the dialog box. Figure 2: NAND Device Configuration interface Select the correct values for the following parameters that define the virtual NAND Flash device to be simulated for the user program. Capacity Bus Width Select the memory size of the device: 128Mb, 256Mb, 512Mb, 1GB, 2Gb, 4Gb, 8Gb, or 16Gb. Select either an 8-bit or 16-bit bus width. \ UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

11 NAND Flash Viewer NAND Type Table 4: Define the NAND type from A, B, or C. Table 4 lists the NAND Flash capacity of each supported type. Available capacity for each NAND type NAND Type Description Capacity A SLC, Small Page 128Mb, 256Mb, 512Mb, or 1Gb B SLC, Large Page 1Gb, 2Gb, or 4Gb C MLC, Large Page 4Gb, 8Gb, or 16Gb Bad Blocks Data File Path/Name Note: Erase all good blocks Select the bad block number to simulate. The number can be expressed as decimal value (for example: 15) or in hexadecimal format (for example: 0x1F). Use a comma to separate each bad block number. Select the location and name of the data file for the virtual NAND Flash device. Use Browse to select an existing data file or create a new one. The NANDAbstractor.exe does not create a new NAND Flash configuration data file. This file is created by the constructor function of class CSimulatorTool_DLL with reference to NANDConfig.dat. Select this option to erase all good blocks when starting to use the virtual NAND Flash device. If not selected, the virtual NAND Flash device will contain information previously stored after its last use. Click OK to create a NAND Flash configuration data file that records these parameters and to continue to the NAND Status/Data Viewer dialog box. NAND Status/Data Viewer The NANDAbstractor.exe displays the NAND Status/Data Viewer interface after clicking the OK button in the NAND Device Configuration interface. The NAND Status/Data Viewer interface displays the contents of the NAND Flash configuration data file previously specified in the NAND Device Configuration interface. The NAND Status/Data Viewer interface consists of three levels of windows: Block Status, Page Status and Page Data. The Block Status window (Figure 5 on page 12) provides an overview of the NAND Flash memory. The developer can use the Block Status to see which block is bad, used or free. The Page Status window (Figure 3 on page 13) shows the overall page status of a certain block. The developer can use the Page Status to see which page in a certain block is used or free. The Page Data window (Figure 4 on page 15) shows all the data stored in a certain page. The developer can use the Page Data to see the value of each bit in a certain page. If the NAND Flash configuration data file specified in Data File Path/Name does not exist, the status of each block and page will show as free, and each byte of the virtual NAND Flash will show as 0xFF. If the data file exists, but its features do not match the UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

12 NAND Flash Viewer parameters defined in the NAND Device Configuration interface, then the status and data shown here is invalid until a new data file is created to replace the old one in constructor function of class CSimulatorTool_DLL. Block Status Figure 5 shows a snapshot of the first level Block Status window of the NAND Status/ Data Viewer. Table 5: Snapshot of Block Status Title bar The title bar displays the capacity, bus width and page size, respectively, of the current virtual NAND Flash device (128Mb/x8/528 bytes, in this example). Central Matrix Icon List The central matrix displays the block status of the virtual NAND Flash memory. Each cell in the matrix represents a block. The size of the matrix depends on the capacity and page size of the virtual NAND device. Only 16x16 cells can be shown on the screen. A vertical scroll bar is used to show the other blocks. Horizontal and vertical hexadecimal numbers along the matrix are used to identify the block number. The key on the right side of the window displays a color for each block status, which are described in Table 6. For large-page NAND Flash memories, an additional Read-only feature marked with a lock is added. Both free and used blocks can have this kind of feature. Table 6: Color Meaning in Block Status Color Red Green Grey Block Status Bad Used Free UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

13 NAND Flash Viewer Note: If a block is locked, the block status displays a lock icon. Total number of blocks The total number of blocks is listed in the top, right corner of the Block Status window. Block No. Buttons Page Status Figure 3: The Block No. text box shows the number for the selected block. Select a block using the mouse, or enter a number in this box to display a certain block. Block numbers can be decimal (default) or in hexadecimal format using the prefix 0x. Click Refresh to display the most recent status of all blocks. If operations in the user program have changed the status of certain blocks (for example: programming a free block), click Refresh to display the updated block status. There are three ways to continue to the Page Status window: Use the mouse to select one block in the matrix (single-click) and click View. Double-click a block in the matrix. Enter the Block No. and click View. Figure 3 displays the second-level Page Status window of the NAND Status/Data Viewer. This window is similar to the Block Status window (Figure 5 on page 12). Snapshot of Page Status Title bar The title bar displays the capacity, bus width and page size, respectively, of the current virtual NAND Flash device (128Mb/x8/528 bytes, in this example). Central Matrix The central matrix displays the page status of one block in the virtual NAND Flash memory. Each cell in the matrix represents a page. The size of the matrix is either 16*2 or 16*4, depending on the NAND device. Horizontal and vertical hexadecimal numbers along the matrix are used to identify the page number. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

14 NAND Flash Viewer Icon List Table 7: The key on the right side of the window displays a color for each block status, which are described in Table 7. Color Meaning in Page Status Color Green Grey Block Status Used Free Total number of pages The total number of pages is indicated in the top, right corner of the Page Status window. Block No. and Page No. The Block No. text box displays the number of the selected block. Select a page using the mouse or enter a number in the Page No. box to display a certain page. Page numbers can be decimal (default) or in hexadecimal format using the prefix 0x. Buttons Page Data Click Refresh to display the most recent status of all pages in current block. If operations in the user program have changed the status of certain pages (for example: programming a free page), click Refresh to display the updated block status. Click Back to return the Block Status window. There are three ways to continue to the Page Data window: Use the mouse to select one page in the matrix (single-click) and click View. Double-click on a page in the matrix. Enter the Page No. and click View. Figure 4 displays the third-level Page Data window of the NAND Status/Data Viewer. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

15 NAND Flash Viewer Figure 4: Snapshot of Page Data Title bar The title bar displays the capacity, bus width and page size, respectively, of the current virtual NAND Flash device (128Mb/x8/528 bytes, in this example). Central Matrix The central matrix displays the page data of one page in the virtual NAND Flash memory, which can be divided into two parts: Main Data and Spare Data. For small-page NAND Flash devices, Main Data is 512 bytes and Spare Data is 16 bytes. For large-page NAND Flash devices, Main Data is 2048 bytes and Spare Data is 64 bytes. Each cell in the matrix represents a byte. Horizontal and vertical hexadecimal numbers along the matrix identify the column address of a current page. Block No. and Page No. The Block No. in the bottom, left corner displays the current block number. The Page No. displays the current page number. Buttons Click Refresh to display the most recent data of the current page. If operations in the user program have changed the data of certain pages (for example: programming a free page), click Refresh to display the updated page data. Click Back to return the Page Status window. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

16 NAND Flash Viewer Miscellaneous Functions Click Prove Page to open the Page Data window for the previous page in the same block. If the current page is the first page, pressing this button displays the last page in the block. Click Next Page to open the Page Data window for the next page in the same block. If the current page is the last page, pressing this button displays the first page in the block. The following list outlines additional functions of the NANDAbstractor.exe: Double-click the title bar to minimize the application window. Right-click the title bar to display the system menu with version information. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

17 SimulatorTool_DLL Library Caution Constructor Function Note: Note: UM0265 NAND Flash Simulator (NSIM) SimulatorTool_DLL Library The SimulatorTool_DLL library consists of three files: SimulatorTool_DLL.dll, SimulatorTool_DLL.h and SimulatorTool_DLL.lib. This library provides a class named CSimulatorTool_DLL, through which developers can create a data file to simulate a NAND Flash device and its operations using four interface functions of the class. Simultaneously, if an error occurs during these operations, it is recorded in a NAND- Warning log file created by class CSimulatorTool_DLL. The SimulatorTool_DLL library provides two functions: When an object of class CSimulatorTool_DLL is defined in the VC project of a user program, the constructor function of this class creates a virtual NAND data file based on data in the NANDConfig.dat configuration file. The four interface functions enable developers to perform operations such as erase, read, program, etc., on virtual NAND Flash devices just like on a physical memory device. When using the SimulatorTool_DLL library in the developer VC project, the SimulatorTool_DLL.dll must be placed in the project root directory, while the other two files should be placed in the Simulator folder under the project root directory. The NANDWarning.log file is also created in the Simulator folder. For more information about using the SimulatorTool_DLL library, see Modify the Class CSimulatorTool_DLL on page 22. The Constructor function of class CSimulatorTool_DLL performs the following tasks: Verifies that the NANDWarning.log file exists in the Simulator folder under the VC project root directory. If the file exists, the Constructor function opens the file and prepares to record log data at the end of file. If this file does not exist, it creates this file. Verifies that the NANDConfig.dat configuration file exists in the Simulator folder under the VC project root directory. If the file exists, the Constructor function reads parameters from the file to collect information about the virtual NAND Flash device to be simulated. If this file does not exist, or a meeting error occurs when reading this file, it uses default parameters (Table 8 on page 18) to build the virtual NAND Flash device. All error or warning information is recorded in the NANDWarning.log file and displayed on the PC screen. Verifies that the data file for the virtual NAND Flash specified in the Data File Path/ Name parameter exists. If it does not exist, or if the current data file does not comply with the user program, it creates a new data file based on the NANDConfig.dat file or default values (Table 8 on page 18). Note that if all parameters of the data file comply with the user program except for the bad blocks, the project will continue to use the current data file, but the blocks status (bad or not) will be modified. The corresponding spare area in each bad block will also be flagged. If the Erase all good blocks option is selected, it erases the virtual NAND Flash memory. This means that the contents of all good blocks will be set to 0xFF. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

18 SimulatorTool_DLL Library Table 8: Default Values of Virtual NAND Flash Device Parameter Capacity Bus Width NAND Type Bad Blocks Data File Path/Name Erase all good blocks Default Value 512Mbs 8-bit A (small page, SLC) None $(VC PRJ ROOT DIR)\Simulator\NANDSimulator.dat Yes Functions Table 9: CommandInput Description Definition Arguments Return Value Comments The function receives one command NSIM_Return CommandInput( ubyte NewCommandCode ) (in) NewCommandCode: the command code NSIM_Return: ERROR_NO_ERROR - function terminates correctly ERROR_SEQUENCE - function terminates incorrectly If the function terminates incorrectly, a new entry is recorded in the NANDWarning.log file and a message is displayed on the screen. Operation on the physical NAND Flash will not return a value to confirm operation success. NSIM provides this function to help developers. Table 10: AddressInput Description Definition Arguments Return Value Comments The function receives one circle of address NSIM_Return AddressInput( ubyte NewAddressCode ) (in) NewAddressCode: one circle of address NSIM_Return: ERROR_NO_ERROR - function terminates correctly ERROR_SEQUENCE - function terminates incorrectly If the function terminates incorrectly, a new entry is recorded in the NANDWarning.log file and a message is displayed on the screen. Operation on the physical NAND Flash will not return a value to confirm operation success. NSIM provides this function to help developers. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

19 SimulatorTool_DLL Library Table 11: DataInput Description Definition Arguments Return Value Comments The function receives one data NSIM_Return DataInput( uword NewDataCode ) (in) NewDataCode: data user want to input in NAND Flash NSIM_Return: ERROR_NO_ERROR - function terminates correctly ERROR_SEQUENCE - function terminates incorrectly For NAND Flash devices with an 8-bit bus width, only the low 8-bit content of the NewDataCode is accepted. If the function terminates incorrectly, a new entry is recorded in the NANDWarning.log file and a message is displayed on the screen. Operation on the physical NAND Flash will not return a value to confirm operation success. NSIM provides this function to help developers. Table 12: DataOutput Description Definition Arguments Return Value Comments The function returns one data uword DataOutput(void) None uword: Data read from NAND Flash For NAND Flash devices with an 8-bit bus width, only the low 8-bit content of the return value is valid. The upper 8-bit content must be zero. If the function terminates incorrectly, a new entry is recorded in the NANDWarning.log file and a message is displayed on the screen. Table 13: BlocksUnlockDown Description Definition Arguments Return Value Comments The function simulates unlocking the blocks that have been locked down NSIM_Return BlocksUnlockDown(void) None NSIM_Return: ERROR_NO_ERROR - function terminates correctly ERROR_SEQUENCE - function terminates incorrectly For NANDXXX-B, the blocks locked can be locked-down using command 0x2C, while a locked-down block cannot be unlocked using a software command. Locked-down blocks can only be unlocked using a hardware control operation. The BlocksUnlockDown function is used to simulate this hardware control operation. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

20 Application Examples UM0265 NAND Flash Simulator (NSIM) Application Examples This section provides two examples of the current operations when using NSIM. The first example explains how to get started building a VC project and using the NAND Flash Viewer to visualize changes ( Building a VC Project and Using the NSIM on page 20). The second example explains how to replace the NAND driver in a developer project using the interface functions of class CSimulatorTool_DLL ( Replacing a NAND Driver in a User Project on page 24). Building a VC Project and Using the NSIM Create a New VC Project The following examples show developers how to build a VC project and use NSIM for designing a user program. This demonstration example helps the developer become familiar with the NSIM tool. First create a new VC6.0 project named TEST_SIMULATOR. The project type is Win32 Console Application. The root directory of this project is D:\ TEST_SIMULATOR. Add Required Files 1. Create a new Simulator folder under the project root directory, then copy the NAND- Abstractor.exe, SimulatorTool_DLL.h, and SimulatorTool_DLL.lib into this folder. 2. Copy the SimulatorTool_DLL.dll file into the project root directory. 3. Using VC6.0, add the SimulatorTool_DLL.lib and SimulatorTool_DLL.h files into the VC project. In addition, add any required user program files. Figure 5 shows a sample project in the VC6.0 interface. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

21 Application Examples Figure 5: Snapshot of a Sample Project Caution Since the SimulatorTool_DLL library will search for NANDConfig.dat in the Simulator folder by default in the VC project (for user program) root directory, ensure that the NANDAbstractor.exe is also located in the Simulator folder. Generate the Configuration File Open NANDAbstractor.exe and set the parameters of the virtual NAND Flash device using the NAND Device Configuration interface (Figure 6 on page 22). Then, click OK to generate the NANDConfig.dat configuration file. For more information, see NAND Device Configuration on page 10. This example uses the default parameters defined in Table 8 on page 18. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

22 Application Examples Figure 6: Snapshot of the NAND Device Configuration Interface View Modify the Class CSimulatorTool_DLL Note: Include the header file and define a global object of class CSimulatorTool_DLL in the developer code file. Call interface functions to operate the virtual NAND Flash memory. Only one object of this class is able to exist in a project. Otherwise, NSIM cannot guarantee correct operation. Sample Code /************************************************* * Sample code of using SimulatorTool_DLL library ************************************************** */ // include the header file of SimulatorTool_DLL library #include "./simulator/simulatortool_dll.h" // define an object of class CSimulatorTool_DLL // only one object of this class is permitted to exist in a // project CSimulatorTool_DLL CSIM_Test; void main() { UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

23 Application Examples udword i=0; udword columnaddr = 0x3035; udword blockaddr = columnaddr>>8; //step1. Erase a block of virtual NAND Flash CSIM_Test.CommandInput (0x60); //cmd input for (i=0; i<3; i++) //3 circles are needed to input block address for 512Mb NAND Flash CSIM_Test.AddressInput (blockaddr>>(i*8)); CSIM_Test.CommandInput (0xD0); //confirm cmd input //step2. Program one page of virtual NAND Flash CSIM_Test.CommandInput (0x80); //cmd input for (i=0; i<4; i++) //4 circles are needed to input column address for 512Mb NAND Flash CSIM_Test.AddressInput (columnaddr>>(i*8)); for (i=0; i<50; i++) //program 50 byte area CSIM_Test.DataInput (0x55); CSIM_Test.CommandInput (0x10); //confirm cmd input } Using the NAND Flash Viewer to Visualize Changes After having performed the steps listed in Building a VC Project and Using the NSIM on page 20, run the TEST_SIMULATOR project. The NANDVirtual.dat and NANDWarning.log files are created in the Simulator folder. The It's not recommended that without Pointer Operation before Page Program Operation, default operate on Area A. warning message is displayed on screen and recorded in the log file. For example, if data is refreshed in the data area, the developer can see that the contents of Page 0x10, Block 0x01 has changed from 0xFF to 0x55, as well as the corresponding Block Status and Page Status, as shown in Figure 7. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

24 Application Examples Figure 7: Snapshot of the Page Data Interface View Replacing a NAND Driver in a User Project This example shows how to embed a NSIM library file into an existing user program project to replace the original physical NAND driver code in the user project using the interface functions of class CSimulatorTool_DLL. The NAND driver in this example is based on an upsd3300 platform and the source driver file is upsd_nand528p.cpp. 1. Build a VC project. 1a. Add the NSIM files and user program files into this project. 1b. Launch NANDAbstractor.exe to generate the configuration file. Note: For more information, refer to Create a New VC Project on page Modify the upsd_nand528p.cpp file. 2a. Include the header file SimulatorTool_DLL.h in upsd_nand528p.cpp. #include "./Simulator/SimulatorTool_DLL.h" 2b. Add the global variable VNand in upsd_nand528p.cpp. CSimulatorTool_DLL VNand; 2c. Disable all macro defines related with physical NAND Flash. 2d. Replace the content of the original four basic NAND functions: NAND_CommandInput, NAND_AddressInput, NAND_DataInput and NAND_DataOutput with corresponding interface functions of class CSimulatorTool_DLL. For example, the NAND_CommandInput function is modified as shown in the following example: UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

25 Application Examples void NAND_CommandInput(ubyte ubcommand) { //disable the original content of function /* DATA = ubcommand; ALE = 0; CLE = 1; WE = 1; */ //replace with interface function CommandInput of class CSimulatorTool_DLL VNand.CommandInput (ubcommand); } 3. Run the Developer Project. The developer can now run this project to obtain the result and view the changes of the virtual NAND Flash using the NAND Flash Viewer. If the expected results are shown on the virtual NAND Flash device, the developer can refer to the NANDWarning.log file to check whether improper operations were caused by the Flash device or the user program. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

26 Revision History UM0265 NAND Flash Simulator (NSIM) Revision History Rev. E /10 Applied branding and formatting. Rev /09 Updated per review feedback. Updated the design architecture diagram. Rev /06 Updated NANDXX-B family part number information in Table 1: Devices and CMD Set covered by NSIM. Updated Table 2: System requirements for NSIM. Rev /06 Updated library information. Updated with new NSIM information. Minor editing and converted to corporate template. Rev /05 Initial release of document. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.

27 Disclaimer Disclaimer Please Read Carefully: INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH MICRON PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN MICRON S TERMS AND CONDITIONS OF SALE FOR SUCH PROD- UCTS, MICRON ASSUMES NO LIABILITY WHATSOEVER, AND MICRON DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF MICRON PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. Micron products are not intended for use in medical, life saving, life sustaining, critical control or safety systems, or in nuclear facility applications. Micron may make changes to specifications and product descriptions at any time, without notice. Micron Technology, Inc. may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights that relate to the presented subject matter. The furnishing of documents and other materials and information does not provide any license, express or implied, by estoppel or otherwise, to any such patents, trademarks, copyrights, or other intellectual property rights. Designers must not rely on the absence or characteristics of any features or instructions marked reserved or undefined. Micron reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them. Contact your local Micron sales office or your distributor to obtain the latest specifications and before placing your product order. Copies of documents which have an order number and are referenced in this document, or other Micron literature may be obtained by visiting Micron s website at Micron StrataFlash and Axcell are trademarks or registered trademarks of Micron or its subsidiaries in the United States and other countries. Other names and brands may be claimed as the property of others. Copyright 2010, Micron Technology, Inc., All Rights Reserved. UM0265 NAND Flash Simulator (NSIM) User Guide - Rev. E 7/10 EN Micron Technology, Inc. All rights reserved.