Merge improved comments into this driver.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7748 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 30 insertions, 201 deletions

diff --git a/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h b/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h
index f77494c946..85b8c7af23 100644
--- a/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h
+++ b/PcAtChipsetPkg/8259InterruptControllerDxe/8259.h
@@ -1,6 +1,7 @@
-/**

+/** @file

+  Driver implementing the Tiano Legacy 8259 Protocol

 

-Copyright (c) 2005, Intel Corporation                                                         

+Copyright (c) 2005, 2009, Intel Corporation                                                         

 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        

@@ -9,13 +10,6 @@ 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.             

 

-Module Name:

-  8259.h

-

-Abstract:

-

-  Driver implementing the Tiano Legacy 8259 Protocol

-

 **/

 

 #ifndef _8259_H__

@@ -53,116 +47,39 @@ Abstract:
 EFI_STATUS

 EFIAPI

 Interrupt8259SetVectorBase (

-  IN  EFI_LEGACY_8259_PROTOCOL  *This,

-  IN  UINT8                     MasterBase,

-  IN  UINT8                     SlaveBase

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This        - TODO: add argument description

-  MasterBase  - TODO: add argument description

-  SlaveBase   - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  IN EFI_LEGACY_8259_PROTOCOL  *This,

+  IN UINT8                     MasterBase,

+  IN UINT8                     SlaveBase

+  );

 

 EFI_STATUS

 EFIAPI

 Interrupt8259GetMask (

-  IN  EFI_LEGACY_8259_PROTOCOL  * This,

+  IN  EFI_LEGACY_8259_PROTOCOL  *This,

   OUT UINT16                    *LegacyMask, OPTIONAL

   OUT UINT16                    *LegacyEdgeLevel, OPTIONAL

   OUT UINT16                    *ProtectedMask, OPTIONAL

   OUT UINT16                    *ProtectedEdgeLevel OPTIONAL

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This                - TODO: add argument description

-  LegacyMask          - TODO: add argument description

-  LegacyEdgeLevel     - TODO: add argument description

-  ProtectedMask       - TODO: add argument description

-  ProtectedEdgeLevel  - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  );

 

 EFI_STATUS

 EFIAPI

 Interrupt8259SetMask (

-  IN  EFI_LEGACY_8259_PROTOCOL  * This,

-  IN  UINT16                    *LegacyMask, OPTIONAL

-  IN  UINT16                    *LegacyEdgeLevel, OPTIONAL

-  IN  UINT16                    *ProtectedMask, OPTIONAL

-  IN  UINT16                    *ProtectedEdgeLevel OPTIONAL

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This                - TODO: add argument description

-  LegacyMask          - TODO: add argument description

-  LegacyEdgeLevel     - TODO: add argument description

-  ProtectedMask       - TODO: add argument description

-  ProtectedEdgeLevel  - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  IN EFI_LEGACY_8259_PROTOCOL  *This,

+  IN UINT16                    *LegacyMask, OPTIONAL

+  IN UINT16                    *LegacyEdgeLevel, OPTIONAL

+  IN UINT16                    *ProtectedMask, OPTIONAL

+  IN UINT16                    *ProtectedEdgeLevel OPTIONAL

+  );

 

 EFI_STATUS

 EFIAPI

 Interrupt8259SetMode (

-  IN  EFI_LEGACY_8259_PROTOCOL  * This,

-  IN  EFI_8259_MODE             Mode,

-  IN  UINT16                    *Mask, OPTIONAL

-  IN  UINT16                    *EdgeLevel OPTIONAL

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This      - TODO: add argument description

-  Mode      - TODO: add argument description

-  Mask      - TODO: add argument description

-  EdgeLevel - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  IN EFI_LEGACY_8259_PROTOCOL  *This,

+  IN EFI_8259_MODE             Mode,

+  IN UINT16                    *Mask, OPTIONAL

+  IN UINT16                    *EdgeLevel OPTIONAL

+  );

 

 EFI_STATUS

 EFIAPI

@@ -170,75 +87,22 @@ Interrupt8259GetVector (
   IN  EFI_LEGACY_8259_PROTOCOL  *This,

   IN  EFI_8259_IRQ              Irq,

   OUT UINT8                     *Vector

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This    - TODO: add argument description

-  Irq     - TODO: add argument description

-  Vector  - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  );

 

 EFI_STATUS

 EFIAPI

 Interrupt8259EnableIrq (

-  IN  EFI_LEGACY_8259_PROTOCOL  *This,

-  IN  EFI_8259_IRQ              Irq,

-  IN  BOOLEAN                   LevelTriggered

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This            - TODO: add argument description

-  Irq             - TODO: add argument description

-  LevelTriggered  - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  IN EFI_LEGACY_8259_PROTOCOL  *This,

+  IN EFI_8259_IRQ              Irq,

+  IN BOOLEAN                   LevelTriggered

+  );

 

 EFI_STATUS

 EFIAPI

 Interrupt8259DisableIrq (

-  IN  EFI_LEGACY_8259_PROTOCOL  *This,

-  IN  EFI_8259_IRQ              Irq

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This  - TODO: add argument description

-  Irq   - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  IN EFI_LEGACY_8259_PROTOCOL  *This,

+  IN EFI_8259_IRQ              Irq

+  );

 

 EFI_STATUS

 EFIAPI

@@ -246,48 +110,13 @@ Interrupt8259GetInterruptLine (
   IN  EFI_LEGACY_8259_PROTOCOL  *This,

   IN  EFI_HANDLE                PciHandle,

   OUT UINT8                     *Vector

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This      - TODO: add argument description

-  PciHandle - TODO: add argument description

-  Vector    - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  );

 

 EFI_STATUS

 EFIAPI

 Interrupt8259EndOfInterrupt (

   IN  EFI_LEGACY_8259_PROTOCOL  *This,

   IN  EFI_8259_IRQ              Irq

-  )

-/**

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  This  - TODO: add argument description

-  Irq   - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

-**/

-;

+  );

 

 #endif