| Message ID | 20170209192623.262044-2-evan.lloyd@arm.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [edk2,1/4] EmbeddedPkg: introduce HardwareInterrupt2 protocol | expand |
On Thu, Feb 09, 2017 at 07:26:20PM +0000, evan.lloyd@arm.com wrote: > From: Ard Biesheuvel <ard.biesheuvel@linaro.org> > > The existing HardwareInterrupt protocol lacks the method to configure > the level/edge and polarity properties of an interrupt. So introduce a > new protocol HardwareInterrupt2, and add some new members that allow the > manipulation of those properties. > > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org> > Signed-off-by: Girish Pathak <girish.pathak@arm.com> > Signed-off-by: Evan Lloyd <evan.lloyd@arm.com> > Tested-by: Girish Pathak <girish.pathak@arm.com> > --- > EmbeddedPkg/EmbeddedPkg.dec | 1 + > EmbeddedPkg/Include/Protocol/HardwareInterrupt2.h | 181 ++++++++++++++++++++ > 2 files changed, 182 insertions(+) > > diff --git a/EmbeddedPkg/EmbeddedPkg.dec b/EmbeddedPkg/EmbeddedPkg.dec > index 2c2cf41103c282103c2a83ad9a105d0f6ac2e9a3..2464f715e68c8e0eb1214c0170fb040830b88f06 100644 > --- a/EmbeddedPkg/EmbeddedPkg.dec > +++ b/EmbeddedPkg/EmbeddedPkg.dec > @@ -58,6 +58,7 @@ [Guids.common] > > [Protocols.common] > gHardwareInterruptProtocolGuid = { 0x2890B3EA, 0x053D, 0x1643, { 0xAD, 0x0C, 0xD6, 0x48, 0x08, 0xDA, 0x3F, 0xF1 } } > + gHardwareInterrupt2ProtocolGuid = { 0x32898322, 0x2da1, 0x474a, { 0xba, 0xaa, 0xf3, 0xf7, 0xcf, 0x56, 0x94, 0x70 } } > gEfiDebugSupportPeriodicCallbackProtocolGuid = { 0x9546e07c, 0x2cbb, 0x4c88, { 0x98, 0x6c, 0xcd, 0x34, 0x10, 0x86, 0xf0, 0x44 } } > gEfiEblAddCommandProtocolGuid = { 0xaeda2428, 0x9a22, 0x4637, { 0x9b, 0x21, 0x54, 0x5e, 0x28, 0xfb, 0xb8, 0x29 } } > gEmbeddedDeviceGuid = { 0xbf4b9d10, 0x13ec, 0x43dd, { 0x88, 0x80, 0xe9, 0xb, 0x71, 0x8f, 0x27, 0xde } } > diff --git a/EmbeddedPkg/Include/Protocol/HardwareInterrupt2.h b/EmbeddedPkg/Include/Protocol/HardwareInterrupt2.h > new file mode 100644 > index 0000000000000000000000000000000000000000..61acdaac4341951b8c1916858490a815cf94dc99 > --- /dev/null > +++ b/EmbeddedPkg/Include/Protocol/HardwareInterrupt2.h > @@ -0,0 +1,181 @@ > +/** @file > + > + Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR> -2017 by now, I guess. > + > + 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. > + > +**/ > + > +#ifndef __HARDWARE_INTERRUPT2_H__ > +#define __HARDWARE_INTERRUPT2_H__ > + > +#include <Protocol/HardwareInterrupt.h> > + > +// 22838932-1a2d-4a47-aaba-f3f7cf569470 > + > +#define EFI_HARDWARE_INTERRUPT2_PROTOCOL_GUID \ > + { 0x32898322, 0x2da1, 0x474a, { 0xba, 0xaa, 0xf3, 0xf7, 0xcf, 0x56, 0x94, 0x70 } } > + > +typedef enum { > + EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_LOW, > + EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_HIGH, > + EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_FALLING, > + EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_RISING, > +} EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE; > + > +typedef struct _EFI_HARDWARE_INTERRUPT2_PROTOCOL EFI_HARDWARE_INTERRUPT2_PROTOCOL; > + > +/** > + Register Handler for the specified interrupt source. > + > + @param This Instance pointer for this protocol > + @param Source Hardware source of the interrupt > + @param Handler Callback for interrupt. NULL to unregister > + > + @retval EFI_SUCCESS Source was updated to support Handler. > + @retval EFI_DEVICE_ERROR Hardware could not be programmed. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *HARDWARE_INTERRUPT2_REGISTER) ( > + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, > + IN HARDWARE_INTERRUPT_SOURCE Source, Arguments horizontally misaligned? > + IN HARDWARE_INTERRUPT_HANDLER Handler > + ); > + > + > +/** > + Enable interrupt source Source. > + > + @param This Instance pointer for this protocol > + @param Source Hardware source of the interrupt > + > + @retval EFI_SUCCESS Source interrupt enabled. > + @retval EFI_DEVICE_ERROR Hardware could not be programmed. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *HARDWARE_INTERRUPT2_ENABLE) ( > + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, > + IN HARDWARE_INTERRUPT_SOURCE Source Arguments horizontally misaligned? > + ); > + > + > + > +/** > + Disable interrupt source Source. > + > + @param This Instance pointer for this protocol > + @param Source Hardware source of the interrupt > + > + @retval EFI_SUCCESS Source interrupt disabled. > + @retval EFI_DEVICE_ERROR Hardware could not be programmed. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *HARDWARE_INTERRUPT2_DISABLE) ( > + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, > + IN HARDWARE_INTERRUPT_SOURCE Source Arguments horizontally misaligned? > + ); > + > + > +/** > + Return current state of interrupt source Source. > + > + @param This Instance pointer for this protocol > + @param Source Hardware source of the interrupt > + @param InterruptState TRUE: source enabled, FALSE: source disabled. > + > + @retval EFI_SUCCESS InterruptState is valid > + @retval EFI_DEVICE_ERROR InterruptState is not valid > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *HARDWARE_INTERRUPT2_INTERRUPT_STATE) ( > + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, > + IN HARDWARE_INTERRUPT_SOURCE Source, Arguments horizontally misaligned? > + IN BOOLEAN *InterruptState > + ); > + > +/** > + Signal to the hardware that the End Of Intrrupt state > + has been reached. > + > + @param This Instance pointer for this protocol > + @param Source Hardware source of the interrupt > + > + @retval EFI_SUCCESS Source interrupt EOI'ed. > + @retval EFI_DEVICE_ERROR Hardware could not be programmed. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *HARDWARE_INTERRUPT2_END_OF_INTERRUPT) ( > + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, Did someone clone HARDWARE_INTERRUPT_PROTOCOL templates, inserted a 2 and forgot to delete a space? :) (I'll stop commenting, but please address throughout.) / Leif > + IN HARDWARE_INTERRUPT_SOURCE Source > + ); > + > +/** > + Return the configured trigger type for an interrupt source > + > + @param This Instance pointer for this protocol > + @param Source Hardware source of the interrupt > + @param TriggerType The configured trigger type > + > + @retval EFI_SUCCESS Operation successful > + @retval EFI_DEVICE_ERROR Information could not be returned > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *HARDWARE_INTERRUPT2_GET_TRIGGER_TYPE) ( > + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, > + IN HARDWARE_INTERRUPT_SOURCE Source, > + OUT EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE *TriggerType > + ); > + > + > +/** > + Configure the trigger type for an interrupt source > + > + @param This Instance pointer for this protocol > + @param Source Hardware source of the interrupt > + @param TriggerType The trigger type to configure > + > + @retval EFI_SUCCESS Operation successful > + @retval EFI_DEVICE_ERROR Hardware could not be programmed. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE) ( > + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, > + IN HARDWARE_INTERRUPT_SOURCE Source, > + IN EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE TriggerType > + ); > + > +struct _EFI_HARDWARE_INTERRUPT2_PROTOCOL { > + HARDWARE_INTERRUPT2_REGISTER RegisterInterruptSource; > + HARDWARE_INTERRUPT2_ENABLE EnableInterruptSource; > + HARDWARE_INTERRUPT2_DISABLE DisableInterruptSource; > + HARDWARE_INTERRUPT2_INTERRUPT_STATE GetInterruptSourceState; > + HARDWARE_INTERRUPT2_END_OF_INTERRUPT EndOfInterrupt; > + > + // v2 members > + HARDWARE_INTERRUPT2_GET_TRIGGER_TYPE GetTriggerType; > + HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE SetTriggerType; > +}; > + > +extern EFI_GUID gHardwareInterrupt2ProtocolGuid; > + > +#endif > -- > Guid("CE165669-3EF3-493F-B85D-6190EE5B9759") > _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
diff --git a/EmbeddedPkg/EmbeddedPkg.dec b/EmbeddedPkg/EmbeddedPkg.dec index 2c2cf41103c282103c2a83ad9a105d0f6ac2e9a3..2464f715e68c8e0eb1214c0170fb040830b88f06 100644 --- a/EmbeddedPkg/EmbeddedPkg.dec +++ b/EmbeddedPkg/EmbeddedPkg.dec @@ -58,6 +58,7 @@ [Guids.common] [Protocols.common] gHardwareInterruptProtocolGuid = { 0x2890B3EA, 0x053D, 0x1643, { 0xAD, 0x0C, 0xD6, 0x48, 0x08, 0xDA, 0x3F, 0xF1 } } + gHardwareInterrupt2ProtocolGuid = { 0x32898322, 0x2da1, 0x474a, { 0xba, 0xaa, 0xf3, 0xf7, 0xcf, 0x56, 0x94, 0x70 } } gEfiDebugSupportPeriodicCallbackProtocolGuid = { 0x9546e07c, 0x2cbb, 0x4c88, { 0x98, 0x6c, 0xcd, 0x34, 0x10, 0x86, 0xf0, 0x44 } } gEfiEblAddCommandProtocolGuid = { 0xaeda2428, 0x9a22, 0x4637, { 0x9b, 0x21, 0x54, 0x5e, 0x28, 0xfb, 0xb8, 0x29 } } gEmbeddedDeviceGuid = { 0xbf4b9d10, 0x13ec, 0x43dd, { 0x88, 0x80, 0xe9, 0xb, 0x71, 0x8f, 0x27, 0xde } } diff --git a/EmbeddedPkg/Include/Protocol/HardwareInterrupt2.h b/EmbeddedPkg/Include/Protocol/HardwareInterrupt2.h new file mode 100644 index 0000000000000000000000000000000000000000..61acdaac4341951b8c1916858490a815cf94dc99 --- /dev/null +++ b/EmbeddedPkg/Include/Protocol/HardwareInterrupt2.h @@ -0,0 +1,181 @@ +/** @file + + Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR> + + 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. + +**/ + +#ifndef __HARDWARE_INTERRUPT2_H__ +#define __HARDWARE_INTERRUPT2_H__ + +#include <Protocol/HardwareInterrupt.h> + +// 22838932-1a2d-4a47-aaba-f3f7cf569470 + +#define EFI_HARDWARE_INTERRUPT2_PROTOCOL_GUID \ + { 0x32898322, 0x2da1, 0x474a, { 0xba, 0xaa, 0xf3, 0xf7, 0xcf, 0x56, 0x94, 0x70 } } + +typedef enum { + EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_LOW, + EFI_HARDWARE_INTERRUPT2_TRIGGER_LEVEL_HIGH, + EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_FALLING, + EFI_HARDWARE_INTERRUPT2_TRIGGER_EDGE_RISING, +} EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE; + +typedef struct _EFI_HARDWARE_INTERRUPT2_PROTOCOL EFI_HARDWARE_INTERRUPT2_PROTOCOL; + +/** + Register Handler for the specified interrupt source. + + @param This Instance pointer for this protocol + @param Source Hardware source of the interrupt + @param Handler Callback for interrupt. NULL to unregister + + @retval EFI_SUCCESS Source was updated to support Handler. + @retval EFI_DEVICE_ERROR Hardware could not be programmed. + +**/ +typedef +EFI_STATUS +(EFIAPI *HARDWARE_INTERRUPT2_REGISTER) ( + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, + IN HARDWARE_INTERRUPT_SOURCE Source, + IN HARDWARE_INTERRUPT_HANDLER Handler + ); + + +/** + Enable interrupt source Source. + + @param This Instance pointer for this protocol + @param Source Hardware source of the interrupt + + @retval EFI_SUCCESS Source interrupt enabled. + @retval EFI_DEVICE_ERROR Hardware could not be programmed. + +**/ +typedef +EFI_STATUS +(EFIAPI *HARDWARE_INTERRUPT2_ENABLE) ( + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, + IN HARDWARE_INTERRUPT_SOURCE Source + ); + + + +/** + Disable interrupt source Source. + + @param This Instance pointer for this protocol + @param Source Hardware source of the interrupt + + @retval EFI_SUCCESS Source interrupt disabled. + @retval EFI_DEVICE_ERROR Hardware could not be programmed. + +**/ +typedef +EFI_STATUS +(EFIAPI *HARDWARE_INTERRUPT2_DISABLE) ( + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, + IN HARDWARE_INTERRUPT_SOURCE Source + ); + + +/** + Return current state of interrupt source Source. + + @param This Instance pointer for this protocol + @param Source Hardware source of the interrupt + @param InterruptState TRUE: source enabled, FALSE: source disabled. + + @retval EFI_SUCCESS InterruptState is valid + @retval EFI_DEVICE_ERROR InterruptState is not valid + +**/ +typedef +EFI_STATUS +(EFIAPI *HARDWARE_INTERRUPT2_INTERRUPT_STATE) ( + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, + IN HARDWARE_INTERRUPT_SOURCE Source, + IN BOOLEAN *InterruptState + ); + +/** + Signal to the hardware that the End Of Intrrupt state + has been reached. + + @param This Instance pointer for this protocol + @param Source Hardware source of the interrupt + + @retval EFI_SUCCESS Source interrupt EOI'ed. + @retval EFI_DEVICE_ERROR Hardware could not be programmed. + +**/ +typedef +EFI_STATUS +(EFIAPI *HARDWARE_INTERRUPT2_END_OF_INTERRUPT) ( + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, + IN HARDWARE_INTERRUPT_SOURCE Source + ); + +/** + Return the configured trigger type for an interrupt source + + @param This Instance pointer for this protocol + @param Source Hardware source of the interrupt + @param TriggerType The configured trigger type + + @retval EFI_SUCCESS Operation successful + @retval EFI_DEVICE_ERROR Information could not be returned + +**/ +typedef +EFI_STATUS +(EFIAPI *HARDWARE_INTERRUPT2_GET_TRIGGER_TYPE) ( + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, + IN HARDWARE_INTERRUPT_SOURCE Source, + OUT EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE *TriggerType + ); + + +/** + Configure the trigger type for an interrupt source + + @param This Instance pointer for this protocol + @param Source Hardware source of the interrupt + @param TriggerType The trigger type to configure + + @retval EFI_SUCCESS Operation successful + @retval EFI_DEVICE_ERROR Hardware could not be programmed. + +**/ +typedef +EFI_STATUS +(EFIAPI *HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE) ( + IN EFI_HARDWARE_INTERRUPT2_PROTOCOL *This, + IN HARDWARE_INTERRUPT_SOURCE Source, + IN EFI_HARDWARE_INTERRUPT2_TRIGGER_TYPE TriggerType + ); + +struct _EFI_HARDWARE_INTERRUPT2_PROTOCOL { + HARDWARE_INTERRUPT2_REGISTER RegisterInterruptSource; + HARDWARE_INTERRUPT2_ENABLE EnableInterruptSource; + HARDWARE_INTERRUPT2_DISABLE DisableInterruptSource; + HARDWARE_INTERRUPT2_INTERRUPT_STATE GetInterruptSourceState; + HARDWARE_INTERRUPT2_END_OF_INTERRUPT EndOfInterrupt; + + // v2 members + HARDWARE_INTERRUPT2_GET_TRIGGER_TYPE GetTriggerType; + HARDWARE_INTERRUPT2_SET_TRIGGER_TYPE SetTriggerType; +}; + +extern EFI_GUID gHardwareInterrupt2ProtocolGuid; + +#endif