OcAppleRamDiskLib.h File Reference

#include <Protocol/AppleRamDisk.h>
#include <Protocol/SimpleFileSystem.h>

Go to the source code of this file.

Functions
CONST APPLE_RAM_DISK_EXTENT_TABLE *	OcAppleRamDiskAllocate (IN UINTN Size, IN EFI_MEMORY_TYPE MemoryType)
BOOLEAN	OcAppleRamDiskRead (IN CONST APPLE_RAM_DISK_EXTENT_TABLE *ExtentTable, IN UINTN Offset, IN UINTN Size, OUT VOID *Buffer)
BOOLEAN	OcAppleRamDiskWrite (IN CONST APPLE_RAM_DISK_EXTENT_TABLE *ExtentTable, IN UINTN Offset, IN UINTN Size, IN CONST VOID *Buffer)
BOOLEAN	OcAppleRamDiskLoadFile (IN OUT CONST APPLE_RAM_DISK_EXTENT_TABLE *ExtentTable, IN EFI_FILE_PROTOCOL *File, IN UINTN FileSize)
VOID	OcAppleRamDiskFree (IN CONST APPLE_RAM_DISK_EXTENT_TABLE *ExtentTable)

Detailed Description

Apple RAM Disk library.

Copyright (C) 2019, Download-Fritz. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file OcAppleRamDiskLib.h.

Function Documentation

OcAppleRamDiskAllocate()

CONST APPLE_RAM_DISK_EXTENT_TABLE * OcAppleRamDiskAllocate	(	IN UINTN	Size,
		IN EFI_MEMORY_TYPE	MemoryType )

Request allocation of Size bytes in extents table.

Parameters

[in]	Size	Requested memory size.
[in]	MemoryType	Requested memory type.

Return values

Allocated

extent table.

Definition at line 322 of file OcAppleRamDiskLib.c.

OcAppleRamDiskFree()

VOID OcAppleRamDiskFree

(

IN CONST APPLE_RAM_DISK_EXTENT_TABLE *

ExtentTable

)

Free RAM disk.

Parameters

[in]

ExtentTable

Allocated extent table.

Definition at line 602 of file OcAppleRamDiskLib.c.

OcAppleRamDiskLoadFile()

BOOLEAN OcAppleRamDiskLoadFile	(	IN OUT CONST APPLE_RAM_DISK_EXTENT_TABLE *	ExtentTable,
		IN EFI_FILE_PROTOCOL *	File,
		IN UINTN	FileSize )

Load file into RAM disk as it is.

Parameters

[in]	ExtentTable	Allocated extent table.
[in]	File	File protocol open for reading.
[in]	FileSize	Amount of data to write.

Return values

TRUE	on success.

OcAppleRamDiskRead()

BOOLEAN OcAppleRamDiskRead	(	IN CONST APPLE_RAM_DISK_EXTENT_TABLE *	ExtentTable,
		IN UINTN	Offset,
		IN UINTN	Size,
		OUT VOID *	Buffer )

Read RAM disk data.

Parameters

[in]	ExtentTable	Allocated extent table.
[in]	Offset	Offset in RAM disk.
[in]	Size	Amount of data to read.
[out]	Buffer	Resulting data.

Return values

TRUE	on success.

Definition at line 354 of file OcAppleRamDiskLib.c.

OcAppleRamDiskWrite()

BOOLEAN OcAppleRamDiskWrite	(	IN CONST APPLE_RAM_DISK_EXTENT_TABLE *	ExtentTable,
		IN UINTN	Offset,
		IN UINTN	Size,
		IN CONST VOID *	Buffer )

Write RAM disk data.

Parameters

[in]	ExtentTable	Allocated extent table.
[in]	Offset	Offset in RAM disk.
[in]	Size	Amount of data to write.
[in]	Buffer	Source data.

Return values

TRUE	on success.

Definition at line 413 of file OcAppleRamDiskLib.c.