xref: /openbmc/linux/fs/adfs/adfs.h (revision 63dc02bd)
1 #include <linux/fs.h>
2 #include <linux/adfs_fs.h>
3 
4 /* Internal data structures for ADFS */
5 
6 #define ADFS_FREE_FRAG		 0
7 #define ADFS_BAD_FRAG		 1
8 #define ADFS_ROOT_FRAG		 2
9 
10 #define ADFS_NDA_OWNER_READ	(1 << 0)
11 #define ADFS_NDA_OWNER_WRITE	(1 << 1)
12 #define ADFS_NDA_LOCKED		(1 << 2)
13 #define ADFS_NDA_DIRECTORY	(1 << 3)
14 #define ADFS_NDA_EXECUTE	(1 << 4)
15 #define ADFS_NDA_PUBLIC_READ	(1 << 5)
16 #define ADFS_NDA_PUBLIC_WRITE	(1 << 6)
17 
18 #include "dir_f.h"
19 
20 struct buffer_head;
21 
22 /*
23  * adfs file system inode data in memory
24  */
25 struct adfs_inode_info {
26 	loff_t		mmu_private;
27 	unsigned long	parent_id;	/* object id of parent		*/
28 	__u32		loadaddr;	/* RISC OS load address		*/
29 	__u32		execaddr;	/* RISC OS exec address		*/
30 	unsigned int	filetype;	/* RISC OS file type		*/
31 	unsigned int	attr;		/* RISC OS permissions		*/
32 	unsigned int	stamped:1;	/* RISC OS file has date/time	*/
33 	struct inode vfs_inode;
34 };
35 
36 /*
37  * Forward-declare this
38  */
39 struct adfs_discmap;
40 struct adfs_dir_ops;
41 
42 /*
43  * ADFS file system superblock data in memory
44  */
45 struct adfs_sb_info {
46 	struct adfs_discmap *s_map;	/* bh list containing map		 */
47 	struct adfs_dir_ops *s_dir;	/* directory operations			 */
48 
49 	uid_t		s_uid;		/* owner uid				 */
50 	gid_t		s_gid;		/* owner gid				 */
51 	umode_t		s_owner_mask;	/* ADFS owner perm -> unix perm		 */
52 	umode_t		s_other_mask;	/* ADFS other perm -> unix perm		 */
53 	int		s_ftsuffix;	/* ,xyz hex filetype suffix option */
54 
55 	__u32		s_ids_per_zone;	/* max. no ids in one zone		 */
56 	__u32		s_idlen;	/* length of ID in map			 */
57 	__u32		s_map_size;	/* sector size of a map			 */
58 	unsigned long	s_size;		/* total size (in blocks) of this fs	 */
59 	signed int	s_map2blk;	/* shift left by this for map->sector	 */
60 	unsigned int	s_log2sharesize;/* log2 share size			 */
61 	__le32		s_version;	/* disc format version			 */
62 	unsigned int	s_namelen;	/* maximum number of characters in name	 */
63 };
64 
65 static inline struct adfs_sb_info *ADFS_SB(struct super_block *sb)
66 {
67 	return sb->s_fs_info;
68 }
69 
70 static inline struct adfs_inode_info *ADFS_I(struct inode *inode)
71 {
72 	return container_of(inode, struct adfs_inode_info, vfs_inode);
73 }
74 
75 /*
76  * Directory handling
77  */
78 struct adfs_dir {
79 	struct super_block	*sb;
80 
81 	int			nr_buffers;
82 	struct buffer_head	*bh[4];
83 
84 	/* big directories need allocated buffers */
85 	struct buffer_head	**bh_fplus;
86 
87 	unsigned int		pos;
88 	unsigned int		parent_id;
89 
90 	struct adfs_dirheader	dirhead;
91 	union  adfs_dirtail	dirtail;
92 };
93 
94 /*
95  * This is the overall maximum name length
96  */
97 #define ADFS_MAX_NAME_LEN	(256 + 4) /* +4 for ,xyz hex filetype suffix */
98 struct object_info {
99 	__u32		parent_id;		/* parent object id	*/
100 	__u32		file_id;		/* object id		*/
101 	__u32		loadaddr;		/* load address		*/
102 	__u32		execaddr;		/* execution address	*/
103 	__u32		size;			/* size			*/
104 	__u8		attr;			/* RISC OS attributes	*/
105 	unsigned int	name_len;		/* name length		*/
106 	char		name[ADFS_MAX_NAME_LEN];/* file name		*/
107 
108 	/* RISC OS file type (12-bit: derived from loadaddr) */
109 	__u16		filetype;
110 };
111 
112 /* RISC OS 12-bit filetype converts to ,xyz hex filename suffix */
113 static inline int append_filetype_suffix(char *buf, __u16 filetype)
114 {
115 	if (filetype == 0xffff)	/* no explicit 12-bit file type was set */
116 		return 0;
117 
118 	*buf++ = ',';
119 	*buf++ = hex_asc_lo(filetype >> 8);
120 	*buf++ = hex_asc_lo(filetype >> 4);
121 	*buf++ = hex_asc_lo(filetype >> 0);
122 	return 4;
123 }
124 
125 struct adfs_dir_ops {
126 	int	(*read)(struct super_block *sb, unsigned int id, unsigned int sz, struct adfs_dir *dir);
127 	int	(*setpos)(struct adfs_dir *dir, unsigned int fpos);
128 	int	(*getnext)(struct adfs_dir *dir, struct object_info *obj);
129 	int	(*update)(struct adfs_dir *dir, struct object_info *obj);
130 	int	(*create)(struct adfs_dir *dir, struct object_info *obj);
131 	int	(*remove)(struct adfs_dir *dir, struct object_info *obj);
132 	int	(*sync)(struct adfs_dir *dir);
133 	void	(*free)(struct adfs_dir *dir);
134 };
135 
136 struct adfs_discmap {
137 	struct buffer_head	*dm_bh;
138 	__u32			dm_startblk;
139 	unsigned int		dm_startbit;
140 	unsigned int		dm_endbit;
141 };
142 
143 /* Inode stuff */
144 struct inode *adfs_iget(struct super_block *sb, struct object_info *obj);
145 int adfs_write_inode(struct inode *inode, struct writeback_control *wbc);
146 int adfs_notify_change(struct dentry *dentry, struct iattr *attr);
147 
148 /* map.c */
149 extern int adfs_map_lookup(struct super_block *sb, unsigned int frag_id, unsigned int offset);
150 extern unsigned int adfs_map_free(struct super_block *sb);
151 
152 /* Misc */
153 void __adfs_error(struct super_block *sb, const char *function,
154 		  const char *fmt, ...);
155 #define adfs_error(sb, fmt...) __adfs_error(sb, __func__, fmt)
156 
157 /* super.c */
158 
159 /*
160  * Inodes and file operations
161  */
162 
163 /* dir_*.c */
164 extern const struct inode_operations adfs_dir_inode_operations;
165 extern const struct file_operations adfs_dir_operations;
166 extern const struct dentry_operations adfs_dentry_operations;
167 extern struct adfs_dir_ops adfs_f_dir_ops;
168 extern struct adfs_dir_ops adfs_fplus_dir_ops;
169 
170 extern int adfs_dir_update(struct super_block *sb, struct object_info *obj,
171 			   int wait);
172 
173 /* file.c */
174 extern const struct inode_operations adfs_file_inode_operations;
175 extern const struct file_operations adfs_file_operations;
176 
177 static inline __u32 signed_asl(__u32 val, signed int shift)
178 {
179 	if (shift >= 0)
180 		val <<= shift;
181 	else
182 		val >>= -shift;
183 	return val;
184 }
185 
186 /*
187  * Calculate the address of a block in an object given the block offset
188  * and the object identity.
189  *
190  * The root directory ID should always be looked up in the map [3.4]
191  */
192 static inline int
193 __adfs_block_map(struct super_block *sb, unsigned int object_id,
194 		 unsigned int block)
195 {
196 	if (object_id & 255) {
197 		unsigned int off;
198 
199 		off = (object_id & 255) - 1;
200 		block += off << ADFS_SB(sb)->s_log2sharesize;
201 	}
202 
203 	return adfs_map_lookup(sb, object_id >> 8, block);
204 }
205