vdisk.h

Go to the documentation of this file.

 
/*
 * Here, Aurora kernel, the virtual disk service registers
 * each disk drives present in the system , for example
 * a system might have two AHCI/SATA drives in two port connected
 * and one NVMe drive, so there will be total three Virtaul Disk
 * registered to each connected physical disk, and each 
 * physical disk will have number of partitions, and the maximum
 * available partition should be 128 because GPT only supports
 * 16 partitions
 */
 
#ifndef __VDISK_H__
#define __VDISK_H__
 
#include <stdint.h>
#include <aurora.h>
#include <Fs/vfs.h>
#include <Fs/_FsGUIDs.h>
 
 
#define MAX_VDISK_DEVICES 26
#define MAX_PARTITION_PER_DISK 128
 
struct _VDISK_;
 
typedef int(*vdisk_read) (struct _VDISK_ *disk, uint64_t lba, uint32_t count ,uint64_t* buffer);
typedef int(*vdisk_write) (struct _VDISK_ *disk, uint64_t lba, uint32_t count, uint64_t *buffer);
/* driver-level write-cache flush (VIRTIO_BLK_T_FLUSH / ATA_CMD_CACHE_FLUSH
 * type thing), left NULL by drivers that dont implement one yet. added at
 * the end of AuVDisk so existing field offsets dont move, but every
 * AuVDiskRegister() caller still has to get its struct from
 * AuCreateVDisk() (kernel-side alloc+memset, so this field comes back
 * NULL) instead of kmalloc'ing or declaring its own AuVDisk. otherwise a
 * driver built against an older copy of this header leaves Flush
 * uninitialized and AuVDiskFlushAll() jumps to garbage on shutdown --axiss */
typedef int(*vdisk_flush) (struct _VDISK_ *disk);
 
/* will needed in future */
typedef struct _au_partition_data_ {
    uint64_t startingLBA;
    uint64_t lastLBA;
    uint64_t maxBlocks;
    GUID part_guid;
    GUID part_unique_guid;
}AuPartitionData;
 
 
//#pragma pack(push,1)
/*  vdisk structures */
typedef struct _VDISK_ {
    char diskname[40];
    char serialNumber[20];
    char diskPath[32];
    void* data;
    uint64_t max_blocks;
    uint64_t blockSize;
    uint8_t __VDiskID;
 
    //----------------------//
    // partition specific   //
    //----------------------//
    // Actually it should   //
    // look like :         //
    // AuPartition part[MAX_PARTITION_PER_DISK] //
    uint8_t num_partition;
    uint64_t startingLBA;
    uint64_t currentLBA;
 
    /* for now only 1 partition 
     * is supported 
     */
    GUID part_guid;
    GUID part_unique_guid;
    /* mounted file system of
     * the part 
     */
    AuVFSNode* fsys;
    
    //----------------------//
    //   disk specific      //
    //=======================//
    vdisk_read Read;
    vdisk_write Write;
    vdisk_flush Flush;
    /* more device specific functions
     * needs to be added like eject
     */
}AuVDisk;
//#pragma pack(pop)
 
#ifdef ARCH_X64
#pragma pack(push,1)
#endif
typedef struct _vdisk_info_ {
    char diskname[40];
    char serialNumber[20];
    uint8_t vDiskID;
    int num_partition;
    uint64_t maxBlocks;
    uint64_t blocksSize;
}AuVDiskInfo;
#ifdef ARCH_X64
#pragma pack(pop)
#endif
 
#ifdef ARCH_X64
#pragma pack(push,1)
#endif
typedef struct _vdisk_partition_info_ {
    char mountedName[32];
    GUID partitionGUID;
    GUID uniqueGUID;
    uint64_t startingLBA;
}AuVDiskPartitionInfo;
#ifdef ARCH_X64
#pragma pack(pop)
#endif
 
 
 
 
extern void AuVDiskInitialise();
 
AU_EXTERN AU_EXPORT uint8_t AuVDiskGetIndex();
 
 
AU_EXTERN AU_EXPORT void AuVDiskRegister(AuVDisk* disk);
 
AU_EXTERN AU_EXPORT AuVDisk *AuCreateVDisk();
 
 
AU_EXTERN AU_EXPORT size_t AuVDiskRead(AuVDisk *disk, uint64_t lba, uint32_t count, uint64_t* buffer);
 
AU_EXTERN AU_EXPORT size_t AuVDiskWrite(AuVDisk* disk, uint64_t lba, uint32_t count, uint64_t* buffer);
 
AU_EXTERN AU_EXPORT int AuVDiskFlush(AuVDisk* disk);
 
AU_EXTERN AU_EXPORT void AuVDiskFlushAll();
 
AU_EXTERN AU_EXPORT void AuVDiskDestroy(AuVDisk *vdisk);
 
extern int AuGetVDiskInfo(uint8_t vdiskID, void* buffer);
 
extern int AuGetVDiskPartitionInfo(uint8_t vdiskID, uint8_t partition_ID, void* buffer);
 
AU_EXTERN AU_EXPORT int AuVDiskCreateStorageFile(char* output);
 
AU_EXTERN AU_EXPORT AuVDisk* AuGetVDisk(int vdisk_idx);
#endif