source: mainline/uspace/srv/fs/fat/fat_dentry.h

Last change on this file was b1834a01, checked in by Jakub Jermar <jakub@…>, 7 years ago

Categorize the remaining orphan doxygroups

  • Property mode set to 100644
File size: 5.0 KB
Line 
1/*
2 * Copyright (c) 2008 Jakub Jermar
3 * Copyright (c) 2011 Oleg Romanenko
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup fat
31 * @{
32 */
33
34#ifndef FAT_FAT_DENTRY_H_
35#define FAT_FAT_DENTRY_H_
36
37#include <ctype.h>
38#include <stdint.h>
39#include <stdbool.h>
40#include <stddef.h>
41#include <unaligned.h>
42
43#define IS_D_CHAR(ch) (isalnum(ch) || ch == '_')
44#define FAT_STOP_CHARS "*?/\\\n\t|'"
45
46#define FAT_NAME_LEN 8
47#define FAT_EXT_LEN 3
48#define FAT_VOLLABEL_LEN 11
49
50#define FAT_NAME_DOT ". "
51#define FAT_NAME_DOT_DOT ".. "
52#define FAT_EXT_PAD " "
53
54#define FAT_ATTR_RDONLY 0x01
55#define FAT_ATTR_HIDDEN 0x02
56#define FAT_ATTR_SYSTEM 0x04
57#define FAT_ATTR_VOLLABEL 0x08
58#define FAT_ATTR_SUBDIR 0x10
59#define FAT_ATTR_ARCHIVE 0x20
60#define FAT_ATTR_LFN \
61 (FAT_ATTR_RDONLY | FAT_ATTR_HIDDEN | FAT_ATTR_SYSTEM | FAT_ATTR_VOLLABEL)
62
63#define FAT_LCASE_LOWER_NAME 0x08
64#define FAT_LCASE_LOWER_EXT 0x10
65
66#define FAT_PAD ' '
67#define FAT_LFN_PAD 0xffff
68#define FAT_SFN_CHAR '_'
69
70#define FAT_DENTRY_UNUSED 0x00
71#define FAT_DENTRY_E5_ESC 0x05
72#define FAT_DENTRY_DOT 0x2e
73#define FAT_DENTRY_ERASED 0xe5
74#define FAT_LFN_LAST 0x40
75#define FAT_LFN_ERASED 0x80
76
77#define FAT_LFN_ORDER(d) ((d)->lfn.order)
78#define FAT_IS_LFN(d) \
79 ((FAT_LFN_ORDER((d)) & FAT_LFN_LAST) == FAT_LFN_LAST)
80#define FAT_LFN_COUNT(d) \
81 (FAT_LFN_ORDER((d)) ^ FAT_LFN_LAST)
82#define FAT_LFN_PART1(d) ((d)->lfn.part1)
83#define FAT_LFN_PART2(d) ((d)->lfn.part2)
84#define FAT_LFN_PART3(d) ((d)->lfn.part3)
85#define FAT_LFN_ATTR(d) ((d)->lfn.attr)
86#define FAT_LFN_CHKSUM(d) ((d)->lfn.check_sum)
87
88#define FAT_LFN_NAME_LEN 260 /* characters */
89#define FAT_LFN_NAME_SIZE STR_BOUNDS(FAT_LFN_NAME_LEN) /* bytes */
90#define FAT_LFN_MAX_COUNT 20
91#define FAT_LFN_PART1_SIZE 5
92#define FAT_LFN_PART2_SIZE 6
93#define FAT_LFN_PART3_SIZE 2
94#define FAT_LFN_ENTRY_SIZE \
95 (FAT_LFN_PART1_SIZE + FAT_LFN_PART2_SIZE + FAT_LFN_PART3_SIZE)
96
97typedef enum {
98 FAT_DENTRY_SKIP,
99 FAT_DENTRY_LAST,
100 FAT_DENTRY_FREE,
101 FAT_DENTRY_VALID,
102 FAT_DENTRY_LFN,
103 FAT_DENTRY_VOLLABEL
104} fat_dentry_clsf_t;
105
106typedef union {
107 struct {
108 uint8_t name[8];
109 uint8_t ext[3];
110 uint8_t attr;
111 uint8_t lcase;
112 uint8_t ctime_fine;
113 uint16_t ctime;
114 uint16_t cdate;
115 uint16_t adate;
116 union {
117 uint16_t eaidx; /* FAT12/FAT16 */
118 uint16_t firstc_hi; /* FAT32 */
119 } __attribute__((packed));
120 uint16_t mtime;
121 uint16_t mdate;
122 union {
123 uint16_t firstc; /* FAT12/FAT16 */
124 uint16_t firstc_lo; /* FAT32 */
125 } __attribute__((packed));
126 uint32_t size;
127 } __attribute__((packed));
128 struct {
129 uint8_t order;
130 uint16_t part1[FAT_LFN_PART1_SIZE];
131 uint8_t attr;
132 uint8_t type;
133 uint8_t check_sum;
134 uint16_t part2[FAT_LFN_PART2_SIZE];
135 uint16_t firstc_lo; /* MUST be 0 */
136 uint16_t part3[FAT_LFN_PART3_SIZE];
137 } __attribute__((packed)) lfn;
138} __attribute__((packed)) fat_dentry_t;
139
140extern int fat_dentry_namecmp(char *, const char *);
141extern void fat_dentry_name_get(const fat_dentry_t *, char *);
142extern void fat_dentry_name_set(fat_dentry_t *, const char *);
143extern void fat_dentry_vollabel_get(const fat_dentry_t *, char *);
144extern fat_dentry_clsf_t fat_classify_dentry(const fat_dentry_t *);
145extern uint8_t fat_dentry_chksum(uint8_t *);
146
147extern size_t fat_lfn_str_nlength(const unaligned_uint16_t *, size_t);
148extern size_t fat_lfn_size(const fat_dentry_t *);
149extern size_t fat_lfn_get_entry(const fat_dentry_t *, uint16_t *, size_t *);
150extern size_t fat_lfn_set_entry(const uint16_t *, size_t *, size_t,
151 fat_dentry_t *);
152
153extern void str_to_ascii(char *, const char *, size_t, uint8_t);
154
155extern bool fat_valid_name(const char *);
156extern bool fat_valid_short_name(const char *);
157
158#endif
159
160/**
161 * @}
162 */
Note: See TracBrowser for help on using the repository browser.