dev/flash/jffs2_flashdev.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  * Copyright (C) 2024 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 JFFS2_FLASHDEV_H
0029 #define JFFS2_FLASHDEV_H
0030
0031 #include <dev/flash/flashdev.h>
0032 #include <rtems/jffs2.h>
0033 #include <rtems/rtems/status.h>
0034
0035 /**
0036  * This function mounts a JFFS2 partition over the specified region on a
0037  * flashdev-controlled device file.
0038  *
0039  * @param  flashdev_path is a device file created by the flashdev backend
0040  * @param  mount_dir is the location at which to mount the JFFS2 filesystem
0041  * @param  region is a description of the segment of the device file to mount
0042  * @param  compressor_control is the JFFS2 compression control
0043  * @param  read_only is a flag indicating whether the mounted JFFS2 filesystem
0044  *         can be written
0045  *
0046  * @return RTEMS_SUCCESSFUL on success.
0047  */
0048 rtems_status_code jffs2_flashdev_mount(
0049   const char *flashdev_path,
0050   const char *mount_dir,
0051   rtems_flashdev_region *region,
0052   rtems_jffs2_compressor_control *compressor_control,
0053   bool read_only
0054 );
0055
0056 #endif /* JFFS2_FLASHDEV_H */