source: rtems/bsps/aarch64/xilinx-zynqmp/include/bsp/jffs2_xqspipsu.h @ ddafdfe

/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSBSPsAArch64XilinxZynqMP
 *
 * @brief XilinxZynqMP QSPI JFFS2 flash driver definitions
 */

/*
 * Copyright (C) 2022 On-Line Applications Research Corporation (OAR)
 *
 * 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.
 *
 * 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 LIBBSP_XILINX_ZYNQMP_JFFS2_XQSPIPSU_H
#define LIBBSP_XILINX_ZYNQMP_JFFS2_XQSPIPSU_H

#include <dev/spi/xqspipsu.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**
 * @brief Mount jffs2 filesystem.
 *
 * @param[in] mount_dir The directory to mount the filesystem at.
 * @param[in] qspipsu_ptr A pointer to an initialized QSPI instance.
 *
 * @retval 0 Successful operation. Negative number otherwise.
 */
int xilinx_zynqmp_nor_jffs2_initialize(
  const char *mount_dir,
  XQspiPsu *qspipsu_ptr
);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* LIBBSP_XILINX_ZYNQMP_JFFS2_XQSPIPSU_H */