git.gag.com Git - fw/altos/blob - src/drivers/ao_fat.h

   1 /*
   2  * Copyright © 2013 Keith Packard <keithp@keithp.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; version 2 of the License.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  16  */
  17
  18 #ifndef _AO_FAT_H_
  19 #define _AO_FAT_H_
  20
  21 void
  22 ao_fat_init(void);
  23
  24 #define AO_FAT_FILE_REGULAR             0x00
  25 #define AO_FAT_FILE_READ_ONLY           0x01
  26 #define AO_FAT_FILE_HIDDEN              0x02
  27 #define AO_FAT_FILE_SYSTEM              0x04
  28 #define AO_FAT_FILE_VOLUME_LABEL        0x08
  29 #define AO_FAT_FILE_DIRECTORY           0x10
  30 #define AO_FAT_FILE_ARCHIVE             0x20
  31
  32 #define AO_FAT_DENT_EMPTY               0xe5
  33 #define AO_FAT_DENT_END                 0x00
  34
  35 #define AO_FAT_IS_FILE(attr)    (((attr) & (AO_FAT_FILE_VOLUME_LABEL|AO_FAT_FILE_DIRECTORY)) == 0)
  36 #define AO_FAT_IS_DIR(attr)     (((attr) & (AO_FAT_FILE_DIRECTORY|AO_FAT_FILE_VOLUME_LABEL)) == AO_FAT_FILE_DIRECTORY)
  37
  38 /* API error codes */
  39 #define AO_FAT_SUCCESS                  0
  40 #define AO_FAT_EPERM                    1
  41 #define AO_FAT_ENOENT                   2
  42 #define AO_FAT_EIO                      4
  43 #define AO_FAT_EBADF                    9
  44 #define AO_FAT_EACCESS                  13
  45 #define AO_FAT_EEXIST                   17
  46 #define AO_FAT_ENOTDIR                  20
  47 #define AO_FAT_EISDIR                   21
  48 #define AO_FAT_EMFILE                   24
  49 #define AO_FAT_EFBIG                    27
  50 #define AO_FAT_ENOSPC                   28
  51 #define AO_FAT_EDIREOF                  29
  52
  53 /* ao_fat_setup return values */
  54 #define AO_FAT_FILESYSTEM_SUCCESS                       0
  55 #define AO_FAT_FILESYSTEM_MBR_READ_FAILURE              1
  56 #define AO_FAT_FILESYSTEM_INVALID_MBR_SIGNATURE         2
  57 #define AO_FAT_FILESYSTEM_INVALID_PARTITION_TYPE        3
  58 #define AO_FAT_FILESYSTEM_ZERO_SIZED_PARTITION          4
  59
  60 #define AO_FAT_FILESYSTEM_BOOT_READ_FAILURE             5
  61 #define AO_FAT_FILESYSTEM_INVALID_BOOT_SIGNATURE        6
  62 #define AO_FAT_FILESYSTEM_INVALID_SECTOR_SIZE           7
  63
  64 void
  65 ao_fat_sync(void);
  66
  67 void
  68 ao_fat_unmount(void);
  69
  70 int8_t
  71 ao_fat_full(void);
  72
  73 int8_t
  74 ao_fat_open(char name[11], uint8_t mode);
  75
  76 #define AO_FAT_OPEN_READ                0
  77 #define AO_FAT_OPEN_WRITE               1
  78 #define AO_FAT_OPEN_RW                  2
  79
  80 int8_t
  81 ao_fat_creat(char name[11]);
  82
  83 int8_t
  84 ao_fat_close(int8_t fd);
  85
  86 int
  87 ao_fat_read(int8_t fd, void *dest, int len);
  88
  89 int
  90 ao_fat_write(int8_t fd, void *src, int len);
  91
  92 #define AO_FAT_SEEK_SET 0
  93 #define AO_FAT_SEEK_CUR 1
  94 #define AO_FAT_SEEK_END 2
  95
  96 int32_t
  97 ao_fat_seek(int8_t fd, int32_t pos, uint8_t whence);
  98
  99 int8_t
 100 ao_fat_unlink(char name[11]);
 101
 102 int8_t
 103 ao_fat_rename(char old[11], char new[11]);
 104
 105 /*
 106  * Byte offset within a file. Supports files up to 2GB in size
 107  */
 108 typedef int32_t         ao_fat_offset_t;
 109
 110 /*
 111  * Cluster index in partition data space
 112  */
 113 typedef uint32_t        ao_fat_cluster_t;
 114
 115 /*
 116  * Sector offset within partition
 117  */
 118 typedef uint32_t        ao_fat_sector_t;
 119
 120 /*
 121  * Index within the root directory
 122  */
 123 typedef uint16_t        ao_fat_dirent_t;
 124
 125 /*
 126  * Offset within a cluster (or sector)
 127  */
 128 typedef uint16_t        ao_fat_cluster_offset_t;
 129
 130 struct ao_fat_dirent {
 131         char                    name[11];
 132         uint8_t                 attr;
 133         uint32_t                size;
 134         ao_fat_cluster_t        cluster;
 135         uint16_t                entry;
 136 };
 137
 138 int8_t
 139 ao_fat_readdir(uint16_t *entry, struct ao_fat_dirent *dirent);
 140
 141 #endif /* _AO_FAT_H_ */