Disk.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef MACHINE_DISK_H
#define MACHINE_DISK_H

#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/machine/Device.h"
#include "pedigree/kernel/processor/types.h"

class String;

class EXPORTED_PUBLIC Disk : public Device
{
  public:
    enum SubType
    {
        ATA = 0,
        ATAPI
    };

    Disk();
    Disk(Device *p);
    virtual ~Disk();

    virtual Type getType();

    virtual SubType getSubType();

    virtual void getName(String &str);

    virtual void dump(String &str);

    virtual uintptr_t read(uint64_t location);

    virtual void write(uint64_t location);

    virtual void align(uint64_t location);

    virtual size_t getSize() const;

    virtual size_t getBlockSize() const;

    virtual void pin(uint64_t location);

    virtual void unpin(uint64_t location);

    virtual bool cacheIsCritical();

    virtual void flush(uint64_t location);
};

#endif