block_driver.hpp

#if !defined(__BLOCK_DRIVER_HPP__)
#define __BLOCK_DRIVER_HPP__

//
// local includes
//
#include "core/drivers/drivers.hpp"

struct block_driver_constants
{
    static const l4_sector_t MIN_SECTOR_NUMBER = 1024;
    static const uint16_t    SECTOR_SIZE       = 512;

    static_assert(is_unsigned<l4_sector_t>::conforms,
                  "l4_sector_t must be an unsigned integer");

    //
    // keep in sync with ata_drive::state_flags_constants
    //
    enum state_flags_constants
    {
        READONLY    = 0x01,
        FLUSHABLE   = 0x02,
        READY       = 0x04,

        ALL_MASK    = READONLY | FLUSHABLE | READY
    };

    typedef bitmask<uint_value_t<ALL_MASK>::least> state_flags;
    static_assert(integer_traits<state_flags::word_type>::const_max >= ALL_MASK,
                  "state_flags's max value is too small");
};

struct block_driver : public block_driver_constants
{
    virtual inline ~block_driver(void)
    {}

    virtual const char *name(void) const = 0;

    virtual bool is(state_flags flags) const = 0;

    virtual const state_flags state(void) const = 0;

    virtual int reset(void) = 0;

    //
    // medium functions
    //
    virtual l4_sector_t sectors(void) const = 0;

    virtual int read_sectors(uint8_t *buffer, l4_sector_t sector, l4_sector_t number) = 0;

    virtual int write_sectors(uint8_t *buffer, l4_sector_t sector, l4_sector_t number) = 0;

    virtual int flush_sectors(void) = 0;
};

#endif

// ***** end of source ***** //