/*
    ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,2011,2012,2013,2014,
              2015,2016,2017,2018,2019,2020,2021 Giovanni Di Sirio.

    This file is part of ChibiOS.

    ChibiOS is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation version 3 of the License.

    ChibiOS is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    vfs/include/vfsbuffers.h
 * @brief   VFS header file.
 * @details VFS shared path buffers header file.
 *
 * @addtogroup VFS_BUFFERS
 * @{
 */

#ifndef VFS_BUFFERS_H
#define VFS_BUFFERS_H

/*===========================================================================*/
/* Module constants.                                                         */
/*===========================================================================*/

/**
 * @brief   Size of the shared buffers.
 */
#define VFS_BUFFER_SIZE         ((VFS_CFG_PATHLEN_MAX + 1) * 2)

/*===========================================================================*/
/* Module pre-compile time settings.                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Module data structures and types.                                         */
/*===========================================================================*/

/**
 * @brief   Type of a shared buffer structure.
 */
typedef union vfs_shared_buffer {
  struct {
    char                buf1[VFS_CFG_PATHLEN_MAX + 1];
    char                buf2[VFS_CFG_PATHLEN_MAX + 1];
  } path;
  char                  bigbuf[VFS_BUFFER_SIZE];
} vfs_shared_buffer_t;

/*===========================================================================*/
/* Module macros.                                                            */
/*===========================================================================*/

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif
  void __vfs_buffers_init(void);
  vfs_shared_buffer_t *vfs_buffer_take(void);
  void vfs_buffer_release(vfs_shared_buffer_t *shbuf);
#ifdef __cplusplus
}
#endif

/*===========================================================================*/
/* Module inline functions.                                                  */
/*===========================================================================*/

#endif /* VFS_BUFFERS_H */

/** @} */