OpenCore  1.0.4
OpenCore Bootloader
Loading...
Searching...
No Matches
AppleRemovableMedia.h File Reference

Go to the source code of this file.

Data Structures

struct  APPLE_REMOVABLE_MEDIA_PROTOCOL
 

Macros

#define APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
 Global Id for Removable_Media Interface.
 
#define APPLE_REMOVABLE_MEDIA_PROTOCOL_REVISION   0x00000001
 

Typedefs

typedef struct APPLE_REMOVABLE_MEDIA_PROTOCOL APPLE_REMOVABLE_MEDIA_PROTOCOL
 
typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_EJECT) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)
 
typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_INJECT) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)
 
typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_ALLOW_REMOVAL) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)
 
typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_PREVENT_REMOVAL) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)
 
typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_DETECT_TRAY_STATE) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This, OUT BOOLEAN *TrayOpen)
 

Variables

EFI_GUID gAppleRemovableMediaProtocolGuid
 

Detailed Description

Protocol interface for any device that supports removable media (i.e. optical drives).

Copyright (c) 2005 Apple Computer, Inc. All rights reserved. Portions Copyright (C) 2017, Download-Fritz. All rights reserved.

Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Computer, Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software.

In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Computer, Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated.

The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file AppleRemovableMedia.h.

Macro Definition Documentation

◆ APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID

#define APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
Value:
{ 0x2EA9743A, 0x23D9, 0x425E, \
{ 0x87, 0x2C, 0xF6, 0x15, 0xAA, 0x19, 0x57, 0x88 } }

Global Id for Removable_Media Interface.

Definition at line 52 of file AppleRemovableMedia.h.

◆ APPLE_REMOVABLE_MEDIA_PROTOCOL_REVISION

#define APPLE_REMOVABLE_MEDIA_PROTOCOL_REVISION   0x00000001

Definition at line 56 of file AppleRemovableMedia.h.

Typedef Documentation

◆ APPLE_REMOVABLE_MEDIA_ALLOW_REMOVAL

typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_ALLOW_REMOVAL) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)

Allow the media to be removed from the drive.

Parameters
[in]ThisProtocol instance pointer.
Return values
EFI_SUCCESSThe media can now be removed.
EFI_UNSUPPORTEDThe media cannot be removed.

Definition at line 98 of file AppleRemovableMedia.h.

◆ APPLE_REMOVABLE_MEDIA_DETECT_TRAY_STATE

typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_DETECT_TRAY_STATE) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This, OUT BOOLEAN *TrayOpen)

Get the status of the drive tray.

Parameters
[in]ThisProtocol instance pointer.
[out]TrayOpenStatus of the drive tray.
Return values
EFI_SUCCESSThe status has been returned in TrayOpen.

Definition at line 129 of file AppleRemovableMedia.h.

◆ APPLE_REMOVABLE_MEDIA_EJECT

typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_EJECT) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)

Eject removable media from drive (such as a CD/DVD).

Parameters
[in]ThisProtocol instance pointer.
Return values
EFI_SUCCESSThe media was ejected.

Definition at line 69 of file AppleRemovableMedia.h.

◆ APPLE_REMOVABLE_MEDIA_INJECT

typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_INJECT) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)

Inject removable media into drive (such as a CD/DVD).

Parameters
[in]ThisProtocol instance pointer.
Return values
EFI_SUCCESSThe media was injected.

Definition at line 83 of file AppleRemovableMedia.h.

◆ APPLE_REMOVABLE_MEDIA_PREVENT_REMOVAL

typedef EFI_STATUS(EFIAPI * APPLE_REMOVABLE_MEDIA_PREVENT_REMOVAL) (IN APPLE_REMOVABLE_MEDIA_PROTOCOL *This)

Prevent the media from being removed from the drive.

Parameters
[in]ThisProtocol instance pointer.
Return values
EFI_SUCCESSThe drive is locked, and the media cannot be removed.
EFI_UNSUPPORTEDThe drive cannot be locked.

Definition at line 114 of file AppleRemovableMedia.h.

◆ APPLE_REMOVABLE_MEDIA_PROTOCOL

typedef struct APPLE_REMOVABLE_MEDIA_PROTOCOL APPLE_REMOVABLE_MEDIA_PROTOCOL

Definition at line 58 of file AppleRemovableMedia.h.

Variable Documentation

◆ gAppleRemovableMediaProtocolGuid

EFI_GUID gAppleRemovableMediaProtocolGuid
extern