mbed | Mbed

Users » mbed_official » Code » mbed

mbed official / mbed

Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more

drivers/LocalFileSystem.h@129:0ab6a29f35bf, 2016-11-08 (annotated)

Committer:: <>
Date:: Tue Nov 08 17:28:34 2016 +0000
Revision:: 129:0ab6a29f35bf
Parent:: 128:9bcdf88f62b0

Release 129 of the mbed library

Ports for Upcoming Targets

3011: Add u-blox Sara-N target. https://github.com/ARMmbed/mbed-os/pull/3011

3099: MAX32625 https://github.com/ARMmbed/mbed-os/pull/3099

3151: Add support for FRDM-K82F https://github.com/ARMmbed/mbed-os/pull/3151

3177: New mcu k22512 fixing pr 3136 https://github.com/ARMmbed/mbed-os/pull/3177

Fixes and Changes

3008: NUCLEO_F072RB: Fix wrong timer channel number on pwm PB_5 pin https://github.com/ARMmbed/mbed-os/pull/3008

3013: STM32xx - Change how the ADC internal pins are checked before pinmap_ https://github.com/ARMmbed/mbed-os/pull/3013

3041: [nRF5] - added implementation of API of serial port flow control configuration. https://github.com/ARMmbed/mbed-os/pull/3041

3084: [nrf5] fix in Digital I/O : a gpioe pin was uninitialized badly https://github.com/ARMmbed/mbed-os/pull/3084

3009: TRNG enabled. TRNG APIs implemented. REV A/B/C/D flags removed. Warnings removed https://github.com/ARMmbed/mbed-os/pull/3009

3074: Target stm init gcc alignement https://github.com/ARMmbed/mbed-os/pull/3074

2988: Update of can_api.c fixing #2987 https://github.com/ARMmbed/mbed-os/pull/2988

3173: [Exporters] Add a device_name to microbit entry in targets.json https://github.com/ARMmbed/mbed-os/pull/3173

2969: [nRF52] - switch irq priorities of driver handlers to the lowest level https://github.com/ARMmbed/mbed-os/pull/2969

3184: #3183 Compiler warning in trng_api.c with K64F https://github.com/ARMmbed/mbed-os/pull/3184

3104: [NuMaker] Support CAN and fix PWM CLK error https://github.com/ARMmbed/mbed-os/pull/3104

3186: MultiTech mDot - add back SPI3 pins https://github.com/ARMmbed/mbed-os/pull/3186

3075: nsapi - Add standardized return types for size and errors https://github.com/ARMmbed/mbed-os/pull/3075

3221: u-blox odin w2 drivers update https://github.com/ARMmbed/mbed-os/pull/3221

Who changed what in which revision?

