123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- /*
- This file is part of UFFS, the Ultra-low-cost Flash File System.
-
- Copyright (C) 2005-2009 Ricky Zheng <ricky_gz_zheng@yahoo.co.nz>
- UFFS is free software; you can redistribute it and/or modify it under
- the GNU Library General Public License as published by the Free Software
- Foundation; either version 2 of the License, or (at your option) any
- later version.
- UFFS is distributed in the hope that it will be useful, but WITHOUT
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- or GNU Library General Public License, as applicable, for more details.
-
- You should have received a copy of the GNU General Public License
- and GNU Library General Public License along with UFFS; if not, write
- to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
- As a special exception, if other files instantiate templates or use
- macros or inline functions from this file, or you compile this file
- and link it with other works to produce a work based on this file,
- this file does not by itself cause the resulting work to be covered
- by the GNU General Public License. However the source code for this
- file must still be made available in accordance with section (3) of
- the GNU General Public License v2.
-
- This exception does not invalidate any other reasons why a work based
- on this file might be covered by the GNU General Public License.
- */
- /**
- * \file flash-interface-example.c
- * \brief example for using flash driver and multiple partitions, with static memory allocator.
- * \author Ricky Zheng, created at 27 Nov, 2007
- */
-
- #include <string.h>
- #include "uffs_config.h"
- #include "uffs/uffs_os.h"
- #include "uffs/uffs_device.h"
- #include "uffs/uffs_flash.h"
- #include "uffs/uffs_mtb.h"
- #include "uffs/uffs_fs.h"
- #define PFX "ndrv: "
- struct my_nand_chip {
- void *IOR_ADDR;
- void *IOW_ADDR;
- UBOOL inited;
- // ...
- };
- /*
- * Standard NAND flash commands
- */
- #define NAND_CMD_READ0 0
- #define NAND_CMD_READ1 1
- #define NAND_CMD_RNDOUT 5
- #define NAND_CMD_PAGEPROG 0x10
- #define NAND_CMD_READOOB 0x50
- #define NAND_CMD_ERASE1 0x60
- #define NAND_CMD_STATUS 0x70
- #define NAND_CMD_STATUS_MULTI 0x71
- #define NAND_CMD_SEQIN 0x80
- #define NAND_CMD_RNDIN 0x85
- #define NAND_CMD_READID 0x90
- #define NAND_CMD_ERASE2 0xd0
- #define NAND_CMD_RESET 0xff
- /* impelent the following functions for your NAND flash */
- #define CHIP_SET_CLE(chip) { chip = chip; }
- #define CHIP_CLR_CLE(chip) {}
- #define CHIP_SET_ALE(chip) {}
- #define CHIP_CLR_ALE(chip) {}
- #define CHIP_SET_NCS(chip) {}
- #define CHIP_CLR_NCS(chip) {}
- #define CHIP_BUSY(chip) {}
- #define CHIP_READY(chip) {}
- #define WRITE_COMMAND(chip, cmd) {}
- #define WRITE_DATA_ADDR(chip, block, page, offset) {}
- #define WRITE_ERASE_ADDR(chip, block) {}
- #define WRITE_DATA(chip, data, len) {}
- #define READ_DATA(chip, data, len) {}
- #define PARSE_STATUS(v) (UFFS_FLASH_NO_ERR) // parse status to UFFS_FLASH_NO_ERR or UFFS_FLASH_BAD_BLK
- #if CONFIG_USE_STATIC_MEMORY_ALLOCATOR == 0
- int main()
- {
- uffs_Perror(UFFS_MSG_NORMAL, "This example need CONFIG_USE_STATIC_MEMORY_ALLOCATOR = 1");
- return 0;
- }
- #else
- static int nand_read_page(uffs_Device *dev, u32 block, u32 page, u8 *data, int data_len, u8 *ecc,
- u8 *spare, int spare_len)
- {
- u8 val = 0;
- int ret = UFFS_FLASH_NO_ERR;
- struct my_nand_chip *chip = (struct my_nand_chip *) dev->attr->_private;
- CHIP_CLR_NCS(chip);
- if (data && data_len > 0) {
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_READ0);
- CHIP_CLR_CLE(chip);
- CHIP_SET_ALE(chip);
- WRITE_DATA_ADDR(chip, block, page, 0);
- CHIP_CLR_ALE(chip);
- READ_DATA(chip, data, data_len);
- // for now, we return all 0xFF to pass UFFS mount, you should remove this at your driver
- memset(data, 0xFF, data_len);
- }
- if (spare && spare_len > 0) {
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_READOOB);
- CHIP_CLR_CLE(chip);
- CHIP_SET_ALE(chip);
- WRITE_DATA_ADDR(chip, block, page, dev->attr->page_data_size);
- CHIP_CLR_ALE(chip);
- READ_DATA(chip, spare, spare_len);
- // for now, we return all 0xFF to pass UFFS mount, you should remove this at your driver
- memset(spare, 0xFF, spare_len);
- }
- if (data == NULL && spare == NULL) {
- // read bad block mark
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_READOOB);
- CHIP_CLR_CLE(chip);
- CHIP_SET_ALE(chip);
- WRITE_DATA_ADDR(chip, block, page, dev->attr->page_data_size + attr->block_status_offs);
- CHIP_CLR_ALE(chip);
- READ_DATA(chip, &val, 1);
- ret = (val == 0xFF ? UFFS_FLASH_NO_ERR : UFFS_FLASH_BAD_BLK);
- // for now, we return UFFS_FLASH_NO_ERR to pass UFFS mount, you should remove this at your driver
- ret = UFFS_FLASH_NO_ERR;
- }
- CHIP_SET_NCS(chip);
- return ret;
- }
- static int nand_write_page(uffs_Device *dev, u32 block, u32 page,
- const u8 *data, int data_len, const u8 *spare, int spare_len)
- {
- u8 val = 0;
- int ret = UFFS_FLASH_NO_ERR;
- UBOOL fall_through = FALSE;
- struct my_nand_chip *chip = (struct my_nand_chip *) dev->attr->_private;
- CHIP_CLR_NCS(chip);
- if (data && data_len > 0) {
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_READ0);
- WRITE_COMMAND(chip, NAND_CMD_SEQIN);
- CHIP_CLR_CLE(chip);
- CHIP_SET_ALE(chip);
- WRITE_DATA_ADDR(chip, block, page, 0);
- CHIP_CLR_ALE(chip);
- CHIP_BUSY(chip);
- WRITE_DATA(chip, data, data_len);
- if (data_len == dev->attr->page_data_size)
- fall_through = U_TRUE;
- else {
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_PAGEPROG);
- WRITE_COMMAND(chip, NAND_CMD_STATUS);
- CHIP_CLR_CLE(chip);
- CHIP_READY(chip);
- READ_DATA(chip, &val, 1);
- ret = PARSE_STATUS(val);
- }
- }
- if (ret != UFFS_FLASH_NO_ERR)
- goto ext;
- if (spare && spare_len > 0) {
- if (!fall_through) {
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_READOOB);
- WRITE_COMMAND(chip, NAND_CMD_SEQIN);
- CHIP_CLR_CLE(chip);
- CHIP_SET_ALE(chip);
- WRITE_DATA_ADDR(chip, block, page, dev->attr->page_data_size);
- CHIP_CLR_ALE(chip);
- CHIP_BUSY(chip);
- }
- WRITE_DATA(chip, spare, spare_len);
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_PAGEPROG);
- WRITE_COMMAND(chip, NAND_CMD_STATUS);
- CHIP_CLR_CLE(chip);
- CHIP_READY(chip);
- READ_DATA(chip, &val, 1);
- ret = PARSE_STATUS(val);
- }
- if (data == NULL && spare == NULL) {
- // mark bad block
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_READOOB);
- WRITE_COMMAND(chip, NAND_CMD_SEQIN);
- CHIP_CLR_CLE(chip);
- CHIP_SET_ALE(chip);
- WRITE_DATA_ADDR(chip, block, page, dev->attr->page_data_size + attr->block_status_offs);
- CHIP_CLR_ALE(chip);
- CHIP_BUSY(chip);
- val = 0;
- WRITE_DATA(chip, &val, 1);
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_PAGEPROG);
- WRITE_COMMAND(chip, NAND_CMD_STATUS);
- CHIP_CLR_CLE(chip);
- CHIP_READY(chip);
- READ_DATA(chip, &val, 1);
- ret = PARSE_STATUS(val);
- }
- ext:
- CHIP_SET_NCS(chip);
- return ret;
- }
- static int nand_erase_block(uffs_Device *dev, u32 block)
- {
- u8 val = 0;
- struct my_nand_chip *chip = (struct my_nand_chip *) dev->attr->_private;
- CHIP_CLR_NCS(chip);
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_ERASE1);
- CHIP_CLR_CLE(chip);
- CHIP_SET_ALE(chip);
- WRITE_ERASE_ADDR(chip, blcok);
- CHIP_CLR_ALE(chip);
- CHIP_SET_CLE(chip);
- WRITE_COMMAND(chip, NAND_CMD_ERASE2);
- WRITE_COMMAND(chip, NAND_CMD_STATUS);
- CHIP_CLR_CLE(chip);
- CHIP_READY(chip);
- READ_DATA(chip, &val, 1);
- CHIP_SET_NCS(chip);
- val = val; // just for eliminating warning
- return PARSE_STATUS(val);
- }
- static int nand_init_flash(uffs_Device *dev)
- {
- // initialize your hardware here ...
- struct my_nand_chip *chip = (struct my_nand_chip *) dev->attr->_private;
- if (!chip->inited) {
- // setup chip I/O address, setup NAND flash controller ... etc.
- // chip->IOR_ADDR = 0xF0000000
- // chip->IOW_ADDR = 0xF0000000
- chip->inited = U_TRUE;
- }
- return 0;
- }
- static int nand_release_flash(uffs_Device *dev)
- {
- // release your hardware here
- struct my_nand_chip *chip = (struct my_nand_chip *) dev->attr->_private;
- chip = chip;
- return 0;
- }
- static uffs_FlashOps g_my_nand_ops = {
- nand_init_flash, // InitFlash()
- nand_release_flash, // ReleaseFlash()
- nand_read_page, // ReadPage()
- NULL, // ReadPageWithLayout
- nand_write_page, // WritePage()
- NULL, // WritePageWithLayout
- NULL, // IsBadBlock(), let UFFS take care of it.
- NULL, // MarkBadBlock(), let UFFS take care of it.
- nand_erase_block, // EraseBlock()
- };
- /////////////////////////////////////////////////////////////////////////////////
- // change these parameters to fit your nand flash specification
- #define TOTAL_BLOCKS 1024
- #define PAGE_DATA_SIZE 512
- #define PAGE_SPARE_SIZE 16
- #define PAGES_PER_BLOCK 32
- #define PAGE_SIZE (PAGE_DATA_SIZE + PAGE_SPARE_SIZE)
- #define BLOCK_DATA_SIZE (PAGE_DATA_SIZE * PAGES_PER_BLOCK)
- #define NR_PARTITION 2 /* total partitions */
- #define PAR_1_BLOCKS 100 /* partition 1 */
- #define PAR_2_BLOCKS (TOTAL_BLOCKS - PAR_1_BLOCKS) /* partition 2 */
- struct my_nand_chip g_nand_chip = {0};
- static struct uffs_StorageAttrSt g_my_flash_storage = {0};
- /* define mount table */
- static uffs_Device demo_device_1 = {0};
- static uffs_Device demo_device_2 = {0};
- static uffs_MountTable demo_mount_table[] = {
- { &demo_device_1, 0, PAR_1_BLOCKS - 1, "/data/" },
- { &demo_device_2, PAR_1_BLOCKS, PAR_1_BLOCKS + PAR_2_BLOCKS - 1, "/" },
- { NULL, 0, 0, NULL }
- };
- /* static alloc the memory for each partition */
- static int static_buffer_par1[UFFS_STATIC_BUFF_SIZE(PAGES_PER_BLOCK, PAGE_SIZE, PAR_1_BLOCKS) / sizeof(int)];
- static int static_buffer_par2[UFFS_STATIC_BUFF_SIZE(PAGES_PER_BLOCK, PAGE_SIZE, PAR_2_BLOCKS) / sizeof(int)];;
- static void init_nand_chip(struct my_nand_chip *chip)
- {
- // init chip IO address, etc.
- }
- static void setup_flash_storage(struct uffs_StorageAttrSt *attr)
- {
- memset(attr, 0, sizeof(struct uffs_StorageAttrSt));
-
- // setup NAND flash attributes.
- attr->total_blocks = TOTAL_BLOCKS; /* total blocks */
- attr->page_data_size = PAGE_DATA_SIZE; /* page data size */
- attr->pages_per_block = PAGES_PER_BLOCK; /* pages per block */
- attr->spare_size = PAGE_SPARE_SIZE; /* page spare size */
- attr->block_status_offs = 4; /* block status offset is 5th byte in spare */
- attr->ecc_opt = UFFS_ECC_SOFT; /* ecc option */
- attr->layout_opt = UFFS_LAYOUT_UFFS; /* let UFFS do the spare layout */
- }
- static URET my_InitDevice(uffs_Device *dev)
- {
- dev->attr = &g_my_flash_storage; // NAND flash attributes
- dev->attr->_private = (void *) &g_nand_chip;// hook nand_chip data structure to attr->_private
- dev->ops = &g_my_nand_ops; // NAND driver
- init_nand_chip(&g_nand_chip);
-
- return U_SUCC;
- }
- static URET my_ReleaseDevice(uffs_Device *dev)
- {
- return U_SUCC;
- }
- static int my_init_filesystem(void)
- {
- uffs_MountTable *mtbl = &(demo_mount_table[0]);
- /* setup nand storage attributes */
- setup_flash_storage(&g_my_flash_storage);
- /* setup memory allocator */
- uffs_MemSetupStaticAllocator(&demo_device_1.mem, static_buffer_par1, sizeof(static_buffer_par1));
- uffs_MemSetupStaticAllocator(&demo_device_2.mem, static_buffer_par2, sizeof(static_buffer_par2));
- /* register mount table */
- while(mtbl->dev) {
- // setup device init/release entry
- mtbl->dev->Init = my_InitDevice;
- mtbl->dev->Release = my_ReleaseDevice;
- uffs_RegisterMountTable(mtbl);
- mtbl++;
- }
- // mount partitions
- for (mtbl = &(demo_mount_table[0]); mtbl->mount != NULL; mtbl++) {
- uffs_Mount(mtbl->mount);
- }
- return uffs_InitFileSystemObjects() == U_SUCC ? 0 : -1;
- }
- static int my_release_filesystem(void)
- {
- uffs_MountTable *mtb;
- int ret = 0;
- // unmount parttions
- for (mtb = &(demo_mount_table[0]); ret == 0 && mtb->mount != NULL; mtb++) {
- ret = uffs_UnMount(mtb->mount);
- }
- // release objects
- if (ret == 0)
- ret = (uffs_ReleaseFileSystemObjects() == U_SUCC ? 0 : -1);
- return ret;
- }
- /* application entry */
- int main()
- {
- uffs_SetupDebugOutput(); // setup debug output as early as possible
- my_init_filesystem();
- // ... my application codes ....
- // read/write/create/delete files ...
- my_release_filesystem();
- return 0;
- }
- #endif
- /////////////////////////////////////////////////////////////////////////////////
|