mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-11-27 12:15:19 +01:00
121 lines
4.7 KiB
C
121 lines
4.7 KiB
C
/** @file
|
|
Copyright (C) 2005 - 2016, Apple Inc. All rights reserved.
|
|
Portions Copyright (C) 2014 - 2016, CupertinoNet. All rights reserved.<BR>
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
**/
|
|
|
|
#ifndef APPLE_KEY_MAP_DATABASE_H_
|
|
#define APPLE_KEY_MAP_DATABASE_H_
|
|
|
|
#include <IndustryStandard/AppleHid.h>
|
|
|
|
// APPLE_KEY_MAP_DATABASE_PROTOCOL_REVISION
|
|
#define APPLE_KEY_MAP_DATABASE_PROTOCOL_REVISION 0x00010000
|
|
|
|
#define APPLE_KEY_MAP_DATABASE_PROTOCOL_GUID \
|
|
{0x584B9EBE, 0x80C1, 0x4BD6, \
|
|
{0x98, 0xB0, 0xA7, 0x78, 0x6E, 0xC2, 0xF2, 0xE2}}
|
|
|
|
typedef struct _APPLE_KEY_MAP_DATABASE_PROTOCOL APPLE_KEY_MAP_DATABASE_PROTOCOL;
|
|
|
|
// KEY_MAP_CREATE_KEY_STROKES_BUFFER
|
|
/** Creates a new key set with a given number of keys allocated. The index
|
|
within the database is returned.
|
|
|
|
@param[in] This A pointer to the protocol instance.
|
|
@param[in] KeyBufferSize The amount of keys to allocate for the key set.
|
|
@param[out] Index The assigned index of the created key set.
|
|
|
|
@return Returned is the status of the operation.
|
|
@retval EFI_SUCCESS A key set with the given number of keys
|
|
allocated has been created.
|
|
@retval EFI_OUT_OF_RESOURCES The memory necessary to complete the operation
|
|
could not be allocated.
|
|
@retval other An error returned by a sub-operation.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *KEY_MAP_CREATE_KEY_STROKES_BUFFER)(
|
|
IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This,
|
|
IN UINTN KeyBufferSize,
|
|
OUT UINTN *Index
|
|
);
|
|
|
|
// KEY_MAP_REMOVE_KEY_STROKES_BUFFER
|
|
/** Removes a key set specified by its index from the database.
|
|
|
|
@param[in] This A pointer to the protocol instance.
|
|
@param[in] Index The index of the key set to remove.
|
|
|
|
@return Returned is the status of the operation.
|
|
@retval EFI_SUCCESS The specified key set has been removed.
|
|
@retval EFI_NOT_FOUND No key set could be found for the given index.
|
|
@retval other An error returned by a sub-operation.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *KEY_MAP_REMOVE_KEY_STROKES_BUFFER)(
|
|
IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This,
|
|
IN UINTN Index
|
|
);
|
|
|
|
// KEY_MAP_SET_KEY_STROKES_KEYS
|
|
/** Sets the keys of a key set specified by its index to the given Keys Buffer.
|
|
|
|
@param[in] This A pointer to the protocol instance.
|
|
@param[in] Index The index of the key set to edit.
|
|
@param[in] Modifiers The key modifiers manipulating the given keys.
|
|
@param[in] NumberOfKeys The number of keys contained in Keys.
|
|
@param[in] Keys An array of keys to add to the specified key set.
|
|
|
|
@return Returned is the status of the operation.
|
|
@retval EFI_SUCCESS The given keys were set for the specified key
|
|
set.
|
|
@retval EFI_OUT_OF_RESOURCES The memory necessary to complete the operation
|
|
could not be allocated.
|
|
@retval EFI_NOT_FOUND No key set could be found for the given index.
|
|
@retval other An error returned by a sub-operation.
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *KEY_MAP_SET_KEY_STROKES_KEYS)(
|
|
IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This,
|
|
IN UINTN Index,
|
|
IN APPLE_MODIFIER_MAP Modifiers,
|
|
IN UINTN NumberOfKeys,
|
|
IN APPLE_KEY *Keys
|
|
);
|
|
|
|
// APPLE_KEY_MAP_DATABASE_PROTOCOL
|
|
/// The structure exposed by the APPLE_KEY_MAP_DATABASE_PROTOCOL.
|
|
struct _APPLE_KEY_MAP_DATABASE_PROTOCOL {
|
|
/// The revision of the installed protocol.
|
|
UINTN Revision;
|
|
|
|
/// A pointer to the CreateKeyStrokesBuffer function.
|
|
KEY_MAP_CREATE_KEY_STROKES_BUFFER CreateKeyStrokesBuffer;
|
|
|
|
/// A pointer to the RemoveKeyStrokes function.
|
|
KEY_MAP_REMOVE_KEY_STROKES_BUFFER RemoveKeyStrokesBuffer;
|
|
|
|
/// A pointer to the SetKeyStrokeBufferKeys function.
|
|
KEY_MAP_SET_KEY_STROKES_KEYS SetKeyStrokeBufferKeys;
|
|
};
|
|
|
|
// gAppleKeyMapDatabaseProtocolGuid
|
|
/// A global variable storing the GUID of the APPLE_KEY_MAP_DATABASE_PROTOCOL.
|
|
extern EFI_GUID gAppleKeyMapDatabaseProtocolGuid;
|
|
|
|
#endif // APPLE_KEY_MAP_DATABASE_H_
|