xref: /openbmc/qemu/include/hw/block/block.h (revision 79e42085)
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 
17 /* Configuration */
18 
19 typedef struct BlockConf {
20     BlockBackend *blk;
21     uint16_t physical_block_size;
22     uint16_t logical_block_size;
23     uint16_t min_io_size;
24     uint32_t opt_io_size;
25     int32_t bootindex;
26     uint32_t discard_granularity;
27     /* geometry, not all devices use this */
28     uint32_t cyls, heads, secs;
29     OnOffAuto wce;
30     bool share_rw;
31     BlockdevOnError rerror;
32     BlockdevOnError werror;
33 } BlockConf;
34 
35 static inline unsigned int get_physical_block_exp(BlockConf *conf)
36 {
37     unsigned int exp = 0, size;
38 
39     for (size = conf->physical_block_size;
40         size > conf->logical_block_size;
41         size >>= 1) {
42         exp++;
43     }
44 
45     return exp;
46 }
47 
48 #define DEFINE_BLOCK_PROPERTIES_BASE(_state, _conf)                     \
49     DEFINE_PROP_BLOCKSIZE("logical_block_size", _state,                 \
50                           _conf.logical_block_size),                    \
51     DEFINE_PROP_BLOCKSIZE("physical_block_size", _state,                \
52                           _conf.physical_block_size),                   \
53     DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0),  \
54     DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0),    \
55     DEFINE_PROP_UINT32("discard_granularity", _state, \
56                        _conf.discard_granularity, -1), \
57     DEFINE_PROP_ON_OFF_AUTO("write-cache", _state, _conf.wce, \
58                             ON_OFF_AUTO_AUTO), \
59     DEFINE_PROP_BOOL("share-rw", _state, _conf.share_rw, false)
60 
61 #define DEFINE_BLOCK_PROPERTIES(_state, _conf)                          \
62     DEFINE_PROP_DRIVE("drive", _state, _conf.blk),                      \
63     DEFINE_BLOCK_PROPERTIES_BASE(_state, _conf)
64 
65 #define DEFINE_BLOCK_CHS_PROPERTIES(_state, _conf)      \
66     DEFINE_PROP_UINT32("cyls", _state, _conf.cyls, 0),  \
67     DEFINE_PROP_UINT32("heads", _state, _conf.heads, 0), \
68     DEFINE_PROP_UINT32("secs", _state, _conf.secs, 0)
69 
70 #define DEFINE_BLOCK_ERROR_PROPERTIES(_state, _conf)                    \
71     DEFINE_PROP_BLOCKDEV_ON_ERROR("rerror", _state, _conf.rerror,       \
72                                   BLOCKDEV_ON_ERROR_AUTO),              \
73     DEFINE_PROP_BLOCKDEV_ON_ERROR("werror", _state, _conf.werror,       \
74                                   BLOCKDEV_ON_ERROR_AUTO)
75 
76 /* Backend access helpers */
77 
78 bool blk_check_size_and_read_all(BlockBackend *blk, void *buf, hwaddr size,
79                                  Error **errp);
80 
81 /* Configuration helpers */
82 
83 bool blkconf_geometry(BlockConf *conf, int *trans,
84                       unsigned cyls_max, unsigned heads_max, unsigned secs_max,
85                       Error **errp);
86 void blkconf_blocksizes(BlockConf *conf);
87 bool blkconf_apply_backend_options(BlockConf *conf, bool readonly,
88                                    bool resizable, Error **errp);
89 
90 /* Hard disk geometry */
91 
92 void hd_geometry_guess(BlockBackend *blk,
93                        uint32_t *pcyls, uint32_t *pheads, uint32_t *psecs,
94                        int *ptrans);
95 int hd_bios_chs_auto_trans(uint32_t cyls, uint32_t heads, uint32_t secs);
96 
97 #endif
98