添加新的mtd接口

This commit is contained in:
heyuanjie87
2018-09-18 18:41:33 +08:00
parent 1abe83531c
commit bc5a5f89e9
9 changed files with 1264 additions and 1 deletions
+14 -1
View File
@@ -90,6 +90,20 @@ config RT_USING_MTD_NAND
default n
endif
config RT_USING_MTD
bool "Using Memory Technology Device (MTD)"
default n
if RT_USING_MTD
config MTD_USING_NOR
bool "Using MTD Nor Flash device"
default n
config MTD_USING_NAND
bool "Using MTD Nand Flash device"
default n
endif
config RT_USING_RTC
bool "Using RTC device drivers"
default n
@@ -138,7 +152,6 @@ config RT_USING_SDIO
config RT_MMCSD_MAX_PARTITION
int "mmcsd max partition"
default 16
config RT_SDIO_DEBUG
bool "Enable SDIO debug log output"
default n
+118
View File
@@ -0,0 +1,118 @@
/*
* File : mtd.h
* This file is part of RT-Thread RTOS
* COPYRIGHT (C) 2012, Shanghai Real-Thread Technology Co., Ltd
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Change Logs:
* Date Author Notes
* 2018-7-5 heyuanjie the first version
*/
#ifndef __MTD_H__
#define __MTD_H__
#include <rtthread.h>
#include <stddef.h>
#include <stdint.h>
#define MTD_TYPE_NOR 1
#define MTD_TYPE_NAND 2
/**
* MTD operation modes
*
* @MTD_OPM_PLACE_OOB: OOB data are placed at the given offset (default)
* @MTD_OPM_AUTO_OOB: OOB data are automatically placed at the free areas
* @MTD_OPM_RAW: data are transferred as-is, with no error correction;
*/
enum mtd_opm
{
MTD_OPM_PLACE_OOB = 0,
MTD_OPM_AUTO_OOB = 1,
MTD_OPM_RAW = 2,
};
#ifndef loff_t
typedef long loff_t;
#endif
struct mtd_oob_region
{
uint8_t offset;
uint8_t length;
};
typedef struct mtd_info
{
struct rt_device parent;
const struct mtd_ops *ops;
uint16_t oob_size;
uint16_t sector_size; /* Minimal writable flash unit size */
uint32_t block_size:28; /* Erase size for the device */
uint32_t type:4;
size_t size; /* Total size of the MTD */
loff_t offset; /* At which this MTD starts, from the beginning of the MEMORY */
struct mtd_info *master;
void *priv;
}rt_mtd_t;
struct mtd_io_desc
{
uint8_t mode; /* operation mode(enum mtd_opm) */
uint8_t ooblen; /* number of oob bytes to write/read */
uint8_t oobretlen; /* number of oob bytes written/read */
uint8_t ooboffs; /* offset in the oob area */
uint8_t *oobbuf;
size_t datlen; /* number of data bytes to write/read */
size_t datretlen; /* number of data bytes written/read */
uint8_t *datbuf; /* if NULL only oob are read/written */
};
struct mtd_ops
{
int(*erase)(rt_mtd_t *mtd, loff_t addr, size_t len); /* return 0 if success */
int(*read) (rt_mtd_t *mtd, loff_t from, struct mtd_io_desc *ops); /* return 0 if success */
int(*write) (rt_mtd_t *mtd, loff_t to, struct mtd_io_desc *ops); /* return 0 if success */
int(*isbad) (rt_mtd_t *mtd, uint32_t block); /* return 1 if bad, 0 not bad */
int(*markbad) (rt_mtd_t *mtd, uint32_t block); /* return 0 if success */
};
struct mtd_part
{
const char *name; /* name of the MTD partion */
loff_t offset; /* start addr of partion */
size_t size; /* size of partion */
};
int rt_mtd_erase(rt_mtd_t *mtd, loff_t addr, size_t size);
int rt_mtd_block_erase(rt_mtd_t *mtd, uint32_t block);
int rt_mtd_read_oob(rt_mtd_t *mtd, loff_t from, struct mtd_io_desc *desc);
int rt_mtd_write_oob(rt_mtd_t *mtd, loff_t to, struct mtd_io_desc *desc);
int rt_mtd_read(rt_mtd_t *mtd, loff_t from, uint8_t *buf, size_t len);
int rt_mtd_write(rt_mtd_t *mtd, loff_t to, const uint8_t *buf, size_t len);
int rt_mtd_block_markbad(rt_mtd_t *mtd, uint32_t block);
int rt_mtd_block_isbad(rt_mtd_t *mtd, uint32_t block);
rt_mtd_t* rt_mtd_get(const char *name);
int rt_mtd_register(rt_mtd_t *master, const struct mtd_part *parts, int np);
#endif
@@ -0,0 +1,118 @@
/*
* File : nand.h
* This file is part of RT-Thread RTOS
* COPYRIGHT (C) 2006 - 2012, RT-Thread Development Team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Change Logs:
* Date Author Notes
* 2018-7-8 heyuanjie the first version
*/
/*
* COPYRIGHT (C) 2012, Shanghai Real Thread
*/
#ifndef _MTDNAND_H_
#define _MTDNAND_H_
#include "mtd.h"
/* Status bits */
#define NAND_STATUS_FAIL 0x01
#define NAND_STATUS_FAIL_N1 0x02
#define NAND_STATUS_WP 0x80
typedef enum
{
NAND_CMD_PAGE_RD, /* read data to chip's page buffer,do WaitBusy after this cmd in low driver */
NAND_CMD_PAGE_WR0, /* write data to chip's page buffer */
NAND_CMD_PAGE_WR1, /* do flash programe */
NAND_CMD_BLK_ERASE, /* erase block */
NAND_CMD_ECC_EN, /* enable gen HWECC */
NAND_CMD_ECC_DIS /* disable gen HWECC */
} nand_cmd_t;
typedef enum
{
NAND_ECCM_NONE,
NAND_ECCM_HW,
} nand_eccmode_t;
struct nand_chip;
struct nand_ops;
/**
* struct nand_buffers - buffer structure for read/write
* @ecccalc: buffer pointer for calculated ECC, size is oobsize.
* @ecccode: buffer pointer for ECC read from flash, size is oobsize.
*
*/
struct nand_buffers
{
uint8_t *ecccalc;
uint8_t *ecccode;
};
struct nand_ecc
{
uint8_t mode; /* nand_eccmode_t */
uint8_t bytes; /* gen ecc bytes per ecc step(usually 3) */
uint16_t stepsize:12; /* min 256 */
uint16_t _step:4; /* */
/* driver must set the two interface if HWECC */
void (*calculate)(struct nand_chip *chip, const uint8_t *dat, uint8_t *ecc_code);
/* return max bit flips if can't correct,return -1 ECC is error(0 success) */
int(*correct)(struct nand_chip *chip, uint8_t *dat, uint8_t *read_ecc, uint8_t *calc_ecc);
/* ignore if NONECC */
const struct mtd_oob_region *layout;
};
typedef struct nand_chip
{
rt_mtd_t parent;
/* driver must init these */
const struct nand_ops *ops;
struct nand_ecc ecc;
const struct mtd_oob_region *freelayout;
/* driver do not touch */
struct nand_buffers buffers;
uint8_t *oob_poi;
uint8_t *pagebuf;
uint32_t size;
uint16_t oobsize;
uint8_t pages_pb;
uint16_t page_size;
int(*read_page)(struct nand_chip *chip, uint8_t *buf, int oob_required, int page);
int(*write_page)(struct nand_chip *chip, const uint8_t *buf, int oob_required, int page);
}rt_nand_t;
struct nand_ops
{
int(*cmdfunc)(rt_nand_t *nand, int cmd, int page, int offset); /* send nand operation cmd, return Status bits(0 success),
if nand is busy please wait in low driver */
int(*read_buf)(rt_nand_t *nand, uint8_t *buf, int len); /* read data from nand chip's page buffer */
int(*write_buf)(rt_nand_t *nand, const uint8_t *buf, int len);/* write data to nand chip's page buffer */
int(*isbad)(rt_nand_t *nand, uint32_t blk); /* if NULL OOB[0] used as bad mark(not 0xff is bad) */
int(*markbad)(rt_nand_t *nand, uint32_t blk); /* if NULL OOB[0] used as bad mark(set to 0x00) */
};
int rt_mtd_nand_init(rt_nand_t *nand, int blk_size, int page_size, int blks_pc, int oob_size);
#endif /* MTD_NAND_H_ */
@@ -0,0 +1,48 @@
/*
* File : mtdnor.h
* This file is part of RT-Thread RTOS
* COPYRIGHT (C) 2012, Shanghai Real-Thread Technology Co., Ltd
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Change Logs:
* Date Author Notes
* 2018-8-30 heyuanjie the first version
*/
#ifndef __MTDNOR_H__
#define __MTDNOR_H__
#include <drivers/mtd.h>
struct nor_ops;
typedef struct
{
rt_mtd_t parent;
const struct nor_ops *ops; /* operations interface */
}rt_nor_t;
struct nor_ops
{
int (*erase)(rt_nor_t *nor, loff_t addr, size_t len); /* return success erased len or error code */
int (*read)(rt_nor_t *nor, loff_t addr, uint8_t *buf, size_t len); /* return success data size or error code */
int (*write)(rt_nor_t *nor, loff_t addr, const uint8_t *buf, size_t len); /* return success data size or error code */
};
int rt_mtd_nor_init(rt_nor_t *nor, int blksize);
#endif
+7
View File
@@ -117,6 +117,13 @@ extern "C" {
#include "drivers/rt_drv_pwm.h"
#endif
#ifdef MTD_USING_NOR
#include "drivers/mtdnor.h"
#endif
#ifdef MTD_USING_NAND
#include "drivers/mtdnand.h"
#endif
#ifdef __cplusplus
}
#endif
+11
View File
@@ -9,6 +9,17 @@ depend = []
CPPPATH = [cwd + '/../include']
group = []
if GetDepend(['RT_USING_MTD']):
src += ['mtd.c']
depend += ['RT_USING_MTD']
if GetDepend(['MTD_USING_NOR']):
src += ['mtdnor.c']
depend += ['MTD_USING_NOR']
if GetDepend(['MTD_USING_NAND']):
src += ['mtdnand.c']
depend += ['MTD_USING_NAND']
if GetDepend(['RT_USING_MTD_NOR']):
src += ['mtd_nor.c']
depend += ['RT_USING_MTD_NOR']
+225
View File
@@ -0,0 +1,225 @@
#include <drivers/mtd.h>
static rt_mtd_t* mtd_part_alloc(rt_mtd_t *master, const struct mtd_part *part)
{
rt_mtd_t *slave;
slave = rt_malloc(sizeof(rt_mtd_t));
if (slave == RT_NULL)
goto out;
slave->master = master;
*slave = *master;
slave->size = part->size;
slave->offset = part->offset;
out:
return slave;
}
rt_mtd_t* rt_mtd_get(const char *name)
{
rt_mtd_t *mtd;
mtd = (rt_mtd_t *)rt_device_find(name);
if (mtd == RT_NULL)
return RT_NULL;
if (mtd->parent.type != RT_Device_Class_MTD)
return RT_NULL;
return mtd;
}
/*
* Register MTD driver
*
* @parts partion description
* @np number of partitions
* @return number of unregistered partitions
*
*/
int rt_mtd_register(rt_mtd_t *master, const struct mtd_part *parts, int np)
{
int ret;
rt_mtd_t *slave;
master->master = master;
master->parent.type = RT_Device_Class_MTD;
if (np > 0)
{
master->offset = parts->offset;
master->size = parts->size;
ret = rt_device_register((rt_device_t)master, parts->name, 0);
if (ret != 0)
goto _out;
np --;
parts ++;
}
while (np > 0)
{
slave = mtd_part_alloc(master, parts);
if (!slave)
break;
ret = rt_device_register((rt_device_t)slave, parts->name, 0);
if (ret)
break;
parts ++;
np --;
}
_out:
return np;
}
int rt_mtd_block_erase(rt_mtd_t *mtd, uint32_t block)
{
uint32_t total_blks;
loff_t addr;
total_blks = mtd->size/mtd->block_size;
if (block >= total_blks)
return -EINVAL;
addr = mtd->offset + mtd->block_size * block;
return mtd->ops->erase(mtd->master, addr, mtd->block_size);
}
int rt_mtd_block_isbad(rt_mtd_t *mtd, uint32_t block)
{
uint32_t total_blks, offset_blk;
if (!mtd->ops->isbad)
return 0;
total_blks = mtd->size / mtd->block_size;
if (block >= total_blks)
return -EINVAL;
offset_blk = mtd->offset / mtd->block_size;
return mtd->ops->isbad(mtd->master, block + offset_blk);
}
int rt_mtd_block_markbad(rt_mtd_t *mtd, uint32_t block)
{
uint32_t total_blks, offset_blk;
if (!mtd->ops->markbad)
return -EOPNOTSUPP;
total_blks = mtd->size / mtd->block_size;
if (block >= total_blks)
return -EINVAL;
offset_blk = mtd->offset / mtd->block_size;
return mtd->ops->markbad(mtd->master, block + offset_blk);
}
int rt_mtd_erase(rt_mtd_t *mtd, loff_t addr, size_t size)
{
if (addr > mtd->size || (addr + size) > mtd->size)
return -EINVAL;
addr += mtd->offset;
return mtd->ops->erase(mtd->master, addr, size);
}
/*
* Read data only
*
* @from offset to read from
* @return success size or error code
*/
int rt_mtd_read(rt_mtd_t *mtd, loff_t from, uint8_t *buf, size_t len)
{
int ret;
struct mtd_io_desc desc = {0};
if (from < 0 || from >= (loff_t)mtd->size || len > mtd->size - from)
return -EINVAL;
if (!len)
return 0;
desc.datbuf = buf;
desc.datlen = len;
ret = mtd->ops->read(mtd->master, from + mtd->offset, &desc);
if (ret)
return ret;
return desc.datretlen;
}
/**
* Write data only
*
* @to offset to write from
* @return success size or error code
*/
int rt_mtd_write(rt_mtd_t *mtd, loff_t to, const uint8_t *buf, size_t len)
{
int ret;
struct mtd_io_desc desc = {0};
if (to < 0 || to >= (loff_t)mtd->size || len > mtd->size - to)
return -EINVAL;
if (!mtd->ops->write)
return -EROFS;
if (!len)
return 0;
desc.datbuf = (uint8_t*)buf;
desc.datlen = len;
ret = mtd->ops->write(mtd->master, to + mtd->offset, &desc);
if (ret)
return ret;
return desc.datretlen;
}
/**
* Read data and/or out-of-band
*
* @from offset to read from
* @desc sector operation description structure
* @return error code, 0 success
*/
int rt_mtd_read_oob(rt_mtd_t *mtd, loff_t from, struct mtd_io_desc *desc)
{
desc->datretlen = 0;
desc->oobretlen = 0;
if (from < 0 || from >= (loff_t)mtd->size)
return -EINVAL;
if (desc->datbuf && (desc->datlen > (mtd->size - from)))
return -EINVAL;
return mtd->ops->read(mtd->master, from + mtd->offset, desc);
}
/**
* Write data and/or out-of-band
*
* @to offset to read from
* @desc sector operation description structure
* @return error code, 0 success
*/
int rt_mtd_write_oob(rt_mtd_t *mtd, loff_t to, struct mtd_io_desc *desc)
{
desc->datretlen = 0;
desc->oobretlen = 0;
if (to < 0 || to >= (loff_t)mtd->size)
return -EINVAL;
if (desc->datbuf && (desc->datlen >(mtd->size - to)))
return -EINVAL;
return mtd->ops->write(mtd->master, to + mtd->offset, desc);
}
File diff suppressed because it is too large Load Diff
+87
View File
@@ -0,0 +1,87 @@
/*
* File : mtdnor.c
* This file is part of RT-Thread RTOS
* COPYRIGHT (C) 2012, Shanghai Real-Thread Technology Co., Ltd
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Change Logs:
* Date Author Notes
* 2018-8-30 heyuanjie the first version
*/
#include <drivers/mtdnor.h>
#ifdef MTD_USING_NOR
static int _nor_erase(rt_mtd_t *mtd, loff_t addr, size_t len)
{
rt_nor_t *nor;
nor = (rt_nor_t *)mtd;
return nor->ops->erase(nor, addr, len);
}
static int _nor_read(rt_mtd_t *mtd, loff_t from, struct mtd_io_desc *desc)
{
rt_nor_t *nor;
int ret;
nor = (rt_nor_t *)mtd;
ret = nor->ops->read(nor, from, desc->datbuf, desc->datlen);
if (ret > 0)
{
desc->datretlen = ret;
ret = 0;
}
return ret;
}
static int _nor_write(rt_mtd_t *mtd, loff_t to, struct mtd_io_desc *desc)
{
rt_nor_t *nor;
int ret;
nor = (rt_nor_t *)mtd;
ret = nor->ops->write(nor, to, desc->datbuf, desc->datlen);
if (ret > 0)
{
desc->datretlen = ret;
ret = 0;
}
return ret;
}
static const struct mtd_ops _ops =
{
_nor_erase,
_nor_read,
_nor_write,
0,
0
};
int rt_mtd_nor_init(rt_nor_t *nor, int blksize)
{
nor->parent.sector_size = 1;
nor->parent.block_size = blksize;
nor->parent.ops = &_ops;
nor->parent.type = MTD_TYPE_NOR;
nor->parent.oob_size = 0;
return 0;
}
#endif