vdisk.h File Reference

#include <stdint.h>
#include <aurora.h>
#include <Fs/vfs.h>
#include <Fs/_FsGUIDs.h>

Include dependency graph for vdisk.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_au_partition_data_
struct	_VDISK_
struct	_vdisk_info_
struct	_vdisk_partition_info_

Macros
#define	MAX_VDISK_DEVICES   26
#define	MAX_PARTITION_PER_DISK   128

Typedefs
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)
typedef int(*	vdisk_flush) (struct _VDISK_ *disk)
typedef struct _au_partition_data_	AuPartitionData
typedef struct _VDISK_	AuVDisk
typedef struct _vdisk_info_	AuVDiskInfo
typedef struct _vdisk_partition_info_	AuVDiskPartitionInfo

Functions
void	AuVDiskInitialise ()
	AuVDiskInitialise – initialise the vdisk.
AU_EXTERN AU_EXPORT uint8_t	AuVDiskGetIndex ()
	AuVDiskGetIndex – returns a vdisk index.
AU_EXTERN AU_EXPORT void	AuVDiskRegister (AuVDisk *disk)
	AuVDiskRegister – adds a vdisk service to the list.
AU_EXTERN AU_EXPORT AuVDisk *	AuCreateVDisk ()
	AuCreateVDisk – creates a vdisk and return to the caller.
AU_EXTERN AU_EXPORT size_t	AuVDiskRead (AuVDisk *disk, uint64_t lba, uint32_t count, uint64_t *buffer)
	AuVDiskRead – reads a disk block from registered disk.
AU_EXTERN AU_EXPORT size_t	AuVDiskWrite (AuVDisk *disk, uint64_t lba, uint32_t count, uint64_t *buffer)
	AuVDiskWrite – reads a disk block from registered disk.
AU_EXTERN AU_EXPORT int	AuVDiskFlush (AuVDisk *disk)
	AuVDiskFlush – flushes a single registered disk's write cache, if its driver provides one (no-op otherwise)
AU_EXTERN AU_EXPORT void	AuVDiskFlushAll ()
	AuVDiskFlushAll – flushes every registered disk's write cache; meant to be called before power-down/reset so no dirty device-side cache is lost.
AU_EXTERN AU_EXPORT void	AuVDiskDestroy (AuVDisk *vdisk)
	AuVDiskDestroy – destroy's a vdisk.
int	AuGetVDiskInfo (uint8_t vdiskID, void *buffer)
	AuGetVDiskInfo – returns virtual disk information to application.
int	AuGetVDiskPartitionInfo (uint8_t vdiskID, uint8_t partition_ID, void *buffer)
	AuGetVDiskPartitionInfo – get partition information from desired virtual disk.
AU_EXTERN AU_EXPORT int	AuVDiskCreateStorageFile (char *output)
	AuVDiskCreateStorageFile – creates a storage directory in device file system.
AU_EXTERN AU_EXPORT AuVDisk *	AuGetVDisk (int vdisk_idx)
	AuGetVDisk – get a vdisk from the vdisk array.

Detailed Description

BSD 2-Clause License

Copyright (c) 2022-2023, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

MAX_PARTITION_PER_DISK

#define MAX_PARTITION_PER_DISK   128

MAX_VDISK_DEVICES

#define MAX_VDISK_DEVICES   26

Typedef Documentation

AuPartitionData

typedef struct _au_partition_data_ AuPartitionData

AuVDisk

typedef struct _VDISK_ AuVDisk

AuVDiskInfo

typedef struct _vdisk_info_ AuVDiskInfo

AuVDiskPartitionInfo

typedef struct _vdisk_partition_info_ AuVDiskPartitionInfo

vdisk_flush

typedef int(* vdisk_flush) (struct _VDISK_ *disk)

vdisk_read

typedef int(* vdisk_read) (struct _VDISK_ *disk, uint64_t lba, uint32_t count,uint64_t *buffer)

vdisk_write

typedef int(* vdisk_write) (struct _VDISK_ *disk, uint64_t lba, uint32_t count, uint64_t *buffer)

Function Documentation

