include/hw/block/block.h

   1 /*
   2  * Common code for block device models
   3  *
   4  * Copyright (C) 2012 Red Hat, Inc.
   5  * Copyright (c) 2003-2008 Fabrice Bellard
   6  *
   7  * This work is licensed under the terms of the GNU GPL, version 2 or
   8  * later.  See the COPYING file in the top-level directory.
   9  */
  10
  11 #ifndef HW_BLOCK_H
  12 #define HW_BLOCK_H
  13
  14 #include "exec/hwaddr.h"
  15 #include "qapi/qapi-types-block-core.h"
  16 #include "hw/qdev-properties-system.h"
  17
  18 /* Configuration */
  19
  20 typedef struct BlockConf {
  21     BlockBackend *blk;
  22     OnOffAuto backend_defaults;
  23     uint32_t physical_block_size;
  24     uint32_t logical_block_size;
  25     uint32_t min_io_size;
  26     uint32_t opt_io_size;
  27     int32_t bootindex;
  28     uint32_t discard_granularity;
  29     /* geometry, not all devices use this */
  30     uint32_t cyls, heads, secs;
  31     uint32_t lcyls, lheads, lsecs;
  32     OnOffAuto wce;
  33     bool share_rw;
  34     OnOffAuto account_invalid, account_failed;
  35     BlockdevOnError rerror;
  36     BlockdevOnError werror;
  37 } BlockConf;
  38
  39 static inline unsigned int get_physical_block_exp(BlockConf *conf)
  40 {
  41     unsigned int exp = 0, size;
  42
  43     for (size = conf->physical_block_size;
  44         size > conf->logical_block_size;
  45         size >>= 1) {
  46         exp++;
  47     }
  48
  49     return exp;
  50 }
  51
  52 #define DEFINE_BLOCK_PROPERTIES_BASE(_state, _conf)                     \
  53     DEFINE_PROP_ON_OFF_AUTO("backend_defaults", _state,                 \
  54                             _conf.backend_defaults, ON_OFF_AUTO_AUTO),  \
  55     DEFINE_PROP_BLOCKSIZE("logical_block_size", _state,                 \
  56                           _conf.logical_block_size),                    \
  57     DEFINE_PROP_BLOCKSIZE("physical_block_size", _state,                \
  58                           _conf.physical_block_size),                   \
  59     DEFINE_PROP_SIZE32("min_io_size", _state, _conf.min_io_size, 0),    \
  60     DEFINE_PROP_SIZE32("opt_io_size", _state, _conf.opt_io_size, 0),    \
  61     DEFINE_PROP_SIZE32("discard_granularity", _state,                   \
  62                        _conf.discard_granularity, -1),                  \
  63     DEFINE_PROP_ON_OFF_AUTO("write-cache", _state, _conf.wce,           \
  64                             ON_OFF_AUTO_AUTO),                          \
  65     DEFINE_PROP_BOOL("share-rw", _state, _conf.share_rw, false),        \
  66     DEFINE_PROP_ON_OFF_AUTO("account-invalid", _state,                  \
  67                             _conf.account_invalid, ON_OFF_AUTO_AUTO),   \
  68     DEFINE_PROP_ON_OFF_AUTO("account-failed", _state,                   \
  69                             _conf.account_failed, ON_OFF_AUTO_AUTO)
  70
  71 #define DEFINE_BLOCK_PROPERTIES(_state, _conf)                          \
  72     DEFINE_PROP_DRIVE("drive", _state, _conf.blk),                      \
  73     DEFINE_BLOCK_PROPERTIES_BASE(_state, _conf)
  74
  75 #define DEFINE_BLOCK_CHS_PROPERTIES(_state, _conf)                      \
  76     DEFINE_PROP_UINT32("cyls", _state, _conf.cyls, 0),                  \
  77     DEFINE_PROP_UINT32("heads", _state, _conf.heads, 0),                \
  78     DEFINE_PROP_UINT32("secs", _state, _conf.secs, 0),                  \
  79     DEFINE_PROP_UINT32("lcyls", _state, _conf.lcyls, 0),                \
  80     DEFINE_PROP_UINT32("lheads", _state, _conf.lheads, 0),              \
  81     DEFINE_PROP_UINT32("lsecs", _state, _conf.lsecs, 0)
  82
  83 #define DEFINE_BLOCK_ERROR_PROPERTIES(_state, _conf)                    \
  84     DEFINE_PROP_BLOCKDEV_ON_ERROR("rerror", _state, _conf.rerror,       \
  85                                   BLOCKDEV_ON_ERROR_AUTO),              \
  86     DEFINE_PROP_BLOCKDEV_ON_ERROR("werror", _state, _conf.werror,       \
  87                                   BLOCKDEV_ON_ERROR_AUTO)
  88
  89 /* Backend access helpers */
  90
  91 bool blk_check_size_and_read_all(BlockBackend *blk, DeviceState *dev,
  92                                  void *buf, hwaddr size, Error **errp);
  93
  94 /* Configuration helpers */
  95
  96 bool blkconf_geometry(BlockConf *conf, int *trans,
  97                       unsigned cyls_max, unsigned heads_max, unsigned secs_max,
  98                       Error **errp);
  99 bool blkconf_blocksizes(BlockConf *conf, Error **errp);
 100 bool blkconf_apply_backend_options(BlockConf *conf, bool readonly,
 101                                    bool resizable, Error **errp);
 102
 103 /* Hard disk geometry */
 104
 105 void hd_geometry_guess(BlockBackend *blk,
 106                        uint32_t *pcyls, uint32_t *pheads, uint32_t *psecs,
 107                        int *ptrans);
 108 int hd_bios_chs_auto_trans(uint32_t cyls, uint32_t heads, uint32_t secs);
 109
 110 #endif