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 #define AO_FAT_SUCCESS                  0
  39 #define AO_FAT_EPERM                    1
  40 #define AO_FAT_ENOENT                   2
  41 #define AO_FAT_EIO                      4
  42 #define AO_FAT_EBADF                    9
  43 #define AO_FAT_EACCESS                  13
  44 #define AO_FAT_EEXIST                   17
  45 #define AO_FAT_ENOTDIR                  20
  46 #define AO_FAT_EISDIR                   21
  47 #define AO_FAT_EMFILE                   24
  48 #define AO_FAT_EFBIG                    27
  49 #define AO_FAT_ENOSPC                   28
  50
  51 void
  52 ao_fat_sync(void);
  53
  54 int8_t
  55 ao_fat_full(void);
  56
  57 int8_t
  58 ao_fat_open(char name[11], uint8_t mode);
  59
  60 #define AO_FAT_OPEN_READ                0
  61 #define AO_FAT_OPEN_WRITE               1
  62 #define AO_FAT_OPEN_RW                  2
  63
  64 int8_t
  65 ao_fat_creat(char name[11]);
  66
  67 int8_t
  68 ao_fat_close(void);
  69
  70 int
  71 ao_fat_read(void *dest, int len);
  72
  73 int
  74 ao_fat_write(void *src, int len);
  75
  76 #define AO_FAT_SEEK_SET 0
  77 #define AO_FAT_SEEK_CUR 1
  78 #define AO_FAT_SEEK_END 2
  79
  80 int32_t
  81 ao_fat_seek(int32_t pos, uint8_t whence);
  82
  83 int8_t
  84 ao_fat_unlink(char name[11]);
  85
  86 int8_t
  87 ao_fat_rename(char old[11], char new[11]);
  88
  89 /*
  90  * Byte offset within a file. Supports files up to 2GB in size
  91  */
  92 typedef int32_t         ao_fat_offset_t;
  93
  94 /*
  95  * Cluster index in partition data space
  96  */
  97 typedef uint32_t        ao_fat_cluster_t;
  98
  99 /*
 100  * Sector offset within partition
 101  */
 102 typedef uint32_t        ao_fat_sector_t;
 103
 104 /*
 105  * Index within the root directory
 106  */
 107 typedef uint16_t        ao_fat_dirent_t;
 108
 109 /*
 110  * Offset within a cluster (or sector)
 111  */
 112 typedef uint16_t        ao_fat_cluster_offset_t;
 113
 114 struct ao_fat_dirent {
 115         char                    name[11];
 116         uint8_t                 attr;
 117         uint32_t                size;
 118         ao_fat_cluster_t        cluster;
 119         uint16_t                entry;
 120 };
 121
 122 int8_t
 123 ao_fat_readdir(uint16_t *entry, struct ao_fat_dirent *dirent);
 124
 125 #endif /* _AO_FAT_H_ */