123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186 |
- /****************************************************************************
- * fs/driver/driver.h
- *
- * Copyright (C) 2007, 2009, 2012, 2014, 2018 Gregory Nutt. All rights
- * reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. Neither the name NuttX nor the names of its contributors may be
- * used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ****************************************************************************/
- #ifndef __FS_DRIVER_DRIVER_H
- #define __FS_DRIVER_DRIVER_H
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <nuttx/compiler.h>
- #include <nuttx/fs/fs.h>
- #include "inode/inode.h"
- /****************************************************************************
- * Public Data
- ****************************************************************************/
- #undef EXTERN
- #if defined(__cplusplus)
- #define EXTERN extern "C"
- extern "C"
- {
- #else
- #define EXTERN extern
- #endif
- /****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
- /****************************************************************************
- * Name: find_blockdriver
- *
- * Description:
- * Return the inode of the block driver specified by 'pathname'
- *
- * Input Parameters:
- * pathname - The full path to the block driver to be located
- * mountflags - If MS_RDONLY is not set, then driver must support write
- * operations (see include/sys/mount.h)
- * ppinode - Address of the location to return the inode reference
- *
- * Returned Value:
- * Returns zero on success or a negated errno on failure:
- *
- * ENOENT - No block driver of this name is registered
- * ENOTBLK - The inode associated with the pathname is not a block driver
- * EACCESS - The MS_RDONLY option was not set but this driver does not
- * support write access
- *
- ****************************************************************************/
- #ifndef CONFIG_DISABLE_MOUNTPOINT
- int find_blockdriver(FAR const char *pathname, int mountflags,
- FAR struct inode **ppinode);
- #endif
- /****************************************************************************
- * Name: block_proxy
- *
- * Description:
- * Create a temporary char driver using drivers/bch to mediate character
- * oriented accessed to the block driver.
- *
- * Input Parameters:
- * blkdev - The path to the block driver
- * oflags - Character driver open flags
- *
- * Returned Value:
- * If positive, non-zero file descriptor is returned on success. This
- * is the file descriptor of the nameless character driver that mediates
- * accesses to the block driver.
- *
- * Errors that may be returned:
- *
- * ENOMEM - Failed to create a temporary path name.
- *
- * Plus:
- *
- * - Errors reported from bchdev_register()
- * - Errors reported from open() or unlink()
- *
- ****************************************************************************/
- #if !defined(CONFIG_DISABLE_MOUNTPOINT)
- int block_proxy(FAR const char *blkdev, int oflags);
- #endif
- /****************************************************************************
- * Name: mtd_proxy
- *
- * Description:
- * Create a temporary block driver using drivers/mtd/ftl to mediate block
- * oriented accessed to the mtd driver.
- *
- * Input Parameters:
- * mtddev - The path to the mtd driver
- * mountflags - if MS_RDONLY is not set, then driver must support write
- * operations (see include/sys/mount.h)
- * ppinode - address of the location to return the inode reference
- *
- * Returned Value:
- * If zero, non-zero inode pointer is returned on success. This
- * is the inode pointer of the nameless block driver that mediates
- * accesses to the mtd driver.
- *
- * Errors that may be returned:
- *
- * ENOMEM - Failed to create a temporary path name.
- *
- * Plus:
- *
- * - Errors reported from ftl_initialize()
- * - Errors reported from open() or unlink()
- *
- ****************************************************************************/
- #ifdef CONFIG_MTD
- int mtd_proxy(FAR const char *mtddev, int mountflags,
- FAR struct inode **ppinode);
- #endif
- /****************************************************************************
- * Name: find_mtddriver
- *
- * Description:
- * Return the inode of the named MTD driver specified by 'pathname'
- *
- * Input Parameters:
- * pathname - the full path to the named MTD driver to be located
- * ppinode - address of the location to return the inode reference
- *
- * Returned Value:
- * Returns zero on success or a negated errno on failure:
- *
- * ENOENT - No MTD driver of this name is registered
- * ENOTBLK - The inode associated with the pathname is not an MTD driver
- *
- ****************************************************************************/
- #if defined(CONFIG_MTD) && !defined(CONFIG_DISABLE_MOUNTPOINT)
- int find_mtddriver(FAR const char *pathname, FAR struct inode **ppinode);
- #endif
- #undef EXTERN
- #if defined(__cplusplus)
- }
- #endif
- #endif /* __FS_DRIVER_DRIVER_H */
|