jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <Kernel/Devices/Device.h>
30
31namespace Kernel {
32
33class BlockDevice : public Device {
34public:
35 virtual ~BlockDevice() override;
36
37 size_t block_size() const { return m_block_size; }
38 virtual bool is_seekable() const override { return true; }
39
40 bool read_block(unsigned index, u8*) const;
41 bool write_block(unsigned index, const u8*);
42 bool read_raw(u32 offset, unsigned length, u8*) const;
43 bool write_raw(u32 offset, unsigned length, const u8*);
44
45 virtual bool read_blocks(unsigned index, u16 count, u8*) = 0;
46 virtual bool write_blocks(unsigned index, u16 count, const u8*) = 0;
47
48protected:
49 BlockDevice(unsigned major, unsigned minor, size_t block_size = PAGE_SIZE)
50 : Device(major, minor)
51 , m_block_size(block_size)
52 {
53 }
54
55private:
56 virtual bool is_block_device() const final { return true; }
57
58 size_t m_block_size { 0 };
59};
60
61}