fs.h

Go to the documentation of this file.

#pragma once
#include <string.h>
#include <3ds/types.h>

#define FS_OPEN_READ   (1<<0)

#define FS_OPEN_WRITE  (1<<1)

#define FS_OPEN_CREATE (1<<2)
/* @} */

#define FS_ATTRIBUTE_NONE      (0x00000000)

#define FS_ATTRIBUTE_READONLY  (0x00000001)

#define FS_ATTRIBUTE_ARCHIVE   (0x00000100)

#define FS_ATTRIBUTE_HIDDEN    (0x00010000)

#define FS_ATTRIBUTE_DIRECTORY (0x01000000)

#define FS_WRITE_NOFLUSH (0x00000000)

#define FS_WRITE_FLUSH   (0x00010001)

/* @} */

typedef enum
{
    PATH_INVALID = 0, 
    PATH_EMPTY   = 1, 
    PATH_BINARY  = 2, 
    PATH_CHAR    = 3, 
    PATH_WCHAR   = 4, 
} FS_pathType;

typedef enum
{
    ARCH_ROMFS = 0x3,
    ARCH_SAVEDATA = 0x4,
    ARCH_EXTDATA = 0x6,
    ARCH_SHARED_EXTDATA = 0x7,
    ARCH_SYSTEM_SAVEDATA = 0x8,
    ARCH_SDMC = 0x9,
    ARCH_SDMC_WRITE_ONLY = 0xA,
    ARCH_BOSS_EXTDATA = 0x12345678,
    ARCH_CARD_SPIFS = 0x12345679,
    ARCH_NAND_RW = 0x1234567D,
    ARCH_NAND_RO = 0x1234567E,
    ARCH_NAND_RO_WRITE_ACCESS = 0x1234567F,
} FS_archiveIds;

typedef struct
{
    FS_pathType type;  
    u32         size;  
    const u8    *data; 
} FS_path;

typedef struct
{
    u32     id;         
    FS_path lowPath;    
    Handle  handleLow;  
    Handle  handleHigh; 
} FS_archive;

typedef struct
{
  // 0x00
  u16 name[0x106];     
  // 0x20C
  u8  shortName[0x09]; 
  // 0x215
  u8  unknown1;        
  // 0x216
  u8  shortExt[0x04];  
  // 0x21A
  u8  unknown2;        
  // 0x21B
  u8  unknown3;        
  // 0x21C
  u8  isDirectory;     
  // 0x21D
  u8  isHidden;        
  // 0x21E
  u8  isArchive;       
  // 0x21F
  u8  isReadOnly;      
  // 0x220
  u64 fileSize;        
} FS_dirent;

static inline FS_path
FS_makePath(FS_pathType type,
            const char  *path)
{
    return (FS_path){type, strlen(path)+1, (const u8*)path};
}

Result fsInit(void);
Result fsExit(void);

Result FSUSER_Initialize(Handle* handle);
Result FSUSER_OpenArchive(Handle* handle, FS_archive* archive);
Result FSUSER_OpenDirectory(Handle* handle, Handle* out, FS_archive archive, FS_path dirLowPath);
Result FSUSER_OpenFile(Handle* handle, Handle* out, FS_archive archive, FS_path fileLowPath, u32 openflags, u32 attributes);
Result FSUSER_OpenFileDirectly(Handle* handle, Handle* out, FS_archive archive, FS_path fileLowPath, u32 openflags, u32 attributes);
Result FSUSER_CloseArchive(Handle* handle, FS_archive* archive);
Result FSUSER_CreateDirectory(Handle* handle, FS_archive archive, FS_path dirLowPath);
Result FSUSER_DeleteFile(Handle *handle, FS_archive archive, FS_path fileLowPath);
Result FSUSER_DeleteDirectory(Handle *handle, FS_archive archive, FS_path dirLowPath);
Result FSUSER_RenameFile(Handle *handle, FS_archive srcArchive, FS_path srcFileLowPath, FS_archive destArchive, FS_path destFileLowPath);
Result FSUSER_RenameDirectory(Handle *handle, FS_archive srcArchive, FS_path srcDirLowPath, FS_archive destArchive, FS_path destDirLowPath);
Result FSUSER_GetSdmcArchiveResource(Handle *handle, u32 *sectorSize, u32 *clusterSize, u32 *numClusters, u32 *freeClusters);
Result FSUSER_IsSdmcDetected(Handle *handle, u32 *detected);
Result FSUSER_IsSdmcWritable(Handle *handle, u32 *writable);

Result FSFILE_Close(Handle handle);
Result FSFILE_Read(Handle handle, u32 *bytesRead, u64 offset, void *buffer, u32 size);
Result FSFILE_Write(Handle handle, u32 *bytesWritten, u64 offset, const void *buffer, u32 size, u32 flushFlags);
Result FSFILE_GetSize(Handle handle, u64 *size);
Result FSFILE_SetSize(Handle handle, u64 size);
Result FSFILE_GetAttributes(Handle handle, u32 *attributes);
Result FSFILE_SetAttributes(Handle handle, u32 attributes);
Result FSFILE_Flush(Handle handle);

Result FSDIR_Read(Handle handle, u32 *entriesRead, u32 entrycount, FS_dirent *buffer);
Result FSDIR_Close(Handle handle);