ObservingBlockDevice.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2017-2017 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_OBSERVING_BLOCK_DEVICE_H
00023 #define MBED_OBSERVING_BLOCK_DEVICE_H
00024 
00025 #include "BlockDevice.h"
00026 #include "PlatformMutex.h"
00027 #include "Callback.h"
00028 
00029 
00030 class ObservingBlockDevice : public BlockDevice
00031 {
00032 public:
00033 
00034     /** Lifetime of the block device
00035      *
00036      * @param bd        Block device to observe
00037      */
00038     ObservingBlockDevice(BlockDevice *bd);
00039     virtual ~ObservingBlockDevice();
00040 
00041     /** Attach a callback which is called on change
00042      *
00043      *  @param cb       Function to call on filesystem change (erase or program)
00044      */
00045     void attach(mbed::Callback<void(BlockDevice *)> cb);
00046 
00047     /** Initialize a block device
00048      *
00049      *  @return         0 on success or a negative error code on failure
00050      */
00051     virtual int init();
00052 
00053     /** Deinitialize a block device
00054      *
00055      *  @return         0 on success or a negative error code on failure
00056      */
00057     virtual int deinit();
00058 
00059     /** Read blocks from a block device
00060      *
00061      *  @param buffer   Buffer to read blocks into
00062      *  @param addr     Address of block to begin reading from
00063      *  @param size     Size to read in bytes, must be a multiple of read block size
00064      *  @return         0 on success, negative error code on failure
00065      */
00066     virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
00067 
00068     /** Program blocks to a block device
00069      *
00070      *  The blocks must have been erased prior to being programmed
00071      *
00072      *  @param buffer   Buffer of data to write to blocks
00073      *  @param addr     Address of block to begin writing to
00074      *  @param size     Size to write in bytes, must be a multiple of program block size
00075      *  @return         0 on success, negative error code on failure
00076      */
00077     virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
00078 
00079     /** Erase blocks on a block device
00080      *
00081      *  The state of an erased block is undefined until it has been programmed
00082      *
00083      *  @param addr     Address of block to begin erasing
00084      *  @param size     Size to erase in bytes, must be a multiple of erase block size
00085      *  @return         0 on success, negative error code on failure
00086      */
00087     virtual int erase(bd_addr_t addr, bd_size_t size);
00088 
00089     /** Get the size of a readable block
00090      *
00091      *  @return         Size of a readable block in bytes
00092      */
00093     virtual bd_size_t get_read_size() const;
00094 
00095     /** Get the size of a programmable block
00096      *
00097      *  @return         Size of a programmable block in bytes
00098      */
00099     virtual bd_size_t get_program_size() const;
00100 
00101     /** Get the size of a erasable block
00102      *
00103      *  @return         Size of a erasable block in bytes
00104      */
00105     virtual bd_size_t get_erase_size() const;
00106 
00107     /** Get the total size of the underlying device
00108      *
00109      *  @return         Size of the underlying device in bytes
00110      */
00111     virtual bd_size_t size() const;
00112 
00113 private:
00114     BlockDevice *_bd;
00115     mbed::Callback<void(BlockDevice *)> _change;
00116 };
00117 
00118 
00119 
00120 #endif