2 This protocol manages the legacy memory regions between 0xc0000 - 0xfffff
4 Copyright (c) 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: LegacyInterrupt.h
15 @par Revision Reference:
16 This protocol is defined in Framework for EFI Compatibility Support Module spec
21 #ifndef _EFI_LEGACY_INTERRUPT_H_
22 #define _EFI_LEGACY_INTERRUPT_H_
26 #define EFI_LEGACY_INTERRUPT_PROTOCOL_GUID \
28 0x31ce593d, 0x108a, 0x485d, {0xad, 0xb2, 0x78, 0xf2, 0x1f, 0x29, 0x66, 0xbe } \
31 typedef struct _EFI_LEGACY_INTERRUPT_PROTOCOL EFI_LEGACY_INTERRUPT_PROTOCOL
;
34 Get the number of PIRQs this hardware supports.
36 @param This Protocol instance pointer.
37 @param NumberPirsq Number of PIRQs.
39 @retval EFI_SUCCESS Number of PIRQs returned.
44 (EFIAPI
*EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS
) (
45 IN EFI_LEGACY_INTERRUPT_PROTOCOL
*This
,
46 OUT UINT8
*NumberPirqs
50 Gets the PCI location associated with this protocol.
52 @param This Protocol instance pointer.
54 @param Device PCI Device
55 @param Function PCI Function
57 @retval EFI_SUCCESS Bus/Device/Function returned
62 (EFIAPI
*EFI_LEGACY_INTERRUPT_GET_LOCATION
) (
63 IN EFI_LEGACY_INTERRUPT_PROTOCOL
*This
,
70 Read the PIRQ register and return the data
72 @param This Protocol instance pointer.
73 @param PirqNumber PIRQ register to read
74 @param PirqData Data read
76 @retval EFI_SUCCESS Data was read
77 @retval EFI_INVALID_PARAMETER Invalid PIRQ number
82 (EFIAPI
*EFI_LEGACY_INTERRUPT_READ_PIRQ
) (
83 IN EFI_LEGACY_INTERRUPT_PROTOCOL
*This
,
89 Write the specified PIRQ register with the given data.
91 @param This Protocol instance pointer.
92 @param PirqNumber PIRQ register to read.
93 @param PirqData Data written.
95 @retval EFI_SUCCESS Table pointer returned
96 @retval EFI_INVALID_PARAMETER Invalid PIRQ number
101 (EFIAPI
*EFI_LEGACY_INTERRUPT_WRITE_PIRQ
) (
102 IN EFI_LEGACY_INTERRUPT_PROTOCOL
*This
,
108 @par Protocol Description:
109 Abstracts the PIRQ programming from the generic EFI Compatibility Support Modules
111 @param GetNumberPirqs
112 Gets the number of PIRQs supported.
115 Gets the PCI bus, device, and function that associated with this protocol.
118 Reads the indicated PIRQ register.
121 Writes to the indicated PIRQ register.
124 struct _EFI_LEGACY_INTERRUPT_PROTOCOL
{
125 EFI_LEGACY_INTERRUPT_GET_NUMBER_PIRQS GetNumberPirqs
;
126 EFI_LEGACY_INTERRUPT_GET_LOCATION GetLocation
;
127 EFI_LEGACY_INTERRUPT_READ_PIRQ ReadPirq
;
128 EFI_LEGACY_INTERRUPT_WRITE_PIRQ WritePirq
;
131 extern EFI_GUID gEfiLegacyInterruptProtocolGuid
;