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