Cleanup SerailIO drivers to have a device path and use PCD settings for various stuff. Also clean up a few coding convention items.

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

BeagleBoardPkg/Sec/Sec.c

@@ -93,7 +93,7 @@ UartInit (
   MmioWrite32 (UartBaseAddress + UART_LCR_REG, UART_LCR_DIV_EN_ENABLE);
 
   // Programmable divisor N = 48Mhz/16/115200 = 26
-  MmioWrite32(UartBaseAddress + UART_DLL_REG, 26); // low divisor
+  MmioWrite32 (UartBaseAddress + UART_DLL_REG, 3000000/FixedPcdGet64 (PcdUartDefaultBaudRate)); // low divisor
   MmioWrite32 (UartBaseAddress + UART_DLH_REG,  0); // high divisor
 
   // Enter into UART operational mode.
@@ -251,6 +251,7 @@ CEntryPoint (
       }
     }
 
+   
   DEBUG_CODE_END ();
 
 
@@ -263,14 +264,12 @@ CEntryPoint (
   LzmaDecompressLibConstructor ();
 
   // Build HOBs to pass up our version of stuff the DXE Core needs to save space
-#if 0
   BuildPeCoffLoaderHob ();
   BuildExtractSectionHob (
     &gLzmaCustomDecompressGuid,
     LzmaGuidedSectionGetInfo,
     LzmaGuidedSectionExtraction
     );
-#endif
 
   DecompressFirstFv ();
 

BeagleBoardPkg/Sec/Sec.inf

@@ -53,6 +53,7 @@
   gEmbeddedTokenSpaceGuid.PcdCacheEnable
 
 [FixedPcd]
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate
   gEmbeddedTokenSpaceGuid.PcdEmbeddedFdBaseAddress
   gEmbeddedTokenSpaceGuid.PcdEmbeddedFdSize
   gEmbeddedTokenSpaceGuid.PcdFlashFvMainBase

EmbeddedPkg/SerialDxe/SerialDxe.inf

@@ -1,6 +1,6 @@
 #/** @file
 #  
-#    Component discription file for Bds module
+#  Convert SerialLib into SerialIo protocol
 #  
 #  Copyright (c) 2008, Intel Corporation. <BR>
 #  All rights reserved. This program and the accompanying materials
@@ -48,6 +48,12 @@
   gEfiSerialIoProtocolGuid    
   gEfiDevicePathProtocolGuid
 
+[FixedPcd]
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits
+
   
 [Depex] 
   TRUE

EmbeddedPkg/SerialDxe/SerialIo.c

@@ -23,6 +23,7 @@
 #include <Library/UefiBootServicesTableLib.h>
 #include <Library/DebugLib.h>
 #include <Library/SerialPortLib.h>
+#include <Library/PcdLib.h>
 
 #include <Protocol/SerialIo.h>
 
@@ -189,7 +190,7 @@ SerialRead (
 {
   UINTN Count;
   
-  Count = SerialPortWrite (Buffer, *BufferSize);
+  Count = SerialPortRead (Buffer, *BufferSize);
   *BufferSize = Count;
   return (Count == 0) ? EFI_DEVICE_ERROR : EFI_SUCCESS;
 }
@@ -203,11 +204,11 @@ EFI_HANDLE  gHandle = NULL;
 EFI_SERIAL_IO_MODE gSerialIoMode = {
   0,                                          // ControlMask
   0,                                          // Timeout
-  0,      // BaudRate
+  FixedPcdGet64 (PcdUartDefaultBaudRate),     // BaudRate
   1,                                          // RceiveFifoDepth
-  0,      // DataBits
+  FixedPcdGet8 (PcdUartDefaultDataBits),      // DataBits
-  0,      // Parity
+  FixedPcdGet8 (PcdUartDefaultParity),        // Parity
-  0       // StopBits
+  FixedPcdGet8 (PcdUartDefaultStopBits)       // StopBits
 };
 
 
@@ -222,6 +223,28 @@ EFI_SERIAL_IO_PROTOCOL gSerialIoTemplate = {
   &gSerialIoMode
 };
   
+typedef struct {
+  VENDOR_DEVICE_PATH        Guid;
+  UART_DEVICE_PATH          Uart;
+  EFI_DEVICE_PATH_PROTOCOL  End;
+} SIMPLE_TEXT_OUT_DEVICE_PATH;
+
+SIMPLE_TEXT_OUT_DEVICE_PATH mDevicePath = {
+  {
+    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, sizeof (VENDOR_DEVICE_PATH), 0},
+    EFI_CALLER_ID_GUID // Use the drivers GUID
+  },
+  {
+    { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (UART_DEVICE_PATH), 0},
+    0,        // Reserved
+    FixedPcdGet64 (PcdUartDefaultBaudRate),   // BaudRate
+    FixedPcdGet8 (PcdUartDefaultDataBits),    // DataBits
+    FixedPcdGet8 (PcdUartDefaultParity),      // Parity (N)
+    FixedPcdGet8 (PcdUartDefaultStopBits)     // StopBits
+  },
+  { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (EFI_DEVICE_PATH_PROTOCOL), 0}
+};
+
 
 /**
   Initialize the state information for the Serial Io Protocol
@@ -248,7 +271,7 @@ SerialDxeInitialize (
   Status = gBS->InstallMultipleProtocolInterfaces (
                   &gHandle, 
                   &gEfiSerialIoProtocolGuid,   &gSerialIoTemplate,
-                  &gEfiDevicePathProtocolGuid, NULL, // BugBug: Need a device path
+                  &gEfiDevicePathProtocolGuid, &mDevicePath, 
                   NULL
                   );
   ASSERT_EFI_ERROR (Status);

EmbeddedPkg/SimpleTextInOutSerial/SimpleTextInOut.c

@@ -64,10 +64,12 @@
 #include <Library/MemoryAllocationLib.h>
 #include <Library/DebugLib.h>
 #include <Library/SerialPortLib.h>
+#include <Library/PcdLib.h>
 
 #include <Protocol/SerialIo.h>
 #include <Protocol/SimpleTextIn.h>
 #include <Protocol/SimpleTextOut.h>
+#include <Protocol/DevicePath.h>
 
 
 #define MODE0_COLUMN_COUNT        80
@@ -200,6 +202,29 @@ EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL mSimpleTextOut = {
 
 EFI_HANDLE           mInstallHandle = NULL;
 
+typedef struct {
+  VENDOR_DEVICE_PATH        Guid;
+  UART_DEVICE_PATH          Uart;
+  EFI_DEVICE_PATH_PROTOCOL  End;
+} SIMPLE_TEXT_OUT_DEVICE_PATH;
+
+SIMPLE_TEXT_OUT_DEVICE_PATH mDevicePath = {
+  {
+    { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, sizeof (VENDOR_DEVICE_PATH), 0},
+    EFI_CALLER_ID_GUID
+  },
+  {
+    { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (UART_DEVICE_PATH), 0},
+    0,        // Reserved
+    FixedPcdGet64 (PcdUartDefaultBaudRate),   // BaudRate
+    FixedPcdGet8 (PcdUartDefaultDataBits),    // DataBits
+    FixedPcdGet8 (PcdUartDefaultParity),      // Parity (N)
+    FixedPcdGet8 (PcdUartDefaultStopBits)     // StopBits
+  },
+  { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (EFI_DEVICE_PATH_PROTOCOL), 0}
+};
+
+
 
 
 BOOLEAN
@@ -271,6 +296,10 @@ ReadKeyStroke (
 {
   CHAR8             Char;
   
+  if (!SerialPortPoll ()) {
+    return EFI_NOT_READY;
+  }
+  
   SerialPortRead ((UINT8 *)&Char, 1);
   
   //
@@ -660,6 +689,7 @@ SimpleTextInOutEntryPoint (
                   &mInstallHandle,
                   &gEfiSimpleTextInProtocolGuid,   &mSimpleTextIn,
                   &gEfiSimpleTextOutProtocolGuid,  &mSimpleTextOut,
+                  &gEfiDevicePathProtocolGuid,     &mDevicePath,
                   NULL
                   );
   if (!EFI_ERROR (Status)) {

EmbeddedPkg/SimpleTextInOutSerial/SimpleTextInOutSerial.inf

@@ -51,5 +51,12 @@
   gEfiSerialIoProtocolGuid    
   gEfiDevicePathProtocolGuid
 
+[FixedPcd]
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity
+  gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits
+
+
 [depex]
   TRUE

Omap35xxPkg/Flash/Flash.c

@@ -23,22 +23,37 @@ UINT8           *gEccCode;
 UINTN           gNum512BytesChunks = 0;
 
 //
+
 // Device path for SemiHosting. It contains our autogened Caller ID GUID.
+
 //
+
 typedef struct {
+
   VENDOR_DEVICE_PATH        Guid;
+
   EFI_DEVICE_PATH_PROTOCOL  End;
+
 } FLASH_DEVICE_PATH;
 
+
+
 FLASH_DEVICE_PATH gDevicePath = {
+
   {
+
     { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, sizeof (VENDOR_DEVICE_PATH), 0 },
+
     EFI_CALLER_ID_GUID
+
   },
+
   { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (EFI_DEVICE_PATH_PROTOCOL), 0}
+
 };
 
 
+
 //Actual page address = Column address + Page address + Block address.
 UINTN
 GetActualPageAddressInBytes (

Omap35xxPkg/TimerDxe/Timer.c

@@ -55,14 +55,23 @@ volatile UINTN  gVector;
 
 
 /**
+
   C Interrupt Handler calledin the interrupt context when Source interrupt is active.
 
+
+
   @param Source         Source of the interrupt. Hardware routing off a specific platform defines
+
                         what source means.
+
   @param SystemContext  Pointer to system register context. Mostly used by debuggers and will
+
                         update the system context after the return from the interrupt if 
+
                         modified. Don't change these values unless you know what you are doing
 
+
+
 **/
 VOID
 EFIAPI
@@ -73,13 +82,21 @@ TimerInterruptHandler (
 {
   EFI_TPL OriginalTPL;
 
+
+
   //
+
   // DXE core uses this callback for the EFI timer tick. The DXE core uses locks 
+
   // that raise to TPL_HIGH and then restore back to current level. Thus we need
+
   // to make sure TPL level is set to TPL_HIGH while we are handling the timer tick. 
+
   //
+
   OriginalTPL = gBS->RaiseTPL (TPL_HIGH_LEVEL);
 
+
   if (mTimerPeriodicCallback) {
     mTimerPeriodicCallback(SystemContext);
   }
@@ -98,34 +115,63 @@ TimerInterruptHandler (
 }
 
 /**
+
   This function registers the handler NotifyFunction so it is called every time 
+
   the timer interrupt fires.  It also passes the amount of time since the last 
+
   handler call to the NotifyFunction.  If NotifyFunction is NULL, then the 
+
   handler is unregistered.  If the handler is registered, then EFI_SUCCESS is 
+
   returned.  If the CPU does not support registering a timer interrupt handler, 
+
   then EFI_UNSUPPORTED is returned.  If an attempt is made to register a handler 
+
   when a handler is already registered, then EFI_ALREADY_STARTED is returned.  
+
   If an attempt is made to unregister a handler when a handler is not registered, 
+
   then EFI_INVALID_PARAMETER is returned.  If an error occurs attempting to 
+
   register the NotifyFunction with the timer interrupt, then EFI_DEVICE_ERROR 
+
   is returned.
 
+
+
   @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.
+
   @param  NotifyFunction   The function to call when a timer interrupt fires. This
+
                            function executes at TPL_HIGH_LEVEL. The DXE Core will
+
                            register a handler for the timer interrupt, so it can know
+
                            how much time has passed. This information is used to
+
                            signal timer based events. NULL will unregister the handler.
 
+
+
   @retval EFI_SUCCESS           The timer handler was registered.
+
   @retval EFI_UNSUPPORTED       The platform does not support timer interrupts.
+
   @retval EFI_ALREADY_STARTED   NotifyFunction is not NULL, and a handler is already
+
                                 registered.
+
   @retval EFI_INVALID_PARAMETER NotifyFunction is NULL, and a handler was not
+
                                 previously registered.
+
   @retval EFI_DEVICE_ERROR      The timer handler could not be registered.
 
+
+
 **/
+
 EFI_STATUS
 EFIAPI
 TimerDriverRegisterHandler (
@@ -147,30 +193,55 @@ TimerDriverRegisterHandler (
 }
 
 /**
+
   This function adjusts the period of timer interrupts to the value specified 
+
   by TimerPeriod.  If the timer period is updated, then the selected timer 
+
   period is stored in EFI_TIMER.TimerPeriod, and EFI_SUCCESS is returned.  If 
+
   the timer hardware is not programmable, then EFI_UNSUPPORTED is returned.  
+
   If an error occurs while attempting to update the timer period, then the 
+
   timer hardware will be put back in its state prior to this call, and 
+
   EFI_DEVICE_ERROR is returned.  If TimerPeriod is 0, then the timer interrupt 
+
   is disabled.  This is not the same as disabling the CPU's interrupts.  
+
   Instead, it must either turn off the timer hardware, or it must adjust the 
+
   interrupt controller so that a CPU interrupt is not generated when the timer 
+
   interrupt fires. 
 
+
+
   @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.
+
   @param  TimerPeriod      The rate to program the timer interrupt in 100 nS units. If
+
                            the timer hardware is not programmable, then EFI_UNSUPPORTED is
+
                            returned. If the timer is programmable, then the timer period
+
                            will be rounded up to the nearest timer period that is supported
+
                            by the timer hardware. If TimerPeriod is set to 0, then the
+
                            timer interrupts will be disabled.
 
+
+
   @retval EFI_SUCCESS           The timer period was changed.
+
   @retval EFI_UNSUPPORTED       The platform cannot change the period of the timer interrupt.
+
   @retval EFI_DEVICE_ERROR      The timer period could not be changed due to a device error.
 
+
+
 **/
 EFI_STATUS
 EFIAPI
@@ -215,18 +286,31 @@ TimerDriverSetTimerPeriod (
 
 
 /**
+
   This function retrieves the period of timer interrupts in 100 ns units, 
+
   returns that value in TimerPeriod, and returns EFI_SUCCESS.  If TimerPeriod 
+
   is NULL, then EFI_INVALID_PARAMETER is returned.  If a TimerPeriod of 0 is 
+
   returned, then the timer is currently disabled.
 
+
+
   @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.
+
   @param  TimerPeriod      A pointer to the timer period to retrieve in 100 ns units. If
+
                            0 is returned, then the timer is currently disabled.
 
+
+
   @retval EFI_SUCCESS           The timer period was returned in TimerPeriod.
+
   @retval EFI_INVALID_PARAMETER TimerPeriod is NULL.
 
+
+
 **/
 EFI_STATUS
 EFIAPI
@@ -244,19 +328,33 @@ TimerDriverGetTimerPeriod (
 }
 
 /**
+
   This function generates a soft timer interrupt. If the platform does not support soft 
+
   timer interrupts, then EFI_UNSUPPORTED is returned. Otherwise, EFI_SUCCESS is returned. 
+
   If a handler has been registered through the EFI_TIMER_ARCH_PROTOCOL.RegisterHandler() 
+
   service, then a soft timer interrupt will be generated. If the timer interrupt is 
+
   enabled when this service is called, then the registered handler will be invoked. The 
+
   registered handler should not be able to distinguish a hardware-generated timer 
+
   interrupt from a software-generated timer interrupt.
 
+
+
   @param  This             The EFI_TIMER_ARCH_PROTOCOL instance.
 
+
+
   @retval EFI_SUCCESS           The soft timer interrupt was generated.
+
   @retval EFI_UNSUPPORTED       The platform does not support the generation of soft timer interrupts.
 
+
+
 **/
 EFI_STATUS
 EFIAPI
@@ -290,38 +388,71 @@ TimerDriverRegisterPeriodicCallback (
 
 
 /**
+
   Interface stucture for the Timer Architectural Protocol.
 
+
+
   @par Protocol Description:
+
   This protocol provides the services to initialize a periodic timer 
+
   interrupt, and to register a handler that is called each time the timer
+
   interrupt fires.  It may also provide a service to adjust the rate of the
+
   periodic timer interrupt.  When a timer interrupt occurs, the handler is 
+
   passed the amount of time that has passed since the previous timer 
+
   interrupt.
 
+
+
   @param RegisterHandler
+
   Registers a handler that will be called each time the 
+
   timer interrupt fires.  TimerPeriod defines the minimum 
+
   time between timer interrupts, so TimerPeriod will also 
+
   be the minimum time between calls to the registered 
+
   handler.
 
+
+
   @param SetTimerPeriod
+
   Sets the period of the timer interrupt in 100 nS units.  
+
   This function is optional, and may return EFI_UNSUPPORTED.  
+
   If this function is supported, then the timer period will 
+
   be rounded up to the nearest supported timer period.
 
+
+
   @param GetTimerPeriod
+
   Retrieves the period of the timer interrupt in 100 nS units.
 
+
+
   @param GenerateSoftInterrupt
+
   Generates a soft timer interrupt that simulates the firing of 
+
   the timer interrupt. This service can be used to invoke the 
+
   registered handler if the timer interrupt has been masked for 
+
   a period of time.
 
+
+
 **/
 EFI_TIMER_ARCH_PROTOCOL   gTimer = {
   TimerDriverRegisterHandler,
@@ -336,17 +467,29 @@ TIMER_DEBUG_SUPPORT_PROTOCOL  gTimerDebugSupport = {
 
 
 /**
+
   Initialize the state information for the Timer Architectural Protocol and
+
   the Timer Debug support protocol that allows the debugger to break into a
+
   running program.
 
+
+
   @param  ImageHandle   of the loaded driver
+
   @param  SystemTable   Pointer to the System Table
 
+
+
   @retval EFI_SUCCESS           Protocol registered
+
   @retval EFI_OUT_OF_RESOURCES  Cannot allocate protocol data structure
+
   @retval EFI_DEVICE_ERROR      Hardware problems
 
+
+
 **/
 EFI_STATUS
 EFIAPI