phatdir.h

Go to the documentation of this file.

#ifndef FS_PHATDIR_H_
#define FS_PHATDIR_H_

/*
 * Copyright (C) 2005-2006 by egnite Software GmbH. All rights reserved.
 *
 * 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.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH 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 EGNITE
 * SOFTWARE GMBH 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.
 *
 * For additional information see http://www.ethernut.de/
 */

#include <dirent.h>
#include <sys/stat.h>


#ifndef PHAT_MAX_NAMELEN
#define PHAT_MAX_NAMELEN    255
#endif

#define PHAT_REM_DIRENT  0xE5
#define PHAT_REM_NAMENT  0x05

typedef struct __attribute__ ((packed)) _PHATDIRENT {
    uint8_t dent_name[11];
    uint8_t dent_attr;
    uint8_t dent_rsvdnt;
    uint8_t dent_ctsecs;
    uint16_t dent_ctime;
    uint16_t dent_cdate;
    uint16_t dent_adate;
    uint16_t dent_clusthi;
    uint16_t dent_mtime;
    uint16_t dent_mdate;
    uint16_t dent_clust;
    uint32_t dent_fsize;
} PHATDIRENT;

typedef struct __attribute__ ((packed)) _PHATXDIRENT {
    uint8_t xdent_seq;
    uint16_t xdent_uname_1_5[5];
    uint8_t xdent_attr;
    uint8_t xdent_rsvd;
    uint8_t xdent_cks;
    uint16_t xdent_uname_6_11[6];
    uint16_t xdent_clust;
    uint16_t xdent_uname_12_13[2];
} PHATXDIRENT;

typedef struct _PHATFIND {
    PHATDIRENT phfind_ent;
    uint32_t phfind_pos;
    int phfind_xcnt;
    char phfind_name[PHAT_MAX_NAMELEN];
} PHATFIND;

__BEGIN_DECLS
/* Prototypes */
extern int PhatDirEntryCreate(NUTFILE * ndp, CONST char *name, int acc, PHATDIRENT * dirent);

extern int PhatDirEntryUpdate(NUTFILE * ndp);

extern int PhatDirReleaseChain(NUTDEVICE * dev, PHATDIRENT * dent);

extern int PhatDirDelEntry(NUTDEVICE * dev, CONST char *path, uint32_t flags);
extern int PhatDirRenameEntry(NUTDEVICE * dev, CONST char *old_path, CONST char *new_path);

extern NUTFILE *PhatDirOpen(NUTDEVICE * dev, CONST char *dpath);
extern NUTFILE *PhatDirOpenParent(NUTDEVICE * dev, CONST char *path, CONST char **basename);
extern int PhatDirEntryFind(NUTFILE * nfp, CONST char *spec, uint32_t flags, PHATFIND * srch);
extern int PhatDirRead(DIR * dir);

extern int PhatDirCreate(NUTDEVICE * dev, char *path);
extern int PhatDirRemove(NUTDEVICE * dev, char *path);

extern int PhatDirEntryStatus(NUTDEVICE * dev, CONST char *path, struct stat *s);

__END_DECLS
/* End of prototypes */
#endif