fs_vmu.h

Go to the documentation of this file.

/* KallistiOS ##version##
 
   dc/fs_vmu.h
   (c)2000-2001 Jordan DeLong
 
*/
 
/** \file    dc/fs_vmu.h
    \brief   VMU filesystem driver.
    \ingroup vfs_vmu
 
    The VMU filesystem driver mounts itself on /vmu of the VFS. Each memory card
    has its own subdirectory off of that directory (i.e, /vmu/a1 for slot 1 of
    the first controller). VMUs themselves have no subdirectories, so the driver
    itself is fairly simple.
 
    Files on a VMU must be multiples of 512 bytes in size, and should have a
    header attached so that they show up in the BIOS menu.
 
    This layer is built off of the vmufs layer, which does all the low-level
    operations. It is generally easier to work with things at this level though,
    so that you can use the normal libc file access functions.
 
    \author Megan Potter
 
    \see    dc/vmu_pkg.h
    \see    dc/vmufs.h
*/
 
#ifndef __DC_FS_VMU_H
#define __DC_FS_VMU_H
 
#include <sys/cdefs.h>
__BEGIN_DECLS
 
#include <kos/fs.h>
#include <dc/vmu_pkg.h>
 
/** \defgroup vfs_vmu   VMU
    \brief              VFS driver for accessing Visual Memory Unit storage
    \ingroup            vfs
 
    @{
*/
 
/* \cond */
/* Initialization */
int fs_vmu_init(void);
int fs_vmu_shutdown(void);
 
#define IOCTL_VMU_SET_HDR     0x564d5530 /* "VMU0" */
/* \endcond */
 
/** \brief  Set a header to an opened VMU file
 
    This function can be used to set a specific header (which contains the
    metadata, icons...) to an opened VMU file, replacing the one it previously
    had (if any).
 
    Note that the "pkg" pointer as well as the eyecatch/icon data pointers it
    contain can be freed (if dynamically allocated) as soon as this function
    return, as the filesystem code will keep an internal copy.
 
    It is valid to pass NULL as the header pointer, in which case the header
    for the file will be discarded.
 
    \param fd               A file descriptor corresponding to the VMU file
    \param pkg              The header to set to the VMU file
    \retval 0               On success.
    \retval -1              On error.
*/
static inline int fs_vmu_set_header(file_t fd, const vmu_pkg_t *pkg) {
    return fs_ioctl(fd, IOCTL_VMU_SET_HDR, pkg);
}
 
/** \brief  Set a default header for newly created VMU files
 
    This function will set a default header, that will be used for new files
    which were not assignated their own header.
 
    Note that files which already have a header, either because they were opened
    read-write or because they were given one, will use their own header instead
    of the default one.
 
    Note that the "pkg" pointer as well as the eyecatch/icon data pointers it
    contain can be freed (if dynamically allocated) as soon as this function
    return, as the filesystem code will keep an internal copy.
 
    It is valid to pass NULL as the header pointer, in which case the default
    header will be discarded.
 
    \param pkg              The header to set to the VMU file
    \retval 0               On success.
    \retval -1              On error.
*/
static inline int fs_vmu_set_default_header(const vmu_pkg_t *pkg) {
    file_t fd;
    int ret;
 
    fd = fs_open("/vmu", O_RDONLY | O_DIR);
    if(!fd)
        return -1;
 
    ret = fs_vmu_set_header(fd, pkg);
    fs_close(fd);
 
    return ret;
}
 
/** @} */
 
__END_DECLS
 
#endif  /* __DC_FS_VMU_H */