include/bsp/jffs2_xnandpsu.h

0001 /*
0002  * SPDX-License-Identifier: BSD-2-Clause
0003  *
0004  * Copyright (C) 2023 On-Line Applications Research Corporation (OAR)
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027
0028 #ifndef LIBBSP_XILINX_ZYNQMP_JFFS2_XNANDPSU_H
0029 #define LIBBSP_XILINX_ZYNQMP_JFFS2_XNANDPSU_H
0030
0031 #ifdef __cplusplus
0032 extern "C"
0033 {
0034 #endif /* __cplusplus */
0035
0036 #include <dev/nand/xnandpsu.h>
0037 #include <rtems/jffs2.h>
0038
0039 /**
0040  * @brief Mount JFFS2 filesystem on NAND device.
0041  *
0042  * @param[in] mount_dir The directory to mount the filesystem at.
0043  * @param[in] NandPsuInstancePtr A pointer to an initialized NAND instance.
0044  *
0045  * @retval 0 Successful operation. Negative number otherwise.
0046  */
0047 int xilinx_zynqmp_nand_jffs2_initialize(
0048   const char *mount_dir,
0049   XNandPsu *NandPsuInstancePtr
0050 );
0051
0052 #ifdef __cplusplus
0053 }
0054 #endif  /* __cplusplus */
0055
0056 #endif  /* LIBBSP_XILINX_ZYNQMP_JFFS2_XNANDPSU_H */