AuCreateVDisk()

AU_EXTERN AU_EXPORT AuVDisk * AuCreateVDisk

(

)

AuCreateVDisk – creates a vdisk and return to the caller.

Returns

return the newly created empty vdisk structure

AuGetVDisk()

AU_EXTERN AU_EXPORT AuVDisk * AuGetVDisk

(

int

vdisk_idx

)

AuGetVDisk – get a vdisk from the vdisk array.

Parameters

vdisk_idx

– virtual disk index

Returns

the vidisk structure respected to the index

AuGetVDiskInfo()

int AuGetVDiskInfo ( uint8_t  vdiskID, void *  buffer  )

extern

AuGetVDiskInfo – returns virtual disk information to application.

Parameters

vdiskID	– id of vdisk
buffer	– Pointer to memory where to store the information

Returns

0 on success,-1 on failure

AuGetVDiskPartitionInfo()

int AuGetVDiskPartitionInfo ( uint8_t  vdiskID, uint8_t  partition_ID, void *  buffer  )

extern

AuGetVDiskPartitionInfo – get partition information from desired virtual disk.

Parameters

vdiskID	– virtual disk identifier
partitionID	– partition number
buffer	– memory pointer where to store the information

Returns

0 on success, -1 on failure

AuVDiskCreateStorageFile()

AU_EXTERN AU_EXPORT int AuVDiskCreateStorageFile

(

char *

output

)

AuVDiskCreateStorageFile – creates a storage directory in device file system.

Parameters

output

– Pointer to memory where to store composite string value

AuVDiskDestroy()

AU_EXTERN AU_EXPORT void AuVDiskDestroy

(

AuVDisk *

vdisk

)

AuVDiskDestroy – destroy's a vdisk.

Parameters

vdisk

– pointer to vdisk

AuVDiskFlush()

AU_EXTERN AU_EXPORT int AuVDiskFlush

(

AuVDisk *

disk

)

AuVDiskFlush – flushes a single registered disk's write cache, if its driver provides one (no-op otherwise)

Parameters

disk	– Pointer to vdisk structure

Returns

0 on success/no-op, driver-defined non-zero on failure

Parameters

disk	– Pointer to vdisk structure

AuVDiskFlushAll()

AU_EXTERN AU_EXPORT void AuVDiskFlushAll

(

)

AuVDiskFlushAll – flushes every registered disk's write cache; meant to be called before power-down/reset so no dirty device-side cache is lost.

AuVDiskFlushAll – flushes every registered disk's write cache; meant to be called before power-down/reset so no dirty device-side cache is lost.

AuVDiskGetIndex()

AU_EXTERN AU_EXPORT uint8_t AuVDiskGetIndex

(

)

AuVDiskGetIndex – returns a vdisk index.

AuVDiskInitialise()

void AuVDiskInitialise ( )

extern

AuVDiskInitialise – initialise the vdisk.

AuVDiskRead()

AU_EXTERN AU_EXPORT size_t AuVDiskRead	(	AuVDisk *	disk,
		uint64_t	lba,
		uint32_t	count,
		uint64_t *	buffer
	)

AuVDiskRead – reads a disk block from registered disk.

Parameters

disk	– Pointer to vdsik structure
lba	– Linear block address to read
count	– number of blocks to read
buffer	– Buffer, where to store the data

Returns

return the amount of data being read in bytes

AuVDiskRegister()

AU_EXTERN AU_EXPORT void AuVDiskRegister

(

AuVDisk *

disk

)

AuVDiskRegister – adds a vdisk service to the list.

Parameters

disk	– disk to add

make letter /a reserved for root '/'

AuVDiskWrite()

AU_EXTERN AU_EXPORT size_t AuVDiskWrite	(	AuVDisk *	disk,
		uint64_t	lba,
		uint32_t	count,
		uint64_t *	buffer
	)

AuVDiskWrite – reads a disk block from registered disk.

Parameters

disk	– Pointer to vdsik structure
lba	– Linear block address to read
count	– number of blocks to read
buffer	– Buffer, where to store the data

Returns

the amount of data being written in bytes