User	Revision	Line number	New contents of line
<>	128:9bcdf88f62b0	1	/* mbed Microcontroller Library
<>	128:9bcdf88f62b0	2	* Copyright (c) 2006-2013 ARM Limited
<>	128:9bcdf88f62b0	3	*
<>	128:9bcdf88f62b0	4	* Licensed under the Apache License, Version 2.0 (the "License");
<>	128:9bcdf88f62b0	5	* you may not use this file except in compliance with the License.
<>	128:9bcdf88f62b0	6	* You may obtain a copy of the License at
<>	128:9bcdf88f62b0	7	*
<>	128:9bcdf88f62b0	8	* http://www.apache.org/licenses/LICENSE-2.0
<>	128:9bcdf88f62b0	9	*
<>	128:9bcdf88f62b0	10	* Unless required by applicable law or agreed to in writing, software
<>	128:9bcdf88f62b0	11	* distributed under the License is distributed on an "AS IS" BASIS,
<>	128:9bcdf88f62b0	12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<>	128:9bcdf88f62b0	13	* See the License for the specific language governing permissions and
<>	128:9bcdf88f62b0	14	* limitations under the License.
<>	128:9bcdf88f62b0	15	*/
<>	128:9bcdf88f62b0	16	#ifndef MBED_LOCALFILESYSTEM_H
<>	128:9bcdf88f62b0	17	#define MBED_LOCALFILESYSTEM_H
<>	128:9bcdf88f62b0	18
<>	128:9bcdf88f62b0	19	#include "platform/platform.h"
<>	128:9bcdf88f62b0	20
<>	128:9bcdf88f62b0	21	#if DEVICE_LOCALFILESYSTEM
<>	128:9bcdf88f62b0	22
<>	128:9bcdf88f62b0	23	#include "drivers/FileSystemLike.h"
<>	128:9bcdf88f62b0	24	#include "platform/PlatformMutex.h"
<>	128:9bcdf88f62b0	25
<>	128:9bcdf88f62b0	26	namespace mbed {
<>	128:9bcdf88f62b0	27	/** \addtogroup drivers */
<>	128:9bcdf88f62b0	28	/** @{*/
<>	128:9bcdf88f62b0	29
<>	128:9bcdf88f62b0	30	FILEHANDLE local_file_open(const char* name, int flags);
<>	128:9bcdf88f62b0	31
<>	128:9bcdf88f62b0	32	class LocalFileHandle : public FileHandle {
<>	128:9bcdf88f62b0	33
<>	128:9bcdf88f62b0	34	public:
<>	128:9bcdf88f62b0	35	LocalFileHandle(FILEHANDLE fh);
<>	128:9bcdf88f62b0	36
<>	128:9bcdf88f62b0	37	virtual int close();
<>	128:9bcdf88f62b0	38
<>	128:9bcdf88f62b0	39	virtual ssize_t write(const void *buffer, size_t length);
<>	128:9bcdf88f62b0	40
<>	128:9bcdf88f62b0	41	virtual ssize_t read(void *buffer, size_t length);
<>	128:9bcdf88f62b0	42
<>	128:9bcdf88f62b0	43	virtual int isatty();
<>	128:9bcdf88f62b0	44
<>	128:9bcdf88f62b0	45	virtual off_t lseek(off_t position, int whence);
<>	128:9bcdf88f62b0	46
<>	128:9bcdf88f62b0	47	virtual int fsync();
<>	128:9bcdf88f62b0	48
<>	128:9bcdf88f62b0	49	virtual off_t flen();
<>	128:9bcdf88f62b0	50
<>	128:9bcdf88f62b0	51	protected:
<>	128:9bcdf88f62b0	52	virtual void lock();
<>	128:9bcdf88f62b0	53	virtual void unlock();
<>	128:9bcdf88f62b0	54	FILEHANDLE _fh;
<>	128:9bcdf88f62b0	55	int pos;
<>	128:9bcdf88f62b0	56	PlatformMutex _mutex;
<>	128:9bcdf88f62b0	57	};
<>	128:9bcdf88f62b0	58
<>	128:9bcdf88f62b0	59	/** A filesystem for accessing the local mbed Microcontroller USB disk drive
<>	128:9bcdf88f62b0	60	*
<>	128:9bcdf88f62b0	61	* This allows programs to read and write files on the same disk drive that is used to program the
<>	128:9bcdf88f62b0	62	* mbed Microcontroller. Once created, the standard C file access functions are used to open,
<>	128:9bcdf88f62b0	63	* read and write files.
<>	128:9bcdf88f62b0	64	*
<>	128:9bcdf88f62b0	65	* @Note Synchronization level: Thread safe
<>	128:9bcdf88f62b0	66	*
<>	128:9bcdf88f62b0	67	* Example:
<>	128:9bcdf88f62b0	68	* @code
<>	128:9bcdf88f62b0	69	* #include "mbed.h"
<>	128:9bcdf88f62b0	70	*
<>	128:9bcdf88f62b0	71	* LocalFileSystem local("local"); // Create the local filesystem under the name "local"
<>	128:9bcdf88f62b0	72	*
<>	128:9bcdf88f62b0	73	* int main() {
<>	128:9bcdf88f62b0	74	* FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
<>	128:9bcdf88f62b0	75	* fprintf(fp, "Hello World!");
<>	128:9bcdf88f62b0	76	* fclose(fp);
<>	128:9bcdf88f62b0	77	* remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
<>	128:9bcdf88f62b0	78	*
<>	128:9bcdf88f62b0	79	* DIR *d = opendir("/local"); // Opens the root directory of the local file system
<>	128:9bcdf88f62b0	80	* struct dirent *p;
<>	128:9bcdf88f62b0	81	* while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
<>	128:9bcdf88f62b0	82	* printf("%s\n", p->d_name); // to stdout.
<>	128:9bcdf88f62b0	83	* }
<>	128:9bcdf88f62b0	84	* closedir(d);
<>	128:9bcdf88f62b0	85	* }
<>	128:9bcdf88f62b0	86	* @endcode
<>	128:9bcdf88f62b0	87	*
<>	128:9bcdf88f62b0	88	* @note
<>	128:9bcdf88f62b0	89	* If the microcontroller program makes an access to the local drive, it will be marked as "removed"
<>	128:9bcdf88f62b0	90	* on the Host computer. This means it is no longer accessible from the Host Computer.
<>	128:9bcdf88f62b0	91	*
<>	128:9bcdf88f62b0	92	* The drive will only re-appear when the microcontroller program exists. Note that if the program does
<>	128:9bcdf88f62b0	93	* not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!
<>	128:9bcdf88f62b0	94	*/
<>	128:9bcdf88f62b0	95	class LocalFileSystem : public FileSystemLike {
<>	128:9bcdf88f62b0	96	// No modifiable state
<>	128:9bcdf88f62b0	97
<>	128:9bcdf88f62b0	98	public:
<>	128:9bcdf88f62b0	99	LocalFileSystem(const char* n) : FileSystemLike(n) {
<>	128:9bcdf88f62b0	100
<>	128:9bcdf88f62b0	101	}
<>	128:9bcdf88f62b0	102
<>	128:9bcdf88f62b0	103	virtual FileHandle open(const char name, int flags);
<>	128:9bcdf88f62b0	104	virtual int remove(const char *filename);
<>	128:9bcdf88f62b0	105	virtual DirHandle opendir(const char name);
<>	128:9bcdf88f62b0	106	};
<>	128:9bcdf88f62b0	107
<>	128:9bcdf88f62b0	108	} // namespace mbed
<>	128:9bcdf88f62b0	109
<>	128:9bcdf88f62b0	110	#endif
<>	128:9bcdf88f62b0	111
<>	128:9bcdf88f62b0	112	#endif
<>	128:9bcdf88f62b0	113
<>	128:9bcdf88f62b0	114	/** @}*/