02aa7bcefe
Current driver supports MTDIOC_BULKERASE ioctl that erases the entire device. The added ioctl MTDIOC_ERASESECTORS adds possibility to erase just sectors defined by the user. This is similar to MEMERASE call in Linux kernel. Signed-off-by: Michal Lenc <michallenc@seznam.cz>
731 lines
26 KiB
C
731 lines
26 KiB
C
/****************************************************************************
|
|
* include/nuttx/mtd/mtd.h
|
|
* Memory Technology Device (MTD) interface
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_MTD_MTD_H
|
|
#define __INCLUDE_NUTTX_MTD_MTD_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <sys/types.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
#include <nuttx/fs/ioctl.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Ioctl commands */
|
|
|
|
/* Note, the following ioctl existed in the past and was removed:
|
|
* #define MTDIOC_XIPBASE _MTDIOC(0x0002)
|
|
* #define MTDIOC_FLUSH _MTDIOC(0x0009)
|
|
* #define MTDIOC_PARTINFO _MTDIOC(0x000b)
|
|
* try to avoid adding a new ioctl with the same ioctl number and
|
|
* replace with BIOC_XIPBASE, BIOC_FLUSH and BIOC_PARTINFO instead.
|
|
*/
|
|
|
|
#define MTDIOC_GEOMETRY _MTDIOC(0x0001) /* IN: Pointer to write-able struct
|
|
* mtd_geometry_s in which to receive
|
|
* receive geometry data (see mtd.h)
|
|
* OUT: Geometry structure is populated
|
|
* with data for the MTD */
|
|
#define MTDIOC_BULKERASE _MTDIOC(0x0003) /* IN: None
|
|
* OUT: None */
|
|
#define MTDIOC_PROTECT _MTDIOC(0x0004) /* IN: Pointer to read-able struct
|
|
* mtd_protects_s that provides
|
|
* the region to protect.
|
|
* OUT: None */
|
|
#define MTDIOC_UNPROTECT _MTDIOC(0x0005) /* IN: Pointer to read-able struct
|
|
* mtd_protects_s that provides
|
|
* the region to un-protect.
|
|
* OUT: None */
|
|
#define MTDIOC_SETSPEED _MTDIOC(0x0006) /* IN: New bus speed in Hz
|
|
* OUT: None */
|
|
#define MTDIOC_EXTENDED _MTDIOC(0x0007) /* IN: unsigned long
|
|
* 0=Use normal memory region
|
|
* 1=Use alternate/extended memory
|
|
* OUT: None */
|
|
#define MTDIOC_ECCSTATUS _MTDIOC(0x0008) /* IN: Pointer to uint8_t
|
|
* OUT: ECC status */
|
|
#define MTDIOC_ERASESTATE _MTDIOC(0x000a) /* IN: Pointer to uint8_t
|
|
* OUT: Byte value that represents the
|
|
* erased state of the MTD cell */
|
|
#define MTDIOC_ERASESECTORS _MTDIOC(0x000c) /* IN: Pointer to mtd_erase_s structure
|
|
* OUT: None */
|
|
|
|
/* Macros to hide implementation */
|
|
|
|
#define MTD_ERASE(d,s,n) ((d)->erase ? (d)->erase(d,s,n) : (-ENOSYS))
|
|
#define MTD_BREAD(d,s,n,b) ((d)->bread ? (d)->bread(d,s,n,b) : (-ENOSYS))
|
|
#define MTD_BWRITE(d,s,n,b)((d)->bwrite ? (d)->bwrite(d,s,n,b) : (-ENOSYS))
|
|
#define MTD_READ(d,s,n,b) ((d)->read ? (d)->read(d,s,n,b) : (-ENOSYS))
|
|
#define MTD_WRITE(d,s,n,b) ((d)->write ? (d)->write(d,s,n,b) : (-ENOSYS))
|
|
#define MTD_IOCTL(d,c,a) ((d)->ioctl ? (d)->ioctl(d,c,a) : (-ENOSYS))
|
|
#define MTD_ISBAD(d,b) ((d)->isbad ? (d)->isbad(d,b) : (-ENOSYS))
|
|
#define MTD_MARKBAD(d,b) ((d)->markbad ? (d)->markbad(d,b) : (-ENOSYS))
|
|
|
|
/* If any of the low-level device drivers declare they want sub-sector erase
|
|
* support, then define MTD_SUBSECTOR_ERASE.
|
|
*/
|
|
|
|
#if defined(CONFIG_M25P_SUBSECTOR_ERASE)
|
|
# define CONFIG_MTD_SUBSECTOR_ERASE 1
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
struct qspi_dev_s; /* Forward reference */
|
|
|
|
/* The following defines the geometry for the device. It treats the device
|
|
* as though it were just an array of fixed size blocks. That is most likely
|
|
* not true, but the client will expect the device logic to do whatever is
|
|
* necessary to make it appear so.
|
|
*/
|
|
|
|
struct mtd_geometry_s
|
|
{
|
|
uint32_t blocksize; /* Size of one read/write block. */
|
|
uint32_t erasesize; /* Size of one erase blocks -- must be a multiple
|
|
* of blocksize. */
|
|
uint32_t neraseblocks; /* Number of erase blocks */
|
|
|
|
/* NULL-terminated string representing the device model */
|
|
|
|
char model[NAME_MAX + 1];
|
|
};
|
|
|
|
/* This structure describes a range of sectors to be protected or
|
|
* unprotected.
|
|
*/
|
|
|
|
struct mtd_protect_s
|
|
{
|
|
off_t startblock; /* First block to be [un-]protected */
|
|
size_t nblocks; /* Number of blocks to [un-]protect */
|
|
};
|
|
|
|
/* The following defines the information for writing bytes to a sector
|
|
* that are not a full page write (bytewrite).
|
|
*/
|
|
|
|
struct mtd_byte_write_s
|
|
{
|
|
uint32_t offset; /* Offset within the device to write to */
|
|
uint16_t count; /* Number of bytes to write */
|
|
const uint8_t *buffer; /* Pointer to the data to write */
|
|
};
|
|
|
|
/* This structure describes a range of erase sectors to be erased. */
|
|
|
|
struct mtd_erase_s
|
|
{
|
|
uint32_t startblock; /* First block to be erased */
|
|
uint32_t nblocks; /* Number of blocks to be erased */
|
|
};
|
|
|
|
/* This structure defines the interface to a simple memory technology device.
|
|
* It will likely need to be extended in the future to support more complex
|
|
* devices.
|
|
*/
|
|
|
|
struct mtd_dev_s
|
|
{
|
|
/* The following methods operate on the MTD: */
|
|
|
|
/* Erase the specified erase blocks (units are erase blocks). Semantic
|
|
* Clarification: Here, we are not referring to the erase block according
|
|
* to the FLASH data sheet. Rather, we are referring to the *smallest*
|
|
* erasable part of the FLASH which may have a name like a page or sector
|
|
* or subsector.
|
|
*/
|
|
|
|
int (*erase)(FAR struct mtd_dev_s *dev, off_t startblock, size_t nblocks);
|
|
|
|
/* Read/write from the specified read/write blocks */
|
|
|
|
ssize_t (*bread)(FAR struct mtd_dev_s *dev, off_t startblock,
|
|
size_t nblocks, FAR uint8_t *buffer);
|
|
ssize_t (*bwrite)(FAR struct mtd_dev_s *dev, off_t startblock,
|
|
size_t nblocks, FAR const uint8_t *buffer);
|
|
|
|
/* Some devices may support byte oriented reads (optional). Most MTD
|
|
* devices are inherently block oriented so byte-oriented writing is not
|
|
* supported. It is recommended that low-level drivers not support read()
|
|
* if it requires buffering.
|
|
*/
|
|
|
|
ssize_t (*read)(FAR struct mtd_dev_s *dev, off_t offset, size_t nbytes,
|
|
FAR uint8_t *buffer);
|
|
#ifdef CONFIG_MTD_BYTE_WRITE
|
|
ssize_t (*write)(FAR struct mtd_dev_s *dev, off_t offset, size_t nbytes,
|
|
FAR const uint8_t *buffer);
|
|
#endif
|
|
|
|
/* Support other, less frequently used commands:
|
|
* - MTDIOC_GEOMETRY: Get MTD geometry
|
|
* - MTDIOC_XIPBASE: Convert block to physical address for
|
|
* eXecute-In-Place
|
|
* - MTDIOC_BULKERASE: Erase the entire device
|
|
* (see include/nuttx/fs/ioctl.h)
|
|
*/
|
|
|
|
int (*ioctl)(FAR struct mtd_dev_s *dev, int cmd, unsigned long arg);
|
|
|
|
/* Check/Mark bad block for the specified block number */
|
|
|
|
int (*isbad)(FAR struct mtd_dev_s *dev, off_t block);
|
|
int (*markbad)(FAR struct mtd_dev_s *dev, off_t block);
|
|
|
|
/* Name of this MTD device */
|
|
|
|
FAR const char *name;
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifndef __ASSEMBLY__
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/* MTD Support **************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: mtd_partition
|
|
*
|
|
* Description:
|
|
* Given an instance of an MTD driver, create a flash partition, ie.,
|
|
* another MTD driver instance that only operates with a sub-region of
|
|
* FLASH media. That sub-region is defined by a sector offset and a
|
|
* sector count (where the size of a sector is provided by the parent MTD
|
|
* driver).
|
|
*
|
|
* NOTE: Since there may be a number of MTD partition drivers operating on
|
|
* the same, underlying FLASH driver, that FLASH driver must be capable
|
|
* of enforcing mutually exclusive access to the FLASH device. Without
|
|
* partitions, that mutual exclusion would be provided by the file system
|
|
* above the FLASH driver.
|
|
*
|
|
* Input Parameters:
|
|
* mtd - The MTD device to be partitioned
|
|
* firstblock - The offset in bytes to the first block
|
|
* nblocks - The number of blocks in the partition
|
|
*
|
|
* Returned Value:
|
|
* On success, another MTD device representing the partition is returned.
|
|
* A NULL value is returned on a failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *mtd_partition(FAR struct mtd_dev_s *mtd,
|
|
off_t firstblock, off_t nblocks);
|
|
|
|
/****************************************************************************
|
|
* Name: mtd_setpartitionname
|
|
*
|
|
* Description:
|
|
* Sets the name of the specified partition.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_MTD_PARTITION_NAMES
|
|
int mtd_setpartitionname(FAR struct mtd_dev_s *mtd, FAR const char *name);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: mtd_rwb_initialize
|
|
*
|
|
* Description:
|
|
* Create an initialized MTD device instance. This MTD driver contains
|
|
* another MTD driver and converts a larger sector size to a standard 512
|
|
* byte sector size.
|
|
*
|
|
* MTD devices are not registered in the file system, but are created as
|
|
* instances that can be bound to other functions (such as a block or
|
|
* character driver front end).
|
|
*
|
|
****************************************************************************/
|
|
|
|
#if defined(CONFIG_MTD_WRBUFFER) || defined(CONFIG_MTD_READAHEAD)
|
|
FAR struct mtd_dev_s *mtd_rwb_initialize(FAR struct mtd_dev_s *mtd);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: ftl_initialize_by_path
|
|
*
|
|
* Description:
|
|
* Initialize to provide a block driver wrapper around an MTD interface
|
|
*
|
|
* Input Parameters:
|
|
* path - The block device path.
|
|
* mtd - The MTD device that supports the FLASH interface.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int ftl_initialize_by_path(FAR const char *path, FAR struct mtd_dev_s *mtd);
|
|
|
|
/****************************************************************************
|
|
* Name: ftl_initialize
|
|
*
|
|
* Description:
|
|
* Initialize to provide a block driver wrapper around an MTD interface
|
|
*
|
|
* Input Parameters:
|
|
* minor - The minor device number. The MTD block device will be
|
|
* registered as as /dev/mtdblockN where N is the minor number.
|
|
* mtd - The MTD device that supports the FLASH interface.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int ftl_initialize(int minor, FAR struct mtd_dev_s *mtd);
|
|
|
|
/****************************************************************************
|
|
* Name: smart_initialize
|
|
*
|
|
* Description:
|
|
* Initialize to provide a Sector Mapped Allocation for Really Tiny (SMART)
|
|
* Flash block driver wrapper around an MTD interface
|
|
*
|
|
* Input Parameters:
|
|
* minor - The minor device number. The MTD block device will be
|
|
* registered as as /dev/mtdsmartN where N is the minor number.
|
|
* mtd - The MTD device that supports the FLASH interface.
|
|
* partname - Optional partition name to append to dev entry, NULL if
|
|
* not supplied.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int smart_initialize(int minor, FAR struct mtd_dev_s *mtd,
|
|
FAR const char *partname);
|
|
|
|
/* MTD Driver Initialization ************************************************/
|
|
|
|
/* Create an initialized MTD device instance for a particular memory device.
|
|
* MTD devices are not registered in the file system as are other device
|
|
* driver but, but are created as instances that can be bound to other
|
|
* functions (such as a block or character driver front end).
|
|
*/
|
|
|
|
/****************************************************************************
|
|
* Name: s512_initialize
|
|
*
|
|
* Description:
|
|
* Create an initialized MTD device instance. This MTD driver contains
|
|
* another MTD driver and converts a larger sector size to a standard 512
|
|
* byte sector size.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_MTD_SECT512
|
|
FAR struct mtd_dev_s *s512_initialize(FAR struct mtd_dev_s *mtd);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: progmem_initialize
|
|
*
|
|
* Description:
|
|
* Create and initialize an MTD device instance that can be used to access
|
|
* on-chip program memory.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *progmem_initialize(void);
|
|
|
|
/****************************************************************************
|
|
* Name: at45db_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based AT45DB161D (16Mbit).
|
|
*
|
|
****************************************************************************/
|
|
|
|
struct spi_dev_s; /* Forward reference */
|
|
FAR struct mtd_dev_s *at45db_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: at24c_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for I2C-based at24cxx EEPROM(AT24C32, AT24C64,
|
|
* AT24C128, AT24C256)
|
|
*
|
|
****************************************************************************/
|
|
|
|
struct i2c_master_s; /* Forward reference */
|
|
|
|
#ifdef CONFIG_AT24XX_MULTI
|
|
FAR struct mtd_dev_s *at24c_initialize(FAR struct i2c_master_s *dev,
|
|
uint8_t address);
|
|
#else
|
|
FAR struct mtd_dev_s *at24c_initialize(FAR struct i2c_master_s *dev);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: at24c_uninitialize
|
|
*
|
|
* Description:
|
|
* Release resources held by an allocated MTD device instance. Resources
|
|
* are only allocated for the case where multiple AT24xx devices are
|
|
* supported.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_AT24XX_MULTI
|
|
void at24c_uninitialize(FAR struct mtd_dev_s *mtd);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: at25_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based AT25DF321 (32Mbit) flash.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *at25_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: is25xp
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based IS25xP FLASH
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *is25xp_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: m25p_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the for SPI-based M25P1 (128Kbit), M25P64 (32Mbit), M25P64
|
|
* (64Mbit), and M25P128 (128Mbit) FLASH (and compatible).
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *m25p_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: mx35_initialize
|
|
*
|
|
* Description:
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *mx35_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: rammtd_initialize
|
|
*
|
|
* Description:
|
|
* Create and initialize a RAM MTD device instance.
|
|
*
|
|
* Input Parameters:
|
|
* start - Address of the beginning of the allocated RAM regions.
|
|
* size - The size in bytes of the allocated RAM region.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *rammtd_initialize(FAR uint8_t *start, size_t size);
|
|
|
|
/****************************************************************************
|
|
* Name: ramtron_initialize
|
|
*
|
|
* Description:
|
|
* Create and initialize a Ramtron MTD device instance.
|
|
*
|
|
* Input Parameters:
|
|
* start - Address of the beginning of the allocated RAM regions.
|
|
* size - The size in bytes of the allocated RAM region.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *ramtron_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: sst25_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based SST25 FLASH
|
|
*
|
|
* Supports SST25VF512, SST25VF010, SST25VF520, SST25VF540, SST25VF080,
|
|
* and SST25VF016
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *sst25_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: sst25xx_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based SST25XX FLASH
|
|
*
|
|
* Supports SST25VF064
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *sst25xx_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: sst26_initialize_spi
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based SST26 FLASH
|
|
*
|
|
* Supports SST26VF016 SST26VF032 SST26VF064
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *sst26_initialize_spi(FAR struct spi_dev_s *dev,
|
|
uint16_t spi_devid);
|
|
|
|
/****************************************************************************
|
|
* Name: sst39vf_initialize
|
|
*
|
|
* Description:
|
|
* Create and initialize an MTD device instance assuming an SST39VF NOR
|
|
* FLASH device at the configured address in memory.
|
|
*
|
|
* Supports SST39VF1601, SST39VF1602, SST39VF3201, SST39VF3202.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *sst39vf_initialize(void);
|
|
|
|
/****************************************************************************
|
|
* Name: w25_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based W25x16, x32, and x64 and W25q16,
|
|
* q32, q64, and q128 FLASH
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *w25_initialize(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: gd25_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based GD25 FLASH
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *gd25_initialize(FAR struct spi_dev_s *dev,
|
|
uint32_t spi_devid);
|
|
|
|
/****************************************************************************
|
|
* Name: gd5f_initialize
|
|
*
|
|
* Description:
|
|
* Initializes the driver for SPI-based GD5F FLASH
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *gd5f_initialize(FAR struct spi_dev_s *dev,
|
|
uint32_t spi_devid);
|
|
|
|
/****************************************************************************
|
|
* Name: s25fl1_initialize
|
|
*
|
|
* Description:
|
|
* Create an initialized MTD device instance for the QuadSPI-based ST24FL1
|
|
* FLASH part.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *s25fl1_initialize(FAR struct qspi_dev_s *qspi,
|
|
bool unprotect);
|
|
|
|
/****************************************************************************
|
|
* Name: mx25l_initialize_spi
|
|
*
|
|
* Description:
|
|
* Create an initialized MTD device instance for the SPI-based MX25Lx
|
|
* FLASH part.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *mx25l_initialize_spi(FAR struct spi_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: mx25rxx_initialize_spi
|
|
*
|
|
* Description:
|
|
* Create an initialized MTD device instance for the SPI-based MX25Rx
|
|
* FLASH part.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *mx25rxx_initialize(FAR struct qspi_dev_s *qspi,
|
|
bool unprotect);
|
|
|
|
/****************************************************************************
|
|
* Name: n25qxxx_initialize
|
|
*
|
|
* Description:
|
|
* Create an initialized MTD device instance for the QuadSPI-based N25Qxxx
|
|
* FLASH part from Micron.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *n25qxxx_initialize(FAR struct qspi_dev_s *qspi,
|
|
bool unprotect);
|
|
|
|
/****************************************************************************
|
|
* Name: w25qxxxjv_initialize
|
|
*
|
|
* Description:
|
|
* Create an initialized MTD device instance for the QuadSPI-based
|
|
* W25QxxxJV FLASH part from Winbond.
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *w25qxxxjv_initialize(FAR struct qspi_dev_s *qspi,
|
|
bool unprotect);
|
|
|
|
/****************************************************************************
|
|
* Name: filemtd_initialize
|
|
*
|
|
* Description:
|
|
* Create and initialize a FILE MTD device instance.
|
|
*
|
|
* Input Parameters:
|
|
* path - Path name of the file backing the MTD device
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *filemtd_initialize(FAR const char *path, size_t offset,
|
|
int16_t sectsize,
|
|
int32_t erasesize);
|
|
|
|
/****************************************************************************
|
|
* Name: filemtd_teardown
|
|
*
|
|
* Description:
|
|
* Teardown a previously created filemtd device.
|
|
*
|
|
* Input Parameters:
|
|
* dev - Pointer to the mtd driver instance.
|
|
*
|
|
****************************************************************************/
|
|
|
|
void filemtd_teardown(FAR struct mtd_dev_s *dev);
|
|
|
|
/****************************************************************************
|
|
* Name: filemtd_isfilemtd
|
|
*
|
|
* Description:
|
|
* Tests if the provided mtd is a filemtd or blockmtd device.
|
|
*
|
|
* Input Parameters:
|
|
* mtd - Pointer to the mtd.
|
|
*
|
|
****************************************************************************/
|
|
|
|
bool filemtd_isfilemtd(FAR struct mtd_dev_s *mtd);
|
|
|
|
/****************************************************************************
|
|
* Name: nullmtd_initialize
|
|
*
|
|
* Description:
|
|
* Create and initialize a MTD null device instance.
|
|
*
|
|
* Input Parameters:
|
|
* mtdlen - Total length of a size in bytes of the MTD null device
|
|
* sectsize - Sector size of the MTD null device
|
|
* erasesize - Erase block size of the MTD null device
|
|
*
|
|
****************************************************************************/
|
|
|
|
FAR struct mtd_dev_s *nullmtd_initialize(size_t mtdlen, int16_t sectsize,
|
|
int32_t erasesize);
|
|
|
|
/****************************************************************************
|
|
* Name: rpmsgmtd_register
|
|
*
|
|
* Description:
|
|
* Rpmsg-mtd client register function, the client cpu should call
|
|
* this function in the board initialize process.
|
|
*
|
|
* Parameters:
|
|
* remotecpu - the server cpu name
|
|
* remotepath - the device you want to access in the remote cpu
|
|
* localpath - the device path in local cpu, if NULL, the localpath is
|
|
* same as the remotepath, provide this argument to supoort
|
|
* custom device path
|
|
*
|
|
* Returned Values:
|
|
* OK on success; A negated errno value is returned on any failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_RPMSGMTD
|
|
int rpmsgmtd_register(FAR const char *remotecpu, FAR const char *remotepath,
|
|
FAR const char *localpath);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: rpmsgmtd_server_init
|
|
*
|
|
* Description:
|
|
* Rpmsg-mtd server initialize function, the server cpu should call
|
|
* this function.
|
|
*
|
|
* Parameters:
|
|
* None
|
|
*
|
|
* Returned Values:
|
|
* OK on success; A negated errno value is returned on any failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_RPMSGMTD_SERVER
|
|
int rpmsgmtd_server_init(void);
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
#endif /* __INCLUDE_NUTTX_MTD_MTD_H */
|