The prosthetic control(MIT)
platform/LocalFileSystem.cpp@0:20e0c61e0684, 2022-06-23 (annotated)
- Committer:
- ganlikun
- Date:
- Thu Jun 23 05:23:34 2022 +0000
- Revision:
- 0:20e0c61e0684
01
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
ganlikun | 0:20e0c61e0684 | 1 | /* mbed Microcontroller Library |
ganlikun | 0:20e0c61e0684 | 2 | * Copyright (c) 2006-2013 ARM Limited |
ganlikun | 0:20e0c61e0684 | 3 | * |
ganlikun | 0:20e0c61e0684 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
ganlikun | 0:20e0c61e0684 | 5 | * you may not use this file except in compliance with the License. |
ganlikun | 0:20e0c61e0684 | 6 | * You may obtain a copy of the License at |
ganlikun | 0:20e0c61e0684 | 7 | * |
ganlikun | 0:20e0c61e0684 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
ganlikun | 0:20e0c61e0684 | 9 | * |
ganlikun | 0:20e0c61e0684 | 10 | * Unless required by applicable law or agreed to in writing, software |
ganlikun | 0:20e0c61e0684 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
ganlikun | 0:20e0c61e0684 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
ganlikun | 0:20e0c61e0684 | 13 | * See the License for the specific language governing permissions and |
ganlikun | 0:20e0c61e0684 | 14 | * limitations under the License. |
ganlikun | 0:20e0c61e0684 | 15 | */ |
ganlikun | 0:20e0c61e0684 | 16 | #include "platform/LocalFileSystem.h" |
ganlikun | 0:20e0c61e0684 | 17 | |
ganlikun | 0:20e0c61e0684 | 18 | #if DEVICE_LOCALFILESYSTEM |
ganlikun | 0:20e0c61e0684 | 19 | |
ganlikun | 0:20e0c61e0684 | 20 | #include "platform/mbed_semihost_api.h" |
ganlikun | 0:20e0c61e0684 | 21 | #include <string.h> |
ganlikun | 0:20e0c61e0684 | 22 | #include <stdio.h> |
ganlikun | 0:20e0c61e0684 | 23 | #include <errno.h> |
ganlikun | 0:20e0c61e0684 | 24 | |
ganlikun | 0:20e0c61e0684 | 25 | namespace mbed { |
ganlikun | 0:20e0c61e0684 | 26 | |
ganlikun | 0:20e0c61e0684 | 27 | /* Extension to FINFO type defined in RTL.h (in Keil RL) - adds 'create time'. */ |
ganlikun | 0:20e0c61e0684 | 28 | typedef struct { |
ganlikun | 0:20e0c61e0684 | 29 | unsigned char hr; /* Hours [0..23] */ |
ganlikun | 0:20e0c61e0684 | 30 | unsigned char min; /* Minutes [0..59] */ |
ganlikun | 0:20e0c61e0684 | 31 | unsigned char sec; /* Seconds [0..59] */ |
ganlikun | 0:20e0c61e0684 | 32 | unsigned char day; /* Day [1..31] */ |
ganlikun | 0:20e0c61e0684 | 33 | unsigned char mon; /* Month [1..12] */ |
ganlikun | 0:20e0c61e0684 | 34 | unsigned short year; /* Year [1980..2107] */ |
ganlikun | 0:20e0c61e0684 | 35 | } FTIME; |
ganlikun | 0:20e0c61e0684 | 36 | |
ganlikun | 0:20e0c61e0684 | 37 | typedef struct { /* File Search info record */ |
ganlikun | 0:20e0c61e0684 | 38 | char name[32]; /* File name */ |
ganlikun | 0:20e0c61e0684 | 39 | long size; /* File size in bytes */ |
ganlikun | 0:20e0c61e0684 | 40 | int fileID; /* System File Identification */ |
ganlikun | 0:20e0c61e0684 | 41 | FTIME create_time; /* Date & time file was created */ |
ganlikun | 0:20e0c61e0684 | 42 | FTIME write_time; /* Date & time of last write */ |
ganlikun | 0:20e0c61e0684 | 43 | } XFINFO; |
ganlikun | 0:20e0c61e0684 | 44 | |
ganlikun | 0:20e0c61e0684 | 45 | #define RESERVED_FOR_USER_APPLICATIONS (0x100) /* 0x100 - 0x1ff */ |
ganlikun | 0:20e0c61e0684 | 46 | #define USR_XFFIND (RESERVED_FOR_USER_APPLICATIONS + 0) |
ganlikun | 0:20e0c61e0684 | 47 | |
ganlikun | 0:20e0c61e0684 | 48 | static int xffind (const char *pattern, XFINFO *info) { |
ganlikun | 0:20e0c61e0684 | 49 | unsigned param[4]; |
ganlikun | 0:20e0c61e0684 | 50 | |
ganlikun | 0:20e0c61e0684 | 51 | param[0] = (unsigned long)pattern; |
ganlikun | 0:20e0c61e0684 | 52 | param[1] = (unsigned long)strlen(pattern); |
ganlikun | 0:20e0c61e0684 | 53 | param[2] = (unsigned long)info; |
ganlikun | 0:20e0c61e0684 | 54 | param[3] = (unsigned long)sizeof(XFINFO); |
ganlikun | 0:20e0c61e0684 | 55 | |
ganlikun | 0:20e0c61e0684 | 56 | return __semihost(USR_XFFIND, param); |
ganlikun | 0:20e0c61e0684 | 57 | } |
ganlikun | 0:20e0c61e0684 | 58 | |
ganlikun | 0:20e0c61e0684 | 59 | #define OPEN_R 0 |
ganlikun | 0:20e0c61e0684 | 60 | #define OPEN_B 1 |
ganlikun | 0:20e0c61e0684 | 61 | #define OPEN_PLUS 2 |
ganlikun | 0:20e0c61e0684 | 62 | #define OPEN_W 4 |
ganlikun | 0:20e0c61e0684 | 63 | #define OPEN_A 8 |
ganlikun | 0:20e0c61e0684 | 64 | #define OPEN_INVALID -1 |
ganlikun | 0:20e0c61e0684 | 65 | |
ganlikun | 0:20e0c61e0684 | 66 | int posix_to_semihost_open_flags(int flags) { |
ganlikun | 0:20e0c61e0684 | 67 | /* POSIX flags -> semihosting open mode */ |
ganlikun | 0:20e0c61e0684 | 68 | int openmode; |
ganlikun | 0:20e0c61e0684 | 69 | if (flags & O_RDWR) { |
ganlikun | 0:20e0c61e0684 | 70 | /* a plus mode */ |
ganlikun | 0:20e0c61e0684 | 71 | openmode = OPEN_PLUS; |
ganlikun | 0:20e0c61e0684 | 72 | if (flags & O_APPEND) { |
ganlikun | 0:20e0c61e0684 | 73 | openmode |= OPEN_A; |
ganlikun | 0:20e0c61e0684 | 74 | } else if (flags & O_TRUNC) { |
ganlikun | 0:20e0c61e0684 | 75 | openmode |= OPEN_W; |
ganlikun | 0:20e0c61e0684 | 76 | } else { |
ganlikun | 0:20e0c61e0684 | 77 | openmode |= OPEN_R; |
ganlikun | 0:20e0c61e0684 | 78 | } |
ganlikun | 0:20e0c61e0684 | 79 | } else if (flags & O_WRONLY) { |
ganlikun | 0:20e0c61e0684 | 80 | /* write or append */ |
ganlikun | 0:20e0c61e0684 | 81 | if (flags & O_APPEND) { |
ganlikun | 0:20e0c61e0684 | 82 | openmode = OPEN_A; |
ganlikun | 0:20e0c61e0684 | 83 | } else { |
ganlikun | 0:20e0c61e0684 | 84 | openmode = OPEN_W; |
ganlikun | 0:20e0c61e0684 | 85 | } |
ganlikun | 0:20e0c61e0684 | 86 | } else if (flags == O_RDONLY) { |
ganlikun | 0:20e0c61e0684 | 87 | /* read mode */ |
ganlikun | 0:20e0c61e0684 | 88 | openmode = OPEN_R; |
ganlikun | 0:20e0c61e0684 | 89 | } else { |
ganlikun | 0:20e0c61e0684 | 90 | /* invalid flags */ |
ganlikun | 0:20e0c61e0684 | 91 | openmode = OPEN_INVALID; |
ganlikun | 0:20e0c61e0684 | 92 | } |
ganlikun | 0:20e0c61e0684 | 93 | |
ganlikun | 0:20e0c61e0684 | 94 | return openmode; |
ganlikun | 0:20e0c61e0684 | 95 | } |
ganlikun | 0:20e0c61e0684 | 96 | |
ganlikun | 0:20e0c61e0684 | 97 | FILEHANDLE local_file_open(const char* name, int flags) { |
ganlikun | 0:20e0c61e0684 | 98 | int openmode = posix_to_semihost_open_flags(flags); |
ganlikun | 0:20e0c61e0684 | 99 | if (openmode == OPEN_INVALID) { |
ganlikun | 0:20e0c61e0684 | 100 | return (FILEHANDLE)NULL; |
ganlikun | 0:20e0c61e0684 | 101 | } |
ganlikun | 0:20e0c61e0684 | 102 | |
ganlikun | 0:20e0c61e0684 | 103 | FILEHANDLE fh = semihost_open(name, openmode); |
ganlikun | 0:20e0c61e0684 | 104 | if (fh == -1) { |
ganlikun | 0:20e0c61e0684 | 105 | return (FILEHANDLE)NULL; |
ganlikun | 0:20e0c61e0684 | 106 | } |
ganlikun | 0:20e0c61e0684 | 107 | |
ganlikun | 0:20e0c61e0684 | 108 | return fh; |
ganlikun | 0:20e0c61e0684 | 109 | } |
ganlikun | 0:20e0c61e0684 | 110 | |
ganlikun | 0:20e0c61e0684 | 111 | LocalFileHandle::LocalFileHandle(FILEHANDLE fh) : _fh(fh), pos(0) { |
ganlikun | 0:20e0c61e0684 | 112 | // No lock needed in constructor |
ganlikun | 0:20e0c61e0684 | 113 | } |
ganlikun | 0:20e0c61e0684 | 114 | |
ganlikun | 0:20e0c61e0684 | 115 | int LocalFileHandle::close() { |
ganlikun | 0:20e0c61e0684 | 116 | int retval = semihost_close(_fh); |
ganlikun | 0:20e0c61e0684 | 117 | delete this; |
ganlikun | 0:20e0c61e0684 | 118 | return retval; |
ganlikun | 0:20e0c61e0684 | 119 | } |
ganlikun | 0:20e0c61e0684 | 120 | |
ganlikun | 0:20e0c61e0684 | 121 | ssize_t LocalFileHandle::write(const void *buffer, size_t length) { |
ganlikun | 0:20e0c61e0684 | 122 | lock(); |
ganlikun | 0:20e0c61e0684 | 123 | ssize_t n = semihost_write(_fh, (const unsigned char*)buffer, length, 0); // number of characters not written |
ganlikun | 0:20e0c61e0684 | 124 | n = length - n; // number of characters written |
ganlikun | 0:20e0c61e0684 | 125 | pos += n; |
ganlikun | 0:20e0c61e0684 | 126 | unlock(); |
ganlikun | 0:20e0c61e0684 | 127 | return n; |
ganlikun | 0:20e0c61e0684 | 128 | } |
ganlikun | 0:20e0c61e0684 | 129 | |
ganlikun | 0:20e0c61e0684 | 130 | ssize_t LocalFileHandle::read(void *buffer, size_t length) { |
ganlikun | 0:20e0c61e0684 | 131 | lock(); |
ganlikun | 0:20e0c61e0684 | 132 | ssize_t n = semihost_read(_fh, (unsigned char*)buffer, length, 0); // number of characters not read |
ganlikun | 0:20e0c61e0684 | 133 | n = length - n; // number of characters read |
ganlikun | 0:20e0c61e0684 | 134 | pos += n; |
ganlikun | 0:20e0c61e0684 | 135 | unlock(); |
ganlikun | 0:20e0c61e0684 | 136 | return n; |
ganlikun | 0:20e0c61e0684 | 137 | } |
ganlikun | 0:20e0c61e0684 | 138 | |
ganlikun | 0:20e0c61e0684 | 139 | int LocalFileHandle::isatty() { |
ganlikun | 0:20e0c61e0684 | 140 | lock(); |
ganlikun | 0:20e0c61e0684 | 141 | int ret = semihost_istty(_fh); |
ganlikun | 0:20e0c61e0684 | 142 | unlock(); |
ganlikun | 0:20e0c61e0684 | 143 | return ret; |
ganlikun | 0:20e0c61e0684 | 144 | } |
ganlikun | 0:20e0c61e0684 | 145 | |
ganlikun | 0:20e0c61e0684 | 146 | off_t LocalFileHandle::seek(off_t position, int whence) { |
ganlikun | 0:20e0c61e0684 | 147 | lock(); |
ganlikun | 0:20e0c61e0684 | 148 | if (whence == SEEK_CUR) { |
ganlikun | 0:20e0c61e0684 | 149 | position += pos; |
ganlikun | 0:20e0c61e0684 | 150 | } else if (whence == SEEK_END) { |
ganlikun | 0:20e0c61e0684 | 151 | position += semihost_flen(_fh); |
ganlikun | 0:20e0c61e0684 | 152 | } /* otherwise SEEK_SET, so position is fine */ |
ganlikun | 0:20e0c61e0684 | 153 | |
ganlikun | 0:20e0c61e0684 | 154 | /* Always seems to return -1, so just ignore for now. */ |
ganlikun | 0:20e0c61e0684 | 155 | semihost_seek(_fh, position); |
ganlikun | 0:20e0c61e0684 | 156 | pos = position; |
ganlikun | 0:20e0c61e0684 | 157 | unlock(); |
ganlikun | 0:20e0c61e0684 | 158 | return position; |
ganlikun | 0:20e0c61e0684 | 159 | } |
ganlikun | 0:20e0c61e0684 | 160 | |
ganlikun | 0:20e0c61e0684 | 161 | int LocalFileHandle::sync() { |
ganlikun | 0:20e0c61e0684 | 162 | lock(); |
ganlikun | 0:20e0c61e0684 | 163 | int ret = semihost_ensure(_fh); |
ganlikun | 0:20e0c61e0684 | 164 | unlock(); |
ganlikun | 0:20e0c61e0684 | 165 | return ret; |
ganlikun | 0:20e0c61e0684 | 166 | } |
ganlikun | 0:20e0c61e0684 | 167 | |
ganlikun | 0:20e0c61e0684 | 168 | off_t LocalFileHandle::size() { |
ganlikun | 0:20e0c61e0684 | 169 | lock(); |
ganlikun | 0:20e0c61e0684 | 170 | off_t off = semihost_flen(_fh); |
ganlikun | 0:20e0c61e0684 | 171 | unlock(); |
ganlikun | 0:20e0c61e0684 | 172 | return off; |
ganlikun | 0:20e0c61e0684 | 173 | } |
ganlikun | 0:20e0c61e0684 | 174 | |
ganlikun | 0:20e0c61e0684 | 175 | void LocalFileHandle::lock() { |
ganlikun | 0:20e0c61e0684 | 176 | _mutex.lock(); |
ganlikun | 0:20e0c61e0684 | 177 | } |
ganlikun | 0:20e0c61e0684 | 178 | |
ganlikun | 0:20e0c61e0684 | 179 | void LocalFileHandle::unlock() { |
ganlikun | 0:20e0c61e0684 | 180 | _mutex.unlock(); |
ganlikun | 0:20e0c61e0684 | 181 | } |
ganlikun | 0:20e0c61e0684 | 182 | |
ganlikun | 0:20e0c61e0684 | 183 | class LocalDirHandle : public DirHandle { |
ganlikun | 0:20e0c61e0684 | 184 | |
ganlikun | 0:20e0c61e0684 | 185 | public: |
ganlikun | 0:20e0c61e0684 | 186 | XFINFO info; |
ganlikun | 0:20e0c61e0684 | 187 | |
ganlikun | 0:20e0c61e0684 | 188 | LocalDirHandle() : info() { |
ganlikun | 0:20e0c61e0684 | 189 | } |
ganlikun | 0:20e0c61e0684 | 190 | |
ganlikun | 0:20e0c61e0684 | 191 | virtual int close() { |
ganlikun | 0:20e0c61e0684 | 192 | // No lock can be used in destructor |
ganlikun | 0:20e0c61e0684 | 193 | delete this; |
ganlikun | 0:20e0c61e0684 | 194 | return 0; |
ganlikun | 0:20e0c61e0684 | 195 | } |
ganlikun | 0:20e0c61e0684 | 196 | |
ganlikun | 0:20e0c61e0684 | 197 | virtual int read(struct dirent *ent) { |
ganlikun | 0:20e0c61e0684 | 198 | lock(); |
ganlikun | 0:20e0c61e0684 | 199 | if (xffind("*", &info)!=0) { |
ganlikun | 0:20e0c61e0684 | 200 | unlock(); |
ganlikun | 0:20e0c61e0684 | 201 | return 0; |
ganlikun | 0:20e0c61e0684 | 202 | } |
ganlikun | 0:20e0c61e0684 | 203 | memcpy(ent->d_name, info.name, sizeof(info.name)); |
ganlikun | 0:20e0c61e0684 | 204 | unlock(); |
ganlikun | 0:20e0c61e0684 | 205 | return 1; |
ganlikun | 0:20e0c61e0684 | 206 | } |
ganlikun | 0:20e0c61e0684 | 207 | |
ganlikun | 0:20e0c61e0684 | 208 | virtual void rewind() { |
ganlikun | 0:20e0c61e0684 | 209 | lock(); |
ganlikun | 0:20e0c61e0684 | 210 | info.fileID = 0; |
ganlikun | 0:20e0c61e0684 | 211 | unlock(); |
ganlikun | 0:20e0c61e0684 | 212 | } |
ganlikun | 0:20e0c61e0684 | 213 | |
ganlikun | 0:20e0c61e0684 | 214 | virtual off_t tell() { |
ganlikun | 0:20e0c61e0684 | 215 | lock(); |
ganlikun | 0:20e0c61e0684 | 216 | int fileId = info.fileID; |
ganlikun | 0:20e0c61e0684 | 217 | unlock(); |
ganlikun | 0:20e0c61e0684 | 218 | return fileId; |
ganlikun | 0:20e0c61e0684 | 219 | } |
ganlikun | 0:20e0c61e0684 | 220 | |
ganlikun | 0:20e0c61e0684 | 221 | virtual void seek(off_t offset) { |
ganlikun | 0:20e0c61e0684 | 222 | lock(); |
ganlikun | 0:20e0c61e0684 | 223 | info.fileID = offset; |
ganlikun | 0:20e0c61e0684 | 224 | unlock(); |
ganlikun | 0:20e0c61e0684 | 225 | } |
ganlikun | 0:20e0c61e0684 | 226 | |
ganlikun | 0:20e0c61e0684 | 227 | protected: |
ganlikun | 0:20e0c61e0684 | 228 | PlatformMutex _mutex; |
ganlikun | 0:20e0c61e0684 | 229 | |
ganlikun | 0:20e0c61e0684 | 230 | virtual void lock() { |
ganlikun | 0:20e0c61e0684 | 231 | _mutex.lock(); |
ganlikun | 0:20e0c61e0684 | 232 | } |
ganlikun | 0:20e0c61e0684 | 233 | |
ganlikun | 0:20e0c61e0684 | 234 | virtual void unlock() { |
ganlikun | 0:20e0c61e0684 | 235 | _mutex.unlock(); |
ganlikun | 0:20e0c61e0684 | 236 | } |
ganlikun | 0:20e0c61e0684 | 237 | }; |
ganlikun | 0:20e0c61e0684 | 238 | |
ganlikun | 0:20e0c61e0684 | 239 | int LocalFileSystem::open(FileHandle **file, const char* name, int flags) { |
ganlikun | 0:20e0c61e0684 | 240 | // No global state modified so function is thread safe |
ganlikun | 0:20e0c61e0684 | 241 | |
ganlikun | 0:20e0c61e0684 | 242 | /* reject filenames with / in them */ |
ganlikun | 0:20e0c61e0684 | 243 | for (const char *tmp = name; *tmp; tmp++) { |
ganlikun | 0:20e0c61e0684 | 244 | if (*tmp == '/') { |
ganlikun | 0:20e0c61e0684 | 245 | return -EINVAL; |
ganlikun | 0:20e0c61e0684 | 246 | } |
ganlikun | 0:20e0c61e0684 | 247 | } |
ganlikun | 0:20e0c61e0684 | 248 | |
ganlikun | 0:20e0c61e0684 | 249 | int openmode = posix_to_semihost_open_flags(flags); |
ganlikun | 0:20e0c61e0684 | 250 | if (openmode == OPEN_INVALID) { |
ganlikun | 0:20e0c61e0684 | 251 | return -EINVAL; |
ganlikun | 0:20e0c61e0684 | 252 | } |
ganlikun | 0:20e0c61e0684 | 253 | |
ganlikun | 0:20e0c61e0684 | 254 | FILEHANDLE fh = semihost_open(name, openmode); |
ganlikun | 0:20e0c61e0684 | 255 | if (fh == -1) { |
ganlikun | 0:20e0c61e0684 | 256 | return -EIO; |
ganlikun | 0:20e0c61e0684 | 257 | } |
ganlikun | 0:20e0c61e0684 | 258 | |
ganlikun | 0:20e0c61e0684 | 259 | *file = new LocalFileHandle(fh); |
ganlikun | 0:20e0c61e0684 | 260 | return 0; |
ganlikun | 0:20e0c61e0684 | 261 | } |
ganlikun | 0:20e0c61e0684 | 262 | |
ganlikun | 0:20e0c61e0684 | 263 | int LocalFileSystem::remove(const char *filename) { |
ganlikun | 0:20e0c61e0684 | 264 | // No global state modified so function is thread safe |
ganlikun | 0:20e0c61e0684 | 265 | |
ganlikun | 0:20e0c61e0684 | 266 | return semihost_remove(filename); |
ganlikun | 0:20e0c61e0684 | 267 | } |
ganlikun | 0:20e0c61e0684 | 268 | |
ganlikun | 0:20e0c61e0684 | 269 | int LocalFileSystem::open(DirHandle **dir, const char *name) { |
ganlikun | 0:20e0c61e0684 | 270 | // No global state modified so function is thread safe |
ganlikun | 0:20e0c61e0684 | 271 | |
ganlikun | 0:20e0c61e0684 | 272 | *dir = new LocalDirHandle(); |
ganlikun | 0:20e0c61e0684 | 273 | return 0; |
ganlikun | 0:20e0c61e0684 | 274 | } |
ganlikun | 0:20e0c61e0684 | 275 | |
ganlikun | 0:20e0c61e0684 | 276 | } // namespace mbed |
ganlikun | 0:20e0c61e0684 | 277 | |
ganlikun | 0:20e0c61e0684 | 278 | #endif |
ganlikun | 0:20e0c61e0684 | 279 |