ReadOnlyBlockDevice.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_READ_ONLY_BLOCK_DEVICE_H
00023 #define MBED_READ_ONLY_BLOCK_DEVICE_H
00024 
00025 #include "BlockDevice.h"
00026 #include "PlatformMutex.h"
00027 
00028 
00029 class ReadOnlyBlockDevice : public BlockDevice
00030 {
00031 public:
00032 
00033     /** Lifetime of the block device
00034      *
00035      * @param bd        Block device to wrap as read only
00036      */
00037     ReadOnlyBlockDevice(BlockDevice *bd);
00038     virtual ~ReadOnlyBlockDevice();
00039 
00040     /** Initialize a block device
00041      *
00042      *  @return         0 on success or a negative error code on failure
00043      */
00044     virtual int init();
00045 
00046     /** Deinitialize a block device
00047      *
00048      *  @return         0 on success or a negative error code on failure
00049      */
00050     virtual int deinit();
00051 
00052     /** Read blocks from a block device
00053      *
00054      *  @param buffer   Buffer to read blocks into
00055      *  @param addr     Address of block to begin reading from
00056      *  @param size     Size to read in bytes, must be a multiple of read block size
00057      *  @return         0 on success, negative error code on failure
00058      */
00059     virtual int read(void *buffer, bd_addr_t addr, bd_size_t size);
00060 
00061     /** Program blocks to a block device
00062      *
00063      *  The blocks must have been erased prior to being programmed
00064      *
00065      *  @param buffer   Buffer of data to write to blocks
00066      *  @param addr     Address of block to begin writing to
00067      *  @param size     Size to write in bytes, must be a multiple of program block size
00068      *  @return         0 on success, negative error code on failure
00069      */
00070     virtual int program(const void *buffer, bd_addr_t addr, bd_size_t size);
00071 
00072     /** Erase blocks on a block device
00073      *
00074      *  The state of an erased block is undefined until it has been programmed
00075      *
00076      *  @param addr     Address of block to begin erasing
00077      *  @param size     Size to erase in bytes, must be a multiple of erase block size
00078      *  @return         0 on success, negative error code on failure
00079      */
00080     virtual int erase(bd_addr_t addr, bd_size_t size);
00081 
00082     /** Get the size of a readable block
00083      *
00084      *  @return         Size of a readable block in bytes
00085      */
00086     virtual bd_size_t get_read_size() const;
00087 
00088     /** Get the size of a programmable block
00089      *
00090      *  @return         Size of a programmable block in bytes
00091      */
00092     virtual bd_size_t get_program_size() const;
00093 
00094     /** Get the size of a erasable block
00095      *
00096      *  @return         Size of a erasable block in bytes
00097      */
00098     virtual bd_size_t get_erase_size() const;
00099 
00100     /** Get the total size of the underlying device
00101      *
00102      *  @return         Size of the underlying device in bytes
00103      */
00104     virtual bd_size_t size() const;
00105 
00106 private:
00107     BlockDevice *_bd;
00108 };
00109 
00110 
00111 
00112 #endif