vdisk.c File Reference

#include <Fs/vdisk.h>
#include <Fs/_gpt.h>
#include <Mm/kmalloc.h>
#include <_null.h>
#include <aucon.h>
#include <Mm/pmmngr.h>
#include <string.h>
#include <stdio.h>
#include <Fs/Dev/devfs.h>

Include dependency graph for vdisk.c:

Functions
void	AuVDiskInitialise ()
	AuVDiskInitialise – initialise the vdisk.
AU_EXTERN AU_EXPORT int	AuVDiskCreateStorageFile (char *output)
	AuVDiskCreateStorageFile – creates a storage directory in device file system.
uint8_t	AuVDiskGetIndex ()
	AuVDiskGetIndex – returns a vdisk index.
AuVDisk *	AuCreateVDisk ()
	AuCreateVDisk – creates a vdisk and return to the caller.
size_t	AuVDiskRead (AuVDisk *disk, uint64_t lba, uint32_t count, uint64_t *buffer)
	AuVDiskRead – reads a disk block from registered disk.
size_t	AuVDiskWrite (AuVDisk *disk, uint64_t lba, uint32_t count, uint64_t *buffer)
	AuVDiskWrite – reads a disk block from registered disk.
void	AuVDiskRegisterPartition (AuVDisk *vdisk)
	AuVDiskRegisterPartition - Gether all informations about the partition for now, only GUID Partition is supported.
void	AuVDiskRegister (AuVDisk *disk)
	AuVDiskRegister – adds a vdisk service to the list.
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.
AuVDisk *	AuGetVDisk (int vdisk_idx)
	AuGetVDisk – get a vdisk from the vdisk array.

Variables
AuVDisk *	VdiskArray [MAX_VDISK_DEVICES]
int	_vdisk_num_

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.

Function Documentation

AuCreateVDisk()

AuVDisk * AuCreateVDisk

(

)

AuCreateVDisk – creates a vdisk and return to the caller.

Returns

return the newly created empty vdisk structure

AuGetVDisk()

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
	)

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
	)

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()

void AuVDiskDestroy

(

AuVDisk *

vdisk

)

AuVDiskDestroy – destroy's a vdisk.

Parameters

vdisk

– pointer to vdisk

AuVDiskGetIndex()

uint8_t AuVDiskGetIndex

(

)

AuVDiskGetIndex – returns a vdisk index.

AuVDiskInitialise()

void AuVDiskInitialise

(

)

AuVDiskInitialise – initialise the vdisk.

AuVDiskRead()

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()

void AuVDiskRegister

(

AuVDisk *

disk

)

AuVDiskRegister – adds a vdisk service to the list.

Parameters

disk	– disk to add

AuVDiskRegisterPartition()

void AuVDiskRegisterPartition

(

AuVDisk *

vdisk

)

AuVDiskRegisterPartition - Gether all informations about the partition for now, only GUID Partition is supported.

Parameters

vdisk

– VDisk structure pointer

AuVDiskWrite()

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

Variable Documentation

_vdisk_num_

int _vdisk_num_

VdiskArray

AuVDisk* VdiskArray[MAX_VDISK_DEVICES]