sys/fs/msdosfs/direntry.h

   1 /* $FreeBSD$ */
   2 /*      $NetBSD: direntry.h,v 1.14 1997/11/17 15:36:32 ws Exp $ */
   3
   4 /*-
   5  * Copyright (C) 1994, 1995, 1997 Wolfgang Solfrank.
   6  * Copyright (C) 1994, 1995, 1997 TooLs GmbH.
   7  * All rights reserved.
   8  * Original code by Paul Popelka (paulp@uts.amdahl.com) (see below).
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by TooLs GmbH.
  21  * 4. The name of TooLs GmbH may not be used to endorse or promote products
  22  *    derived from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  27  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  29  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  30  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  32  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  33  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 /*-
  36  * Written by Paul Popelka (paulp@uts.amdahl.com)
  37  *
  38  * You can do anything you want with this software, just don't say you wrote
  39  * it, and don't remove this notice.
  40  *
  41  * This software is provided "as is".
  42  *
  43  * The author supplies this software to be publicly redistributed on the
  44  * understanding that the author is not responsible for the correct
  45  * functioning of this software in any circumstances and is not liable for
  46  * any damages caused by this software.
  47  *
  48  * October 1992
  49  */
  50
  51 /*
  52  * Structure of a dos directory entry.
  53  */
  54 struct direntry {
  55         u_int8_t        deName[8];      /* filename, blank filled */
  56 #define SLOT_EMPTY      0x00            /* slot has never been used */
  57 #define SLOT_E5         0x05            /* the real value is 0xe5 */
  58 #define SLOT_DELETED    0xe5            /* file in this slot deleted */
  59         u_int8_t        deExtension[3]; /* extension, blank filled */
  60         u_int8_t        deAttributes;   /* file attributes */
  61 #define ATTR_NORMAL     0x00            /* normal file */
  62 #define ATTR_READONLY   0x01            /* file is readonly */
  63 #define ATTR_HIDDEN     0x02            /* file is hidden */
  64 #define ATTR_SYSTEM     0x04            /* file is a system file */
  65 #define ATTR_VOLUME     0x08            /* entry is a volume label */
  66 #define ATTR_DIRECTORY  0x10            /* entry is a directory name */
  67 #define ATTR_ARCHIVE    0x20            /* file is new or modified */
  68         u_int8_t        deLowerCase;    /* NT VFAT lower case flags */
  69 #define LCASE_BASE      0x08            /* filename base in lower case */
  70 #define LCASE_EXT       0x10            /* filename extension in lower case */
  71         u_int8_t        deCHundredth;   /* hundredth of seconds in CTime */
  72         u_int8_t        deCTime[2];     /* create time */
  73         u_int8_t        deCDate[2];     /* create date */
  74         u_int8_t        deADate[2];     /* access date */
  75         u_int8_t        deHighClust[2]; /* high bytes of cluster number */
  76         u_int8_t        deMTime[2];     /* last update time */
  77         u_int8_t        deMDate[2];     /* last update date */
  78         u_int8_t        deStartCluster[2]; /* starting cluster of file */
  79         u_int8_t        deFileSize[4];  /* size of file in bytes */
  80 };
  81
  82 /*
  83  * Structure of a Win95 long name directory entry
  84  */
  85 struct winentry {
  86         u_int8_t        weCnt;
  87 #define WIN_LAST        0x40
  88 #define WIN_CNT         0x3f
  89         u_int8_t        wePart1[10];
  90         u_int8_t        weAttributes;
  91 #define ATTR_WIN95      0x0f
  92         u_int8_t        weReserved1;
  93         u_int8_t        weChksum;
  94         u_int8_t        wePart2[12];
  95         u_int16_t       weReserved2;
  96         u_int8_t        wePart3[4];
  97 };
  98 #define WIN_CHARS       13      /* Number of chars per winentry */
  99
 100 /*
 101  * Maximum number of winentries for a filename.
 102  */
 103 #define WIN_MAXSUBENTRIES 20
 104
 105 /*
 106  * Maximum filename length in Win95
 107  * Note: Must be < sizeof(dirent.d_name)
 108  */
 109 #define WIN_MAXLEN      255
 110
 111 /*
 112  * This is the format of the contents of the deTime field in the direntry
 113  * structure.
 114  * We don't use bitfields because we don't know how compilers for
 115  * arbitrary machines will lay them out.
 116  */
 117 #define DT_2SECONDS_MASK        0x1F    /* seconds divided by 2 */
 118 #define DT_2SECONDS_SHIFT       0
 119 #define DT_MINUTES_MASK         0x7E0   /* minutes */
 120 #define DT_MINUTES_SHIFT        5
 121 #define DT_HOURS_MASK           0xF800  /* hours */
 122 #define DT_HOURS_SHIFT          11
 123
 124 /*
 125  * This is the format of the contents of the deDate field in the direntry
 126  * structure.
 127  */
 128 #define DD_DAY_MASK             0x1F    /* day of month */
 129 #define DD_DAY_SHIFT            0
 130 #define DD_MONTH_MASK           0x1E0   /* month */
 131 #define DD_MONTH_SHIFT          5
 132 #define DD_YEAR_MASK            0xFE00  /* year - 1980 */
 133 #define DD_YEAR_SHIFT           9
 134
 135 #ifdef _KERNEL
 136 struct mbnambuf {
 137         size_t  nb_len;
 138         int     nb_last_id;
 139         char    nb_buf[WIN_MAXLEN + 1];
 140 };
 141
 142 struct dirent;
 143 struct msdosfsmount;
 144
 145 char    *mbnambuf_flush(struct mbnambuf *nbp, struct dirent *dp);
 146 void    mbnambuf_init(struct mbnambuf *nbp);
 147 void    mbnambuf_write(struct mbnambuf *nbp, char *name, int id);
 148 int     dos2unixfn(u_char dn[11], u_char *un, int lower,
 149             struct msdosfsmount *pmp);
 150 int     unix2dosfn(const u_char *un, u_char dn[12], size_t unlen, u_int gen,
 151             struct msdosfsmount *pmp);
 152 int     unix2winfn(const u_char *un, size_t unlen, struct winentry *wep, int cnt,
 153             int chksum, struct msdosfsmount *pmp);
 154 int     winChkName(struct mbnambuf *nbp, const u_char *un, size_t unlen,
 155             int chksum, struct msdosfsmount *pmp);
 156 int     win2unixfn(struct mbnambuf *nbp, struct winentry *wep, int chksum,
 157             struct msdosfsmount *pmp);
 158 u_int8_t winChksum(struct direntry *dep);
 159 int     winSlotCnt(const u_char *un, size_t unlen, struct msdosfsmount *pmp);
 160 size_t  winLenFixup(const u_char *un, size_t unlen);
 161 #endif  /* _KERNEL */