lib/libnandfs/libnandfs.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2010-2012 Semihalf.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _LIBNANDFS_NANDFS_H
  32 #define _LIBNANDFS_NANDFS_H
  33
  34 struct nandfs {
  35         struct nandfs_fsdata            n_fsdata;
  36         struct nandfs_super_block       n_sb;
  37         char                            n_ioc[MNAMELEN];
  38         char                            n_dev[MNAMELEN];
  39         int                             n_iocfd;
  40         int                             n_devfd;
  41         int                             n_flags;
  42         char                            n_errmsg[120];
  43 };
  44
  45 int nandfs_iserror(struct nandfs *);
  46 const char *nandfs_errmsg(struct nandfs *);
  47
  48 void nandfs_init(struct nandfs *, const char *);
  49 void nandfs_destroy(struct nandfs *);
  50
  51 const char *nandfs_dev(struct nandfs *);
  52
  53 int nandfs_open(struct nandfs *);
  54 void nandfs_close(struct nandfs *);
  55
  56 int nandfs_get_cpstat(struct nandfs *, struct nandfs_cpstat *);
  57
  58 ssize_t nandfs_get_cp(struct nandfs *, uint64_t,
  59     struct nandfs_cpinfo *, size_t);
  60
  61 ssize_t nandfs_get_snap(struct nandfs *, uint64_t,
  62     struct nandfs_cpinfo *, size_t);
  63
  64 int nandfs_make_snap(struct nandfs *, uint64_t *);
  65 int nandfs_delete_snap(struct nandfs *, uint64_t);
  66
  67 #endif  /* _LIBNANDFS_NANDFS_H */