bertos/io/kblock.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \author Francesco Sacchi <batt@develer.com>
  34  *
  35  * \brief KBlock interface
  36  *
  37  * $WIZ$ module_name = "kblock"
  38  */
  39
  40 #ifndef IO_KBLOCK_H
  41 #define IO_KBLOCK_H
  42
  43 #include <cfg/compiler.h>
  44 #include <cfg/debug.h>
  45 #include <cfg/macros.h>
  46
  47 /** Type for addressing blocks in the device. */
  48 typedef uint32_t block_idx_t;
  49
  50 // Fwd Declaration
  51 struct KBlock;
  52
  53 /**
  54  * \name Prototypes for KBlock low level access functions.
  55  *
  56  * When writing a driver implementing the KBlock interface you can choose which
  57  * function subset to implement, but you have to set to NULL unimplemented
  58  * features.
  59  *
  60  *  \{
  61  */
  62 typedef size_t (* kblock_read_direct_t)  (struct KBlock *b, block_idx_t index, void *buf, size_t offset, size_t size);
  63 typedef size_t (* kblock_write_direct_t) (struct KBlock *b, block_idx_t index, const void *buf, size_t offset, size_t size);
  64
  65 typedef size_t (* kblock_read_t)        (struct KBlock *b, void *buf, size_t offset, size_t size);
  66 typedef size_t (* kblock_write_t)       (struct KBlock *b, const void *buf, size_t offset, size_t size);
  67 typedef int    (* kblock_load_t)        (struct KBlock *b, block_idx_t index);
  68 typedef int    (* kblock_store_t)       (struct KBlock *b, block_idx_t index);
  69
  70 typedef int    (* kblock_error_t)       (struct KBlock *b);
  71 typedef void   (* kblock_clearerr_t)    (struct KBlock *b);
  72 typedef int    (* kblock_close_t)       (struct KBlock *b);
  73 /* \} */
  74
  75 /**
  76  * Table of interface functions for a KBlock device.
  77  */
  78 typedef struct KBlockVTable
  79 {
  80         kblock_read_direct_t readDirect;
  81         kblock_write_direct_t writeDirect;
  82
  83         kblock_read_t  readBuf;
  84         kblock_write_t writeBuf;
  85         kblock_load_t  load;
  86         kblock_store_t store;
  87
  88         kblock_error_t    error;    ///< \sa kblock_error()
  89         kblock_clearerr_t clearerr; ///< \sa kblock_clearerr()
  90
  91         kblock_close_t  close; ///< \sa kblock_close()
  92 } KBlockVTable;
  93
  94
  95 #define KB_BUFFERED    BV(0) ///< Internal flag: true if the KBlock has a buffer
  96 #define KB_CACHE_DIRTY BV(1) ///< Internal flag: true if the cache is dirty
  97 #define KB_PARTIAL_WRITE BV(2) ///< Internal flag: true if the device allows partial block write
  98
  99 /**
 100  * KBlock private members.
 101  * These are the private members of the KBlock interface, please do not
 102  * access these directly, use the KBlock API.
 103  */
 104 typedef struct KBlockPriv
 105 {
 106         DB(id_t type);         ///< Used to keep track, at runtime, of the class type.
 107         int flags;             ///< Status and error flags.
 108         void *buf;             ///< Pointer to the page buffer for RAM-cached KBlocks.
 109         block_idx_t blk_start; ///< Start block number when the device is trimmed. \sa kblock_trim().
 110         block_idx_t curr_blk;  ///< Current cached block number in cached KBlocks.
 111
 112         const struct KBlockVTable *vt; ///< Virtual table of interface functions.
 113 } KBlockPriv;
 114
 115 /**
 116  * KBlock: interface for a generic block device.
 117  *
 118  * A block device is a device which can only be read/written
 119  * with data blocks of constant size: flash memories,
 120  * SD cards, hard disks, etc...
 121  *
 122  * This interface is designed to adapt to most block devices and
 123  * use peculiar features in order to save CPU time and memory space.
 124  *
 125  * You do not have to use this structure directly, specific implementations
 126  * will be supplied in the peripheral drivers.
 127  */
 128 typedef struct KBlock
 129 {
 130         KBlockPriv priv;         ///< Interface private data, do not use directly.
 131
 132         /* Public access members */
 133         size_t blk_size;         ///< Block size.
 134         block_idx_t blk_cnt;     ///< Number of blocks available in the device.
 135 } KBlock;
 136
 137
 138 /**
 139  * Use a subset of the blocks on the device.
 140  *
 141  * This function is useful for partitioning a device and use it for
 142  * different purposes at the same time.
 143  *
 144  * This function will limit the number of blocks used on the device by setting
 145  * a start index and a number of blocks to be used counting from that index.
 146  *
 147  * The blocks outside this range are no more accessible.
 148  *
 149  * Logical block indexes will be mapped to physical indexes inside this new
 150  * range automatically. Even following calls to kblock_trim() will use logical
 151  * indexes, so, once trimmed, access can only be limited further and never
 152  * expanded back.
 153  *
 154  * Example:
 155  * \code
 156  * //...init KBlock device dev
 157  * kblock_trim(dev, 200, 1500); // Restrict access to the 200-1700 physical block range.
 158  * kblock_read(dev, 0, buf, 0, dev->blk_size);  // Read from physical block #200.
 159  * kblock_trim(dev, 0, 300); // Restrict access to the 200-500 physical block range.
 160  * \endcode
 161  *
 162  * \param b KBlock device.
 163  * \param start The index of the start block for the limiting window in logical addressing units.
 164  * \param count The number of blocks to be used.
 165  *
 166  */
 167 INLINE void kblock_trim(struct KBlock *b, block_idx_t start, block_idx_t count)
 168 {
 169         ASSERT(start + count <= b->blk_cnt);
 170         b->priv.blk_start += start;
 171         b->blk_cnt = count;
 172 }
 173
 174
 175 #define KB_ASSERT_METHOD(b, method) \
 176         do \
 177         { \
 178                 ASSERT(b); \
 179                 ASSERT((b)->priv.vt); \
 180                 ASSERT((b)->priv.vt->method); \
 181         } \
 182         while (0)
 183
 184
 185 /**
 186  * Get the current errors for the device.
 187  *
 188  * \note Calling this function will not clear the errors.
 189  *
 190  * \param b KBlock device.
 191  *
 192  * \return 0 if no error is present, a driver specific mask of errors otherwise.
 193  *
 194  * \sa kblock_clearerr()
 195  */
 196 INLINE int kblock_error(struct KBlock *b)
 197 {
 198         KB_ASSERT_METHOD(b, error);
 199         return b->priv.vt->error(b);
 200 }
 201
 202 /**
 203  * Clear the errors of the device.
 204  *
 205  * \param b KBlock device.
 206  *
 207  *
 208  * \sa kblock_error()
 209  */
 210 INLINE void kblock_clearerr(struct KBlock *b)
 211 {
 212         KB_ASSERT_METHOD(b, clearerr);
 213         b->priv.vt->clearerr(b);
 214 }
 215
 216
 217 /**
 218  * Flush the cache (if any) to the device.
 219  *
 220  * This function will write any pending modifications to the device.
 221  * If the device does not have a cache, this function will do nothing.
 222  *
 223  * \return 0 if all is OK, EOF on errors.
 224  * \sa kblock_read(), kblock_write(), kblock_buffered().
 225  */
 226 int kblock_flush(struct KBlock *b);
 227
 228 /**
 229  * Close the device.
 230  *
 231  * \param b KBlock device.
 232  *
 233  * \return 0 on success, EOF on errors.
 234  */
 235 INLINE int kblock_close(struct KBlock *b)
 236 {
 237         KB_ASSERT_METHOD(b, close);
 238         return kblock_flush(b) | b->priv.vt->close(b);
 239 }
 240
 241 /**
 242  * \return true if the device \a b is buffered, false otherwise.
 243  * \param b KBlock device.
 244  * \sa kblock_cachedBlock(), kblock_cacheDirty().
 245  */
 246 INLINE bool kblock_buffered(struct KBlock *b)
 247 {
 248         ASSERT(b);
 249         return (b->priv.flags & KB_BUFFERED);
 250 }
 251
 252
 253 /**
 254  * \return The current cached block number if the device is buffered.
 255  * \param b KBlock device.
 256  * \note   This function will throw an ASSERT if called on a non buffered KBlock.
 257  * \sa kblock_buffered(), kblock_cacheDirty().
 258  */
 259 INLINE block_idx_t kblock_cachedBlock(struct KBlock *b)
 260 {
 261         ASSERT(kblock_buffered(b));
 262         return b->priv.curr_blk;
 263 }
 264
 265
 266 /**
 267  * Return the status of the internal cache.
 268  *
 269  * \param b KBlock device.
 270  * \return If the device supports buffering, returns true if the cache is dirty,
 271  *         false if the cache is clean and coherent with device content.
 272  * \note   This function will throw an ASSERT if called on a non buffered KBlock.
 273  * \sa kblock_cachedBlock(), kblock_buffered().
 274  */
 275 INLINE bool kblock_cacheDirty(struct KBlock *b)
 276 {
 277         ASSERT(kblock_buffered(b));
 278         return kblock_buffered(b) && (b->priv.flags & KB_CACHE_DIRTY);
 279 }
 280
 281 /**
 282  * \return true if the device \a b supports partial block write. That is, you
 283  *         can call kblock_write() with a size which is lesser than the block
 284  *         size.
 285  * \param b KBlock device.
 286  * \sa kblock_write().
 287  */
 288 INLINE bool kblock_partialWrite(struct KBlock *b)
 289 {
 290         ASSERT(b);
 291         return (b->priv.flags & KB_PARTIAL_WRITE);
 292 }
 293
 294 /**
 295  * Read data from the block device.
 296  *
 297  * This function will read \a size bytes from block \a idx starting at
 298  * address \a offset inside the block.
 299  *
 300  * Most block devices (almost all flash memories, for instance),
 301  * can efficiently read even a part of the block.
 302  *
 303  * \note This function can be slow if you try to partial read a block from
 304  *       a device which does not support partial block reads and is opened
 305  *       in unbuffered mode.
 306  *
 307  * \param b KBlock device.
 308  * \param idx the block number where you want to read.
 309  * \param buf a buffer where the data will be read.
 310  * \param offset the offset inside the block from which data reading will start.
 311  * \param size the size of data to be read.
 312  *
 313  * \return the number of bytes read.
 314  *
 315  * \sa kblock_write().
 316  */
 317 size_t kblock_read(struct KBlock *b, block_idx_t idx, void *buf, size_t offset, size_t size);
 318
 319
 320 /**
 321  * Write data to the block device.
 322  *
 323  * This function will write \a size bytes to block \a idx starting at
 324  * address \a offset inside the block.
 325  *
 326  * \note Partial block writes are supported only on certain devices.
 327  *       You can use kblock_partialWrite() in order to check if the device
 328  *       has this feature or not.
 329  *
 330  * \note If the device is opened in buffered mode, this function will use
 331  *       efficiently and trasparently the cache provided.
 332  *       In order to be sure that all modifications are actually written
 333  *       to the device you have to call kblock_flush().
 334  *
 335  * \param b KBlock device.
 336  * \param idx the block number where you want to write.
 337  * \param buf a pointer to the data to be written.
 338  * \param offset the offset inside the block from which data writing will start.
 339  * \param size the size of data to be written.
 340  *
 341  * \return the number of bytes written.
 342  *
 343  * \sa kblock_read(), kblock_flush(), kblock_buffered(), kblock_partialWrite().
 344  */
 345 size_t kblock_write(struct KBlock *b, block_idx_t idx, const void *buf, size_t offset, size_t size);
 346
 347 /**
 348  * Copy one block to another.
 349  *
 350  * This function will copy the content of block \a src to block \a dest.
 351  *
 352  * \note This function is available only on devices which support partial
 353  *       block write or are opened in buffered mode.
 354  *
 355  * \param b KBlock device.
 356  * \param src source block number.
 357  * \param dest destination block number.
 358  *
 359  * \return 0 if all is OK, EOF on errors.
 360  */
 361 int kblock_copy(struct KBlock *b, block_idx_t src, block_idx_t dest);
 362
 363 int kblock_swLoad(struct KBlock *b, block_idx_t index);
 364 int kblock_swStore(struct KBlock *b, block_idx_t index);
 365 size_t kblock_swReadBuf(struct KBlock *b, void *buf, size_t offset, size_t size);
 366 size_t kblock_swWriteBuf(struct KBlock *b, const void *buf, size_t offset, size_t size);
 367 int kblock_swClose(struct KBlock *b);
 368
 369 #endif /* IO_KBLOCK_H */