168 lines
5.4 KiB
C
168 lines
5.4 KiB
C
/****************************************************************************
|
|
* include/nuttx/fs/smart.h
|
|
*
|
|
* 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_FS_SMART_H
|
|
#define __INCLUDE_NUTTX_FS_SMART_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <sys/types.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Macros to hide implementation */
|
|
|
|
#define SMART_FMT_ISFORMATTED 0x01
|
|
#define SMART_FMT_HASBYTEWRITE 0x02
|
|
|
|
/* The logical sector number of the root directory. */
|
|
|
|
#define SMARTFS_ROOT_DIR_SECTOR 3
|
|
|
|
/* Defines the sector types */
|
|
|
|
#define SMARTFS_SECTOR_TYPE_DIR 1
|
|
#define SMARTFS_SECTOR_TYPE_FILE 2
|
|
|
|
#ifdef CONFIG_SMART_DEV_LOOP
|
|
/* Loop device IOCTL commands */
|
|
|
|
/* Command: SMART_LOOPIOC_SETUP
|
|
* Description: Setup the loop device
|
|
* Argument: A pointer to a read-only instance of struct losetup_s.
|
|
* Dependencies: The loop device must be enabled (CONFIG_DEV_LOOP=y)
|
|
*/
|
|
|
|
/* Command: SMART_LOOPIOC_TEARDOWN
|
|
* Description: Teardown a loop device previously setup vis LOOPIOC_SETUP
|
|
* Argument: A read-able pointer to the path of the device to be
|
|
* torn down
|
|
* Dependencies: The loop device must be enabled (CONFIG_DEV_LOOP=y)
|
|
*/
|
|
|
|
#define SMART_LOOPIOC_SETUP _LOOPIOC(0x0001)
|
|
#define SMART_LOOPIOC_TEARDOWN _LOOPIOC(0x0002)
|
|
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/* The following defines the format information for the device. This
|
|
* information is retrieved via the BIOC_GETFORMAT ioctl.
|
|
*/
|
|
|
|
struct smart_format_s
|
|
{
|
|
uint16_t sectorsize; /* Size of one read/write sector */
|
|
uint16_t availbytes; /* Number of bytes available in each sector */
|
|
uint16_t nsectors; /* Total number of sectors on device */
|
|
uint16_t nfreesectors; /* Number of free sectors on device */
|
|
uint8_t flags; /* Format flags (see above) */
|
|
uint8_t namesize; /* Size of filenames on this volume */
|
|
#ifdef CONFIG_SMARTFS_MULTI_ROOT_DIRS
|
|
uint8_t nrootdirentries; /* Number of root directories on this device */
|
|
uint8_t rootdirnum; /* Root directory number for this dev entry */
|
|
#endif
|
|
};
|
|
|
|
/* The following defines the information for writing a logical sector
|
|
* to the device.
|
|
*/
|
|
|
|
struct smart_read_write_s
|
|
{
|
|
uint16_t logsector; /* The logical sector number */
|
|
uint16_t offset; /* Offset within the sector to write to */
|
|
uint16_t count; /* Number of bytes to write */
|
|
const uint8_t *buffer; /* Pointer to the data to write */
|
|
};
|
|
|
|
/* The following defines the procfs data exchange interface between the
|
|
* SMART MTD and FS layers.
|
|
*/
|
|
|
|
#if defined(CONFIG_FS_PROCFS) && !defined(CONFIG_FS_PROCFS_EXCLUDE_SMARTFS)
|
|
struct smart_procfs_data_s
|
|
{
|
|
#ifdef CONFIG_MTD_SMART_ERASE_DEBUG
|
|
const uint16_t *erasecounts; /* Pointer to the erase counts array */
|
|
uint16_t erasesize; /* Number of entries in the erase counts array */
|
|
#else
|
|
uint8_t __pad;
|
|
#endif
|
|
};
|
|
#endif
|
|
|
|
#ifdef CONFIG_SMART_DEV_LOOP
|
|
/* This is the structure referred to in the argument to the LOOPIOC_SETUP
|
|
* IOCTL command.
|
|
*/
|
|
|
|
struct smart_losetup_s
|
|
{
|
|
FAR const char *filename; /* The file or character device to use */
|
|
int minor; /* The minor number of thedevice */
|
|
int erasesize; /* The erase size to use on the file */
|
|
int sectsize; /* The sector / page size of the file */
|
|
off_t offset; /* An offset that may be applied to the device */
|
|
bool readonly; /* True: Read access will be supported only */
|
|
};
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifndef __ASSEMBLY__
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_SMART_DEV_LOOP
|
|
int smart_loop_register_driver(void);
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
#endif /* __INCLUDE_NUTTX_FS_SMART_H */
|